CryptoPkg/Test: Add unit test for CryptoEc

Add unit test for CryptoEc.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Xiaoyu Lu <xiaoyu1.lu@intel.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Signed-off-by: Yi Li <yi1.li@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

diff --git a/CryptoPkg/Library/BaseCryptLib/UnitTestHostBaseCryptLib.inf b/CryptoPkg/Library/BaseCryptLib/UnitTestHostBaseCryptLib.inf
index 6891db97fb4c7495d8548dcef278f1ee0dd3b674..168e24e4c041ac12f18b53945d2e2e4bcd16fee8 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/UnitTestHostBaseCryptLib.inf
+++ b/CryptoPkg/Library/BaseCryptLib/UnitTestHostBaseCryptLib.inf
@@ -48,6 +48,8 @@
   Pk/CryptRsaPss.c\r
   Pk/CryptRsaPssSign.c\r
   Bn/CryptBn.c\r
+  Pk/CryptEcNull.c    |*|*|*|!gEfiCryptoPkgTokenSpaceGuid.PcdOpensslEcEnabled\r
+  Pk/CryptEc.c    |*|*|*|gEfiCryptoPkgTokenSpaceGuid.PcdOpensslEcEnabled\r
 \r
   SysCall/UnitTestHostCrtWrapper.c\r
 \r

diff --git a/CryptoPkg/Test/CryptoPkgHostUnitTest.dsc b/CryptoPkg/Test/CryptoPkgHostUnitTest.dsc
index 16478f4a57ca730e63e3b3a2c02d073e58adf110..b6e1a6619844aad5cf8c5da363b40aca8f2aa4fc 100644 (file)
--- a/CryptoPkg/Test/CryptoPkgHostUnitTest.dsc
+++ b/CryptoPkg/Test/CryptoPkgHostUnitTest.dsc
@@ -19,6 +19,9 @@
 \r
 !include UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc\r
 \r
+[PcdsFixedAtBuild]\r
+  gEfiCryptoPkgTokenSpaceGuid.PcdOpensslEcEnabled|TRUE\r
+\r
 [LibraryClasses]\r
   OpensslLib|CryptoPkg/Library/OpensslLib/OpensslLib.inf\r
   BaseCryptLib|CryptoPkg/Library/BaseCryptLib/UnitTestHostBaseCryptLib.inf\r

diff --git a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/BaseCryptLibUnitTests.c b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/BaseCryptLibUnitTests.c
index 8450e951722d833d09541e56e74317b19330ca29..63bae35b80be3788426939b98ca5ee48275262a6 100644 (file)
--- a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/BaseCryptLibUnitTests.c
+++ b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/BaseCryptLibUnitTests.c
@@ -28,6 +28,7 @@ SUITE_DESC  mSuiteDesc[] = {
   { "Hkdf extract and expand tests", "CryptoPkg.BaseCryptLib", NULL, NULL, &mHkdfTestNum,           mHkdfTest           },\r
   { "Aead AES Gcm tests",            "CryptoPkg.BaseCryptLib", NULL, NULL, &mAeadAesGcmTestNum,     mAeadAesGcmTest     },\r
   { "Bn verify tests",               "CryptoPkg.BaseCryptLib", NULL, NULL, &mBnTestNum,             mBnTest             },\r
+  { "EC verify tests",               "CryptoPkg.BaseCryptLib", NULL, NULL, &mEcTestNum,             mEcTest             },\r
 };\r
 \r
 EFI_STATUS\r

