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