Skip to content

Commit

Permalink
feat(hss-payload-gen): Update README
Browse files Browse the repository at this point in the history
See README.md in tools/hss-payload-generator for more
details on verifying code signing with hss-payload-generator,
specifically when performing payload generator or payload inspection.

Signed-off-by: Ivan Griffin <[email protected]>
  • Loading branch information
griffini authored and Ivan Griffin committed Oct 14, 2024
1 parent f91740f commit aec7250
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions tools/hss-payload-generator/README.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
% HSS Payload Generator
% 2022-09-02
% 2024-10-14

# Introduction

Expand All @@ -21,10 +21,17 @@ To print diagnostics about a pre-existing image, use `-d`:

To enable secure boot authentication (via image signing), use `-p` to specify the location of an X.509 Private Key for the Elliptic Curve P-384 (SECP384r1):

$ ./hss-payload-generator -c test/config.yaml payload.bin -p /path/to/private.pem
$ ./hss-payload-generator -c test/config.yaml -p /path/to/private.pem payload.bin

See the documentation on secure boot authentication for more details.

To verify secure boot code signing, use the `-u` option to specify the location of a DER format Public Key for the Elliptic Curve P-384 (SECP384r1). This option is compatible with either `-p` (during generation) or `-d` during image inspection - for example:

$ ./hss-payload-generator -p x509-ec-secp384r1-private.pem -c config.yaml -u x509-ec-secp384r1-public.der payload.bin
$ ./hss-payload-generator -u x509-ec-secp384r1-public.der -d payload.bin

NOTE: specifically when on Microsoft Windows, ensure that the `payload.bin` argument is at the end of the command line when creating a payload image. We recommend also making the `payload.bin` argument the last argument on Linux.

## Config File example

First, we can optionally set a name for our image, otherwise one will be created dynamically:
Expand Down

0 comments on commit aec7250

Please sign in to comment.