2 The header file of HII Config Access protocol implementation of SecureBoot
5 Copyright (c) 2011 - 2017, 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 __SECUREBOOT_CONFIG_IMPL_H__
17 #define __SECUREBOOT_CONFIG_IMPL_H__
21 #include <Protocol/HiiConfigAccess.h>
22 #include <Protocol/HiiConfigRouting.h>
23 #include <Protocol/SimpleFileSystem.h>
24 #include <Protocol/BlockIo.h>
25 #include <Protocol/DevicePath.h>
26 #include <Protocol/DebugPort.h>
27 #include <Protocol/LoadFile.h>
29 #include <Library/BaseLib.h>
30 #include <Library/BaseMemoryLib.h>
31 #include <Library/DebugLib.h>
32 #include <Library/MemoryAllocationLib.h>
33 #include <Library/UefiBootServicesTableLib.h>
34 #include <Library/UefiRuntimeServicesTableLib.h>
35 #include <Library/UefiHiiServicesLib.h>
36 #include <Library/UefiLib.h>
37 #include <Library/HiiLib.h>
38 #include <Library/DevicePathLib.h>
39 #include <Library/PrintLib.h>
40 #include <Library/PlatformSecureLib.h>
41 #include <Library/BaseCryptLib.h>
42 #include <Library/FileExplorerLib.h>
43 #include <Library/PeCoffLib.h>
45 #include <Guid/MdeModuleHii.h>
46 #include <Guid/AuthenticatedVariableFormat.h>
47 #include <Guid/FileSystemVolumeLabelInfo.h>
48 #include <Guid/ImageAuthentication.h>
49 #include <Guid/FileInfo.h>
50 #include <Guid/WinCertificate.h>
52 #include "SecureBootConfigNvData.h"
55 // Tool generated IFR binary data and String package data
57 extern UINT8 SecureBootConfigBin
[];
58 extern UINT8 SecureBootConfigDxeStrings
[];
61 // Shared IFR form update data
63 extern VOID
*mStartOpCodeHandle
;
64 extern VOID
*mEndOpCodeHandle
;
65 extern EFI_IFR_GUID_LABEL
*mStartLabel
;
66 extern EFI_IFR_GUID_LABEL
*mEndLabel
;
69 #define TWO_BYTE_ENCODE 0x82
73 // SHA-256 digest size in bytes
75 #define SHA256_DIGEST_SIZE 32
77 // SHA-384 digest size in bytes
79 #define SHA384_DIGEST_SIZE 48
81 // SHA-512 digest size in bytes
83 #define SHA512_DIGEST_SIZE 64
86 // Set max digest size as SHA512 Output (64 bytes) by far
88 #define MAX_DIGEST_SIZE SHA512_DIGEST_SIZE
90 #define WIN_CERT_UEFI_RSA2048_SIZE 256
95 #define HASHALG_SHA224 0x00000000
96 #define HASHALG_SHA256 0x00000001
97 #define HASHALG_SHA384 0x00000002
98 #define HASHALG_SHA512 0x00000003
99 #define HASHALG_RAW 0x00000004
100 #define HASHALG_MAX 0x00000004
107 } SECUREBOOT_MENU_OPTION
;
110 EFI_FILE_HANDLE FHandle
;
113 } SECUREBOOT_FILE_CONTEXT
;
117 // We define another format of 5th directory entry: security directory
120 UINT32 Offset
; // Offset of certificate
121 UINT32 SizeOfCert
; // size of certificate appended
122 } EFI_IMAGE_SECURITY_DATA_DIRECTORY
;
130 /// HII specific Vendor Device Path definition.
133 VENDOR_DEVICE_PATH VendorDevicePath
;
134 EFI_DEVICE_PATH_PROTOCOL End
;
135 } HII_VENDOR_DEVICE_PATH
;
140 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess
;
141 EFI_HII_HANDLE HiiHandle
;
142 EFI_HANDLE DriverHandle
;
144 SECUREBOOT_FILE_CONTEXT
*FileContext
;
146 EFI_GUID
*SignatureGUID
;
147 } SECUREBOOT_CONFIG_PRIVATE_DATA
;
149 extern SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate
;
150 extern SECUREBOOT_CONFIG_PRIVATE_DATA
*gSecureBootPrivateData
;
152 #define SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'E', 'C', 'B')
153 #define SECUREBOOT_CONFIG_PRIVATE_FROM_THIS(a) CR (a, SECUREBOOT_CONFIG_PRIVATE_DATA, ConfigAccess, SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE)
156 // Cryptograhpic Key Information
159 typedef struct _CPL_KEY_INFO
{
160 UINT32 KeyLengthInBits
; // Key Length In Bits
161 UINT32 BlockSize
; // Operation Block Size in Bytes
162 UINT32 CipherBlockSize
; // Output Cipher Block Size in Bytes
163 UINT32 KeyType
; // Key Type
164 UINT32 CipherMode
; // Cipher Mode for Symmetric Algorithm
165 UINT32 Flags
; // Additional Key Property Flags
171 Retrieves the size, in bytes, of the context buffer required for hash operations.
173 @return The size, in bytes, of the context buffer required for hash operations.
178 (EFIAPI
*HASH_GET_CONTEXT_SIZE
)(
183 Initializes user-supplied memory pointed by HashContext as hash context for
186 If HashContext is NULL, then ASSERT().
188 @param[in, out] HashContext Pointer to Context being initialized.
190 @retval TRUE HASH context initialization succeeded.
191 @retval FALSE HASH context initialization failed.
197 IN OUT VOID
*HashContext
202 Performs digest on a data buffer of the specified length. This function can
203 be called multiple times to compute the digest of long or discontinuous data streams.
205 If HashContext is NULL, then ASSERT().
207 @param[in, out] HashContext Pointer to the MD5 context.
208 @param[in] Data Pointer to the buffer containing the data to be hashed.
209 @param[in] DataLength Length of Data buffer in bytes.
211 @retval TRUE HASH data digest succeeded.
212 @retval FALSE Invalid HASH context. After HashFinal function has been called, the
213 HASH context cannot be reused.
218 (EFIAPI
*HASH_UPDATE
)(
219 IN OUT VOID
*HashContext
,
225 Completes hash computation and retrieves the digest value into the specified
226 memory. After this function has been called, the context cannot be used again.
228 If HashContext is NULL, then ASSERT().
229 If HashValue is NULL, then ASSERT().
231 @param[in, out] HashContext Pointer to the MD5 context
232 @param[out] HashValue Pointer to a buffer that receives the HASH digest
235 @retval TRUE HASH digest computation succeeded.
236 @retval FALSE HASH digest computation failed.
241 (EFIAPI
*HASH_FINAL
)(
242 IN OUT VOID
*HashContext
,
247 // Hash Algorithm Table
250 CHAR16
*Name
; ///< Name for Hash Algorithm
251 UINTN DigestLength
; ///< Digest Length
252 UINT8
*OidValue
; ///< Hash Algorithm OID ASN.1 Value
253 UINTN OidLength
; ///< Length of Hash OID Value
254 HASH_GET_CONTEXT_SIZE GetContextSize
; ///< Pointer to Hash GetContentSize function
255 HASH_INIT HashInit
; ///< Pointer to Hash Init function
256 HASH_UPDATE HashUpdate
; ///< Pointer to Hash Update function
257 HASH_FINAL HashFinal
; ///< Pointer to Hash Final function
263 } WIN_CERTIFICATE_EFI_PKCS
;
267 This function publish the SecureBoot configuration Form.
269 @param[in, out] PrivateData Points to SecureBoot configuration private data.
271 @retval EFI_SUCCESS HII Form is installed successfully.
272 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
273 @retval Others Other errors as indicated.
277 InstallSecureBootConfigForm (
278 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
283 This function removes SecureBoot configuration Form.
285 @param[in, out] PrivateData Points to SecureBoot configuration private data.
289 UninstallSecureBootConfigForm (
290 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
295 This function allows a caller to extract the current configuration for one
296 or more named elements from the target driver.
298 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
299 @param[in] Request A null-terminated Unicode string in
300 <ConfigRequest> format.
301 @param[out] Progress On return, points to a character in the Request
302 string. Points to the string's null terminator if
303 request was successful. Points to the most recent
304 '&' before the first failing name/value pair (or
305 the beginning of the string if the failure is in
306 the first name/value pair) if the request was not
308 @param[out] Results A null-terminated Unicode string in
309 <ConfigAltResp> format which has all values filled
310 in for the names in the Request string. String to
311 be allocated by the called function.
313 @retval EFI_SUCCESS The Results is filled with the requested values.
314 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
315 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
316 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
322 SecureBootExtractConfig (
323 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
324 IN CONST EFI_STRING Request
,
325 OUT EFI_STRING
*Progress
,
326 OUT EFI_STRING
*Results
331 This function processes the results of changes in configuration.
333 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
334 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
336 @param[out] Progress A pointer to a string filled in with the offset of
337 the most recent '&' before the first failing
338 name/value pair (or the beginning of the string if
339 the failure is in the first name/value pair) or
340 the terminating NULL if all was successful.
342 @retval EFI_SUCCESS The Results is processed successfully.
343 @retval EFI_INVALID_PARAMETER Configuration is NULL.
344 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
350 SecureBootRouteConfig (
351 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
352 IN CONST EFI_STRING Configuration
,
353 OUT EFI_STRING
*Progress
358 This function processes the results of changes in configuration.
360 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
361 @param[in] Action Specifies the type of action taken by the browser.
362 @param[in] QuestionId A unique value which is sent to the original
363 exporting driver so that it can identify the type
365 @param[in] Type The type of value for the question.
366 @param[in] Value A pointer to the data being sent to the original
368 @param[out] ActionRequest On return, points to the action requested by the
371 @retval EFI_SUCCESS The callback successfully handled the action.
372 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
373 variable and its data.
374 @retval EFI_DEVICE_ERROR The variable could not be saved.
375 @retval EFI_UNSUPPORTED The specified Action is not supported by the
382 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
383 IN EFI_BROWSER_ACTION Action
,
384 IN EFI_QUESTION_ID QuestionId
,
386 IN EFI_IFR_TYPE_VALUE
*Value
,
387 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
392 This function converts an input device structure to a Unicode string.
394 @param[in] DevPath A pointer to the device path structure.
396 @return A new allocated Unicode string that represents the device path.
402 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
407 Clean up the dynamic opcode at label and form specified by both LabelId.
409 @param[in] LabelId It is both the Form ID and Label ID for opcode deletion.
410 @param[in] PrivateData Module private data.
416 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
421 Read file content into BufferPtr, the size of the allocate buffer
422 is *FileSize plus AddtionAllocateSize.
424 @param[in] FileHandle The file to be read.
425 @param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
426 @param[out] FileSize Size of input file
427 @param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
428 In case the buffer need to contain others besides the file content.
430 @retval EFI_SUCCESS The file was read into the buffer.
431 @retval EFI_INVALID_PARAMETER A parameter was invalid.
432 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
433 @retval others Unexpected error.
438 IN EFI_FILE_HANDLE FileHandle
,
439 IN OUT VOID
**BufferPtr
,
441 IN UINTN AddtionAllocateSize
446 Close an open file handle.
448 @param[in] FileHandle The file handle to close.
453 IN EFI_FILE_HANDLE FileHandle
458 Converts a nonnegative integer to an octet string of a specified length.
460 @param[in] Integer Pointer to the nonnegative integer to be converted
461 @param[in] IntSizeInWords Length of integer buffer in words
462 @param[out] OctetString Converted octet string of the specified length
463 @param[in] OSSizeInBytes Intended length of resulting octet string in bytes
467 @retval EFI_SUCCESS Data conversion successfully
468 @retval EFI_BUFFER_TOOL_SMALL Buffer is too small for output string
474 IN CONST UINTN
*Integer
,
475 IN UINTN IntSizeInWords
,
476 OUT UINT8
*OctetString
,
477 IN UINTN OSSizeInBytes
481 Worker function that prints an EFI_GUID into specified Buffer.
483 @param[in] Guid Pointer to GUID to print.
484 @param[in] Buffer Buffer to print Guid into.
485 @param[in] BufferSize Size of Buffer.
487 @retval Number of characters printed.
498 Update the PK form base on the input file path info.
500 @param FilePath Point to the file path.
502 @retval TRUE Exit caller function.
503 @retval FALSE Not exit caller function.
508 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
512 Update the KEK form base on the input file path info.
514 @param FilePath Point to the file path.
516 @retval TRUE Exit caller function.
517 @retval FALSE Not exit caller function.
522 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
526 Update the DB form base on the input file path info.
528 @param FilePath Point to the file path.
530 @retval TRUE Exit caller function.
531 @retval FALSE Not exit caller function.
536 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
540 Update the DBX form base on the input file path info.
542 @param FilePath Point to the file path.
544 @retval TRUE Exit caller function.
545 @retval FALSE Not exit caller function.
550 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
554 Update the DBT form base on the input file path info.
556 @param FilePath Point to the file path.
558 @retval TRUE Exit caller function.
559 @retval FALSE Not exit caller function.
564 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath