Skip to content

Latest commit

 

History

History
147 lines (119 loc) · 6.49 KB

README.md

File metadata and controls

147 lines (119 loc) · 6.49 KB
Raw

Salmiac

A confidential VM running unmodified container images in AWS Nitro Enclaves. Salmiac makes it possible to run an application in isolated compute environments to protect and securely process highly sensitive data.

By default bare Nitro Enclaves doesn't provide any networking capability outside of the enclave environment as well as no persistent storage, meaning that all your data is lost when container image finishes its execution.

Salmiac enhances Nitro Enclaves by enabling networking for external communication and providing encrypted persistent storage.

Useful links

Quick Start Guide

This guide allows you to build salmiac from source and convert your docker application into a one that can run in a nitro enclave.

  1. Set up your Ubuntu based build system:

    • Install Rust: Follow this guide.
    • Install Docker: Follow this guide to install version 24.0.x OR 
      apt-get install docker-ce=5:24.0.1-1~ubuntu.20.04~focal docker-ce-cli=5:24.0.1-1~ubuntu.20.04~focal  containerd.io
    • Install tools needed to build the linux kernel: Follow this guide.
    • Install additional dependencies: 
      apt-get install pkg-config libclang-dev cmake libpcap-dev

  2. Set up your Nitro-enabled AWS EC2 instance:

    • Install docker on your EC2: Follow this guide.
    • Install nitro-cli on your EC2: Follow this guide.

  3. Build requisite docker images needed to run container converter

    # Run from the root of the repository
# build enclave-base image
cd salmiac/docker/enclave-base
docker build -t enclave-base .
      
# build parent-base image
cd ../parent-base
docker build -t parent-base .

  4. Build the enclave kernel. This step takes a long time and needs to be done only once. The artifacts produced by this step need not be cleaned up unless the kernel config is updated.

    cd amzn-linux-nbd
./build-enclave-kernel.sh build

  5. Build the converter image. To produce a debug build of the converter, ensure the release flag is removed from the step below.

      # Run from the root of the repository
  cd salmiac
  # To produce a debug build of the converter, ensure the release flag is removed from the step below.
  ./build-converter.sh --release

  cd docker
  # If a debug build of the converter was produced, use debug as an argument to the below script
  ./build-conv-container.sh release

  6. Create a simple conversion request json file (say /tmp/req.json) More details about each field of the conversion request can be found in /salmiac/api-model/src/converter.rs

     {
   "input_image": {
      "name": "hello-world", 
   },
   "output_image": {
      "name": "hello-world-nitro",
   },
   "converter_options": {
      "push_converted_image": false,
      "enable_overlay_filesystem_persistence": false
   },
   "nitro_enclaves_options": {
      "cpu_count": 2,
      "mem_size": "4096M"
   }
}

  7. Make your application Nitro VM-capable by running container converter with the file from previous step. The converter by default pulls the input image and pushes the output image to remote repositories. These images are then cleaned up from the local docker cache. In our example, the output image push is disabled in the request json and to preserve the images in the docker cache, 'PRESERVE_IMAGES' environment variable is specified.

       docker run --rm --name converter --user 0 --privileged -v /var/run/docker.sock:/var/run/docker.sock -e PRESERVE_IMAGES=input,result -v /tmp/req-files:/app converter --request-file /app/req.json

  8. Copy converted image into your EC2 instance and run the image. Note the use of the environment variable which disables the use of default certificates, which allows you to skip access to Fortanix CCM. Read more about environment variables used in salmiac here - /salmiac/ENV_VARS.md

       # Copy your converted image from step #7 into your EC2 isntance
   # ...       
   # Run copied image inside EC2
   docker run -it --rm --privileged -v /run/nitro_enclaves:/run/nitro_enclaves -e ENCLAVEOS_DISABLE_DEFAULT_CERTIFICATE=true hello-world-nitro

Contributing

We gratefully accept bug reports and contributions from the community. By participating in this community, you agree to abide by Code of Conduct. All contributions are covered under the Developer's Certificate of Origin (DCO).

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

License

This project is primarily distributed under the terms of the Mozilla Public License (MPL) 2.0, see LICENSE for details.