Skip to content

Latest commit

 

History

History
130 lines (96 loc) · 3.84 KB

INSTALL.md

File metadata and controls

130 lines (96 loc) · 3.84 KB
Raw

Asylo - Manual Installation

The following steps can be used to manually install Asylo and its dependencies. The manual installation process and Docker image creation process have both primarily been tested on Debian Buster, but may also be used to install Asylo on other Linux distros and versions.

See the README.md for instructions on Docker usage, which is our recommended way of using the Asylo framework.

Asylo sources

Clone the Asylo project from GitHub into a directory of your choice.

ASYLO="${HOME}"/asylo
git clone https://github.com/google/asylo.git "${ASYLO}"/sdk

Toolchain

The Asylo framework uses a custom toolchain to compile enclave applications for various backend environments. For example, to build your application for a simulated SGX enclave backend, use the sgx-sim config.

bazel build --config=sgx-sim :my_app

If using macros defined by asylo.bzl or sgx_sdk.bzl, then --config=sgx-sim is not the correct way to build your application. Those enclave/test/loader targets will instead directly transition to the Asylo toolchain and build with a number of supported enclave backends. A target defined by Asylo's backend-generic macros is given a suffix like _sgx_sim to denote which backend it uses.

You can manually install the toolchain by following these steps:

  1. Download and install the following prerequisites, which are needed for building the toolchain:

    • bison
    • build-essential
    • flex
    • libisl-dev
    • libmpc-dev
    • libmpfr-dev
    • rsync
    • texinfo
    • wget
    • zlib1g-dev

    For example, on Debian:

    sudo apt install bison build-essential flex libisl-dev libmpc-dev \
    libmpfr-dev rsync texinfo wget zlib1g-dev

  2. Build and install the toolchain.

    "${ASYLO}"/sdk/asylo/distrib/toolchain/install-toolchain \
    --user \
    --prefix "${ASYLO}"/toolchains/default

    This will install the toolchain under "${ASYLO}"/toolchains/default

See toolchain/README.md for additional details on installing the toolchain.

Intel SGX SDK

The Asylo framework uses Intel SGX SDK v2.9 with a patch that backports some pull requests and applies minor changes needed to build the SDK with the Asylo toolchain.

Intel SGX hardware backend support

Intel SGX hardware support requires additional dependencies. The process of installing these dependencies is detailed in the Intel SGX SDK README. Namely, you must

Bazel

The Asylo framework is built with Bazel, Google's open source build tool.

You can manually install Bazel by following these steps:

sudo apt install curl gnupg
curl https://bazel.build/bazel-release.pub.gpg | sudo apt-key add -
echo "deb http://storage.googleapis.com/bazel-apt stable jdk1.8" | \
    sudo tee /etc/apt/sources.list.d/bazel.list
sudo apt update
sudo apt install bazel

Additional dependencies

The following packages are used by Asylo and its dependencies, and must also be installed.

  • git
  • ocaml-nox
  • ocamlbuild
  • python3

On Debian, these can be installed with the following command:

sudo apt install git ocaml-nox ocamlbuild

Next steps

Refer to the project README for using this Asylo installation.