/** @file\r
\r
- Implements CRC32 guided section handler to parse CRC32 encapsulation section, \r
- extract data and authenticate 32 bit CRC value.\r
-\r
-Copyright (c) 2007 - 2008, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ This library registers CRC32 guided section handler\r
+ to parse CRC32 encapsulation section and extract raw data.\r
+ It uses UEFI boot service CalculateCrc32 to authenticate 32 bit CRC value.\r
+\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
-#include <Protocol/Crc32GuidedSectionExtraction.h>\r
+#include <Guid/Crc32GuidedSectionExtraction.h>\r
#include <Protocol/SecurityPolicy.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
\r
+///\r
+/// CRC32 Guided Section header\r
+///\r
typedef struct {\r
- EFI_GUID_DEFINED_SECTION GuidedSectionHeader;\r
- UINT32 CRC32Checksum;\r
+ EFI_GUID_DEFINED_SECTION GuidedSectionHeader; ///< EFI guided section header\r
+ UINT32 CRC32Checksum; ///< 32bit CRC check sum\r
} CRC32_SECTION_HEADER;\r
\r
+typedef struct {\r
+ EFI_GUID_DEFINED_SECTION2 GuidedSectionHeader; ///< EFI guided section header\r
+ UINT32 CRC32Checksum; ///< 32bit CRC check sum\r
+} CRC32_SECTION2_HEADER;\r
+\r
+/**\r
+\r
+ GetInfo gets raw data size and attribute of the input guided section.\r
+ It first checks whether the input guid section is supported.\r
+ If not, EFI_INVALID_PARAMETER will return.\r
+\r
+ @param InputSection Buffer containing the input GUIDed section to be processed.\r
+ @param OutputBufferSize The size of OutputBuffer.\r
+ @param ScratchBufferSize The size of ScratchBuffer.\r
+ @param SectionAttribute The attribute of the input guided section.\r
+\r
+ @retval EFI_SUCCESS The size of destination buffer, the size of scratch buffer and\r
+ the attribute of the input section are successfully retrieved.\r
+ @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match this instance guid.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Crc32GuidedSectionGetInfo (\r
OUT UINT32 *ScratchBufferSize,\r
OUT UINT16 *SectionAttribute\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- The implementation of Crc32 guided section GetInfo().\r
-\r
-Arguments:\r
- InputSection Buffer containing the input GUIDed section to be processed. \r
- OutputBufferSize The size of OutputBuffer.\r
- ScratchBufferSize The size of ScratchBuffer.\r
- SectionAttribute The attribute of the input guided section.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
- EFI_INVALID_PARAMETER - The source data is corrupted, or\r
- The GUID in InputSection does not match this instance guid.\r
-\r
---*/\r
{\r
- if (!CompareGuid (\r
- &gEfiCrc32GuidedSectionExtractionProtocolGuid, \r
+ if (IS_SECTION2 (InputSection)) {\r
+ //\r
+ // Check whether the input guid section is recognized.\r
+ //\r
+ if (!CompareGuid (\r
+ &gEfiCrc32GuidedSectionExtractionGuid,\r
+ &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)->SectionDefinitionGuid))) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ //\r
+ // Retrieve the size and attribute of the input section data.\r
+ //\r
+ *SectionAttribute = ((EFI_GUID_DEFINED_SECTION2 *) InputSection)->Attributes;\r
+ *ScratchBufferSize = 0;\r
+ *OutputBufferSize = SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *) InputSection)->DataOffset;\r
+ } else {\r
+ //\r
+ // Check whether the input guid section is recognized.\r
+ //\r
+ if (!CompareGuid (\r
+ &gEfiCrc32GuidedSectionExtractionGuid,\r
&(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
- return EFI_INVALID_PARAMETER;\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ //\r
+ // Retrieve the size and attribute of the input section data.\r
+ //\r
+ *SectionAttribute = ((EFI_GUID_DEFINED_SECTION *) InputSection)->Attributes;\r
+ *ScratchBufferSize = 0;\r
+ *OutputBufferSize = SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset;\r
}\r
- //\r
- // Retrieve the size and attribute of the input section data.\r
- //\r
- *SectionAttribute = ((EFI_GUID_DEFINED_SECTION *) InputSection)->Attributes;\r
- *ScratchBufferSize = 0;\r
- *OutputBufferSize = *(UINT32 *) (((EFI_COMMON_SECTION_HEADER *) InputSection)->Size) & 0x00ffffff;\r
- *OutputBufferSize -= ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+\r
+ Extraction handler tries to extract raw data from the input guided section.\r
+ It also does authentication check for 32bit CRC value in the input guided section.\r
+ It first checks whether the input guid section is supported.\r
+ If not, EFI_INVALID_PARAMETER will return.\r
+\r
+ @param InputSection Buffer containing the input GUIDed section to be processed.\r
+ @param OutputBuffer Buffer to contain the output raw data allocated by the caller.\r
+ @param ScratchBuffer A pointer to a caller-allocated buffer for function internal use.\r
+ @param AuthenticationStatus A pointer to a caller-allocated UINT32 that indicates the\r
+ authentication status of the output buffer.\r
+\r
+ @retval EFI_SUCCESS Section Data and Auth Status is extracted successfully.\r
+ @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match this instance guid.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Crc32GuidedSectionHandler (\r
IN VOID *ScratchBuffer, OPTIONAL\r
OUT UINT32 *AuthenticationStatus\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- The implementation of Crc32 Guided section extraction.\r
-\r
-Arguments:\r
- InputSection Buffer containing the input GUIDed section to be processed. \r
- OutputBuffer OutputBuffer to point to the start of the section's contents.\r
- if guided data is not prcessed. Otherwise,\r
- OutputBuffer to contain the output data, which is allocated by the caller.\r
- ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \r
- AuthenticationStatus A pointer to a caller-allocated UINT32 that indicates the\r
- authentication status of the output buffer.
-\r
-Returns:\r
-\r
- RETURN_SUCCESS - Decompression is successfull\r
- RETURN_INVALID_PARAMETER - The source data is corrupted, or\r
- The GUID in InputSection does not match this instance guid.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
- CRC32_SECTION_HEADER *Crc32SectionHeader;\r
+ UINT32 SectionCrc32Checksum;\r
UINT32 Crc32Checksum;\r
UINT32 OutputBufferSize;\r
VOID *DummyInterface;\r
\r
- if (!CompareGuid (\r
- &gEfiCrc32GuidedSectionExtractionProtocolGuid, \r
+ if (IS_SECTION2 (InputSection)) {\r
+ //\r
+ // Check whether the input guid section is recognized.\r
+ //\r
+ if (!CompareGuid (\r
+ &gEfiCrc32GuidedSectionExtractionGuid,\r
+ &(((EFI_GUID_DEFINED_SECTION2 *) InputSection)->SectionDefinitionGuid))) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Get section Crc32 checksum.\r
+ //\r
+ SectionCrc32Checksum = ((CRC32_SECTION2_HEADER *) InputSection)->CRC32Checksum;\r
+ *OutputBuffer = (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION2 *) InputSection)->DataOffset;\r
+ OutputBufferSize = SECTION2_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION2 *) InputSection)->DataOffset;\r
+\r
+ //\r
+ // Implicitly CRC32 GUIDed section should have STATUS_VALID bit set\r
+ //\r
+ ASSERT (((EFI_GUID_DEFINED_SECTION2 *) InputSection)->Attributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID);\r
+ *AuthenticationStatus = EFI_AUTH_STATUS_IMAGE_SIGNED;\r
+ } else {\r
+ //\r
+ // Check whether the input guid section is recognized.\r
+ //\r
+ if (!CompareGuid (\r
+ &gEfiCrc32GuidedSectionExtractionGuid,\r
&(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
\r
- Crc32Checksum = 0;\r
- //\r
- // Points to the Crc32 section header\r
- //\r
- Crc32SectionHeader = (CRC32_SECTION_HEADER *) InputSection;\r
- *OutputBuffer = (UINT8 *) InputSection + Crc32SectionHeader->GuidedSectionHeader.DataOffset;\r
- OutputBufferSize = *(UINT32 *) (((EFI_COMMON_SECTION_HEADER *) InputSection)->Size) & 0x00ffffff; \r
- OutputBufferSize -= Crc32SectionHeader->GuidedSectionHeader.DataOffset;\r
+ //\r
+ // Get section Crc32 checksum.\r
+ //\r
+ SectionCrc32Checksum = ((CRC32_SECTION_HEADER *) InputSection)->CRC32Checksum;\r
+ *OutputBuffer = (UINT8 *) InputSection + ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset;\r
+ OutputBufferSize = SECTION_SIZE (InputSection) - ((EFI_GUID_DEFINED_SECTION *) InputSection)->DataOffset;\r
+\r
+ //\r
+ // Implicitly CRC32 GUIDed section should have STATUS_VALID bit set\r
+ //\r
+ ASSERT (((EFI_GUID_DEFINED_SECTION *) InputSection)->Attributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID);\r
+ *AuthenticationStatus = EFI_AUTH_STATUS_IMAGE_SIGNED;\r
+ }\r
\r
//\r
- // Implictly CRC32 GUIDed section should have STATUS_VALID bit set\r
+ // Init Checksum value to Zero.\r
//\r
- ASSERT (Crc32SectionHeader->GuidedSectionHeader.Attributes & EFI_GUIDED_SECTION_AUTH_STATUS_VALID);\r
- *AuthenticationStatus = EFI_AUTH_STATUS_IMAGE_SIGNED;\r
+ Crc32Checksum = 0;\r
\r
//\r
// Check whether there exists EFI_SECURITY_POLICY_PROTOCOL_GUID.\r
//\r
Status = gBS->LocateProtocol (&gEfiSecurityPolicyProtocolGuid, NULL, &DummyInterface);\r
if (!EFI_ERROR (Status)) {\r
+ //\r
+ // If SecurityPolicy Protocol exist, AUTH platform override bit is set.\r
+ //\r
*AuthenticationStatus |= EFI_AUTH_STATUS_PLATFORM_OVERRIDE;\r
} else {\r
//\r
//\r
Status = gBS->CalculateCrc32 (*OutputBuffer, OutputBufferSize, &Crc32Checksum);\r
if (Status == EFI_SUCCESS) {\r
- if (Crc32Checksum != Crc32SectionHeader->CRC32Checksum) {\r
+ if (Crc32Checksum != SectionCrc32Checksum) {\r
+ //\r
+ // If Crc32 checksum is not matched, AUTH tested failed bit is set.\r
+ //\r
*AuthenticationStatus |= EFI_AUTH_STATUS_TEST_FAILED;\r
}\r
} else {\r
+ //\r
+ // If Crc32 checksum is not calculated, AUTH not tested bit is set.\r
+ //\r
*AuthenticationStatus |= EFI_AUTH_STATUS_NOT_TESTED;\r
}\r
}\r
return EFI_SUCCESS;\r
}\r
\r
-/**
- Register Crc32 section handler.\r
-
- @retval RETURN_SUCCESS Register successfully.\r
- @retval RETURN_OUT_OF_RESOURCES No enough memory to store this handler.
+/**\r
+ Register the handler to extract CRC32 guided section.\r
+\r
+ @param ImageHandle ImageHandle of the loaded driver.\r
+ @param SystemTable Pointer to the EFI System Table.\r
+\r
+ @retval EFI_SUCCESS Register successfully.\r
+ @retval EFI_OUT_OF_RESOURCES No enough memory to register this handler.\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeCrc32GuidedSectionExtractLibConstructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
{\r
return ExtractGuidedSectionRegisterHandlers (\r
- &gEfiCrc32GuidedSectionExtractionProtocolGuid,\r
+ &gEfiCrc32GuidedSectionExtractionGuid,\r
Crc32GuidedSectionGetInfo,\r
Crc32GuidedSectionHandler\r
);\r
projects / mirror_edk2.git / blobdiff