gupta-ak / openenclave-1

SDK for developing enclaves

Open Enclave SDK

Introduction

Open Enclave (OE) is an SDK for building enclave applications in C and C++. An enclave application partitions itself into two components:

1. An untrusted component (called the host) and
2. A trusted component (called the enclave).

An enclave is a protected memory region that provides confidentiality for data and code execution. It is an instance of a Trusted Execution Environment (TEE) which is usually secured by hardware, for example, Intel Software Guard Extensions (SGX).

This SDK aims to generalize the development of enclave applications across TEEs from different hardware vendors. The current implementation provides support for Intel SGX as well as preview support for OP-TEE OS on ARM TrustZone. As an open source project, this SDK also strives to provide a transparent solution that is agnostic to specific vendors, service providers and choice of operating systems.

Getting Started

Intel SGX

If you would like to start developing apps with the preview Open Enclave SDK release, start here for instructions to install and use the SDK package:

• Ubuntu 18.04 with SGX hardware
• Ubuntu 16.04 with SGX hardware
• Ubuntu 18.04 or 16.04 in simulation mode
• Windows Release Package coming soon

If you would like to run Ubuntu 16.04 or Ubuntu 18.04 in a Hyper-V VM on SGX capable hardware, see Setting up a Linux Hyper-V VM on Windows with SGX Support.

OP-TEE OS (ARM TrustZone)

The Open Enclave SDK provides preview support for the Open Portable TEE OS (OP-TEE OS). OP-TEE is an operating system for TEE's that implement a traditional kernel-mode and user-mode execution environment. It runs on A-profile ARM systems that support ARM TrustZone. As a result, the Open Enclave SDK can be leveraged to target these systems as well.

For an overview of the SDK's support for OP-TEE OS as well as links to getting started guides, see Open Enclave SDK for OP-TEE OS.

Contributing

This project welcomes contributions and suggestions. All contributions to the Open Enclave SDK must adhere to the terms of the Developer Certificate of Origin (DCO). For details, see Contributing to Open Enclave.

This project follows a Code of Conduct adapted from the Contributor Covenant v1.4.

If you are interested in contributing directly to the codebase, please see the following documentation:

• Development Guide
• Governance Model
• Build SDK and run tests

API Documentation

The Doxygen generated documentation corresponding to the APIs currently supported by the master branch is here. API Documentation for older releases of the SDK can be found on the Open Enclave SDK website.

Licensing

This project is released under the MIT License.