2 Image signature database are defined for the signed image validation.
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
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.
13 @par Revision Reference:
14 GUIDs defined in UEFI 2.5 spec.
17 #ifndef __IMAGE_AUTHTICATION_H__
18 #define __IMAGE_AUTHTICATION_H__
20 #include <Guid/GlobalVariable.h>
21 #include <Protocol/Hash.h>
23 #define EFI_IMAGE_SECURITY_DATABASE_GUID \
25 0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \
29 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
30 /// for the authorized signature database.
32 #define EFI_IMAGE_SECURITY_DATABASE L"db"
34 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
35 /// for the forbidden signature database.
37 #define EFI_IMAGE_SECURITY_DATABASE1 L"dbx"
39 /// Variable name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
40 /// for the timestamp signature database.
42 #define EFI_IMAGE_SECURITY_DATABASE2 L"dbt"
44 #define SECURE_BOOT_MODE_ENABLE 1
45 #define SECURE_BOOT_MODE_DISABLE 0
47 /// Depricated value definition for SetupMode variable
52 /// Value definition for SetupMode/DeployedMode/AuditMode variable
54 #define SETUP_MODE_ENABLE 1
55 #define SETUP_MODE_DISABLE 0
56 #define DEPLOYED_MODE_ENABLE 1
57 #define DEPLOYED_MODE_DISABLE 0
58 #define AUDIT_MODE_ENABLE 1
59 #define AUDIT_MODE_DISABLE 0
61 //***********************************************************************
63 //***********************************************************************
65 /// The format of a signature database.
71 /// An identifier which identifies the agent which added the signature to the list.
73 EFI_GUID SignatureOwner
;
75 /// The format of the signature is defined by the SignatureType.
77 UINT8 SignatureData
[1];
82 /// Type of the signature. GUID signature types are defined in below.
84 EFI_GUID SignatureType
;
86 /// Total size of the signature list, including this header.
88 UINT32 SignatureListSize
;
90 /// Size of the signature header which precedes the array of signatures.
92 UINT32 SignatureHeaderSize
;
94 /// Size of each signature.
98 /// Header before the array of signatures. The format of this header is specified
99 /// by the SignatureType.
100 /// UINT8 SignatureHeader[SignatureHeaderSize];
102 /// An array of signatures. Each signature is SignatureSize bytes in length.
103 /// EFI_SIGNATURE_DATA Signatures[][SignatureSize];
105 } EFI_SIGNATURE_LIST
;
109 /// The SHA256 hash of an X.509 certificate's To-Be-Signed contents.
111 EFI_SHA256_HASH ToBeSignedHash
;
113 /// The time that the certificate shall be considered to be revoked.
115 EFI_TIME TimeOfRevocation
;
116 } EFI_CERT_X509_SHA256
;
120 /// The SHA384 hash of an X.509 certificate's To-Be-Signed contents.
122 EFI_SHA384_HASH ToBeSignedHash
;
124 /// The time that the certificate shall be considered to be revoked.
126 EFI_TIME TimeOfRevocation
;
127 } EFI_CERT_X509_SHA384
;
131 /// The SHA512 hash of an X.509 certificate's To-Be-Signed contents.
133 EFI_SHA512_HASH ToBeSignedHash
;
135 /// The time that the certificate shall be considered to be revoked.
137 EFI_TIME TimeOfRevocation
;
138 } EFI_CERT_X509_SHA512
;
143 /// This identifies a signature containing a SHA-256 hash. The SignatureHeader size shall
144 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
147 #define EFI_CERT_SHA256_GUID \
149 0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \
153 /// This identifies a signature containing an RSA-2048 key. The key (only the modulus
154 /// since the public key exponent is known to be 0x10001) shall be stored in big-endian
156 /// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size
157 /// of SignatureOwner component) + 256 bytes.
159 #define EFI_CERT_RSA2048_GUID \
161 0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \
165 /// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash. The
166 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of
167 /// SignatureOwner component) + 256 bytes.
169 #define EFI_CERT_RSA2048_SHA256_GUID \
171 0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \
175 /// This identifies a signature containing a SHA-1 hash. The SignatureSize shall always
176 /// be 16 (size of SignatureOwner component) + 20 bytes.
178 #define EFI_CERT_SHA1_GUID \
180 0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \
184 /// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash. The
185 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of
186 /// SignatureOwner component) + 256 bytes.
188 #define EFI_CERT_RSA2048_SHA1_GUID \
190 0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \
194 /// This identifies a signature based on an X.509 certificate. If the signature is an X.509
195 /// certificate then verification of the signature of an image should validate the public
196 /// key certificate in the image using certificate path verification, up to this X.509
197 /// certificate as a trusted root. The SignatureHeader size shall always be 0. The
198 /// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) +
199 /// the size of the certificate itself.
200 /// Note: This means that each certificate will normally be in a separate EFI_SIGNATURE_LIST.
202 #define EFI_CERT_X509_GUID \
204 0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \
208 /// This identifies a signature containing a SHA-224 hash. The SignatureHeader size shall
209 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
212 #define EFI_CERT_SHA224_GUID \
214 0xb6e5233, 0xa65c, 0x44c9, {0x94, 0x7, 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd} \
218 /// This identifies a signature containing a SHA-384 hash. The SignatureHeader size shall
219 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
222 #define EFI_CERT_SHA384_GUID \
224 0xff3e5307, 0x9fd0, 0x48c9, {0x85, 0xf1, 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x1} \
228 /// This identifies a signature containing a SHA-512 hash. The SignatureHeader size shall
229 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
232 #define EFI_CERT_SHA512_GUID \
234 0x93e0fae, 0xa6c4, 0x4f50, {0x9f, 0x1b, 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a} \
238 /// This identifies a signature containing the SHA256 hash of an X.509 certificate's
239 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall
240 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)
241 /// + 48 bytes for an EFI_CERT_X509_SHA256 structure. If the TimeOfRevocation is non-zero,
242 /// the certificate should be considered to be revoked from that time and onwards, and
243 /// otherwise the certificate shall be considered to always be revoked.
245 #define EFI_CERT_X509_SHA256_GUID \
247 0x3bd2a492, 0x96c0, 0x4079, {0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed } \
251 /// This identifies a signature containing the SHA384 hash of an X.509 certificate's
252 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall
253 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)
254 /// + 64 bytes for an EFI_CERT_X509_SHA384 structure. If the TimeOfRevocation is non-zero,
255 /// the certificate should be considered to be revoked from that time and onwards, and
256 /// otherwise the certificate shall be considered to always be revoked.
258 #define EFI_CERT_X509_SHA384_GUID \
260 0x7076876e, 0x80c2, 0x4ee6, {0xaa, 0xd2, 0x28, 0xb3, 0x49, 0xa6, 0x86, 0x5b } \
264 /// This identifies a signature containing the SHA512 hash of an X.509 certificate's
265 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall
266 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)
267 /// + 80 bytes for an EFI_CERT_X509_SHA512 structure. If the TimeOfRevocation is non-zero,
268 /// the certificate should be considered to be revoked from that time and onwards, and
269 /// otherwise the certificate shall be considered to always be revoked.
271 #define EFI_CERT_X509_SHA512_GUID \
273 0x446dbf63, 0x2502, 0x4cda, {0xbc, 0xfa, 0x24, 0x65, 0xd2, 0xb0, 0xfe, 0x9d } \
277 /// This identifies a signature containing a DER-encoded PKCS #7 version 1.5 [RFC2315]
278 /// SignedData value.
280 #define EFI_CERT_TYPE_PKCS7_GUID \
282 0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7} \
285 //***********************************************************************
286 // Image Execution Information Table Definition
287 //***********************************************************************
288 typedef UINT32 EFI_IMAGE_EXECUTION_ACTION
;
290 #define EFI_IMAGE_EXECUTION_AUTHENTICATION 0x00000007
291 #define EFI_IMAGE_EXECUTION_AUTH_UNTESTED 0x00000000
292 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED 0x00000001
293 #define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED 0x00000002
294 #define EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND 0x00000003
295 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND 0x00000004
296 #define EFI_IMAGE_EXECUTION_POLICY_FAILED 0x00000005
297 #define EFI_IMAGE_EXECUTION_INITIALIZED 0x00000008
300 // EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table
301 // and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID.
305 /// Describes the action taken by the firmware regarding this image.
307 EFI_IMAGE_EXECUTION_ACTION Action
;
309 /// Size of all of the entire structure.
313 /// If this image was a UEFI device driver (for option ROM, for example) this is the
314 /// null-terminated, user-friendly name for the device. If the image was for an application,
315 /// then this is the name of the application. If this cannot be determined, then a simple
316 /// NULL character should be put in this position.
321 /// For device drivers, this is the device path of the device for which this device driver
322 /// was intended. In some cases, the driver itself may be stored as part of the system
323 /// firmware, but this field should record the device's path, not the firmware path. For
324 /// applications, this is the device path of the application. If this cannot be determined,
325 /// a simple end-of-path device node should be put in this position.
326 /// EFI_DEVICE_PATH_PROTOCOL DevicePath;
330 /// Zero or more image signatures. If the image contained no signatures,
331 /// then this field is empty.
332 /// EFI_SIGNATURE_LIST Signature;
334 } EFI_IMAGE_EXECUTION_INFO
;
339 /// Number of EFI_IMAGE_EXECUTION_INFO structures.
341 UINTN NumberOfImages
;
343 /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures.
345 // EFI_IMAGE_EXECUTION_INFO InformationInfo[]
346 } EFI_IMAGE_EXECUTION_INFO_TABLE
;
348 extern EFI_GUID gEfiImageSecurityDatabaseGuid
;
349 extern EFI_GUID gEfiCertSha256Guid
;
350 extern EFI_GUID gEfiCertRsa2048Guid
;
351 extern EFI_GUID gEfiCertRsa2048Sha256Guid
;
352 extern EFI_GUID gEfiCertSha1Guid
;
353 extern EFI_GUID gEfiCertRsa2048Sha1Guid
;
354 extern EFI_GUID gEfiCertX509Guid
;
355 extern EFI_GUID gEfiCertSha224Guid
;
356 extern EFI_GUID gEfiCertSha384Guid
;
357 extern EFI_GUID gEfiCertSha512Guid
;
358 extern EFI_GUID gEfiCertX509Sha256Guid
;
359 extern EFI_GUID gEfiCertX509Sha384Guid
;
360 extern EFI_GUID gEfiCertX509Sha512Guid
;
361 extern EFI_GUID gEfiCertPkcs7Guid
;