4f4296086d75c6c1e99d3aa17a3da904d184847a
[mirror_edk2.git] / MdePkg / Include / Guid / ImageAuthentication.h
1 /** @file
2 Image signature database are defined for the signed image validation.
3
4 Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 @par Revision Reference:
14 GUIDs defined in UEFI 2.5 spec.
15 **/
16
17 #ifndef __IMAGE_AUTHTICATION_H__
18 #define __IMAGE_AUTHTICATION_H__
19
20 #include <Guid/GlobalVariable.h>
21 #include <Protocol/Hash.h>
22
23 #define EFI_IMAGE_SECURITY_DATABASE_GUID \
24 { \
25 0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \
26 }
27
28 ///
29 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
30 /// for the authorized signature database.
31 ///
32 #define EFI_IMAGE_SECURITY_DATABASE L"db"
33 ///
34 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
35 /// for the forbidden signature database.
36 ///
37 #define EFI_IMAGE_SECURITY_DATABASE1 L"dbx"
38 ///
39 /// Variable name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
40 /// for the timestamp signature database.
41 ///
42 #define EFI_IMAGE_SECURITY_DATABASE2 L"dbt"
43
44 #define SECURE_BOOT_MODE_ENABLE 1
45 #define SECURE_BOOT_MODE_DISABLE 0
46 #define SETUP_MODE 1
47 #define USER_MODE 0
48
49
50 //***********************************************************************
51 // Signature Database
52 //***********************************************************************
53 ///
54 /// The format of a signature database.
55 ///
56 #pragma pack(1)
57
58 typedef struct {
59 ///
60 /// An identifier which identifies the agent which added the signature to the list.
61 ///
62 EFI_GUID SignatureOwner;
63 ///
64 /// The format of the signature is defined by the SignatureType.
65 ///
66 UINT8 SignatureData[1];
67 } EFI_SIGNATURE_DATA;
68
69 typedef struct {
70 ///
71 /// Type of the signature. GUID signature types are defined in below.
72 ///
73 EFI_GUID SignatureType;
74 ///
75 /// Total size of the signature list, including this header.
76 ///
77 UINT32 SignatureListSize;
78 ///
79 /// Size of the signature header which precedes the array of signatures.
80 ///
81 UINT32 SignatureHeaderSize;
82 ///
83 /// Size of each signature.
84 ///
85 UINT32 SignatureSize;
86 ///
87 /// Header before the array of signatures. The format of this header is specified
88 /// by the SignatureType.
89 /// UINT8 SignatureHeader[SignatureHeaderSize];
90 ///
91 /// An array of signatures. Each signature is SignatureSize bytes in length.
92 /// EFI_SIGNATURE_DATA Signatures[][SignatureSize];
93 ///
94 } EFI_SIGNATURE_LIST;
95
96 typedef struct {
97 ///
98 /// The SHA256 hash of an X.509 certificate's To-Be-Signed contents.
99 ///
100 EFI_SHA256_HASH ToBeSignedHash;
101 ///
102 /// The time that the certificate shall be considered to be revoked.
103 ///
104 EFI_TIME TimeOfRevocation;
105 } EFI_CERT_X509_SHA256;
106
107 typedef struct {
108 ///
109 /// The SHA384 hash of an X.509 certificate's To-Be-Signed contents.
110 ///
111 EFI_SHA384_HASH ToBeSignedHash;
112 ///
113 /// The time that the certificate shall be considered to be revoked.
114 ///
115 EFI_TIME TimeOfRevocation;
116 } EFI_CERT_X509_SHA384;
117
118 typedef struct {
119 ///
120 /// The SHA512 hash of an X.509 certificate's To-Be-Signed contents.
121 ///
122 EFI_SHA512_HASH ToBeSignedHash;
123 ///
124 /// The time that the certificate shall be considered to be revoked.
125 ///
126 EFI_TIME TimeOfRevocation;
127 } EFI_CERT_X509_SHA512;
128
129 #pragma pack()
130
131 ///
132 /// This identifies a signature containing a SHA-256 hash. The SignatureHeader size shall
133 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
134 /// 32 bytes.
135 ///
136 #define EFI_CERT_SHA256_GUID \
137 { \
138 0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \
139 }
140
141 ///
142 /// This identifies a signature containing an RSA-2048 key. The key (only the modulus
143 /// since the public key exponent is known to be 0x10001) shall be stored in big-endian
144 /// order.
145 /// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size
146 /// of SignatureOwner component) + 256 bytes.
147 ///
148 #define EFI_CERT_RSA2048_GUID \
149 { \
150 0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \
151 }
152
153 ///
154 /// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash. The
155 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of
156 /// SignatureOwner component) + 256 bytes.
157 ///
158 #define EFI_CERT_RSA2048_SHA256_GUID \
159 { \
160 0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \
161 }
162
163 ///
164 /// This identifies a signature containing a SHA-1 hash. The SignatureSize shall always
165 /// be 16 (size of SignatureOwner component) + 20 bytes.
166 ///
167 #define EFI_CERT_SHA1_GUID \
168 { \
169 0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \
170 }
171
172 ///
173 /// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash. The
174 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of
175 /// SignatureOwner component) + 256 bytes.
176 ///
177 #define EFI_CERT_RSA2048_SHA1_GUID \
178 { \
179 0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \
180 }
181
182 ///
183 /// This identifies a signature based on an X.509 certificate. If the signature is an X.509
184 /// certificate then verification of the signature of an image should validate the public
185 /// key certificate in the image using certificate path verification, up to this X.509
186 /// certificate as a trusted root. The SignatureHeader size shall always be 0. The
187 /// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) +
188 /// the size of the certificate itself.
189 /// Note: This means that each certificate will normally be in a separate EFI_SIGNATURE_LIST.
190 ///
191 #define EFI_CERT_X509_GUID \
192 { \
193 0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \
194 }
195
196 ///
197 /// This identifies a signature containing a SHA-224 hash. The SignatureHeader size shall
198 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
199 /// 28 bytes.
200 ///
201 #define EFI_CERT_SHA224_GUID \
202 { \
203 0xb6e5233, 0xa65c, 0x44c9, {0x94, 0x7, 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd} \
204 }
205
206 ///
207 /// This identifies a signature containing a SHA-384 hash. The SignatureHeader size shall
208 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
209 /// 48 bytes.
210 ///
211 #define EFI_CERT_SHA384_GUID \
212 { \
213 0xff3e5307, 0x9fd0, 0x48c9, {0x85, 0xf1, 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x1} \
214 }
215
216 ///
217 /// This identifies a signature containing a SHA-512 hash. The SignatureHeader size shall
218 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
219 /// 64 bytes.
220 ///
221 #define EFI_CERT_SHA512_GUID \
222 { \
223 0x93e0fae, 0xa6c4, 0x4f50, {0x9f, 0x1b, 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a} \
224 }
225
226 ///
227 /// This identifies a signature containing the SHA256 hash of an X.509 certificate's
228 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall
229 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)
230 /// + 48 bytes for an EFI_CERT_X509_SHA256 structure. If the TimeOfRevocation is non-zero,
231 /// the certificate should be considered to be revoked from that time and onwards, and
232 /// otherwise the certificate shall be considered to always be revoked.
233 ///
234 #define EFI_CERT_X509_SHA256_GUID \
235 { \
236 0x3bd2a492, 0x96c0, 0x4079, {0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed } \
237 }
238
239 ///
240 /// This identifies a signature containing the SHA384 hash of an X.509 certificate's
241 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall
242 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)
243 /// + 64 bytes for an EFI_CERT_X509_SHA384 structure. If the TimeOfRevocation is non-zero,
244 /// the certificate should be considered to be revoked from that time and onwards, and
245 /// otherwise the certificate shall be considered to always be revoked.
246 ///
247 #define EFI_CERT_X509_SHA384_GUID \
248 { \
249 0x7076876e, 0x80c2, 0x4ee6, {0xaa, 0xd2, 0x28, 0xb3, 0x49, 0xa6, 0x86, 0x5b } \
250 }
251
252 ///
253 /// This identifies a signature containing the SHA512 hash of an X.509 certificate's
254 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall
255 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)
256 /// + 80 bytes for an EFI_CERT_X509_SHA512 structure. If the TimeOfRevocation is non-zero,
257 /// the certificate should be considered to be revoked from that time and onwards, and
258 /// otherwise the certificate shall be considered to always be revoked.
259 ///
260 #define EFI_CERT_X509_SHA512_GUID \
261 { \
262 0x446dbf63, 0x2502, 0x4cda, {0xbc, 0xfa, 0x24, 0x65, 0xd2, 0xb0, 0xfe, 0x9d } \
263 }
264
265 ///
266 /// This identifies a signature containing a DER-encoded PKCS #7 version 1.5 [RFC2315]
267 /// SignedData value.
268 ///
269 #define EFI_CERT_TYPE_PKCS7_GUID \
270 { \
271 0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7} \
272 }
273
274 //***********************************************************************
275 // Image Execution Information Table Definition
276 //***********************************************************************
277 typedef UINT32 EFI_IMAGE_EXECUTION_ACTION;
278
279 #define EFI_IMAGE_EXECUTION_AUTHENTICATION 0x00000007
280 #define EFI_IMAGE_EXECUTION_AUTH_UNTESTED 0x00000000
281 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED 0x00000001
282 #define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED 0x00000002
283 #define EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND 0x00000003
284 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND 0x00000004
285 #define EFI_IMAGE_EXECUTION_POLICY_FAILED 0x00000005
286 #define EFI_IMAGE_EXECUTION_INITIALIZED 0x00000008
287
288 //
289 // EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table
290 // and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID.
291 //
292 typedef struct {
293 ///
294 /// Describes the action taken by the firmware regarding this image.
295 ///
296 EFI_IMAGE_EXECUTION_ACTION Action;
297 ///
298 /// Size of all of the entire structure.
299 ///
300 UINT32 InfoSize;
301 ///
302 /// If this image was a UEFI device driver (for option ROM, for example) this is the
303 /// null-terminated, user-friendly name for the device. If the image was for an application,
304 /// then this is the name of the application. If this cannot be determined, then a simple
305 /// NULL character should be put in this position.
306 /// CHAR16 Name[];
307 ///
308
309 ///
310 /// For device drivers, this is the device path of the device for which this device driver
311 /// was intended. In some cases, the driver itself may be stored as part of the system
312 /// firmware, but this field should record the device's path, not the firmware path. For
313 /// applications, this is the device path of the application. If this cannot be determined,
314 /// a simple end-of-path device node should be put in this position.
315 /// EFI_DEVICE_PATH_PROTOCOL DevicePath;
316 ///
317
318 ///
319 /// Zero or more image signatures. If the image contained no signatures,
320 /// then this field is empty.
321 /// EFI_SIGNATURE_LIST Signature;
322 ///
323 } EFI_IMAGE_EXECUTION_INFO;
324
325
326 typedef struct {
327 ///
328 /// Number of EFI_IMAGE_EXECUTION_INFO structures.
329 ///
330 UINTN NumberOfImages;
331 ///
332 /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures.
333 ///
334 // EFI_IMAGE_EXECUTION_INFO InformationInfo[]
335 } EFI_IMAGE_EXECUTION_INFO_TABLE;
336
337 extern EFI_GUID gEfiImageSecurityDatabaseGuid;
338 extern EFI_GUID gEfiCertSha256Guid;
339 extern EFI_GUID gEfiCertRsa2048Guid;
340 extern EFI_GUID gEfiCertRsa2048Sha256Guid;
341 extern EFI_GUID gEfiCertSha1Guid;
342 extern EFI_GUID gEfiCertRsa2048Sha1Guid;
343 extern EFI_GUID gEfiCertX509Guid;
344 extern EFI_GUID gEfiCertSha224Guid;
345 extern EFI_GUID gEfiCertSha384Guid;
346 extern EFI_GUID gEfiCertSha512Guid;
347 extern EFI_GUID gEfiCertX509Sha256Guid;
348 extern EFI_GUID gEfiCertX509Sha384Guid;
349 extern EFI_GUID gEfiCertX509Sha512Guid;
350 extern EFI_GUID gEfiCertPkcs7Guid;
351
352 #endif