Security: Add HashLibTdx

RFC: https://bugzilla.tianocore.org/show_bug.cgi?id=3853

This library provides hash service by registered hash handler in Td
guest. Currently only SHA384 is supported. After that the hash value is
extended to Td RTMR registers which is similar to TPM PCRs.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
Signed-off-by: Min Xu <min.m.xu@intel.com>

3 files changed, 254 insertions, 0 deletions

diff --git a/SecurityPkg/Library/HashLibTdx/HashLibTdx.c b/SecurityPkg/Library/HashLibTdx/HashLibTdx.c
new file mode 100644
index 0000000..75d96ee
--- /dev/null
+++ b/SecurityPkg/Library/HashLibTdx/HashLibTdx.c
@@ -0,0 +1,207 @@
+/** @file

+  This library is HashLib for Tdx.

+

+Copyright (c) 2021 - 2022, Intel Corporation. All rights reserved. <BR>

+SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include <PiPei.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/DebugLib.h>

+#include <Library/PcdLib.h>

+#include <Library/HashLib.h>

+#include <Library/TdxLib.h>

+#include <Protocol/CcMeasurement.h>

+

+EFI_GUID  mSha384Guid = HASH_ALGORITHM_SHA384_GUID;

+

+//

+// Currently TDX supports SHA384.

+//

+HASH_INTERFACE  mHashInterface =  {

+  { 0 }, NULL, NULL, NULL

+};

+

+UINTN  mHashInterfaceCount = 0;

+

+/**

+  Start hash sequence.

+

+  @param HashHandle Hash handle.

+

+  @retval EFI_SUCCESS          Hash sequence start and HandleHandle returned.

+  @retval EFI_OUT_OF_RESOURCES No enough resource to start hash.

+**/

+EFI_STATUS

+EFIAPI

+HashStart (

+  OUT HASH_HANDLE  *HashHandle

+  )

+{

+  HASH_HANDLE  HashCtx;

+

+  if (mHashInterfaceCount == 0) {

+    ASSERT (FALSE);

+    return EFI_UNSUPPORTED;

+  }

+

+  HashCtx = 0;

+  mHashInterface.HashInit (&HashCtx);

+

+  *HashHandle = HashCtx;

+

+  return EFI_SUCCESS;

+}

+

+/**

+  Update hash sequence data.

+

+  @param HashHandle    Hash handle.

+  @param DataToHash    Data to be hashed.

+  @param DataToHashLen Data size.

+

+  @retval EFI_SUCCESS     Hash sequence updated.

+**/

+EFI_STATUS

+EFIAPI

+HashUpdate (

+  IN HASH_HANDLE  HashHandle,

+  IN VOID         *DataToHash,

+  IN UINTN        DataToHashLen

+  )

+{

+  if (mHashInterfaceCount == 0) {

+    ASSERT (FALSE);

+    return EFI_UNSUPPORTED;

+  }

+

+  mHashInterface.HashUpdate (HashHandle, DataToHash, DataToHashLen);

+

+  return EFI_SUCCESS;

+}

+

+/**

+  Hash sequence complete and extend to PCR.

+

+  @param HashHandle    Hash handle.

+  @param PcrIndex      PCR to be extended.

+  @param DataToHash    Data to be hashed.

+  @param DataToHashLen Data size.

+  @param DigestList    Digest list.

+

+  @retval EFI_SUCCESS     Hash sequence complete and DigestList is returned.

+**/

+EFI_STATUS

+EFIAPI

+HashCompleteAndExtend (

+  IN HASH_HANDLE          HashHandle,

+  IN TPMI_DH_PCR          PcrIndex,

+  IN VOID                 *DataToHash,

+  IN UINTN                DataToHashLen,

+  OUT TPML_DIGEST_VALUES  *DigestList

+  )

+{

+  TPML_DIGEST_VALUES  Digest;

+  EFI_STATUS          Status;

+

+  if (mHashInterfaceCount == 0) {

+    ASSERT (FALSE);

+    return EFI_UNSUPPORTED;

+  }

+

+  ZeroMem (DigestList, sizeof (*DigestList));

+

+  mHashInterface.HashUpdate (HashHandle, DataToHash, DataToHashLen);

+  mHashInterface.HashFinal (HashHandle, &Digest);

+

+  CopyMem (

+    &DigestList->digests[0],

+    &Digest.digests[0],

+    sizeof (Digest.digests[0])

+    );

+  DigestList->count++;

+

+  ASSERT (DigestList->count == 1 && DigestList->digests[0].hashAlg == TPM_ALG_SHA384);

+

+  Status = TdExtendRtmr (

+             (UINT32 *)DigestList->digests[0].digest.sha384,

+             SHA384_DIGEST_SIZE,

+             (UINT8)PcrIndex

+             );

+

+  ASSERT (!EFI_ERROR (Status));

+  return Status;

+}

+

+/**

+  Hash data and extend to RTMR.

+

+  @param PcrIndex      PCR to be extended.

+  @param DataToHash    Data to be hashed.

+  @param DataToHashLen Data size.

+  @param DigestList    Digest list.

+

+  @retval EFI_SUCCESS     Hash data and DigestList is returned.

+**/

