Caution

This is documentation for the development version of the project, aka master branch. If you installed Gramine from packages, documentation for the stable version is available at https://gramine.readthedocs.io/en/stable/.

Index

Symbols

--allow-debug-enclave gramine-sgx-ias-verify-report command line option --allow-hw-config-needed gramine-sgx-ias-verify-report command line option --allow-outdated-tcb gramine-sgx-ias-verify-report command line option --allow-sw-hardening-needed gramine-sgx-ias-verify-report command line option --api-key gramine-sgx-ias-request command line option --cert-path gramine-sgx-ias-request command line option --check gramine-manifest command line option --chroot gramine-sgx-sign command line option --date gramine-sgx-sign command line option --define gramine-manifest command line option --depfile gramine-sgx-sign command line option --force gramine-sgx-gen-private-key command line option --gid gramine-sgx-ias-request command line option --help gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-quote-view command line option gramine-sgx-sign command line option --ias-pubkey gramine-sgx-ias-verify-report command line option --isv-prod-id gramine-sgx-ias-verify-report command line option --isv-svn gramine-sgx-ias-verify-report command line option --key gramine-sgx-sign command line option --libpal gramine-sgx-sign command line option --manifest gramine-sgx-sign command line option --mr-enclave gramine-sgx-ias-verify-report command line option --mr-signer gramine-sgx-ias-verify-report command line option --msb gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-quote-view command line option --no-check gramine-manifest command line option --no-force gramine-sgx-gen-private-key command line option --nonce gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option --output gramine-sgx-get-token command line option gramine-sgx-sign command line option --output-format gramine-sgx-sigstruct-view command line option --quiet gramine-sgx-gen-private-key command line option gramine-sgx-get-token command line option gramine-sgx-sign command line option is-sgx-available command line option --quote-path gramine-sgx-ias-request command line option --report-data gramine-sgx-ias-verify-report command line option --report-path gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option --report-url gramine-sgx-ias-request command line option --sig gramine-sgx-get-token command line option --sig-path gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option --sigfile gramine-sgx-sign command line option

--sigrl-path gramine-sgx-ias-request command line option --sigrl-url gramine-sgx-ias-request command line option --verbose gramine-sgx-gen-private-key command line option gramine-sgx-get-token command line option gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-sign command line option gramine-sgx-sigstruct-view command line option --version gramine command line option --with gramine-sgx-sign command line option -c gramine-sgx-ias-request command line option -D gramine-manifest command line option gramine-ratls command line option -E gramine-sgx-ias-verify-report command line option -f gramine-sgx-gen-private-key command line option -g gramine-sgx-ias-request command line option -h gramine-ratls command line option gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-quote-view command line option gramine-sgx-sign command line option -i gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -k gramine-sgx-ias-request command line option gramine-sgx-sign command line option -l gramine-sgx-sign command line option -m gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-quote-view command line option gramine-sgx-sign command line option -n gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -o gramine-sgx-get-token command line option gramine-sgx-sign command line option -P gramine-ratls command line option gramine-sgx-ias-verify-report command line option -q gramine-sgx-gen-private-key command line option gramine-sgx-get-token command line option gramine-sgx-ias-request command line option gramine-sgx-sign command line option -R gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -r gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -S gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -s gramine-sgx-get-token command line option gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-sign command line option -V gramine-sgx-ias-verify-report command line option -v gramine-sgx-gen-private-key command line option gramine-sgx-get-token command line option gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-sign command line option gramine-sgx-sigstruct-view command line option

_

_PAL_STREAM_ATTR (C struct)

A

AE AEP AESM

AEX Architectural Enclave Service Manager Architectural Enclaves Attestation

B

built-in function gramine.runtimedir() ldd() python.get_path() python.get_paths()

C

check() (graminelibos.Manifest method)

chroot (graminelibos.manifest.TrustedFile attribute)

D

Data Center Attestation Primitives

DCAP

E

EDMM Enclave Enclave Dynamic Memory Management Enclave Page Cache Enclave Page Cache Map Enhanced Privacy Identification Enhanced Privacy Identifier ensure_hash() (graminelibos.manifest.TrustedFile method)

