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
70 #define BUFFER_MAX_SIZE 100
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
;
115 #define SECUREBOOT_FREE_NON_NULL(Pointer) \
117 if ((Pointer) != NULL) { \
118 FreePool((Pointer)); \
123 #define SECUREBOOT_FREE_NON_OPCODE(Handle) \
125 if ((Handle) != NULL) { \
126 HiiFreeOpCodeHandle((Handle)); \
130 #define SIGNATURE_DATA_COUNTS(List) \
131 (((List)->SignatureListSize - sizeof(EFI_SIGNATURE_LIST) - (List)->SignatureHeaderSize) / (List)->SignatureSize)
134 // We define another format of 5th directory entry: security directory
137 UINT32 Offset
; // Offset of certificate
138 UINT32 SizeOfCert
; // size of certificate appended
139 } EFI_IMAGE_SECURITY_DATA_DIRECTORY
;
147 /// HII specific Vendor Device Path definition.
150 VENDOR_DEVICE_PATH VendorDevicePath
;
151 EFI_DEVICE_PATH_PROTOCOL End
;
152 } HII_VENDOR_DEVICE_PATH
;
159 } CURRENT_VARIABLE_NAME
;
162 Delete_Signature_List_All
,
163 Delete_Signature_List_One
,
164 Delete_Signature_Data
165 }SIGNATURE_DELETE_TYPE
;
170 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess
;
171 EFI_HII_HANDLE HiiHandle
;
172 EFI_HANDLE DriverHandle
;
174 SECUREBOOT_FILE_CONTEXT
*FileContext
;
176 EFI_GUID
*SignatureGUID
;
178 CURRENT_VARIABLE_NAME VariableName
; // The variable name we are processing.
179 UINT32 ListCount
; // Record current variable has how many signature list.
180 UINTN ListIndex
; // Record which signature list is processing.
181 BOOLEAN
*CheckArray
; // Record whcih siganture data checked.
182 } SECUREBOOT_CONFIG_PRIVATE_DATA
;
184 extern SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate
;
185 extern SECUREBOOT_CONFIG_PRIVATE_DATA
*gSecureBootPrivateData
;
187 #define SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'E', 'C', 'B')
188 #define SECUREBOOT_CONFIG_PRIVATE_FROM_THIS(a) CR (a, SECUREBOOT_CONFIG_PRIVATE_DATA, ConfigAccess, SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE)
191 // Cryptograhpic Key Information
194 typedef struct _CPL_KEY_INFO
{
195 UINT32 KeyLengthInBits
; // Key Length In Bits
196 UINT32 BlockSize
; // Operation Block Size in Bytes
197 UINT32 CipherBlockSize
; // Output Cipher Block Size in Bytes
198 UINT32 KeyType
; // Key Type
199 UINT32 CipherMode
; // Cipher Mode for Symmetric Algorithm
200 UINT32 Flags
; // Additional Key Property Flags
206 Retrieves the size, in bytes, of the context buffer required for hash operations.
208 @return The size, in bytes, of the context buffer required for hash operations.
213 (EFIAPI
*HASH_GET_CONTEXT_SIZE
)(
218 Initializes user-supplied memory pointed by HashContext as hash context for
221 If HashContext is NULL, then ASSERT().
223 @param[in, out] HashContext Pointer to Context being initialized.
225 @retval TRUE HASH context initialization succeeded.
226 @retval FALSE HASH context initialization failed.
232 IN OUT VOID
*HashContext
237 Performs digest on a data buffer of the specified length. This function can
238 be called multiple times to compute the digest of long or discontinuous data streams.
240 If HashContext is NULL, then ASSERT().
242 @param[in, out] HashContext Pointer to the MD5 context.
243 @param[in] Data Pointer to the buffer containing the data to be hashed.
244 @param[in] DataLength Length of Data buffer in bytes.
246 @retval TRUE HASH data digest succeeded.
247 @retval FALSE Invalid HASH context. After HashFinal function has been called, the
248 HASH context cannot be reused.
253 (EFIAPI
*HASH_UPDATE
)(
254 IN OUT VOID
*HashContext
,
260 Completes hash computation and retrieves the digest value into the specified
261 memory. After this function has been called, the context cannot be used again.
263 If HashContext is NULL, then ASSERT().
264 If HashValue is NULL, then ASSERT().
266 @param[in, out] HashContext Pointer to the MD5 context
267 @param[out] HashValue Pointer to a buffer that receives the HASH digest
270 @retval TRUE HASH digest computation succeeded.
271 @retval FALSE HASH digest computation failed.
276 (EFIAPI
*HASH_FINAL
)(
277 IN OUT VOID
*HashContext
,
282 // Hash Algorithm Table
285 CHAR16
*Name
; ///< Name for Hash Algorithm
286 UINTN DigestLength
; ///< Digest Length
287 UINT8
*OidValue
; ///< Hash Algorithm OID ASN.1 Value
288 UINTN OidLength
; ///< Length of Hash OID Value
289 HASH_GET_CONTEXT_SIZE GetContextSize
; ///< Pointer to Hash GetContentSize function
290 HASH_INIT HashInit
; ///< Pointer to Hash Init function
291 HASH_UPDATE HashUpdate
; ///< Pointer to Hash Update function
292 HASH_FINAL HashFinal
; ///< Pointer to Hash Final function
298 } WIN_CERTIFICATE_EFI_PKCS
;
302 This function publish the SecureBoot configuration Form.
304 @param[in, out] PrivateData Points to SecureBoot configuration private data.
306 @retval EFI_SUCCESS HII Form is installed successfully.
307 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
308 @retval Others Other errors as indicated.
312 InstallSecureBootConfigForm (
313 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
318 This function removes SecureBoot configuration Form.
320 @param[in, out] PrivateData Points to SecureBoot configuration private data.
324 UninstallSecureBootConfigForm (
325 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
330 This function allows a caller to extract the current configuration for one
331 or more named elements from the target driver.
333 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
334 @param[in] Request A null-terminated Unicode string in
335 <ConfigRequest> format.
336 @param[out] Progress On return, points to a character in the Request
337 string. Points to the string's null terminator if
338 request was successful. Points to the most recent
339 '&' before the first failing name/value pair (or
340 the beginning of the string if the failure is in
341 the first name/value pair) if the request was not
343 @param[out] Results A null-terminated Unicode string in
344 <ConfigAltResp> format which has all values filled
345 in for the names in the Request string. String to
346 be allocated by the called function.
348 @retval EFI_SUCCESS The Results is filled with the requested values.
349 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
350 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
351 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
357 SecureBootExtractConfig (
358 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
359 IN CONST EFI_STRING Request
,
360 OUT EFI_STRING
*Progress
,
361 OUT EFI_STRING
*Results
366 This function processes the results of changes in configuration.
368 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
369 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
371 @param[out] Progress A pointer to a string filled in with the offset of
372 the most recent '&' before the first failing
373 name/value pair (or the beginning of the string if
374 the failure is in the first name/value pair) or
375 the terminating NULL if all was successful.
377 @retval EFI_SUCCESS The Results is processed successfully.
378 @retval EFI_INVALID_PARAMETER Configuration is NULL.
379 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
385 SecureBootRouteConfig (
386 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
387 IN CONST EFI_STRING Configuration
,
388 OUT EFI_STRING
*Progress
393 This function processes the results of changes in configuration.
395 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
396 @param[in] Action Specifies the type of action taken by the browser.
397 @param[in] QuestionId A unique value which is sent to the original
398 exporting driver so that it can identify the type
400 @param[in] Type The type of value for the question.
401 @param[in] Value A pointer to the data being sent to the original
403 @param[out] ActionRequest On return, points to the action requested by the
406 @retval EFI_SUCCESS The callback successfully handled the action.
407 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
408 variable and its data.
409 @retval EFI_DEVICE_ERROR The variable could not be saved.
410 @retval EFI_UNSUPPORTED The specified Action is not supported by the
417 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
418 IN EFI_BROWSER_ACTION Action
,
419 IN EFI_QUESTION_ID QuestionId
,
421 IN EFI_IFR_TYPE_VALUE
*Value
,
422 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
427 This function converts an input device structure to a Unicode string.
429 @param[in] DevPath A pointer to the device path structure.
431 @return A new allocated Unicode string that represents the device path.
437 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
442 Clean up the dynamic opcode at label and form specified by both LabelId.
444 @param[in] LabelId It is both the Form ID and Label ID for opcode deletion.
445 @param[in] PrivateData Module private data.
451 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
456 Read file content into BufferPtr, the size of the allocate buffer
457 is *FileSize plus AddtionAllocateSize.
459 @param[in] FileHandle The file to be read.
460 @param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
461 @param[out] FileSize Size of input file
462 @param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
463 In case the buffer need to contain others besides the file content.
465 @retval EFI_SUCCESS The file was read into the buffer.
466 @retval EFI_INVALID_PARAMETER A parameter was invalid.
467 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
468 @retval others Unexpected error.
473 IN EFI_FILE_HANDLE FileHandle
,
474 IN OUT VOID
**BufferPtr
,
476 IN UINTN AddtionAllocateSize
481 Close an open file handle.
483 @param[in] FileHandle The file handle to close.
488 IN EFI_FILE_HANDLE FileHandle
493 Converts a nonnegative integer to an octet string of a specified length.
495 @param[in] Integer Pointer to the nonnegative integer to be converted
496 @param[in] IntSizeInWords Length of integer buffer in words
497 @param[out] OctetString Converted octet string of the specified length
498 @param[in] OSSizeInBytes Intended length of resulting octet string in bytes
502 @retval EFI_SUCCESS Data conversion successfully
503 @retval EFI_BUFFER_TOOL_SMALL Buffer is too small for output string
509 IN CONST UINTN
*Integer
,
510 IN UINTN IntSizeInWords
,
511 OUT UINT8
*OctetString
,
512 IN UINTN OSSizeInBytes
516 Worker function that prints an EFI_GUID into specified Buffer.
518 @param[in] Guid Pointer to GUID to print.
519 @param[in] Buffer Buffer to print Guid into.
520 @param[in] BufferSize Size of Buffer.
522 @retval Number of characters printed.
533 Update the PK form base on the input file path info.
535 @param FilePath Point to the file path.
537 @retval TRUE Exit caller function.
538 @retval FALSE Not exit caller function.
543 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
547 Update the KEK form base on the input file path info.
549 @param FilePath Point to the file path.
551 @retval TRUE Exit caller function.
552 @retval FALSE Not exit caller function.
557 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
561 Update the DB form base on the input file path info.
563 @param FilePath Point to the file path.
565 @retval TRUE Exit caller function.
566 @retval FALSE Not exit caller function.
571 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
575 Update the DBX form base on the input file path info.
577 @param FilePath Point to the file path.
579 @retval TRUE Exit caller function.
580 @retval FALSE Not exit caller function.
585 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
589 Update the DBT form base on the input file path info.
591 @param FilePath Point to the file path.
593 @retval TRUE Exit caller function.
594 @retval FALSE Not exit caller function.
599 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath