Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 3.75 KB

README.md

File metadata and controls

95 lines (64 loc) · 3.75 KB
Raw

Occlum "Hello World!" sample

This sample shows how to run an Occlum application in MarbleRun. In essence, you have to add the premain-libos process to your Occlum image, use it as an entry point for your instance and supply the original entry point as an Argv value in MarbleRun's manifest.json. premain will contact the Coordinator, set up the environment, and run the actual application. Take a look into the Makefile for details.

Requirements

First, get Occlum and its build toolchain up and running. This can become quite complex if you run it on your existing environment. Therefore, we use the official Docker image and expose the SGX device to it. Make sure to mount your /etc/sgx_default_qcnl.conf so your application has access to your PCCS. Note that we also chose --network host here, as we assume you do not run the coordinator in the same Docker instance. This option is potentially insecure in production use, as it disables the isolation of the container network. For a production setup, we recommend that you choose a setup that exposes the coordinator to the container.

docker run -it --network host --device /dev/sgx_enclave --device /dev/sgx_provision -v /dev/sgx:/dev/sgx -v /etc/sgx_default_qcnl.conf:/etc/sgx_default_qcnl.conf occlum/occlum:0.30.1-ubuntu20.04

Build

Inside the Docker instance, clone the MarbleRun repository and run the Makefile included in this directory. It will automatically build the premain process and "Hello World" application, create the Occlum instance and run occlum build to create the final image.

git clone https://github.com/edgelesssys/marblerun.git
cd marblerun/samples/occlum-hello
make

After you build the Occlum image, retrieve the UniqueID of the enclave for MarbleRun's manifest.json. You can get the values using the Occlum CLI:

cd occlum-instance
occlum print mrenclave
cd ..

From this point, you can take the output and insert it as UniqueID into manifest.json.

If you want to change the entry point of your application, you can also edit the first Argv value in the manifest. This needs to be a path to the virtual file system of your Occlum image.

Run

We assume that the Coordinator is run with the following environment variables:

  • EDG_COORDINATOR_MESH_ADDR=localhost:2001
  • EDG_COORDINATOR_CLIENT_ADDR=localhost:4433
  • EDG_COORDINATOR_DNS_NAMES=localhost
  • EDG_COORDINATOR_SEAL_DIR=$PWD

Once the Coordinator instance is running, upload the manifest to the Coordinator:

curl -k --data-binary @manifest.json https://localhost:4433/manifest

Now we automatically run our application with the help of the Makefile:

make run

Or manually:

cd occlum-instance
occlum run /bin/premain-libos

Troubleshooting

  • If you receive the following error message on launch:

    fatal error: failed to reserve page summary memory

    Make sure you allocated enough memory in enclave.json. The most important parameters are user_space_size and default_mmap_size. For safe values to start, check out the provided demo manifest.

  • Else, if you receive:

    ERROR: The entrypoint does not seem to exist: '/bin/your_application'
Please make sure that you define a valid entrypoint in your manifest (for example: /bin/hello_world).
panic: "invalid entrypoint definition in argv[0]"

    Make sure you specified the correct filename of your target application.

  • If you are running into other issues, Occlum's error logging might help:

    OCCLUM_LOG_LEVEL=error make run

    or:

    OCCLUM_LOG_LEVEL=error occlum run /bin/premain-libos