]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Guid/ImageAuthentication.h
1. Add TCG MOR (Memory Overwrite request) definition from TCG Platform Reset Attack...
[mirror_edk2.git] / MdePkg / Include / Guid / ImageAuthentication.h
diff --git a/MdePkg/Include/Guid/ImageAuthentication.h b/MdePkg/Include/Guid/ImageAuthentication.h
new file mode 100644 (file)
index 0000000..b965a42
--- /dev/null
@@ -0,0 +1,221 @@
+/** @file\r
+  Platform Key, Key Exchange Key, and Image signature database are defined \r
+  for the signed image validation.\r
+\r
+  Copyright (c) 2009, Intel Corporation\r
+  All rights reserved. This program and the accompanying materials                          \r
+  are licensed and made available under the terms and conditions of the BSD License         \r
+  which accompanies this distribution.  The full text of the license may be found at        \r
+  http://opensource.org/licenses/bsd-license.php                                            \r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+\r
+  @par Revision Reference:\r
+  GUIDs defined in UEFI 2.2 spec.\r
+**/\r
+\r
+#ifndef __IMAGE_AUTHTICATION_H__\r
+#define __IMAGE_AUTHTICATION_H__\r
+\r
+#include <Guid/GlobalVariable.h>\r
+\r
+#define EFI_IMAGE_SECURITY_DATABASE_GUID \\r
+  { \\r
+    0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \\r
+  }\r
+\r
+///\r
+/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID \r
+/// for the authorized signature database.\r
+///\r
+#define EFI_IMAGE_SECURITY_DATABASE       L"db"\r
+///\r
+/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID \r
+/// for the forbidden signature database.\r
+///\r
+#define EFI_IMAGE_SECURITY_DATABASE1      L"dbx"\r
+\r
+#define SETUP_MODE                        1\r
+#define USER_MODE                         0\r
+///\r
+/// Globally "SetupMode" variable to specify whether the system is currently operating \r
+/// in setup mode (1) or not (0). All other values are reserved.\r
+///\r
+#define EFI_SETUP_MODE_NAME               L"SetupMode"\r
+///\r
+/// Globally "PK" variable for the Platform Key Signature Database.\r
+///\r
+#define EFI_PLATFORM_KEY_NAME             L"PK"\r
+///\r
+/// Globally "KEK" variable for the Key Exchange Key Signature Database.\r
+///\r
+#define EFI_KEY_EXCHANGE_KEY_NAME         L"KEK"\r
+///\r
+/// Globally "SignatureSupport" variable returns an array of GUIDs, \r
+/// with each GUID representing a type of signature which the platform \r
+/// firmware supports for images and other data.\r
+///\r
+#define EFI_SIGNATURE_SUPPORT_NAME        L"SignatureSupport"\r
+\r
+//***********************************************************************\r
+// Signature Database\r
+//***********************************************************************\r
+///\r
+/// The format of a signature database. \r
+///\r
+#pragma pack(1)\r
+\r
+typedef struct {\r
+  ///\r
+  /// An identifier which identifies the agent which added the signature to the list.\r
+  ///\r
+  EFI_GUID             SignatureOwner;\r
+  ///\r
+  /// The format of the signature is defined by the SignatureType.\r
+  ///\r
+  UINT8                          SignatureData[1];\r
+} EFI_SIGNATURE_DATA;\r
+\r
+typedef struct {\r
+  ///\r
+  /// Type of the signature. GUID signature types are defined in below.\r
+  ///\r
+  EFI_GUID             SignatureType;\r
+  ///\r
+  /// Total size of the signature list, including this header.\r
+  ///\r
+  UINT32               SignatureListSize;\r
+  ///\r
+  /// Size of the signature header which precedes the array of signatures.\r
+  ///\r
+  UINT32               SignatureHeaderSize;\r
+  ///\r
+  /// Size of each signature.\r
+  ///\r
+  UINT32              SignatureSize; \r
+  ///\r
+  /// Header before the array of signatures. The format of this header is specified \r
+  /// by the SignatureType.\r
+  /// UINT8           SignatureHeader[SignatureHeaderSize];\r
+  ///\r
+  /// An array of signatures. Each signature is SignatureSize bytes in length. \r
+  /// EFI_SIGNATURE_DATA Signatures[][SignatureSize];\r
+  ///\r
+} EFI_SIGNATURE_LIST;\r
+\r
+#pragma pack()\r
+\r
+///\r
+/// This identifies a signature containing a SHA-256 hash. The SignatureHeader size should \r
+/// always be 0.  The SignatureSize should always be 32 bytes.\r
+///\r
+#define EFI_CERT_SHA256_GUID \\r
+  { \\r
+    0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \\r
+  }\r
+\r
+///\r
+/// This identifies a signature containing an RSA-2048 key. The SignatureHeader size should \r
+/// always be 0. The SignatureSize should always be 256 bytes.\r
+///\r
+#define EFI_CERT_RSA2048_GUID \\r
+  { \\r
+    0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \\r
+  }\r
+\r
+///\r
+/// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash. The \r
+/// SignatureHeader size should always be 0. The SignatureSize should always be 256 bytes.\r
+///\r
+#define EFI_CERT_RSA2048_SHA256_GUID \\r
+  { \\r
+    0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \\r
+  }\r
+\r
+///\r
+/// This identifies a signature containing a SHA-1 hash.  The SignatureHeader size should always\r
+/// be 0. The SignatureSize should always be 20 bytes\r
+///\r
+#define EFI_CERT_SHA1_GUID \\r
+  { \\r
+    0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \\r
+  }\r
+\r
+///\r
+/// This identifies a signature containing a RSA-2048 signature of a SHA-1 hash. The \r
+/// SignatureHeader size should always be 0. The SignatureSize should always be 256 bytes.\r
+///\r
+#define EFI_CERT_RSA2048_SHA1_GUID \\r
+  { \\r
+    0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \\r
+  }\r
+\r
+///\r
+/// This identifies a signature based on an X.509 certificate. If the signature is an X.509 certificate then \r
+/// verification of the signature of an image should validate the public key certificate in the image using \r
+/// certificate path verification, up to this X.509 certificate as a trusted root.\r
+///\r
+#define EFI_CERT_X509 \\r
+  { \\r
+    0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \\r
+  }\r
+\r
+//***********************************************************************\r
+// Image Execution Information Table Definition\r
+//***********************************************************************\r
+typedef UINT32 EFI_IMAGE_EXECUTION_ACTION;\r
+\r
+#define EFI_IMAGE_EXECUTION_AUTHENTICATION          0x00000007 \r
+\r
+//\r
+// EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table \r
+// and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID.\r
+//\r
+typedef struct {\r
+  ///\r
+  /// Describes the action taken by the firmware regarding this image.\r
+  ///\r
+  EFI_IMAGE_EXECUTION_ACTION     Action;\r
+  ///\r
+  /// Size of all of the entire structure.\r
+  ///\r
+  UINT32                        InfoSize;\r
+  ///\r
+  /// If this image was a UEFI device driver (for option ROM, for example) this is the \r
+  /// null-terminated, user-friendly name for the device. If the image was for an application, \r
+  /// then this is the name of the application. If this cannot be determined, then a simple \r
+  /// NULL character should be put in this position.\r
+  /// CHAR16                    Name[];\r
+  ///\r
+\r
+  ///\r
+  /// For device drivers, this is the device path of the device for which this device driver \r
+  /// was intended. In some cases, the driver itself may be stored as part of the system \r
+  /// firmware, but this field should record the device's path, not the firmware path. For \r
+  /// applications, this is the device path of the application. If this cannot be determined, \r
+  /// a simple end-of-path device node should be put in this position.\r
+  /// EFI_DEVICE_PATH_PROTOCOL  DevicePath;\r
+  ///\r
+\r
+  ///\r
+  /// The image digest of the image. The certificate type must be one of the hash types. \r
+  /// The hash type must match the type used in the Signature field.\r
+  ///\r
+  WIN_CERTIFICATE               ImageHash;\r
+  ///\r
+  /// Zero or more image signatures. If the image contained no signtures, \r
+  /// then this field is empty.\r
+  ///\r
+  WIN_CERTIFICATE               Signature;\r
+} EFI_IMAGE_EXECUTION_INFO;\r
+\r
+extern EFI_GUID gEfiImageSecurityDatabaseGuid;\r
+extern EFI_GUID gEfiCertSha256Guid;\r
+extern EFI_GUID gEfiCertRsa2048Guid;      \r
+extern EFI_GUID gEfiCertRsa2048Sha256Guid;\r
+extern EFI_GUID gEfiCertSha1Guid;\r
+extern EFI_GUID gEfiCertRsa2048Sha1Guid;\r
+extern EFI_GUID gEfiCertX509Guid;\r
+\r
+#endif\r