2 EFI_RNG_PROTOCOL as defined in UEFI 2.4.
3 The UEFI Random Number Generator Protocol is used to provide random bits for use
4 in applications, or entropy for seeding other random number generators.
6 Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials are licensed and made available under
8 the terms and conditions of the BSD License that accompanies this distribution.
9 The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef __EFI_RNG_PROTOCOL_H__
18 #define __EFI_RNG_PROTOCOL_H__
20 FILE_LICENCE ( BSD3 );
23 /// Global ID for the Random Number Generator Protocol
25 #define EFI_RNG_PROTOCOL_GUID \
27 0x3152bca5, 0xeade, 0x433d, {0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44 } \
30 typedef struct _EFI_RNG_PROTOCOL EFI_RNG_PROTOCOL;
33 /// A selection of EFI_RNG_PROTOCOL algorithms.
34 /// The algorithms listed are optional, not meant to be exhaustive and be argmented by
35 /// vendors or other industry standards.
38 typedef EFI_GUID EFI_RNG_ALGORITHM;
41 /// The algorithms corresponds to SP800-90 as defined in
42 /// NIST SP 800-90, "Recommendation for Random Number Generation Using Deterministic Random
43 /// Bit Generators", March 2007.
45 #define EFI_RNG_ALGORITHM_SP800_90_HASH_256_GUID \
47 0xa7af67cb, 0x603b, 0x4d42, {0xba, 0x21, 0x70, 0xbf, 0xb6, 0x29, 0x3f, 0x96 } \
49 #define EFI_RNG_ALGORITHM_SP800_90_HMAC_256_GUID \
51 0xc5149b43, 0xae85, 0x4f53, {0x99, 0x82, 0xb9, 0x43, 0x35, 0xd3, 0xa9, 0xe7 } \
53 #define EFI_RNG_ALGORITHM_SP800_90_CTR_256_GUID \
55 0x44f0de6e, 0x4d8c, 0x4045, {0xa8, 0xc7, 0x4d, 0xd1, 0x68, 0x85, 0x6b, 0x9e } \
58 /// The algorithms correspond to X9.31 as defined in
59 /// NIST, "Recommended Random Number Generator Based on ANSI X9.31 Appendix A.2.4 Using
60 /// the 3-Key Triple DES and AES Algorithm", January 2005.
62 #define EFI_RNG_ALGORITHM_X9_31_3DES_GUID \
64 0x63c4785a, 0xca34, 0x4012, {0xa3, 0xc8, 0x0b, 0x6a, 0x32, 0x4f, 0x55, 0x46 } \
66 #define EFI_RNG_ALGORITHM_X9_31_AES_GUID \
68 0xacd03321, 0x777e, 0x4d3d, {0xb1, 0xc8, 0x20, 0xcf, 0xd8, 0x88, 0x20, 0xc9 } \
71 /// The "raw" algorithm, when supported, is intended to provide entropy directly from
72 /// the source, without it going through some deterministic random bit generator.
74 #define EFI_RNG_ALGORITHM_RAW \
76 0xe43176d7, 0xb6e8, 0x4827, {0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61 } \
80 Returns information about the random number generation implementation.
82 @param[in] This A pointer to the EFI_RNG_PROTOCOL instance.
83 @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList.
84 On output with a return code of EFI_SUCCESS, the size
85 in bytes of the data returned in RNGAlgorithmList. On output
86 with a return code of EFI_BUFFER_TOO_SMALL,
87 the size of RNGAlgorithmList required to obtain the list.
88 @param[out] RNGAlgorithmList A caller-allocated memory buffer filled by the driver
89 with one EFI_RNG_ALGORITHM element for each supported
90 RNG algorithm. The list must not change across multiple
91 calls to the same driver. The first algorithm in the list
92 is the default algorithm for the driver.
94 @retval EFI_SUCCESS The RNG algorithm list was returned successfully.
95 @retval EFI_UNSUPPORTED The services is not supported by this driver.
96 @retval EFI_DEVICE_ERROR The list of algorithms could not be retrieved due to a
97 hardware or firmware error.
98 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect.
99 @retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too small to hold the result.
104 (EFIAPI *EFI_RNG_GET_INFO) (
105 IN EFI_RNG_PROTOCOL *This,
106 IN OUT UINTN *RNGAlgorithmListSize,
107 OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
111 Produces and returns an RNG value using either the default or specified RNG algorithm.
113 @param[in] This A pointer to the EFI_RNG_PROTOCOL instance.
114 @param[in] RNGAlgorithm A pointer to the EFI_RNG_ALGORITHM that identifies the RNG
115 algorithm to use. May be NULL in which case the function will
116 use its default RNG algorithm.
117 @param[in] RNGValueLength The length in bytes of the memory buffer pointed to by
118 RNGValue. The driver shall return exactly this numbers of bytes.
119 @param[out] RNGValue A caller-allocated memory buffer filled by the driver with the
122 @retval EFI_SUCCESS The RNG value was returned successfully.
123 @retval EFI_UNSUPPORTED The algorithm specified by RNGAlgorithm is not supported by
125 @retval EFI_DEVICE_ERROR An RNG value could not be retrieved due to a hardware or
127 @retval EFI_NOT_READY There is not enough random data available to satisfy the length
128 requested by RNGValueLength.
129 @retval EFI_INVALID_PARAMETER RNGValue is NULL or RNGValueLength is zero.
134 (EFIAPI *EFI_RNG_GET_RNG) (
135 IN EFI_RNG_PROTOCOL *This,
136 IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL
137 IN UINTN RNGValueLength,
142 /// The Random Number Generator (RNG) protocol provides random bits for use in
143 /// applications, or entropy for seeding other random number generators.
145 struct _EFI_RNG_PROTOCOL {
146 EFI_RNG_GET_INFO GetInfo;
147 EFI_RNG_GET_RNG GetRNG;
150 extern EFI_GUID gEfiRngProtocolGuid;
151 extern EFI_GUID gEfiRngAlgorithmSp80090Hash256Guid;
152 extern EFI_GUID gEfiRngAlgorithmSp80090Hmac256Guid;
153 extern EFI_GUID gEfiRngAlgorithmSp80090Ctr256Guid;
154 extern EFI_GUID gEfiRngAlgorithmX9313DesGuid;
155 extern EFI_GUID gEfiRngAlgorithmX931AesGuid;
156 extern EFI_GUID gEfiRngAlgorithmRaw;