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>
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
72 // SHA-256 digest size in bytes
74 #define SHA256_DIGEST_SIZE 32
76 // SHA-384 digest size in bytes
78 #define SHA384_DIGEST_SIZE 48
80 // SHA-512 digest size in bytes
82 #define SHA512_DIGEST_SIZE 64
85 // Set max digest size as SHA512 Output (64 bytes) by far
87 #define MAX_DIGEST_SIZE SHA512_DIGEST_SIZE
89 #define WIN_CERT_UEFI_RSA2048_SIZE 256
94 #define HASHALG_SHA224 0x00000000
95 #define HASHALG_SHA256 0x00000001
96 #define HASHALG_SHA384 0x00000002
97 #define HASHALG_SHA512 0x00000003
98 #define HASHALG_RAW 0x00000004
99 #define HASHALG_MAX 0x00000004
106 } SECUREBOOT_MENU_OPTION
;
109 EFI_FILE_HANDLE FHandle
;
111 } SECUREBOOT_FILE_CONTEXT
;
115 // We define another format of 5th directory entry: security directory
118 UINT32 Offset
; // Offset of certificate
119 UINT32 SizeOfCert
; // size of certificate appended
120 } EFI_IMAGE_SECURITY_DATA_DIRECTORY
;
128 /// HII specific Vendor Device Path definition.
131 VENDOR_DEVICE_PATH VendorDevicePath
;
132 EFI_DEVICE_PATH_PROTOCOL End
;
133 } HII_VENDOR_DEVICE_PATH
;
138 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess
;
139 EFI_HII_HANDLE HiiHandle
;
140 EFI_HANDLE DriverHandle
;
142 SECUREBOOT_FILE_CONTEXT
*FileContext
;
144 EFI_GUID
*SignatureGUID
;
145 } SECUREBOOT_CONFIG_PRIVATE_DATA
;
147 extern SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate
;
148 extern SECUREBOOT_CONFIG_PRIVATE_DATA
*gSecureBootPrivateData
;
150 #define SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('S', 'E', 'C', 'B')
151 #define SECUREBOOT_CONFIG_PRIVATE_FROM_THIS(a) CR (a, SECUREBOOT_CONFIG_PRIVATE_DATA, ConfigAccess, SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE)
154 // Cryptograhpic Key Information
157 typedef struct _CPL_KEY_INFO
{
158 UINT32 KeyLengthInBits
; // Key Length In Bits
159 UINT32 BlockSize
; // Operation Block Size in Bytes
160 UINT32 CipherBlockSize
; // Output Cipher Block Size in Bytes
161 UINT32 KeyType
; // Key Type
162 UINT32 CipherMode
; // Cipher Mode for Symmetric Algorithm
163 UINT32 Flags
; // Additional Key Property Flags
169 Retrieves the size, in bytes, of the context buffer required for hash operations.
171 @return The size, in bytes, of the context buffer required for hash operations.
176 (EFIAPI
*HASH_GET_CONTEXT_SIZE
)(
181 Initializes user-supplied memory pointed by HashContext as hash context for
184 If HashContext is NULL, then ASSERT().
186 @param[in, out] HashContext Pointer to Context being initialized.
188 @retval TRUE HASH context initialization succeeded.
189 @retval FALSE HASH context initialization failed.
195 IN OUT VOID
*HashContext
200 Performs digest on a data buffer of the specified length. This function can
201 be called multiple times to compute the digest of long or discontinuous data streams.
203 If HashContext is NULL, then ASSERT().
205 @param[in, out] HashContext Pointer to the MD5 context.
206 @param[in] Data Pointer to the buffer containing the data to be hashed.
207 @param[in] DataLength Length of Data buffer in bytes.
209 @retval TRUE HASH data digest succeeded.
210 @retval FALSE Invalid HASH context. After HashFinal function has been called, the
211 HASH context cannot be reused.
216 (EFIAPI
*HASH_UPDATE
)(
217 IN OUT VOID
*HashContext
,
223 Completes hash computation and retrieves the digest value into the specified
224 memory. After this function has been called, the context cannot be used again.
226 If HashContext is NULL, then ASSERT().
227 If HashValue is NULL, then ASSERT().
229 @param[in, out] HashContext Pointer to the MD5 context
230 @param[out] HashValue Pointer to a buffer that receives the HASH digest
233 @retval TRUE HASH digest computation succeeded.
234 @retval FALSE HASH digest computation failed.
239 (EFIAPI
*HASH_FINAL
)(
240 IN OUT VOID
*HashContext
,
245 // Hash Algorithm Table
248 CHAR16
*Name
; ///< Name for Hash Algorithm
249 UINTN DigestLength
; ///< Digest Length
250 UINT8
*OidValue
; ///< Hash Algorithm OID ASN.1 Value
251 UINTN OidLength
; ///< Length of Hash OID Value
252 HASH_GET_CONTEXT_SIZE GetContextSize
; ///< Pointer to Hash GetContentSize function
253 HASH_INIT HashInit
; ///< Pointer to Hash Init function
254 HASH_UPDATE HashUpdate
; ///< Pointer to Hash Update function
255 HASH_FINAL HashFinal
; ///< Pointer to Hash Final function
261 } WIN_CERTIFICATE_EFI_PKCS
;
265 This function publish the SecureBoot configuration Form.
267 @param[in, out] PrivateData Points to SecureBoot configuration private data.
269 @retval EFI_SUCCESS HII Form is installed successfully.
270 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
271 @retval Others Other errors as indicated.
275 InstallSecureBootConfigForm (
276 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
281 This function removes SecureBoot configuration Form.
283 @param[in, out] PrivateData Points to SecureBoot configuration private data.
287 UninstallSecureBootConfigForm (
288 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
293 This function allows a caller to extract the current configuration for one
294 or more named elements from the target driver.
296 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
297 @param[in] Request A null-terminated Unicode string in
298 <ConfigRequest> format.
299 @param[out] Progress On return, points to a character in the Request
300 string. Points to the string's null terminator if
301 request was successful. Points to the most recent
302 '&' before the first failing name/value pair (or
303 the beginning of the string if the failure is in
304 the first name/value pair) if the request was not
306 @param[out] Results A null-terminated Unicode string in
307 <ConfigAltResp> format which has all values filled
308 in for the names in the Request string. String to
309 be allocated by the called function.
311 @retval EFI_SUCCESS The Results is filled with the requested values.
312 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
313 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
314 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
320 SecureBootExtractConfig (
321 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
322 IN CONST EFI_STRING Request
,
323 OUT EFI_STRING
*Progress
,
324 OUT EFI_STRING
*Results
329 This function processes the results of changes in configuration.
331 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
332 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
334 @param[out] Progress A pointer to a string filled in with the offset of
335 the most recent '&' before the first failing
336 name/value pair (or the beginning of the string if
337 the failure is in the first name/value pair) or
338 the terminating NULL if all was successful.
340 @retval EFI_SUCCESS The Results is processed successfully.
341 @retval EFI_INVALID_PARAMETER Configuration is NULL.
342 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
348 SecureBootRouteConfig (
349 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
350 IN CONST EFI_STRING Configuration
,
351 OUT EFI_STRING
*Progress
356 This function processes the results of changes in configuration.
358 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
359 @param[in] Action Specifies the type of action taken by the browser.
360 @param[in] QuestionId A unique value which is sent to the original
361 exporting driver so that it can identify the type
363 @param[in] Type The type of value for the question.
364 @param[in] Value A pointer to the data being sent to the original
366 @param[out] ActionRequest On return, points to the action requested by the
369 @retval EFI_SUCCESS The callback successfully handled the action.
370 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
371 variable and its data.
372 @retval EFI_DEVICE_ERROR The variable could not be saved.
373 @retval EFI_UNSUPPORTED The specified Action is not supported by the
380 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
381 IN EFI_BROWSER_ACTION Action
,
382 IN EFI_QUESTION_ID QuestionId
,
384 IN EFI_IFR_TYPE_VALUE
*Value
,
385 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
390 This function converts an input device structure to a Unicode string.
392 @param[in] DevPath A pointer to the device path structure.
394 @return A new allocated Unicode string that represents the device path.
400 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
405 Clean up the dynamic opcode at label and form specified by both LabelId.
407 @param[in] LabelId It is both the Form ID and Label ID for opcode deletion.
408 @param[in] PrivateData Module private data.
414 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
419 Read file content into BufferPtr, the size of the allocate buffer
420 is *FileSize plus AddtionAllocateSize.
422 @param[in] FileHandle The file to be read.
423 @param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
424 @param[out] FileSize Size of input file
425 @param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
426 In case the buffer need to contain others besides the file content.
428 @retval EFI_SUCCESS The file was read into the buffer.
429 @retval EFI_INVALID_PARAMETER A parameter was invalid.
430 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
431 @retval others Unexpected error.
436 IN EFI_FILE_HANDLE FileHandle
,
437 IN OUT VOID
**BufferPtr
,
439 IN UINTN AddtionAllocateSize
444 Close an open file handle.
446 @param[in] FileHandle The file handle to close.
451 IN EFI_FILE_HANDLE FileHandle
456 Converts a nonnegative integer to an octet string of a specified length.
458 @param[in] Integer Pointer to the nonnegative integer to be converted
459 @param[in] IntSizeInWords Length of integer buffer in words
460 @param[out] OctetString Converted octet string of the specified length
461 @param[in] OSSizeInBytes Intended length of resulting octet string in bytes
465 @retval EFI_SUCCESS Data conversion successfully
466 @retval EFI_BUFFER_TOOL_SMALL Buffer is too small for output string
472 IN CONST UINTN
*Integer
,
473 IN UINTN IntSizeInWords
,
474 OUT UINT8
*OctetString
,
475 IN UINTN OSSizeInBytes
479 Worker function that prints an EFI_GUID into specified Buffer.
481 @param[in] Guid Pointer to GUID to print.
482 @param[in] Buffer Buffer to print Guid into.
483 @param[in] BufferSize Size of Buffer.
485 @retval Number of characters printed.
496 Update the PK form base on the input file path info.
498 @param FilePath Point to the file path.
500 @retval TRUE Exit caller function.
501 @retval FALSE Not exit caller function.
506 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
510 Update the KEK form base on the input file path info.
512 @param FilePath Point to the file path.
514 @retval TRUE Exit caller function.
515 @retval FALSE Not exit caller function.
520 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
524 Update the DB form base on the input file path info.
526 @param FilePath Point to the file path.
528 @retval TRUE Exit caller function.
529 @retval FALSE Not exit caller function.
534 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
538 Update the DBX form base on the input file path info.
540 @param FilePath Point to the file path.
542 @retval TRUE Exit caller function.
543 @retval FALSE Not exit caller function.
548 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
552 Update the DBT form base on the input file path info.
554 @param FilePath Point to the file path.
556 @retval TRUE Exit caller function.
557 @retval FALSE Not exit caller function.
562 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath