diff --git a/README.md b/README.md index 70648cb..5706cfc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # clevis-pin-tpm2 Rewritten Clevis TPM2 PIN + +This rewrite supports all previously encrypted values of the PCR-only clevis TPM2 PIN. +Additionally, it supports Authorized Policies to delegate authorization of PCR values to an external party. + + +## Creating policies + +A [reference implementation](https://github.com/puiterwijk/clevis-pin-tpm2-signtool) has been made available for creating policies as parsed by this pin. +To use this, first create a policy (see instructions in the repository) and take the output signed policy and the public key JSON. +These files need to be available when the PIN runs, so if the pin is used to encrypt the filesystem root, it will probably need to be in /boot. +Then run: `$binary encrypt '{"policy_pubkey_path": "/boot/policy_pubkey.json", "policy_ref": "", "policy_path": "/boot/policy.json"}'