1. Getting Started

1.1. What is Keystone Enclave

Keystone Enclave is an open source secure enclave for RISC-V processors.

You can currently run Keystone on qemu, FireSim (FPGA), or the SiFive HiFive Unleashed board.

You can migrate the Keystone enclave into arbitrary RISC-V processor, with a very small modification on hardware to plant the silicon root of trust.

Attention

We’re actively adding more documents right now. Please post in Keystone forum or create a GitHub issue if you face any undocumented trouble.

Attention

The current version (0.X) of Keystone is not formally verified, nor matured. We recommend you to use Keystone only for research purposes until it gets stablized. We appreciate any contribution for making Keystone better.

1.2. Quick Start

• 1.2.1. Running Keystone with QEMU
  • 1.2.1.1. Installing Dependencies
  • 1.2.1.2. Quick Setup
  • 1.2.1.3. Compile Sources
  • 1.2.1.4. Launch QEMU
• 1.2.2. Running Keystone with FireSim
  • 1.2.2.1. Who needs it?
  • 1.2.2.2. Setting Up FireSim Manager Instance
  • 1.2.2.3. Building Keystone Software
  • 1.2.2.4. Launching Simulation
  • 1.2.2.5. Running Keystone Enclaves
• 1.2.3. Running Keystone on Hardware
  • 1.2.3.1. Building for HiFive
  • 1.2.3.2. Setting up the HiFive
  • 1.2.3.3. Running on the HiFive