1 /** @file 2 EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0. 3 EFI_HASH_PROTOCOL as defined in UEFI 2.0. 4 The EFI Hash Service Binding Protocol is used to locate hashing services support 5 provided by a driver and to create and destroy instances of the EFI Hash Protocol 6 so that a multiple drivers can use the underlying hashing services. 7 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> 8 This program and the accompanying materials are licensed and made available under 9 the terms and conditions of the BSD License that accompanies this distribution. 10 The full text of the license may be found at 11 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. 14 **/ 15 16 #ifndef __EFI_HASH_PROTOCOL_H__ 17 #define __EFI_HASH_PROTOCOL_H__ 18 19 #include <sys/cdefs.h> 20 __FBSDID("$FreeBSD$"); 21 22 #define CONST const 23 24 #define EFI_HASH_SERVICE_BINDING_PROTOCOL_GUID \ 25 { \ 26 0x42881c98, 0xa4f3, 0x44b0, {0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd } \ 27 } 28 29 #define EFI_HASH_PROTOCOL_GUID \ 30 { \ 31 0xc5184932, 0xdba5, 0x46db, {0xa5, 0xba, 0xcc, 0x0b, 0xda, 0x9c, 0x14, 0x35 } \ 32 } 33 34 #define EFI_HASH_ALGORITHM_SHA1_GUID \ 35 { \ 36 0x2ae9d80f, 0x3fb2, 0x4095, {0xb7, 0xb1, 0xe9, 0x31, 0x57, 0xb9, 0x46, 0xb6 } \ 37 } 38 39 #define EFI_HASH_ALGORITHM_SHA224_GUID \ 40 { \ 41 0x8df01a06, 0x9bd5, 0x4bf7, {0xb0, 0x21, 0xdb, 0x4f, 0xd9, 0xcc, 0xf4, 0x5b } \ 42 } 43 44 #define EFI_HASH_ALGORITHM_SHA256_GUID \ 45 { \ 46 0x51aa59de, 0xfdf2, 0x4ea3, {0xbc, 0x63, 0x87, 0x5f, 0xb7, 0x84, 0x2e, 0xe9 } \ 47 } 48 49 #define EFI_HASH_ALGORITHM_SHA384_GUID \ 50 { \ 51 0xefa96432, 0xde33, 0x4dd2, {0xae, 0xe6, 0x32, 0x8c, 0x33, 0xdf, 0x77, 0x7a } \ 52 } 53 54 #define EFI_HASH_ALGORITHM_SHA512_GUID \ 55 { \ 56 0xcaa4381e, 0x750c, 0x4770, {0xb8, 0x70, 0x7a, 0x23, 0xb4, 0xe4, 0x21, 0x30 } \ 57 } 58 59 #define EFI_HASH_ALGORTIHM_MD5_GUID \ 60 { \ 61 0xaf7c79c, 0x65b5, 0x4319, {0xb0, 0xae, 0x44, 0xec, 0x48, 0x4e, 0x4a, 0xd7 } \ 62 } 63 64 #define EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID \ 65 { \ 66 0x24c5dc2f, 0x53e2, 0x40ca, {0x9e, 0xd6, 0xa5, 0xd9, 0xa4, 0x9f, 0x46, 0x3b } \ 67 } 68 69 #define EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID \ 70 { \ 71 0x8628752a, 0x6cb7, 0x4814, {0x96, 0xfc, 0x24, 0xa8, 0x15, 0xac, 0x22, 0x26 } \ 72 } 73 74 // 75 // Note: Use of the following algorithms with EFI_HASH_PROTOCOL is deprecated. 76 // EFI_HASH_ALGORITHM_SHA1_GUID 77 // EFI_HASH_ALGORITHM_SHA224_GUID 78 // EFI_HASH_ALGORITHM_SHA256_GUID 79 // EFI_HASH_ALGORITHM_SHA384_GUID 80 // EFI_HASH_ALGORITHM_SHA512_GUID 81 // EFI_HASH_ALGORTIHM_MD5_GUID 82 // 83 84 typedef struct _EFI_HASH_PROTOCOL EFI_HASH_PROTOCOL; 85 86 typedef UINT8 EFI_MD5_HASH[16]; 87 typedef UINT8 EFI_SHA1_HASH[20]; 88 typedef UINT8 EFI_SHA224_HASH[28]; 89 typedef UINT8 EFI_SHA256_HASH[32]; 90 typedef UINT8 EFI_SHA384_HASH[48]; 91 typedef UINT8 EFI_SHA512_HASH[64]; 92 93 typedef union { 94 EFI_MD5_HASH *Md5Hash; 95 EFI_SHA1_HASH *Sha1Hash; 96 EFI_SHA224_HASH *Sha224Hash; 97 EFI_SHA256_HASH *Sha256Hash; 98 EFI_SHA384_HASH *Sha384Hash; 99 EFI_SHA512_HASH *Sha512Hash; 100 } EFI_HASH_OUTPUT; 101 102 /** 103 Returns the size of the hash which results from a specific algorithm. 104 @param[in] This Points to this instance of EFI_HASH_PROTOCOL. 105 @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. 106 @param[out] HashSize Holds the returned size of the algorithm's hash. 107 @retval EFI_SUCCESS Hash size returned successfully. 108 @retval EFI_INVALID_PARAMETER HashSize is NULL or HashAlgorithm is NULL. 109 @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported 110 by this driver. 111 **/ 112 typedef 113 EFI_STATUS 114 (EFIAPI *EFI_HASH_GET_HASH_SIZE)( 115 IN CONST EFI_HASH_PROTOCOL *This, 116 IN CONST EFI_GUID *HashAlgorithm, 117 OUT UINTN *HashSize 118 ); 119 120 /** 121 Creates a hash for the specified message text. 122 @param[in] This Points to this instance of EFI_HASH_PROTOCOL. 123 @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. 124 @param[in] Extend Specifies whether to create a new hash (FALSE) or extend the specified 125 existing hash (TRUE). 126 @param[in] Message Points to the start of the message. 127 @param[in] MessageSize The size of Message, in bytes. 128 @param[in,out] Hash On input, if Extend is TRUE, then this parameter holds a pointer 129 to a pointer to an array containing the hash to extend. If Extend 130 is FALSE, then this parameter holds a pointer to a pointer to a 131 caller-allocated array that will receive the result of the hash 132 computation. On output (regardless of the value of Extend), the 133 array will contain the result of the hash computation. 134 @retval EFI_SUCCESS Hash returned successfully. 135 @retval EFI_INVALID_PARAMETER Message or Hash, HashAlgorithm is NULL or MessageSize is 0. 136 MessageSize is not an integer multiple of block size. 137 @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this 138 driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash. 139 **/ 140 typedef 141 EFI_STATUS 142 (EFIAPI *EFI_HASH_HASH)( 143 IN CONST EFI_HASH_PROTOCOL *This, 144 IN CONST EFI_GUID *HashAlgorithm, 145 IN BOOLEAN Extend, 146 IN CONST UINT8 *Message, 147 IN UINT64 MessageSize, 148 IN OUT EFI_HASH_OUTPUT *Hash 149 ); 150 151 /// 152 /// This protocol allows creating a hash of an arbitrary message digest 153 /// using one or more hash algorithms. 154 /// 155 struct _EFI_HASH_PROTOCOL { 156 EFI_HASH_GET_HASH_SIZE GetHashSize; 157 EFI_HASH_HASH Hash; 158 }; 159 160 extern EFI_GUID gEfiHashServiceBindingProtocolGuid; 161 extern EFI_GUID gEfiHashProtocolGuid; 162 extern EFI_GUID gEfiHashAlgorithmSha1Guid; 163 extern EFI_GUID gEfiHashAlgorithmSha224Guid; 164 extern EFI_GUID gEfiHashAlgorithmSha256Guid; 165 extern EFI_GUID gEfiHashAlgorithmSha384Guid; 166 extern EFI_GUID gEfiHashAlgorithmSha512Guid; 167 extern EFI_GUID gEfiHashAlgorithmMD5Guid; 168 extern EFI_GUID gEfiHashAlgorithmSha1NoPadGuid; 169 extern EFI_GUID gEfiHashAlgorithmSha256NoPadGuid; 170 171 #endif 172