Add UEFI RNG Protocol support. The driver will leverage Intel Secure Key technology...
authorLong, Qin <qin.long@intel.com>
Tue, 19 Nov 2013 01:49:49 +0000 (01:49 +0000)
committersfu5 <sfu5@6f19259b-4bc3-4df7-8a09-765794883524>
Tue, 19 Nov 2013 01:49:49 +0000 (01:49 +0000)
Signed-off-by: Long, Qin <qin.long@intel.com>
Reviewed-by: Fu, Siyuan <siyuan.fu@intel.com>
Reviewed-by: Rosenbaum, Lee G <lee.g.rosenbaum@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14858 6f19259b-4bc3-4df7-8a09-765794883524

17 files changed:
MdePkg/Include/Protocol/Rng.h [new file with mode: 0644]
MdePkg/MdePkg.dec
SecurityPkg/Application/RngTest/RngTest.c [new file with mode: 0644]
SecurityPkg/Application/RngTest/RngTest.inf [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/AesCore.c [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/AesCore.h [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/IA32/AsmRdRand.asm [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/IA32/GccRdRand.c [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/IA32/RdRandWord.c [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/RdRand.c [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/RdRand.h [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.inf [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/X64/AsmRdRand.asm [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/X64/GccRdRand.c [new file with mode: 0644]
SecurityPkg/RandomNumberGenerator/RngDxe/X64/RdRandWord.c [new file with mode: 0644]
SecurityPkg/SecurityPkg.dsc

diff --git a/MdePkg/Include/Protocol/Rng.h b/MdePkg/Include/Protocol/Rng.h
new file mode 100644 (file)
index 0000000..5a4fe69
--- /dev/null
@@ -0,0 +1,156 @@
+/** @file\r
+  EFI_RNG_PROTOCOL as defined in UEFI 2.4.\r
+  The UEFI Random Number Generator Protocol is used to provide random bits for use \r
+  in applications, or entropy for seeding other random number generators.\r
+\r
+Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef __EFI_RNG_PROTOCOL_H__\r
+#define __EFI_RNG_PROTOCOL_H__\r
+\r
+///\r
+/// Global ID for the Random Number Generator Protocol\r
+///\r
+#define EFI_RNG_PROTOCOL_GUID \\r
+  { \\r
+    0x3152bca5, 0xeade, 0x433d, {0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44 } \\r
+  }\r
+\r
+typedef struct _EFI_RNG_PROTOCOL EFI_RNG_PROTOCOL;\r
+\r
+///\r
+/// A selection of EFI_RNG_PROTOCOL algorithms.\r
+/// The algorithms listed are optional, not meant to be exhaustive and be argmented by \r
+/// vendors or other industry standards.\r
+///\r
+\r
+typedef EFI_GUID EFI_RNG_ALGORITHM;\r
+\r
+///\r
+/// The algorithms corresponds to SP800-90 as defined in\r
+/// NIST SP 800-90, "Recommendation for Random Number Generation Using Deterministic Random\r
+/// Bit Generators", March 2007.\r
+///\r
+#define EFI_RNG_ALGORITHM_SP800_90_HASH_256_GUID \\r
+  { \\r
+    0xa7af67cb, 0x603b, 0x4d42, {0xba, 0x21, 0x70, 0xbf, 0xb6, 0x29, 0x3f, 0x96 } \\r
+  }\r
+#define EFI_RNG_ALGORITHM_SP800_90_HMAC_256_GUID \\r
+  { \\r
+    0xc5149b43, 0xae85, 0x4f53, {0x99, 0x82, 0xb9, 0x43, 0x35, 0xd3, 0xa9, 0xe7 } \\r
+  }\r
+#define EFI_RNG_ALGORITHM_SP800_90_CTR_256_GUID \\r
+  { \\r
+    0x44f0de6e, 0x4d8c, 0x4045, {0xa8, 0xc7, 0x4d, 0xd1, 0x68, 0x85, 0x6b, 0x9e } \\r
+  }\r
+///\r
+/// The algorithms correspond to X9.31 as defined in\r
+/// NIST, "Recommended Random Number Generator Based on ANSI X9.31 Appendix A.2.4 Using\r
+/// the 3-Key Triple DES and AES Algorithm", January 2005.\r
+///\r
+#define EFI_RNG_ALGORITHM_X9_31_3DES_GUID \\r
+  { \\r
+    0x63c4785a, 0xca34, 0x4012, {0xa3, 0xc8, 0x0b, 0x6a, 0x32, 0x4f, 0x55, 0x46 } \\r
+  }\r
+#define EFI_RNG_ALGORITHM_X9_31_AES_GUID \\r
+  { \\r
+    0xacd03321, 0x777e, 0x4d3d, {0xb1, 0xc8, 0x20, 0xcf, 0xd8, 0x88, 0x20, 0xc9 } \\r
+  }\r
+///\r
+/// The "raw" algorithm, when supported, is intended to provide entropy directly from\r
+/// the source, without it going through some deterministic random bit generator.\r
+///\r
+#define EFI_RNG_ALGORITHM_RAW \\r
+  { \\r
+    0xe43176d7, 0xb6e8, 0x4827, {0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61 } \\r
+  }\r
+\r
+/**\r
+  Returns information about the random number generation implementation.\r
+\r
+  @param[in]     This                 A pointer to the EFI_RNG_PROTOCOL instance.\r
+  @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList. \r
+                                      On output with a return code of EFI_SUCCESS, the size\r
+                                      in bytes of the data returned in RNGAlgorithmList. On output\r
+                                      with a return code of EFI_BUFFER_TOO_SMALL,\r
+                                      the size of RNGAlgorithmList required to obtain the list.\r
+  @param[out] RNGAlgorithmList        A caller-allocated memory buffer filled by the driver\r
+                                      with one EFI_RNG_ALGORITHM element for each supported\r
+                                      RNG algorithm. The list must not change across multiple\r
+                                      calls to the same driver. The first algorithm in the list\r
+                                      is the default algorithm for the driver.\r
+\r
+  @retval EFI_SUCCESS                 The RNG algorithm list was returned successfully.\r
+  @retval EFI_UNSUPPORTED             The services is not supported by this driver.\r
+  @retval EFI_DEVICE_ERROR            The list of algorithms could not be retrieved due to a\r
+                                      hardware or firmware error.\r
+  @retval EFI_INVALID_PARAMETER       One or more of the parameters are incorrect.\r
+  @retval EFI_BUFFER_TOO_SMALL        The buffer RNGAlgorithmList is too small to hold the result.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_RNG_GET_INFO) (\r
+  IN EFI_RNG_PROTOCOL             *This,\r
+  IN OUT UINTN                    *RNGAlgorithmListSize,\r
+  OUT EFI_RNG_ALGORITHM           *RNGAlgorithmList\r
+  );\r
+\r
+/**\r
+  Produces and returns an RNG value using either the default or specified RNG algorithm.\r
+\r
+  @param[in]  This                    A pointer to the EFI_RNG_PROTOCOL instance.\r
+  @param[in]  RNGAlgorithm            A pointer to the EFI_RNG_ALGORITHM that identifies the RNG\r
+                                      algorithm to use. May be NULL in which case the function will\r
+                                      use its default RNG algorithm.\r
+  @param[in]  RNGValueLength          The length in bytes of the memory buffer pointed to by\r
+                                      RNGValue. The driver shall return exactly this numbers of bytes.\r
+  @param[out] RNGValue                A caller-allocated memory buffer filled by the driver with the\r
+                                      resulting RNG value.\r
+\r
+  @retval EFI_SUCCESS                 The RNG value was returned successfully.\r
+  @retval EFI_UNSUPPORTED             The algorithm specified by RNGAlgorithm is not supported by\r
+                                      this driver.\r
+  @retval EFI_DEVICE_ERROR            An RNG value could not be retrieved due to a hardware or\r
+                                      firmware error.\r
+  @retval EFI_NOT_READY               There is not enough random data available to satisfy the length\r
+                                      requested by RNGValueLength.\r
+  @retval EFI_INVALID_PARAMETER       RNGValue is NULL or RNGValueLength is zero.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_RNG_GET_RNG) (\r
+  IN EFI_RNG_PROTOCOL            *This,\r
+  IN EFI_RNG_ALGORITHM           *RNGAlgorithm, OPTIONAL\r
+  IN UINTN                       RNGValueLength,\r
+  OUT UINT8                      *RNGValue\r
+  );\r
+\r
+///\r
+/// The Random Number Generator (RNG) protocol provides random bits for use in \r
+/// applications, or entropy for seeding other random number generators.\r
+///\r
+struct _EFI_RNG_PROTOCOL {\r
+  EFI_RNG_GET_INFO                GetInfo;\r
+  EFI_RNG_GET_RNG                 GetRNG;\r
+};\r
+\r
+extern EFI_GUID gEfiRngProtocolGuid;\r
+extern EFI_GUID gEfiRngAlgorithmSp80090Hash256Guid;\r
+extern EFI_GUID gEfiRngAlgorithmSp80090Hmac256Guid;\r
+extern EFI_GUID gEfiRngAlgorithmSp80090Ctr256Guid;\r
+extern EFI_GUID gEfiRngAlgorithmX9313DesGuid;\r
+extern EFI_GUID gEfiRngAlgorithmX931AesGuid;\r
+extern EFI_GUID gEfiRngAlgorithmRaw;\r
+\r
+#endif\r
index 6d3303c..35bc7a4 100644 (file)
   ## Include/Guid/FmpCapsule.h\r
   gEfiFmpCapsuleGuid             =  { 0x6dcbd5ed, 0xe82d, 0x4c44, {0xbd, 0xa1, 0x71, 0x94, 0x19, 0x9a, 0xd9, 0x2a }}\r
 \r
+  ## Include/Protocol/Rng.h\r
+  gEfiRngAlgorithmSp80090Hash256Guid = { 0xa7af67cb, 0x603b, 0x4d42, {0xba, 0x21, 0x70, 0xbf, 0xb6, 0x29, 0x3f, 0x96 }}\r
+  gEfiRngAlgorithmSp80090Hmac256Guid = { 0xc5149b43, 0xae85, 0x4f53, {0x99, 0x82, 0xb9, 0x43, 0x35, 0xd3, 0xa9, 0xe7 }}\r
+  gEfiRngAlgorithmSp80090Ctr256Guid  = { 0x44f0de6e, 0x4d8c, 0x4045, {0xa8, 0xc7, 0x4d, 0xd1, 0x68, 0x85, 0x6b, 0x9e }}\r
+  gEfiRngAlgorithmX9313DesGuid       = { 0x63c4785a, 0xca34, 0x4012, {0xa3, 0xc8, 0x0b, 0x6a, 0x32, 0x4f, 0x55, 0x46 }}\r
+  gEfiRngAlgorithmX931AesGuid        = { 0xacd03321, 0x777e, 0x4d3d, {0xb1, 0xc8, 0x20, 0xcf, 0xd8, 0x88, 0x20, 0xc9 }}\r
+  gEfiRngAlgorithmRaw                = { 0xe43176d7, 0xb6e8, 0x4827, {0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61 }}\r
+\r
   #\r
   # GUID defined in PI1.0\r
   #\r
   ## Include/Protocol/Timestamp.h\r
   gEfiTimestampProtocolGuid            = { 0xafbfde41, 0x2e6e, 0x4262, {0xba, 0x65, 0x62, 0xb9, 0x23, 0x6e, 0x54, 0x95 }}\r
 \r
+  ## Include/Protocol/Rng.h\r
+  gEfiRngProtocolGuid                  = { 0x3152bca5, 0xeade, 0x433d, {0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44 }}\r
+\r
 [PcdsFeatureFlag]\r
   ## If TRUE, the component name protocol will not be installed.\r
   gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable|FALSE|BOOLEAN|0x0000000d\r
diff --git a/SecurityPkg/Application/RngTest/RngTest.c b/SecurityPkg/Application/RngTest/RngTest.c
new file mode 100644 (file)
index 0000000..25edece
--- /dev/null
@@ -0,0 +1,231 @@
+/** @file\r
+  UEFI RNG (Random Number Generator) Protocol test application.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/        \r
+\r
+#include <Uefi.h>\r
+#include <Library/UefiLib.h>\r
+#include <Library/UefiApplicationEntryPoint.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Protocol/Rng.h>\r
+\r
+/**\r
+  The user Entry Point for Application. The user code starts with this function\r
+  as the real entry point for the application.\r
+\r
+  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
+  @param[in] SystemTable    A pointer to the EFI System Table.\r
+  \r
+  @retval EFI_SUCCESS       The entry point is executed successfully.\r
+  @retval other             Some error occurs when executing this entry point.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+UefiMain (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  )\r
+{\r
+  EFI_STATUS         Status;\r
+  EFI_RNG_PROTOCOL   *Rng;\r
+  UINTN              RngAlgListSize;\r
+  EFI_RNG_ALGORITHM  RngAlgList[10];\r
+  EFI_RNG_ALGORITHM  *PtrRngAlg;\r
+  UINTN              RngAlgCount;\r
+  UINT8              *Rand;\r
+  UINTN              RandSize;\r
+  UINTN              Index;\r
+  UINTN              Index2;\r
+\r
+  Status    = EFI_SUCCESS;\r
+  PtrRngAlg = NULL;\r
+  Rand      = NULL;\r
+    \r
+  Print (L"UEFI RNG Protocol Testing :\n");\r
+  Print (L"----------------------------\n");\r
+\r
+  //-----------------------------------------\r
+  // Basic UEFI RNG Protocol Test\r
+  //-----------------------------------------\r
+  Print (L" -- Locate UEFI RNG Protocol : ");\r
+  Status = gBS->LocateProtocol (&gEfiRngProtocolGuid, NULL, (VOID **)&Rng);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]\n", Status);\r
+    goto Exit;\r
+  } else {\r
+    Print (L"[Pass]\n");\r
+  }\r
+\r
+  //-----------------------------------------\r
+  // Rng->GetInfo() interface test.\r
+  //-----------------------------------------\r
+  \r
+  Print (L" -- Call RNG->GetInfo() interface : ");\r
+  RngAlgListSize = 0;\r
+  Status = Rng->GetInfo (Rng, &RngAlgListSize, NULL);\r
+  if (Status != EFI_BUFFER_TOO_SMALL) {\r
+    Print (L"[Fail - Status = %r]\n", Status);\r
+  }\r
+  //\r
+  // Print out the supported RNG algorithm GUIDs\r
+  //\r
+  RngAlgCount = RngAlgListSize / sizeof (EFI_RNG_ALGORITHM);\r
+  Print (L"\n     >> Supported RNG Algorithm (Count = %d) : ", RngAlgCount);\r
+  Status = Rng->GetInfo (Rng, &RngAlgListSize, RngAlgList);\r
+  for (Index = 0; Index < RngAlgCount; Index++) {\r
+    PtrRngAlg = (EFI_RNG_ALGORITHM *)(&RngAlgList[Index]);\r
+    Print (L"\n          %d) ", Index);\r
+    Print (L"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x", PtrRngAlg->Data1,\r
+             PtrRngAlg->Data2, PtrRngAlg->Data3, PtrRngAlg->Data4[0], PtrRngAlg->Data4[1],\r
+             PtrRngAlg->Data4[2], PtrRngAlg->Data4[3], PtrRngAlg->Data4[4],\r
+             PtrRngAlg->Data4[5], PtrRngAlg->Data4[6], PtrRngAlg->Data4[7]);    \r
+  }\r
+\r
+  //-----------------------------------------\r
+  // Rng->GetRNG() interface test.\r
+  //-----------------------------------------\r
+  Print (L"\n -- Call RNG->GetRNG() interface : ");\r
+\r
+  //\r
+  // Allocate one buffer to store random data.\r
+  //\r
+  RandSize = 32;\r
+  Rand     = AllocatePool (RandSize);\r
+  \r
+  //\r
+  // RNG with default algorithm\r
+  //\r
+  Print (L"\n     >> RNG with default algorithm : ");\r
+  Status = Rng->GetRNG (Rng, NULL, RandSize, Rand);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]", Status);\r
+  } else {\r
+    Print (L"[Pass]");\r
+  }\r
+  \r
+  //\r
+  // RNG with SP800-90-HMAC-256\r
+  //\r
+  Print (L"\n     >> RNG with SP800-90-HMAC-256 : ");\r
+  Status = Rng->GetRNG (Rng, &gEfiRngAlgorithmSp80090Hmac256Guid, RandSize, Rand);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]", Status);\r
+  } else {\r
+    Print (L"[Pass]");\r
+  }\r
+\r
+  //\r
+  // RNG with SP800-90-HASH-256\r
+  //\r
+  Print (L"\n     >> RNG with SP800-90-Hash-256 : ");\r
+  Status = Rng->GetRNG (Rng, &gEfiRngAlgorithmSp80090Hash256Guid, RandSize, Rand);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]", Status);\r
+  } else {\r
+    Print (L"[Pass]");\r
+  }\r
+\r
+  //\r
+  // RNG with SP800-90-CTR-256\r
+  //\r
+  Print (L"\n     >> RNG with SP800-90-CTR-256 : ");\r
+  Status = Rng->GetRNG (Rng, &gEfiRngAlgorithmSp80090Ctr256Guid, RandSize, Rand);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]", Status);\r
+  } else {\r
+    Print (L"[Pass]");\r
+  }\r
+\r
+  //\r
+  // RNG with X9.31-3DES\r
+  //\r
+  Print (L"\n     >> RNG with X9.31-3DES : ");\r
+  Status = Rng->GetRNG (Rng, &gEfiRngAlgorithmX9313DesGuid, RandSize, Rand);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]", Status);\r
+  } else {\r
+    Print (L"[Pass]");\r
+  }\r
+\r
+  //\r
+  // RNG with X9.31-AES\r
+  //\r
+  Print (L"\n     >> RNG with X9.31-AES : ");\r
+  Status = Rng->GetRNG (Rng, &gEfiRngAlgorithmX931AesGuid, RandSize, Rand);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]", Status);\r
+  } else {\r
+    Print (L"[Pass]");\r
+  }\r
+\r
+  //\r
+  // RNG with RAW Entropy\r
+  //\r
+  Print (L"\n     >> RNG with RAW Entropy : ");\r
+  Status = Rng->GetRNG (Rng, &gEfiRngAlgorithmRaw, RandSize, Rand);\r
+  if (EFI_ERROR (Status)) {\r
+    Print (L"[Fail - Status = %r]", Status);\r
+  } else {\r
+    Print (L"[Pass]");\r
+  }\r
+\r
+  //-----------------------------------------\r
+  // Random Number Generator test.\r
+  //-----------------------------------------\r
+  Print (L"\n -- Random Number Generation Test with default RNG Algorithm (20 Rounds): ");\r
+\r
+  RandSize = 1;\r
+  for (Index = 0; Index < 20; Index++) {\r
+    Status = Rng->GetRNG (Rng, NULL, RandSize, Rand);\r
+    if (EFI_ERROR (Status)) {\r
+      Print (L"[Fail - Status = %r]", Status);\r
+      break;\r
+    } else {\r
+      Print (L"\n          %02d) - ", Index + 1);\r
+      for (Index2 = 0; Index2 < RandSize; Index2++) {\r
+        Print (L"%02x", Rand[Index2]);\r
+      }\r
+    }\r
+\r
+    RandSize +=1;\r
+  }\r
+\r
+  //-----------------------------------------\r
+  // Random Number Generator test.\r
+  //-----------------------------------------\r
+  Print (L"\n -- RAW Entropy Generation Test (20 Rounds) : ");\r
+\r
+  RandSize = 32;\r
+  for (Index = 0; Index < 20; Index++) {\r
+    Status = Rng->GetRNG (Rng, &gEfiRngAlgorithmRaw, RandSize, Rand);\r
+    if (EFI_ERROR (Status)) {\r
+      Print (L"[Fail - Status = %r]", Status);\r
+      break;\r
+    } else {\r
+      Print (L"\n          %02d) - ", Index + 1);\r
+      for (Index2 = 0; Index2 < RandSize; Index2++) {\r
+        Print (L"%02x", Rand[Index2]);\r
+      }\r
+    }\r
+  }\r
+\r
+  Print (L"\n -- Exit UEFI RNG Protocol Test (Status = %r).\n", Status);\r
+  \r
+Exit:\r
+  if (Rand != NULL) {\r
+    FreePool (Rand);\r
+  }\r
+  return Status;\r
+}\r
diff --git a/SecurityPkg/Application/RngTest/RngTest.inf b/SecurityPkg/Application/RngTest/RngTest.inf
new file mode 100644 (file)
index 0000000..bec78a4
--- /dev/null
@@ -0,0 +1,50 @@
+## @file\r
+#  UEFI RNG (Random Number Generator) Protocol test application.\r
+#\r
+#  Copyright (c) 2013, 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
+#  http://opensource.org/licenses/bsd-license.php\r
+#\r
+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+#\r
+##\r
+\r
+[Defines]\r
+  INF_VERSION                    = 0x00010005\r
+  BASE_NAME                      = RngTest\r
+  FILE_GUID                      = B8AC7FB2-4211-4c2b-B62F-504421666C87\r
+  MODULE_TYPE                    = UEFI_APPLICATION\r
+  VERSION_STRING                 = 1.0\r
+  ENTRY_POINT                    = UefiMain\r
+\r
+#\r
+# The following information is for reference only and not required by the build tools.\r
+#\r
+#  VALID_ARCHITECTURES           = IA32 X64\r
+#\r
+\r
+[Sources]\r
+  RngTest.c\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+  MdeModulePkg/MdeModulePkg.dec\r
+  SecurityPkg/SecurityPkg.dec\r
+\r
+[LibraryClasses]\r
+  UefiApplicationEntryPoint\r
+  UefiLib\r
+\r
+[Protocols]\r
+  gEfiRngProtocolGuid\r
+\r
+[Guids]\r
+  gEfiRngAlgorithmSp80090Hash256Guid\r
+  gEfiRngAlgorithmSp80090Hmac256Guid\r
+  gEfiRngAlgorithmSp80090Ctr256Guid\r
+  gEfiRngAlgorithmX9313DesGuid\r
+  gEfiRngAlgorithmX931AesGuid\r
+  gEfiRngAlgorithmRaw
\ No newline at end of file
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/AesCore.c b/SecurityPkg/RandomNumberGenerator/RngDxe/AesCore.c
new file mode 100644 (file)
index 0000000..46d82ac
--- /dev/null
@@ -0,0 +1,367 @@
+/** @file\r
+  Core Primitive Implementation of the Advanced Encryption Standard (AES) algorithm.\r
+  Refer to FIPS PUB 197 ("Advanced Encryption Standard (AES)") for detailed algorithm \r
+  description of AES. \r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "AesCore.h"\r
+\r
+//\r
+// Number of columns (32-bit words) comprising the State.\r
+// AES_NB is a constant (value = 4) for NIST FIPS-197.\r
+//\r
+#define AES_NB                     4\r
+\r
+//\r
+// Pre-computed AES Forward Table: AES_ETABLE[t] = AES_SBOX[t].[02, 01, 01, 03]\r
+// This is to speed up execution of the cipher by combining SubBytes and\r
+// ShiftRows with MixColumns steps and transforming them into table lookups.\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT32 AES_FTABLE[] = {\r
+  0xc66363a5, 0xf87c7c84, 0xee777799, 0xf67b7b8d, 0xfff2f20d, 0xd66b6bbd, \r
+  0xde6f6fb1, 0x91c5c554, 0x60303050, 0x02010103, 0xce6767a9, 0x562b2b7d,\r
+  0xe7fefe19, 0xb5d7d762, 0x4dababe6, 0xec76769a, 0x8fcaca45, 0x1f82829d, \r
+  0x89c9c940, 0xfa7d7d87, 0xeffafa15, 0xb25959eb, 0x8e4747c9, 0xfbf0f00b,\r
+  0x41adadec, 0xb3d4d467, 0x5fa2a2fd, 0x45afafea, 0x239c9cbf, 0x53a4a4f7, \r
+  0xe4727296, 0x9bc0c05b, 0x75b7b7c2, 0xe1fdfd1c, 0x3d9393ae, 0x4c26266a,\r
+  0x6c36365a, 0x7e3f3f41, 0xf5f7f702, 0x83cccc4f, 0x6834345c, 0x51a5a5f4, \r
+  0xd1e5e534, 0xf9f1f108, 0xe2717193, 0xabd8d873, 0x62313153, 0x2a15153f,\r
+  0x0804040c, 0x95c7c752, 0x46232365, 0x9dc3c35e, 0x30181828, 0x379696a1, \r
+  0x0a05050f, 0x2f9a9ab5, 0x0e070709, 0x24121236, 0x1b80809b, 0xdfe2e23d,\r
+  0xcdebeb26, 0x4e272769, 0x7fb2b2cd, 0xea75759f, 0x1209091b, 0x1d83839e, \r
+  0x582c2c74, 0x341a1a2e, 0x361b1b2d, 0xdc6e6eb2, 0xb45a5aee, 0x5ba0a0fb,\r
+  0xa45252f6, 0x763b3b4d, 0xb7d6d661, 0x7db3b3ce, 0x5229297b, 0xdde3e33e, \r
+  0x5e2f2f71, 0x13848497, 0xa65353f5, 0xb9d1d168, 0x00000000, 0xc1eded2c,\r
+  0x40202060, 0xe3fcfc1f, 0x79b1b1c8, 0xb65b5bed, 0xd46a6abe, 0x8dcbcb46, \r
+  0x67bebed9, 0x7239394b, 0x944a4ade, 0x984c4cd4, 0xb05858e8, 0x85cfcf4a,\r
+  0xbbd0d06b, 0xc5efef2a, 0x4faaaae5, 0xedfbfb16, 0x864343c5, 0x9a4d4dd7, \r
+  0x66333355, 0x11858594, 0x8a4545cf, 0xe9f9f910, 0x04020206, 0xfe7f7f81,\r
+  0xa05050f0, 0x783c3c44, 0x259f9fba, 0x4ba8a8e3, 0xa25151f3, 0x5da3a3fe, \r
+  0x804040c0, 0x058f8f8a, 0x3f9292ad, 0x219d9dbc, 0x70383848, 0xf1f5f504,\r
+  0x63bcbcdf, 0x77b6b6c1, 0xafdada75, 0x42212163, 0x20101030, 0xe5ffff1a, \r
+  0xfdf3f30e, 0xbfd2d26d, 0x81cdcd4c, 0x180c0c14, 0x26131335, 0xc3ecec2f,\r
+  0xbe5f5fe1, 0x359797a2, 0x884444cc, 0x2e171739, 0x93c4c457, 0x55a7a7f2, \r
+  0xfc7e7e82, 0x7a3d3d47, 0xc86464ac, 0xba5d5de7, 0x3219192b, 0xe6737395,\r
+  0xc06060a0, 0x19818198, 0x9e4f4fd1, 0xa3dcdc7f, 0x44222266, 0x542a2a7e, \r
+  0x3b9090ab, 0x0b888883, 0x8c4646ca, 0xc7eeee29, 0x6bb8b8d3, 0x2814143c,\r
+  0xa7dede79, 0xbc5e5ee2, 0x160b0b1d, 0xaddbdb76, 0xdbe0e03b, 0x64323256, \r
+  0x743a3a4e, 0x140a0a1e, 0x924949db, 0x0c06060a, 0x4824246c, 0xb85c5ce4,\r
+  0x9fc2c25d, 0xbdd3d36e, 0x43acacef, 0xc46262a6, 0x399191a8, 0x319595a4, \r
+  0xd3e4e437, 0xf279798b, 0xd5e7e732, 0x8bc8c843, 0x6e373759, 0xda6d6db7,\r
+  0x018d8d8c, 0xb1d5d564, 0x9c4e4ed2, 0x49a9a9e0, 0xd86c6cb4, 0xac5656fa, \r
+  0xf3f4f407, 0xcfeaea25, 0xca6565af, 0xf47a7a8e, 0x47aeaee9, 0x10080818,\r
+  0x6fbabad5, 0xf0787888, 0x4a25256f, 0x5c2e2e72, 0x381c1c24, 0x57a6a6f1, \r
+  0x73b4b4c7, 0x97c6c651, 0xcbe8e823, 0xa1dddd7c, 0xe874749c, 0x3e1f1f21,\r
+  0x964b4bdd, 0x61bdbddc, 0x0d8b8b86, 0x0f8a8a85, 0xe0707090, 0x7c3e3e42, \r
+  0x71b5b5c4, 0xcc6666aa, 0x904848d8, 0x06030305, 0xf7f6f601, 0x1c0e0e12,\r
+  0xc26161a3, 0x6a35355f, 0xae5757f9, 0x69b9b9d0, 0x17868691, 0x99c1c158, \r
+  0x3a1d1d27, 0x279e9eb9, 0xd9e1e138, 0xebf8f813, 0x2b9898b3, 0x22111133,\r
+  0xd26969bb, 0xa9d9d970, 0x078e8e89, 0x339494a7, 0x2d9b9bb6, 0x3c1e1e22, \r
+  0x15878792, 0xc9e9e920, 0x87cece49, 0xaa5555ff, 0x50282878, 0xa5dfdf7a,\r
+  0x038c8c8f, 0x59a1a1f8, 0x09898980, 0x1a0d0d17, 0x65bfbfda, 0xd7e6e631, \r
+  0x844242c6, 0xd06868b8, 0x824141c3, 0x299999b0, 0x5a2d2d77, 0x1e0f0f11,\r
+  0x7bb0b0cb, 0xa85454fc, 0x6dbbbbd6, 0x2c16163a\r
+};\r
+\r
+//\r
+// Pre-computed AES Reverse Table: AES_DTABLE[t] = AES_INV_SBOX[t].[0e, 09, 0d, 0b]\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT32 AES_RTABLE[] = {\r
+  0x51f4a750, 0x7e416553, 0x1a17a4c3, 0x3a275e96, 0x3bab6bcb, 0x1f9d45f1, \r
+  0xacfa58ab, 0x4be30393, 0x2030fa55, 0xad766df6, 0x88cc7691, 0xf5024c25,\r
+  0x4fe5d7fc, 0xc52acbd7, 0x26354480, 0xb562a38f, 0xdeb15a49, 0x25ba1b67, \r
+  0x45ea0e98, 0x5dfec0e1, 0xc32f7502, 0x814cf012, 0x8d4697a3, 0x6bd3f9c6,\r
+  0x038f5fe7, 0x15929c95, 0xbf6d7aeb, 0x955259da, 0xd4be832d, 0x587421d3, \r
+  0x49e06929, 0x8ec9c844, 0x75c2896a, 0xf48e7978, 0x99583e6b, 0x27b971dd,\r
+  0xbee14fb6, 0xf088ad17, 0xc920ac66, 0x7dce3ab4, 0x63df4a18, 0xe51a3182, \r
+  0x97513360, 0x62537f45, 0xb16477e0, 0xbb6bae84, 0xfe81a01c, 0xf9082b94,\r
+  0x70486858, 0x8f45fd19, 0x94de6c87, 0x527bf8b7, 0xab73d323, 0x724b02e2, \r
+  0xe31f8f57, 0x6655ab2a, 0xb2eb2807, 0x2fb5c203, 0x86c57b9a, 0xd33708a5,\r
+  0x302887f2, 0x23bfa5b2, 0x02036aba, 0xed16825c, 0x8acf1c2b, 0xa779b492, \r
+  0xf307f2f0, 0x4e69e2a1, 0x65daf4cd, 0x0605bed5, 0xd134621f, 0xc4a6fe8a,\r
+  0x342e539d, 0xa2f355a0, 0x058ae132, 0xa4f6eb75, 0x0b83ec39, 0x4060efaa, \r
+  0x5e719f06, 0xbd6e1051, 0x3e218af9, 0x96dd063d, 0xdd3e05ae, 0x4de6bd46,\r
+  0x91548db5, 0x71c45d05, 0x0406d46f, 0x605015ff, 0x1998fb24, 0xd6bde997, \r
+  0x894043cc, 0x67d99e77, 0xb0e842bd, 0x07898b88, 0xe7195b38, 0x79c8eedb,\r
+  0xa17c0a47, 0x7c420fe9, 0xf8841ec9, 0x00000000, 0x09808683, 0x322bed48, \r
+  0x1e1170ac, 0x6c5a724e, 0xfd0efffb, 0x0f853856, 0x3daed51e, 0x362d3927,\r
+  0x0a0fd964, 0x685ca621, 0x9b5b54d1, 0x24362e3a, 0x0c0a67b1, 0x9357e70f, \r
+  0xb4ee96d2, 0x1b9b919e, 0x80c0c54f, 0x61dc20a2, 0x5a774b69, 0x1c121a16,\r
+  0xe293ba0a, 0xc0a02ae5, 0x3c22e043, 0x121b171d, 0x0e090d0b, 0xf28bc7ad, \r
+  0x2db6a8b9, 0x141ea9c8, 0x57f11985, 0xaf75074c, 0xee99ddbb, 0xa37f60fd,\r
+  0xf701269f, 0x5c72f5bc, 0x44663bc5, 0x5bfb7e34, 0x8b432976, 0xcb23c6dc, \r
+  0xb6edfc68, 0xb8e4f163, 0xd731dcca, 0x42638510, 0x13972240, 0x84c61120,\r
+  0x854a247d, 0xd2bb3df8, 0xaef93211, 0xc729a16d, 0x1d9e2f4b, 0xdcb230f3, \r
+  0x0d8652ec, 0x77c1e3d0, 0x2bb3166c, 0xa970b999, 0x119448fa, 0x47e96422,\r
+  0xa8fc8cc4, 0xa0f03f1a, 0x567d2cd8, 0x223390ef, 0x87494ec7, 0xd938d1c1, \r
+  0x8ccaa2fe, 0x98d40b36, 0xa6f581cf, 0xa57ade28, 0xdab78e26, 0x3fadbfa4,\r
+  0x2c3a9de4, 0x5078920d, 0x6a5fcc9b, 0x547e4662, 0xf68d13c2, 0x90d8b8e8, \r
+  0x2e39f75e, 0x82c3aff5, 0x9f5d80be, 0x69d0937c, 0x6fd52da9, 0xcf2512b3,\r
+  0xc8ac993b, 0x10187da7, 0xe89c636e, 0xdb3bbb7b, 0xcd267809, 0x6e5918f4, \r
+  0xec9ab701, 0x834f9aa8, 0xe6956e65, 0xaaffe67e, 0x21bccf08, 0xef15e8e6,\r
+  0xbae79bd9, 0x4a6f36ce, 0xea9f09d4, 0x29b07cd6, 0x31a4b2af, 0x2a3f2331, \r
+  0xc6a59430, 0x35a266c0, 0x744ebc37, 0xfc82caa6, 0xe090d0b0, 0x33a7d815,\r
+  0xf104984a, 0x41ecdaf7, 0x7fcd500e, 0x1791f62f, 0x764dd68d, 0x43efb04d, \r
+  0xccaa4d54, 0xe49604df, 0x9ed1b5e3, 0x4c6a881b, 0xc12c1fb8, 0x4665517f,\r
+  0x9d5eea04, 0x018c355d, 0xfa877473, 0xfb0b412e, 0xb3671d5a, 0x92dbd252, \r
+  0xe9105633, 0x6dd64713, 0x9ad7618c, 0x37a10c7a, 0x59f8148e, 0xeb133c89,\r
+  0xcea927ee, 0xb761c935, 0xe11ce5ed, 0x7a47b13c, 0x9cd2df59, 0x55f2733f, \r
+  0x1814ce79, 0x73c737bf, 0x53f7cdea, 0x5ffdaa5b, 0xdf3d6f14, 0x7844db86,\r
+  0xcaaff381, 0xb968c43e, 0x3824342c, 0xc2a3405f, 0x161dc372, 0xbce2250c, \r
+  0x283c498b, 0xff0d9541, 0x39a80171, 0x080cb3de, 0xd8b4e49c, 0x6456c190,\r
+  0x7bcb8461, 0xd532b670, 0x486c5c74, 0xd0b85742\r
+};\r
+\r
+//\r
+// AES Inverse S-Box (Defined in sec 5.3.2 of FIPS PUB 197).\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT8 AES_INV_SBOX[256] = {\r
+  0x52, 0x09, 0x6a, 0xd5, 0x30, 0x36, 0xa5, 0x38, 0xbf, 0x40, 0xa3, 0x9e, 0x81, 0xf3, 0xd7, 0xfb,\r
+  0x7c, 0xe3, 0x39, 0x82, 0x9b, 0x2f, 0xff, 0x87, 0x34, 0x8e, 0x43, 0x44, 0xc4, 0xde, 0xe9, 0xcb,\r
+  0x54, 0x7b, 0x94, 0x32, 0xa6, 0xc2, 0x23, 0x3d, 0xee, 0x4c, 0x95, 0x0b, 0x42, 0xfa, 0xc3, 0x4e,\r
+  0x08, 0x2e, 0xa1, 0x66, 0x28, 0xd9, 0x24, 0xb2, 0x76, 0x5b, 0xa2, 0x49, 0x6d, 0x8b, 0xd1, 0x25,\r
+  0x72, 0xf8, 0xf6, 0x64, 0x86, 0x68, 0x98, 0x16, 0xd4, 0xa4, 0x5c, 0xcc, 0x5d, 0x65, 0xb6, 0x92,\r
+  0x6c, 0x70, 0x48, 0x50, 0xfd, 0xed, 0xb9, 0xda, 0x5e, 0x15, 0x46, 0x57, 0xa7, 0x8d, 0x9d, 0x84,\r
+  0x90, 0xd8, 0xab, 0x00, 0x8c, 0xbc, 0xd3, 0x0a, 0xf7, 0xe4, 0x58, 0x05, 0xb8, 0xb3, 0x45, 0x06,\r
+  0xd0, 0x2c, 0x1e, 0x8f, 0xca, 0x3f, 0x0f, 0x02, 0xc1, 0xaf, 0xbd, 0x03, 0x01, 0x13, 0x8a, 0x6b,\r
+  0x3a, 0x91, 0x11, 0x41, 0x4f, 0x67, 0xdc, 0xea, 0x97, 0xf2, 0xcf, 0xce, 0xf0, 0xb4, 0xe6, 0x73,\r
+  0x96, 0xac, 0x74, 0x22, 0xe7, 0xad, 0x35, 0x85, 0xe2, 0xf9, 0x37, 0xe8, 0x1c, 0x75, 0xdf, 0x6e,\r
+  0x47, 0xf1, 0x1a, 0x71, 0x1d, 0x29, 0xc5, 0x89, 0x6f, 0xb7, 0x62, 0x0e, 0xaa, 0x18, 0xbe, 0x1b,\r
+  0xfc, 0x56, 0x3e, 0x4b, 0xc6, 0xd2, 0x79, 0x20, 0x9a, 0xdb, 0xc0, 0xfe, 0x78, 0xcd, 0x5a, 0xf4,\r
+  0x1f, 0xdd, 0xa8, 0x33, 0x88, 0x07, 0xc7, 0x31, 0xb1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xec, 0x5f,\r
+  0x60, 0x51, 0x7f, 0xa9, 0x19, 0xb5, 0x4a, 0x0d, 0x2d, 0xe5, 0x7a, 0x9f, 0x93, 0xc9, 0x9c, 0xef,\r
+  0xa0, 0xe0, 0x3b, 0x4d, 0xae, 0x2a, 0xf5, 0xb0, 0xc8, 0xeb, 0xbb, 0x3c, 0x83, 0x53, 0x99, 0x61,\r
+  0x17, 0x2b, 0x04, 0x7e, 0xba, 0x77, 0xd6, 0x26, 0xe1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0c, 0x7d\r
+};\r
+\r
+//\r
+// Round constant word array used in AES key expansion.\r
+//\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST UINT32 Rcon[] = {\r
+  0x01000000, 0x02000000, 0x04000000, 0x08000000, 0x10000000,\r
+  0x20000000, 0x40000000, 0x80000000, 0x1B000000, 0x36000000\r
+};\r
+\r
+//\r
+// Rotates x right n bits (circular right shift operation)\r
+//\r
+#define ROTATE_RIGHT32(x, n)    (((x) >> (n)) | ((x) << (32-(n))))\r
+\r
+//\r
+// Loading & Storing 32-bit words in big-endian format: y[3..0] --> x; x --> y[3..0];\r
+//\r
+#define LOAD32H(x, y)    { x = ((UINT32)((y)[0] & 0xFF) << 24) | ((UINT32)((y)[1] & 0xFF) << 16) |  \\r
+                               ((UINT32)((y)[2] & 0xFF) <<  8) | ((UINT32)((y)[3] & 0xFF)); }\r
+#define STORE32H(x, y)   { (y)[0] = (UINT8)(((x) >> 24) & 0xFF); (y)[1] = (UINT8)(((x) >> 16) & 0xFF); \\r
+                           (y)[2] = (UINT8)(((x) >>  8) & 0xFF); (y)[3] = (UINT8)((x)         & 0xFF); }\r
+\r
+//\r
+// Wrap macros for AES forward and reverse tables lookups\r
+//\r
+#define AES_FT0(x)  AES_FTABLE[x]\r
+#define AES_FT1(x)  ROTATE_RIGHT32(AES_FTABLE[x],  8)\r
+#define AES_FT2(x)  ROTATE_RIGHT32(AES_FTABLE[x], 16)\r
+#define AES_FT3(x)  ROTATE_RIGHT32(AES_FTABLE[x], 24)\r
+\r
+#define AES_RT0(x)  AES_RTABLE[x]\r
+#define AES_RT1(x)  ROTATE_RIGHT32(AES_RTABLE[x],  8)\r
+#define AES_RT2(x)  ROTATE_RIGHT32(AES_RTABLE[x], 16)\r
+#define AES_RT3(x)  ROTATE_RIGHT32(AES_RTABLE[x], 24)\r
+\r
+///\r
+/// AES Key Schedule which is expanded from symmetric key [Size 60 = 4 * ((Max AES Round, 14) + 1)].\r
+///\r
+typedef struct {\r
+  UINTN     Nk;            // Number of Cipher Key (in 32-bit words);\r
+  UINT32    eKey[60];      // Expanded AES encryption key\r
+  UINT32    dKey[60];      // Expanded AES decryption key (Not used here)\r
+} AES_KEY;\r
+\r
+/**\r
+  AES Key Expansion. \r
+  This function expands the cipher key into encryption schedule.\r
+\r
+  @param[in]  Key                AES symmetric key buffer.\r
+  @param[in]  KeyLenInBits       Key length in bits (128, 192, or 256).\r
+  @param[out] AesKey             Expanded AES Key schedule for encryption.\r
+\r
+  @retval EFI_SUCCESS            AES key expansion succeeded.\r
+  @retval EFI_INVALID_PARAMETER  Unsupported key length.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+AesExpandKey (\r
+  IN UINT8         *Key,\r
+  IN UINTN         KeyLenInBits,\r
+  OUT AES_KEY      *AesKey\r
+  )\r
+{\r
+  UINTN       Nk, Nr, NW;\r
+  UINTN       i, j, k;\r
+  UINT32      *Ek;\r
+  UINT32      Temp;\r
+\r
+  //\r
+  // Nk - Number of 32-bit words comprising the cipher key. (Nk = 4, 6 or 8)\r
+  // Nr - Number of rounds. (Nr = 10, 12, or 14), which is dependent on the key size.\r
+  //\r
+  Nk = KeyLenInBits >> 5;\r
+  if (Nk != 4 && Nk != 6 && Nk != 8) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  Nr = Nk + 6;\r
+  NW = AES_NB * (Nr + 1);    // Key Expansion generates a total of Nb * (Nr + 1) words\r
+  AesKey->Nk = Nk;\r
+\r
+  //\r
+  // Load initial symmetric AES key;\r
+  // Note that AES was designed on big-endian systems.\r
+  //\r
+  Ek = AesKey->eKey;\r
+  for (i = j = 0; i < Nk; i++, j+=4) {\r
+    LOAD32H (Ek[i], Key + j);\r
+  }\r
+  \r
+  //\r
+  // Initialize the encryption key scheduler\r
+  //\r
+  for (j = Nk, k = 0; j < NW; j+=Nk, k++) {\r
+    Temp  = Ek[j - 1];\r
+    Ek[j] = Ek[j - Nk] ^ (AES_FT2((Temp >> 16) & 0xFF) & 0xFF000000) ^\r
+                         (AES_FT3((Temp >>  8) & 0xFF) & 0x00FF0000) ^\r
+                         (AES_FT0((Temp)       & 0xFF) & 0x0000FF00) ^\r
+                         (AES_FT1((Temp >> 24) & 0xFF) & 0x000000FF) ^\r
+                         Rcon[k];\r
+    if (Nk <= 6) {\r
+      //\r
+      // If AES Cipher Key is 128 or 192 bits\r
+      //\r
+      for (i = 1; i < Nk && (i + j) < NW; i++) {\r
+        Ek [i + j] = Ek [i + j - Nk] ^ Ek[i + j - 1];\r
+      }\r
+    } else {\r
+      //\r
+      // Different routine for key expansion If Cipher Key is 256 bits, \r
+      //\r
+      for (i = 1; i < 4 && (i + j) < NW; i++) {\r
+        Ek [i + j] = Ek[i + j - Nk] ^ Ek[i + j - 1];\r
+      }\r
+      if (j + 4 < NW) {\r
+        Temp      = Ek[j + 3];\r
+        Ek[j + 4] = Ek[j + 4 - Nk] ^ (AES_FT2((Temp >> 24) & 0xFF) & 0xFF000000) ^\r
+                                     (AES_FT3((Temp >> 16) & 0xFF) & 0x00FF0000) ^\r
+                                     (AES_FT0((Temp >>  8) & 0xFF) & 0x0000FF00) ^\r
+                                     (AES_FT1((Temp)       & 0xFF) & 0x000000FF);\r
+      }\r
+      \r
+      for (i = 5; i < Nk && (i + j) < NW; i++) {\r
+        Ek[i + j] = Ek[i + j - Nk] ^ Ek[i + j - 1];\r
+      }\r
+    }\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Encrypts one single block data (128 bits) with AES algorithm.\r
+\r
+  @param[in]  Key                AES symmetric key buffer.\r
+  @param[in]  InData             One block of input plaintext to be encrypted.\r
+  @param[out] OutData            Encrypted output ciphertext.\r
+\r
+  @retval EFI_SUCCESS            AES Block Encryption succeeded.\r
+  @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+AesEncrypt (\r
+  IN  UINT8        *Key,\r
+  IN  UINT8        *InData,\r
+  OUT UINT8        *OutData\r
+  )\r
+{\r
+  AES_KEY  AesKey;\r
+  UINTN    Nr;\r
+  UINT32   *Ek, s[4], t[4], *x, *y, *Temp;\r
+  UINTN    Index, k, Round;\r
+\r
+  if ((Key == NULL) || (InData == NULL) || (OutData == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Expands AES Key for encryption.\r
+  //\r
+  AesExpandKey (Key, 128, &AesKey);\r
+\r
+  Nr = AesKey.Nk + 6;\r
+  Ek = AesKey.eKey;\r
+\r
+  //\r
+  // Initialize the cipher State array with the initial round key\r
+  //\r
+  for (Index = 0; Index < AES_NB; Index++) {\r
+    LOAD32H (s[Index], InData + 4 * Index);\r
+    s[Index] ^= Ek[Index];\r
+  }\r
+\r
+  k = AES_NB;\r
+  x = s; \r
+  y = t;\r
+  //\r
+  // AES Cipher transformation rounds (Nr - 1 rounds), in which SubBytes(), \r
+  // ShiftRows() and MixColumns() operations were combined by a sequence of \r
+  // table lookups to speed up the execution.\r
+  //\r
+  for (Round = 1; Round < Nr; Round++) {\r
+    y[0] = AES_FT0 ((x[0] >> 24)       ) ^ AES_FT1 ((x[1] >> 16) & 0xFF) ^\r
+           AES_FT2 ((x[2] >>  8) & 0xFF) ^ AES_FT3 ((x[3]      ) & 0xFF) ^ Ek[k];\r
+    y[1] = AES_FT0 ((x[1] >> 24)       ) ^ AES_FT1 ((x[2] >> 16) & 0xFF) ^\r
+           AES_FT2 ((x[3] >>  8) & 0xFF) ^ AES_FT3 ((x[0]      ) & 0xFF) ^ Ek[k + 1];\r
+    y[2] = AES_FT0 ((x[2] >> 24)       ) ^ AES_FT1 ((x[3] >> 16) & 0xFF) ^\r
+           AES_FT2 ((x[0] >>  8) & 0xFF) ^ AES_FT3 ((x[1]      ) & 0xFF) ^ Ek[k + 2];\r
+    y[3] = AES_FT0 ((x[3] >> 24)       ) ^ AES_FT1 ((x[0] >> 16) & 0xFF) ^\r
+           AES_FT2 ((x[1] >>  8) & 0xFF) ^ AES_FT3 ((x[2]      ) & 0xFF) ^ Ek[k + 3];\r
+\r
+    k += 4;\r
+    Temp = x; x = y; y = Temp;  \r
+  }\r
+\r
+  //\r
+  // Apply the final round, which does not include MixColumns() transformation\r
+  //\r
+  y[0] = (AES_FT2 ((x[0] >> 24)       ) & 0xFF000000) ^ (AES_FT3 ((x[1] >> 16) & 0xFF) & 0x00FF0000) ^\r
+         (AES_FT0 ((x[2] >>  8) & 0xFF) & 0x0000FF00) ^ (AES_FT1 ((x[3]      ) & 0xFF) & 0x000000FF) ^\r
+         Ek[k];\r
+  y[1] = (AES_FT2 ((x[1] >> 24)       ) & 0xFF000000) ^ (AES_FT3 ((x[2] >> 16) & 0xFF) & 0x00FF0000) ^\r
+         (AES_FT0 ((x[3] >>  8) & 0xFF) & 0x0000FF00) ^ (AES_FT1 ((x[0]      ) & 0xFF) & 0x000000FF) ^\r
+         Ek[k + 1];\r
+  y[2] = (AES_FT2 ((x[2] >> 24)       ) & 0xFF000000) ^ (AES_FT3 ((x[3] >> 16) & 0xFF) & 0x00FF0000) ^\r
+         (AES_FT0 ((x[0] >>  8) & 0xFF) & 0x0000FF00) ^ (AES_FT1 ((x[1]      ) & 0xFF) & 0x000000FF) ^\r
+         Ek[k + 2];\r
+  y[3] = (AES_FT2 ((x[3] >> 24)       ) & 0xFF000000) ^ (AES_FT3 ((x[0] >> 16) & 0xFF) & 0x00FF0000) ^\r
+         (AES_FT0 ((x[1] >>  8) & 0xFF) & 0x0000FF00) ^ (AES_FT1 ((x[2]      ) & 0xFF) & 0x000000FF) ^\r
+         Ek[k + 3];\r
+\r
+  //\r
+  // Output the transformed result;\r
+  //\r
+  for (Index = 0; Index < AES_NB; Index++) {\r
+    STORE32H (y[Index], OutData + 4 * Index);\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}
\ No newline at end of file
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/AesCore.h b/SecurityPkg/RandomNumberGenerator/RngDxe/AesCore.h
new file mode 100644 (file)
index 0000000..8279c61
--- /dev/null
@@ -0,0 +1,37 @@
+/** @file\r
+  Function prototype for AES Block Cipher support.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef __AES_CORE_H__\r
+#define __AES_CORE_H__\r
+\r
+/**\r
+  Encrypts one single block data (128 bits) with AES algorithm.\r
+\r
+  @param[in]  Key                AES symmetric key buffer.\r
+  @param[in]  InData             One block of input plaintext to be encrypted.\r
+  @param[out] OutData            Encrypted output ciphertext.\r
+\r
+  @retval EFI_SUCCESS            AES Block Encryption succeeded.\r
+  @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+AesEncrypt (\r
+  IN  UINT8        *Key,\r
+  IN  UINT8        *InData,\r
+  OUT UINT8        *OutData\r
+  );\r
+\r
+#endif  // __AES_CORE_H__\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/IA32/AsmRdRand.asm b/SecurityPkg/RandomNumberGenerator/RngDxe/IA32/AsmRdRand.asm
new file mode 100644 (file)
index 0000000..37b3830
--- /dev/null
@@ -0,0 +1,67 @@
+;------------------------------------------------------------------------------\r
+;\r
+; Copyright (c) 2013, 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
+; http://opensource.org/licenses/bsd-license.php.\r
+;\r
+; THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+; WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+;\r
+; Module Name:\r
+;\r
+;   AsmRdRand.Asm\r
+;\r
+; Abstract:\r
+;\r
+;   Implementation for 16-, and 32- invocations of RDRAND instruction under 32bit platform.\r
+;\r
+; Notes:\r
+;\r
+;   Visual Studio coding practices do not use inline asm since multiple compilers and \r
+;   architectures are supported assembler not recognizing rdrand instruction so using DB's.\r
+;\r
+;------------------------------------------------------------------------------\r
+\r
+    .586P\r
+    .model flat, C\r
+    .code\r
\r
+;------------------------------------------------------------------------------\r
+;  Generate a 16 bit random number\r
+;  Return TRUE if Rand generated successfully, or FALSE if not\r
+;\r
+;  BOOLEAN EFIAPI RdRand16Step (UINT16 *Rand);   ECX\r
+;------------------------------------------------------------------------------\r
+RdRand16Step  PROC\r
+    ; rdrand   ax                  ; generate a 16 bit RN into ax, CF=1 if RN generated ok, otherwise CF=0\r
+    db     0fh, 0c7h, 0f0h         ; rdrand r16:  "0f c7 /6  ModRM:r/m(w)"\r
+    jb     rn16_ok                 ; jmp if CF=1\r
+    xor    eax, eax                ; reg=0 if CF=0\r
+    ret                            ; return with failure status\r
+rn16_ok:\r
+    mov    [ecx], ax\r
+    mov    eax, 1\r
+    ret\r
+RdRand16Step ENDP\r
+\r
+;------------------------------------------------------------------------------\r
+;  Generate a 32 bit random number\r
+;    Return TRUE if Rand generated successfully, or FALSE if not\r
+;\r
+;  BOOLEAN EFIAPI RdRand32Step (UINT32 *Rand);   ECX\r
+;------------------------------------------------------------------------------\r
+RdRand32Step  PROC\r
+    ; rdrand   eax                 ; generate a 32 bit RN into eax, CF=1 if RN generated ok, otherwise CF=0\r
+    db     0fh, 0c7h, 0f0h         ; rdrand r32:  "0f c7 /6  ModRM:r/m(w)"\r
+    jb     rn32_ok                 ; jmp if CF=1\r
+    xor    eax, eax                ; reg=0 if CF=0\r
+    ret                            ; return with failure status\r
+rn32_ok:\r
+    mov    [ecx], eax\r
+    mov    eax,  1\r
+    ret\r
+RdRand32Step  ENDP\r
+\r
+    END\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/IA32/GccRdRand.c b/SecurityPkg/RandomNumberGenerator/RngDxe/IA32/GccRdRand.c
new file mode 100644 (file)
index 0000000..f42302a
--- /dev/null
@@ -0,0 +1,69 @@
+/** @file\r
+  RDRAND Support Routines for GCC environment.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+/**\r
+  Generates a 16-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand16Step (\r
+  OUT UINT16       *Rand\r
+  )\r
+{\r
+  UINT8  Carry;\r
+\r
+  //\r
+  // Uses byte code for RDRAND instruction,\r
+  // in case that GCC version has no direct support on RDRAND assembly.\r
+  //\r
+  __asm__ __volatile__ (\r
+    ".byte 0x66; .byte 0x0f; .byte 0xc7; .byte 0xf0; setc %1"\r
+    :"=a"  (*Rand), \r
+     "=qm" (Carry)\r
+    ); \r
+\r
+  return (BOOLEAN) Carry;\r
+}\r
+\r
+/**\r
+  Generates a 32-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand32Step (\r
+  OUT UINT32       *Rand\r
+  )\r
+{\r
+  UINT8  Carry;\r
+\r
+  __asm__ __volatile__ (\r
+    ".byte 0x0f; .byte 0xc7; .byte 0xf0; setc %1"\r
+    :"=a"  (*Rand), \r
+     "=qm" (Carry)\r
+    );\r
+\r
+  return (BOOLEAN) Carry;\r
+}
\ No newline at end of file
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/IA32/RdRandWord.c b/SecurityPkg/RandomNumberGenerator/RngDxe/IA32/RdRandWord.c
new file mode 100644 (file)
index 0000000..125c53b
--- /dev/null
@@ -0,0 +1,104 @@
+/** @file\r
+  RDRAND Support Routines.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "RdRand.h"\r
+\r
+/**\r
+  Generates a 64-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand64Step  (\r
+  OUT UINT64   *Rand\r
+  )\r
+{\r
+  UINT32  RandLow;\r
+  UINT32  RandHigh;\r
+\r
+  //\r
+  // Generating a 64-bit rand on a 32-bit system by \r
+  // mapping two 32-bit RDRAND instructions.\r
+  //\r
+  if (!RdRand32Step (&RandLow)) {\r
+    return FALSE;\r
+  }\r
+  if (!RdRand32Step (&RandHigh)) {\r
+    return FALSE;\r
+  }\r
+\r
+  *Rand = (UINT64) RandLow | LShiftU64 ((UINT64)RandHigh, 32);\r
+\r
+  return TRUE;\r
+}\r
+\r
+/**\r
+  Calls RDRAND to request a word-length random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random number.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        Random word generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random word.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandWord (\r
+  OUT UINTN        *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  )\r
+{\r
+  return RdRand32 (Rand, NeedRetry);\r
+}\r
+\r
+/**\r
+  Calls RDRAND to request multiple word-length random numbers.\r
+\r
+  @param[in]   Length        Size of the buffer, in words, to fill with.\r
+  @param[out]  RandBuffer    Pointer to the buffer to store the random result.\r
+\r
+  @retval EFI_SUCCESS        Random words generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random words.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGetWords (\r
+  IN UINTN         Length,\r
+  OUT UINTN        *RandBuffer\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  UINT32      Index;\r
+\r
+  for (Index = 0; Index < Length; Index++) {\r
+    //\r
+    // Obtain one word-length (32-bit) Random Number with possible retry-loop.\r
+    //\r
+    Status = RdRand32 (RandBuffer, TRUE);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+    \r
+    RandBuffer++;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RdRand.c b/SecurityPkg/RandomNumberGenerator/RngDxe/RdRand.c
new file mode 100644 (file)
index 0000000..7e618dc
--- /dev/null
@@ -0,0 +1,395 @@
+/** @file\r
+  Support routines for RDRAND instruction access.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "RdRand.h"\r
+#include "AesCore.h"\r
+\r
+//\r
+// Bit mask used to determine if RdRand instruction is supported.\r
+//\r
+#define RDRAND_MASK    0x40000000\r
+\r
+/**\r
+  Determines whether or not RDRAND instruction is supported by the host hardware.\r
+\r
+  @retval EFI_SUCCESS          RDRAND instruction supported.\r
+  @retval EFI_UNSUPPORTED      RDRAND instruction not supported.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+IsRdRandSupported (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  UINT32      RegEax;\r
+  UINT32      RegEbx;\r
+  UINT32      RegEcx;\r
+  UINT32      RegEdx;\r
+  BOOLEAN     IsIntelCpu;\r
+\r
+  Status     = EFI_UNSUPPORTED;\r
+  IsIntelCpu = FALSE;\r
+  \r
+  //\r
+  // Checks whether the current processor is an Intel product by CPUID.\r
+  //\r
+  AsmCpuid (0, &RegEax, &RegEbx, &RegEcx, &RegEdx);\r
+  if ((CompareMem ((CHAR8 *)(&RegEbx), "Genu", 4) == 0) &&\r
+      (CompareMem ((CHAR8 *)(&RegEdx), "ineI", 4) == 0) &&\r
+      (CompareMem ((CHAR8 *)(&RegEcx), "ntel", 4) == 0)) {\r
+    IsIntelCpu = TRUE;\r
+  }\r
+\r
+  if (IsIntelCpu) {\r
+    //\r
+    // Determine RDRAND support by examining bit 30 of the ECX register returned by CPUID.\r
+    // A value of 1 indicates that processor supports RDRAND instruction.\r
+    //\r
+    AsmCpuid (1, 0, 0, &RegEcx, 0);\r
+\r
+    if ((RegEcx & RDRAND_MASK) == RDRAND_MASK) {\r
+      Status = EFI_SUCCESS;\r
+    }\r
+  }\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Calls RDRAND to obtain a 16-bit random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        RDRAND call was successful.\r
+  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRand16 (\r
+  OUT UINT16       *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  )\r
+{\r
+  UINT32      Index;\r
+  UINT32      RetryCount;\r
+\r
+  if (NeedRetry) {\r
+    RetryCount = RETRY_LIMIT;\r
+  } else {\r
+    RetryCount = 1;\r
+  }\r
+\r
+  //\r
+  // Perform a single call to RDRAND, or enter a loop call until RDRAND succeeds.\r
+  //\r
+  for (Index = 0; Index < RetryCount; Index++) {\r
+    if (RdRand16Step (Rand)) {\r
+      return EFI_SUCCESS;\r
+    }\r
+  }\r
+  \r
+  return EFI_NOT_READY;\r
+}\r
+\r
+/**\r
+  Calls RDRAND to obtain a 32-bit random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        RDRAND call was successful.\r
+  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRand32 (\r
+  OUT UINT32       *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  )\r
+{\r
+  UINT32      Index;\r
+  UINT32      RetryCount;\r
+\r
+  if (NeedRetry) {\r
+    RetryCount = RETRY_LIMIT;\r
+  } else {\r
+    RetryCount = 1;\r
+  }\r
+\r
+  //\r
+  // Perform a single call to RDRAND, or enter a loop call until RDRAND succeeds.\r
+  //\r
+  for (Index = 0; Index < RetryCount; Index++) {\r
+    if (RdRand32Step (Rand)) {\r
+      return EFI_SUCCESS;\r
+    }\r
+  }\r
+  \r
+  return EFI_NOT_READY;\r
+}\r
+\r
+/**\r
+  Calls RDRAND to obtain a 64-bit random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        RDRAND call was successful.\r
+  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRand64 (\r
+  OUT UINT64       *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  )\r
+{\r
+  UINT32      Index;\r
+  UINT32      RetryCount;\r
+\r
+  if (NeedRetry) {\r
+    RetryCount = RETRY_LIMIT;\r
+  } else {\r
+    RetryCount = 1;\r
+  }\r
+\r
+  //\r
+  // Perform a single call to RDRAND, or enter a loop call until RDRAND succeeds.\r
+  //\r
+  for (Index = 0; Index < RetryCount; Index++) {\r
+    if (RdRand64Step (Rand)) {\r
+      return EFI_SUCCESS;\r
+    }\r
+  }\r
+  \r
+  return EFI_NOT_READY;\r
+}\r
+\r
+/**\r
+  Calls RDRAND to fill a buffer of arbitrary size with random bytes.\r
+\r
+  @param[in]   Length        Size of the buffer, in bytes,  to fill with.\r
+  @param[out]  RandBuffer    Pointer to the buffer to store the random result.\r
+\r
+  @retval EFI_SUCCESS        Random bytes generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random bytes.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGetBytes (\r
+  IN UINTN         Length,\r
+  OUT UINT8        *RandBuffer\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  UINT8       *Start;\r
+  UINT8       *ResidualStart;\r
+  UINTN       *BlockStart;\r
+  UINTN       TempRand;\r
+  UINTN       Count;\r
+  UINTN       Residual;\r
+  UINTN       StartLen;\r
+  UINTN       BlockNum;\r
+  UINTN       Index;\r
+\r
+  ResidualStart = NULL;\r
+  TempRand      = 0;\r
+\r
+  //\r
+  // Compute the address of the first word aligned (32/64-bit) block in the \r
+  // destination buffer, depending on whether we are in 32- or 64-bit mode.\r
+  //\r
+  Start = RandBuffer;\r
+  if (((UINT32)(UINTN)Start % (UINT32)sizeof(UINTN)) == 0) {\r
+    BlockStart = (UINTN *)Start;\r
+    Count      = Length;\r
+    StartLen   = 0;\r
+  } else {\r
+    BlockStart = (UINTN *)(((UINTN)Start & ~(UINTN)(sizeof(UINTN) - 1)) + (UINTN)sizeof(UINTN));\r
+    Count      = Length - (sizeof (UINTN) - (UINT32)((UINTN)Start % sizeof (UINTN)));\r
+    StartLen   = (UINT32)((UINTN)BlockStart - (UINTN)Start);\r
+  }\r
+\r
+  //\r
+  // Compute the number of word blocks and the remaining number of bytes.\r
+  //\r
+  Residual = Count % sizeof (UINTN);\r
+  BlockNum = Count / sizeof (UINTN);\r
+  if (Residual != 0) {\r
+    ResidualStart = (UINT8 *) (BlockStart + BlockNum);\r
+  }\r
+\r
+  //\r
+  // Obtain a temporary random number for use in the residuals. Failout if retry fails.\r
+  //\r
+  if (StartLen > 0) {\r
+    Status = RdRandWord ((UINTN *) &TempRand, TRUE);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+  }\r
+\r
+  //\r
+  // Populate the starting mis-aligned block.\r
+  //\r
+  for (Index = 0; Index < StartLen; Index++) {\r
+    Start[Index] = (UINT8)(TempRand & 0xff);\r
+    TempRand     = TempRand >> 8;\r
+  }\r
+\r
+  //\r
+  // Populate the central aligned block. Fail out if retry fails.\r
+  //\r
+  Status = RdRandGetWords (BlockNum, (UINTN *)(BlockStart));\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+  //\r
+  // Populate the final mis-aligned block.\r
+  //\r
+  if (Residual > 0) {\r
+    Status = RdRandWord ((UINTN *)&TempRand, TRUE);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+    for (Index = 0; Index < Residual; Index++) {\r
+      ResidualStart[Index] = (UINT8)(TempRand & 0xff);\r
+      TempRand             = TempRand >> 8;\r
+    }\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Creates a 128bit random value that is fully forward and backward prediction resistant,\r
+  suitable for seeding a NIST SP800-90 Compliant, FIPS 1402-2 certifiable SW DRBG.\r
+  This function takes multiple random numbers through RDRAND without intervening\r
+  delays to ensure reseeding and performs AES-CBC-MAC over the data to compute the\r
+  seed value.\r
+  \r
+  @param[out]  SeedBuffer    Pointer to a 128bit buffer to store the random seed.\r
+\r
+  @retval EFI_SUCCESS        Random seed generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random bytes.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGetSeed128 (\r
+  OUT UINT8        *SeedBuffer\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  UINT8       RandByte[16];\r
+  UINT8       Key[16];\r
+  UINT8       Ffv[16];\r
+  UINT8       Xored[16];\r
+  UINT32      Index;\r
+  UINT32      Index2;\r
+\r
+  //\r
+  // Chose an arbitary key and zero the feed_forward_value (FFV)\r
+  //\r
+  for (Index = 0; Index < 16; Index++) {\r
+    Key[Index] = (UINT8) Index;\r
+    Ffv[Index] = 0;\r
+  }\r
+\r
+  //\r
+  // Perform CBC_MAC over 32 * 128 bit values, with 10us gaps between 128 bit value\r
+  // The 10us gaps will ensure multiple reseeds within the HW RNG with a large design margin.\r
+  //\r
+  for (Index = 0; Index < 32; Index++) {\r
+    MicroSecondDelay (10);\r
+    Status = RdRandGetBytes (16, RandByte);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+\r
+    //\r
+    // Perform XOR operations on two 128-bit value.\r
+    //\r
+    for (Index2 = 0; Index2 < 16; Index2++) {\r
+      Xored[Index2] = RandByte[Index2] ^ Ffv[Index2];\r
+    }\r
+\r
+    AesEncrypt (Key, Xored, Ffv);\r
+  }\r
+\r
+  for (Index = 0; Index < 16; Index++) {\r
+    SeedBuffer[Index] = Ffv[Index];\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Generate high-quality entropy source through RDRAND.\r
+\r
+  @param[in]   Length        Size of the buffer, in bytes, to fill with.\r
+  @param[out]  Entropy       Pointer to the buffer to store the entropy data.\r
+\r
+  @retval EFI_SUCCESS        Entropy generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random data.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGenerateEntropy (\r
+  IN UINTN         Length,\r
+  OUT UINT8        *Entropy\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  UINTN       BlockCount;\r
+  UINT8       Seed[16];\r
+  UINT8       *Ptr;\r
+\r
+  Status     = EFI_NOT_READY;\r
+  BlockCount = Length / 16;\r
+  Ptr        = (UINT8 *)Entropy;\r
+\r
+  //\r
+  // Generate high-quality seed for DRBG Entropy\r
+  //\r
+  while (BlockCount > 0) {\r
+    Status = RdRandGetSeed128 (Seed);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+    CopyMem (Ptr, Seed, 16);\r
+\r
+    BlockCount--;\r
+    Ptr = Ptr + 16;\r
+  }\r
+\r
+  //\r
+  // Populate the remained data as request.\r
+  //\r
+  Status = RdRandGetSeed128 (Seed);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+  CopyMem (Ptr, Seed, (Length % 16));\r
+\r
+  return Status;\r
+}\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RdRand.h b/SecurityPkg/RandomNumberGenerator/RngDxe/RdRand.h
new file mode 100644 (file)
index 0000000..20fd9fb
--- /dev/null
@@ -0,0 +1,213 @@
+/** @file\r
+  Header for the RDRAND APIs used by RNG DXE driver.\r
+\r
+  Support API definitions for RDRAND instruction access, which will leverage\r
+  Intel Secure Key technology to provide high-quality random numbers for use\r
+  in applications, or entropy for seeding other random number generators.\r
+  Refer to http://software.intel.com/en-us/articles/intel-digital-random-number\r
+  -generator-drng-software-implementation-guide/ for more information about Intel\r
+  Secure Key technology.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef __RD_RAND_H__\r
+#define __RD_RAND_H__\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/TimerLib.h>\r
+#include <Protocol/Rng.h>\r
+\r
+//\r
+// The maximun number of retries to obtain one available random number. \r
+//\r
+#define RETRY_LIMIT    10\r
+\r
+/**\r
+  Determines whether or not RDRAND instruction is supported by the host hardware.\r
+\r
+  @retval EFI_SUCCESS          RDRAND instruction supported.\r
+  @retval EFI_UNSUPPORTED      RDRAND instruction not supported.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+IsRdRandSupported (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Generates a 16-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand16Step (\r
+  OUT UINT16       *Rand\r
+  );\r
+\r
+/**\r
+  Generates a 32-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand32Step (\r
+  OUT UINT32       *Rand\r
+  );\r
+\r
+/**\r
+  Generates a 64-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand64Step  (\r
+  OUT UINT64   *Rand\r
+  );\r
+\r
+/**\r
+  Calls RDRAND to obtain a 16-bit random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        RDRAND call was successful.\r
+  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRand16 (\r
+  OUT UINT16       *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  );\r
+\r
+/**\r
+  Calls RDRAND to obtain a 32-bit random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        RDRAND call was successful.\r
+  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRand32 (\r
+  OUT UINT32       *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  );\r
+\r
+/**\r
+  Calls RDRAND to obtain a 64-bit random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        RDRAND call was successful.\r
+  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRand64 (\r
+  OUT UINT64       *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  );\r
+  \r
+/**\r
+  Calls RDRAND to request a word-length random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random number.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        Random word generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random word.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandWord (\r
+  OUT UINTN        *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  );\r
+\r
+/**\r
+  Calls RDRAND to request multiple word-length random numbers.\r
+\r
+  @param[in]   Length        Size of the buffer, in words, to fill with.\r
+  @param[out]  RandBuffer    Pointer to the buffer to store the random result.\r
+\r
+  @retval EFI_SUCCESS        Random words generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random words.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGetWords (\r
+  IN UINTN         Length,\r
+  OUT UINTN        *RandBuffer\r
+  );\r
+\r
+/**\r
+  Calls RDRAND to fill a buffer of arbitrary size with random bytes.\r
+\r
+  @param[in]   Length        Size of the buffer, in bytes,  to fill with.\r
+  @param[out]  RandBuffer    Pointer to the buffer to store the random result.\r
+\r
+  @retval EFI_SUCCESS        Random bytes generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random bytes.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGetBytes (\r
+  IN UINTN         Length,\r
+  OUT UINT8        *RandBuffer\r
+  );\r
+\r
+/**\r
+  Generate high-quality entropy source through RDRAND.\r
+\r
+  @param[in]   Length        Size of the buffer, in bytes, to fill with.\r
+  @param[out]  Entropy       Pointer to the buffer to store the entropy data.\r
+\r
+  @retval EFI_SUCCESS        Entropy generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random data.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGenerateEntropy (\r
+  IN UINTN         Length,\r
+  OUT UINT8        *Entropy\r
+  );\r
+\r
+#endif  // __RD_RAND_H__
\ No newline at end of file
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c
new file mode 100644 (file)
index 0000000..98ef3b3
--- /dev/null
@@ -0,0 +1,219 @@
+/** @file  \r
+  RNG Driver to produce the UEFI Random Number Generator protocol.\r
+\r
+  The driver will use the new RDRAND instruction to produce high-quality, high-performance \r
+  entropy and random number.\r
+\r
+  RNG Algoritnms defined in UEFI 2.4:\r
+   - EFI_RNG_ALGORITHM_SP800_90_CTR_256_GUID  - Supported\r
+     (RDRAND implements a hardware NIST SP800-90 AES-CTR-256 based DRBG)\r
+   - EFI_RNG_ALGORITHM_RAW                    - Supported\r
+     (Structuring RDRAND invocation can be guaranteed as high-quality entropy source)\r
+   - EFI_RNG_ALGORITHM_SP800_90_HMAC_256_GUID - Unsupported\r
+   - EFI_RNG_ALGORITHM_SP800_90_HASH_256_GUID - Unsupported\r
+   - EFI_RNG_ALGORITHM_X9_31_3DES_GUID        - Unsupported\r
+   - EFI_RNG_ALGORITHM_X9_31_AES_GUID         - Unsupported\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "RdRand.h"\r
+\r
+//\r
+// Supported RNG Algorithms list by this driver.\r
+//\r
+EFI_RNG_ALGORITHM mSupportedRngAlgorithms[] = {\r
+  EFI_RNG_ALGORITHM_SP800_90_CTR_256_GUID,\r
+  EFI_RNG_ALGORITHM_RAW\r
+};\r
+\r
+/**\r
+  Returns information about the random number generation implementation.\r
+\r
+  @param[in]     This                 A pointer to the EFI_RNG_PROTOCOL instance.\r
+  @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList. \r
+                                      On output with a return code of EFI_SUCCESS, the size\r
+                                      in bytes of the data returned in RNGAlgorithmList. On output\r
+                                      with a return code of EFI_BUFFER_TOO_SMALL,\r
+                                      the size of RNGAlgorithmList required to obtain the list.\r
+  @param[out] RNGAlgorithmList        A caller-allocated memory buffer filled by the driver\r
+                                      with one EFI_RNG_ALGORITHM element for each supported\r
+                                      RNG algorithm. The list must not change across multiple\r
+                                      calls to the same driver. The first algorithm in the list\r
+                                      is the default algorithm for the driver.\r
+\r
+  @retval EFI_SUCCESS                 The RNG algorithm list was returned successfully.\r
+  @retval EFI_UNSUPPORTED             The services is not supported by this driver.\r
+  @retval EFI_DEVICE_ERROR            The list of algorithms could not be retrieved due to a\r
+                                      hardware or firmware error.\r
+  @retval EFI_INVALID_PARAMETER       One or more of the parameters are incorrect.\r
+  @retval EFI_BUFFER_TOO_SMALL        The buffer RNGAlgorithmList is too small to hold the result.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RngGetInfo (\r
+  IN EFI_RNG_PROTOCOL             *This,\r
+  IN OUT UINTN                    *RNGAlgorithmListSize,\r
+  OUT EFI_RNG_ALGORITHM           *RNGAlgorithmList\r
+  )\r
+{\r
+  EFI_STATUS    Status;\r
+  UINTN         RequiredSize;\r
+\r
+  if ((This == NULL) || (RNGAlgorithmListSize == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  RequiredSize = sizeof (mSupportedRngAlgorithms);\r
+  if (*RNGAlgorithmListSize < RequiredSize) {\r
+    Status = EFI_BUFFER_TOO_SMALL;\r
+  } else {\r
+    //\r
+    // Return algorithm list supported by driver.\r
+    //\r
+    if (RNGAlgorithmList != NULL) {\r
+      CopyMem (RNGAlgorithmList, mSupportedRngAlgorithms, RequiredSize);\r
+      Status = EFI_SUCCESS;\r
+    } else {\r
+      Status = EFI_INVALID_PARAMETER;\r
+    }\r
+  }\r
+  *RNGAlgorithmListSize = RequiredSize;\r
+  \r
+  return Status;\r
+}\r
+\r
+/**\r
+  Produces and returns an RNG value using either the default or specified RNG algorithm.\r
+\r
+  @param[in]  This                    A pointer to the EFI_RNG_PROTOCOL instance.\r
+  @param[in]  RNGAlgorithm            A pointer to the EFI_RNG_ALGORITHM that identifies the RNG\r
+                                      algorithm to use. May be NULL in which case the function will\r
+                                      use its default RNG algorithm.\r
+  @param[in]  RNGValueLength          The length in bytes of the memory buffer pointed to by\r
+                                      RNGValue. The driver shall return exactly this numbers of bytes.\r
+  @param[out] RNGValue                A caller-allocated memory buffer filled by the driver with the\r
+                                      resulting RNG value.\r
+\r
+  @retval EFI_SUCCESS                 The RNG value was returned successfully.\r
+  @retval EFI_UNSUPPORTED             The algorithm specified by RNGAlgorithm is not supported by\r
+                                      this driver.\r
+  @retval EFI_DEVICE_ERROR            An RNG value could not be retrieved due to a hardware or\r
+                                      firmware error.\r
+  @retval EFI_NOT_READY               There is not enough random data available to satisfy the length\r
+                                      requested by RNGValueLength.\r
+  @retval EFI_INVALID_PARAMETER       RNGValue is NULL or RNGValueLength is zero.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RngGetRNG (\r
+  IN EFI_RNG_PROTOCOL            *This,\r
+  IN EFI_RNG_ALGORITHM           *RNGAlgorithm, OPTIONAL\r
+  IN UINTN                       RNGValueLength,\r
+  OUT UINT8                      *RNGValue\r
+  )\r
+{\r
+  EFI_STATUS    Status;\r
+\r
+  if ((RNGValueLength == 0) || (RNGValue == NULL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Status = EFI_UNSUPPORTED;\r
+  if (RNGAlgorithm == NULL) {\r
+    //\r
+    // Use the default RNG algorithm if RNGAlgorithm is NULL.\r
+    //\r
+    RNGAlgorithm = &gEfiRngAlgorithmSp80090Ctr256Guid;\r
+  }\r
+\r
+  //\r
+  // NIST SP800-90-AES-CTR-256 supported by RDRAND\r
+  //\r
+  if (CompareGuid (RNGAlgorithm, &gEfiRngAlgorithmSp80090Ctr256Guid)) {\r
+    Status = RdRandGetBytes (RNGValueLength, RNGValue);\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // The "raw" algorithm is intended to provide entropy directly\r
+  //\r
+  if (CompareGuid (RNGAlgorithm, &gEfiRngAlgorithmRaw)) {\r
+    //\r
+    // When a DRBG is used on the output of a entropy source, \r
+    // its security level must be at least 256 bits according to UEFI Spec.\r
+    //\r
+    if (RNGValueLength < 32) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+    \r
+    Status = RdRandGenerateEntropy (RNGValueLength, RNGValue);\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Other algorithms were unsupported by this driver.\r
+  //\r
+  return Status;\r
+}\r
+\r
+//\r
+// The Random Number Generator (RNG) protocol\r
+//\r
+EFI_RNG_PROTOCOL mRngRdRand = {\r
+  RngGetInfo,\r
+  RngGetRNG\r
+};\r
+\r
+/**\r
+  The user Entry Point for the Random Number Generator (RNG) driver.\r
+\r
+  @param[in] ImageHandle    The firmware allocated handle for the EFI image.\r
+  @param[in] SystemTable    A pointer to the EFI System Table.\r
+\r
+  @retval EFI_SUCCESS       The entry point is executed successfully.\r
+  @retval EFI_NOT_SUPPORTED Platform does not support RNG.\r
+  @retval Other             Some error occurs when executing this entry point.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RngDriverEntry (\r
+  IN EFI_HANDLE          ImageHandle,\r
+  IN EFI_SYSTEM_TABLE    *SystemTable\r
+  )\r
+{\r
+  EFI_STATUS    Status;\r
+  EFI_HANDLE    Handle;\r
+\r
+  //\r
+  // Verify RdRand support on Platform.\r
+  //\r
+  Status = IsRdRandSupported ();\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Install UEFI RNG (Random Number Generator) Protocol\r
+  //\r
+  Handle = NULL;\r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
+                  &Handle,\r
+                  &gEfiRngProtocolGuid,\r
+                  &mRngRdRand,\r
+                  NULL\r
+                  );\r
+  \r
+  return Status;\r
+}\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.inf b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.inf
new file mode 100644 (file)
index 0000000..c84ab36
--- /dev/null
@@ -0,0 +1,75 @@
+## @file\r
+#  Module that produces the UEFI Random Number Generator protocol.\r
+#\r
+#  This module will leverage Intel Secure Key technology to produce the Random\r
+#  Number Generator protocol, which is used to provide high-quality random numbers\r
+#  for use in applications, or entropy for seeding other random number generators.\r
+#  Refer to http://software.intel.com/en-us/articles/intel-digital-random-number\r
+#  -generator-drng-software-implementation-guide/ for more information about Intel\r
+#  Secure Key technology.\r
+#\r
+#  Copyright (c) 2013, 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
+#  http://opensource.org/licenses/bsd-license.php\r
+#\r
+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+#\r
+##\r
+\r
+[Defines]\r
+  INF_VERSION                    = 0x00010005\r
+  BASE_NAME                      = RngDxe\r
+  FILE_GUID                      = B981A835-6EE8-4f4c-AE0B-210AA0BFBF01\r
+  MODULE_TYPE                    = DXE_DRIVER\r
+  VERSION_STRING                 = 1.0\r
+  ENTRY_POINT                    = RngDriverEntry\r
+\r
+#\r
+# The following information is for reference only and not required by the build tools.\r
+#\r
+#  VALID_ARCHITECTURES           = IA32 X64\r
+#\r
+\r
+[Sources.common]\r
+  RngDxe.c\r
+  RdRand.c\r
+  AesCore.c\r
+\r
+[Sources.IA32]\r
+  IA32/RdRandWord.c\r
+  IA32/AsmRdRand.asm        | MSFT\r
+  IA32/GccRdRand.c          | GCC\r
+\r
+[Sources.X64]\r
+  X64/RdRandWord.c\r
+  X64/AsmRdRand.asm         | MSFT\r
+  X64/GccRdRand.c           | GCC\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+  SecurityPkg/SecurityPkg.dec\r
+\r
+[LibraryClasses]\r
+  UefiLib\r
+  UefiBootServicesTableLib\r
+  BaseLib\r
+  DebugLib     \r
+  UefiDriverEntryPoint\r
+  TimerLib\r
+\r
+[Guids]\r
+  gEfiRngAlgorithmSp80090Hash256Guid\r
+  gEfiRngAlgorithmSp80090Hmac256Guid\r
+  gEfiRngAlgorithmSp80090Ctr256Guid\r
+  gEfiRngAlgorithmX9313DesGuid\r
+  gEfiRngAlgorithmX931AesGuid\r
+  gEfiRngAlgorithmRaw\r
+\r
+[Protocols]\r
+  gEfiRngProtocolGuid             ## PRODUCES\r
+\r
+[Depex]\r
+  TRUE\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/X64/AsmRdRand.asm b/SecurityPkg/RandomNumberGenerator/RngDxe/X64/AsmRdRand.asm
new file mode 100644 (file)
index 0000000..8a4fe65
--- /dev/null
@@ -0,0 +1,83 @@
+;------------------------------------------------------------------------------\r
+;\r
+; Copyright (c) 2013, 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
+; http://opensource.org/licenses/bsd-license.php.\r
+;\r
+; THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+; WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+;\r
+; Module Name:\r
+;\r
+;   AsmRdRand.Asm\r
+;\r
+; Abstract:\r
+;\r
+;   Implementation for 16-, 32-, and 64-bit invocations of RDRAND instruction under 64bit platform.\r
+;\r
+; Notes:\r
+;\r
+;   Visual Studio coding practices do not use inline asm since multiple compilers and \r
+;   architectures are supported assembler not recognizing rdrand instruction so using DB's.\r
+;\r
+;------------------------------------------------------------------------------\r
+\r
+    .code\r
\r
+;------------------------------------------------------------------------------\r
+;  Generate a 16 bit random number\r
+;  Return TRUE if Rand generated successfully, or FALSE if not\r
+;\r
+;  BOOLEAN EFIAPI RdRand16Step (UINT16 *Rand);   RCX\r
+;------------------------------------------------------------------------------\r
+RdRand16Step  PROC\r
+    ; rdrand   ax                  ; generate a 16 bit RN into ax, CF=1 if RN generated ok, otherwise CF=0\r
+    db     0fh, 0c7h, 0f0h         ; rdrand r16:  "0f c7 /6  ModRM:r/m(w)"\r
+    jb     rn16_ok                 ; jmp if CF=1\r
+    xor    rax, rax                ; reg=0 if CF=0\r
+    ret                            ; return with failure status\r
+rn16_ok:\r
+    mov    [rcx], ax\r
+    mov    rax, 1\r
+    ret\r
+RdRand16Step ENDP\r
+\r
+;------------------------------------------------------------------------------\r
+;  Generate a 32 bit random number\r
+;    Return TRUE if Rand generated successfully, or FALSE if not\r
+;\r
+;  BOOLEAN EFIAPI RdRand32Step (UINT32 *Rand);   RCX\r
+;------------------------------------------------------------------------------\r
+RdRand32Step  PROC\r
+    ; rdrand   eax                 ; generate a 32 bit RN into eax, CF=1 if RN generated ok, otherwise CF=0\r
+    db     0fh, 0c7h, 0f0h         ; rdrand r32:  "0f c7 /6  ModRM:r/m(w)"\r
+    jb     rn32_ok                 ; jmp if CF=1\r
+    xor    rax, rax                ; reg=0 if CF=0\r
+    ret                            ; return with failure status\r
+rn32_ok:\r
+    mov    [rcx], eax\r
+    mov    rax,  1\r
+    ret\r
+RdRand32Step ENDP\r
+\r
+;------------------------------------------------------------------------------\r
+;  Generate a 64 bit random number\r
+;    Return TRUE if RN generated successfully, or FALSE if not\r
+;\r
+;  BOOLEAN EFIAPI RdRand64Step (UINT64 *Random);   RCX\r
+;------------------------------------------------------------------------------\r
+RdRand64Step  PROC\r
+    ; rdrand   rax                 ; generate a 64 bit RN into rax, CF=1 if RN generated ok, otherwise CF=0\r
+    db     048h, 0fh, 0c7h, 0f0h   ; rdrand r64: "REX.W + 0F C7 /6 ModRM:r/m(w)" \r
+    jb     rn64_ok                 ; jmp if CF=1\r
+    xor    rax, rax                ; reg=0 if CF=0\r
+    ret                            ; return with failure status\r
+rn64_ok:\r
+    mov    [rcx], rax\r
+    mov    rax, 1\r
+    ret\r
+RdRand64Step ENDP\r
+\r
+    END\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/X64/GccRdRand.c b/SecurityPkg/RandomNumberGenerator/RngDxe/X64/GccRdRand.c
new file mode 100644 (file)
index 0000000..d28336d
--- /dev/null
@@ -0,0 +1,95 @@
+/** @file\r
+  RDRAND Support Routines for GCC environment.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+/**\r
+  Generates a 16-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand16Step (\r
+  OUT UINT16       *Rand\r
+  )\r
+{\r
+  UINT8  Carry;\r
+\r
+  //\r
+  // Uses byte code for RDRAND instruction,\r
+  // in case that GCC version has no direct support on RDRAND assembly.\r
+  //\r
+  __asm__ __volatile__ (\r
+    ".byte 0x66; .byte 0x0f; .byte 0xc7; .byte 0xf0; setc %1"\r
+    :"=a"  (*Rand),\r
+     "=qm" (Carry)\r
+    ); \r
+\r
+  return (BOOLEAN) Carry;\r
+}\r
+\r
+/**\r
+  Generates a 32-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand32Step (\r
+  OUT UINT32       *Rand\r
+  )\r
+{\r
+  UINT8  Carry;\r
+\r
+  __asm__ __volatile__ (\r
+    ".byte 0x0f; .byte 0xc7; .byte 0xf0; setc %1"\r
+    :"=a"  (*Rand), \r
+     "=qm" (Carry)\r
+    );\r
+\r
+  return (BOOLEAN) Carry;\r
+}\r
+\r
+/**\r
+  Generates a 64-bit random number through RDRAND instruction.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random result.\r
+\r
+  @retval TRUE               RDRAND call was successful.\r
+  @retval FALSE              Failed attempts to call RDRAND.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RdRand64Step  (\r
+  OUT UINT64   *Rand\r
+  )\r
+{\r
+  UINT8  Carry;\r
+\r
+  __asm__ __volatile__ (\r
+    ".byte 0x48; .byte 0x0f; .byte 0xc7; .byte 0xf0; setc %1"\r
+    :"=a"  (*Rand), \r
+     "=qm" (Carry)\r
+    );\r
+  \r
+  return (BOOLEAN) Carry;\r
+}\r
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/X64/RdRandWord.c b/SecurityPkg/RandomNumberGenerator/RngDxe/X64/RdRandWord.c
new file mode 100644 (file)
index 0000000..946e5ba
--- /dev/null
@@ -0,0 +1,70 @@
+/** @file\r
+  RDRAND Support Routines.\r
+\r
+Copyright (c) 2013, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "RdRand.h"\r
+\r
+/**\r
+  Calls RDRAND to request a word-length random number.\r
+\r
+  @param[out]  Rand          Buffer pointer to store the random number.\r
+  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
+\r
+  @retval EFI_SUCCESS        Random word generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random word.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandWord (\r
+  OUT UINTN        *Rand,\r
+  IN BOOLEAN       NeedRetry\r
+  )\r
+{\r
+  return RdRand64 (Rand, NeedRetry);\r
+}\r
+\r
+/**\r
+  Calls RDRAND to request multiple word-length random numbers.\r
+\r
+  @param[in]   Length        Size of the buffer, in words, to fill with.\r
+  @param[out]  RandBuffer    Pointer to the buffer to store the random result.\r
+\r
+  @retval EFI_SUCCESS        Random words generation succeeded.\r
+  @retval EFI_NOT_READY      Failed to request random words.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RdRandGetWords (\r
+  IN UINTN         Length,\r
+  OUT UINTN        *RandBuffer\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  UINT32      Index;\r
+\r
+  for (Index = 0; Index < Length; Index++) {\r
+    //\r
+    // Obtain one word-length (64-bit) Random Number with possible retry-loop.\r
+    //\r
+    Status = RdRand64 (RandBuffer, TRUE);\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+    \r
+    RandBuffer++;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}
\ No newline at end of file
index ebe65b8..0dba0f1 100644 (file)
   # Application\r
   #\r
   SecurityPkg/Application/VariableInfo/VariableInfo.inf\r
+  SecurityPkg/Application/RngTest/RngTest.inf\r
 \r
   #\r
   # TPM\r
   SecurityPkg/VariableAuthenticated/RuntimeDxe/VariableSmmRuntimeDxe.inf\r
   SecurityPkg/Tcg/TcgSmm/TcgSmm.inf\r
   SecurityPkg/Tcg/TrEESmm/TrEESmm.inf\r
+  #\r
+  # Random Number Generator\r
+  #\r
+  SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.inf\r
 \r
 [Components.IPF]\r
   SecurityPkg/VariableAuthenticated/EsalVariableDxeSal/EsalVariableDxeSal.inf \r