environment variable GRAMINE_NO_AUTO_GET_TOKEN EPC EPCM EPID event_wait_with_retry (C function) expand_all_trusted_files() (graminelibos.Manifest method) expand_directory() (graminelibos.manifest.TrustedFile method)

F

FLC Flexible Launch Control

from_manifest() (graminelibos.manifest.TrustedFile class method) from_realpath() (graminelibos.manifest.TrustedFile class method) from_template() (graminelibos.Manifest class method)

G

get_dependencies() (graminelibos.Manifest method) gramine command line option --version gramine-manifest command line option --check --define --no-check -D gramine-ratls command line option -D -h -P gramine-sgx-gen-private-key command line option --force --no-force --quiet --verbose -f -q -v gramine-sgx-get-token command line option --output --quiet --sig --verbose -o -q -s -v gramine-sgx-ias-request command line option --api-key --cert-path --gid --help --msb --nonce --quote-path --report-path --report-url --sig-path --sigrl-path --sigrl-url --verbose -c -g -h -i -k -m -n -q -r -R -S -s -v report sigrl gramine-sgx-ias-verify-report command line option --allow-debug-enclave --allow-hw-config-needed --allow-outdated-tcb --allow-sw-hardening-needed --help --ias-pubkey --isv-prod-id --isv-svn --mr-enclave --mr-signer --msb --nonce --report-data --report-path --sig-path --verbose -E -h -i -m -n -P -r -R -s -S -v -V

gramine-sgx-quote-view command line option --help --msb -h -m gramine-sgx-sign command line option --chroot --date --depfile --help --key --libpal --manifest --output --quiet --sigfile --verbose --with -h -k -l -m -o -q -s -v gramine-sgx-sigstruct-view command line option --output-format --verbose -v gramine.libos (built-in variable) gramine.runtimedir() built-in function

I

IAS Intel Attestation Service Intel Provisioning Certification Service Intel Provisioning Service Intel SGX SDK

Intel SGX Software Development Kit iovec (C struct) IPS is-sgx-available command line option --quiet

K

Key Separation and Sharing

KSS

L

Launch Enclave ldd() built-in function

LE Local Attestation

M

Manifest (class in graminelibos) ManifestError (class in graminelibos)

MEE Memory Encryption Engine

O

OCALL

P

PAL pal_access (C enum) pal_access.PAL_ACCESS_BOUND (C enumerator) pal_access.PAL_ACCESS_RDONLY (C enumerator) pal_access.PAL_ACCESS_RDWR (C enumerator) pal_access.PAL_ACCESS_WRONLY (C enumerator) PAL_CONTEXT (C struct) pal_cpu_info (C struct) pal_create_mode (C enum) pal_create_mode.PAL_CREATE_ALWAYS (C enumerator) pal_create_mode.PAL_CREATE_IGNORED (C enumerator) pal_create_mode.PAL_CREATE_NEVER (C enumerator) pal_create_mode.PAL_CREATE_TRY (C enumerator) pal_delete_mode (C enum) pal_delete_mode.PAL_DELETE_ALL (C enumerator) pal_delete_mode.PAL_DELETE_READ (C enumerator) pal_delete_mode.PAL_DELETE_WRITE (C enumerator) pal_event (C enum) pal_event.PAL_EVENT_ARITHMETIC_ERROR (C enumerator) pal_event.PAL_EVENT_ILLEGAL (C enumerator) pal_event.PAL_EVENT_INTERRUPTED (C enumerator) pal_event.PAL_EVENT_MEMFAULT (C enumerator) pal_event.PAL_EVENT_NO_EVENT (C enumerator) pal_event.PAL_EVENT_NUM_BOUND (C enumerator) pal_event.PAL_EVENT_QUIT (C enumerator) pal_event_handler_t (C type) PAL_IDX (C type) pal_initial_mem_range (C struct) pal_prot_flags_t (C type) pal_public_state (C struct) pal_public_state.alloc_align (C var) pal_public_state.disable_aslr (C var) pal_public_state.early_libos_mem_range_end (C var) pal_public_state.early_libos_mem_range_start (C var) pal_public_state.first_thread (C var) pal_public_state.initial_mem_ranges (C var) pal_public_state.log_level (C var) pal_public_state.manifest_root (C var) pal_public_state.memory_address_end (C var) pal_public_state.memory_address_start (C var) pal_public_state.parent_process (C var) pal_public_state.shared_address_end (C var) pal_public_state.shared_address_start (C var) pal_segment_reg (C enum) pal_segment_reg.PAL_SEGMENT_FS (C enumerator) pal_segment_reg.PAL_SEGMENT_GS (C enumerator) pal_share_flags_t (C type) pal_socket_addr (C struct) pal_socket_domain (C enum) pal_socket_domain.PAL_DISCONNECT (C enumerator) pal_socket_domain.PAL_IPV4 (C enumerator) pal_socket_domain.PAL_IPV6 (C enumerator) pal_socket_type (C enum) pal_socket_type.PAL_SOCKET_TCP (C enumerator) pal_socket_type.PAL_SOCKET_UDP (C enumerator) PAL_STREAM_ATTR (C type) pal_stream_options_t (C type) pal_topo_info (C struct) pal_wait_flags_t (C type) PalAttestationQuote (C function) PalAttestationReport (C function)

