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