Services that create SGX enclaves depend on the Intel SGX SDK. This must be installed in the build environment, as well as the runtime environment.
An easy way to get this environment is to build in the docker image that we use for CI.
The dockerfile for this image lives in docker/Dockerfile.
You can use ./mob prompt to pull this image, (or to build it locally), and get a prompt
in this environment.
# From the root of the repo
./mob prompt
# At the container prompt
cargo build
If you have SGX-enabled hardware (activated in BIOS, and with SGX kernel module installed),
you can use ./mob prompt --hw to get SGX in the container. Then you can both build and
run the tests in SGX_MODE=HW. (See below for an explanation.)
You can use ./mob '<command>' to run <command> from within
the docker environment. For IDE support, this can be used to run cargo check.
An example workspace configuration for Rust Analyzer is provided below:
"rust-analyzer.checkOnSave.overrideCommand": [
"./mob",
"cargo check --workspace --message-format=json --all-targets"
],
"rust-analyzer.cargo.buildScripts.overrideCommand": [
"./mob",
"cargo check --workspace --message-format=json --all-targets"
],
"rust-analyzer.cargo.buildScripts.useRustcWrapper": false,
"rust-analyzer.cargo.buildScripts.enable": false,
"rust-analyzer.procMacro.enable": false,A docker-less build also works fine for development:
- Follow instructions consensus/service/BUILD.md
- Set up your environment with
docker/init_debian.shand possiblydocker/install_sgx.sh
There are two project-wide SGX-related configuration variables SGX_MODE and IAS_MODE.
These are set by environment variables, and they must be the same for all artifacts,
even those that don't depend directly on SGX. E.g. mobilecoind must have the same configuration
as consensus_service for Intel Remote Attestation to work, otherwise an error will occur at runtime.
For local testing, you should usually use SGX_MODE=SW and IAS_MODE=DEV.
If you are seeking to build a client that you can test against MobileCoin's official testnet,
you must use SGX_MODE=HW and IAS_MODE=PROD, because testnet is configured as a production environment.
SGX_MODE=SW means that the enclaves won't be "real" enclaves -- consensus service will link
to Intel-provided "_sim" versions of the Intel SGX SDK, and the enclave will be loaded approximately
like a shared library being dlopen'ed. This means that you will be able to use gdb and get
backtraces normally through the enclave code. In this mode, the CPU does not securely compute
measurements of the enclave, and attestation doesn't prove the integrity of the enclave.
SGX_MODE=HW means that the real Intel libraries are used, and the enclave is loaded securely.
This mode is required for Intel Remote Attestation to work and provide security.
The clients and servers must all agree about this setting, or attestation will fail.
IAS_MODE=DEV means that we will hit the Intel provided "dev endpoints" during remote attestation.
These won't require the real production signing key in connection to the MRENCLAVE measurements.
IAS_MODE=PROD means that we will hit the real Intel provided endpoints for remote attestation.
In code, this discrepancy is largely handled by the attest-net crate.
The clients and servers must all agree about this setting, or attestation will fail.
cargo supports crate-level features, and feature unification across the build plan.
cargo does not support any notion of "global project-wide configuration".
In practice, it's too hard invoke cargo to get all the features enabled exactly correctly on
all the right crates, if every crate has an sgx_mode and ias_mode feature.
Even if cargo had workspace-level features, which it doesn't, that wouldn't be good enough for us
because our build requires using multiple workspaces. We must keep the cargo features on some
targets separated and not unified.
Unifying cargo features across enclave targets and server targets will break the enclave builds.
This is because the enclave builds in a special no_std environment.
Making SGX_MODE and IAS_MODE environment variables, and making build.rs scripts that read
them and set features on these crates as needed, is the simplest way to make sure that there is
one source of truth for these values for all of the artifacts in the whole build.
The SGX_MODE environment variable configuration is also used throughout Intel SGX SDK examples.
In order to run SGX securely with SGX_MODE=HW you may need to change certain settings in your BIOS. These settings reduce the risk of certain side-channel attacks and are required
by the MobileCoin network to accept an enclave quote.
These may look different depending on your BIOS type.
Software Guard Extensions (SGX) must be enabled. This is usually found under CPU Configuration
Hyperthreading must be disabled. This is also usually found under CPU Configuration
Integrated Graphics must be disabled. This is usually found under Display
For technical reasons, the consensus_enclave must be in a separate workspace.
It is also built using cargo build.
The enclave build is invoked automatically if needed from the consensus_service build.rs.
To reproducibly build the enclave, (get exactly the right MRENCLAVE value), you must build in the container.
For local testing, you don't need to get exactly the right MRENCLAVE value. You can set up test networks with whatever MRENCLAVE your build produces, and clients that check this value using the Remote Attestation process.
If you want to download a prebuilt enclave, signed using the production signing key, in order use IAS_MODE=PROD
and participate in a production-environment network, check out the enclave-signing-material instructions:
https://github.com/mobilecoinfoundation/mobilecoin/blob/master/consensus/service/BUILD.md#enclave-signing-material