Skip to content

Files

Latest commit

DukeDavis12mkow
DukeDavis12
and
mkow
Remove all deprecated manifest options
Dec 12, 2024
5902e47 · Dec 12, 2024

History

History

Intel-Confidential-Compute-for-X

README.md

Intel® Confidential Compute for X

The "Intel® Confidential Compute for X" project provides an interactive script to transform regular Docker images to Gramine-protected (aka, graminized) Docker images. The transformation adds important features, e.g., attestation, to the original Docker image to enable secure end-to-end use cases. The interactive script asks users for necessary configurations, and provides these inputs to GSC for the actual transformation.

One main goal of the project is to prepare the necessary script settings and templates so that a graminized Docker image for well-known applications can be created in minutes. At the moment, Intel® carefully prepared the script for the following applications:

For these applications, the interactive script also provides a test feature. With a single command, users can generate a non-production, Gramine-protected Docker image. This image is signed with a dummy key and must only be used for experimentation and learning.

One can easily graminize more applications with the interactive script by studying the prepared application, and adjusting the settings and templates as needed.

Prerequisites

For building an "Intel® Confidential Compute for X" image

  • No hardware requirements.
  • Any regular system with a Linux distribution is sufficient.
  • Install the necessary build dependencies and adjust the permissions of /var/run/docker.sock for the current user:
    • Ubuntu 20.04 
      sudo apt-get update && sudo apt-get install -y docker.io python3 python3-pip
python3 -m pip install docker jinja2 tomli tomli-w pyyaml
sudo chown $USER /var/run/docker.sock

For executing an "Intel® Confidential Compute for X" image

Hardware requirements

  • SGX-enabled Azure VMs:

    At Azure, VMs of the DCsv3 and DCdsv3-series should be used. Azure provides a quickstart guide to setup such VMs. During the selection of the VM, one has to carefully select a machine providing the necessary amount of EPC memory suiting the application. A table with the provided EPC memory size can be found on the DCsv3 and DCdsv3-series overview.

  • Bare-metal systems:

    User is expected to have DCAP remote attestation infrastructure with PCCS setup and system provisioned. Please follow instructions here for DCAP remote attestation setup.

Install the necessary build dependencies:

Below commands are specific to Ubuntu 20.04. Please follow the instructions under "Intel® SGX Application User" section in document here for other distro specific commands.

sudo apt-get update && sudo apt-get install -y docker.io
sudo chown $USER /var/run/docker.sock

echo 'deb [arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu focal main' | \
    sudo tee /etc/apt/sources.list.d/intel-sgx.list
wget -qO - https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key | \
    sudo apt-key add -
sudo apt-get update && \
    sudo apt-get install -y -f libsgx-dcap-ql libsgx-dcap-default-qpl=1.16.100.2-focal1

# Execute below command (only on Azure VM) to change PCCS_URL to Azure PCCS
sudo sed -i "s|^\(  \"pccs_url\": \"https://\).*\(/sgx/certification.*\)|\1global.acccache.azure.net\2|g" \
    /etc/sgx_default_qcnl.conf

Usage of the interactive script

python3 curate.py <app name> <base image name> <optional args>

For detailed usage information:

python3 curate.py --help

Contents

.
|-- curate.py  # Interactive script that does the transformation explained above.
|-- keys/      # Gramine and Intel-SGX repository keys for installing packages.
|-- util/      # Helper scripts and files that curate.py uses.
|-- verifier/  # Contents to build attestation verifier image.
|-- workloads/ # Contains  script settings and templates for prepared applications.