2 The Miscellaneous Routines for TlsAuthConfigDxe driver.
4 Copyright (c) 2016 - 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 #include "TlsAuthConfigImpl.h"
18 VOID
*mStartOpCodeHandle
= NULL
;
19 VOID
*mEndOpCodeHandle
= NULL
;
20 EFI_IFR_GUID_LABEL
*mStartLabel
= NULL
;
21 EFI_IFR_GUID_LABEL
*mEndLabel
= NULL
;
24 CHAR16 mTlsAuthConfigStorageName
[] = L
"TLS_AUTH_CONFIG_IFR_NVDATA";
26 TLS_AUTH_CONFIG_PRIVATE_DATA
*mTlsAuthPrivateData
= NULL
;
28 HII_VENDOR_DEVICE_PATH mTlsAuthConfigHiiVendorDevicePath
= {
34 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
35 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
42 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
44 (UINT8
) (END_DEVICE_PATH_LENGTH
),
45 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
51 // Possible DER-encoded certificate file suffixes, end with NULL pointer.
53 CHAR16
* mDerPemEncodedSuffix
[] = {
62 This code checks if the FileSuffix is one of the possible DER/PEM-encoded certificate suffix.
64 @param[in] FileSuffix The suffix of the input certificate file
66 @retval TRUE It's a DER/PEM-encoded certificate.
67 @retval FALSE It's NOT a DER/PEM-encoded certificate.
71 IsDerPemEncodeCertificate (
72 IN CONST CHAR16
*FileSuffix
76 for (Index
= 0; mDerPemEncodedSuffix
[Index
] != NULL
; Index
++) {
77 if (StrCmp (FileSuffix
, mDerPemEncodedSuffix
[Index
]) == 0) {
85 Worker function that prints an EFI_GUID into specified Buffer.
87 @param[in] Guid Pointer to GUID to print.
88 @param[in] Buffer Buffer to print Guid into.
89 @param[in] BufferSize Size of Buffer.
91 @retval Number of characters printed.
101 return UnicodeSPrint (
110 List all cert in specified database by GUID in the page
111 for user to select and delete as needed.
113 @param[in] PrivateData Module's private data.
114 @param[in] VariableName The variable name of the vendor's signature database.
115 @param[in] VendorGuid A unique identifier for the vendor.
116 @param[in] LabelNumber Label number to insert opcodes.
117 @param[in] FormId Form ID of current page.
118 @param[in] QuestionIdBase Base question id of the signature list.
120 @retval EFI_SUCCESS Success to update the signature list page
121 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
126 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
,
127 IN CHAR16
*VariableName
,
128 IN EFI_GUID
*VendorGuid
,
129 IN UINT16 LabelNumber
,
130 IN EFI_FORM_ID FormId
,
131 IN EFI_QUESTION_ID QuestionIdBase
138 VOID
*StartOpCodeHandle
;
139 VOID
*EndOpCodeHandle
;
140 EFI_IFR_GUID_LABEL
*StartLabel
;
141 EFI_IFR_GUID_LABEL
*EndLabel
;
144 EFI_SIGNATURE_LIST
*CertList
;
145 EFI_SIGNATURE_DATA
*Cert
;
148 EFI_STRING_ID GuidID
;
155 StartOpCodeHandle
= NULL
;
156 EndOpCodeHandle
= NULL
;
159 // Initialize the container for dynamic opcodes.
161 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
162 if (StartOpCodeHandle
== NULL
) {
163 Status
= EFI_OUT_OF_RESOURCES
;
167 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
168 if (EndOpCodeHandle
== NULL
) {
169 Status
= EFI_OUT_OF_RESOURCES
;
174 // Create Hii Extend Label OpCode.
176 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
180 sizeof (EFI_IFR_GUID_LABEL
)
182 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
183 StartLabel
->Number
= LabelNumber
;
185 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
189 sizeof (EFI_IFR_GUID_LABEL
)
191 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
192 EndLabel
->Number
= LABEL_END
;
198 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, NULL
, &DataSize
, Data
);
199 if (EFI_ERROR (Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
203 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
205 Status
= EFI_OUT_OF_RESOURCES
;
209 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, NULL
, &DataSize
, Data
);
210 if (EFI_ERROR (Status
)) {
214 GuidStr
= AllocateZeroPool (100);
215 if (GuidStr
== NULL
) {
216 Status
= EFI_OUT_OF_RESOURCES
;
221 // Enumerate all data.
223 ItemDataSize
= (UINT32
) DataSize
;
224 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
227 while ((ItemDataSize
> 0) && (ItemDataSize
>= CertList
->SignatureListSize
)) {
229 if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Guid
)) {
230 Help
= STRING_TOKEN (STR_CERT_TYPE_PCKS_GUID
);
233 // The signature type is not supported in current implementation.
235 ItemDataSize
-= CertList
->SignatureListSize
;
236 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
240 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
241 for (Index
= 0; Index
< CertCount
; Index
++) {
242 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
243 + sizeof (EFI_SIGNATURE_LIST
)
244 + CertList
->SignatureHeaderSize
245 + Index
* CertList
->SignatureSize
);
247 // Display GUID and help
249 GuidToString (&Cert
->SignatureOwner
, GuidStr
, 100);
250 GuidID
= HiiSetString (Private
->RegisteredHandle
, 0, GuidStr
, NULL
);
251 HiiCreateCheckBoxOpCode (
253 (EFI_QUESTION_ID
) (QuestionIdBase
+ GuidIndex
++),
258 EFI_IFR_FLAG_CALLBACK
,
264 ItemDataSize
-= CertList
->SignatureListSize
;
265 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
270 Private
->RegisteredHandle
,
277 if (StartOpCodeHandle
!= NULL
) {
278 HiiFreeOpCodeHandle (StartOpCodeHandle
);
281 if (EndOpCodeHandle
!= NULL
) {
282 HiiFreeOpCodeHandle (EndOpCodeHandle
);
289 if (GuidStr
!= NULL
) {
297 Delete one entry from cert database.
299 @param[in] PrivateData Module's private data.
300 @param[in] VariableName The variable name of the database.
301 @param[in] VendorGuid A unique identifier for the vendor.
302 @param[in] LabelNumber Label number to insert opcodes.
303 @param[in] FormId Form ID of current page.
304 @param[in] QuestionIdBase Base question id of the cert list.
305 @param[in] DeleteIndex Cert index to delete.
307 @retval EFI_SUCCESS Delete siganture successfully.
308 @retval EFI_NOT_FOUND Can't find the signature item,
309 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
313 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
,
314 IN CHAR16
*VariableName
,
315 IN EFI_GUID
*VendorGuid
,
316 IN UINT16 LabelNumber
,
317 IN EFI_FORM_ID FormId
,
318 IN EFI_QUESTION_ID QuestionIdBase
,
328 EFI_SIGNATURE_LIST
*CertList
;
329 EFI_SIGNATURE_LIST
*NewCertList
;
330 EFI_SIGNATURE_DATA
*Cert
;
344 // Get original signature list data.
347 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, NULL
, &DataSize
, NULL
);
348 if (EFI_ERROR (Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
352 OldData
= (UINT8
*) AllocateZeroPool (DataSize
);
353 if (OldData
== NULL
) {
354 Status
= EFI_OUT_OF_RESOURCES
;
358 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, &Attr
, &DataSize
, OldData
);
359 if (EFI_ERROR(Status
)) {
364 // Allocate space for new variable.
366 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
368 Status
= EFI_OUT_OF_RESOURCES
;
373 // Enumerate all data and erasing the target item.
376 ItemDataSize
= (UINT32
) DataSize
;
377 CertList
= (EFI_SIGNATURE_LIST
*) OldData
;
380 while ((ItemDataSize
> 0) && (ItemDataSize
>= CertList
->SignatureListSize
)) {
381 if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Guid
)) {
383 // Copy EFI_SIGNATURE_LIST header then calculate the signature count in this list.
385 CopyMem (Data
+ Offset
, CertList
, (sizeof(EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
));
386 NewCertList
= (EFI_SIGNATURE_LIST
*) (Data
+ Offset
);
387 Offset
+= (sizeof(EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
388 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
389 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
390 for (Index
= 0; Index
< CertCount
; Index
++) {
391 if (GuidIndex
== DeleteIndex
) {
395 NewCertList
->SignatureListSize
-= CertList
->SignatureSize
;
399 // This item doesn't match. Copy it to the Data buffer.
401 CopyMem (Data
+ Offset
, (UINT8
*)(Cert
), CertList
->SignatureSize
);
402 Offset
+= CertList
->SignatureSize
;
405 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) Cert
+ CertList
->SignatureSize
);
409 // This List doesn't match. Just copy it to the Data buffer.
411 CopyMem (Data
+ Offset
, (UINT8
*)(CertList
), CertList
->SignatureListSize
);
412 Offset
+= CertList
->SignatureListSize
;
415 ItemDataSize
-= CertList
->SignatureListSize
;
416 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
421 // Doesn't find the signature Item!
423 Status
= EFI_NOT_FOUND
;
428 // Delete the EFI_SIGNATURE_LIST header if there is no signature in the list.
430 ItemDataSize
= Offset
;
431 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
433 ZeroMem (OldData
, ItemDataSize
);
434 while ((ItemDataSize
> 0) && (ItemDataSize
>= CertList
->SignatureListSize
)) {
435 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
436 DEBUG ((DEBUG_INFO
, " CertCount = %x\n", CertCount
));
437 if (CertCount
!= 0) {
438 CopyMem (OldData
+ Offset
, (UINT8
*)(CertList
), CertList
->SignatureListSize
);
439 Offset
+= CertList
->SignatureListSize
;
441 ItemDataSize
-= CertList
->SignatureListSize
;
442 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
447 Status
= gRT
->SetVariable(
454 if (EFI_ERROR (Status
)) {
455 DEBUG ((DEBUG_ERROR
, "Failed to set variable, Status = %r\n", Status
));
464 if (OldData
!= NULL
) {
468 return UpdateDeletePage (
480 Close an open file handle.
482 @param[in] FileHandle The file handle to close.
487 IN EFI_FILE_HANDLE FileHandle
490 if (FileHandle
!= NULL
) {
491 FileHandle
->Close (FileHandle
);
496 Read file content into BufferPtr, the size of the allocate buffer
497 is *FileSize plus AddtionAllocateSize.
499 @param[in] FileHandle The file to be read.
500 @param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
501 @param[out] FileSize Size of input file
502 @param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
503 In case the buffer need to contain others besides the file content.
505 @retval EFI_SUCCESS The file was read into the buffer.
506 @retval EFI_INVALID_PARAMETER A parameter was invalid.
507 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
508 @retval others Unexpected error.
513 IN EFI_FILE_HANDLE FileHandle
,
514 IN OUT VOID
**BufferPtr
,
516 IN UINTN AddtionAllocateSize
521 UINT64 SourceFileSize
;
525 if ((FileHandle
== NULL
) || (FileSize
== NULL
)) {
526 return EFI_INVALID_PARAMETER
;
534 Status
= FileHandle
->SetPosition (FileHandle
, (UINT64
) -1);
535 if (EFI_ERROR (Status
)) {
539 Status
= FileHandle
->GetPosition (FileHandle
, &SourceFileSize
);
540 if (EFI_ERROR (Status
)) {
544 Status
= FileHandle
->SetPosition (FileHandle
, 0);
545 if (EFI_ERROR (Status
)) {
549 BufferSize
= (UINTN
) SourceFileSize
+ AddtionAllocateSize
;
550 Buffer
= AllocateZeroPool(BufferSize
);
551 if (Buffer
== NULL
) {
552 return EFI_OUT_OF_RESOURCES
;
555 BufferSize
= (UINTN
) SourceFileSize
;
556 *FileSize
= BufferSize
;
558 Status
= FileHandle
->Read (FileHandle
, &BufferSize
, Buffer
);
559 if (EFI_ERROR (Status
) || BufferSize
!= *FileSize
) {
562 Status
= EFI_BAD_BUFFER_SIZE
;
573 This function will open a file or directory referenced by DevicePath.
575 This function opens a file with the open mode according to the file path. The
576 Attributes is valid only for EFI_FILE_MODE_CREATE.
578 @param[in, out] FilePath On input, the device path to the file.
579 On output, the remaining device path.
580 @param[out] FileHandle Pointer to the file handle.
581 @param[in] OpenMode The mode to open the file with.
582 @param[in] Attributes The file's file attributes.
584 @retval EFI_SUCCESS The information was set.
585 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
586 @retval EFI_UNSUPPORTED Could not open the file path.
587 @retval EFI_NOT_FOUND The specified file could not be found on the
588 device or the file system could not be found on
590 @retval EFI_NO_MEDIA The device has no medium.
591 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
592 medium is no longer supported.
593 @retval EFI_DEVICE_ERROR The device reported an error.
594 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
595 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
596 @retval EFI_ACCESS_DENIED The file was opened read only.
597 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
599 @retval EFI_VOLUME_FULL The volume is full.
603 OpenFileByDevicePath (
604 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
,
605 OUT EFI_FILE_HANDLE
*FileHandle
,
611 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*EfiSimpleFileSystemProtocol
;
612 EFI_FILE_PROTOCOL
*Handle1
;
613 EFI_FILE_PROTOCOL
*Handle2
;
614 EFI_HANDLE DeviceHandle
;
616 if ((FilePath
== NULL
|| FileHandle
== NULL
)) {
617 return EFI_INVALID_PARAMETER
;
620 Status
= gBS
->LocateDevicePath (
621 &gEfiSimpleFileSystemProtocolGuid
,
625 if (EFI_ERROR (Status
)) {
629 Status
= gBS
->OpenProtocol(
631 &gEfiSimpleFileSystemProtocolGuid
,
632 (VOID
**)&EfiSimpleFileSystemProtocol
,
635 EFI_OPEN_PROTOCOL_GET_PROTOCOL
637 if (EFI_ERROR (Status
)) {
641 Status
= EfiSimpleFileSystemProtocol
->OpenVolume(EfiSimpleFileSystemProtocol
, &Handle1
);
642 if (EFI_ERROR (Status
)) {
648 // go down directories one node at a time.
650 while (!IsDevicePathEnd (*FilePath
)) {
652 // For file system access each node should be a file path component
654 if (DevicePathType (*FilePath
) != MEDIA_DEVICE_PATH
||
655 DevicePathSubType (*FilePath
) != MEDIA_FILEPATH_DP
658 return (EFI_INVALID_PARAMETER
);
661 // Open this file path node
667 // Try to test opening an existing file
669 Status
= Handle2
->Open (
672 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
673 OpenMode
&~EFI_FILE_MODE_CREATE
,
678 // see if the error was that it needs to be created
680 if ((EFI_ERROR (Status
)) && (OpenMode
!= (OpenMode
&~EFI_FILE_MODE_CREATE
))) {
681 Status
= Handle2
->Open (
684 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
690 // Close the last node
692 Handle2
->Close (Handle2
);
694 if (EFI_ERROR(Status
)) {
701 *FilePath
= NextDevicePathNode (*FilePath
);
705 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!
707 *FileHandle
= (VOID
*)Handle1
;
712 This function converts an input device structure to a Unicode string.
714 @param[in] DevPath A pointer to the device path structure.
716 @return A new allocated Unicode string that represents the device path.
722 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
725 return ConvertDevicePathToText (
734 Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.
735 The caller is responsible for freeing the allocated buffer using FreePool(). If return NULL
736 means not enough memory resource.
738 @param DevicePath Device path.
740 @retval NULL Not enough memory resourece for AllocateCopyPool.
741 @retval Other A new allocated string that represents the file name.
745 ExtractFileNameFromDevicePath (
746 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
755 ASSERT(DevicePath
!= NULL
);
757 String
= DevicePathToStr(DevicePath
);
758 MatchString
= String
;
762 while(MatchString
!= NULL
){
763 LastMatch
= MatchString
+ 1;
764 MatchString
= StrStr(LastMatch
,L
"\\");
767 Length
= StrLen(LastMatch
);
768 FileName
= AllocateCopyPool ((Length
+ 1) * sizeof(CHAR16
), LastMatch
);
769 if (FileName
!= NULL
) {
770 *(FileName
+ Length
) = 0;
779 Enroll a new X509 certificate into Variable.
781 @param[in] PrivateData The module's private data.
782 @param[in] VariableName Variable name of CA database.
784 @retval EFI_SUCCESS New X509 is enrolled successfully.
785 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
789 EnrollX509toVariable (
790 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
,
791 IN CHAR16
*VariableName
797 EFI_SIGNATURE_LIST
*CACert
;
798 EFI_SIGNATURE_DATA
*CACertData
;
812 Status
= ReadFileContent (
813 Private
->FileContext
->FHandle
,
818 if (EFI_ERROR (Status
)) {
821 ASSERT (X509Data
!= NULL
);
823 SigDataSize
= sizeof(EFI_SIGNATURE_LIST
) + sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
;
825 Data
= AllocateZeroPool (SigDataSize
);
827 Status
= EFI_OUT_OF_RESOURCES
;
832 // Fill Certificate Database parameters.
834 CACert
= (EFI_SIGNATURE_LIST
*) Data
;
835 CACert
->SignatureListSize
= (UINT32
) SigDataSize
;
836 CACert
->SignatureHeaderSize
= 0;
837 CACert
->SignatureSize
= (UINT32
) (sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
);
838 CopyGuid (&CACert
->SignatureType
, &gEfiCertX509Guid
);
840 CACertData
= (EFI_SIGNATURE_DATA
*) ((UINT8
* ) CACert
+ sizeof (EFI_SIGNATURE_LIST
));
841 CopyGuid (&CACertData
->SignatureOwner
, Private
->CertGuid
);
842 CopyMem ((UINT8
* ) (CACertData
->SignatureData
), X509Data
, X509DataSize
);
845 // Check if signature database entry has been already existed.
846 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
847 // new signature data to original variable
849 Attr
= TLS_AUTH_CONFIG_VAR_BASE_ATTR
;
851 Status
= gRT
->GetVariable(
853 &gEfiTlsCaCertificateGuid
,
858 if (Status
== EFI_BUFFER_TOO_SMALL
) {
859 Attr
|= EFI_VARIABLE_APPEND_WRITE
;
860 } else if (Status
!= EFI_NOT_FOUND
) {
864 Status
= gRT
->SetVariable(
866 &gEfiTlsCaCertificateGuid
,
871 if (EFI_ERROR (Status
)) {
877 CloseFile (Private
->FileContext
->FHandle
);
878 if (Private
->FileContext
->FileName
!= NULL
) {
879 FreePool(Private
->FileContext
->FileName
);
880 Private
->FileContext
->FileName
= NULL
;
883 Private
->FileContext
->FHandle
= NULL
;
885 if (Private
->CertGuid
!= NULL
) {
886 FreePool (Private
->CertGuid
);
887 Private
->CertGuid
= NULL
;
894 if (X509Data
!= NULL
) {
902 Enroll Cert into TlsCaCertificate. The GUID will be Private->CertGuid.
904 @param[in] PrivateData The module's private data.
905 @param[in] VariableName Variable name of signature database.
907 @retval EFI_SUCCESS New Cert enrolled successfully.
908 @retval EFI_INVALID_PARAMETER The parameter is invalid.
909 @retval EFI_UNSUPPORTED The Cert file is unsupported type.
910 @retval others Fail to enroll Cert data.
915 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
,
916 IN CHAR16
*VariableName
922 if ((Private
->FileContext
->FileName
== NULL
) || (Private
->FileContext
->FHandle
== NULL
) || (Private
->CertGuid
== NULL
)) {
923 return EFI_INVALID_PARAMETER
;
927 // Parse the file's postfix.
929 NameLength
= StrLen (Private
->FileContext
->FileName
);
930 if (NameLength
<= 4) {
931 return EFI_INVALID_PARAMETER
;
933 FilePostFix
= Private
->FileContext
->FileName
+ NameLength
- 4;
935 if (IsDerPemEncodeCertificate (FilePostFix
)) {
937 // Supports DER-encoded X509 certificate.
939 return EnrollX509toVariable (Private
, VariableName
);
942 return EFI_UNSUPPORTED
;
946 Refresh the global UpdateData structure.
955 // Free current updated date
957 if (mStartOpCodeHandle
!= NULL
) {
958 HiiFreeOpCodeHandle (mStartOpCodeHandle
);
962 // Create new OpCode Handle
964 mStartOpCodeHandle
= HiiAllocateOpCodeHandle ();
967 // Create Hii Extend Label OpCode as the start opcode
969 mStartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
973 sizeof (EFI_IFR_GUID_LABEL
)
975 mStartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
979 Clean up the dynamic opcode at label and form specified by both LabelId.
981 @param[in] LabelId It is both the Form ID and Label ID for opcode deletion.
982 @param[in] PrivateData Module private data.
988 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*PrivateData
991 RefreshUpdateData ();
994 // Remove all op-codes from dynamic page
996 mStartLabel
->Number
= LabelId
;
998 PrivateData
->RegisteredHandle
,
1001 mStartOpCodeHandle
, // Label LabelId
1002 mEndOpCodeHandle
// LABEL_END
1007 Update the form base on the selected file.
1009 @param FilePath Point to the file path.
1010 @param FormId The form need to display.
1012 @retval TRUE Exit caller function.
1013 @retval FALSE Not exit caller function.
1018 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1019 IN EFI_FORM_ID FormId
1023 EFI_STRING_ID StringToken
;
1027 if (FilePath
!= NULL
) {
1028 FileName
= ExtractFileNameFromDevicePath(FilePath
);
1030 if (FileName
== NULL
) {
1032 // FileName = NULL has two case:
1033 // 1. FilePath == NULL, not select file.
1034 // 2. FilePath != NULL, but ExtractFileNameFromDevicePath return NULL not enough memory resource.
1035 // In these two case, no need to update the form, and exit the caller function.
1039 StringToken
= HiiSetString (mTlsAuthPrivateData
->RegisteredHandle
, 0, FileName
, NULL
);
1041 mTlsAuthPrivateData
->FileContext
->FileName
= FileName
;
1043 OpenFileByDevicePath (
1045 &mTlsAuthPrivateData
->FileContext
->FHandle
,
1050 // Create Subtitle op-code for the display string of the option.
1052 RefreshUpdateData ();
1053 mStartLabel
->Number
= FormId
;
1055 HiiCreateSubTitleOpCode (
1064 mTlsAuthPrivateData
->RegisteredHandle
,
1065 &gTlsAuthConfigGuid
,
1067 mStartOpCodeHandle
, /// Label FormId
1068 mEndOpCodeHandle
/// LABEL_END
1075 Update the form base on the input file path info.
1077 @param FilePath Point to the file path.
1079 @retval TRUE Exit caller function.
1080 @retval FALSE Not exit caller function.
1085 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1088 return UpdatePage(FilePath
, TLS_AUTH_CONFIG_FORMID4_FORM
);
1092 Unload the configuration form, this includes: delete all the configuration
1093 entries, uninstall the form callback protocol, and free the resources used.
1095 @param[in] Private Pointer to the driver private data.
1097 @retval EFI_SUCCESS The configuration form is unloaded.
1098 @retval Others Failed to unload the form.
1102 TlsAuthConfigFormUnload (
1103 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
1106 if (Private
->DriverHandle
!= NULL
) {
1108 // Uninstall EFI_HII_CONFIG_ACCESS_PROTOCOL
1110 gBS
->UninstallMultipleProtocolInterfaces (
1111 Private
->DriverHandle
,
1112 &gEfiDevicePathProtocolGuid
,
1113 &mTlsAuthConfigHiiVendorDevicePath
,
1114 &gEfiHiiConfigAccessProtocolGuid
,
1115 &Private
->ConfigAccess
,
1118 Private
->DriverHandle
= NULL
;
1121 if (Private
->RegisteredHandle
!= NULL
) {
1123 // Remove HII package list
1125 HiiRemovePackages (Private
->RegisteredHandle
);
1126 Private
->RegisteredHandle
= NULL
;
1129 if (Private
->CertGuid
!= NULL
) {
1130 FreePool (Private
->CertGuid
);
1133 if (Private
->FileContext
!= NULL
) {
1134 FreePool (Private
->FileContext
);
1139 if (mStartOpCodeHandle
!= NULL
) {
1140 HiiFreeOpCodeHandle (mStartOpCodeHandle
);
1143 if (mEndOpCodeHandle
!= NULL
) {
1144 HiiFreeOpCodeHandle (mEndOpCodeHandle
);
1152 Initialize the configuration form.
1154 @param[in] Private Pointer to the driver private data.
1156 @retval EFI_SUCCESS The configuration form is initialized.
1157 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1161 TlsAuthConfigFormInit (
1162 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
1167 Private
->Signature
= TLS_AUTH_CONFIG_PRIVATE_DATA_SIGNATURE
;
1169 Private
->ConfigAccess
.ExtractConfig
= TlsAuthConfigAccessExtractConfig
;
1170 Private
->ConfigAccess
.RouteConfig
= TlsAuthConfigAccessRouteConfig
;
1171 Private
->ConfigAccess
.Callback
= TlsAuthConfigAccessCallback
;
1174 // Install Device Path Protocol and Config Access protocol to driver handle.
1176 Status
= gBS
->InstallMultipleProtocolInterfaces (
1177 &Private
->DriverHandle
,
1178 &gEfiDevicePathProtocolGuid
,
1179 &mTlsAuthConfigHiiVendorDevicePath
,
1180 &gEfiHiiConfigAccessProtocolGuid
,
1181 &Private
->ConfigAccess
,
1184 if (EFI_ERROR (Status
)) {
1189 // Publish our HII data.
1191 Private
->RegisteredHandle
= HiiAddPackages (
1192 &gTlsAuthConfigGuid
,
1193 Private
->DriverHandle
,
1194 TlsAuthConfigDxeStrings
,
1195 TlsAuthConfigVfrBin
,
1198 if (Private
->RegisteredHandle
== NULL
) {
1199 Status
= EFI_OUT_OF_RESOURCES
;
1203 Private
->FileContext
= AllocateZeroPool (sizeof (TLS_AUTH_CONFIG_FILE_CONTEXT
));
1204 if (Private
->FileContext
== NULL
) {
1205 Status
= EFI_OUT_OF_RESOURCES
;
1210 // Init OpCode Handle and Allocate space for creation of Buffer
1212 mStartOpCodeHandle
= HiiAllocateOpCodeHandle ();
1213 if (mStartOpCodeHandle
== NULL
) {
1214 Status
= EFI_OUT_OF_RESOURCES
;
1218 mEndOpCodeHandle
= HiiAllocateOpCodeHandle ();
1219 if (mEndOpCodeHandle
== NULL
) {
1220 Status
= EFI_OUT_OF_RESOURCES
;
1225 // Create Hii Extend Label OpCode as the start opcode
1227 mStartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
1231 sizeof (EFI_IFR_GUID_LABEL
)
1233 mStartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1236 // Create Hii Extend Label OpCode as the end opcode
1238 mEndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
1242 sizeof (EFI_IFR_GUID_LABEL
)
1244 mEndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1245 mEndLabel
->Number
= LABEL_END
;
1250 TlsAuthConfigFormUnload (Private
);
1256 This function allows the caller to request the current
1257 configuration for one or more named elements. The resulting
1258 string is in <ConfigAltResp> format. Any and all alternative
1259 configuration strings shall also be appended to the end of the
1260 current configuration string. If they are, they must appear
1261 after the current configuration. They must contain the same
1262 routing (GUID, NAME, PATH) as the current configuration string.
1263 They must have an additional description indicating the type of
1264 alternative configuration the string represents,
1265 "ALTCFG=<StringToken>". That <StringToken> (when
1266 converted from Hex UNICODE to binary) is a reference to a
1267 string in the associated string pack.
1269 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1271 @param Request A null-terminated Unicode string in
1272 <ConfigRequest> format. Note that this
1273 includes the routing information as well as
1274 the configurable name / value pairs. It is
1275 invalid for this string to be in
1276 <MultiConfigRequest> format.
1277 If a NULL is passed in for the Request field,
1278 all of the settings being abstracted by this function
1279 will be returned in the Results field. In addition,
1280 if a ConfigHdr is passed in with no request elements,
1281 all of the settings being abstracted for that particular
1282 ConfigHdr reference will be returned in the Results Field.
1284 @param Progress On return, points to a character in the
1285 Request string. Points to the string's null
1286 terminator if request was successful. Points
1287 to the most recent "&" before the first
1288 failing name / value pair (or the beginning
1289 of the string if the failure is in the first
1290 name / value pair) if the request was not
1293 @param Results A null-terminated Unicode string in
1294 <MultiConfigAltResp> format which has all values
1295 filled in for the names in the Request string.
1296 String to be allocated by the called function.
1298 @retval EFI_SUCCESS The Results string is filled with the
1299 values corresponding to all requested
1302 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
1303 parts of the results that must be
1304 stored awaiting possible future
1307 @retval EFI_NOT_FOUND Routing data doesn't match any
1308 known driver. Progress set to the
1309 first character in the routing header.
1310 Note: There is no requirement that the
1311 driver validate the routing data. It
1312 must skip the <ConfigHdr> in order to
1315 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
1316 to most recent "&" before the
1317 error or the beginning of the
1320 @retval EFI_INVALID_PARAMETER Unknown name. Progress points
1321 to the & before the name in
1327 TlsAuthConfigAccessExtractConfig (
1328 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1329 IN CONST EFI_STRING Request
,
1330 OUT EFI_STRING
*Progress
,
1331 OUT EFI_STRING
*Results
1337 EFI_STRING ConfigRequest
;
1338 EFI_STRING ConfigRequestHdr
;
1339 TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
;
1340 BOOLEAN AllocatedRequest
;
1342 if (Progress
== NULL
|| Results
== NULL
) {
1343 return EFI_INVALID_PARAMETER
;
1346 AllocatedRequest
= FALSE
;
1347 ConfigRequestHdr
= NULL
;
1348 ConfigRequest
= NULL
;
1351 Private
= TLS_AUTH_CONFIG_PRIVATE_FROM_THIS (This
);
1353 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1354 ZeroMem (&Private
->TlsAuthConfigNvData
, BufferSize
);
1356 *Progress
= Request
;
1358 if ((Request
!= NULL
) && !HiiIsConfigHdrMatch (Request
, &gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
)) {
1359 return EFI_NOT_FOUND
;
1362 ConfigRequest
= Request
;
1363 if ((Request
== NULL
) || (StrStr (Request
, L
"OFFSET") == NULL
)) {
1365 // Request is set to NULL or OFFSET is NULL, construct full request string.
1367 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
1368 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
1370 ConfigRequestHdr
= HiiConstructConfigHdr (&gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
, Private
->DriverHandle
);
1371 Size
= (StrLen (ConfigRequestHdr
) + 32 + 1) * sizeof (CHAR16
);
1372 ConfigRequest
= AllocateZeroPool (Size
);
1373 ASSERT (ConfigRequest
!= NULL
);
1374 AllocatedRequest
= TRUE
;
1375 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr
, (UINT64
)BufferSize
);
1376 FreePool (ConfigRequestHdr
);
1377 ConfigRequestHdr
= NULL
;
1380 Status
= gHiiConfigRouting
->BlockToConfig (
1383 (UINT8
*) &Private
->TlsAuthConfigNvData
,
1390 // Free the allocated config request string.
1392 if (AllocatedRequest
) {
1393 FreePool (ConfigRequest
);
1397 // Set Progress string to the original request string.
1399 if (Request
== NULL
) {
1401 } else if (StrStr (Request
, L
"OFFSET") == NULL
) {
1402 *Progress
= Request
+ StrLen (Request
);
1410 This function applies changes in a driver's configuration.
1411 Input is a Configuration, which has the routing data for this
1412 driver followed by name / value configuration pairs. The driver
1413 must apply those pairs to its configurable storage. If the
1414 driver's configuration is stored in a linear block of data
1415 and the driver's name / value pairs are in <BlockConfig>
1416 format, it may use the ConfigToBlock helper function (above) to
1419 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1421 @param Configuration A null-terminated Unicode string in
1422 <ConfigString> format.
1424 @param Progress A pointer to a string filled in with the
1425 offset of the most recent '&' before the
1426 first failing name / value pair (or the
1427 beginn ing of the string if the failure
1428 is in the first name / value pair) or
1429 the terminating NULL if all was
1432 @retval EFI_SUCCESS The results have been distributed or are
1433 awaiting distribution.
1435 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
1436 parts of the results that must be
1437 stored awaiting possible future
1440 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the
1441 Results parameter would result
1442 in this type of error.
1444 @retval EFI_NOT_FOUND Target for the specified routing data
1450 TlsAuthConfigAccessRouteConfig (
1451 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1452 IN CONST EFI_STRING Configuration
,
1453 OUT EFI_STRING
*Progress
1458 TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
;
1460 if (Progress
== NULL
) {
1461 return EFI_INVALID_PARAMETER
;
1463 *Progress
= Configuration
;
1465 if (Configuration
== NULL
) {
1466 return EFI_INVALID_PARAMETER
;
1470 // Check routing data in <ConfigHdr>.
1471 // Note: there is no name for Name/Value storage, only GUID will be checked
1473 if (!HiiIsConfigHdrMatch (Configuration
, &gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
)) {
1474 return EFI_NOT_FOUND
;
1477 Private
= TLS_AUTH_CONFIG_PRIVATE_FROM_THIS (This
);
1479 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1480 ZeroMem (&Private
->TlsAuthConfigNvData
, BufferSize
);
1482 Status
= gHiiConfigRouting
->ConfigToBlock (
1485 (UINT8
*) &Private
->TlsAuthConfigNvData
,
1489 if (EFI_ERROR (Status
)) {
1498 This function is called to provide results data to the driver.
1499 This data consists of a unique key that is used to identify
1500 which data is either being passed back or being asked for.
1502 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1503 @param Action Specifies the type of action taken by the browser.
1504 @param QuestionId A unique value which is sent to the original
1505 exporting driver so that it can identify the type
1506 of data to expect. The format of the data tends to
1507 vary based on the opcode that generated the callback.
1508 @param Type The type of value for the question.
1509 @param Value A pointer to the data being sent to the original
1511 @param ActionRequest On return, points to the action requested by the
1514 @retval EFI_SUCCESS The callback successfully handled the action.
1515 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
1516 variable and its data.
1517 @retval EFI_DEVICE_ERROR The variable could not be saved.
1518 @retval EFI_UNSUPPORTED The specified Action is not supported by the
1523 TlsAuthConfigAccessCallback (
1524 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1525 IN EFI_BROWSER_ACTION Action
,
1526 IN EFI_QUESTION_ID QuestionId
,
1528 IN OUT EFI_IFR_TYPE_VALUE
*Value
,
1529 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
1534 RETURN_STATUS RStatus
;
1535 TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
;
1537 TLS_AUTH_CONFIG_IFR_NVDATA
*IfrNvData
;
1539 EFI_DEVICE_PATH_PROTOCOL
*File
;
1541 Status
= EFI_SUCCESS
;
1544 if ((This
== NULL
) || (Value
== NULL
) || (ActionRequest
== NULL
)) {
1545 return EFI_INVALID_PARAMETER
;
1548 Private
= TLS_AUTH_CONFIG_PRIVATE_FROM_THIS (This
);
1550 mTlsAuthPrivateData
= Private
;
1553 // Retrieve uncommitted data from Browser
1555 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1556 IfrNvData
= AllocateZeroPool (BufferSize
);
1557 if (IfrNvData
== NULL
) {
1558 return EFI_OUT_OF_RESOURCES
;
1561 HiiGetBrowserData (&gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
, BufferSize
, (UINT8
*) IfrNvData
);
1563 if ((Action
!= EFI_BROWSER_ACTION_CHANGED
) &&
1564 (Action
!= EFI_BROWSER_ACTION_CHANGING
)) {
1565 Status
= EFI_UNSUPPORTED
;
1569 if (Action
== EFI_BROWSER_ACTION_CHANGING
) {
1570 switch (QuestionId
) {
1571 case KEY_TLS_AUTH_CONFIG_CLIENT_CERT
:
1572 case KEY_TLS_AUTH_CONFIG_SERVER_CA
:
1576 ZeroMem (IfrNvData
->CertGuid
, sizeof (IfrNvData
->CertGuid
));
1577 if (Private
->CertGuid
== NULL
) {
1578 Private
->CertGuid
= (EFI_GUID
*) AllocateZeroPool (sizeof (EFI_GUID
));
1579 if (Private
->CertGuid
== NULL
) {
1580 return EFI_OUT_OF_RESOURCES
;
1583 if (QuestionId
== KEY_TLS_AUTH_CONFIG_CLIENT_CERT
) {
1584 LabelId
= TLS_AUTH_CONFIG_FORMID3_FORM
;
1586 LabelId
= TLS_AUTH_CONFIG_FORMID4_FORM
;
1590 // Refresh selected file.
1592 CleanUpPage (LabelId
, Private
);
1594 case KEY_TLS_AUTH_CONFIG_ENROLL_CERT_FROM_FILE
:
1595 ChooseFile( NULL
, NULL
, UpdateCAFromFile
, &File
);
1598 case KEY_TLS_AUTH_CONFIG_VALUE_SAVE_AND_EXIT
:
1599 Status
= EnrollCertDatabase (Private
, EFI_TLS_CA_CERTIFICATE_VARIABLE
);
1600 if (EFI_ERROR (Status
)) {
1602 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
1604 L
"ERROR: Enroll Cert Failure!",
1610 case KEY_TLS_AUTH_CONFIG_VALUE_NO_SAVE_AND_EXIT
:
1611 if (Private
->FileContext
->FHandle
!= NULL
) {
1612 CloseFile (Private
->FileContext
->FHandle
);
1613 Private
->FileContext
->FHandle
= NULL
;
1614 if (Private
->FileContext
->FileName
!= NULL
){
1615 FreePool(Private
->FileContext
->FileName
);
1616 Private
->FileContext
->FileName
= NULL
;
1620 if (Private
->CertGuid
!= NULL
) {
1621 FreePool (Private
->CertGuid
);
1622 Private
->CertGuid
= NULL
;
1626 case KEY_TLS_AUTH_CONFIG_DELETE_CERT
:
1629 EFI_TLS_CA_CERTIFICATE_VARIABLE
,
1630 &gEfiTlsCaCertificateGuid
,
1632 TLS_AUTH_CONFIG_FORMID5_FORM
,
1633 OPTION_DEL_CA_ESTION_ID
1638 if ((QuestionId
>= OPTION_DEL_CA_ESTION_ID
) &&
1639 (QuestionId
< (OPTION_DEL_CA_ESTION_ID
+ OPTION_CONFIG_RANGE
))) {
1642 EFI_TLS_CA_CERTIFICATE_VARIABLE
,
1643 &gEfiTlsCaCertificateGuid
,
1645 TLS_AUTH_CONFIG_FORMID5_FORM
,
1646 OPTION_DEL_CA_ESTION_ID
,
1647 QuestionId
- OPTION_DEL_CA_ESTION_ID
1652 } else if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
1653 switch (QuestionId
) {
1654 case KEY_TLS_AUTH_CONFIG_CERT_GUID
:
1655 ASSERT (Private
->CertGuid
!= NULL
);
1656 RStatus
= StrToGuid (
1657 IfrNvData
->CertGuid
,
1660 if (RETURN_ERROR (RStatus
) || (IfrNvData
->CertGuid
[GUID_STRING_LENGTH
] != L
'\0')) {
1661 Status
= EFI_INVALID_PARAMETER
;
1665 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
;
1674 if (!EFI_ERROR (Status
)) {
1675 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1676 HiiSetBrowserData (&gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
, BufferSize
, (UINT8
*) IfrNvData
, NULL
);
1679 FreePool (IfrNvData
);