]> git.proxmox.com Git - mirror_edk2.git/blobdiff - CryptoPkg/Test/UnitTest/Library/BaseCryptLib/HmacTests.c
CryptoPkg/Test/UnitTest/Library/BaseCryptLib: Unit test fixes
[mirror_edk2.git] / CryptoPkg / Test / UnitTest / Library / BaseCryptLib / HmacTests.c
index 2e0cdd7c45703960dcf2248069758d1217b41102..b347cb4cb4f8e839623e686f343294f6f3ce8654 100644 (file)
@@ -11,68 +11,91 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 //\r
 // Max Known Digest Size is SHA512 Output (64 bytes) by far\r
 //\r
-#define MAX_DIGEST_SIZE    64\r
+#define MAX_DIGEST_SIZE  64\r
 \r
 //\r
 // Data string for HMAC validation\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *HmacData = "Hi There";\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8  *HmacData = "Hi There";\r
 \r
 //\r
 // Key value for HMAC-MD5 validation. (From "2. Test Cases for HMAC-MD5" of IETF RFC2202)\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 HmacMd5Key[16] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacMd5Key[16] = {\r
   0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b\r
-  };\r
+};\r
 \r
 //\r
 // Result for HMAC-MD5("Hi There"). (From "2. Test Cases for HMAC-MD5" of IETF RFC2202)\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 HmacMd5Digest[] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacMd5Digest[] = {\r
   0x92, 0x94, 0x72, 0x7a, 0x36, 0x38, 0xbb, 0x1c, 0x13, 0xf4, 0x8e, 0xf8, 0x15, 0x8b, 0xfc, 0x9d\r
-  };\r
+};\r
 \r
 //\r
 // Key value for HMAC-SHA-1 validation. (From "3. Test Cases for HMAC-SHA-1" of IETF RFC2202)\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 HmacSha1Key[20] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacSha1Key[20] = {\r
   0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,\r
   0x0b, 0x0b, 0x0b, 0x0b\r
-  };\r
+};\r
 \r
 //\r
 // Result for HMAC-SHA-1 ("Hi There"). (From "3. Test Cases for HMAC-SHA-1" of IETF RFC2202)\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 HmacSha1Digest[] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacSha1Digest[] = {\r
   0xb6, 0x17, 0x31, 0x86, 0x55, 0x05, 0x72, 0x64, 0xe2, 0x8b, 0xc0, 0xb6, 0xfb, 0x37, 0x8c, 0x8e,\r
   0xf1, 0x46, 0xbe, 0x00\r
-  };\r
+};\r
 \r
 //\r
 // Key value for HMAC-SHA-256 validation. (From "4. Test Vectors" of IETF RFC4231)\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 HmacSha256Key[20] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacSha256Key[20] = {\r
   0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,\r
   0x0b, 0x0b, 0x0b, 0x0b\r
-  };\r
+};\r
 \r
 //\r
 // Result for HMAC-SHA-256 ("Hi There"). (From "4. Test Vectors" of IETF RFC4231)\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 HmacSha256Digest[] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacSha256Digest[] = {\r
   0xb0, 0x34, 0x4c, 0x61, 0xd8, 0xdb, 0x38, 0x53, 0x5c, 0xa8, 0xaf, 0xce, 0xaf, 0x0b, 0xf1, 0x2b,\r
   0x88, 0x1d, 0xc2, 0x00, 0xc9, 0x83, 0x3d, 0xa7, 0x26, 0xe9, 0x37, 0x6c, 0x2e, 0x32, 0xcf, 0xf7\r
