CryptoPkg/Test/UnitTest/Library/BaseCryptLib/HashTests.c

   1 /** @file
   2   Application for Hash Primitives Validation.
   3
   4 Copyright (c) 2010 - 2020, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include "TestBaseCryptLib.h"
  10
  11 //
  12 // Max Known Digest Size is SHA512 Output (64 bytes) by far
  13 //
  14 #define MAX_DIGEST_SIZE  64
  15
  16 //
  17 // Message string for digest validation
  18 //
  19 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8  *HashData = "abc";
  20
  21 //
  22 // Result for MD5("abc"). (From "A.5 Test suite" of IETF RFC1321)
  23 //
  24 #ifdef ENABLE_MD5_DEPRECATED_INTERFACES
  25 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  Md5Digest[MD5_DIGEST_SIZE] = {
  26   0x90, 0x01, 0x50, 0x98, 0x3c, 0xd2, 0x4f, 0xb0, 0xd6, 0x96, 0x3f, 0x7d, 0x28, 0xe1, 0x7f, 0x72
  27 };
  28 #endif
  29
  30 //
  31 // Result for SHA-1("abc"). (From "A.1 SHA-1 Example" of NIST FIPS 180-2)
  32 //
  33 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  Sha1Digest[SHA1_DIGEST_SIZE] = {
  34   0xa9, 0x99, 0x3e, 0x36, 0x47, 0x06, 0x81, 0x6a, 0xba, 0x3e, 0x25, 0x71, 0x78, 0x50, 0xc2, 0x6c,
  35   0x9c, 0xd0, 0xd8, 0x9d
  36 };
  37
  38 //
  39 // Result for SHA-256("abc"). (From "B.1 SHA-256 Example" of NIST FIPS 180-2)
  40 //
  41 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  Sha256Digest[SHA256_DIGEST_SIZE] = {
  42   0xba, 0x78, 0x16, 0xbf, 0x8f, 0x01, 0xcf, 0xea, 0x41, 0x41, 0x40, 0xde, 0x5d, 0xae, 0x22, 0x23,
  43   0xb0, 0x03, 0x61, 0xa3, 0x96, 0x17, 0x7a, 0x9c, 0xb4, 0x10, 0xff, 0x61, 0xf2, 0x00, 0x15, 0xad
  44 };
  45
  46 //
  47 // Result for SHA-384("abc"). (From "D.1 SHA-384 Example" of NIST FIPS 180-2)
  48 //
  49 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  Sha384Digest[SHA384_DIGEST_SIZE] = {
  50   0xcb, 0x00, 0x75, 0x3f, 0x45, 0xa3, 0x5e, 0x8b, 0xb5, 0xa0, 0x3d, 0x69, 0x9a, 0xc6, 0x50, 0x07,
  51   0x27, 0x2c, 0x32, 0xab, 0x0e, 0xde, 0xd1, 0x63, 0x1a, 0x8b, 0x60, 0x5a, 0x43, 0xff, 0x5b, 0xed,
  52   0x80, 0x86, 0x07, 0x2b, 0xa1, 0xe7, 0xcc, 0x23, 0x58, 0xba, 0xec, 0xa1, 0x34, 0xc8, 0x25, 0xa7
  53 };
  54
  55 //
  56 // Result for SHA-512("abc"). (From "C.1 SHA-512 Example" of NIST FIPS 180-2)
  57 //
  58 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  Sha512Digest[SHA512_DIGEST_SIZE] = {
  59   0xdd, 0xaf, 0x35, 0xa1, 0x93, 0x61, 0x7a, 0xba, 0xcc, 0x41, 0x73, 0x49, 0xae, 0x20, 0x41, 0x31,
  60   0x12, 0xe6, 0xfa, 0x4e, 0x89, 0xa9, 0x7e, 0xa2, 0x0a, 0x9e, 0xee, 0xe6, 0x4b, 0x55, 0xd3, 0x9a,
  61   0x21, 0x92, 0x99, 0x2a, 0x27, 0x4f, 0xc1, 0xa8, 0x36, 0xba, 0x3c, 0x23, 0xa3, 0xfe, 0xeb, 0xbd,
  62   0x45, 0x4d, 0x44, 0x23, 0x64, 0x3c, 0xe8, 0x0e, 0x2a, 0x9a, 0xc9, 0x4f, 0xa5, 0x4c, 0xa4, 0x9f
  63 };
  64
  65 typedef
  66 UINTN
  67 (EFIAPI *EFI_HASH_GET_CONTEXT_SIZE)(
  68   VOID
  69   );
  70
  71 typedef
  72 BOOLEAN
  73 (EFIAPI *EFI_HASH_INIT)(
  74   OUT  VOID  *HashContext
  75   );
  76
  77 typedef
  78 BOOLEAN
  79 (EFIAPI *EFI_HASH_UPDATE)(
  80   IN OUT  VOID        *HashContext,
  81   IN      CONST VOID  *Data,
  82   IN      UINTN       DataSize
  83   );
  84
  85 typedef
  86 BOOLEAN
  87 (EFIAPI *EFI_HASH_FINAL)(
  88   IN OUT  VOID   *HashContext,
  89   OUT     UINT8  *HashValue
  90   );
  91
  92 typedef
  93 BOOLEAN
  94 (EFIAPI *EFI_HASH_ALL)(
  95   IN   CONST VOID  *Data,
  96   IN   UINTN       DataSize,
  97   OUT  UINT8       *HashValue
  98   );
  99
 100 typedef struct {
 101   UINT32                       DigestSize;
 102   EFI_HASH_GET_CONTEXT_SIZE    GetContextSize;
 103   EFI_HASH_INIT                HashInit;
 104   EFI_HASH_UPDATE              HashUpdate;
 105   EFI_HASH_FINAL               HashFinal;
 106   EFI_HASH_ALL                 HashAll;
 107   CONST UINT8                  *Digest;
 108   VOID                         *HashCtx;
 109 } HASH_TEST_CONTEXT;
 110
 111 #ifdef ENABLE_MD5_DEPRECATED_INTERFACES
 112 HASH_TEST_CONTEXT  mMd5TestCtx = { MD5_DIGEST_SIZE, Md5GetContextSize, Md5Init, Md5Update, Md5Final, Md5HashAll, Md5Digest };
 113 #endif
 114 HASH_TEST_CONTEXT  mSha1TestCtx   = { SHA1_DIGEST_SIZE, Sha1GetContextSize, Sha1Init, Sha1Update, Sha1Final, Sha1HashAll, Sha1Digest };
 115 HASH_TEST_CONTEXT  mSha256TestCtx = { SHA256_DIGEST_SIZE, Sha256GetContextSize, Sha256Init, Sha256Update, Sha256Final, Sha256HashAll, Sha256Digest };
 116 HASH_TEST_CONTEXT  mSha384TestCtx = { SHA384_DIGEST_SIZE, Sha384GetContextSize, Sha384Init, Sha384Update, Sha384Final, Sha384HashAll, Sha384Digest };
 117 HASH_TEST_CONTEXT  mSha512TestCtx = { SHA512_DIGEST_SIZE, Sha512GetContextSize, Sha512Init, Sha512Update, Sha512Final, Sha512HashAll, Sha512Digest };
 118
 119 UNIT_TEST_STATUS
 120 EFIAPI
 121 TestVerifyHashPreReq (
 122   UNIT_TEST_CONTEXT  Context
 123   )
 124 {
 125   HASH_TEST_CONTEXT  *HashTestContext;
 126   UINTN              CtxSize;
 127
 128   HashTestContext          = Context;
 129   CtxSize                  = HashTestContext->GetContextSize ();
 130   HashTestContext->HashCtx = AllocatePool (CtxSize);
 131   if (HashTestContext->HashCtx == NULL) {
 132     return UNIT_TEST_ERROR_TEST_FAILED;
 133   }
 134
 135   return UNIT_TEST_PASSED;
 136 }
 137
 138 VOID
 139 EFIAPI
 140 TestVerifyHashCleanUp (
 141   UNIT_TEST_CONTEXT  Context
 142   )
 143 {
 144   HASH_TEST_CONTEXT  *HashTestContext;
 145
 146   HashTestContext = Context;
 147   if (HashTestContext->HashCtx != NULL) {
 148     FreePool (HashTestContext->HashCtx);
 149   }
 150 }
 151
 152 UNIT_TEST_STATUS
 153 EFIAPI
 154 TestVerifyHash (
 155   IN UNIT_TEST_CONTEXT  Context
 156   )
 157 {
 158   UINTN              DataSize;
 159   UINT8              Digest[MAX_DIGEST_SIZE];
 160   BOOLEAN            Status;
 161   HASH_TEST_CONTEXT  *HashTestContext;
 162
 163   HashTestContext = Context;
 164
 165   DataSize = AsciiStrLen (HashData);
 166
 167   ZeroMem (Digest, MAX_DIGEST_SIZE);
 168
 169   Status = HashTestContext->HashInit (HashTestContext->HashCtx);
 170   UT_ASSERT_TRUE (Status);
 171
 172   Status = HashTestContext->HashUpdate (HashTestContext->HashCtx, HashData, DataSize);
 173   UT_ASSERT_TRUE (Status);
 174
 175   Status = HashTestContext->HashFinal (HashTestContext->HashCtx, Digest);
 176   UT_ASSERT_TRUE (Status);
 177
 178   UT_ASSERT_MEM_EQUAL (Digest, HashTestContext->Digest, HashTestContext->DigestSize);
 179
 180   ZeroMem (Digest, MAX_DIGEST_SIZE);
 181   Status = HashTestContext->HashAll (HashData, DataSize, Digest);
 182   UT_ASSERT_TRUE (Status);
 183
 184   UT_ASSERT_MEM_EQUAL (Digest, HashTestContext->Digest, HashTestContext->DigestSize);
 185
 186   return UNIT_TEST_PASSED;
 187 }
 188
 189 TEST_DESC  mHashTest[] = {
 190   //
 191   // -----Description----------------Class---------------------Function---------------Pre------------------Post------------Context
 192   //
 193  #ifdef ENABLE_MD5_DEPRECATED_INTERFACES
 194   { "TestVerifyMd5()",    "CryptoPkg.BaseCryptLib.Hash", TestVerifyHash, TestVerifyHashPreReq, TestVerifyHashCleanUp, &mMd5TestCtx    },
 195  #endif
 196   { "TestVerifySha1()",   "CryptoPkg.BaseCryptLib.Hash", TestVerifyHash, TestVerifyHashPreReq, TestVerifyHashCleanUp, &mSha1TestCtx   },
 197   { "TestVerifySha256()", "CryptoPkg.BaseCryptLib.Hash", TestVerifyHash, TestVerifyHashPreReq, TestVerifyHashCleanUp, &mSha256TestCtx },
 198   { "TestVerifySha384()", "CryptoPkg.BaseCryptLib.Hash", TestVerifyHash, TestVerifyHashPreReq, TestVerifyHashCleanUp, &mSha384TestCtx },
 199   { "TestVerifySha512()", "CryptoPkg.BaseCryptLib.Hash", TestVerifyHash, TestVerifyHashPreReq, TestVerifyHashCleanUp, &mSha512TestCtx },
 200 };
 201
 202 UINTN  mHashTestNum = ARRAY_SIZE (mHashTest);