2 The header file of HII Config Access protocol implementation of SecureBoot
5 Copyright (c) 2011 - 2016, 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>
44 #include <Guid/MdeModuleHii.h>
45 #include <Guid/AuthenticatedVariableFormat.h>
46 #include <Guid/FileSystemVolumeLabelInfo.h>
47 #include <Guid/ImageAuthentication.h>
48 #include <Guid/FileInfo.h>
50 #include "SecureBootConfigNvData.h"
53 // Tool generated IFR binary data and String package data
55 extern UINT8 SecureBootConfigBin
[];
56 extern UINT8 SecureBootConfigDxeStrings
[];
59 // Shared IFR form update data
61 extern VOID
*mStartOpCodeHandle
;
62 extern VOID
*mEndOpCodeHandle
;
63 extern EFI_IFR_GUID_LABEL
*mStartLabel
;
64 extern EFI_IFR_GUID_LABEL
*mEndLabel
;
67 #define TWO_BYTE_ENCODE 0x82
70 // SHA-1 digest size in bytes.
72 #define SHA1_DIGEST_SIZE 20
74 // SHA-256 digest size in bytes
76 #define SHA256_DIGEST_SIZE 32
78 // SHA-384 digest size in bytes
80 #define SHA384_DIGEST_SIZE 48
82 // SHA-512 digest size in bytes
84 #define SHA512_DIGEST_SIZE 64
87 // Set max digest size as SHA512 Output (64 bytes) by far
89 #define MAX_DIGEST_SIZE SHA512_DIGEST_SIZE
91 #define WIN_CERT_UEFI_RSA2048_SIZE 256
96 #define HASHALG_SHA1 0x00000000
97 #define HASHALG_SHA224 0x00000001
98 #define HASHALG_SHA256 0x00000002
99 #define HASHALG_SHA384 0x00000003
100 #define HASHALG_SHA512 0x00000004
101 #define HASHALG_RAW 0x00000005
102 #define HASHALG_MAX 0x00000005
105 #define SECUREBOOT_MENU_OPTION_SIGNATURE SIGNATURE_32 ('S', 'b', 'M', 'u')
106 #define SECUREBOOT_MENU_ENTRY_SIGNATURE SIGNATURE_32 ('S', 'b', 'M', 'r')
109 EFI_DEVICE_PATH_PROTOCOL Header
;
111 UINT8 VendorDefinedData
[1];
112 } VENDOR_DEVICE_PATH_WITH_DATA
;
115 EFI_DEVICE_PATH_PROTOCOL Header
;
116 UINT16 NetworkProtocol
;
119 UINT16 TargetPortalGroupTag
;
120 CHAR16 TargetName
[1];
121 } ISCSI_DEVICE_PATH_WITH_NAME
;
131 (*DEV_PATH_FUNCTION
) (
132 IN OUT POOL_PRINT
*Str
,
139 DEV_PATH_FUNCTION Function
;
140 } DEVICE_PATH_STRING_TABLE
;
146 } SECUREBOOT_MENU_OPTION
;
149 EFI_FILE_HANDLE FHandle
;
151 } SECUREBOOT_FILE_CONTEXT
;
155 // We define another format of 5th directory entry: security directory
158 UINT32 Offset
; // Offset of certificate
159 UINT32 SizeOfCert
; // size of certificate appended
160 } EFI_IMAGE_SECURITY_DATA_DIRECTORY
;
168 /// HII specific Vendor Device Path definition.
171 VENDOR_DEVICE_PATH VendorDevicePath
;
172 EFI_DEVICE_PATH_PROTOCOL End
;
173 } HII_VENDOR_DEVICE_PATH
;
178 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess
;
179 EFI_HII_HANDLE HiiHandle
;
180 EFI_HANDLE DriverHandle
;
182 SECUREBOOT_FILE_CONTEXT
*FileContext
;
184 EFI_GUID
*SignatureGUID
;
185 } SECUREBOOT_CONFIG_PRIVATE_DATA
;
187 extern SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate
;
188 extern SECUREBOOT_CONFIG_PRIVATE_DATA
*gSecureBootPrivateData
;
190 #define SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'E', 'C', 'B')
191 #define SECUREBOOT_CONFIG_PRIVATE_FROM_THIS(a) CR (a, SECUREBOOT_CONFIG_PRIVATE_DATA, ConfigAccess, SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE)
194 // Cryptograhpic Key Information
197 typedef struct _CPL_KEY_INFO
{
198 UINT32 KeyLengthInBits
; // Key Length In Bits
199 UINT32 BlockSize
; // Operation Block Size in Bytes
200 UINT32 CipherBlockSize
; // Output Cipher Block Size in Bytes
201 UINT32 KeyType
; // Key Type
202 UINT32 CipherMode
; // Cipher Mode for Symmetric Algorithm
203 UINT32 Flags
; // Additional Key Property Flags
209 Retrieves the size, in bytes, of the context buffer required for hash operations.
211 @return The size, in bytes, of the context buffer required for hash operations.
216 (EFIAPI
*HASH_GET_CONTEXT_SIZE
)(
221 Initializes user-supplied memory pointed by HashContext as hash context for
224 If HashContext is NULL, then ASSERT().
226 @param[in, out] HashContext Pointer to Context being initialized.
228 @retval TRUE HASH context initialization succeeded.
229 @retval FALSE HASH context initialization failed.
235 IN OUT VOID
*HashContext
240 Performs digest on a data buffer of the specified length. This function can
241 be called multiple times to compute the digest of long or discontinuous data streams.
243 If HashContext is NULL, then ASSERT().
245 @param[in, out] HashContext Pointer to the MD5 context.
246 @param[in] Data Pointer to the buffer containing the data to be hashed.
247 @param[in] DataLength Length of Data buffer in bytes.
249 @retval TRUE HASH data digest succeeded.
250 @retval FALSE Invalid HASH context. After HashFinal function has been called, the
251 HASH context cannot be reused.
256 (EFIAPI
*HASH_UPDATE
)(
257 IN OUT VOID
*HashContext
,
263 Completes hash computation and retrieves the digest value into the specified
264 memory. After this function has been called, the context cannot be used again.
266 If HashContext is NULL, then ASSERT().
267 If HashValue is NULL, then ASSERT().
269 @param[in, out] HashContext Pointer to the MD5 context
270 @param[out] HashValue Pointer to a buffer that receives the HASH digest
273 @retval TRUE HASH digest computation succeeded.
274 @retval FALSE HASH digest computation failed.
279 (EFIAPI
*HASH_FINAL
)(
280 IN OUT VOID
*HashContext
,
285 // Hash Algorithm Table
288 CHAR16
*Name
; ///< Name for Hash Algorithm
289 UINTN DigestLength
; ///< Digest Length
290 UINT8
*OidValue
; ///< Hash Algorithm OID ASN.1 Value
291 UINTN OidLength
; ///< Length of Hash OID Value
292 HASH_GET_CONTEXT_SIZE GetContextSize
; ///< Pointer to Hash GetContentSize function
293 HASH_INIT HashInit
; ///< Pointer to Hash Init function
294 HASH_UPDATE HashUpdate
; ///< Pointer to Hash Update function
295 HASH_FINAL HashFinal
; ///< Pointer to Hash Final function
301 } WIN_CERTIFICATE_EFI_PKCS
;
305 This function publish the SecureBoot configuration Form.
307 @param[in, out] PrivateData Points to SecureBoot configuration private data.
309 @retval EFI_SUCCESS HII Form is installed successfully.
310 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
311 @retval Others Other errors as indicated.
315 InstallSecureBootConfigForm (
316 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
321 This function removes SecureBoot configuration Form.
323 @param[in, out] PrivateData Points to SecureBoot configuration private data.
327 UninstallSecureBootConfigForm (
328 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
333 This function allows a caller to extract the current configuration for one
334 or more named elements from the target driver.
336 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
337 @param[in] Request A null-terminated Unicode string in
338 <ConfigRequest> format.
339 @param[out] Progress On return, points to a character in the Request
340 string. Points to the string's null terminator if
341 request was successful. Points to the most recent
342 '&' before the first failing name/value pair (or
343 the beginning of the string if the failure is in
344 the first name/value pair) if the request was not
346 @param[out] Results A null-terminated Unicode string in
347 <ConfigAltResp> format which has all values filled
348 in for the names in the Request string. String to
349 be allocated by the called function.
351 @retval EFI_SUCCESS The Results is filled with the requested values.
352 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
353 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
354 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
360 SecureBootExtractConfig (
361 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
362 IN CONST EFI_STRING Request
,
363 OUT EFI_STRING
*Progress
,
364 OUT EFI_STRING
*Results
369 This function processes the results of changes in configuration.
371 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
372 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
374 @param[out] Progress A pointer to a string filled in with the offset of
375 the most recent '&' before the first failing
376 name/value pair (or the beginning of the string if
377 the failure is in the first name/value pair) or
378 the terminating NULL if all was successful.
380 @retval EFI_SUCCESS The Results is processed successfully.
381 @retval EFI_INVALID_PARAMETER Configuration is NULL.
382 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
388 SecureBootRouteConfig (
389 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
390 IN CONST EFI_STRING Configuration
,
391 OUT EFI_STRING
*Progress
396 This function processes the results of changes in configuration.
398 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
399 @param[in] Action Specifies the type of action taken by the browser.
400 @param[in] QuestionId A unique value which is sent to the original
401 exporting driver so that it can identify the type
403 @param[in] Type The type of value for the question.
404 @param[in] Value A pointer to the data being sent to the original
406 @param[out] ActionRequest On return, points to the action requested by the
409 @retval EFI_SUCCESS The callback successfully handled the action.
410 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
411 variable and its data.
412 @retval EFI_DEVICE_ERROR The variable could not be saved.
413 @retval EFI_UNSUPPORTED The specified Action is not supported by the
420 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
421 IN EFI_BROWSER_ACTION Action
,
422 IN EFI_QUESTION_ID QuestionId
,
424 IN EFI_IFR_TYPE_VALUE
*Value
,
425 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
430 This function converts an input device structure to a Unicode string.
432 @param[in] DevPath A pointer to the device path structure.
434 @return A new allocated Unicode string that represents the device path.
440 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
445 Clean up the dynamic opcode at label and form specified by both LabelId.
447 @param[in] LabelId It is both the Form ID and Label ID for opcode deletion.
448 @param[in] PrivateData Module private data.
454 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
459 Read file content into BufferPtr, the size of the allocate buffer
460 is *FileSize plus AddtionAllocateSize.
462 @param[in] FileHandle The file to be read.
463 @param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
464 @param[out] FileSize Size of input file
465 @param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
466 In case the buffer need to contain others besides the file content.
468 @retval EFI_SUCCESS The file was read into the buffer.
469 @retval EFI_INVALID_PARAMETER A parameter was invalid.
470 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
471 @retval others Unexpected error.
476 IN EFI_FILE_HANDLE FileHandle
,
477 IN OUT VOID
**BufferPtr
,
479 IN UINTN AddtionAllocateSize
484 Close an open file handle.
486 @param[in] FileHandle The file handle to close.
491 IN EFI_FILE_HANDLE FileHandle
496 Converts a nonnegative integer to an octet string of a specified length.
498 @param[in] Integer Pointer to the nonnegative integer to be converted
499 @param[in] IntSizeInWords Length of integer buffer in words
500 @param[out] OctetString Converted octet string of the specified length
501 @param[in] OSSizeInBytes Intended length of resulting octet string in bytes
505 @retval EFI_SUCCESS Data conversion successfully
506 @retval EFI_BUFFER_TOOL_SMALL Buffer is too small for output string
512 IN CONST UINTN
*Integer
,
513 IN UINTN IntSizeInWords
,
514 OUT UINT8
*OctetString
,
515 IN UINTN OSSizeInBytes
520 Convert a String to Guid Value.
522 @param[in] Str Specifies the String to be converted.
523 @param[in] StrLen Number of Unicode Characters of String (exclusive \0)
524 @param[out] Guid Return the result Guid value.
526 @retval EFI_SUCCESS The operation is finished successfully.
527 @retval EFI_NOT_FOUND Invalid string.
539 Worker function that prints an EFI_GUID into specified Buffer.
541 @param[in] Guid Pointer to GUID to print.
542 @param[in] Buffer Buffer to print Guid into.
543 @param[in] BufferSize Size of Buffer.
545 @retval Number of characters printed.
556 Update the PK form base on the input file path info.
558 @param FilePath Point to the file path.
560 @retval TRUE Exit caller function.
561 @retval FALSE Not exit caller function.
565 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
569 Update the KEK form base on the input file path info.
571 @param FilePath Point to the file path.
573 @retval TRUE Exit caller function.
574 @retval FALSE Not exit caller function.
578 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
582 Update the DB form base on the input file path info.
584 @param FilePath Point to the file path.
586 @retval TRUE Exit caller function.
587 @retval FALSE Not exit caller function.
591 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
595 Update the DBX form base on the input file path info.
597 @param FilePath Point to the file path.
599 @retval TRUE Exit caller function.
600 @retval FALSE Not exit caller function.
604 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
608 Update the DBT form base on the input file path info.
610 @param FilePath Point to the file path.
612 @retval TRUE Exit caller function.
613 @retval FALSE Not exit caller function.
617 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath