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