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>
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>
51 #include "SecureBootConfigNvData.h"
54 // Tool generated IFR binary data and String package data
56 extern UINT8 SecureBootConfigBin
[];
57 extern UINT8 SecureBootConfigDxeStrings
[];
60 // Shared IFR form update data
62 extern VOID
*mStartOpCodeHandle
;
63 extern VOID
*mEndOpCodeHandle
;
64 extern EFI_IFR_GUID_LABEL
*mStartLabel
;
65 extern EFI_IFR_GUID_LABEL
*mEndLabel
;
68 #define TWO_BYTE_ENCODE 0x82
71 // SHA-1 digest size in bytes.
73 #define SHA1_DIGEST_SIZE 20
75 // SHA-256 digest size in bytes
77 #define SHA256_DIGEST_SIZE 32
79 // SHA-384 digest size in bytes
81 #define SHA384_DIGEST_SIZE 48
83 // SHA-512 digest size in bytes
85 #define SHA512_DIGEST_SIZE 64
88 // Set max digest size as SHA512 Output (64 bytes) by far
90 #define MAX_DIGEST_SIZE SHA512_DIGEST_SIZE
92 #define WIN_CERT_UEFI_RSA2048_SIZE 256
97 #define HASHALG_SHA1 0x00000000
98 #define HASHALG_SHA224 0x00000001
99 #define HASHALG_SHA256 0x00000002
100 #define HASHALG_SHA384 0x00000003
101 #define HASHALG_SHA512 0x00000004
102 #define HASHALG_RAW 0x00000005
103 #define HASHALG_MAX 0x00000005
110 } SECUREBOOT_MENU_OPTION
;
113 EFI_FILE_HANDLE FHandle
;
115 } SECUREBOOT_FILE_CONTEXT
;
119 // We define another format of 5th directory entry: security directory
122 UINT32 Offset
; // Offset of certificate
123 UINT32 SizeOfCert
; // size of certificate appended
124 } EFI_IMAGE_SECURITY_DATA_DIRECTORY
;
132 /// HII specific Vendor Device Path definition.
135 VENDOR_DEVICE_PATH VendorDevicePath
;
136 EFI_DEVICE_PATH_PROTOCOL End
;
137 } HII_VENDOR_DEVICE_PATH
;
142 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess
;
143 EFI_HII_HANDLE HiiHandle
;
144 EFI_HANDLE DriverHandle
;
146 SECUREBOOT_FILE_CONTEXT
*FileContext
;
148 EFI_GUID
*SignatureGUID
;
149 } SECUREBOOT_CONFIG_PRIVATE_DATA
;
151 extern SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate
;
152 extern SECUREBOOT_CONFIG_PRIVATE_DATA
*gSecureBootPrivateData
;
154 #define SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'E', 'C', 'B')
155 #define SECUREBOOT_CONFIG_PRIVATE_FROM_THIS(a) CR (a, SECUREBOOT_CONFIG_PRIVATE_DATA, ConfigAccess, SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE)
158 // Cryptograhpic Key Information
161 typedef struct _CPL_KEY_INFO
{
162 UINT32 KeyLengthInBits
; // Key Length In Bits
163 UINT32 BlockSize
; // Operation Block Size in Bytes
164 UINT32 CipherBlockSize
; // Output Cipher Block Size in Bytes
165 UINT32 KeyType
; // Key Type
166 UINT32 CipherMode
; // Cipher Mode for Symmetric Algorithm
167 UINT32 Flags
; // Additional Key Property Flags
173 Retrieves the size, in bytes, of the context buffer required for hash operations.
175 @return The size, in bytes, of the context buffer required for hash operations.
180 (EFIAPI
*HASH_GET_CONTEXT_SIZE
)(
185 Initializes user-supplied memory pointed by HashContext as hash context for
188 If HashContext is NULL, then ASSERT().
190 @param[in, out] HashContext Pointer to Context being initialized.
192 @retval TRUE HASH context initialization succeeded.
193 @retval FALSE HASH context initialization failed.
199 IN OUT VOID
*HashContext
204 Performs digest on a data buffer of the specified length. This function can
205 be called multiple times to compute the digest of long or discontinuous data streams.
207 If HashContext is NULL, then ASSERT().
209 @param[in, out] HashContext Pointer to the MD5 context.
210 @param[in] Data Pointer to the buffer containing the data to be hashed.
211 @param[in] DataLength Length of Data buffer in bytes.
213 @retval TRUE HASH data digest succeeded.
214 @retval FALSE Invalid HASH context. After HashFinal function has been called, the
215 HASH context cannot be reused.
220 (EFIAPI
*HASH_UPDATE
)(
221 IN OUT VOID
*HashContext
,
227 Completes hash computation and retrieves the digest value into the specified
228 memory. After this function has been called, the context cannot be used again.
230 If HashContext is NULL, then ASSERT().
231 If HashValue is NULL, then ASSERT().
233 @param[in, out] HashContext Pointer to the MD5 context
234 @param[out] HashValue Pointer to a buffer that receives the HASH digest
237 @retval TRUE HASH digest computation succeeded.
238 @retval FALSE HASH digest computation failed.
243 (EFIAPI
*HASH_FINAL
)(
244 IN OUT VOID
*HashContext
,
249 // Hash Algorithm Table
252 CHAR16
*Name
; ///< Name for Hash Algorithm
253 UINTN DigestLength
; ///< Digest Length
254 UINT8
*OidValue
; ///< Hash Algorithm OID ASN.1 Value
255 UINTN OidLength
; ///< Length of Hash OID Value
256 HASH_GET_CONTEXT_SIZE GetContextSize
; ///< Pointer to Hash GetContentSize function
257 HASH_INIT HashInit
; ///< Pointer to Hash Init function
258 HASH_UPDATE HashUpdate
; ///< Pointer to Hash Update function
259 HASH_FINAL HashFinal
; ///< Pointer to Hash Final function
265 } WIN_CERTIFICATE_EFI_PKCS
;
269 This function publish the SecureBoot configuration Form.
271 @param[in, out] PrivateData Points to SecureBoot configuration private data.
273 @retval EFI_SUCCESS HII Form is installed successfully.
274 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
275 @retval Others Other errors as indicated.
279 InstallSecureBootConfigForm (
280 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
285 This function removes SecureBoot configuration Form.
287 @param[in, out] PrivateData Points to SecureBoot configuration private data.
291 UninstallSecureBootConfigForm (
292 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
297 This function allows a caller to extract the current configuration for one
298 or more named elements from the target driver.
300 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
301 @param[in] Request A null-terminated Unicode string in
302 <ConfigRequest> format.
303 @param[out] Progress On return, points to a character in the Request
304 string. Points to the string's null terminator if
305 request was successful. Points to the most recent
306 '&' before the first failing name/value pair (or
307 the beginning of the string if the failure is in
308 the first name/value pair) if the request was not
310 @param[out] Results A null-terminated Unicode string in
311 <ConfigAltResp> format which has all values filled
312 in for the names in the Request string. String to
313 be allocated by the called function.
315 @retval EFI_SUCCESS The Results is filled with the requested values.
316 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
317 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
318 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
324 SecureBootExtractConfig (
325 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
326 IN CONST EFI_STRING Request
,
327 OUT EFI_STRING
*Progress
,
328 OUT EFI_STRING
*Results
333 This function processes the results of changes in configuration.
335 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
336 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
338 @param[out] Progress A pointer to a string filled in with the offset of
339 the most recent '&' before the first failing
340 name/value pair (or the beginning of the string if
341 the failure is in the first name/value pair) or
342 the terminating NULL if all was successful.
344 @retval EFI_SUCCESS The Results is processed successfully.
345 @retval EFI_INVALID_PARAMETER Configuration is NULL.
346 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
352 SecureBootRouteConfig (
353 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
354 IN CONST EFI_STRING Configuration
,
355 OUT EFI_STRING
*Progress
360 This function processes the results of changes in configuration.
362 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
363 @param[in] Action Specifies the type of action taken by the browser.
364 @param[in] QuestionId A unique value which is sent to the original
365 exporting driver so that it can identify the type
367 @param[in] Type The type of value for the question.
368 @param[in] Value A pointer to the data being sent to the original
370 @param[out] ActionRequest On return, points to the action requested by the
373 @retval EFI_SUCCESS The callback successfully handled the action.
374 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
375 variable and its data.
376 @retval EFI_DEVICE_ERROR The variable could not be saved.
377 @retval EFI_UNSUPPORTED The specified Action is not supported by the
384 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
385 IN EFI_BROWSER_ACTION Action
,
386 IN EFI_QUESTION_ID QuestionId
,
388 IN EFI_IFR_TYPE_VALUE
*Value
,
389 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
394 This function converts an input device structure to a Unicode string.
396 @param[in] DevPath A pointer to the device path structure.
398 @return A new allocated Unicode string that represents the device path.
404 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
409 Clean up the dynamic opcode at label and form specified by both LabelId.
411 @param[in] LabelId It is both the Form ID and Label ID for opcode deletion.
412 @param[in] PrivateData Module private data.
418 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
423 Read file content into BufferPtr, the size of the allocate buffer
424 is *FileSize plus AddtionAllocateSize.
426 @param[in] FileHandle The file to be read.
427 @param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
428 @param[out] FileSize Size of input file
429 @param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
430 In case the buffer need to contain others besides the file content.
432 @retval EFI_SUCCESS The file was read into the buffer.
433 @retval EFI_INVALID_PARAMETER A parameter was invalid.
434 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
435 @retval others Unexpected error.
440 IN EFI_FILE_HANDLE FileHandle
,
441 IN OUT VOID
**BufferPtr
,
443 IN UINTN AddtionAllocateSize
448 Close an open file handle.
450 @param[in] FileHandle The file handle to close.
455 IN EFI_FILE_HANDLE FileHandle
460 Converts a nonnegative integer to an octet string of a specified length.
462 @param[in] Integer Pointer to the nonnegative integer to be converted
463 @param[in] IntSizeInWords Length of integer buffer in words
464 @param[out] OctetString Converted octet string of the specified length
465 @param[in] OSSizeInBytes Intended length of resulting octet string in bytes
469 @retval EFI_SUCCESS Data conversion successfully
470 @retval EFI_BUFFER_TOOL_SMALL Buffer is too small for output string
476 IN CONST UINTN
*Integer
,
477 IN UINTN IntSizeInWords
,
478 OUT UINT8
*OctetString
,
479 IN UINTN OSSizeInBytes
484 Convert a String to Guid Value.
486 @param[in] Str Specifies the String to be converted.
487 @param[in] StrLen Number of Unicode Characters of String (exclusive \0)
488 @param[out] Guid Return the result Guid value.
490 @retval EFI_SUCCESS The operation is finished successfully.
491 @retval EFI_NOT_FOUND Invalid string.
503 Worker function that prints an EFI_GUID into specified Buffer.
505 @param[in] Guid Pointer to GUID to print.
506 @param[in] Buffer Buffer to print Guid into.
507 @param[in] BufferSize Size of Buffer.
509 @retval Number of characters printed.
520 Update the PK form base on the input file path info.
522 @param FilePath Point to the file path.
524 @retval TRUE Exit caller function.
525 @retval FALSE Not exit caller function.
530 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
534 Update the KEK form base on the input file path info.
536 @param FilePath Point to the file path.
538 @retval TRUE Exit caller function.
539 @retval FALSE Not exit caller function.
544 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
548 Update the DB form base on the input file path info.
550 @param FilePath Point to the file path.
552 @retval TRUE Exit caller function.
553 @retval FALSE Not exit caller function.
558 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
562 Update the DBX form base on the input file path info.
564 @param FilePath Point to the file path.
566 @retval TRUE Exit caller function.
567 @retval FALSE Not exit caller function.
572 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
576 Update the DBT form base on the input file path info.
578 @param FilePath Point to the file path.
580 @retval TRUE Exit caller function.
581 @retval FALSE Not exit caller function.
586 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath