From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pg1-f175.google.com (mail-pg1-f175.google.com [209.85.215.175]) by mx.groups.io with SMTP id smtpd.web11.7009.1597198892703645031 for ; Tue, 11 Aug 2020 19:21:32 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20161025 header.b=kJaWL2oV; spf=pass (domain: gmail.com, ip: 209.85.215.175, mailfrom: matthewfcarlson@gmail.com) Received: by mail-pg1-f175.google.com with SMTP id m34so236697pgl.11 for ; Tue, 11 Aug 2020 19:21:32 -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=pnpeDiHsom2Eybs6G+PN5XwUWtu8h4fpds68AeABzAs=; b=kJaWL2oVGG34601uBxAxY1dXyEZsPMZpofaufUzR1Ezaqzd64vmfXsx/gtdAG2e97N S1camBKNFygsowtIRGHywFklf+Nnw3URI/8nNkm3GVtXOIm5lfudymWQFtXQn4Bw8fB2 jm6/4tTZEFeKHn2zUmfWRREMqY4bncB4a0N1XOsE/Qz3UffUkRz0T3nxCO13ut4mbOQS B4q84tm7nAJuxlgTFKl19fZr5EES6dtt1IY67uQ+QiekEUtqbFp2Ur+QzhMjkRBCOP6T m7ThC2tjiJweCPXIYWUnNh/ejaZt2O/Kc68aXCQUQ5DL18igqTwDRHX4k3wISrCZP1cm 6gJQ== 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=pnpeDiHsom2Eybs6G+PN5XwUWtu8h4fpds68AeABzAs=; b=gnW7zts7ipHJ46AE+cFbEgR0UT7YZfN+Q20OuV3DBgbww2NpJy3g44LbRXtl4+/p4O VwGSQz7Et8ELw+tMOjzVK8UXvLhn7m2yhjO9Z/xjDg0Q35V8MzTwhzuErjvA0l/Dev6n Qr4j2BtPoLolS9d16NQYus3f+5Qg3wCkMOiLHqX0XTRx+P2SPWNqn3vxqK2T+YR/MOjO mD+J+kXAws0zBk2Q+J/kq2EjfyjbYHjS9N0NEugF2IaRWSJWWlWQ2YpLZOY5Hc0uLdjF wwrWkRQ07+Hm3p1ji4DfYDldZF8rvICeFwHPBcqm8GyUJUMj9lykuoKEomMdkSP1gbNY W2Qw== X-Gm-Message-State: AOAM533Vi+AwhsbUyeI3xH+B1Orziwa9n9sv0ZXm56wR8Cy5vwJvRtLP PKX6EaVuQlIMLS60g6D27txk1q3/9LgRfQ== X-Google-Smtp-Source: ABdhPJyb/s+xDQuLOMWsgY3V0Bm+AqjO2F0wNRQepojZJIYqQ0Zc83/X+KiwjDdhQedtdTZMTDaqrA== X-Received: by 2002:a63:29c8:: with SMTP id p191mr3309980pgp.333.1597198892041; Tue, 11 Aug 2020 19:21:32 -0700 (PDT) Return-Path: Received: from tvis-name-05.localdomain ([50.34.40.129]) by smtp.gmail.com with ESMTPSA id q17sm415952pfh.32.2020.08.11.19.21.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 11 Aug 2020 19:21:31 -0700 (PDT) From: "Matthew Carlson" To: devel@edk2.groups.io Cc: Michael D Kinney , Liming Gao , Zhiguang Liu , Matthew Carlson Subject: [PATCH v5 2/5] MdePkg: BaseRngLibDxe: Add RngLib that uses RngDxe Date: Tue, 11 Aug 2020 19:21:24 -0700 Message-Id: <20200812022127.1205-3-matthewfcarlson@gmail.com> X-Mailer: git-send-email 2.27.0.windows.1 In-Reply-To: <20200812022127.1205-1-matthewfcarlson@gmail.com> References: <20200812022127.1205-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: 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