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

   1 /** @file
   2   Application for RSA Primitives Validation.
   3
   4 Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include "TestBaseCryptLib.h"
  10
  11 #define  RSA_MODULUS_LENGTH  512
  12
  13 //
  14 // RSA PKCS#1 Validation Data from OpenSSL "Fips_rsa_selftest.c"
  15 //
  16
  17 //
  18 // Public Modulus of RSA Key
  19 //
  20 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  RsaN[] = {
  21   0xBB, 0xF8, 0x2F, 0x09, 0x06, 0x82, 0xCE, 0x9C, 0x23, 0x38, 0xAC, 0x2B, 0x9D, 0xA8, 0x71, 0xF7,
  22   0x36, 0x8D, 0x07, 0xEE, 0xD4, 0x10, 0x43, 0xA4, 0x40, 0xD6, 0xB6, 0xF0, 0x74, 0x54, 0xF5, 0x1F,
  23   0xB8, 0xDF, 0xBA, 0xAF, 0x03, 0x5C, 0x02, 0xAB, 0x61, 0xEA, 0x48, 0xCE, 0xEB, 0x6F, 0xCD, 0x48,
  24   0x76, 0xED, 0x52, 0x0D, 0x60, 0xE1, 0xEC, 0x46, 0x19, 0x71, 0x9D, 0x8A, 0x5B, 0x8B, 0x80, 0x7F,
  25   0xAF, 0xB8, 0xE0, 0xA3, 0xDF, 0xC7, 0x37, 0x72, 0x3E, 0xE6, 0xB4, 0xB7, 0xD9, 0x3A, 0x25, 0x84,
  26   0xEE, 0x6A, 0x64, 0x9D, 0x06, 0x09, 0x53, 0x74, 0x88, 0x34, 0xB2, 0x45, 0x45, 0x98, 0x39, 0x4E,
  27   0xE0, 0xAA, 0xB1, 0x2D, 0x7B, 0x61, 0xA5, 0x1F, 0x52, 0x7A, 0x9A, 0x41, 0xF6, 0xC1, 0x68, 0x7F,
  28   0xE2, 0x53, 0x72, 0x98, 0xCA, 0x2A, 0x8F, 0x59, 0x46, 0xF8, 0xE5, 0xFD, 0x09, 0x1D, 0xBD, 0xCB
  29 };
  30
  31 //
  32 // Public Exponent of RSA Key
  33 //
  34 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  RsaE[] = { 0x11 };
  35
  36 //
  37 // Private Exponent of RSA Key
  38 //
  39 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  RsaD[] = {
  40   0xA5, 0xDA, 0xFC, 0x53, 0x41, 0xFA, 0xF2, 0x89, 0xC4, 0xB9, 0x88, 0xDB, 0x30, 0xC1, 0xCD, 0xF8,
  41   0x3F, 0x31, 0x25, 0x1E, 0x06, 0x68, 0xB4, 0x27, 0x84, 0x81, 0x38, 0x01, 0x57, 0x96, 0x41, 0xB2,
  42   0x94, 0x10, 0xB3, 0xC7, 0x99, 0x8D, 0x6B, 0xC4, 0x65, 0x74, 0x5E, 0x5C, 0x39, 0x26, 0x69, 0xD6,
  43   0x87, 0x0D, 0xA2, 0xC0, 0x82, 0xA9, 0x39, 0xE3, 0x7F, 0xDC, 0xB8, 0x2E, 0xC9, 0x3E, 0xDA, 0xC9,
  44   0x7F, 0xF3, 0xAD, 0x59, 0x50, 0xAC, 0xCF, 0xBC, 0x11, 0x1C, 0x76, 0xF1, 0xA9, 0x52, 0x94, 0x44,
  45   0xE5, 0x6A, 0xAF, 0x68, 0xC5, 0x6C, 0x09, 0x2C, 0xD3, 0x8D, 0xC3, 0xBE, 0xF5, 0xD2, 0x0A, 0x93,
  46   0x99, 0x26, 0xED, 0x4F, 0x74, 0xA1, 0x3E, 0xDD, 0xFB, 0xE1, 0xA1, 0xCE, 0xCC, 0x48, 0x94, 0xAF,
  47   0x94, 0x28, 0xC2, 0xB7, 0xB8, 0x88, 0x3F, 0xE4, 0x46, 0x3A, 0x4B, 0xC8, 0x5B, 0x1C, 0xB3, 0xC1
  48 };
  49
  50 //
  51 // Known Answer Test (KAT) Data for RSA PKCS#1 Signing
  52 //
  53 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8  RsaSignData[] = "OpenSSL FIPS 140-2 Public Key RSA KAT";
  54
  55 //
  56 // Known Signature for the above message, under SHA-1 Digest
  57 //
  58 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  RsaPkcs1Signature[] = {
  59   0x71, 0xEE, 0x1A, 0xC0, 0xFE, 0x01, 0x93, 0x54, 0x79, 0x5C, 0xF2, 0x4C, 0x4A, 0xFD, 0x1A, 0x05,
  60   0x8F, 0x64, 0xB1, 0x6D, 0x61, 0x33, 0x8D, 0x9B, 0xE7, 0xFD, 0x60, 0xA3, 0x83, 0xB5, 0xA3, 0x51,
  61   0x55, 0x77, 0x90, 0xCF, 0xDC, 0x22, 0x37, 0x8E, 0xD0, 0xE1, 0xAE, 0x09, 0xE3, 0x3D, 0x1E, 0xF8,
  62   0x80, 0xD1, 0x8B, 0xC2, 0xEC, 0x0A, 0xD7, 0x6B, 0x88, 0x8B, 0x8B, 0xA1, 0x20, 0x22, 0xBE, 0x59,
  63   0x5B, 0xE0, 0x23, 0x24, 0xA1, 0x49, 0x30, 0xBA, 0xA9, 0x9E, 0xE8, 0xB1, 0x8A, 0x62, 0x16, 0xBF,
  64   0x4E, 0xCA, 0x2E, 0x4E, 0xBC, 0x29, 0xA8, 0x67, 0x13, 0xB7, 0x9F, 0x1D, 0x04, 0x44, 0xE5, 0x5F,
  65   0x35, 0x07, 0x11, 0xBC, 0xED, 0x19, 0x37, 0x21, 0xCF, 0x23, 0x48, 0x1F, 0x72, 0x05, 0xDE, 0xE6,
  66   0xE8, 0x7F, 0x33, 0x8A, 0x76, 0x4B, 0x2F, 0x95, 0xDF, 0xF1, 0x5F, 0x84, 0x80, 0xD9, 0x46, 0xB4
  67 };
  68
  69 //
  70 // Default public key 0x10001 = 65537
  71 //
  72 GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8  DefaultPublicKey[] = {
  73   0x01, 0x00, 0x01
  74 };
  75
  76 VOID  *mRsa;
  77
  78 UNIT_TEST_STATUS
  79 EFIAPI
  80 TestVerifyRsaPreReq (
  81   UNIT_TEST_CONTEXT  Context
  82   )
  83 {
  84   mRsa = RsaNew ();
  85
  86   if (mRsa == NULL) {
  87     return UNIT_TEST_ERROR_TEST_FAILED;
  88   }
  89
  90   return UNIT_TEST_PASSED;
  91 }
  92
  93 VOID
  94 EFIAPI
  95 TestVerifyRsaCleanUp (
  96   UNIT_TEST_CONTEXT  Context
  97   )
  98 {
  99   if (mRsa != NULL) {
 100     RsaFree (mRsa);
 101     mRsa = NULL;
 102   }
 103 }
 104
 105 UNIT_TEST_STATUS
 106 EFIAPI
 107 TestVerifyRsaSetGetKeyComponents (
 108   IN UNIT_TEST_CONTEXT  Context
 109   )
 110 {
 111   BOOLEAN  Status;
 112   UINTN    KeySize;
 113   UINT8    *KeyBuffer;
 114
 115   //
 116   // Set/Get RSA Key Components
 117   //
 118
 119   //
 120   // Set/Get RSA Key N
 121   //
 122   Status = RsaSetKey (mRsa, RsaKeyN, RsaN, sizeof (RsaN));
 123   UT_ASSERT_TRUE (Status);
 124
 125   KeySize = 0;
 126   Status  = RsaGetKey (mRsa, RsaKeyN, NULL, &KeySize);
 127   UT_ASSERT_FALSE (Status);
 128   UT_ASSERT_EQUAL (KeySize, sizeof (RsaN));
 129
 130   KeyBuffer = AllocatePool (KeySize);
 131   Status    = RsaGetKey (mRsa, RsaKeyN, KeyBuffer, &KeySize);
 132   UT_ASSERT_TRUE (Status);
 133   UT_ASSERT_EQUAL (KeySize, sizeof (RsaN));
 134
 135   UT_ASSERT_MEM_EQUAL (KeyBuffer, RsaN, KeySize);
 136
 137   FreePool (KeyBuffer);
 138
 139   //
 140   // Set/Get RSA Key E
 141   //
 142   Status = RsaSetKey (mRsa, RsaKeyE, RsaE, sizeof (RsaE));
 143   UT_ASSERT_TRUE (Status);
 144
 145   KeySize = 0;
 146   Status  = RsaGetKey (mRsa, RsaKeyE, NULL, &KeySize);
 147   UT_ASSERT_FALSE (Status);
 148   UT_ASSERT_EQUAL (KeySize, sizeof (RsaE));
 149
 150   KeyBuffer = AllocatePool (KeySize);
 151   Status    = RsaGetKey (mRsa, RsaKeyE, KeyBuffer, &KeySize);
 152   UT_ASSERT_TRUE (Status);
 153   UT_ASSERT_EQUAL (KeySize, sizeof (RsaE));
 154
 155   UT_ASSERT_MEM_EQUAL (KeyBuffer, RsaE, KeySize);
 156
 157   FreePool (KeyBuffer);
 158
 159   //
 160   // Clear/Get RSA Key Components
 161   //
 162
 163   //
 164   // Clear/Get RSA Key N
 165   //
 166   Status = RsaSetKey (mRsa, RsaKeyN, NULL, 0);
 167   UT_ASSERT_TRUE (Status);
 168
 169   KeySize = 1;
 170   Status  = RsaGetKey (mRsa, RsaKeyN, NULL, &KeySize);
 171   UT_ASSERT_TRUE (Status);
 172   UT_ASSERT_EQUAL (KeySize, 0);
 173
 174   //
 175   // Clear/Get RSA Key E
 176   //
 177   Status = RsaSetKey (mRsa, RsaKeyE, NULL, 0);
 178   UT_ASSERT_TRUE (Status);
 179
 180   KeySize = 1;
 181   Status  = RsaGetKey (mRsa, RsaKeyE, NULL, &KeySize);
 182   UT_ASSERT_TRUE (Status);
 183   UT_ASSERT_EQUAL (KeySize, 0);
 184
 185   return UNIT_TEST_PASSED;
 186 }
 187
 188 UNIT_TEST_STATUS
 189 EFIAPI
 190 TestVerifyRsaGenerateKeyComponents (
 191   IN UNIT_TEST_CONTEXT  Context
 192   )
 193 {
 194   BOOLEAN  Status;
 195   UINTN    KeySize;
 196   UINT8    *KeyBuffer;
 197
 198   //
 199   // Generate RSA Key Components
 200   //
 201
 202   Status = RsaGenerateKey (mRsa, RSA_MODULUS_LENGTH, NULL, 0);
 203   UT_ASSERT_TRUE (Status);
 204
 205   KeySize   = RSA_MODULUS_LENGTH / 8;
 206   KeyBuffer = AllocatePool (KeySize);
 207   Status    = RsaGetKey (mRsa, RsaKeyE, KeyBuffer, &KeySize);
 208   UT_ASSERT_TRUE (Status);
 209   UT_ASSERT_EQUAL (KeySize, 3);
 210   UT_ASSERT_MEM_EQUAL (KeyBuffer, DefaultPublicKey, 3);
 211
 212   KeySize = RSA_MODULUS_LENGTH / 8;
 213   Status  = RsaGetKey (mRsa, RsaKeyN, KeyBuffer, &KeySize);
 214   UT_ASSERT_TRUE (Status);
 215   UT_ASSERT_EQUAL (KeySize, RSA_MODULUS_LENGTH / 8);
 216
 217   Status = RsaCheckKey (mRsa);
 218   UT_ASSERT_TRUE (Status);
 219
 220   //
 221   // Check invalid RSA key components
 222   //
 223   Status = RsaSetKey (mRsa, RsaKeyN, RsaN, sizeof (RsaN));
 224   UT_ASSERT_TRUE (Status);
 225
 226   Status = RsaCheckKey (mRsa);
 227   UT_ASSERT_FALSE (Status);
 228
 229   Status = RsaSetKey (mRsa, RsaKeyN, KeyBuffer, KeySize);
 230   UT_ASSERT_TRUE (Status);
 231
 232   Status = RsaCheckKey (mRsa);
 233   UT_ASSERT_TRUE (Status);
 234
 235   Status = RsaSetKey (mRsa, RsaKeyE, RsaE, sizeof (RsaE));
 236   UT_ASSERT_TRUE (Status);
 237
 238   Status = RsaCheckKey (mRsa);
 239   UT_ASSERT_FALSE (Status);
 240
 241   FreePool (KeyBuffer);
 242
 243   return UNIT_TEST_PASSED;
 244 }
 245
 246 UNIT_TEST_STATUS
 247 EFIAPI
 248 TestVerifyRsaPkcs1SignVerify (
 249   IN UNIT_TEST_CONTEXT  Context
 250   )
 251 {
 252   UINT8    HashValue[SHA1_DIGEST_SIZE];
 253   UINTN    HashSize;
 254   UINT8    *Signature;
 255   UINTN    SigSize;
 256   BOOLEAN  Status;
 257
 258   //
 259   // SHA-1 Digest Message for PKCS#1 Signature
 260   //
 261   HashSize = SHA1_DIGEST_SIZE;
 262   ZeroMem (HashValue, HashSize);
 263
 264   Status = Sha1HashAll (RsaSignData, AsciiStrLen (RsaSignData), HashValue);
 265   UT_ASSERT_TRUE (Status);
 266
 267   //
 268   // Sign RSA PKCS#1-encoded Signature
 269   //
 270
 271   Status = RsaSetKey (mRsa, RsaKeyN, RsaN, sizeof (RsaN));
 272   UT_ASSERT_TRUE (Status);
 273
 274   Status = RsaSetKey (mRsa, RsaKeyE, RsaE, sizeof (RsaE));
 275   UT_ASSERT_TRUE (Status);
 276
 277   Status = RsaSetKey (mRsa, RsaKeyD, RsaD, sizeof (RsaD));
 278   UT_ASSERT_TRUE (Status);
 279
 280   SigSize = 0;
 281   Status  = RsaPkcs1Sign (mRsa, HashValue, HashSize, NULL, &SigSize);
 282   UT_ASSERT_FALSE (Status);
 283   UT_ASSERT_NOT_EQUAL (SigSize, 0);
 284
 285   Signature = AllocatePool (SigSize);
 286   Status    = RsaPkcs1Sign (mRsa, HashValue, HashSize, Signature, &SigSize);
 287   UT_ASSERT_TRUE (Status);
 288   UT_ASSERT_EQUAL (SigSize, sizeof (RsaPkcs1Signature));
 289
 290   UT_ASSERT_MEM_EQUAL (Signature, RsaPkcs1Signature, SigSize);
 291
 292   //
 293   // Verify RSA PKCS#1-encoded Signature
 294   //
 295   Status = RsaPkcs1Verify (mRsa, HashValue, HashSize, Signature, SigSize);
 296   UT_ASSERT_TRUE (Status);
 297
 298   FreePool (Signature);
 299
 300   return UNIT_TEST_PASSED;
 301 }
 302
 303 TEST_DESC  mRsaTest[] = {
 304   //
 305   // -----Description--------------------------------------Class----------------------Function---------------------------------Pre---------------------Post---------Context
 306   //
 307   { "TestVerifyRsaSetGetKeyComponents()",   "CryptoPkg.BaseCryptLib.Rsa", TestVerifyRsaSetGetKeyComponents,   TestVerifyRsaPreReq, TestVerifyRsaCleanUp, NULL },
 308   { "TestVerifyRsaGenerateKeyComponents()", "CryptoPkg.BaseCryptLib.Rsa", TestVerifyRsaGenerateKeyComponents, TestVerifyRsaPreReq, TestVerifyRsaCleanUp, NULL },
 309   { "TestVerifyRsaPkcs1SignVerify()",       "CryptoPkg.BaseCryptLib.Rsa", TestVerifyRsaPkcs1SignVerify,       TestVerifyRsaPreReq, TestVerifyRsaCleanUp, NULL },
 310 };
 311
 312 UINTN  mRsaTestNum = ARRAY_SIZE (mRsaTest);