Rust SGX SDK Documents

We provide documents for our Rust SGX SDK. These documents are automatically generated by using cargo doc in each crate, and will update immediately on new SDK release.

• sgx_types contains basic data type definitions and macros.
• sgx_tstd provides almost all of compatible part of Rust std.
• sgx_trts is SGX trusted runtime system (tRTS), provides the enclave entry point logic as well as other functions to be used by enclave developers.
• sgx_tservice provides APIs interact with Intel Trusted Platform Service.
• sgx_tcrypto includes a trusted cryptography library.
• sgx_tse provides three key functions for attest an enclave.
• sgx_tseal provides APIs for data sealing and unsealing.
• sgx_tdh provides Diffie-Hellman session establishment APIs.
• sgx_tkey_exchange provides APIs for exchange secrets between server and enclaves.
• sgx_alloc provides the new alloc system in Rust SGX environment.
• sgx_tprotected_fs provides the file system APIs in Rust SGX environment.
• sgx_tunittest provides the unit test driver APIs in Rust SGX environment.
• sgx_rand, sgx_rand_derive provides Rust style PRNG interface in SGX.
• sgx_serialize, sgx_serialize_derive and sgx_serialize_derive_internals provides Rust style data serialization and deserialization in SGX.
• sgx_urts is the untrusted library for programming untrusted part in Rust.
• sgx_tprotected_fs supports the protected file-system provided by Intel.
• sgx_build_helper helps the building process of sgx_tstd.

A summary of Rust SGX SDK APIs

For quick search, we provide a list of Rust SGX SDK APIs here, demonstrating stable APIs and unstable APIs.

Maintainer

Yu Ding dingelish@gmail.com