Skip to content

Commit

Permalink
Update the readme files.
Browse files Browse the repository at this point in the history
1. Update the name of the linux-modules-extra package.
2. Remove the trailing whitespaces.

Signed-off-by: Qinkun Bao <qinkun@google.com>
  • Loading branch information
qinkunbao committed Jul 30, 2024
1 parent f1a89eb commit 71d7dc8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,20 +110,20 @@ This type contains five fields:

## `rtmr`

This library should be used within the confidential workload to perform a hash
This library should be used within the confidential workload to perform a hash
extend operation into the TDX RTMR register.

### `func ExtendEventLog(rtmrIndex int, hashAlgo crypto.Hash, eventLog []byte) error`

This function calculates the hash digest of a provided event log and extends it
in the corresponding RTMR register. However, it's important to note that TDX
currently only supports the SHA-384 hash algorithm. If `hashAlgo` is not SHA-384,
This function calculates the hash digest of a provided event log and extends it
in the corresponding RTMR register. However, it's important to note that TDX
currently only supports the SHA-384 hash algorithm. If `hashAlgo` is not SHA-384,
the function will return an error.

### `func ExtendDigest(rtmrIndex int, digest []byte) error`

This function extends a SHA-384 digest into the corresponding RTMR register.
If the length of the given digest does not match that of a SHA-384 digest,
This function extends a SHA-384 digest into the corresponding RTMR register.
If the length of the given digest does not match that of a SHA-384 digest,
the function will return an error.

## License
Expand Down
2 changes: 1 addition & 1 deletion tools/attest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ and either manually load the module or reboot.
To install the linux-modules-extra package, run:

```console
sudo apt-get install linux-modules-extra-gcp
sudo apt-get install linux-modules-extra-$(uname -r)
```

To manually load the module, run:
Expand Down

0 comments on commit 71d7dc8

Please sign in to comment.