MdePkg: Apply uncrustify changes

[mirror_edk2.git] / MdePkg / Library / DxeRngLib / DxeRngLib.c

/** @file\r
 Provides an implementation of the library class RngLib that uses the Rng protocol.\r
\r
 Copyright (c) Microsoft Corporation. All rights reserved.\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#include <Uefi.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/RngLib.h>\r
#include <Protocol/Rng.h>\r
\r
/**\r
  Routine Description:\r
\r
  Generates a random number via the NIST\r
  800-9A algorithm.  Refer to\r
  http://csrc.nist.gov/groups/STM/cavp/documents/drbg/DRBGVS.pdf\r
  for more information.\r
\r
  @param[out] Buffer      Buffer to receive the random number.\r
  @param[in]  BufferSize  Number of bytes in Buffer.\r
\r
  @retval EFI_SUCCESS or underlying failure code.\r
**/\r
STATIC\r
EFI_STATUS\r
GenerateRandomNumberViaNist800Algorithm (\r
  OUT UINT8  *Buffer,\r
  IN  UINTN  BufferSize\r
  )\r
{\r
  EFI_STATUS        Status;\r
  EFI_RNG_PROTOCOL  *RngProtocol;\r
\r
  RngProtocol = NULL;\r
\r
  if (Buffer == NULL) {\r
    DEBUG ((DEBUG_ERROR, "%a: Buffer == NULL.\n", __FUNCTION__));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = gBS->LocateProtocol (&gEfiRngProtocolGuid, NULL, (VOID **)&RngProtocol);\r
  if (EFI_ERROR (Status) || (RngProtocol == NULL)) {\r
    DEBUG ((DEBUG_ERROR, "%a: Could not locate RNG prototocol, Status = %r\n", __FUNCTION__, Status));\r
    return Status;\r
  }\r
\r
  Status = RngProtocol->GetRNG (RngProtocol, &gEfiRngAlgorithmSp80090Ctr256Guid, BufferSize, Buffer);\r
  DEBUG ((DEBUG_INFO, "%a: GetRNG algorithm CTR-256 - Status = %r\n", __FUNCTION__, Status));\r
  if (!EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = RngProtocol->GetRNG (RngProtocol, &gEfiRngAlgorithmSp80090Hmac256Guid, BufferSize, Buffer);\r
  DEBUG ((DEBUG_INFO, "%a: GetRNG algorithm HMAC-256 - Status = %r\n", __FUNCTION__, Status));\r
  if (!EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = RngProtocol->GetRNG (RngProtocol, &gEfiRngAlgorithmSp80090Hash256Guid, BufferSize, Buffer);\r
  DEBUG ((DEBUG_INFO, "%a: GetRNG algorithm Hash-256 - Status = %r\n", __FUNCTION__, Status));\r
  if (!EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // If all the other methods have failed, use the default method from the RngProtocol\r
  Status = RngProtocol->GetRNG (RngProtocol, NULL, BufferSize, Buffer);\r
  DEBUG ((DEBUG_INFO, "%a: GetRNG algorithm Hash-256 - Status = %r\n", __FUNCTION__, Status));\r
  if (!EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  // If we get to this point, we have failed\r
  DEBUG ((DEBUG_ERROR, "%a: GetRNG() failed, staus = %r\n", __FUNCTION__, Status));\r
\r
  return Status;\r
}// GenerateRandomNumberViaNist800Algorithm()\r
\r
/**\r
  Generates a 16-bit random number.\r
\r
  if Rand is NULL, return FALSE.\r
\r
  @param[out] Rand     Buffer pointer to store the 16-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber16 (\r
  OUT UINT16  *Rand\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if (Rand == NULL) {\r
    return FALSE;\r
  }\r
\r
  Status = GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, sizeof (UINT16));\r
  if (EFI_ERROR (Status)) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Generates a 32-bit random number.\r
\r
  if Rand is NULL, return FALSE.\r
\r
  @param[out] Rand     Buffer pointer to store the 32-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber32 (\r
  OUT UINT32  *Rand\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if (Rand == NULL) {\r
    return FALSE;\r
  }\r
\r
  Status = GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, sizeof (UINT32));\r
  if (EFI_ERROR (Status)) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Generates a 64-bit random number.\r
\r
  if Rand is NULL, return FALSE.\r
\r
  @param[out] Rand     Buffer pointer to store the 64-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber64 (\r
  OUT UINT64  *Rand\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if (Rand == NULL) {\r
    return FALSE;\r
  }\r
\r
  Status = GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, sizeof (UINT64));\r
  if (EFI_ERROR (Status)) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Generates a 128-bit random number.\r
\r
  if Rand is NULL, return FALSE.\r
\r
  @param[out] Rand     Buffer pointer to store the 128-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber128 (\r
  OUT UINT64  *Rand\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if (Rand == NULL) {\r
    return FALSE;\r
  }\r
\r
  Status = GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, 2 * sizeof (UINT64));\r
  if (EFI_ERROR (Status)) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r