1 /** @file 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. 5 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. 11 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. 14 15 **/ 16 17 #ifndef __EFI_RNG_PROTOCOL_H__ 18 #define __EFI_RNG_PROTOCOL_H__ 19 20 /// 21 /// Global ID for the Random Number Generator Protocol 22 /// 23 #define EFI_RNG_PROTOCOL_GUID \ 24 { \ 25 0x3152bca5, 0xeade, 0x433d, {0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44 } \ 26 } 27 28 typedef struct _EFI_RNG_PROTOCOL EFI_RNG_PROTOCOL; 29 30 /// 31 /// A selection of EFI_RNG_PROTOCOL algorithms. 32 /// The algorithms listed are optional, not meant to be exhaustive and be argmented by 33 /// vendors or other industry standards. 34 /// 35 36 typedef EFI_GUID EFI_RNG_ALGORITHM; 37 38 /// 39 /// The algorithms corresponds to SP800-90 as defined in 40 /// NIST SP 800-90, "Recommendation for Random Number Generation Using Deterministic Random 41 /// Bit Generators", March 2007. 42 /// 43 #define EFI_RNG_ALGORITHM_SP800_90_HASH_256_GUID \ 44 { \ 45 0xa7af67cb, 0x603b, 0x4d42, {0xba, 0x21, 0x70, 0xbf, 0xb6, 0x29, 0x3f, 0x96 } \ 46 } 47 #define EFI_RNG_ALGORITHM_SP800_90_HMAC_256_GUID \ 48 { \ 49 0xc5149b43, 0xae85, 0x4f53, {0x99, 0x82, 0xb9, 0x43, 0x35, 0xd3, 0xa9, 0xe7 } \ 50 } 51 #define EFI_RNG_ALGORITHM_SP800_90_CTR_256_GUID \ 52 { \ 53 0x44f0de6e, 0x4d8c, 0x4045, {0xa8, 0xc7, 0x4d, 0xd1, 0x68, 0x85, 0x6b, 0x9e } \ 54 } 55 /// 56 /// The algorithms correspond to X9.31 as defined in 57 /// NIST, "Recommended Random Number Generator Based on ANSI X9.31 Appendix A.2.4 Using 58 /// the 3-Key Triple DES and AES Algorithm", January 2005. 59 /// 60 #define EFI_RNG_ALGORITHM_X9_31_3DES_GUID \ 61 { \ 62 0x63c4785a, 0xca34, 0x4012, {0xa3, 0xc8, 0x0b, 0x6a, 0x32, 0x4f, 0x55, 0x46 } \ 63 } 64 #define EFI_RNG_ALGORITHM_X9_31_AES_GUID \ 65 { \ 66 0xacd03321, 0x777e, 0x4d3d, {0xb1, 0xc8, 0x20, 0xcf, 0xd8, 0x88, 0x20, 0xc9 } \ 67 } 68 /// 69 /// The "raw" algorithm, when supported, is intended to provide entropy directly from 70 /// the source, without it going through some deterministic random bit generator. 71 /// 72 #define EFI_RNG_ALGORITHM_RAW \ 73 { \ 74 0xe43176d7, 0xb6e8, 0x4827, {0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61 } \ 75 } 76 77 /** 78 Returns information about the random number generation implementation. 79 80 @param[in] This A pointer to the EFI_RNG_PROTOCOL instance. 81 @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList. 82 On output with a return code of EFI_SUCCESS, the size 83 in bytes of the data returned in RNGAlgorithmList. On output 84 with a return code of EFI_BUFFER_TOO_SMALL, 85 the size of RNGAlgorithmList required to obtain the list. 86 @param[out] RNGAlgorithmList A caller-allocated memory buffer filled by the driver 87 with one EFI_RNG_ALGORITHM element for each supported 88 RNG algorithm. The list must not change across multiple 89 calls to the same driver. The first algorithm in the list 90 is the default algorithm for the driver. 91 92 @retval EFI_SUCCESS The RNG algorithm list was returned successfully. 93 @retval EFI_UNSUPPORTED The services is not supported by this driver. 94 @retval EFI_DEVICE_ERROR The list of algorithms could not be retrieved due to a 95 hardware or firmware error. 96 @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. 97 @retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too small to hold the result. 98 99 **/ 100 typedef 101 EFI_STATUS 102 (EFIAPI *EFI_RNG_GET_INFO) ( 103 IN EFI_RNG_PROTOCOL *This, 104 IN OUT UINTN *RNGAlgorithmListSize, 105 OUT EFI_RNG_ALGORITHM *RNGAlgorithmList 106 ); 107 108 /** 109 Produces and returns an RNG value using either the default or specified RNG algorithm. 110 111 @param[in] This A pointer to the EFI_RNG_PROTOCOL instance. 112 @param[in] RNGAlgorithm A pointer to the EFI_RNG_ALGORITHM that identifies the RNG 113 algorithm to use. May be NULL in which case the function will 114 use its default RNG algorithm. 115 @param[in] RNGValueLength The length in bytes of the memory buffer pointed to by 116 RNGValue. The driver shall return exactly this numbers of bytes. 117 @param[out] RNGValue A caller-allocated memory buffer filled by the driver with the 118 resulting RNG value. 119 120 @retval EFI_SUCCESS The RNG value was returned successfully. 121 @retval EFI_UNSUPPORTED The algorithm specified by RNGAlgorithm is not supported by 122 this driver. 123 @retval EFI_DEVICE_ERROR An RNG value could not be retrieved due to a hardware or 124 firmware error. 125 @retval EFI_NOT_READY There is not enough random data available to satisfy the length 126 requested by RNGValueLength. 127 @retval EFI_INVALID_PARAMETER RNGValue is NULL or RNGValueLength is zero. 128 129 **/ 130 typedef 131 EFI_STATUS 132 (EFIAPI *EFI_RNG_GET_RNG) ( 133 IN EFI_RNG_PROTOCOL *This, 134 IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL 135 IN UINTN RNGValueLength, 136 OUT UINT8 *RNGValue 137 ); 138 139 /// 140 /// The Random Number Generator (RNG) protocol provides random bits for use in 141 /// applications, or entropy for seeding other random number generators. 142 /// 143 struct _EFI_RNG_PROTOCOL { 144 EFI_RNG_GET_INFO GetInfo; 145 EFI_RNG_GET_RNG GetRNG; 146 }; 147 148 extern EFI_GUID gEfiRngProtocolGuid; 149 extern EFI_GUID gEfiRngAlgorithmSp80090Hash256Guid; 150 extern EFI_GUID gEfiRngAlgorithmSp80090Hmac256Guid; 151 extern EFI_GUID gEfiRngAlgorithmSp80090Ctr256Guid; 152 extern EFI_GUID gEfiRngAlgorithmX9313DesGuid; 153 extern EFI_GUID gEfiRngAlgorithmX931AesGuid; 154 extern EFI_GUID gEfiRngAlgorithmRaw; 155 156 #endif 157