PalCpuIdRetrieve (C function) PalDebugLog (C function) PalEventClear (C function) PalEventCreate (C function) PalEventSet (C function) PalEventWait (C function) PalGetPalPublicState (C function) PalGetSpecialKey (C function) PalObjectDestroy (C function) PalProcessCreate (C function) PalProcessExit (C function) PalRandomBitsRead (C function) PalReceiveHandle (C function) PalSegmentBaseGet (C function) PalSegmentBaseSet (C function) PalSendHandle (C function) PalSetExceptionHandler (C function) PalSocketAccept (C function) PalSocketBind (C function) PalSocketConnect (C function) PalSocketCreate (C function) PalSocketListen (C function) PalSocketRecv (C function) PalSocketSend (C function) PalStreamAttributesQuery (C function) PalStreamAttributesQueryByHandle (C function) PalStreamAttributesSetByHandle (C function) PalStreamChangeName (C function) PalStreamDelete (C function) PalStreamFlush (C function) PalStreamMap (C function) PalStreamOpen (C function) PalStreamRead (C function) PalStreamSetLength (C function) PalStreamsWaitEvents (C function) PalStreamWaitForClient (C function) PalStreamWrite (C function) PalSystemTimeQuery (C function) PalThreadCreate (C function) PalThreadExit (C function) PalThreadResume (C function) PalThreadYieldExecution (C function) PalVirtualMemoryAlloc (C function) PalVirtualMemoryFree (C function) PalVirtualMemoryProtect (C function) PCE PCS PE PRM Processor Reserved Memory Provisioning Certification Enclave Provisioning Enclave PSW python.distlib (built-in variable) python.get_path() built-in function python.get_paths() built-in function python.implementation (built-in variable) python.platstdlib (built-in variable) python.purelib (built-in variable) python.stdlib (built-in variable)

Q

QE	Quoting Enclave

R

RA-TLS realpath (graminelibos.manifest.TrustedFile attribute)

Remote Attestation report gramine-sgx-ias-request command line option

S

SDK Secret Provisioning SECS Secure Channel Security Version Number Service Provider ID SGX SGX Enclave Control Structure SGX Platform Software SGX Quote

SGX Report SGX SDK SGX2 sha256 (graminelibos.manifest.TrustedFile attribute) sigrl gramine-sgx-ias-request command line option SPID SSA State Save Area SVN

T

TCB TCS TEE Thread Control Block

Thread Control Structure to_manifest() (graminelibos.manifest.TrustedFile method) Trusted Computing Base Trusted Execution Environment TrustedFile (class in graminelibos.manifest)

U

uri (graminelibos.manifest.TrustedFile attribute)