[PATCH v7 12/19] SecurityPkg/RngDxe: Remove ArchGetSupportedRngAlgorithms()


PierreGondois
 

From: Pierre Gondois <Pierre.Gondois@...>

RngGetInfo() is one of the 2 functions of the EFI_RNG_PROTOCOL.
RngGetInfo() is currently a mere wrapper around
ArchGetSupportedRngAlgorithms() which is implemented differently
depending on the architecture used.

RngGetInfo() does nothing more than calling
ArchGetSupportedRngAlgorithms(). So remove it, and let RngGetInfo()
be implemented differently according to the architecture.

This follows the implementation of the other function of the
EFI_RNG_PROTOCOL, RngGetRNG().

Signed-off-by: Pierre Gondois <pierre.gondois@...>
---
.../RngDxe/AArch64/RngDxe.c | 19 +++++--
.../RngDxe/Rand/RngDxe.c | 22 +++++++--
.../RandomNumberGenerator/RngDxe/RngDxe.c | 49 -------------------
.../RngDxe/RngDxeInternals.h | 25 ----------
4 files changed, 33 insertions(+), 82 deletions(-)

diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c b/=
SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c
index 3daf847d46d3..6d989f7ea376 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c
@@ -14,6 +14,7 @@
Copyright (c) 2021, NUVIA Inc. All rights reserved.<BR>
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
+ Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>
=20
SPDX-License-Identifier: BSD-2-Clause-Patent
=20
@@ -85,6 +86,7 @@ RngGetRNG (
/**
Returns information about the random number generation implementation.
=20
+ @param[in] This A pointer to the EFI_RNG_PROTOCOL =
instance.
@param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNG=
AlgorithmList.
On output with a return code of EF=
I_SUCCESS, the size
in bytes of the data returned in R=
NGAlgorithmList. On output
@@ -97,14 +99,19 @@ RngGetRNG (
is the default algorithm for the d=
river.
=20
@retval EFI_SUCCESS The RNG algorithm list was returne=
d successfully.
+ @retval EFI_UNSUPPORTED The services is not supported by t=
his driver.
+ @retval EFI_DEVICE_ERROR The list of algorithms could not b=
e retrieved due to a
+ hardware or firmware error.
+ @retval EFI_INVALID_PARAMETER One or more of the parameters are =
incorrect.
@retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too=
small to hold the result.
=20
**/
-UINTN
+EFI_STATUS
EFIAPI
-ArchGetSupportedRngAlgorithms (
- IN OUT UINTN *RNGAlgorithmListSize,
- OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
+RngGetInfo (
+ IN EFI_RNG_PROTOCOL *This,
+ IN OUT UINTN *RNGAlgorithmListSize,
+ OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
)
{
UINTN RequiredSize;
@@ -112,6 +119,10 @@ ArchGetSupportedRngAlgorithms (
=20
RequiredSize =3D sizeof (EFI_RNG_ALGORITHM);
=20
+ if ((This =3D=3D NULL) || (RNGAlgorithmListSize =3D=3D NULL)) {
+ return EFI_INVALID_PARAMETER;
+ }
+
if (*RNGAlgorithmListSize < RequiredSize) {
*RNGAlgorithmListSize =3D RequiredSize;
return EFI_BUFFER_TOO_SMALL;
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c b/Sec=
urityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c
index df7db12b771c..b2d2236380fd 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c
@@ -104,6 +104,7 @@ RngGetRNG (
/**
Returns information about the random number generation implementation.
=20
+ @param[in] This A pointer to the EFI_RNG_PROTOCOL =
instance.
@param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNG=
AlgorithmList.
On output with a return code of EF=
I_SUCCESS, the size
in bytes of the data returned in R=
NGAlgorithmList. On output
@@ -116,18 +117,27 @@ RngGetRNG (
is the default algorithm for the d=
river.
=20
@retval EFI_SUCCESS The RNG algorithm list was returne=
d successfully.
+ @retval EFI_UNSUPPORTED No supported algorithms found.
+ @retval EFI_DEVICE_ERROR The list of algorithms could not b=
e retrieved due to a
+ hardware or firmware error.
+ @retval EFI_INVALID_PARAMETER One or more of the parameters are =
incorrect.
@retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too=
small to hold the result.
=20
**/
-UINTN
+EFI_STATUS
EFIAPI
-ArchGetSupportedRngAlgorithms (
- IN OUT UINTN *RNGAlgorithmListSize,
- OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
+RngGetInfo (
+ IN EFI_RNG_PROTOCOL *This,
+ IN OUT UINTN *RNGAlgorithmListSize,
+ OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
)
{
UINTN RequiredSize;
=20
+ if ((This =3D=3D NULL) || (RNGAlgorithmListSize =3D=3D NULL)) {
+ return EFI_INVALID_PARAMETER;
+ }
+
RequiredSize =3D 2 * sizeof (EFI_RNG_ALGORITHM);
=20
if (*RNGAlgorithmListSize < RequiredSize) {
@@ -135,6 +145,10 @@ ArchGetSupportedRngAlgorithms (
return EFI_BUFFER_TOO_SMALL;
}
=20
+ if (RNGAlgorithmList =3D=3D NULL) {
+ return EFI_INVALID_PARAMETER;
+ }
+
CopyMem (&RNGAlgorithmList[0], &gEfiRngAlgorithmSp80090Ctr256Guid, siz=
eof (EFI_RNG_ALGORITHM));
=20
// x86 platforms also support EFI_RNG_ALGORITHM_RAW via RDSEED
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c b/Security=
Pkg/RandomNumberGenerator/RngDxe/RngDxe.c
index 6f52eeff4a09..6608ca8804a5 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c
@@ -28,55 +28,6 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
=20
#include "RngDxeInternals.h"
=20
-/**
- Returns information about the random number generation implementation.
-
- @param[in] This A pointer to the EFI_RNG_PROTOCOL =
instance.
- @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNG=
AlgorithmList.
- On output with a return code of EF=
I_SUCCESS, the size
- in bytes of the data returned in R=
NGAlgorithmList. On output
- with a return code of EFI_BUFFER_T=
OO_SMALL,
- the size of RNGAlgorithmList requi=
red to obtain the list.
- @param[out] RNGAlgorithmList A caller-allocated memory buffer f=
illed by the driver
- with one EFI_RNG_ALGORITHM element=
for each supported
- RNG algorithm. The list must not c=
hange across multiple
- calls to the same driver. The firs=
t algorithm in the list
- is the default algorithm for the d=
river.
-
- @retval EFI_SUCCESS The RNG algorithm list was returne=
d successfully.
- @retval EFI_UNSUPPORTED The services is not supported by t=
his driver.
- @retval EFI_DEVICE_ERROR The list of algorithms could not b=
e retrieved due to a
- hardware or firmware error.
- @retval EFI_INVALID_PARAMETER One or more of the parameters are =
incorrect.
- @retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too=
small to hold the result.
-
-**/
-EFI_STATUS
-EFIAPI
-RngGetInfo (
- IN EFI_RNG_PROTOCOL *This,
- IN OUT UINTN *RNGAlgorithmListSize,
- OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
- )
-{
- EFI_STATUS Status;
-
- if ((This =3D=3D NULL) || (RNGAlgorithmListSize =3D=3D NULL)) {
- return EFI_INVALID_PARAMETER;
- }
-
- //
- // Return algorithm list supported by driver.
- //
- if (RNGAlgorithmList !=3D NULL) {
- Status =3D ArchGetSupportedRngAlgorithms (RNGAlgorithmListSize, RNGA=
lgorithmList);
- } else {
- Status =3D EFI_INVALID_PARAMETER;
- }
-
- return Status;
-}
-
//
// The Random Number Generator (RNG) protocol
//
diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h b=
/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h
index 48d2d27c1608..7ecab140483d 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h
@@ -74,31 +74,6 @@ RngGetRNG (
OUT UINT8 *RNGValue
);
=20
-/**
- Returns information about the random number generation implementation.
-
- @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNG=
AlgorithmList.
- On output with a return code of EF=
I_SUCCESS, the size
- in bytes of the data returned in R=
NGAlgorithmList. On output
- with a return code of EFI_BUFFER_T=
OO_SMALL,
- the size of RNGAlgorithmList requi=
red to obtain the list.
- @param[out] RNGAlgorithmList A caller-allocated memory buffer f=
illed by the driver
- with one EFI_RNG_ALGORITHM element=
for each supported
- RNG algorithm. The list must not c=
hange across multiple
- calls to the same driver. The firs=
t algorithm in the list
- is the default algorithm for the d=
river.
-
- @retval EFI_SUCCESS The RNG algorithm list was returne=
d successfully.
- @retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too=
small to hold the result.
-
-**/
-UINTN
-EFIAPI
-ArchGetSupportedRngAlgorithms (
- IN OUT UINTN *RNGAlgorithmListSize,
- OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
- );
-
/**
Runs CPU RNG instruction to fill a buffer of arbitrary size with rando=
m bytes.
=20
--=20
2.25.1