SecurityPkg: Clean up source files

[mirror_edk2.git] / SecurityPkg / Library / HashLibBaseCryptoRouter / HashLibBaseCryptoRouterDxe.c

diff --git a/SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.c b/SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.c
index 8e93335e69dd8662b15d87e718af103f9e6c7a12..73a616a0dfa51945c0561c29dfc5a5b978419c7d 100644 (file)
--- a/SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.c
+++ b/SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.c
@@ -1,9 +1,9 @@
 /** @file\r
-  Ihis library is BaseCrypto router. It will redirect hash request to each individual\r
+  This library is BaseCrypto router. It will redirect hash request to each individual\r
   hash handler registerd, such as SHA1, SHA256.\r
   Platform can use PcdTpm2HashMask to mask some hash engines.\r
 \r
-Copyright (c) 2013, Intel Corporation. All rights reserved. <BR>\r
+Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved. <BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -25,9 +25,33 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "HashLibBaseCryptoRouterCommon.h"\r
 \r
-HASH_INTERFACE   mHashInterface[HASH_COUNT] = {0};\r
+HASH_INTERFACE   mHashInterface[HASH_COUNT] = {{{0}, NULL, NULL, NULL}};\r
 UINTN            mHashInterfaceCount = 0;\r
 \r
+UINT32           mSupportedHashMaskLast = 0;\r
+UINT32           mSupportedHashMaskCurrent = 0;\r
+\r
+/**\r
+  Check mismatch of supported HashMask between modules\r
+  that may link different HashInstanceLib instances.\r
+\r
+**/\r
+VOID\r
+CheckSupportedHashMaskMismatch (\r
+  VOID\r
+  )\r
+{\r
+  if (mSupportedHashMaskCurrent != mSupportedHashMaskLast) {\r
+    DEBUG ((\r
+      DEBUG_WARN,\r
+      "WARNING: There is mismatch of supported HashMask (0x%x - 0x%x) between modules\n",\r
+      mSupportedHashMaskCurrent,\r
+      mSupportedHashMaskLast\r
+      ));\r
+    DEBUG ((DEBUG_WARN, "that are linking different HashInstanceLib instances!\n"));\r
+  }\r
+}\r
+\r
 /**\r
   Start hash sequence.\r
 \r
@@ -44,16 +68,22 @@ HashStart (
 {\r
   HASH_HANDLE  *HashCtx;\r
   UINTN        Index;\r
+  UINT32       HashMask;\r
 \r
   if (mHashInterfaceCount == 0) {\r
     return EFI_UNSUPPORTED;\r
   }\r
 \r
+  CheckSupportedHashMaskMismatch ();\r
+\r
   HashCtx = AllocatePool (sizeof(*HashCtx) * mHashInterfaceCount);\r
   ASSERT (HashCtx != NULL);\r
 \r
   for (Index = 0; Index < mHashInterfaceCount; Index++) {\r
-    mHashInterface[Index].HashInit (&HashCtx[Index]);\r
+    HashMask = Tpm2GetHashMaskFromAlgo (&mHashInterface[Index].HashGuid);\r
+    if ((HashMask & PcdGet32 (PcdTpm2HashMask)) != 0) {\r
+      mHashInterface[Index].HashInit (&HashCtx[Index]);\r
+    }\r
   }\r
 \r
   *HashHandle = (HASH_HANDLE)HashCtx;\r
@@ -80,15 +110,21 @@ HashUpdate (
 {\r
   HASH_HANDLE  *HashCtx;\r
   UINTN        Index;\r
+  UINT32       HashMask;\r
 \r
   if (mHashInterfaceCount == 0) {\r
     return EFI_UNSUPPORTED;\r
   }\r
 \r
+  CheckSupportedHashMaskMismatch ();\r
+\r
   HashCtx = (HASH_HANDLE *)HashHandle;\r
 \r
   for (Index = 0; Index < mHashInterfaceCount; Index++) {\r
-    mHashInterface[Index].HashUpdate (HashCtx[Index], DataToHash, DataToHashLen);\r
+    HashMask = Tpm2GetHashMaskFromAlgo (&mHashInterface[Index].HashGuid);\r
+    if ((HashMask & PcdGet32 (PcdTpm2HashMask)) != 0) {\r
+      mHashInterface[Index].HashUpdate (HashCtx[Index], DataToHash, DataToHashLen);\r
+    }\r
   }\r
 \r
   return EFI_SUCCESS;\r
@@ -119,18 +155,24 @@ HashCompleteAndExtend (
   HASH_HANDLE        *HashCtx;\r
   UINTN              Index;\r
   EFI_STATUS         Status;\r
+  UINT32             HashMask;\r
 \r
   if (mHashInterfaceCount == 0) {\r
     return EFI_UNSUPPORTED;\r
   }\r
 \r
+  CheckSupportedHashMaskMismatch ();\r
+\r
   HashCtx = (HASH_HANDLE *)HashHandle;\r
   ZeroMem (DigestList, sizeof(*DigestList));\r
 \r
   for (Index = 0; Index < mHashInterfaceCount; Index++) {\r
-    mHashInterface[Index].HashUpdate (HashCtx[Index], DataToHash, DataToHashLen);\r
-    mHashInterface[Index].HashFinal (HashCtx[Index], &Digest);\r
-    Tpm2SetHashToDigestList (DigestList, &Digest);\r
+    HashMask = Tpm2GetHashMaskFromAlgo (&mHashInterface[Index].HashGuid);\r
+    if ((HashMask & PcdGet32 (PcdTpm2HashMask)) != 0) {\r
+      mHashInterface[Index].HashUpdate (HashCtx[Index], DataToHash, DataToHashLen);\r
+      mHashInterface[Index].HashFinal (HashCtx[Index], &Digest);\r
+      Tpm2SetHashToDigestList (DigestList, &Digest);\r
+    }\r
   }\r
 \r
   FreePool (HashCtx);\r
@@ -168,6 +210,8 @@ HashAndExtend (
     return EFI_UNSUPPORTED;\r
   }\r
 \r
+  CheckSupportedHashMaskMismatch ();\r
+\r
   HashStart (&HashHandle);\r
   HashUpdate (HashHandle, DataToHash, DataToHashLen);\r
   Status = HashCompleteAndExtend (HashHandle, PcrIndex, NULL, 0, DigestList);\r
@@ -192,6 +236,7 @@ RegisterHashInterfaceLib (
 {\r
   UINTN              Index;\r
   UINT32             HashMask;\r
+  EFI_STATUS         Status;\r
 \r
   //\r
   // Check allow\r
@@ -210,12 +255,52 @@ RegisterHashInterfaceLib (
   //\r
   for (Index = 0; Index < mHashInterfaceCount; Index++) {\r
     if (CompareGuid (&mHashInterface[Index].HashGuid, &HashInterface->HashGuid)) {\r
+      DEBUG ((DEBUG_ERROR, "Hash Interface (%g) has been registered\n", &HashInterface->HashGuid));\r
       return EFI_ALREADY_STARTED;\r
     }\r
   }\r
 \r
+  //\r
+  // Record hash algorithm bitmap of CURRENT module which consumes HashLib.\r
+  //\r
+  mSupportedHashMaskCurrent = PcdGet32 (PcdTcg2HashAlgorithmBitmap) | HashMask;\r
+  Status = PcdSet32S (PcdTcg2HashAlgorithmBitmap, mSupportedHashMaskCurrent);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   CopyMem (&mHashInterface[mHashInterfaceCount], HashInterface, sizeof(*HashInterface));\r
   mHashInterfaceCount ++;\r
-  \r
+\r
   return EFI_SUCCESS;\r
-}
\ No newline at end of file
+}\r
+\r
+/**\r
+  The constructor function of HashLibBaseCryptoRouterDxe.\r
+\r
+  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param  SystemTable   A pointer to the EFI System Table.\r
+\r
+  @retval EFI_SUCCESS   The constructor executed correctly.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HashLibBaseCryptoRouterDxeConstructor (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  )\r
+{\r
+  EFI_STATUS    Status;\r
+\r
+  //\r
+  // Record hash algorithm bitmap of LAST module which also consumes HashLib.\r
+  //\r
+  mSupportedHashMaskLast = PcdGet32 (PcdTcg2HashAlgorithmBitmap);\r
+\r
+  //\r
+  // Set PcdTcg2HashAlgorithmBitmap to 0 in CONSTRUCTOR for CURRENT module.\r
+  //\r
+  Status = PcdSet32S (PcdTcg2HashAlgorithmBitmap, 0);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  return EFI_SUCCESS;\r
+}\r