-  };\r
+};\r
+\r
+//\r
+// Key value for HMAC-SHA-384 validation. (From "4. Test Vectors" of IETF RFC4231)\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacSha384Key[20] = {\r
+  0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b,\r
+  0x0b, 0x0b, 0x0b, 0x0b\r
+};\r
+\r
+//\r
+// Result for HMAC-SHA-384 ("Hi There"). (From "4. Test Vectors" of IETF RFC4231)\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  HmacSha384Digest[] = {\r
+  0xaf, 0xd0, 0x39, 0x44, 0xd8, 0x48, 0x95, 0x62, 0x6b, 0x08, 0x25, 0xf4, 0xab, 0x46, 0x90, 0x7f,\r
+  0x15, 0xf9, 0xda, 0xdb, 0xe4, 0x10, 0x1e, 0xc6, 0x82, 0xaa, 0x03, 0x4c, 0x7c, 0xeb, 0xc5, 0x9c,\r
+  0xfa, 0xea, 0x9e, 0xa9, 0x07, 0x6e, 0xde, 0x7f, 0x4a, 0xf1, 0x52, 0xe8, 0xb2, 0xfa, 0x9c, 0xb6\r
+};\r
 \r
 typedef\r
-VOID*\r
-(EFIAPI *EFI_HMAC_NEW) (\r
+VOID *\r
+(EFIAPI *EFI_HMAC_NEW)(\r
   VOID\r
   );\r
 \r
+typedef\r
+VOID\r
+(EFIAPI *EFI_HMAC_FREE)(\r
+  IN VOID  *HashContext\r
+  );\r
+\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_HMAC_INIT) (\r
+(EFIAPI *EFI_HMAC_INIT)(\r
   IN OUT  VOID        *HashContext,\r
   IN   CONST UINT8    *Key,\r
   IN   UINTN           KeySize\r
@@ -80,7 +103,7 @@ BOOLEAN
 \r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_HMAC_UPDATE) (\r
+(EFIAPI *EFI_HMAC_UPDATE)(\r
   IN OUT  VOID        *HashContext,\r
   IN      CONST VOID  *Data,\r
   IN      UINTN       DataSize\r
@@ -88,39 +111,40 @@ BOOLEAN
 \r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_HMAC_FINAL) (\r
+(EFIAPI *EFI_HMAC_FINAL)(\r
   IN OUT  VOID   *HashContext,\r
   OUT     UINT8  *HashValue\r
   );\r
 \r
 typedef struct {\r
-  UINT32                     DigestSize;\r
-  EFI_HMAC_NEW               HmacNew;\r
-  EFI_HMAC_INIT              HmacInit;\r
-  EFI_HMAC_UPDATE            HmacUpdate;\r
-  EFI_HMAC_FINAL             HmacFinal;\r
-  CONST UINT8                *Key;\r
-  UINTN                      KeySize;\r
-  CONST UINT8                *Digest;\r
-  VOID                       *HmacCtx;\r
+  UINT32             DigestSize;\r
+  EFI_HMAC_NEW       HmacNew;\r
+  EFI_HMAC_FREE      HmacFree;\r
+  EFI_HMAC_INIT      HmacInit;\r
+  EFI_HMAC_UPDATE    HmacUpdate;\r
+  EFI_HMAC_FINAL     HmacFinal;\r
+  CONST UINT8        *Key;\r
+  UINTN              KeySize;\r
+  CONST UINT8        *Digest;\r
+  VOID               *HmacCtx;\r
 } HMAC_TEST_CONTEXT;\r
 \r
 // These functions have been deprecated but they've been left commented out for future reference\r
-//HMAC_TEST_CONTEXT       mHmacMd5TestCtx    = {MD5_DIGEST_SIZE,    HmacMd5New,    HmacMd5SetKey,    HmacMd5Update,    HmacMd5Final,    HmacMd5Key,    sizeof(HmacMd5Key),    HmacMd5Digest};\r
-//HMAC_TEST_CONTEXT       mHmacSha1TestCtx   = {SHA1_DIGEST_SIZE,   HmacSha1New,   HmacSha1SetKey,   HmacSha1Update,   HmacSha1Final,   HmacSha1Key,   sizeof(HmacSha1Key),   HmacSha1Digest};\r
-HMAC_TEST_CONTEXT       mHmacSha256TestCtx = {SHA256_DIGEST_SIZE, HmacSha256New, HmacSha256SetKey, HmacSha256Update, HmacSha256Final, HmacSha256Key, sizeof(HmacSha256Key), HmacSha256Digest};\r
-\r
+// HMAC_TEST_CONTEXT       mHmacMd5TestCtx    = {MD5_DIGEST_SIZE,    HmacMd5New,    HmacMd5Free,  HmacMd5SetKey,    HmacMd5Update,    HmacMd5Final,    HmacMd5Key,    sizeof(HmacMd5Key),    HmacMd5Digest};\r
+// HMAC_TEST_CONTEXT       mHmacSha1TestCtx   = {SHA1_DIGEST_SIZE,   HmacSha1New,   HmacSha1Free, HmacSha1SetKey,   HmacSha1Update,   HmacSha1Final,   HmacSha1Key,   sizeof(HmacSha1Key),   HmacSha1Digest};\r
+HMAC_TEST_CONTEXT  mHmacSha256TestCtx = { SHA256_DIGEST_SIZE, HmacSha256New, HmacSha256Free, HmacSha256SetKey, HmacSha256Update, HmacSha256Final, HmacSha256Key, sizeof (HmacSha256Key), HmacSha256Digest };\r
+HMAC_TEST_CONTEXT  mHmacSha384TestCtx = { SHA384_DIGEST_SIZE, HmacSha384New, HmacSha384Free, HmacSha384SetKey, HmacSha384Update, HmacSha384Final, HmacSha384Key, sizeof (HmacSha384Key), HmacSha384Digest };\r
 \r
 UNIT_TEST_STATUS\r
 EFIAPI\r
 TestVerifyHmacPreReq (\r
-  UNIT_TEST_CONTEXT           Context\r
+  UNIT_TEST_CONTEXT  Context\r
   )\r
 {\r
-  HMAC_TEST_CONTEXT *HmacTestContext;\r
+  HMAC_TEST_CONTEXT  *HmacTestContext;\r
 \r
-  HmacTestContext = Context;\r
-  HmacTestContext->HmacCtx = HmacTestContext->HmacNew();\r
+  HmacTestContext          = Context;\r
+  HmacTestContext->HmacCtx = HmacTestContext->HmacNew ();\r
   if (HmacTestContext->HmacCtx == NULL) {\r
     return UNIT_TEST_ERROR_TEST_FAILED;\r
   }\r
@@ -131,38 +155,38 @@ TestVerifyHmacPreReq (
 VOID\r
 EFIAPI\r
 TestVerifyHmacCleanUp (\r
-  UNIT_TEST_CONTEXT           Context\r
+  UNIT_TEST_CONTEXT  Context\r
   )\r
 {\r
-  HMAC_TEST_CONTEXT *HmacTestContext;\r
+  HMAC_TEST_CONTEXT  *HmacTestContext;\r
 \r
   HmacTestContext = Context;\r
   if (HmacTestContext->HmacCtx != NULL) {\r
-    FreePool (HmacTestContext->HmacCtx);\r
+    HmacTestContext->HmacFree (HmacTestContext->HmacCtx);\r
   }\r
 }\r
 \r
 UNIT_TEST_STATUS\r
 EFIAPI\r
 TestVerifyHmac (\r
-  IN UNIT_TEST_CONTEXT           Context\r
+  IN UNIT_TEST_CONTEXT  Context\r
   )\r
 {\r
-  UINT8    Digest[MAX_DIGEST_SIZE];\r
-  BOOLEAN  Status;\r
-  HMAC_TEST_CONTEXT *HmacTestContext;\r
+  UINT8              Digest[MAX_DIGEST_SIZE];\r
+  BOOLEAN            Status;\r
+  HMAC_TEST_CONTEXT  *HmacTestContext;\r
 \r
   HmacTestContext = Context;\r
 \r
   ZeroMem (Digest, MAX_DIGEST_SIZE);\r
 \r
-  Status  = HmacTestContext->HmacInit (HmacTestContext->HmacCtx, HmacTestContext->Key, HmacTestContext->KeySize);\r
+  Status = HmacTestContext->HmacInit (HmacTestContext->HmacCtx, HmacTestContext->Key, HmacTestContext->KeySize);\r
   UT_ASSERT_TRUE (Status);\r
 \r
-  Status  = HmacTestContext->HmacUpdate (HmacTestContext->HmacCtx, HmacData, 8);\r
+  Status = HmacTestContext->HmacUpdate (HmacTestContext->HmacCtx, HmacData, 8);\r
   UT_ASSERT_TRUE (Status);\r
 \r
-  Status  = HmacTestContext->HmacFinal (HmacTestContext->HmacCtx, Digest);\r
+  Status = HmacTestContext->HmacFinal (HmacTestContext->HmacCtx, Digest);\r
   UT_ASSERT_TRUE (Status);\r
 \r
   UT_ASSERT_MEM_EQUAL (Digest, HmacTestContext->Digest, HmacTestContext->DigestSize);\r
@@ -170,15 +194,15 @@ TestVerifyHmac (
   return UNIT_TEST_PASSED;\r
 }\r
 \r
-TEST_DESC mHmacTest[] = {\r
-    //\r
-    // -----Description---------------------Class---------------------Function---------------Pre------------------Post------------Context\r
-    //\r
-    {"TestVerifyHmacSha256()", "CryptoPkg.BaseCryptLib.Hmac",   TestVerifyHmac, TestVerifyHmacPreReq, TestVerifyHmacCleanUp, &mHmacSha256TestCtx},\r
-    // These functions have been deprecated but they've been left commented out for future reference\r
-    //{"TestVerifyHmacMd5()",    "CryptoPkg.BaseCryptLib.Hmac",   TestVerifyHmac, TestVerifyHmacPreReq, TestVerifyHmacCleanUp, &mHmacMd5TestCtx},\r
-    //{"TestVerifyHmacSha1()",   "CryptoPkg.BaseCryptLib.Hmac",   TestVerifyHmac, TestVerifyHmacPreReq, TestVerifyHmacCleanUp, &mHmacSha1TestCtx},\r
-\r
+TEST_DESC  mHmacTest[] = {\r
+  //\r
+  // -----Description---------------------Class---------------------Function---------------Pre------------------Post------------Context\r
+  //\r
+  { "TestVerifyHmacSha256()", "CryptoPkg.BaseCryptLib.Hmac", TestVerifyHmac, TestVerifyHmacPreReq, TestVerifyHmacCleanUp, &mHmacSha256TestCtx },\r
+  { "TestVerifyHmacSha384()", "CryptoPkg.BaseCryptLib.Hmac", TestVerifyHmac, TestVerifyHmacPreReq, TestVerifyHmacCleanUp, &mHmacSha384TestCtx },\r
+  // These functions have been deprecated but they've been left commented out for future reference\r
+  // {"TestVerifyHmacMd5()",    "CryptoPkg.BaseCryptLib.Hmac",   TestVerifyHmac, TestVerifyHmacPreReq, TestVerifyHmacCleanUp, &mHmacMd5TestCtx},\r
+  // {"TestVerifyHmacSha1()",   "CryptoPkg.BaseCryptLib.Hmac",   TestVerifyHmac, TestVerifyHmacPreReq, TestVerifyHmacCleanUp, &mHmacSha1TestCtx},\r
 };\r
 \r
-UINTN mHmacTestNum = ARRAY_SIZE(mHmacTest);\r
+UINTN  mHmacTestNum = ARRAY_SIZE (mHmacTest);\r