2 The internal header file includes the common header files, defines
3 internal structure and functions used by ImageVerificationLib.
5 Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __IMAGEVERIFICATIONLIB_H__
17 #define __IMAGEVERIFICATIONLIB_H__
19 #include <Library/UefiDriverEntryPoint.h>
20 #include <Library/DebugLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/UefiBootServicesTableLib.h>
23 #include <Library/UefiRuntimeServicesTableLib.h>
24 #include <Library/UefiLib.h>
25 #include <Library/BaseLib.h>
26 #include <Library/MemoryAllocationLib.h>
27 #include <Library/BaseCryptLib.h>
28 #include <Library/PcdLib.h>
29 #include <Library/DevicePathLib.h>
30 #include <Library/SecurityManagementLib.h>
31 #include <Protocol/FirmwareVolume2.h>
32 #include <Protocol/DevicePath.h>
33 #include <Protocol/BlockIo.h>
34 #include <Protocol/SimpleFileSystem.h>
35 #include <Protocol/VariableWrite.h>
36 #include <Guid/ImageAuthentication.h>
37 #include <Guid/AuthenticatedVariableFormat.h>
38 #include <IndustryStandard/PeImage.h>
40 #define EFI_CERT_TYPE_RSA2048_SHA256_SIZE 256
41 #define EFI_CERT_TYPE_RSA2048_SIZE 256
42 #define MAX_NOTIFY_STRING_LEN 64
45 // Image type definitions
47 #define IMAGE_UNKNOWN 0x00000000
48 #define IMAGE_FROM_FV 0x00000001
49 #define IMAGE_FROM_OPTION_ROM 0x00000002
50 #define IMAGE_FROM_REMOVABLE_MEDIA 0x00000003
51 #define IMAGE_FROM_FIXED_MEDIA 0x00000004
54 // Authorization policy bit definition
56 #define ALWAYS_EXECUTE 0x00000000
57 #define NEVER_EXECUTE 0x00000001
58 #define ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002
59 #define DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003
60 #define DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004
61 #define QUERY_USER_ON_SECURITY_VIOLATION 0x00000005
66 #define HASHALG_SHA1 0x00000000
67 #define HASHALG_SHA224 0x00000001
68 #define HASHALG_SHA256 0x00000002
69 #define HASHALG_SHA384 0x00000003
70 #define HASHALG_SHA512 0x00000004
71 #define HASHALG_MAX 0x00000005
74 // Set max digest size as SHA256 Output (32 bytes) by far
76 #define MAX_DIGEST_SIZE SHA256_DIGEST_SIZE
79 // PKCS7 Certificate definition
84 } WIN_CERTIFICATE_EFI_PKCS
;
88 Retrieves the size, in bytes, of the context buffer required for hash operations.
90 @return The size, in bytes, of the context buffer required for hash operations.
95 (EFIAPI
*HASH_GET_CONTEXT_SIZE
)(
100 Initializes user-supplied memory pointed by HashContext as hash context for
103 If HashContext is NULL, then ASSERT().
105 @param[in, out] HashContext Pointer to Context being initialized.
107 @retval TRUE HASH context initialization succeeded.
108 @retval FALSE HASH context initialization failed.
114 IN OUT VOID
*HashContext
119 Performs digest on a data buffer of the specified length. This function can
120 be called multiple times to compute the digest of long or discontinuous data streams.
122 If HashContext is NULL, then ASSERT().
124 @param[in, out] HashContext Pointer to the MD5 context.
125 @param[in] Data Pointer to the buffer containing the data to be hashed.
126 @param[in] DataLength Length of Data buffer in bytes.
128 @retval TRUE HASH data digest succeeded.
129 @retval FALSE Invalid HASH context. After HashFinal function has been called, the
130 HASH context cannot be reused.
135 (EFIAPI
*HASH_UPDATE
)(
136 IN OUT VOID
*HashContext
,
142 Completes hash computation and retrieves the digest value into the specified
143 memory. After this function has been called, the context cannot be used again.
145 If HashContext is NULL, then ASSERT().
146 If HashValue is NULL, then ASSERT().
148 @param[in, out] HashContext Pointer to the MD5 context
149 @param[out] HashValue Pointer to a buffer that receives the HASH digest
152 @retval TRUE HASH digest computation succeeded.
153 @retval FALSE HASH digest computation failed.
158 (EFIAPI
*HASH_FINAL
)(
159 IN OUT VOID
*HashContext
,
165 // Hash Algorithm Table
169 // Name for Hash Algorithm
177 // Hash Algorithm OID ASN.1 Value
181 // Length of Hash OID Value
185 // Pointer to Hash GetContentSize function
187 HASH_GET_CONTEXT_SIZE GetContextSize
;
189 // Pointer to Hash Init function
193 // Pointer to Hash Update function
195 HASH_UPDATE HashUpdate
;
197 // Pointer to Hash Final function
199 HASH_FINAL HashFinal
;