diff --git a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/EcTests.c b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/EcTests.c
new file mode 100644 (file)
index 0000000..54ce0b2
--- /dev/null
+++ b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/EcTests.c
@@ -0,0 +1,290 @@
+/** @file\r
+  Application for Diffie-Hellman Primitives Validation.\r
+\r
+Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#include "TestBaseCryptLib.h"\r
+\r
+#define EC_CURVE_NUM_SUPPORTED  3\r
+UINTN  EcCurveList[EC_CURVE_NUM_SUPPORTED]   = { CRYPTO_NID_SECP256R1, CRYPTO_NID_SECP384R1, CRYPTO_NID_SECP521R1 };\r
+UINTN  EcKeyHalfSize[EC_CURVE_NUM_SUPPORTED] = { 32, 48, 66 };\r
+\r
+struct Generator {\r
+  UINT8    X[66];\r
+  UINT8    Y[66];\r
+};\r
+\r
+// Generator points of all ec curve\r
+struct Generator  EcCurveGenerator[EC_CURVE_NUM_SUPPORTED] =\r
+{\r
+  // CRYPTO_NID_SECP256R1\r
+  {\r
+    { 0x6B, 0x17, 0xD1, 0xF2, 0xE1, 0x2C, 0x42, 0x47, 0xF8, 0xBC, 0xE6, 0xE5,\r
+      0x63, 0xA4, 0x40, 0xF2, 0x77, 0x03, 0x7D, 0x81, 0x2D, 0xEB, 0x33, 0xA0,\r
+      0xF4, 0xA1, 0x39, 0x45, 0xD8, 0x98, 0xC2, 0x96 },\r
+\r
+    { 0x4f, 0xe3, 0x42, 0xe2, 0xfe, 0x1a, 0x7f, 0x9b, 0x8e, 0xe7, 0xeb, 0x4a,\r
+      0x7c, 0x0f, 0x9e, 0x16, 0x2b, 0xce, 0x33, 0x57, 0x6b, 0x31, 0x5e, 0xce,\r
+      0xcb, 0xb6, 0x40, 0x68, 0x37, 0xbf, 0x51, 0xf5 }\r
+  },\r
+  // CRYPTO_NID_SECP384R1\r
+  {\r
+    { 0xAA, 0x87, 0xCA, 0x22, 0xBE, 0x8B, 0x05, 0x37, 0x8E, 0xB1, 0xC7, 0x1E,\r
+      0xF3, 0x20, 0xAD, 0x74, 0x6E, 0x1D, 0x3B, 0x62, 0x8B, 0xA7, 0x9B, 0x98,\r
+      0x59, 0xF7, 0x41, 0xE0, 0x82, 0x54, 0x2A, 0x38, 0x55, 0x02, 0xF2, 0x5D,\r
+      0xBF, 0x55, 0x29, 0x6C, 0x3A, 0x54, 0x5E, 0x38, 0x72, 0x76, 0x0A, 0xB7 },\r
+\r
+    { 0x36, 0x17, 0xde, 0x4a, 0x96, 0x26, 0x2c, 0x6f, 0x5d, 0x9e, 0x98, 0xbf,\r
+      0x92, 0x92, 0xdc, 0x29, 0xf8, 0xf4, 0x1d, 0xbd, 0x28, 0x9a, 0x14, 0x7c,\r
+      0xe9, 0xda, 0x31, 0x13, 0xb5, 0xf0, 0xb8, 0xc0, 0x0a, 0x60, 0xb1, 0xce,\r
+      0x1d, 0x7e, 0x81, 0x9d, 0x7a, 0x43, 0x1d, 0x7c, 0x90, 0xea, 0x0e, 0x5f }\r
+  },\r
+  // CRYPTO_NID_SECP521R1\r
+  {\r
+    { 0x00, 0xC6, 0x85, 0x8E, 0x06, 0xB7, 0x04, 0x04, 0xE9, 0xCD, 0x9E, 0x3E,\r
+      0xCB, 0x66, 0x23, 0x95, 0xB4, 0x42, 0x9C, 0x64, 0x81, 0x39, 0x05, 0x3F,\r
+      0xB5, 0x21, 0xF8, 0x28, 0xAF, 0x60, 0x6B, 0x4D, 0x3D, 0xBA, 0xA1, 0x4B,\r
+      0x5E, 0x77, 0xEF, 0xE7, 0x59, 0x28, 0xFE, 0x1D, 0xC1, 0x27, 0xA2, 0xFF,\r
+      0xA8, 0xDE, 0x33, 0x48, 0xB3, 0xC1, 0x85, 0x6A, 0x42, 0x9B, 0xF9, 0x7E,\r
+      0x7E, 0x31, 0xC2, 0xE5, 0xBD, 0x66 },\r
+\r
+    { 0x01, 0x18, 0x39, 0x29, 0x6a, 0x78, 0x9a, 0x3b, 0xc0, 0x04, 0x5c, 0x8a,\r
+      0x5f, 0xb4, 0x2c, 0x7d, 0x1b, 0xd9, 0x98, 0xf5, 0x44, 0x49, 0x57, 0x9b,\r
+      0x44, 0x68, 0x17, 0xaf, 0xbd, 0x17, 0x27, 0x3e, 0x66, 0x2c, 0x97, 0xee,\r
+      0x72, 0x99, 0x5e, 0xf4, 0x26, 0x40, 0xc5, 0x50, 0xb9, 0x01, 0x3f, 0xad,\r
+      0x07, 0x61, 0x35, 0x3c, 0x70, 0x86, 0xa2, 0x72, 0xc2, 0x40, 0x88, 0xbe,\r
+      0x94, 0x76, 0x9f, 0xd1, 0x66, 0x50 }\r
+  }\r
+};\r
+\r
+VOID  *Ec1;\r
+VOID  *Ec2;\r
+VOID  *Group;\r
+VOID  *Point1;\r
+VOID  *Point2;\r
+VOID  *PointRes;\r
+VOID  *BnX;\r
+VOID  *BnY;\r
+VOID  *BnP;\r
+VOID  *BnOrder;\r
+\r
+UNIT_TEST_STATUS\r
+EFIAPI\r
+TestVerifyEcPreReq (\r
+  UNIT_TEST_CONTEXT  Context\r
+  )\r
+{\r
+  Ec1      = NULL;\r
+  Ec2      = NULL;\r
+  Group    = NULL;\r
+  Point1   = NULL;\r
+  Point2   = NULL;\r
+  PointRes = NULL;\r
+  BnX      = NULL;\r
+  BnY      = NULL;\r
+  BnP      = BigNumInit ();\r
+  BnOrder  = BigNumInit ();\r
+  if ((BnP == NULL) || (BnOrder == NULL)) {\r
+    return UNIT_TEST_ERROR_TEST_FAILED;\r
+  }\r
+\r
+  return UNIT_TEST_PASSED;\r
+}\r
+\r
+VOID\r
+EFIAPI\r
+TestVerifyEcCleanUp (\r
+  UNIT_TEST_CONTEXT  Context\r
+  )\r
+{\r
+  BigNumFree (BnX, TRUE);\r
+  BigNumFree (BnY, TRUE);\r
+  BigNumFree (BnP, TRUE);\r
+  BigNumFree (BnOrder, TRUE);\r
+  EcGroupFree (Group);\r
+  EcPointDeInit (Point1, TRUE);\r
+  EcPointDeInit (Point2, TRUE);\r
+  EcPointDeInit (PointRes, TRUE);\r
+  EcFree (Ec1);\r
+  EcFree (Ec2);\r
+}\r
+\r
+UNIT_TEST_STATUS\r
+EFIAPI\r
+TestVerifyEcBasic (\r
+  UNIT_TEST_CONTEXT  Context\r
+  )\r
+{\r
+  UINTN    CurveCount;\r
+  BOOLEAN  Status;\r
+\r
+  //\r
+  // Initialize BigNumbers\r
+  //\r
+  for (CurveCount = 0; CurveCount < EC_CURVE_NUM_SUPPORTED; CurveCount++) {\r
+    //\r
+    // Basic EC functions unit test\r
+    //\r
+    Group = EcGroupInit (EcCurveList[CurveCount]);\r
+    if (Group == NULL) {\r
+      return UNIT_TEST_ERROR_TEST_FAILED;\r
+    }\r
+\r
+    Point1   = EcPointInit (Group);\r
+    Point2   = EcPointInit (Group);\r
+    PointRes = EcPointInit (Group);\r
+    BnX      = BigNumFromBin (EcCurveGenerator[CurveCount].X, EcKeyHalfSize[CurveCount]);\r
+    BnY      = BigNumFromBin (EcCurveGenerator[CurveCount].Y, EcKeyHalfSize[CurveCount]);\r
+    if ((Point1 == NULL) || (Point2 == NULL) || (PointRes == NULL) || (BnX == NULL) || (BnY == NULL)) {\r
+      return UNIT_TEST_ERROR_TEST_FAILED;\r
+    }\r
+\r
+    Status = EcGroupGetCurve (Group, BnP, NULL, NULL, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcGroupGetOrder (Group, BnOrder);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    // Point G should on curve\r
+    Status = EcPointSetAffineCoordinates (Group, Point1, BnX, BnY, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointSetAffineCoordinates (Group, Point2, BnX, BnY, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointEqual (Group, Point1, Point2, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointIsOnCurve (Group, Point1, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointIsAtInfinity (Group, Point1);\r
+    UT_ASSERT_FALSE (Status);\r
+\r
+    // Point 2G should on curve\r
+    Status = EcPointAdd (Group, PointRes, Point1, Point1, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointIsOnCurve (Group, PointRes, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    // Point Order * G should at infinity\r
+    Status = EcPointMul (Group, PointRes, Point1, BnOrder, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointIsAtInfinity (Group, PointRes);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    // -(-G) == G\r
+    Status = EcPointInvert (Group, Point2, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointEqual (Group, Point2, Point1, NULL);\r
+    UT_ASSERT_FALSE (Status);\r
+\r
+    Status = EcPointInvert (Group, Point2, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointEqual (Group, Point2, Point1, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    // Compress point test\r
+    Status = EcPointSetCompressedCoordinates (Group, Point1, BnX, 0, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointSetCompressedCoordinates (Group, Point2, BnX, 1, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointEqual (Group, Point2, Point1, NULL);\r
+    UT_ASSERT_FALSE (Status);\r
+\r
+    Status = EcPointInvert (Group, Point2, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+\r
+    Status = EcPointEqual (Group, Point2, Point1, NULL);\r
+    UT_ASSERT_TRUE (Status);\r
+  }\r
+\r
+  return UNIT_TEST_PASSED;\r
+}\r
+\r
+UNIT_TEST_STATUS\r
+EFIAPI\r
+TestVerifyEcDh (\r
+  UNIT_TEST_CONTEXT  Context\r
+  )\r
+{\r
+  UINT8    Public1[66 * 2];\r
+  UINTN    Public1Length;\r
+  UINT8    Public2[66 * 2];\r
+  UINTN    Public2Length;\r
+  UINT8    Key1[66];\r
+  UINTN    Key1Length;\r
+  UINT8    Key2[66];\r
+  UINTN    Key2Length;\r
+  UINTN    CurveCount;\r
+  BOOLEAN  Status;\r
+\r
+  for (CurveCount = 0; CurveCount < EC_CURVE_NUM_SUPPORTED; CurveCount++) {\r
+    //\r
+    // Initial key length\r
+    //\r
+    Public1Length = sizeof (Public1);\r
+    Public2Length = sizeof (Public2);\r
+    Key1Length    = sizeof (Key1);\r
+    Key2Length    = sizeof (Key2);\r
+    //\r
+    // ECDH functions unit test\r
+    //\r
+    Ec1 = EcNewByNid (EcCurveList[CurveCount]);\r
+    if (Ec1 == NULL) {\r
+      return UNIT_TEST_ERROR_TEST_FAILED;\r
+    }\r
+\r
+    Ec2 = EcNewByNid (EcCurveList[CurveCount]);\r
+    if (Ec2 == NULL) {\r
+      return UNIT_TEST_ERROR_TEST_FAILED;\r
+    }\r
+\r
+    Status = EcGenerateKey (Ec1, Public1, &Public1Length);\r
+    UT_ASSERT_TRUE (Status);\r
+    UT_ASSERT_EQUAL (Public1Length, EcKeyHalfSize[CurveCount] * 2);\r
+\r
+    Status = EcGenerateKey (Ec2, Public2, &Public2Length);\r
+    UT_ASSERT_TRUE (Status);\r
+    UT_ASSERT_EQUAL (Public2Length, EcKeyHalfSize[CurveCount] * 2);\r
+\r
+    Status = EcDhComputeKey (Ec1, Public2, Public2Length, NULL, Key1, &Key1Length);\r
+    UT_ASSERT_TRUE (Status);\r
+    UT_ASSERT_EQUAL (Key1Length, EcKeyHalfSize[CurveCount]);\r
+\r
+    Status = EcDhComputeKey (Ec2, Public1, Public1Length, NULL, Key2, &Key2Length);\r
+    UT_ASSERT_TRUE (Status);\r
+    UT_ASSERT_EQUAL (Key2Length, EcKeyHalfSize[CurveCount]);\r
+\r
+    UT_ASSERT_EQUAL (Key1Length, Key2Length);\r
+    UT_ASSERT_MEM_EQUAL (Key1, Key2, Key1Length);\r
+\r
+    Status = EcGetPubKey (Ec1, Public2, &Public2Length);\r
+    UT_ASSERT_TRUE (Status);\r
+    UT_ASSERT_EQUAL (Public2Length, EcKeyHalfSize[CurveCount] * 2);\r
+\r
+    UT_ASSERT_EQUAL (Public1Length, Public2Length);\r
+    UT_ASSERT_MEM_EQUAL (Public1, Public2, Public1Length);\r
+  }\r
+\r
+  return UNIT_TEST_PASSED;\r
+}\r
+\r
+TEST_DESC  mEcTest[] = {\r
+  //\r
+  // -----Description-----------------Class------------------Function----Pre----Post----Context\r
+  //\r
+  { "TestVerifyEcBasic()", "CryptoPkg.BaseCryptLib.Ec", TestVerifyEcBasic, TestVerifyEcPreReq, TestVerifyEcCleanUp, NULL },\r
+  { "TestVerifyEcDh()",    "CryptoPkg.BaseCryptLib.Ec", TestVerifyEcDh,    TestVerifyEcPreReq, TestVerifyEcCleanUp, NULL },\r
+};\r
+\r
+UINTN  mEcTestNum = ARRAY_SIZE (mEcTest);\r

diff --git a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLib.h b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLib.h
index fc44030ff6b8ccb3c663547a95013a840bb21535..3a84e63a8793483a69b3241920e09038670bf697 100644 (file)
--- a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLib.h
+++ b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLib.h
@@ -95,6 +95,8 @@ extern TEST_DESC  mAeadAesGcmTest[];
 extern UINTN      mBnTestNum;\r
 extern TEST_DESC  mBnTest[];\r
 \r
+extern UINTN      mEcTestNum;\r
+extern TEST_DESC  mEcTest[];\r
 /** Creates a framework you can use */\r
 EFI_STATUS\r
 EFIAPI\r

diff --git a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibHost.inf b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibHost.inf
index 40dfade717647a3527dba2f7d78ea485224bd889..023b796946309a69e7df697a07c4f4b3934f02db 100644 (file)
--- a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibHost.inf
+++ b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibHost.inf
@@ -40,6 +40,7 @@
   HkdfTests.c\r
   AeadAesGcmTests.c\r
   BnTests.c\r
+  EcTests.c\r
 \r
 [Packages]\r
   MdePkg/MdePkg.dec\r

diff --git a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibShell.inf b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibShell.inf
index 00e6b088b8858366417e6f4f91819a537e422dce..5bfd190236b98f97029c94bd52b070fcdaad2ced 100644 (file)
--- a/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibShell.inf
+++ b/CryptoPkg/Test/UnitTest/Library/BaseCryptLib/TestBaseCryptLibShell.inf
@@ -39,6 +39,7 @@
   HkdfTests.c\r
   AeadAesGcmTests.c\r
   BnTests.c\r
+  EcTests.c\r
 \r
 [Packages]\r
   MdePkg/MdePkg.dec\r