From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pg1-f169.google.com (mail-pg1-f169.google.com [209.85.215.169]) by mx.groups.io with SMTP id smtpd.web10.1324.1597272223366086929 for ; Wed, 12 Aug 2020 15:43:43 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20161025 header.b=O0A98dDT; spf=pass (domain: gmail.com, ip: 209.85.215.169, mailfrom: matthewfcarlson@gmail.com) Received: by mail-pg1-f169.google.com with SMTP id 128so1787569pgd.5 for ; Wed, 12 Aug 2020 15:43:43 -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=79qSTF+DDwXfXZsAJ3rYOr3lD6bBvGl7pEUAd275AY0=; b=O0A98dDTq41clMColNBukp66m5Jc94+kYbX8gm1Vweri+yJ73UUNsv2JSRhBN+s40M lmH/zd8Rtx1eIm5V6INMy3LGXQqkymx+8eB+2nP20oTGf+Ii74Zrsc9BeDlJjBNHo5W2 vwb/Vl6DF/FioiXHkijmKCKIpmpcjCHc1APiU80fvOStGIzWWIdU2itBAlbPieCPvIlJ qUE8rDa0sF4pL2t5aY/4nmscpi9sb+8yFhJ2ycjGkZBsPIL/xrN3CLg2DNOdnZFfbVYf MaG2ep6UoSa1lGkzU2aKuJN3z6DvNBjpS2c4p2y8AcjGwzo7w0jhfRN5PsfoM6zHEnRZ vaAA== 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=79qSTF+DDwXfXZsAJ3rYOr3lD6bBvGl7pEUAd275AY0=; b=s8eP0ji1hesLY1pX9tKzJD166xOAEp1LnmT/9x8Iee4dCijKe6gQp6h0ySFvrO4iKB ekLIlrffWIERm9zXJMFbLR93+qjLjsoMupD5HPmiSRseOgvKpoiv74pGi3/c0sjX5ANR 7FPzFekFsBjhc9Zysnm7MQFDFqP+KY1HJlbdHEq8HfnMLn/7aqHT4QRwjOvMMCAoFjDa 67QBb3SdJIYltZVc71WLif79WLLMMv4j5bcn0tsAYgLqB8PGagK0qX9ReM2l/FtZQsG+ Our5itQTLY+nBPNjqLK1OOvf6XwNinESkG8cUw230Rcx+eXIJ85+hm7LFqeaxRixzrnt UAFA== X-Gm-Message-State: AOAM531xGqB7lcmpuJ2llxv1ybdESpvaKoLTE5+pnxDKMnGcxkbjb4ko N6bgv+r7klFMVkTPfXwgbiqja3h8vnDG4w== X-Google-Smtp-Source: ABdhPJztXQgbcHeDvAf8N19haUckh0oCe+bT098BvZZ4mUDVJfNeEPsDdaeX2KdbwxgRFEwmlVMTkw== X-Received: by 2002:aa7:9712:: with SMTP id a18mr1494881pfg.197.1597272222625; Wed, 12 Aug 2020 15:43:42 -0700 (PDT) Return-Path: Received: from tvis-name-05.localdomain ([50.34.40.129]) by smtp.gmail.com with ESMTPSA id l63sm3252943pgl.24.2020.08.12.15.43.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 12 Aug 2020 15:43:42 -0700 (PDT) From: "Matthew Carlson" To: devel@edk2.groups.io Cc: Ard Biesheuvel , Michael D Kinney , Liming Gao , Zhiguang Liu , Matthew Carlson Subject: [PATCH v6 2/5] MdePkg: BaseRngLibDxe: Add RngLib that uses RngDxe Date: Wed, 12 Aug 2020 15:43:35 -0700 Message-Id: <20200812224338.287-3-matthewfcarlson@gmail.com> X-Mailer: git-send-email 2.27.0.windows.1 In-Reply-To: <20200812224338.287-1-matthewfcarlson@gmail.com> References: <20200812224338.287-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/BaseRngLibDxe/RngDxeLib.c | 200 ++++++++++++++++++++ MdePkg/Library/BaseRngLibDxe/BaseRngLibDxe.inf | 38 ++++ MdePkg/MdePkg.dsc | 4 +- 3 files changed, 241 insertions(+), 1 deletion(-) diff --git a/MdePkg/Library/BaseRngLibDxe/RngDxeLib.c b/MdePkg/Library/Base= RngLibDxe/RngDxeLib.c new file mode 100644 index 000000000000..8ee29329de13 --- /dev/null +++ b/MdePkg/Library/BaseRngLibDxe/RngDxeLib.c @@ -0,0 +1,200 @@ +/** @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 +EFI_STATUS=0D +EFIAPI=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 **)&Rng= Protocol);=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, &gEfiRngAlgorithmSp80090Ctr2= 56Guid, BufferSize, Buffer);=0D + DEBUG((DEBUG_INFO, "[%a] GetRNG algorithm CTR-256 - Status =3D %r\n", __= FUNCTION__, Status));=0D + if(!EFI_ERROR(Status)) {=0D + return Status;=0D + }=0D +=0D + Status =3D RngProtocol->GetRNG(RngProtocol, &gEfiRngAlgorithmSp80090Hmac= 256Guid, 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, &gEfiRngAlgorithmSp80090Hash= 256Guid, 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/BaseRngLibDxe/BaseRngLibDxe.inf b/MdePkg/Librar= y/BaseRngLibDxe/BaseRngLibDxe.inf new file mode 100644 index 000000000000..819a106b1376 --- /dev/null +++ b/MdePkg/Library/BaseRngLibDxe/BaseRngLibDxe.inf @@ -0,0 +1,38 @@ +# @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 +# MU_CHANGE: New file=0D +##=0D +=0D +[Defines]=0D + INF_VERSION =3D 0x00010017=0D + BASE_NAME =3D BaseRngLibDxe=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 + RngDxeLib.c=0D +=0D +[LibraryClasses]=0D + DebugLib=0D + UefiBootServicesTableLib=0D +=0D +[Protocols]=0D + gEfiRngProtocolGuid ## CONSUMES=0D +=0D +[Depex]=0D + gEfiRngProtocolGuid=0D +=0D +[Guids]=0D + gEfiRngAlgorithmSp80090Ctr256Guid ## CONSUMES=0D + gEfiRngAlgorithmSp80090Hash256Guid ## CONSUMES=0D + gEfiRngAlgorithmSp80090Hmac256Guid ## CONSUMES=0D diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc index d7ba3a730909..837a0047400e 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/BaseRngLibDxe/BaseRngLibDxe.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