Build your first application with Scone framework โ
In this tutorial, you will learn how to build and run a Confidential Computing application with the Scone TEE framework.
WARNING
Before going any further, make sure you managed to Build your first application.
Prerequisites:
- Docker 17.05 or higher on the daemon and client.
- iExec SDK 8.0.0 or higher. Install the iExec SDK
- Familiarity with the basic concepts of Intelยฎ SGX and SCONE framework.
In order to follow this tutorial, you will need to register a free SCONE Account to access SCONE build tools and curated images from the SCONE registry.
Once your account is activated, you need to request access to the SCONE build tools for iExec.
# when your account is ready, run `docker login` to connect the SCONE registry
docker login registry.scontain.com
Prepare your application โ
WARNING
For demo purposes, we omitted some development best practices in these examples.
Make sure to check your field's best practices before going to production.
Before going further, your <docker-hub-user>/hello-world:1.0.0
image built previously is required.
If you missed that part, please go back to Build your first application.
For this tutorial, you can reuse the same directory tree or create a new one.
To create a new directory tree, execute the following commands in ~/iexec-projects/
.
cd ~/iexec-projects
mkdir tee-hello-world-app && cd tee-hello-world-app
iexec init --skip-wallet
mkdir src
touch Dockerfile
touch sconify.sh
chmod +x sconify.sh
Update chain json โ
Make sure your chain.json
content is as follows:
{
"default": "bellecour",
"chains": {
"bellecour": {
"sms": { "scone": "https://sms.scone-debug.v8-bellecour.iex.ec" }
}
}
}
If you start from a new firectory tree, you will need to replay the following steps from Build your first application:
- Write the app Javascript or Python source code in
src/
- Dockerize your app
- Push your app to Dockerhub
As we mentioned earlier, the advantage of using SCONE is the ability to make the application Intelยฎ SGX-enabled without changing the source code. The only thing we are going to do is rebuilding the app using the Trusted-Execution-Environment tooling provided by SCONE.
INFO
SCONE provides TEE conversion tooling (Python, Java, ..) plus eventually TEE base images for other languages (NodeJs).
Build the TEE docker image โ
We will use the following script to wrap the sconification process, copy the sconify.sh
script in the current directory:
#!/bin/bash
# Declare the app entrypoint
ENTRYPOINT="node /app/app.js"
# Declare image related variables
IMG_NAME=tee-scone-hello-world
IMG_FROM=<docker-hub-user>/hello-world:1.0.0
IMG_TO=<docker-hub-user>/${IMG_NAME}:1.0.0-debug
# Run the sconifier to build the TEE image based on the non-TEE image
docker run -it --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
registry.scontain.com/scone-production/iexec-sconify-image:5.9.1-v16\
sconify_iexec \
--name=${IMG_NAME} \
--from=${IMG_FROM} \
--to=${IMG_TO} \
--binary-fs \
--fs-dir=/app \
--host-path=/etc/hosts \
--host-path=/etc/resolv.conf \
--binary=/usr/local/bin/node \
--heap=1G \
--dlopen=1 \
--no-color \
--verbose \
--command=${ENTRYPOINT} \
&& echo -e "\n------------------\n" \
&& echo "successfully built TEE docker image => ${IMG_TO}" \
&& echo "application mrenclave.fingerprint is $(docker run --rm -e SCONE_HASH=1 ${IMG_TO})"
#!/bin/bash
# Declare the app entrypoint
ENTRYPOINT="python3 /app/app.py"
# Declare image related variables
IMG_NAME=tee-scone-hello-world
IMG_FROM=<docker-hub-user>/hello-world:1.0.0
IMG_TO=<docker-hub-user>/${IMG_NAME}:1.0.0-debug
# Run the sconifier to build the TEE image based on the non-TEE image
docker run -it \
-v /var/run/docker.sock:/var/run/docker.sock \
registry.scontain.com/scone-production/iexec-sconify-image:5.9.1-v16\
sconify_iexec \
--name=${IMG_NAME} \
--from=${IMG_FROM} \
--to=${IMG_TO} \
--binary-fs \
--fs-dir=/app \
--host-path=/etc/hosts \
--host-path=/etc/resolv.conf \
--binary=/usr/local/bin/python3 \
--heap=1G \
--dlopen=1 \
--no-color \
--verbose \
--command=${ENTRYPOINT} \
&& echo -e "\n------------------\n" \
&& echo "successfully built TEE docker image => ${IMG_TO}" \
&& echo "application mrenclave.fingerprint is $(docker run --rm -e SCONE_HASH=1 ${IMG_TO})"
Run the sconify.sh
script to build the Scone TEE application:
./sconify.sh
Push your image on DockerHub:
docker push <docker-hub-user>/tee-scone-hello-world:1.0.0-debug
Congratulations, you just built your Scone TEE application.
INFO
You may have noticed the tee-debug
flag in the image name, the built image is actually in TEE debug mode, this allows you to have some debug features while developping the app.
Once you are happy with the debug app, contact us to go to production!
Test your app on iExec โ
At this stage, your application is ready to be tested on iExec. The process is similar to testing any type of application on the platform, with these minor exceptions:
Deploy the TEE app on iExec โ
TEE applications require some additional information to be filled in during deployment.
# prepare the TEE application template
iexec app init --tee
Edit iexec.json
and fill in the standard keys and the mrenclave
object:
{
...
"app": {
"owner": "<your-wallet-address>", // starts with 0x
"name": "tee-scone-hello-world", // application name
"type": "DOCKER",
"multiaddr": "docker.io/<docker-hub-user>/tee-scone-hello-world:1.0.0-debug", // app image
"checksum": "<checksum>", // starts with 0x, update it with your own image digest
"mrenclave": {
"framework": "SCONE", // TEE framework (keep default value)
"version": "v5.9", // Scone version (keep default value)
"entrypoint": "node /app/app.js" OR "python3 /app/app.py", // update it with your own image entrypoint
"heapSize": 1073741824, // heap size in bytes, update it with --heap option value used in sconify.sh script during TEE image build
"fingerprint": "<mrenclave>" // fingerprint of the enclave code (mrenclave), without 0x prefix, see how to retrieve it below
}
},
...
}
INFO
See Create your identity on the blockchain to retrieve <your-wallet-address>
value.
See Deploy your app on iExec to retrieve your image <checksum>
.
Run your TEE image with SCONE_HASH=1
to get the enclave fingerprint (mrenclave):
docker run --rm -e SCONE_HASH=1 <docker-hub-user>/tee-scone-hello-world:1.0.0-debug
Deploy the app with the standard command:
iexec app deploy
Run the TEE app โ
Specify the tag --tag tee,scone
in iexec app run
command to run a tee app.
One last thing, in order to run a TEE-debug app you will also need to select a debug workerpool, use the debug workerpool debug-v8-learn.main.pools.iexec.eth
.
You are now ready to run the app
iexec app run --tag tee,scone --workerpool debug-v8-learn.main.pools.iexec.eth --watch
INFO
You noticed we used debug-v8-learn.main.pools.iexec.eth
instead of an ethereum address, this is an ENS name.
The ENS (Ethereum Name Service) protocol enables associating decentralized naming to ethereum addresses.
INFO
Remember, you can access task and app logs by following the instructions on page Debug your tasks.
Next step? โ
In this tutorial, you learned how to leverage your application with the power of Trusted Execution Environments using iExec. But according to your use case, you may need to use some confidential data to get the full potential of the Confidential Computing paradigm. Check out next chapters to see how: