Google Git
Sign in
apache / incubator-teaclave-sgx-sdk / refs/tags/April-Release
commitf2b16ba4c37f38877dc85d935dc80b648f36c700[log] [tgz]
authorYu Ding <dingelish@gmail.com>Wed Apr 26 22:43:59 2017 -0700
committerYu Ding <dingelish@gmail.com>Wed Apr 26 22:43:59 2017 -0700
tree5dccd79659b202429fa62c4135a750c7bcab3b6a
Rust SGX SDK v0.1.0
156 files changed
tree: 5dccd79659b202429fa62c4135a750c7bcab3b6a
  1. common/
  2. compiler-rt/
  3. dockerfile/
  4. release_docs/
  5. samplecode/
  6. sgx_tcrypto/
  7. sgx_tdh/
  8. sgx_tkey_exchange/
  9. sgx_trts/
  10. sgx_tse/
  11. sgx_tseal/
  12. sgx_tservice/
  13. sgx_tstdc/
  14. sgx_types/
  15. buildenv.mk
  16. LICENSE
  17. Readme.md
  18. release_notes.md
Readme.md

Rust SGX SDK

This Rust SGX SDK helps developers write Intel SGX enclaves in Rust programming language.

Requirement

Ubuntu 16.04

Intel SGX SDK 1.8 for Linux installed

Docker (Recommended)

Configuration

Using docker (Recommended)

First, make sure Intel SGX Driver 1.8 is installed and functions well. /dev/isgx should be appeared.

Second, pull the docker image

$ docker pull baiduxlab/sgx-rust

Third, start a docker with sgx device support and the Rust SGX SDK.

$ docker run -v /your/path/to/rust-sgx:/root/sgx -ti --device /dev/isgx baiduxlab/sgx-rust

Next, start the aesm service inside the docker

root@docker:/# /opt/intel/sgxpsw/aesm/aesm_service &

Finally, check if the sample code works

root@docker:~/sgx/samplecode/helloworld# make

root@docker:~/sgx/samplecode/helloworld# cd bin

root@docker:~/sgx/samplecode/helloworld/bin# ./app

Native without docker (Not recommended)

Install Intel SGX driver and SDK first. And refer to Dockerfile for detail.

Build the docker image by yourself

Make sure Intel SGX SDK is properly installed and service started on the host OS. Then cd dockerfile and run docker build -t rust-sgx-docker to build.

Sample Codes

We provide five sample codes to help developers understand how to write Enclave codes in Rust. These codes are located at samplecode directory.

  • helloworld is a very simple app. It shows some basic usages of argument passing, Rust string and ECALL/OCALLs.

  • crypto shows the usage of crypto APIs provided by Intel SGX libraries. It does some crypto calculations inside the enclave, which is recommended in most circumstances.

  • localattestation is a sample ported from the original Intel SGX SDK. It shows how to do local attestation in Rust programming language.

  • sealeddata sample shows how to seal secret data in an enclave and how to verify the sealed data.

  • thread sample is a sample ported from the original Intel SGX SDK, showing some basic usages of threading APIs.

Tips for writing enclaves in Rust

Writing EDL

  • For fixed-length array in ECALL/OCALL definition, declare it as an array. For dynamic-length array, use the keyword size= to let the Intel SGX knows how many bytes should be copied.

ECALL Function Naming

  • Add #[no_mangle] for every ECALL function.

Passing/returning arrays

  • For dynamic-length array, the only way is to use raw pointers in Rust. There are several functions to get/set data using raw pointers such as offset method. One can also use slice::from_raw_parts to convert the array to a slice.

  • For Fixed-length array, the above method is acceptable. And according to discussions in issue 30382 and issue 31227, thin-pointers (such as fixed-length array) are FFI-safe for now, but undocumented. In the sample codes, we use fixed-length arrays for passing and returning some fixed-length data.

License

Baidu Rust-SGX SDK is provided under the BSD license. Please refer to the License file for details.

Authors

Ran Duan, Long Li, Yu Ding, Lenx Wei, Tanghui Chen

Contacts

Yu Ding, dingelish@gmail.com