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 --date <YYYY-MM-DD>|today gramine-sgx-sign command line option --define <key>=<value>, -D <key>=<value> gramine-manifest command line option --depfile depfile gramine-sgx-sign command line option --force, -f gramine-sgx-gen-private-key command line option --help, -h gramine-sgx-sign command line option --key key_file, -k key_file gramine-sgx-sign command line option --libpal libpal_path, -l libpal_path gramine-sgx-sign command line option --manifest manifest_file, -m manifest_file gramine-sgx-sign command line option --no-force gramine-sgx-gen-private-key command line option --output output_manifest, -o output_manifest gramine-sgx-sign command line option --output token_file, -o token_file gramine-sgx-get-token command line option --output-format [text|toml|json] gramine-sgx-sigstruct-view command line option --quiet is-sgx-available command line option --quiet, -q gramine-sgx-gen-private-key command line option gramine-sgx-get-token command line option gramine-sgx-sign command line option --sig sigstruct_file, -s sigstruct_file gramine-sgx-get-token command line option --sigfile sigfile, -s sigfile gramine-sgx-sign command line option --verbose, -v gramine-sgx-gen-private-key command line option gramine-sgx-get-token command line option gramine-sgx-sign command line option gramine-sgx-sigstruct-view command line option --version gramine command line option --with <plugin> gramine-sgx-sign command line option

-c, --cert-path gramine-sgx-ias-request command line option -D gramine-ratls command line option -E, --mr-enclave gramine-sgx-ias-verify-report command line option -g, --gid gramine-sgx-ias-request command line option -h gramine-ratls command line option -h, --help gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-quote-view command line option -i, --ias-pubkey gramine-sgx-ias-verify-report command line option -i, --sigrl-path gramine-sgx-ias-request command line option -k, --api-key gramine-sgx-ias-request command line option -m, --msb gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option gramine-sgx-quote-view command line option -n, --nonce gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -P gramine-ratls command line option -P, --isv-prod-id gramine-sgx-ias-verify-report command line option -q, --quote-path gramine-sgx-ias-request command line option -R, --report-data gramine-sgx-ias-verify-report command line option -r, --report-path gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -R, --report-url gramine-sgx-ias-request command line option -S, --mr-signer gramine-sgx-ias-verify-report command line option -s, --sig-path gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option -S, --sigrl-url gramine-sgx-ias-request command line option -V, --isv-svn gramine-sgx-ias-verify-report command line option -v, --verbose gramine-sgx-ias-request command line option gramine-sgx-ias-verify-report command line option

A

AE AEP AESM

AEX Architectural Enclave Service Manager Architectural Enclaves Attestation

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 environment variable GRAMINE_NO_AUTO_GET_TOKEN EPC EPCM EPID event_wait_with_retry (C function)

F

FLC	Flexible Launch Control

G

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

gramine-sgx-quote-view command line option -h, --help -m, --msb gramine-sgx-sign command line option --date <YYYY-MM-DD>|today --depfile depfile --help, -h --key key_file, -k key_file --libpal libpal_path, -l libpal_path --manifest manifest_file, -m manifest_file --output output_manifest, -o output_manifest --quiet, -q --sigfile sigfile, -s sigfile --verbose, -v --with <plugin> gramine-sgx-sigstruct-view command line option --output-format [text|toml|json] --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 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

MEE	Memory Encryption Engine

O

OCALL

P

PAL 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 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 sigrl gramine-sgx-ias-request command line option SPID SSA State Save Area SVN

T

TCB TCS TEE

Thread Control Block Thread Control Structure Trusted Computing Base Trusted Execution Environment