From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mx.groups.io with SMTP id smtpd.web11.5218.1573654915314620401 for ; Wed, 13 Nov 2019 06:21:55 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 192.55.52.120, mailfrom: jian.j.wang@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Nov 2019 06:21:54 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.68,300,1569308400"; d="scan'208";a="207808284" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by orsmga006.jf.intel.com with ESMTP; 13 Nov 2019 06:21:54 -0800 Received: from shsmsx105.ccr.corp.intel.com (10.239.4.158) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.439.0; Wed, 13 Nov 2019 06:21:53 -0800 Received: from shsmsx107.ccr.corp.intel.com ([169.254.9.63]) by SHSMSX105.ccr.corp.intel.com ([169.254.11.225]) with mapi id 14.03.0439.000; Wed, 13 Nov 2019 22:21:51 +0800 From: "Wang, Jian J" To: Laszlo Ersek , "devel@edk2.groups.io" CC: "Kinney, Michael D" , "Gao, Liming" , Ard Biesheuvel , "Ni, Ray" Subject: Re: [edk2-devel] [PATCH v2] MdePkg: add null version of RngLib Thread-Topic: [edk2-devel] [PATCH v2] MdePkg: add null version of RngLib Thread-Index: AQHVmeQ8KkpGWwvnmEK0adxuC0rfU6eIvgug//+RdwCAANeLYA== Date: Wed, 13 Nov 2019 14:21:51 +0000 Message-ID: References: <15D6A215430F1F2B.28343@groups.io> In-Reply-To: Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiZTNjNTBlY2QtYjI1My00YjM4LTk4NWQtYjU5NDU1NWJkZjYzIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoidGhpRzJKSmxJaFRcL1JtUWMwK242U1BBY2xZenRrMGdZanZkQ1hBU3Ewa0Y4bGZiYjBVaHo4TnUwN1pkVW5RbkMifQ== x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.2.0.6 dlp-reaction: no-action x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Return-Path: jian.j.wang@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Laszlo, > -----Original Message----- > From: Laszlo Ersek > Sent: Wednesday, November 13, 2019 5:28 PM > To: Wang, Jian J ; devel@edk2.groups.io > Cc: Kinney, Michael D ; Gao, Liming > ; Ard Biesheuvel ; Ni, = Ray > > Subject: Re: [edk2-devel] [PATCH v2] MdePkg: add null version of RngLib >=20 > On 11/13/19 09:43, Wang, Jian J wrote: > > As requested by Ray, I'd like to mention more usage about this library > > instance. > > > > To be more specific, if following components or functionalities are us= ed in a > > platform, the BaseRngLibNull should *not* be used. Instead, a non-Null > version > > of RngLib must be used (like BaseRngLib for IA32/X64, or coming RngDxe= Lib > > for all ARCHs). > > > > - SecurityPkg/HddPassword/HddPasswordDxe.c > > - AES, TLS (NetworkPkg/TlsDxe/TlsDxe.inf, CryptoPkg/Library/TlsLib/Tls= Lib.inf) > > RSA_OAEP, RSA_PK1 > > - (If BaseRngLibNull interface ASSERTed at boot time) >=20 > Just a naming suggestion for "RngDxeLib": I think it should be called > "DxeRngLibXxxx", where "Xxxx" should stand for the core idea in the > implementation. For example, if the library is based on > EFI_RNG_PROTOCOL, then it likely should be called >=20 > DxeRngLibRngProtocol >=20 > This scheme seems consistent with some other library instance names > under MdePkg/Library: >=20 > MdePkg/Library/UefiDebugLibDebugPortProtocol > MdePkg/Library/UefiDevicePathLibDevicePathProtocol >=20 > and maybe even with >=20 > MdePkg/Library/SmmPciLibPciRootBridgeIo > MdePkg/Library/UefiPciLibPciRootBridgeIo >=20 Good suggestion. Thanks. Regards, Jian > Thanks > Laszlo >=20 > > > > Regards, > > Jian > > > >> -----Original Message----- > >> From: devel@edk2.groups.io On Behalf Of Wang, > Jian > >> J > >> Sent: Wednesday, November 13, 2019 1:35 PM > >> To: devel@edk2.groups.io > >> Cc: Kinney, Michael D ; Gao, Liming > >> ; Laszlo Ersek ; Ard Biesheu= vel > >> ; Ni, Ray > >> Subject: [edk2-devel] [PATCH v2] MdePkg: add null version of RngLib > >> > >>> v2: > >>> - Change the name from RngLibNull to BaseRngLibNull according to La= szlo's > >>> comments > >>> - Move the module from SecurityPkg to MdePkg according to Laszlo's > >> comments > >>> - Update commit message according to Laszlo and Ray's comments > >> > >> This is null version of RngLib which should be used with modules that > >> inherit an (indirect) dependency on the RngLib class, but never actua= lly > >> call RngLib APIs for consuming randomness. > >> > >> > >> Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=3D1871 > >> Cc: Michael D Kinney > >> Cc: Liming Gao > >> Cc: Laszlo Ersek > >> Cc: Ard Biesheuvel > >> Cc: Ray Ni > >> Signed-off-by: Jian J Wang > >> --- > >> .../Library/BaseRngLibNull/BaseRngLibNull.c | 95 +++++++++++++++++= ++ > >> .../Library/BaseRngLibNull/BaseRngLibNull.inf | 31 ++++++ > >> .../Library/BaseRngLibNull/BaseRngLibNull.uni | 14 +++ > >> MdePkg/MdePkg.dsc | 1 + > >> 4 files changed, 141 insertions(+) > >> create mode 100644 MdePkg/Library/BaseRngLibNull/BaseRngLibNull.c > >> create mode 100644 MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf > >> create mode 100644 MdePkg/Library/BaseRngLibNull/BaseRngLibNull.uni > >> > >> diff --git a/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.c > >> b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.c > >> new file mode 100644 > >> index 0000000000..13677abc84 > >> --- /dev/null > >> +++ b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.c > >> @@ -0,0 +1,95 @@ > >> +/** @file > >> + Null version of Random number generator services. > >> + > >> +Copyright (c) 2019, Intel Corporation. All rights reserved.
> >> +SPDX-License-Identifier: BSD-2-Clause-Patent > >> + > >> +**/ > >> + > >> +#include > >> +#include > >> +#include > >> + > >> +/** > >> + Generates a 16-bit random number. > >> + > >> + if Rand is NULL, then ASSERT(). > >> + > >> + @param[out] Rand Buffer pointer to store the 16-bit random val= ue. > >> + > >> + @retval TRUE Random number generated successfully. > >> + @retval FALSE Failed to generate the random number. > >> + > >> +**/ > >> +BOOLEAN > >> +EFIAPI > >> +GetRandomNumber16 ( > >> + OUT UINT16 *Rand > >> + ) > >> +{ > >> + ASSERT (FALSE); > >> + return FALSE; > >> +} > >> + > >> +/** > >> + Generates a 32-bit random number. > >> + > >> + if Rand is NULL, then ASSERT(). > >> + > >> + @param[out] Rand Buffer pointer to store the 32-bit random val= ue. > >> + > >> + @retval TRUE Random number generated successfully. > >> + @retval FALSE Failed to generate the random number. > >> + > >> +**/ > >> +BOOLEAN > >> +EFIAPI > >> +GetRandomNumber32 ( > >> + OUT UINT32 *Rand > >> + ) > >> +{ > >> + ASSERT (FALSE); > >> + return FALSE; > >> +} > >> + > >> +/** > >> + Generates a 64-bit random number. > >> + > >> + if Rand is NULL, then ASSERT(). > >> + > >> + @param[out] Rand Buffer pointer to store the 64-bit random val= ue. > >> + > >> + @retval TRUE Random number generated successfully. > >> + @retval FALSE Failed to generate the random number. > >> + > >> +**/ > >> +BOOLEAN > >> +EFIAPI > >> +GetRandomNumber64 ( > >> + OUT UINT64 *Rand > >> + ) > >> +{ > >> + ASSERT (FALSE); > >> + return FALSE; > >> +} > >> + > >> +/** > >> + Generates a 128-bit random number. > >> + > >> + if Rand is NULL, then ASSERT(). > >> + > >> + @param[out] Rand Buffer pointer to store the 128-bit random va= lue. > >> + > >> + @retval TRUE Random number generated successfully. > >> + @retval FALSE Failed to generate the random number. > >> + > >> +**/ > >> +BOOLEAN > >> +EFIAPI > >> +GetRandomNumber128 ( > >> + OUT UINT64 *Rand > >> + ) > >> +{ > >> + ASSERT (FALSE); > >> + return FALSE; > >> +} > >> diff --git a/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf > >> b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf > >> new file mode 100644 > >> index 0000000000..f456df1dae > >> --- /dev/null > >> +++ b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf > >> @@ -0,0 +1,31 @@ > >> +## @file > >> +# Null instance of RNG (Random Number Generator) Library. > >> +# > >> +# Copyright (c) 2019, Intel Corporation. All rights reserved.
> >> +# > >> +# SPDX-License-Identifier: BSD-2-Clause-Patent > >> +# > >> +## > >> + > >> +[Defines] > >> + INF_VERSION =3D 0x00010005 > >> + BASE_NAME =3D BaseRngLibNull > >> + MODULE_UNI_FILE =3D BaseRngLibNull.uni > >> + FILE_GUID =3D CD8991F8-2061-4084-8C9E-9C6F352= DC58D > >> + MODULE_TYPE =3D BASE > >> + VERSION_STRING =3D 1.0 > >> + LIBRARY_CLASS =3D RngLib > >> + > >> +# > >> +# VALID_ARCHITECTURES =3D IA32 X64 ARM AARCH64 > >> +# > >> + > >> +[Sources] > >> + BaseRngLibNull.c > >> + > >> +[Packages] > >> + MdePkg/MdePkg.dec > >> + > >> +[LibraryClasses] > >> + BaseLib > >> + DebugLib > >> diff --git a/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.uni > >> b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.uni > >> new file mode 100644 > >> index 0000000000..f32be6a617 > >> --- /dev/null > >> +++ b/MdePkg/Library/BaseRngLibNull/BaseRngLibNull.uni > >> @@ -0,0 +1,14 @@ > >> +// /** @file > >> +// Null Instance of RNG (Random Number Generator) Library. > >> +// > >> +// Copyright (c) 2019, Intel Corporation. All rights reserved.
> >> +// > >> +// SPDX-License-Identifier: BSD-2-Clause-Patent > >> +// > >> +// **/ > >> + > >> + > >> +#string STR_MODULE_ABSTRACT #language en-US "Null Instan= ce of > >> RNG Library" > >> + > >> +#string STR_MODULE_DESCRIPTION #language en-US "This librar= y > >> instance should be used with modules that inherit an (indirect) depen= dency on > >> the RngLib class, but never actually call RngLib APIs for consuming > randomness." > >> + > >> diff --git a/MdePkg/MdePkg.dsc b/MdePkg/MdePkg.dsc > >> index c1278e7907..0aeafaaacc 100644 > >> --- a/MdePkg/MdePkg.dsc > >> +++ b/MdePkg/MdePkg.dsc > >> @@ -61,6 +61,7 @@ > >> > >> > MdePkg/Library/BaseUefiDecompressLib/BaseUefiTianoCustomDecompressLib. > >> inf > >> MdePkg/Library/BaseSmbusLibNull/BaseSmbusLibNull.inf > >> MdePkg/Library/BaseSafeIntLib/BaseSafeIntLib.inf > >> + MdePkg/Library/BaseRngLibNull/BaseRngLibNull.inf > >> > >> MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.inf > >> MdePkg/Library/DxeCoreHobLib/DxeCoreHobLib.inf > >> -- > >> 2.17.1.windows.2 > >> > >> > >>=20 > >