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