From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f41.google.com (mail-pj1-f41.google.com [209.85.216.41]) by mx.groups.io with SMTP id smtpd.web12.3267.1597347885885337841 for ; Thu, 13 Aug 2020 12:44:45 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20161025 header.b=CEs2giJc; spf=pass (domain: gmail.com, ip: 209.85.216.41, mailfrom: matthewfcarlson@gmail.com) Received: by mail-pj1-f41.google.com with SMTP id kr4so3267094pjb.2 for ; Thu, 13 Aug 2020 12:44:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=9mCpx524HH/PmclT/8kczyn4cGBIJc0of/iisPPfQGA=; b=CEs2giJc70y7gPpwpft/02GnK47aCMormZRK/Qz/owZfSlF7ZFgShGLYOkgr/3V7Cn O8hwH27osnCY5qjgGFQNCepTLYH79TUXMuXU19JRXZulV3PWXKLRSYmdmSFcnxP6U1Uo 43Fwff9gF91uRX8lDm15r6/UyXKe8COoSabS9a+ex+RAHCpiy6PKHxT7G5zRbx5VQQLI /za9Vqszsz3rthwZbQoqPWW1IxhNmMMOKaI0haiF4heobscim1Hl0fUpm54vxkOupARz Qq9TGGI+S21HZyXoIkWXixZOgRAEbQEx2eCs+AYXlOf3ZeoIMK0WJKVuJ4kj4+yvjlNL hSqQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=9mCpx524HH/PmclT/8kczyn4cGBIJc0of/iisPPfQGA=; b=RGjbgVvz3dbGxbjQBBWBndajd/VJNkyhjBIwvHQ7TUEHAZzEBY6CsWDEV7zFVedGWi 0ILoONlxW2hZz5cki6lmaQ72kS0bli664Q5bTnc9O0lo/AO7DWjhXsjZ21oIu+TudEl+ +SZzc08K3y6Bi1lPASAts/XLQbgJzsmnV3fko43qXqz17/MAGWL5ughRx0HNqGH8iJYO VC4sGOe7WxkRIOHZhXcwTXX3jPNaA+Oh2y6MWFgNYPqEaY/csvLHfeZDA1q7qUrG4fVJ pKimMqf51H/PZzSCoLTWYiDXcGGRoSEKn9ZGtasggz2ZiqgCriLYm0ZSLwUWF5vXv2VO kl6Q== X-Gm-Message-State: AOAM531DF/d6zu2vGT6j0kq+zsIOfM1l6hfP9j99kcmVs0MMdrtqBH/R e5q7FeWyblmuJ7oNukzr+girDXWqcJ6oHA== X-Google-Smtp-Source: ABdhPJyaV5Ac3wSIMLY5YZUhig5DxT+3Mfb/XgzQewdMk5090TFEXrHVfxx5FU9FtnjCTm7gDT0HnQ== X-Received: by 2002:a17:90a:bc44:: with SMTP id t4mr6422080pjv.182.1597347885174; Thu, 13 Aug 2020 12:44:45 -0700 (PDT) Return-Path: Received: from tvis-name-05.localdomain ([50.34.40.129]) by smtp.gmail.com with ESMTPSA id c15sm6708851pfo.115.2020.08.13.12.44.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Aug 2020 12:44:44 -0700 (PDT) From: "Matthew Carlson" To: devel@edk2.groups.io Cc: Ard Biesheuvel , Michael D Kinney , Liming Gao , Zhiguang Liu , Matthew Carlson Subject: [PATCH v7 2/5] MdePkg: BaseRngLibDxe: Add RngLib that uses RngDxe Date: Thu, 13 Aug 2020 12:44:38 -0700 Message-Id: <20200813194441.892-3-matthewfcarlson@gmail.com> X-Mailer: git-send-email 2.27.0.windows.1 In-Reply-To: <20200813194441.892-1-matthewfcarlson@gmail.com> References: <20200813194441.892-1-matthewfcarlson@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Matthew Carlson This adds a RngLib that uses the RngProtocol to provide randomness. This means that the RngLib is meant to be used with DXE_DRIVERS. Ref: https://github.com/tianocore/edk2/pull/845 Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3D1871 Cc: Ard Biesheuvel Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Signed-off-by: Matthew Carlson --- MdePkg/Library/DxeRngLib/DxeRngLib.c | 206 ++++++++++++++++++++ MdePkg/Library/DxeRngLib/DxeRngLib.inf | 37 ++++ MdePkg/MdePkg.dsc | 4 +- 3 files changed, 246 insertions(+), 1 deletion(-) diff --git a/MdePkg/Library/DxeRngLib/DxeRngLib.c b/MdePkg/Library/DxeRngLi= b/DxeRngLib.c new file mode 100644 index 000000000000..0bd6585357b5 --- /dev/null +++ b/MdePkg/Library/DxeRngLib/DxeRngLib.c @@ -0,0 +1,206 @@ +/** @file=0D + Provides an implementation of the library class RngLib that uses the Rng = protocol.=0D +=0D + Copyright (c) Microsoft Corporation. All rights reserved.=0D + SPDX-License-Identifier: BSD-2-Clause-Patent=0D +=0D +**/=0D +#include =0D +#include =0D +#include =0D +#include =0D +#include =0D +=0D +/**=0D +Routine Description:=0D +=0D + Generates a random number via the NIST=0D + 800-9A algorithm. Refer to=0D + http://csrc.nist.gov/groups/STM/cavp/documents/drbg/DRBGVS.pdf=0D + for more information.=0D +=0D + Arguments:=0D +=0D + Buffer -- Buffer to receive the random number.=0D + BufferSize -- Number of bytes in Buffer.=0D +=0D +Return Value:=0D +=0D + EFI_SUCCESS or underlying failure code.=0D +=0D +**/=0D +STATIC=0D +EFI_STATUS=0D +GenerateRandomNumberViaNist800Algorithm (=0D + OUT UINT8 *Buffer,=0D + IN UINTN BufferSize=0D + )=0D +{=0D + EFI_STATUS Status;=0D + EFI_RNG_PROTOCOL *RngProtocol;=0D +=0D + RngProtocol =3D NULL;=0D +=0D + if (Buffer =3D=3D NULL) {=0D + DEBUG((DEBUG_ERROR, "[%a] Buffer =3D=3D NULL.\n", __FUNCTION__));=0D + return EFI_INVALID_PARAMETER;=0D + }=0D +=0D + Status =3D gBS->LocateProtocol (&gEfiRngProtocolGuid, NULL, (VOID **)&Rn= gProtocol);=0D + if (EFI_ERROR (Status) || RngProtocol =3D=3D NULL) {=0D + DEBUG((DEBUG_ERROR, "%a: Could not locate RNG prototocol, Status =3D= %r\n", __FUNCTION__, Status));=0D + return Status;=0D + }=0D +=0D + Status =3D RngProtocol->GetRNG (RngProtocol, &gEfiRngAlgorithmSp80090Ctr= 256Guid, BufferSize, Buffer);=0D + DEBUG((DEBUG_INFO, "%a: GetRNG algorithm CTR-256 - Status =3D %r\n", __F= UNCTION__, Status));=0D + if(!EFI_ERROR(Status)) {=0D + return Status;=0D + }=0D +=0D + Status =3D RngProtocol->GetRNG (RngProtocol, &gEfiRngAlgorithmSp80090Hma= c256Guid, BufferSize, Buffer);=0D + DEBUG((DEBUG_INFO, "%a: GetRNG algorithm HMAC-256 - Status =3D %r\n", __= FUNCTION__, Status));=0D + if(!EFI_ERROR(Status)) {=0D + return Status;=0D + }=0D +=0D + Status =3D RngProtocol->GetRNG (RngProtocol, &gEfiRngAlgorithmSp80090Has= h256Guid, BufferSize, Buffer);=0D + DEBUG((DEBUG_INFO, "%a: GetRNG algorithm Hash-256 - Status =3D %r\n", __= FUNCTION__, Status));=0D + if (!EFI_ERROR(Status)) {=0D + return Status;=0D + }=0D + // If all the other methods have failed, use the default method from the= RngProtocol=0D + Status =3D RngProtocol->GetRNG (RngProtocol, NULL, BufferSize, Buffer);= =0D + DEBUG((DEBUG_INFO, "%a: GetRNG algorithm Hash-256 - Status =3D %r\n", __= FUNCTION__, Status));=0D + if (!EFI_ERROR(Status)) {=0D + return Status;=0D + }=0D + // If we get to this point, we have failed=0D + DEBUG((DEBUG_ERROR, "%a: GetRNG() failed, staus =3D %r\n", __FUNCTION__,= Status));=0D +=0D + return Status;=0D +}// GenerateRandomNumberViaNist800Algorithm()=0D +=0D +=0D +/**=0D + Generates a 16-bit random number.=0D +=0D + if Rand is NULL, return FALSE.=0D +=0D + @param[out] Rand Buffer pointer to store the 16-bit random value.=0D +=0D + @retval TRUE Random number generated successfully.=0D + @retval FALSE Failed to generate the random number.=0D +=0D +**/=0D +BOOLEAN=0D +EFIAPI=0D +GetRandomNumber16 (=0D + OUT UINT16 *Rand=0D + )=0D +{=0D + EFI_STATUS Status;=0D +=0D + if (Rand =3D=3D NULL)=0D + {=0D + return FALSE;=0D + }=0D +=0D + Status =3D GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, 2);=0D + if (EFI_ERROR (Status))=0D + {=0D + return FALSE;=0D + }=0D + return TRUE;=0D +}=0D +=0D +/**=0D + Generates a 32-bit random number.=0D +=0D + if Rand is NULL, return FALSE.=0D +=0D + @param[out] Rand Buffer pointer to store the 32-bit random value.=0D +=0D + @retval TRUE Random number generated successfully.=0D + @retval FALSE Failed to generate the random number.=0D +=0D +**/=0D +BOOLEAN=0D +EFIAPI=0D +GetRandomNumber32 (=0D + OUT UINT32 *Rand=0D + )=0D +{=0D + EFI_STATUS Status;=0D +=0D + if (Rand =3D=3D NULL) {=0D + return FALSE;=0D + }=0D +=0D + Status =3D GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, 4);=0D + if (EFI_ERROR (Status)) {=0D + return FALSE;=0D + }=0D + return TRUE;=0D +}=0D +=0D +/**=0D + Generates a 64-bit random number.=0D +=0D + if Rand is NULL, return FALSE.=0D +=0D + @param[out] Rand Buffer pointer to store the 64-bit random value.=0D +=0D + @retval TRUE Random number generated successfully.=0D + @retval FALSE Failed to generate the random number.=0D +=0D +**/=0D +BOOLEAN=0D +EFIAPI=0D +GetRandomNumber64 (=0D + OUT UINT64 *Rand=0D + )=0D +{=0D + EFI_STATUS Status;=0D +=0D + if (Rand =3D=3D NULL)=0D + {=0D + return FALSE;=0D + }=0D +=0D + Status =3D GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, 8);=0D + if (EFI_ERROR (Status)) {=0D + return FALSE;=0D + }=0D + return TRUE;=0D +}=0D +=0D +/**=0D + Generates a 128-bit random number.=0D +=0D + if Rand is NULL, return FALSE.=0D +=0D + @param[out] Rand Buffer pointer to store the 128-bit random value.=0D +=0D + @retval TRUE Random number generated successfully.=0D + @retval FALSE Failed to generate the random number.=0D +=0D +**/=0D +BOOLEAN=0D +EFIAPI=0D +GetRandomNumber128 (=0D + OUT UINT64 *Rand=0D + )=0D +{=0D + EFI_STATUS Status;=0D +=0D + if (Rand =3D=3D NULL) {=0D + return FALSE;=0D + }=0D +=0D + Status =3D GenerateRandomNumberViaNist800Algorithm ((UINT8 *)Rand, 16);= =0D + if (EFI_ERROR (Status)) {=0D + return FALSE;=0D + }=0D + return TRUE;=0D +}=0D diff --git a/MdePkg/Library/DxeRngLib/DxeRngLib.inf b/MdePkg/Library/DxeRng= Lib/DxeRngLib.inf new file mode 100644 index 000000000000..d0dc381c20c3 --- /dev/null +++ b/MdePkg/Library/DxeRngLib/DxeRngLib.inf @@ -0,0 +1,37 @@ +# @file=0D +# Provides implementation of the library class RngLib that uses the RngPro= tocol=0D +#=0D +# @copyright=0D +# Copyright (c) Microsoft Corporation. All rights reserved.=0D +# SPDX-License-Identifier: BSD-2-Clause-Patent=0D +#=0D +##=0D +=0D +[Defines]=0D + INF_VERSION =3D 0x00010017=0D + BASE_NAME =3D DxeRngLib=0D + FILE_GUID =3D FF9F84C5-A33E-44E3-9BB5-0D654B2D4149=0D + MODULE_TYPE =3D DXE_DRIVER=0D + VERSION_STRING =3D 1.0=0D + LIBRARY_CLASS =3D RngLib|DXE_DRIVER UEFI_APPLICATION UEFI_DRIVER=0D +=0D +[Packages]=0D + MdePkg/MdePkg.dec=0D +=0D +[Sources]=0D + DxeRngLib.c=0D +=0D +[LibraryClasses]=0D + DebugLib=0D + UefiBootServicesTableLib=0D +=0D +[Protocols]=0D + gEfiRngProtocolGuid ## CONSUMES=0D +=0D +[Depex]=0D + gEfiRngProtocolGuid=0D +=0D +[Guids]=0D + gEfiRngAlgorithmSp80090Ctr256Guid=0D + gEfiRngAlgorithmSp80090Hash256Guid=0D + gEfiRngAlgorithmSp80090Hmac256Guid=0D diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc index d7ba3a730909..2c3b7966b086 100644 --- a/MdePkg/MdePkg.dsc +++ b/MdePkg/MdePkg.dsc @@ -62,8 +62,10 @@ MdePkg/Library/BasePostCodeLibPort80/BasePostCodeLibPort80.inf=0D MdePkg/Library/BasePrintLib/BasePrintLib.inf=0D MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull.i= nf=0D - MdePkg/Library/BaseRngLibTimerLib/BaseRngLibTimerLib.inf=0D + MdePkg/Library/DxeRngLib/DxeRngLib.inf=0D MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf=0D + MdePkg/Library/BaseRngLibTimerLib/BaseRngLibTimerLib.inf=0D +=0D MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.inf=0D MdePkg/Library/BaseSynchronizationLib/BaseSynchronizationLib.inf=0D MdePkg/Library/BaseTimerLibNullTemplate/BaseTimerLibNullTemplate.inf=0D --=20 2.27.0.windows.1