1 /** 2 Based on Protocol/Hash.h, original notice: 3 4 EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0. 5 EFI_HASH_PROTOCOL as defined in UEFI 2.0. 6 The EFI Hash Service Binding Protocol is used to locate hashing services support 7 provided by a driver and to create and destroy instances of the EFI Hash Protocol 8 so that a multiple drivers can use the underlying hashing services. 9 10 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved. 11 This program and the accompanying materials are licensed and made available under 12 the terms and conditions of the BSD License that accompanies this distribution. 13 The full text of the license may be found at 14 http://opensource.org/licenses/bsd-license.php. 15 16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 18 19 **/ 20 module uefi.protocols.hash; 21 import uefi.base; 22 import uefi.base_type; 23 24 public: 25 extern (C): 26 enum EFI_GUID EFI_HASH_SERVICE_BINDING_PROTOCOL_GUID = EFI_GUID(0x42881c98, 27 0xa4f3, 0x44b0, [0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd]); 28 enum EFI_GUID EFI_HASH_PROTOCOL_GUID = EFI_GUID(0xc5184932, 0xdba5, 0x46db, 29 [0xa5, 0xba, 0xcc, 0x0b, 0xda, 0x9c, 0x14, 0x35]); 30 enum EFI_GUID EFI_HASH_ALGORITHM_SHA1_GUID = EFI_GUID(0x2ae9d80f, 0x3fb2, 31 0x4095, [0xb7, 0xb1, 0xe9, 0x31, 0x57, 0xb9, 0x46, 0xb6]); 32 enum EFI_GUID EFI_HASH_ALGORITHM_SHA224_GUID = EFI_GUID(0x8df01a06, 0x9bd5, 33 0x4bf7, [0xb0, 0x21, 0xdb, 0x4f, 0xd9, 0xcc, 0xf4, 0x5b]); 34 enum EFI_GUID EFI_HASH_ALGORITHM_SHA256_GUID = EFI_GUID(0x51aa59de, 0xfdf2, 35 0x4ea3, [0xbc, 0x63, 0x87, 0x5f, 0xb7, 0x84, 0x2e, 0xe9]); 36 enum EFI_GUID EFI_HASH_ALGORITHM_SHA384_GUID = EFI_GUID(0xefa96432, 0xde33, 37 0x4dd2, [0xae, 0xe6, 0x32, 0x8c, 0x33, 0xdf, 0x77, 0x7a]); 38 enum EFI_GUID EFI_HASH_ALGORITHM_SHA512_GUID = EFI_GUID(0xcaa4381e, 0x750c, 39 0x4770, [0xb8, 0x70, 0x7a, 0x23, 0xb4, 0xe4, 0x21, 0x30]); 40 enum EFI_GUID EFI_HASH_ALGORTIHM_MD5_GUID = EFI_GUID(0xaf7c79c, 0x65b5, 0x4319, 41 [0xb0, 0xae, 0x44, 0xec, 0x48, 0x4e, 0x4a, 0xd7]); 42 enum EFI_GUID EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID = EFI_GUID(0x24c5dc2f, 0x53e2, 43 0x40ca, [0x9e, 0xd6, 0xa5, 0xd9, 0xa4, 0x9f, 0x46, 0x3b]); 44 enum EFI_GUID EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID = EFI_GUID(0x8628752a, 45 0x6cb7, 0x4814, [0x96, 0xfc, 0x24, 0xa8, 0x15, 0xac, 0x22, 0x26]); 46 alias EFI_HASH_PROTOCOL = _EFI_HASH_PROTOCOL; 47 alias EFI_MD5_HASH = UINT8[16]; 48 alias EFI_SHA1_HASH = UINT8[20]; 49 alias EFI_SHA224_HASH = UINT8[28]; 50 alias EFI_SHA256_HASH = UINT8[32]; 51 alias EFI_SHA384_HASH = UINT8[48]; 52 alias EFI_SHA512_HASH = UINT8[64]; 53 union EFI_HASH_OUTPUT 54 { 55 EFI_MD5_HASH* Md5Hash; 56 EFI_SHA1_HASH* Sha1Hash; 57 EFI_SHA224_HASH* Sha224Hash; 58 EFI_SHA256_HASH* Sha256Hash; 59 EFI_SHA384_HASH* Sha384Hash; 60 EFI_SHA512_HASH* Sha512Hash; 61 } 62 /** 63 Returns the size of the hash which results from a specific algorithm. 64 65 @param[in] This Points to this instance of EFI_HASH_PROTOCOL. 66 @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. 67 @param[out] HashSize Holds the returned size of the algorithm's hash. 68 69 @retval EFI_SUCCESS Hash size returned successfully. 70 @retval EFI_INVALID_PARAMETER HashSize is NULL or HashAlgorithm is NULL. 71 @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported 72 by this driver. 73 74 **/ 75 alias EFI_HASH_GET_HASH_SIZE = EFI_STATUS function(const EFI_HASH_PROTOCOL* This, 76 const EFI_GUID* HashAlgorithm, UINTN* HashSize) @nogc nothrow; 77 /** 78 Creates a hash for the specified message text. 79 80 @param[in] This Points to this instance of EFI_HASH_PROTOCOL. 81 @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. 82 @param[in] Extend Specifies whether to create a new hash (FALSE) or extend the specified 83 existing hash (TRUE). 84 @param[in] Message Points to the start of the message. 85 @param[in] MessageSize The size of Message, in bytes. 86 @param[in,out] Hash On input, if Extend is TRUE, then this parameter holds a pointer 87 to a pointer to an array containing the hash to extend. If Extend 88 is FALSE, then this parameter holds a pointer to a pointer to a 89 caller-allocated array that will receive the result of the hash 90 computation. On output (regardless of the value of Extend), the 91 array will contain the result of the hash computation. 92 93 @retval EFI_SUCCESS Hash returned successfully. 94 @retval EFI_INVALID_PARAMETER Message or Hash, HashAlgorithm is NULL or MessageSize is 0. 95 MessageSize is not an integer multiple of block size. 96 @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this 97 driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash. 98 99 **/ 100 alias EFI_HASH_HASH = EFI_STATUS function(const EFI_HASH_PROTOCOL* This, 101 const EFI_GUID* HashAlgorithm, BOOLEAN Extend, const UINT8* Message, 102 UINT64 MessageSize, EFI_HASH_OUTPUT* Hash) @nogc nothrow; 103 /// This protocol allows creating a hash of an arbitrary message digest 104 /// using one or more hash algorithms. 105 struct _EFI_HASH_PROTOCOL 106 { 107 EFI_HASH_GET_HASH_SIZE GetHashSize; 108 EFI_HASH_HASH Hash; 109 110 }