Skip to content

Commit 8d0e076

Browse files
authored
Add table of contents to README (#609)
Also adjusted indentation for the subsections in section *Install the Intel(R) SGX PSW*.
1 parent a21f2d9 commit 8d0e076

File tree

1 file changed

+52
-27
lines changed

1 file changed

+52
-27
lines changed

README.md

Lines changed: 52 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,33 @@
1-
2-
31
Intel(R) Software Guard Extensions for Linux\* OS
42
================================================
53

64
# linux-sgx
5+
* [Introduction](#introduction)
6+
* [License](#license)
7+
* [Contributing](#contributing)
8+
* [Documentation](#documentation)
9+
* [Quick Start with Docker and Docker Compose](#quick-start-with-docker-and-docker-compose)
10+
* [Build and Install the Intel(R) SGX Driver](#build-and-install-the-intelr-sgx-driver)
11+
* [Build the Intel(R) SGX SDK and Intel(R) SGX PSW Package](#build-the-intelr-sgx-sdk-and-intelr-sgx-psw-package)
12+
* [Prerequisites](#prerequisites)
13+
* [Build the Intel(R) SGX SDK and Intel(R) SGX SDK Installer](#build-the-intelr-sgx-sdk-and-intelr-sgx-sdk-installer)
14+
* [Build the Intel(R) SGX PSW and Intel(R) SGX PSW Installer](#build-the-intelr-sgx-psw-and-intelr-sgx-psw-installer)
15+
* [Install the Intel(R) SGX SDK](#install-the-intelr-sgx-sdk)
16+
* [Prerequisites](#prerequisites-1)
17+
* [Install the Intel(R) SGX SDK](#install-the-intelr-sgx-sdk-1)
18+
* [Test the Intel(R) SGX SDK Package with the Code Samples](#test-the-intelr-sgx-sdk-package-with-the-code-samples)
19+
* [Compile and Run the Code Samples in the Hardware Mode](#compile-and-run-the-code-samples-in-the-hardware-mode)
20+
* [Install the Intel(R) SGX PSW](#install-the-intelr-sgx-psw)
21+
* [Prerequisites](#prerequisites-2)
22+
* [Install the Intel(R) SGX PSW](#install-the-intelr-sgx-psw-1)
23+
* [Using the local repo(recommended)](#using-the-local-reporecommended)
24+
* [Using the individual packages](#using-the-individual-packages)
25+
* [Upgrade from a legacy installation](#upgrade-from-a-legacy-installation)
26+
* [Configure the installation](#configure-the-installation)
27+
* [ECDSA attestation](#ecdsa-attestation)
28+
* [Start or Stop aesmd Service](#start-or-stop-aesmd-service)
29+
* [Configure the Proxy for aesmd Service](#configure-the-proxy-for-aesmd-service)
30+
* [Reproducibility](#reproducibility)
731

832
Introduction
933
------------
@@ -359,36 +383,37 @@ Install the Intel(R) SGX PSW
359383
### Install the Intel(R) SGX PSW
360384
- The SGX PSW provides 3 services: launch, EPID-based attestation, and algorithm agnostic attestation. Starting with the 2.8 release, the SGX PSW is split into smaller packages and the user can choose which features and services to install. There are 2 methods to install the required packages: Using individual packages or using the local repo generated by the build system. Using the local repo is recommended since the system will resolve the dependencies automatically. Currently, we support .deb and .rpm based repos.
361385
362-
#### Using the local repo(recommended)
386+
#### Using the local repo(recommended)
363387
364-
| |Ubuntu 16.04, Ubuntu 18.04 and Ubuntu 20.04|Red Hat Enterprise Linux 7.6, Red Hat Enterprise Linux 8.2, CentOS 8.2, Fedora 31|
365-
| ------------ | ------------ | ------------ |
366-
|launch service |apt-get install libsgx-launch libsgx-urts|yum install libsgx-launch libsgx-urts|
367-
|EPID-based attestation service|apt-get install libsgx-epid libsgx-urts|yum install libsgx-epid libsgx-urts|
368-
|algorithm agnostic attestation service|apt-get install libsgx-quote-ex libsgx-urts|yum install libsgx-quote-ex libsgx-urts|
369-
|DCAP ECDSA-based service(Ubuntu16.04 not included)|apt-get install libsgx-dcap-ql|yum install libsgx-dcap-ql|
388+
| |Ubuntu 16.04, Ubuntu 18.04 and Ubuntu 20.04|Red Hat Enterprise Linux 7.6, Red Hat Enterprise Linux 8.2, CentOS 8.2, Fedora 31|
389+
| ------------ | ------------ | ------------ |
390+
|launch service |apt-get install libsgx-launch libsgx-urts|yum install libsgx-launch libsgx-urts|
391+
|EPID-based attestation service|apt-get install libsgx-epid libsgx-urts|yum install libsgx-epid libsgx-urts|
392+
|algorithm agnostic attestation service|apt-get install libsgx-quote-ex libsgx-urts|yum install libsgx-quote-ex libsgx-urts|
393+
|DCAP ECDSA-based service(Ubuntu16.04 not included)|apt-get install libsgx-dcap-ql|yum install libsgx-dcap-ql|
370394
371-
Optionally, you can install *-dbgsym or *-debuginfo packages to get the debug symbols, and install *-dev or *-devel packages to get the header files for development.
395+
Optionally, you can install *-dbgsym or *-debuginfo packages to get the debug symbols, and install *-dev or *-devel packages to get the header files for development.
372396
373-
**NOTE**: To debug with sgx-gdb on Ubuntu 16.04, you need to ensure the Intel(R) SGX PSW is built under the condition that the environment variable ``DEB_BUILD_OPTIONS="nostrip"`` is set.
397+
**NOTE**: To debug with sgx-gdb on Ubuntu 16.04, you need to ensure the Intel(R) SGX PSW is built under the condition that the environment variable ``DEB_BUILD_OPTIONS="nostrip"`` is set.
374398
375-
#### Using the individual packages
376-
Please refer [Intel_SGX_Installation_Guide_Linux](https://download.01.org/intel-sgx/latest/linux-latest/docs/) for detail.
399+
#### Using the individual packages
400+
Please refer [Intel_SGX_Installation_Guide_Linux](https://download.01.org/intel-sgx/latest/linux-latest/docs/) for detail.
377401
378-
#### Upgrade from a legacy installation
379-
Sometimes we will split old package into smaller ones or move file between different packages. In such cases, you will encounter error messages like: "dpkg: error processing archive ....(--unpack): trying to overwrite ...". You can use 2 methods to address it.
380-
* Uninstall the old installation first, then install new packages.
381-
* Add ``-o Dpkg::Options::="--force-overwrite"`` option to overwrite existing files and use “``dist-upgrade``” instead of "upgrade" to install new packages when upgrading. In short, you should use this command:
382-
```
383-
apt-get dist-upgrade -o Dpkg::Options::="--force-overwrite"
384-
```
385-
#### Configure the installation
386-
Some packages are configured with recommended dependency on other packages that are not required for certain usage. For instance, the background daemon is not required for container usage. It will be installed by default, but you can drop it by using the additional option during the installation.
387-
* On Ubuntu 16.04, Ubuntu 18.04 and Ubuntu 20.04:
388-
```
389-
--no-install-recommends
390-
```
391-
**NOTE** On rpm based system, rpmbuild>=4.12 is required to enable similar features.
402+
#### Upgrade from a legacy installation
403+
Sometimes we will split old package into smaller ones or move file between different packages. In such cases, you will encounter error messages like: "dpkg: error processing archive ....(--unpack): trying to overwrite ...". You can use 2 methods to address it.
404+
* Uninstall the old installation first, then install new packages.
405+
* Add ``-o Dpkg::Options::="--force-overwrite"`` option to overwrite existing files and use “``dist-upgrade``” instead of "upgrade" to install new packages when upgrading. In short, you should use this command:
406+
```
407+
apt-get dist-upgrade -o Dpkg::Options::="--force-overwrite"
408+
```
409+
410+
#### Configure the installation
411+
Some packages are configured with recommended dependency on other packages that are not required for certain usage. For instance, the background daemon is not required for container usage. It will be installed by default, but you can drop it by using the additional option during the installation.
412+
* On Ubuntu 16.04, Ubuntu 18.04 and Ubuntu 20.04:
413+
```
414+
--no-install-recommends
415+
```
416+
**NOTE** On rpm based system, rpmbuild>=4.12 is required to enable similar features.
392417
393418
### ECDSA attestation
394419
To enable ECDSA attestation

0 commit comments

Comments
 (0)