2 EDKII System Capsule library.
4 EDKII System Capsule library instance.
6 CapsuleAuthenticateSystemFirmware(), ExtractAuthenticatedImage() will receive
7 untrusted input and do basic validation.
9 Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>
10 This program and the accompanying materials
11 are licensed and made available under the terms and conditions of the BSD License
12 which accompanies this distribution. The full text of the license may be found at
13 http://opensource.org/licenses/bsd-license.php
15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #include <Guid/SystemResourceTable.h>
23 #include <Guid/FirmwareContentsSigned.h>
24 #include <Guid/WinCertificate.h>
25 #include <Guid/EdkiiSystemFmpCapsule.h>
26 #include <Guid/WinCertificate.h>
27 #include <Guid/ImageAuthentication.h>
29 #include <Library/BaseLib.h>
30 #include <Library/BaseMemoryLib.h>
31 #include <Library/DebugLib.h>
32 #include <Library/PcdLib.h>
33 #include <Library/MemoryAllocationLib.h>
34 #include <Library/EdkiiSystemCapsuleLib.h>
35 #include <Library/FmpAuthenticationLib.h>
37 #include <Protocol/FirmwareManagement.h>
39 EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR
*mImageFmpInfo
;
40 UINTN mImageFmpInfoSize
;
41 EFI_GUID mEdkiiSystemFirmwareFileGuid
;
44 Check if a block of buffer is erased.
46 @param[in] ErasePolarity Erase polarity attribute of the firmware volume
47 @param[in] InBuffer The buffer to be checked
48 @param[in] BufferSize Size of the buffer in bytes
50 @retval TRUE The block of buffer is erased
51 @retval FALSE The block of buffer is not erased
55 IN UINT8 ErasePolarity
,
64 if(ErasePolarity
== 1) {
71 for (Count
= 0; Count
< BufferSize
; Count
++) {
72 if (Buffer
[Count
] != EraseByte
) {
81 Get Section buffer pointer by SectionType and SectionInstance.
83 @param[in] SectionBuffer The buffer of section
84 @param[in] SectionBufferSize The size of SectionBuffer in bytes
85 @param[in] SectionType The SectionType of Section to be found
86 @param[in] SectionInstance The Instance of Section to be found
87 @param[out] OutSectionBuffer The section found, including SECTION_HEADER
88 @param[out] OutSectionSize The size of section found, including SECTION_HEADER
90 @retval TRUE The FFS buffer is found.
91 @retval FALSE The FFS buffer is not found.
95 IN VOID
*SectionBuffer
,
96 IN UINT32 SectionBufferSize
,
97 IN EFI_SECTION_TYPE SectionType
,
98 IN UINTN SectionInstance
,
99 OUT VOID
**OutSectionBuffer
,
100 OUT UINTN
*OutSectionSize
103 EFI_COMMON_SECTION_HEADER
*SectionHeader
;
107 DEBUG ((DEBUG_INFO
, "GetSectionByType - Buffer: 0x%08x - 0x%08x\n", SectionBuffer
, SectionBufferSize
));
112 SectionHeader
= SectionBuffer
;
115 while ((UINTN
)SectionHeader
< (UINTN
)SectionBuffer
+ SectionBufferSize
) {
116 DEBUG ((DEBUG_INFO
, "GetSectionByType - Section: 0x%08x\n", SectionHeader
));
117 if (IS_SECTION2(SectionHeader
)) {
118 SectionSize
= SECTION2_SIZE(SectionHeader
);
120 SectionSize
= SECTION_SIZE(SectionHeader
);
123 if (SectionHeader
->Type
== SectionType
) {
124 if (Instance
== SectionInstance
) {
125 *OutSectionBuffer
= (UINT8
*)SectionHeader
;
126 *OutSectionSize
= SectionSize
;
127 DEBUG((DEBUG_INFO
, "GetSectionByType - 0x%x - 0x%x\n", *OutSectionBuffer
, *OutSectionSize
));
130 DEBUG((DEBUG_INFO
, "GetSectionByType - find section instance %x\n", Instance
));
135 // Skip other section type
137 DEBUG ((DEBUG_INFO
, "GetSectionByType - other section type 0x%x\n", SectionHeader
->Type
));
143 SectionHeader
= (EFI_COMMON_SECTION_HEADER
*)((UINTN
)SectionHeader
+ ALIGN_VALUE(SectionSize
, 4));
150 Get FFS buffer pointer by FileName GUID and FileType.
152 @param[in] FdStart The System Firmware FD image
153 @param[in] FdSize The size of System Firmware FD image
154 @param[in] FileName The FileName GUID of FFS to be found
155 @param[in] Type The FileType of FFS to be found
156 @param[out] OutFfsBuffer The FFS buffer found, including FFS_FILE_HEADER
157 @param[out] OutFfsBufferSize The size of FFS buffer found, including FFS_FILE_HEADER
159 @retval TRUE The FFS buffer is found.
160 @retval FALSE The FFS buffer is not found.
166 IN EFI_GUID
*FileName
,
167 IN EFI_FV_FILETYPE Type
,
168 OUT VOID
**OutFfsBuffer
,
169 OUT UINTN
*OutFfsBufferSize
173 EFI_FIRMWARE_VOLUME_HEADER
*FvHeader
;
174 EFI_FIRMWARE_VOLUME_EXT_HEADER
*FvExtHeader
;
175 EFI_FFS_FILE_HEADER
*FfsHeader
;
180 DEBUG ((DEBUG_INFO
, "GetFfsByName - FV: 0x%08x - 0x%08x\n", (UINTN
)FdStart
, (UINTN
)FdSize
));
183 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*)FdStart
;
184 while ((UINTN
)FvHeader
< (UINTN
)FdStart
+ FdSize
- 1) {
185 FvSize
= (UINTN
)FdStart
+ FdSize
- (UINTN
)FvHeader
;
187 if (FvHeader
->Signature
!= EFI_FVH_SIGNATURE
) {
188 FvHeader
= (EFI_FIRMWARE_VOLUME_HEADER
*)((UINTN
)FvHeader
+ SIZE_4KB
);
191 DEBUG((DEBUG_ERROR
, "checking FV....0x%08x - 0x%x\n", FvHeader
, FvHeader
->FvLength
));
193 if (FvHeader
->FvLength
> FvSize
) {
194 DEBUG((DEBUG_ERROR
, "GetFfsByName - FvSize: 0x%08x, MaxSize - 0x%08x\n", (UINTN
)FvHeader
->FvLength
, (UINTN
)FvSize
));
197 FvSize
= (UINTN
)FvHeader
->FvLength
;
202 if (FvHeader
->ExtHeaderOffset
!= 0) {
203 FvExtHeader
= (EFI_FIRMWARE_VOLUME_EXT_HEADER
*)((UINT8
*)FvHeader
+ FvHeader
->ExtHeaderOffset
);
204 FfsHeader
= (EFI_FFS_FILE_HEADER
*)((UINT8
*)FvExtHeader
+ FvExtHeader
->ExtHeaderSize
);
206 FfsHeader
= (EFI_FFS_FILE_HEADER
*)((UINT8
*)FvHeader
+ FvHeader
->HeaderLength
);
208 FfsHeader
= (EFI_FFS_FILE_HEADER
*)((UINTN
)FvHeader
+ ALIGN_VALUE((UINTN
)FfsHeader
- (UINTN
)FvHeader
, 8));
210 while ((UINTN
)FfsHeader
< (UINTN
)FvHeader
+ FvSize
- 1) {
211 DEBUG((DEBUG_INFO
, "GetFfsByName - FFS: 0x%08x\n", FfsHeader
));
212 TestLength
= (UINTN
)((UINTN
)FvHeader
+ FvSize
- (UINTN
)FfsHeader
);
213 if (TestLength
> sizeof(EFI_FFS_FILE_HEADER
)) {
214 TestLength
= sizeof(EFI_FFS_FILE_HEADER
);
216 if (IsBufferErased(1, FfsHeader
, TestLength
)) {
220 if (IS_FFS_FILE2(FfsHeader
)) {
221 FfsSize
= FFS_FILE2_SIZE(FfsHeader
);
223 FfsSize
= FFS_FILE_SIZE(FfsHeader
);
226 if (CompareGuid(FileName
, &FfsHeader
->Name
) &&
227 ((Type
== EFI_FV_FILETYPE_ALL
) || (FfsHeader
->Type
== Type
))) {
231 *OutFfsBuffer
= FfsHeader
;
232 *OutFfsBufferSize
= FfsSize
;
236 // Any other type is not allowed
238 DEBUG((DEBUG_INFO
, "GetFfsByName - other FFS type 0x%x, name %g\n", FfsHeader
->Type
, &FfsHeader
->Name
));
244 FfsHeader
= (EFI_FFS_FILE_HEADER
*)((UINTN
)FfsHeader
+ ALIGN_VALUE(FfsSize
, 8));
250 FvHeader
= (VOID
*)(UINTN
)((UINTN
)FvHeader
+ FvHeader
->FvLength
);
251 DEBUG((DEBUG_ERROR
, "Next FV....0x%08x - 0x%x\n", FvHeader
, FvHeader
->FvLength
));
255 DEBUG((DEBUG_ERROR
, "GetFfsByName - NO FV Found\n"));
261 Extract the driver FV from an authenticated image.
263 @param[in] AuthenticatedImage The authenticated capsule image.
264 @param[in] AuthenticatedImageSize The size of the authenticated capsule image in bytes.
265 @param[out] DriverFvImage The driver FV image.
266 @param[out] DriverFvImageSize The size of the driver FV image in bytes.
268 @retval TRUE The driver Fv is extracted.
269 @retval FALSE The driver Fv is not extracted.
273 ExtractDriverFvImage (
274 IN VOID
*AuthenticatedImage
,
275 IN UINTN AuthenticatedImageSize
,
276 OUT VOID
**DriverFvImage
,
277 OUT UINTN
*DriverFvImageSize
281 UINT32 FileHeaderSize
;
283 *DriverFvImage
= NULL
;
284 *DriverFvImageSize
= 0;
286 Result
= GetFfsByName(AuthenticatedImage
, AuthenticatedImageSize
, &gEdkiiSystemFmpCapsuleDriverFvFileGuid
, EFI_FV_FILETYPE_RAW
, DriverFvImage
, DriverFvImageSize
);
291 if (IS_FFS_FILE2(*DriverFvImage
)) {
292 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER2
);
294 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER
);
296 *DriverFvImage
= (UINT8
*)*DriverFvImage
+ FileHeaderSize
;
297 *DriverFvImageSize
= *DriverFvImageSize
- FileHeaderSize
;
303 Extract the config image from an authenticated image.
305 @param[in] AuthenticatedImage The authenticated capsule image.
306 @param[in] AuthenticatedImageSize The size of the authenticated capsule image in bytes.
307 @param[out] ConfigImage The config image.
308 @param[out] ConfigImageSize The size of the config image in bytes.
310 @retval TRUE The config image is extracted.
311 @retval FALSE The config image is not extracted.
316 IN VOID
*AuthenticatedImage
,
317 IN UINTN AuthenticatedImageSize
,
318 OUT VOID
**ConfigImage
,
319 OUT UINTN
*ConfigImageSize
323 UINT32 FileHeaderSize
;
326 *ConfigImageSize
= 0;
328 Result
= GetFfsByName(AuthenticatedImage
, AuthenticatedImageSize
, &gEdkiiSystemFmpCapsuleConfigFileGuid
, EFI_FV_FILETYPE_RAW
, ConfigImage
, ConfigImageSize
);
333 if (IS_FFS_FILE2(*ConfigImage
)) {
334 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER2
);
336 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER
);
338 *ConfigImage
= (UINT8
*)*ConfigImage
+ FileHeaderSize
;
339 *ConfigImageSize
= *ConfigImageSize
- FileHeaderSize
;
345 Extract the authenticated image from an FMP capsule image.
347 Caution: This function may receive untrusted input.
349 @param[in] Image The FMP capsule image, including EFI_FIRMWARE_IMAGE_AUTHENTICATION.
350 @param[in] ImageSize The size of FMP capsule image in bytes.
351 @param[out] LastAttemptStatus The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
352 @param[out] AuthenticatedImage The authenticated capsule image, excluding EFI_FIRMWARE_IMAGE_AUTHENTICATION.
353 @param[out] AuthenticatedImageSize The size of the authenticated capsule image in bytes.
355 @retval TRUE The authenticated image is extracted.
356 @retval FALSE The authenticated image is not extracted.
360 ExtractAuthenticatedImage (
363 OUT UINT32
*LastAttemptStatus
,
364 OUT VOID
**AuthenticatedImage
,
365 OUT UINTN
*AuthenticatedImageSize
368 EFI_FIRMWARE_IMAGE_AUTHENTICATION
*ImageAuth
;
372 UINTN PublicKeyDataLength
;
374 DEBUG((DEBUG_INFO
, "ExtractAuthenticatedImage - Image: 0x%08x - 0x%08x\n", (UINTN
)Image
, (UINTN
)ImageSize
));
376 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT
;
377 if ((Image
== NULL
) || (ImageSize
== 0)) {
381 ImageAuth
= (EFI_FIRMWARE_IMAGE_AUTHENTICATION
*)Image
;
382 if (ImageSize
< sizeof(EFI_FIRMWARE_IMAGE_AUTHENTICATION
)) {
383 DEBUG((DEBUG_ERROR
, "ExtractAuthenticatedImage - ImageSize too small\n"));
386 if (ImageAuth
->AuthInfo
.Hdr
.dwLength
<= OFFSET_OF(WIN_CERTIFICATE_UEFI_GUID
, CertData
)) {
387 DEBUG((DEBUG_ERROR
, "ExtractAuthenticatedImage - dwLength too small\n"));
390 if ((UINTN
) ImageAuth
->AuthInfo
.Hdr
.dwLength
> MAX_UINTN
- sizeof(UINT64
)) {
391 DEBUG((DEBUG_ERROR
, "ExtractAuthenticatedImage - dwLength too big\n"));
394 if (ImageSize
<= sizeof(ImageAuth
->MonotonicCount
) + ImageAuth
->AuthInfo
.Hdr
.dwLength
) {
395 DEBUG((DEBUG_ERROR
, "ExtractAuthenticatedImage - ImageSize too small\n"));
398 if (ImageAuth
->AuthInfo
.Hdr
.wRevision
!= 0x0200) {
399 DEBUG((DEBUG_ERROR
, "ExtractAuthenticatedImage - wRevision: 0x%02x, expect - 0x%02x\n", (UINTN
)ImageAuth
->AuthInfo
.Hdr
.wRevision
, (UINTN
)0x0200));
402 if (ImageAuth
->AuthInfo
.Hdr
.wCertificateType
!= WIN_CERT_TYPE_EFI_GUID
) {
403 DEBUG((DEBUG_ERROR
, "ExtractAuthenticatedImage - wCertificateType: 0x%02x, expect - 0x%02x\n", (UINTN
)ImageAuth
->AuthInfo
.Hdr
.wCertificateType
, (UINTN
)WIN_CERT_TYPE_EFI_GUID
));
407 CertType
= &ImageAuth
->AuthInfo
.CertType
;
408 DEBUG((DEBUG_INFO
, "ExtractAuthenticatedImage - CertType: %g\n", CertType
));
410 if (CompareGuid(&gEfiCertPkcs7Guid
, CertType
)) {
411 PublicKeyData
= PcdGetPtr(PcdPkcs7CertBuffer
);
412 PublicKeyDataLength
= PcdGetSize(PcdPkcs7CertBuffer
);
413 } else if (CompareGuid(&gEfiCertTypeRsa2048Sha256Guid
, CertType
)) {
414 PublicKeyData
= PcdGetPtr(PcdRsa2048Sha256PublicKeyBuffer
);
415 PublicKeyDataLength
= PcdGetSize(PcdRsa2048Sha256PublicKeyBuffer
);
419 ASSERT (PublicKeyData
!= NULL
);
420 ASSERT (PublicKeyDataLength
!= 0);
422 Status
= AuthenticateFmpImage(
430 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_SUCCESS
;
432 case RETURN_SECURITY_VIOLATION
:
433 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR
;
435 case RETURN_INVALID_PARAMETER
:
436 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT
;
438 case RETURN_UNSUPPORTED
:
439 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT
;
441 case RETURN_OUT_OF_RESOURCES
:
442 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES
;
445 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL
;
448 if (EFI_ERROR(Status
)) {
452 if (AuthenticatedImage
!= NULL
) {
453 *AuthenticatedImage
= (UINT8
*)ImageAuth
+ ImageAuth
->AuthInfo
.Hdr
.dwLength
+ sizeof(ImageAuth
->MonotonicCount
);
455 if (AuthenticatedImageSize
!= NULL
) {
456 *AuthenticatedImageSize
= ImageSize
- ImageAuth
->AuthInfo
.Hdr
.dwLength
- sizeof(ImageAuth
->MonotonicCount
);
462 Extract ImageFmpInfo from system firmware.
464 @param[in] SystemFirmwareImage The System Firmware image.
465 @param[in] SystemFirmwareImageSize The size of the System Firmware image in bytes.
466 @param[out] ImageFmpInfo The ImageFmpInfo.
467 @param[out] ImageFmpInfoSize The size of the ImageFmpInfo in bytes.
469 @retval TRUE The ImageFmpInfo is extracted.
470 @retval FALSE The ImageFmpInfo is not extracted.
474 ExtractSystemFirmwareImageFmpInfo (
475 IN VOID
*SystemFirmwareImage
,
476 IN UINTN SystemFirmwareImageSize
,
477 OUT EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR
**ImageFmpInfo
,
478 OUT UINTN
*ImageFmpInfoSize
482 UINT32 SectionHeaderSize
;
483 UINT32 FileHeaderSize
;
485 *ImageFmpInfo
= NULL
;
486 *ImageFmpInfoSize
= 0;
488 Result
= GetFfsByName(SystemFirmwareImage
, SystemFirmwareImageSize
, &gEdkiiSystemFirmwareImageDescriptorFileGuid
, EFI_FV_FILETYPE_ALL
, (VOID
**)ImageFmpInfo
, ImageFmpInfoSize
);
492 if (IS_FFS_FILE2 (*ImageFmpInfo
)) {
493 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER2
);
495 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER
);
497 *ImageFmpInfo
= (VOID
*)((UINT8
*)*ImageFmpInfo
+ FileHeaderSize
);
498 *ImageFmpInfoSize
= *ImageFmpInfoSize
- FileHeaderSize
;
500 Result
= GetSectionByType(*ImageFmpInfo
, (UINT32
)*ImageFmpInfoSize
, EFI_SECTION_RAW
, 0, (VOID
**)ImageFmpInfo
, ImageFmpInfoSize
);
504 if (IS_SECTION2(*ImageFmpInfo
)) {
505 SectionHeaderSize
= sizeof(EFI_RAW_SECTION2
);
507 SectionHeaderSize
= sizeof(EFI_RAW_SECTION
);
509 *ImageFmpInfo
= (VOID
*)((UINT8
*)*ImageFmpInfo
+ SectionHeaderSize
);
510 *ImageFmpInfoSize
= *ImageFmpInfoSize
- SectionHeaderSize
;
516 Extract the System Firmware image from an authenticated image.
518 @param[in] AuthenticatedImage The authenticated capsule image.
519 @param[in] AuthenticatedImageSize The size of the authenticated capsule image in bytes.
520 @param[out] SystemFirmwareImage The System Firmware image.
521 @param[out] SystemFirmwareImageSize The size of the System Firmware image in bytes.
523 @retval TRUE The System Firmware image is extracted.
524 @retval FALSE The System Firmware image is not extracted.
528 ExtractSystemFirmwareImage (
529 IN VOID
*AuthenticatedImage
,
530 IN UINTN AuthenticatedImageSize
,
531 OUT VOID
**SystemFirmwareImage
,
532 OUT UINTN
*SystemFirmwareImageSize
536 UINT32 FileHeaderSize
;
538 *SystemFirmwareImage
= NULL
;
539 *SystemFirmwareImageSize
= 0;
541 Result
= GetFfsByName(AuthenticatedImage
, AuthenticatedImageSize
, &mEdkiiSystemFirmwareFileGuid
, EFI_FV_FILETYPE_RAW
, SystemFirmwareImage
, SystemFirmwareImageSize
);
543 // no nested FV, just return all data.
544 *SystemFirmwareImage
= AuthenticatedImage
;
545 *SystemFirmwareImageSize
= AuthenticatedImageSize
;
549 if (IS_FFS_FILE2 (*SystemFirmwareImage
)) {
550 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER2
);
552 FileHeaderSize
= sizeof(EFI_FFS_FILE_HEADER
);
554 *SystemFirmwareImage
= (UINT8
*)*SystemFirmwareImage
+ FileHeaderSize
;
555 *SystemFirmwareImageSize
= *SystemFirmwareImageSize
- FileHeaderSize
;
561 Authenticated system firmware FMP capsule image.
563 Caution: This function may receive untrusted input.
565 @param[in] Image The FMP capsule image, including EFI_FIRMWARE_IMAGE_AUTHENTICATION.
566 @param[in] ImageSize The size of FMP capsule image in bytes.
567 @param[in] ForceVersionMatch TRUE: The version of capsule must be as same as the version of current image.
568 FALSE: The version of capsule must be as same as greater than the lowest
569 supported version of current image.
570 @param[out] LastAttemptVersion The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
571 @param[out] LastAttemptStatus The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
572 @param[out] AuthenticatedImage The authenticated capsule image, excluding EFI_FIRMWARE_IMAGE_AUTHENTICATION.
573 @param[out] AuthenticatedImageSize The size of the authenticated capsule image in bytes.
575 @retval TRUE Authentication passes and the authenticated image is extracted.
576 @retval FALSE Authentication fails and the authenticated image is not extracted.
580 CapsuleAuthenticateSystemFirmware (
583 IN BOOLEAN ForceVersionMatch
,
584 OUT UINT32
*LastAttemptVersion
,
585 OUT UINT32
*LastAttemptStatus
,
586 OUT VOID
**AuthenticatedImage
,
587 OUT UINTN
*AuthenticatedImageSize
591 EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR
*ImageFmpInfo
;
592 UINTN ImageFmpInfoSize
;
593 EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR
*CurrentImageFmpInfo
;
594 UINTN CurrentImageFmpInfoSize
;
595 VOID
*SystemFirmwareImage
;
596 UINTN SystemFirmwareImageSize
;
598 *LastAttemptVersion
= 0;
601 // NOTE: This function need run in an isolated environment.
602 // Do not touch FMP protocol and its private structure.
604 if (mImageFmpInfo
== NULL
) {
605 DEBUG((DEBUG_INFO
, "ImageFmpInfo is not set\n"));
606 return EFI_SECURITY_VIOLATION
;
609 Result
= ExtractAuthenticatedImage((VOID
*)Image
, ImageSize
, LastAttemptStatus
, AuthenticatedImage
, AuthenticatedImageSize
);
611 DEBUG((DEBUG_INFO
, "ExtractAuthenticatedImage - fail\n"));
612 return EFI_SECURITY_VIOLATION
;
615 DEBUG((DEBUG_INFO
, "AuthenticatedImage - 0x%x - 0x%x\n", *AuthenticatedImage
, *AuthenticatedImageSize
));
617 Result
= ExtractSystemFirmwareImage(*AuthenticatedImage
, *AuthenticatedImageSize
, &SystemFirmwareImage
, &SystemFirmwareImageSize
);
619 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT
;
620 DEBUG((DEBUG_INFO
, "ExtractSystemFirmwareImage - fail\n"));
621 return EFI_SECURITY_VIOLATION
;
623 DEBUG((DEBUG_INFO
, "SystemFirmwareImage - 0x%x - 0x%x\n", SystemFirmwareImage
, SystemFirmwareImageSize
));
625 Result
= ExtractSystemFirmwareImageFmpInfo(SystemFirmwareImage
, SystemFirmwareImageSize
, &ImageFmpInfo
, &ImageFmpInfoSize
);
627 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT
;
628 DEBUG((DEBUG_INFO
, "ExtractSystemFirmwareImageFmpInfo - fail\n"));
629 return EFI_SECURITY_VIOLATION
;
632 *LastAttemptVersion
= ImageFmpInfo
->Version
;
633 DEBUG((DEBUG_INFO
, "ImageFmpInfo - 0x%x - 0x%x\n", ImageFmpInfo
, ImageFmpInfoSize
));
634 DEBUG((DEBUG_INFO
, "NewImage Version - 0x%x\n", ImageFmpInfo
->Version
));
635 DEBUG((DEBUG_INFO
, "NewImage LowestSupportedImageVersion - 0x%x\n", ImageFmpInfo
->LowestSupportedImageVersion
));
637 CurrentImageFmpInfo
= mImageFmpInfo
;
638 CurrentImageFmpInfoSize
= mImageFmpInfoSize
;
640 DEBUG((DEBUG_INFO
, "ImageFmpInfo - 0x%x - 0x%x\n", CurrentImageFmpInfo
, CurrentImageFmpInfoSize
));
641 DEBUG((DEBUG_INFO
, "Current Version - 0x%x\n", CurrentImageFmpInfo
->Version
));
642 DEBUG((DEBUG_INFO
, "Current LowestSupportedImageVersion - 0x%x\n", CurrentImageFmpInfo
->LowestSupportedImageVersion
));
644 if (ForceVersionMatch
) {
645 if (CurrentImageFmpInfo
->Version
!= ImageFmpInfo
->Version
) {
646 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION
;
647 DEBUG((DEBUG_INFO
, "ForceVersionMatch check - fail\n"));
648 return EFI_SECURITY_VIOLATION
;
651 if (ImageFmpInfo
->Version
< CurrentImageFmpInfo
->LowestSupportedImageVersion
) {
652 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION
;
653 DEBUG((DEBUG_INFO
, "LowestSupportedImageVersion check - fail\n"));
654 return EFI_SECURITY_VIOLATION
;
658 *LastAttemptStatus
= LAST_ATTEMPT_STATUS_SUCCESS
;
663 PcdCallBack gets the real set PCD value
665 @param[in] CallBackGuid The PCD token GUID being set.
666 @param[in] CallBackToken The PCD token number being set.
667 @param[in, out] TokenData A pointer to the token data being set.
668 @param[in] TokenDataSize The size, in bytes, of the data being set.
673 EdkiiSystemCapsuleLibPcdCallBack (
674 IN CONST GUID
*CallBackGuid
, OPTIONAL
675 IN UINTN CallBackToken
,
676 IN OUT VOID
*TokenData
,
677 IN UINTN TokenDataSize
680 if (CompareGuid (CallBackGuid
, &gEfiSignedCapsulePkgTokenSpaceGuid
) &&
681 CallBackToken
== PcdToken (PcdEdkiiSystemFirmwareImageDescriptor
)) {
682 mImageFmpInfoSize
= TokenDataSize
;
683 mImageFmpInfo
= AllocateCopyPool (mImageFmpInfoSize
, TokenData
);
684 ASSERT(mImageFmpInfo
!= NULL
);
686 // Cancel Callback after get the real set value
688 LibPcdCancelCallback (
689 &gEfiSignedCapsulePkgTokenSpaceGuid
,
690 PcdToken (PcdEdkiiSystemFirmwareImageDescriptor
),
691 EdkiiSystemCapsuleLibPcdCallBack
695 if (CompareGuid (CallBackGuid
, &gEfiSignedCapsulePkgTokenSpaceGuid
) &&
696 CallBackToken
== PcdToken (PcdEdkiiSystemFirmwareFileGuid
)) {
697 CopyGuid(&mEdkiiSystemFirmwareFileGuid
, TokenData
);
699 // Cancel Callback after get the real set value
701 LibPcdCancelCallback (
702 &gEfiSignedCapsulePkgTokenSpaceGuid
,
703 PcdToken (PcdEdkiiSystemFirmwareFileGuid
),
704 EdkiiSystemCapsuleLibPcdCallBack
710 The constructor function.
712 @retval EFI_SUCCESS The constructor successfully .
716 EdkiiSystemCapsuleLibConstructor (
720 mImageFmpInfoSize
= PcdGetSize(PcdEdkiiSystemFirmwareImageDescriptor
);
721 mImageFmpInfo
= PcdGetPtr(PcdEdkiiSystemFirmwareImageDescriptor
);
723 // Verify Firmware Image Descriptor first
725 if (mImageFmpInfoSize
< sizeof (EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR
) ||
726 mImageFmpInfo
->Signature
!= EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR_SIGNATURE
) {
728 // SystemFirmwareImageDescriptor is not set.
729 // Register PCD set callback to hook PCD value set.
731 mImageFmpInfo
= NULL
;
732 mImageFmpInfoSize
= 0;
733 LibPcdCallbackOnSet (
734 &gEfiSignedCapsulePkgTokenSpaceGuid
,
735 PcdToken (PcdEdkiiSystemFirmwareImageDescriptor
),
736 EdkiiSystemCapsuleLibPcdCallBack
739 mImageFmpInfo
= AllocateCopyPool (mImageFmpInfoSize
, mImageFmpInfo
);
740 ASSERT(mImageFmpInfo
!= NULL
);
743 CopyGuid(&mEdkiiSystemFirmwareFileGuid
, PcdGetPtr(PcdEdkiiSystemFirmwareFileGuid
));
745 // Verify GUID value first
747 if (CompareGuid (&mEdkiiSystemFirmwareFileGuid
, &gZeroGuid
)) {
748 LibPcdCallbackOnSet (
749 &gEfiSignedCapsulePkgTokenSpaceGuid
,
750 PcdToken (PcdEdkiiSystemFirmwareFileGuid
),
751 EdkiiSystemCapsuleLibPcdCallBack