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] Private 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 Clean the file related resource.
482 @param[in] Private Module's private data.
487 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
490 if (Private
->FileContext
->FHandle
!= NULL
) {
491 Private
->FileContext
->FHandle
->Close (Private
->FileContext
->FHandle
);
492 Private
->FileContext
->FHandle
= NULL
;
493 if (Private
->FileContext
->FileName
!= NULL
){
494 FreePool(Private
->FileContext
->FileName
);
495 Private
->FileContext
->FileName
= NULL
;
501 Read file content into BufferPtr, the size of the allocate buffer
502 is *FileSize plus AddtionAllocateSize.
504 @param[in] FileHandle The file to be read.
505 @param[in, out] BufferPtr Pointers to the pointer of allocated buffer.
506 @param[out] FileSize Size of input file
507 @param[in] AddtionAllocateSize Addtion size the buffer need to be allocated.
508 In case the buffer need to contain others besides the file content.
510 @retval EFI_SUCCESS The file was read into the buffer.
511 @retval EFI_INVALID_PARAMETER A parameter was invalid.
512 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
513 @retval others Unexpected error.
518 IN EFI_FILE_HANDLE FileHandle
,
519 IN OUT VOID
**BufferPtr
,
521 IN UINTN AddtionAllocateSize
526 UINT64 SourceFileSize
;
530 if ((FileHandle
== NULL
) || (FileSize
== NULL
)) {
531 return EFI_INVALID_PARAMETER
;
539 Status
= FileHandle
->SetPosition (FileHandle
, (UINT64
) -1);
540 if (EFI_ERROR (Status
)) {
544 Status
= FileHandle
->GetPosition (FileHandle
, &SourceFileSize
);
545 if (EFI_ERROR (Status
)) {
549 Status
= FileHandle
->SetPosition (FileHandle
, 0);
550 if (EFI_ERROR (Status
)) {
554 BufferSize
= (UINTN
) SourceFileSize
+ AddtionAllocateSize
;
555 Buffer
= AllocateZeroPool(BufferSize
);
556 if (Buffer
== NULL
) {
557 return EFI_OUT_OF_RESOURCES
;
560 BufferSize
= (UINTN
) SourceFileSize
;
561 *FileSize
= BufferSize
;
563 Status
= FileHandle
->Read (FileHandle
, &BufferSize
, Buffer
);
564 if (EFI_ERROR (Status
) || BufferSize
!= *FileSize
) {
567 Status
= EFI_BAD_BUFFER_SIZE
;
578 This function will open a file or directory referenced by DevicePath.
580 This function opens a file with the open mode according to the file path. The
581 Attributes is valid only for EFI_FILE_MODE_CREATE.
583 @param[in, out] FilePath On input, the device path to the file.
584 On output, the remaining device path.
585 @param[out] FileHandle Pointer to the file handle.
586 @param[in] OpenMode The mode to open the file with.
587 @param[in] Attributes The file's file attributes.
589 @retval EFI_SUCCESS The information was set.
590 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
591 @retval EFI_UNSUPPORTED Could not open the file path.
592 @retval EFI_NOT_FOUND The specified file could not be found on the
593 device or the file system could not be found on
595 @retval EFI_NO_MEDIA The device has no medium.
596 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
597 medium is no longer supported.
598 @retval EFI_DEVICE_ERROR The device reported an error.
599 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
600 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
601 @retval EFI_ACCESS_DENIED The file was opened read only.
602 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
604 @retval EFI_VOLUME_FULL The volume is full.
608 OpenFileByDevicePath (
609 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
,
610 OUT EFI_FILE_HANDLE
*FileHandle
,
616 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*EfiSimpleFileSystemProtocol
;
617 EFI_FILE_PROTOCOL
*Handle1
;
618 EFI_FILE_PROTOCOL
*Handle2
;
619 EFI_HANDLE DeviceHandle
;
621 if ((FilePath
== NULL
|| FileHandle
== NULL
)) {
622 return EFI_INVALID_PARAMETER
;
625 Status
= gBS
->LocateDevicePath (
626 &gEfiSimpleFileSystemProtocolGuid
,
630 if (EFI_ERROR (Status
)) {
634 Status
= gBS
->OpenProtocol(
636 &gEfiSimpleFileSystemProtocolGuid
,
637 (VOID
**)&EfiSimpleFileSystemProtocol
,
640 EFI_OPEN_PROTOCOL_GET_PROTOCOL
642 if (EFI_ERROR (Status
)) {
646 Status
= EfiSimpleFileSystemProtocol
->OpenVolume(EfiSimpleFileSystemProtocol
, &Handle1
);
647 if (EFI_ERROR (Status
)) {
653 // go down directories one node at a time.
655 while (!IsDevicePathEnd (*FilePath
)) {
657 // For file system access each node should be a file path component
659 if (DevicePathType (*FilePath
) != MEDIA_DEVICE_PATH
||
660 DevicePathSubType (*FilePath
) != MEDIA_FILEPATH_DP
663 return (EFI_INVALID_PARAMETER
);
666 // Open this file path node
672 // Try to test opening an existing file
674 Status
= Handle2
->Open (
677 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
678 OpenMode
&~EFI_FILE_MODE_CREATE
,
683 // see if the error was that it needs to be created
685 if ((EFI_ERROR (Status
)) && (OpenMode
!= (OpenMode
&~EFI_FILE_MODE_CREATE
))) {
686 Status
= Handle2
->Open (
689 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
695 // Close the last node
697 Handle2
->Close (Handle2
);
699 if (EFI_ERROR(Status
)) {
706 *FilePath
= NextDevicePathNode (*FilePath
);
710 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!
712 *FileHandle
= (VOID
*)Handle1
;
717 This function converts an input device structure to a Unicode string.
719 @param[in] DevPath A pointer to the device path structure.
721 @return A new allocated Unicode string that represents the device path.
727 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
730 return ConvertDevicePathToText (
739 Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.
740 The caller is responsible for freeing the allocated buffer using FreePool(). If return NULL
741 means not enough memory resource.
743 @param DevicePath Device path.
745 @retval NULL Not enough memory resourece for AllocateCopyPool.
746 @retval Other A new allocated string that represents the file name.
750 ExtractFileNameFromDevicePath (
751 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
760 ASSERT(DevicePath
!= NULL
);
762 String
= DevicePathToStr(DevicePath
);
763 MatchString
= String
;
767 while(MatchString
!= NULL
){
768 LastMatch
= MatchString
+ 1;
769 MatchString
= StrStr(LastMatch
,L
"\\");
772 Length
= StrLen(LastMatch
);
773 FileName
= AllocateCopyPool ((Length
+ 1) * sizeof(CHAR16
), LastMatch
);
774 if (FileName
!= NULL
) {
775 *(FileName
+ Length
) = 0;
784 Enroll a new X509 certificate into Variable.
786 @param[in] PrivateData The module's private data.
787 @param[in] VariableName Variable name of CA database.
789 @retval EFI_SUCCESS New X509 is enrolled successfully.
790 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
794 EnrollX509toVariable (
795 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
,
796 IN CHAR16
*VariableName
802 EFI_SIGNATURE_LIST
*CACert
;
803 EFI_SIGNATURE_DATA
*CACertData
;
818 Status
= ReadFileContent (
819 Private
->FileContext
->FHandle
,
824 if (EFI_ERROR (Status
)) {
827 ASSERT (X509Data
!= NULL
);
829 SigDataSize
= sizeof(EFI_SIGNATURE_LIST
) + sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
;
831 Data
= AllocateZeroPool (SigDataSize
);
833 Status
= EFI_OUT_OF_RESOURCES
;
838 // Fill Certificate Database parameters.
840 CACert
= (EFI_SIGNATURE_LIST
*) Data
;
841 CACert
->SignatureListSize
= (UINT32
) SigDataSize
;
842 CACert
->SignatureHeaderSize
= 0;
843 CACert
->SignatureSize
= (UINT32
) (sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
);
844 CopyGuid (&CACert
->SignatureType
, &gEfiCertX509Guid
);
846 CACertData
= (EFI_SIGNATURE_DATA
*) ((UINT8
* ) CACert
+ sizeof (EFI_SIGNATURE_LIST
));
847 CopyGuid (&CACertData
->SignatureOwner
, Private
->CertGuid
);
848 CopyMem ((UINT8
* ) (CACertData
->SignatureData
), X509Data
, X509DataSize
);
851 // Check if the signature database entry already exists. If it does, use the
852 // EFI_VARIABLE_APPEND_WRITE attribute to append the new signature data to
853 // the original variable, plus preserve the original variable attributes.
855 Status
= gRT
->GetVariable(
857 &gEfiTlsCaCertificateGuid
,
862 if (Status
== EFI_BUFFER_TOO_SMALL
) {
863 Attr
|= EFI_VARIABLE_APPEND_WRITE
;
864 } else if (Status
== EFI_NOT_FOUND
) {
865 Attr
= TLS_AUTH_CONFIG_VAR_BASE_ATTR
;
870 Status
= gRT
->SetVariable(
872 &gEfiTlsCaCertificateGuid
,
877 if (EFI_ERROR (Status
)) {
882 CleanFileContext (Private
);
884 if (Private
->CertGuid
!= NULL
) {
885 FreePool (Private
->CertGuid
);
886 Private
->CertGuid
= NULL
;
893 if (X509Data
!= NULL
) {
901 Enroll Cert into TlsCaCertificate. The GUID will be Private->CertGuid.
903 @param[in] PrivateData The module's private data.
904 @param[in] VariableName Variable name of signature database.
906 @retval EFI_SUCCESS New Cert enrolled successfully.
907 @retval EFI_INVALID_PARAMETER The parameter is invalid.
908 @retval EFI_UNSUPPORTED The Cert file is unsupported type.
909 @retval others Fail to enroll Cert data.
914 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
,
915 IN CHAR16
*VariableName
921 if ((Private
->FileContext
->FileName
== NULL
) || (Private
->FileContext
->FHandle
== NULL
) || (Private
->CertGuid
== NULL
)) {
922 return EFI_INVALID_PARAMETER
;
926 // Parse the file's postfix.
928 NameLength
= StrLen (Private
->FileContext
->FileName
);
929 if (NameLength
<= 4) {
930 return EFI_INVALID_PARAMETER
;
932 FilePostFix
= Private
->FileContext
->FileName
+ NameLength
- 4;
934 if (IsDerPemEncodeCertificate (FilePostFix
)) {
936 // Supports DER-encoded X509 certificate.
938 return EnrollX509toVariable (Private
, VariableName
);
941 return EFI_UNSUPPORTED
;
945 Refresh the global UpdateData structure.
954 // Free current updated date
956 if (mStartOpCodeHandle
!= NULL
) {
957 HiiFreeOpCodeHandle (mStartOpCodeHandle
);
961 // Create new OpCode Handle
963 mStartOpCodeHandle
= HiiAllocateOpCodeHandle ();
966 // Create Hii Extend Label OpCode as the start opcode
968 mStartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
972 sizeof (EFI_IFR_GUID_LABEL
)
974 mStartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
978 Clean up the dynamic opcode at label and form specified by both LabelId.
980 @param[in] LabelId It is both the Form ID and Label ID for opcode deletion.
981 @param[in] PrivateData Module private data.
987 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*PrivateData
990 RefreshUpdateData ();
993 // Remove all op-codes from dynamic page
995 mStartLabel
->Number
= LabelId
;
997 PrivateData
->RegisteredHandle
,
1000 mStartOpCodeHandle
, // Label LabelId
1001 mEndOpCodeHandle
// LABEL_END
1006 Update the form base on the selected file.
1008 @param FilePath Point to the file path.
1009 @param FormId The form need to display.
1011 @retval TRUE Exit caller function.
1012 @retval FALSE Not exit caller function.
1017 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
1018 IN EFI_FORM_ID FormId
1022 EFI_STRING_ID StringToken
;
1026 if (FilePath
!= NULL
) {
1027 FileName
= ExtractFileNameFromDevicePath(FilePath
);
1029 if (FileName
== NULL
) {
1031 // FileName = NULL has two case:
1032 // 1. FilePath == NULL, not select file.
1033 // 2. FilePath != NULL, but ExtractFileNameFromDevicePath return NULL not enough memory resource.
1034 // In these two case, no need to update the form, and exit the caller function.
1038 StringToken
= HiiSetString (mTlsAuthPrivateData
->RegisteredHandle
, 0, FileName
, NULL
);
1040 mTlsAuthPrivateData
->FileContext
->FileName
= FileName
;
1042 OpenFileByDevicePath (
1044 &mTlsAuthPrivateData
->FileContext
->FHandle
,
1049 // Create Subtitle op-code for the display string of the option.
1051 RefreshUpdateData ();
1052 mStartLabel
->Number
= FormId
;
1054 HiiCreateSubTitleOpCode (
1063 mTlsAuthPrivateData
->RegisteredHandle
,
1064 &gTlsAuthConfigGuid
,
1066 mStartOpCodeHandle
, /// Label FormId
1067 mEndOpCodeHandle
/// LABEL_END
1074 Update the form base on the input file path info.
1076 @param FilePath Point to the file path.
1078 @retval TRUE Exit caller function.
1079 @retval FALSE Not exit caller function.
1084 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
1087 return UpdatePage(FilePath
, TLS_AUTH_CONFIG_FORMID4_FORM
);
1091 Unload the configuration form, this includes: delete all the configuration
1092 entries, uninstall the form callback protocol, and free the resources used.
1094 @param[in] Private Pointer to the driver private data.
1096 @retval EFI_SUCCESS The configuration form is unloaded.
1097 @retval Others Failed to unload the form.
1101 TlsAuthConfigFormUnload (
1102 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
1105 if (Private
->DriverHandle
!= NULL
) {
1107 // Uninstall EFI_HII_CONFIG_ACCESS_PROTOCOL
1109 gBS
->UninstallMultipleProtocolInterfaces (
1110 Private
->DriverHandle
,
1111 &gEfiDevicePathProtocolGuid
,
1112 &mTlsAuthConfigHiiVendorDevicePath
,
1113 &gEfiHiiConfigAccessProtocolGuid
,
1114 &Private
->ConfigAccess
,
1117 Private
->DriverHandle
= NULL
;
1120 if (Private
->RegisteredHandle
!= NULL
) {
1122 // Remove HII package list
1124 HiiRemovePackages (Private
->RegisteredHandle
);
1125 Private
->RegisteredHandle
= NULL
;
1128 if (Private
->CertGuid
!= NULL
) {
1129 FreePool (Private
->CertGuid
);
1132 if (Private
->FileContext
!= NULL
) {
1133 FreePool (Private
->FileContext
);
1138 if (mStartOpCodeHandle
!= NULL
) {
1139 HiiFreeOpCodeHandle (mStartOpCodeHandle
);
1142 if (mEndOpCodeHandle
!= NULL
) {
1143 HiiFreeOpCodeHandle (mEndOpCodeHandle
);
1151 Initialize the configuration form.
1153 @param[in] Private Pointer to the driver private data.
1155 @retval EFI_SUCCESS The configuration form is initialized.
1156 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1160 TlsAuthConfigFormInit (
1161 IN TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
1166 Private
->Signature
= TLS_AUTH_CONFIG_PRIVATE_DATA_SIGNATURE
;
1168 Private
->ConfigAccess
.ExtractConfig
= TlsAuthConfigAccessExtractConfig
;
1169 Private
->ConfigAccess
.RouteConfig
= TlsAuthConfigAccessRouteConfig
;
1170 Private
->ConfigAccess
.Callback
= TlsAuthConfigAccessCallback
;
1173 // Install Device Path Protocol and Config Access protocol to driver handle.
1175 Status
= gBS
->InstallMultipleProtocolInterfaces (
1176 &Private
->DriverHandle
,
1177 &gEfiDevicePathProtocolGuid
,
1178 &mTlsAuthConfigHiiVendorDevicePath
,
1179 &gEfiHiiConfigAccessProtocolGuid
,
1180 &Private
->ConfigAccess
,
1183 if (EFI_ERROR (Status
)) {
1188 // Publish our HII data.
1190 Private
->RegisteredHandle
= HiiAddPackages (
1191 &gTlsAuthConfigGuid
,
1192 Private
->DriverHandle
,
1193 TlsAuthConfigDxeStrings
,
1194 TlsAuthConfigVfrBin
,
1197 if (Private
->RegisteredHandle
== NULL
) {
1198 Status
= EFI_OUT_OF_RESOURCES
;
1202 Private
->FileContext
= AllocateZeroPool (sizeof (TLS_AUTH_CONFIG_FILE_CONTEXT
));
1203 if (Private
->FileContext
== NULL
) {
1204 Status
= EFI_OUT_OF_RESOURCES
;
1209 // Init OpCode Handle and Allocate space for creation of Buffer
1211 mStartOpCodeHandle
= HiiAllocateOpCodeHandle ();
1212 if (mStartOpCodeHandle
== NULL
) {
1213 Status
= EFI_OUT_OF_RESOURCES
;
1217 mEndOpCodeHandle
= HiiAllocateOpCodeHandle ();
1218 if (mEndOpCodeHandle
== NULL
) {
1219 Status
= EFI_OUT_OF_RESOURCES
;
1224 // Create Hii Extend Label OpCode as the start opcode
1226 mStartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
1230 sizeof (EFI_IFR_GUID_LABEL
)
1232 mStartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1235 // Create Hii Extend Label OpCode as the end opcode
1237 mEndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
1241 sizeof (EFI_IFR_GUID_LABEL
)
1243 mEndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1244 mEndLabel
->Number
= LABEL_END
;
1249 TlsAuthConfigFormUnload (Private
);
1255 This function allows the caller to request the current
1256 configuration for one or more named elements. The resulting
1257 string is in <ConfigAltResp> format. Any and all alternative
1258 configuration strings shall also be appended to the end of the
1259 current configuration string. If they are, they must appear
1260 after the current configuration. They must contain the same
1261 routing (GUID, NAME, PATH) as the current configuration string.
1262 They must have an additional description indicating the type of
1263 alternative configuration the string represents,
1264 "ALTCFG=<StringToken>". That <StringToken> (when
1265 converted from Hex UNICODE to binary) is a reference to a
1266 string in the associated string pack.
1268 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1270 @param Request A null-terminated Unicode string in
1271 <ConfigRequest> format. Note that this
1272 includes the routing information as well as
1273 the configurable name / value pairs. It is
1274 invalid for this string to be in
1275 <MultiConfigRequest> format.
1276 If a NULL is passed in for the Request field,
1277 all of the settings being abstracted by this function
1278 will be returned in the Results field. In addition,
1279 if a ConfigHdr is passed in with no request elements,
1280 all of the settings being abstracted for that particular
1281 ConfigHdr reference will be returned in the Results Field.
1283 @param Progress On return, points to a character in the
1284 Request string. Points to the string's null
1285 terminator if request was successful. Points
1286 to the most recent "&" before the first
1287 failing name / value pair (or the beginning
1288 of the string if the failure is in the first
1289 name / value pair) if the request was not
1292 @param Results A null-terminated Unicode string in
1293 <MultiConfigAltResp> format which has all values
1294 filled in for the names in the Request string.
1295 String to be allocated by the called function.
1297 @retval EFI_SUCCESS The Results string is filled with the
1298 values corresponding to all requested
1301 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
1302 parts of the results that must be
1303 stored awaiting possible future
1306 @retval EFI_NOT_FOUND Routing data doesn't match any
1307 known driver. Progress set to the
1308 first character in the routing header.
1309 Note: There is no requirement that the
1310 driver validate the routing data. It
1311 must skip the <ConfigHdr> in order to
1314 @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set
1315 to most recent "&" before the
1316 error or the beginning of the
1319 @retval EFI_INVALID_PARAMETER Unknown name. Progress points
1320 to the & before the name in
1326 TlsAuthConfigAccessExtractConfig (
1327 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1328 IN CONST EFI_STRING Request
,
1329 OUT EFI_STRING
*Progress
,
1330 OUT EFI_STRING
*Results
1336 EFI_STRING ConfigRequest
;
1337 EFI_STRING ConfigRequestHdr
;
1338 TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
;
1339 BOOLEAN AllocatedRequest
;
1341 if (Progress
== NULL
|| Results
== NULL
) {
1342 return EFI_INVALID_PARAMETER
;
1345 AllocatedRequest
= FALSE
;
1346 ConfigRequestHdr
= NULL
;
1347 ConfigRequest
= NULL
;
1350 Private
= TLS_AUTH_CONFIG_PRIVATE_FROM_THIS (This
);
1352 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1353 ZeroMem (&Private
->TlsAuthConfigNvData
, BufferSize
);
1355 *Progress
= Request
;
1357 if ((Request
!= NULL
) && !HiiIsConfigHdrMatch (Request
, &gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
)) {
1358 return EFI_NOT_FOUND
;
1361 ConfigRequest
= Request
;
1362 if ((Request
== NULL
) || (StrStr (Request
, L
"OFFSET") == NULL
)) {
1364 // Request is set to NULL or OFFSET is NULL, construct full request string.
1366 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
1367 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
1369 ConfigRequestHdr
= HiiConstructConfigHdr (&gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
, Private
->DriverHandle
);
1370 Size
= (StrLen (ConfigRequestHdr
) + 32 + 1) * sizeof (CHAR16
);
1371 ConfigRequest
= AllocateZeroPool (Size
);
1372 ASSERT (ConfigRequest
!= NULL
);
1373 AllocatedRequest
= TRUE
;
1374 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr
, (UINT64
)BufferSize
);
1375 FreePool (ConfigRequestHdr
);
1376 ConfigRequestHdr
= NULL
;
1379 Status
= gHiiConfigRouting
->BlockToConfig (
1382 (UINT8
*) &Private
->TlsAuthConfigNvData
,
1389 // Free the allocated config request string.
1391 if (AllocatedRequest
) {
1392 FreePool (ConfigRequest
);
1396 // Set Progress string to the original request string.
1398 if (Request
== NULL
) {
1400 } else if (StrStr (Request
, L
"OFFSET") == NULL
) {
1401 *Progress
= Request
+ StrLen (Request
);
1409 This function applies changes in a driver's configuration.
1410 Input is a Configuration, which has the routing data for this
1411 driver followed by name / value configuration pairs. The driver
1412 must apply those pairs to its configurable storage. If the
1413 driver's configuration is stored in a linear block of data
1414 and the driver's name / value pairs are in <BlockConfig>
1415 format, it may use the ConfigToBlock helper function (above) to
1418 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1420 @param Configuration A null-terminated Unicode string in
1421 <ConfigString> format.
1423 @param Progress A pointer to a string filled in with the
1424 offset of the most recent '&' before the
1425 first failing name / value pair (or the
1426 beginn ing of the string if the failure
1427 is in the first name / value pair) or
1428 the terminating NULL if all was
1431 @retval EFI_SUCCESS The results have been distributed or are
1432 awaiting distribution.
1434 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the
1435 parts of the results that must be
1436 stored awaiting possible future
1439 @retval EFI_INVALID_PARAMETERS Passing in a NULL for the
1440 Results parameter would result
1441 in this type of error.
1443 @retval EFI_NOT_FOUND Target for the specified routing data
1449 TlsAuthConfigAccessRouteConfig (
1450 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1451 IN CONST EFI_STRING Configuration
,
1452 OUT EFI_STRING
*Progress
1457 TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
;
1459 if (Progress
== NULL
) {
1460 return EFI_INVALID_PARAMETER
;
1462 *Progress
= Configuration
;
1464 if (Configuration
== NULL
) {
1465 return EFI_INVALID_PARAMETER
;
1469 // Check routing data in <ConfigHdr>.
1470 // Note: there is no name for Name/Value storage, only GUID will be checked
1472 if (!HiiIsConfigHdrMatch (Configuration
, &gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
)) {
1473 return EFI_NOT_FOUND
;
1476 Private
= TLS_AUTH_CONFIG_PRIVATE_FROM_THIS (This
);
1478 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1479 ZeroMem (&Private
->TlsAuthConfigNvData
, BufferSize
);
1481 Status
= gHiiConfigRouting
->ConfigToBlock (
1484 (UINT8
*) &Private
->TlsAuthConfigNvData
,
1488 if (EFI_ERROR (Status
)) {
1497 This function is called to provide results data to the driver.
1498 This data consists of a unique key that is used to identify
1499 which data is either being passed back or being asked for.
1501 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1502 @param Action Specifies the type of action taken by the browser.
1503 @param QuestionId A unique value which is sent to the original
1504 exporting driver so that it can identify the type
1505 of data to expect. The format of the data tends to
1506 vary based on the opcode that generated the callback.
1507 @param Type The type of value for the question.
1508 @param Value A pointer to the data being sent to the original
1510 @param ActionRequest On return, points to the action requested by the
1513 @retval EFI_SUCCESS The callback successfully handled the action.
1514 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
1515 variable and its data.
1516 @retval EFI_DEVICE_ERROR The variable could not be saved.
1517 @retval EFI_UNSUPPORTED The specified Action is not supported by the
1522 TlsAuthConfigAccessCallback (
1523 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
1524 IN EFI_BROWSER_ACTION Action
,
1525 IN EFI_QUESTION_ID QuestionId
,
1527 IN OUT EFI_IFR_TYPE_VALUE
*Value
,
1528 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
1533 RETURN_STATUS RStatus
;
1534 TLS_AUTH_CONFIG_PRIVATE_DATA
*Private
;
1536 TLS_AUTH_CONFIG_IFR_NVDATA
*IfrNvData
;
1538 EFI_DEVICE_PATH_PROTOCOL
*File
;
1540 Status
= EFI_SUCCESS
;
1543 if ((This
== NULL
) || (Value
== NULL
) || (ActionRequest
== NULL
)) {
1544 return EFI_INVALID_PARAMETER
;
1547 Private
= TLS_AUTH_CONFIG_PRIVATE_FROM_THIS (This
);
1549 mTlsAuthPrivateData
= Private
;
1552 // Retrieve uncommitted data from Browser
1554 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1555 IfrNvData
= AllocateZeroPool (BufferSize
);
1556 if (IfrNvData
== NULL
) {
1557 return EFI_OUT_OF_RESOURCES
;
1560 HiiGetBrowserData (&gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
, BufferSize
, (UINT8
*) IfrNvData
);
1562 if ((Action
!= EFI_BROWSER_ACTION_CHANGED
) &&
1563 (Action
!= EFI_BROWSER_ACTION_CHANGING
) &&
1564 (Action
!= EFI_BROWSER_ACTION_FORM_CLOSE
)) {
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
:
1596 // If the file is already opened, clean the file related resource first.
1598 CleanFileContext (Private
);
1600 ChooseFile( NULL
, NULL
, UpdateCAFromFile
, &File
);
1603 case KEY_TLS_AUTH_CONFIG_VALUE_SAVE_AND_EXIT
:
1604 Status
= EnrollCertDatabase (Private
, EFI_TLS_CA_CERTIFICATE_VARIABLE
);
1605 if (EFI_ERROR (Status
)) {
1606 CleanFileContext (Private
);
1609 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
1611 L
"ERROR: Enroll Cert Failure!",
1617 case KEY_TLS_AUTH_CONFIG_VALUE_NO_SAVE_AND_EXIT
:
1618 CleanFileContext (Private
);
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
;
1670 } else if (Action
== EFI_BROWSER_ACTION_FORM_CLOSE
) {
1671 CleanFileContext (Private
);
1676 if (!EFI_ERROR (Status
)) {
1677 BufferSize
= sizeof (TLS_AUTH_CONFIG_IFR_NVDATA
);
1678 HiiSetBrowserData (&gTlsAuthConfigGuid
, mTlsAuthConfigStorageName
, BufferSize
, (UINT8
*) IfrNvData
, NULL
);
1681 FreePool (IfrNvData
);