+EFI_STATUS

+EFIAPI

+HashAndExtend (

+  IN TPMI_DH_PCR          PcrIndex,

+  IN VOID                 *DataToHash,

+  IN UINTN                DataToHashLen,

+  OUT TPML_DIGEST_VALUES  *DigestList

+  )

+{

+  HASH_HANDLE  HashHandle;

+  EFI_STATUS   Status;

+

+  if (mHashInterfaceCount == 0) {

+    ASSERT (FALSE);

+    return EFI_UNSUPPORTED;

+  }

+

+  ASSERT (TdIsEnabled ());

+

+  HashStart (&HashHandle);

+  HashUpdate (HashHandle, DataToHash, DataToHashLen);

+  Status = HashCompleteAndExtend (HashHandle, PcrIndex, NULL, 0, DigestList);

+

+  return Status;

+}

+

+/**

+  This service register Hash.

+

+  @param HashInterface  Hash interface

+

+  @retval EFI_SUCCESS          This hash interface is registered successfully.

+  @retval EFI_UNSUPPORTED      System does not support register this interface.

+  @retval EFI_ALREADY_STARTED  System already register this interface.

+**/

+EFI_STATUS

+EFIAPI

+RegisterHashInterfaceLib (

+  IN HASH_INTERFACE  *HashInterface

+  )

+{

+  ASSERT (TdIsEnabled ());

+

+  //

+  // Only SHA384 is allowed.

+  //

+  if (!CompareGuid (&mSha384Guid, &HashInterface->HashGuid)) {

+    return EFI_UNSUPPORTED;

+  }

+

+  if (mHashInterfaceCount != 0) {

+    ASSERT (FALSE);

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  CopyMem (&mHashInterface, HashInterface, sizeof (*HashInterface));

+  mHashInterfaceCount++;

+

+  return EFI_SUCCESS;

+}

diff --git a/SecurityPkg/Library/HashLibTdx/HashLibTdx.inf b/SecurityPkg/Library/HashLibTdx/HashLibTdx.inf
new file mode 100644
index 0000000..9461321
--- /dev/null
+++ b/SecurityPkg/Library/HashLibTdx/HashLibTdx.inf
@@ -0,0 +1,37 @@
+## @file

+#  Provides hash service by registered hash handler in Tdx.

+#

+#  This library is HashLib for Tdx. Currently only SHA384 is supported.

+#

+# Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR>

+# SPDX-License-Identifier: BSD-2-Clause-Patent

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = HashLibTdx

+  FILE_GUID                      = 77F6EA3E-1ABA-4467-A447-926E8CEB2D13

+  MODULE_TYPE                    = BASE

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = HashLib|SEC DXE_DRIVER

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = X64

+#

+

+[Sources]

+  HashLibTdx.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+  SecurityPkg/SecurityPkg.dec

+

+[LibraryClasses]

+  BaseLib

+  BaseMemoryLib

+  DebugLib

+  PcdLib

+  TdxLib

diff --git a/SecurityPkg/SecurityPkg.dsc b/SecurityPkg/SecurityPkg.dsc
index 73a93c2..0d8c997 100644
--- a/SecurityPkg/SecurityPkg.dsc
+++ b/SecurityPkg/SecurityPkg.dsc
@@ -72,6 +72,7 @@
   MmUnblockMemoryLib|MdePkg/Library/MmUnblockMemoryLib/MmUnblockMemoryLibNull.inf

   SecureBootVariableLib|SecurityPkg/Library/SecureBootVariableLib/SecureBootVariableLib.inf

   SecureBootVariableProvisionLib|SecurityPkg/Library/SecureBootVariableProvisionLib/SecureBootVariableProvisionLib.inf

+  TdxLib|MdePkg/Library/TdxLib/TdxLib.inf

 

 [LibraryClasses.ARM, LibraryClasses.AARCH64]

   #

@@ -92,6 +93,12 @@
 [LibraryClasses.RISCV64]

   RngLib|MdePkg/Library/BaseRngLibTimerLib/BaseRngLibTimerLib.inf

 

+[LibraryClasses.X64.SEC]

+  HashLib|SecurityPkg/Library/HashLibTdx/HashLibTdx.inf

+

+[LibraryClasses.X64.DXE_DRIVER]

+  HashLib|SecurityPkg/Library/HashLibTdx/HashLibTdx.inf

+

 [LibraryClasses.common.PEIM]

   PeimEntryPoint|MdePkg/Library/PeimEntryPoint/PeimEntryPoint.inf

   PeiServicesLib|MdePkg/Library/PeiServicesLib/PeiServicesLib.inf

@@ -283,6 +290,9 @@
   #

   SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.inf

 

+[Components.X64]

+  SecurityPkg/Library/HashLibTdx/HashLibTdx.inf

+

 [Components.IA32, Components.X64]

   SecurityPkg/VariableAuthenticated/SecureBootConfigDxe/SecureBootConfigDxe.inf