Skip to content

Commit acd102d

Browse files
committed
update docs, fix typos
1 parent 8b059c4 commit acd102d

File tree

8 files changed

+18
-1769
lines changed

8 files changed

+18
-1769
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `Trusted Platform` uses a [Trusted Platform Module (TPM)](https://en.wikiped
66

77
## Overview
88

9-
For detailed documentationon the components used in this project, please refer to the [docs](docs/OVERVIEW.md).
9+
For detailed documentation on the components used in this project, please refer to the [docs](docs/OVERVIEW.md).
1010

1111
## Build
1212

@@ -40,7 +40,7 @@ Use the included `Makefile` to build and perform initial setup.
4040

4141
Copy the [config file](configs/platform/config.dev.yaml) to the root of the project directory where you will run the `trusted-platform` binary. Edit the configuration file according to your environment and requirements.
4242

43-
Use [tpm2_getekcertificate](https://github.com/tpm2-software/tpm2-tools/blob/master/man/tpm2_getekcertificate.1.md) to dump your TPM Endorsement Key to the project directory where you will run the `trusted-platform` binary. Follow the example and use the ECcert.bin file name, or edit the config file to match the custom name you choose for your EK certificate in the TPM section of the config.
43+
Use [tpm2_getekcertificate](https://github.com/tpm2-software/tpm2-tools/blob/master/man/tpm2_getekcertificate.1.md) to dump your TPM Endorsement Key x509 certificate to the project directory where you will run the `trusted-platform` binary. Follow the example and use the ECcert.bin file name, or edit the config file to match the custom name you choose for your EK certificate in the TPM section of the platform configuration file.
4444

4545
Start the embedded web services:
4646

@@ -58,14 +58,14 @@ During platform setup, several passwords are collected to encrypt and password p
5858

5959
* Root Certificate Authority Private Key Password
6060
* Intermediate Certificate Authority Private Key Password
61-
* Web Server Private Key Password
61+
* Web Server TLS Private Key Password
6262

6363
To automate the platform setup for testing, these passwords can be set in the configuration file, which will cause the setup to bypass the inital prompts and use the passwords defined in the config. This mechanism should only be used for testing, evaluation or development.
6464

6565

6666
## LUKS
6767

68-
At this time, preliminary support for LUKS is included in the `Makefile`. In the future, full LUKS integration will be provided.
68+
At this time, preliminary support for LUKS is included in the `Makefile`. In the future, full LUKS integration will be provided through the platform.
6969

7070
To setup an ecnrypted LUKS `trusted-data` volume for platform data, use the included `luks-create` Makefile target.
7171

@@ -85,16 +85,14 @@ If you don't trust the trusted `Makefile`, you can create your own key file and
8585

8686
Then you can use the `luks-mount` target to mount your volume prior to starting the platform.
8787

88-
Don't forget to remove your LUKS key from the system. In the future, this step will be fully automated and the key will be sealed to the TPM Endorsement Key.
88+
Don't forget to remove your LUKS key from the system. In the future, this step will be fully automated and the key will be sealed to the TPM.
8989

9090

9191
## Platform Startup & Local Attestation
9292

9393
When the platform starts up, the Certificate Authorities are initialized, resulting in a Root and Intermeidate CA with public / private keys, a signing certificate, and a dedicated encryption key. The Intermediate CA will have the Root CA's certificate imported to its trusted root store. Each CA's Certificate Revocation List is created and initialized with a dummy certificate.
9494

95-
After the CA is initialized, local system platform measurements are taken according to the platform configuration file, signed by the CA, and stored in the CA's internal blob storage along with it's signature. Each time the platform is subsequently started, new system measurements are taken, a new digest is created from the new measurements, and verified against the initial platform measurements signature. If the signgature does not match (verification failed), the platform will return a fatal error and terminate.
96-
97-
In the future, custom local attestation failure event handlers will be supported.
95+
After the CA is initialized, local system platform measurements are taken according to the platform configuration file, signed by the CA, and stored in the CA's internal blob store along, with the digest and signature of the measurements. On subsequent startups, new system measurements are taken, a new digest is created and then verified against the initial platform measurements signature. If the signature does not match (verification failed), the platform will return a fatal error and terminate. In the future, it will also re-seal the platform by unmounting the LUKS volume and run a set of custom event handlers that allow responding to the unexpected state of the system any way you want.
9896

9997

10098
## Remote Attestation
@@ -107,7 +105,7 @@ Full remote attestation is working. Test it out using the provided `Makefile` ta
107105
# Verifier
108106
make verifier
109107

110-
After attestation completes, you should see a new `attestation` folder appear with something like this:
108+
After attestation completes, you should see a new `attestation` folder appear that looks something like this:
111109

112110
```
113111
.

config.yaml

Lines changed: 0 additions & 323 deletions
This file was deleted.

0 commit comments

Comments
 (0)