From 71d7dc88dad5be6b557578ac09077d9e44c1a764 Mon Sep 17 00:00:00 2001 From: Qinkun Bao Date: Tue, 30 Jul 2024 18:47:19 +0000 Subject: [PATCH] Update the readme files. 1. Update the name of the linux-modules-extra package. 2. Remove the trailing whitespaces. Signed-off-by: Qinkun Bao --- README.md | 12 ++++++------ tools/attest/README.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4296232..30bb93b 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/tools/attest/README.md b/tools/attest/README.md index 3574c16..ba55457 100644 --- a/tools/attest/README.md +++ b/tools/attest/README.md @@ -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: