| commit | af441e3c9143a8c1d04dbbc544142adc8e35f73e | [log] [tgz] |
|---|---|---|
| author | Yu Ding <dingelish@gmail.com> | Sat Jul 22 12:00:36 2017 -0700 |
| committer | Yu Ding <dingelish@gmail.com> | Sat Jul 22 12:00:36 2017 -0700 |
| tree | d2d41b9c27dbb8146d6e33db2cf518c332f49d67 | |
| parent | 4e5a090656d331843433ef42dc30b49260a90cd7 [diff] |
Rust SGX SDK v0.2.0 release
This Rust SGX SDK helps developers write Intel SGX enclaves in Rust programming language.
We are proud to have our v0.2.0 Rust SGX SDK released. It is now providing more threading functions, thread local storages, exception handling routines and supports unwind mechanism, as well as support of LARGE ENCLAVE MEMORY with the help of Intel SGX v1.9 (31.75 GB enclave memory tested). Please refer to release notes for further details. And we are working on a white paper for technical details about this project.
Attention Rust has recently merged a patch (rustc: Implement the #[global_allocator] attribute) which significantly changes the behavior of liballoc. Thus set_oom_handler is no longer available since nightly-2017-07-07. Due to its instability, v0.2.0 Rust SGX SDK keeps using the old liballoc instead of new liballoc_system. As a result, nightly version rustc after 2017-07-06 will not successfully compile sgx_trts.
Ubuntu 16.04
Intel SGX SDK 1.9 for Linux installed
Docker (Recommended)
First, make sure Intel SGX Driver 1.9 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
Install Intel SGX driver and SDK first. And refer to Dockerfile for detail.
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.
The online documents for SDK crates can be found here.
We recommend to use cargo doc to generate documents for each crate in this SDK by yourself. The auto generated documents are easy to read and search.
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.
New! remoteattestation sample shows how to make remote attestation with Rust SGX SDK. The sample is forked from linux-sgx-attestation and credits to Blackrabbit (blackrabbit256@gmail.com). The enclave in Rust is shipped in this sample and Makefiles are modified accordingly.
New! hugemem sample shows how to use huge mem in SGX enclave. In this sample, we allocate reserve 31.75GB heap space and allocate 31.625GB buffers!
size= to let the Intel SGX knows how many bytes should be copied.#[no_mangle] for every ECALL function.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.
Baidu Rust-SGX SDK is provided under the BSD license. Please refer to the License file for details.
Ran Duan, Long Li, Shi Jia, Yu Ding, Lenx Wei, Tanghui Chen
Thanks to Prof. Jingqiang Lin for his contribution to this project.
Yu Ding, dingelish@gmail.com