2 This driver verifies and reports OBB FVs.
4 Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #include "FvReportPei.h"
11 STATIC CONST HASH_ALG_INFO mHashAlgInfo
[] = {
12 {TPM_ALG_SHA256
, SHA256_DIGEST_SIZE
, Sha256Init
, Sha256Update
, Sha256Final
, Sha256HashAll
}, // 000B
13 {TPM_ALG_SHA384
, SHA384_DIGEST_SIZE
, Sha384Init
, Sha384Update
, Sha384Final
, Sha384HashAll
}, // 000C
14 {TPM_ALG_SHA512
, SHA512_DIGEST_SIZE
, Sha512Init
, Sha512Update
, Sha512Final
, Sha512HashAll
}, // 000D
18 Find hash algorithm information from mHashAlgInfo according to given ID.
20 @param[in] HashAlgId Hash algorithm type id.
22 @retval Pointer to HASH_ALG_INFO if given hash algorithm is supported.
23 @retval NULL if given algorithm is not supported.
34 for (Index
= 0; Index
< ARRAY_SIZE (mHashAlgInfo
); ++Index
) {
35 if (mHashAlgInfo
[Index
].HashAlgId
== HashAlgId
) {
36 return &mHashAlgInfo
[Index
];
44 Install a EDKII_PEI_FIRMWARE_VOLUME_INFO_PREHASHED_FV_PPI instance so that
45 TCG driver may use to extend PCRs.
47 @param[in] FvBuffer Buffer containing the whole FV.
48 @param[in] FvLength Length of the FV.
49 @param[in] HashAlgoId Hash algorithm type id.
50 @param[in] HashSize Hash size.
51 @param[in] HashValue Hash value buffer.
64 EFI_PEI_PPI_DESCRIPTOR
*FvInfoPpiDescriptor
;
65 EDKII_PEI_FIRMWARE_VOLUME_INFO_PREHASHED_FV_PPI
*PreHashedFvPpi
;
69 PpiSize
= sizeof (EDKII_PEI_FIRMWARE_VOLUME_INFO_PREHASHED_FV_PPI
)
73 PreHashedFvPpi
= AllocatePool (PpiSize
);
74 ASSERT (PreHashedFvPpi
!= NULL
);
76 PreHashedFvPpi
->FvBase
= (UINT32
)(UINTN
)FvBuffer
;
77 PreHashedFvPpi
->FvLength
= (UINT32
)FvLength
;
78 PreHashedFvPpi
->Count
= 1;
80 HashInfo
= HASH_INFO_PTR (PreHashedFvPpi
);
81 HashInfo
->HashAlgoId
= HashAlgoId
;
82 HashInfo
->HashSize
= HashSize
;
83 CopyMem (HASH_VALUE_PTR (HashInfo
), HashValue
, HashSize
);
85 FvInfoPpiDescriptor
= AllocatePool (sizeof (EFI_PEI_PPI_DESCRIPTOR
));
86 ASSERT (FvInfoPpiDescriptor
!= NULL
);
88 FvInfoPpiDescriptor
->Guid
= &gEdkiiPeiFirmwareVolumeInfoPrehashedFvPpiGuid
;
89 FvInfoPpiDescriptor
->Flags
= EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
;
90 FvInfoPpiDescriptor
->Ppi
= (VOID
*) PreHashedFvPpi
;
92 Status
= PeiServicesInstallPpi (FvInfoPpiDescriptor
);
93 ASSERT_EFI_ERROR (Status
);
97 Calculate and verify hash value for given FV.
99 @param[in] HashInfo Hash information of the FV.
100 @param[in] FvInfo Information of FV used for verification.
101 @param[in] FvNumber Length of the FV.
102 @param[in] BootMode Length of the FV.
104 @retval EFI_SUCCESS The given FV is integrate.
105 @retval EFI_VOLUME_CORRUPTED The given FV is corrupted (hash mismatch).
106 @retval EFI_UNSUPPORTED The hash algorithm is not supported.
111 IN FV_HASH_INFO
*HashInfo
,
112 IN HASHED_FV_INFO
*FvInfo
,
114 IN EFI_BOOT_MODE BootMode
118 CONST HASH_ALG_INFO
*AlgInfo
;
124 if (HashInfo
== NULL
||
125 HashInfo
->HashSize
== 0 ||
126 HashInfo
->HashAlgoId
== TPM_ALG_NULL
) {
127 DEBUG ((DEBUG_INFO
, "Bypass FV hash verification\r\n"));
131 AlgInfo
= FindHashAlgInfo (HashInfo
->HashAlgoId
);
132 if (AlgInfo
== NULL
|| AlgInfo
->HashSize
!= HashInfo
->HashSize
) {
133 DEBUG ((DEBUG_ERROR
, "Unsupported or wrong hash algorithm: %04X (size=%d)\r\n",
134 HashInfo
->HashAlgoId
, HashInfo
->HashSize
));
135 return EFI_UNSUPPORTED
;
138 ASSERT (FvInfo
!= NULL
);
139 ASSERT (FvNumber
> 0);
142 // We need a hash value for each FV as well as one for all FVs.
144 HashValue
= AllocateZeroPool (AlgInfo
->HashSize
* (FvNumber
+ 1));
145 ASSERT (HashValue
!= NULL
);
148 // Calculate hash value for each FV first.
150 FvHashValue
= HashValue
;
151 for (FvIndex
= 0; FvIndex
< FvNumber
; ++FvIndex
) {
153 // FV must be meant for verified boot and/or measured boot.
155 ASSERT ((FvInfo
[FvIndex
].Flag
& HASHED_FV_FLAG_VERIFIED_BOOT
) != 0 ||
156 (FvInfo
[FvIndex
].Flag
& HASHED_FV_FLAG_MEASURED_BOOT
) != 0);
159 // Skip any FV not meant for current boot mode.
161 if ((FvInfo
[FvIndex
].Flag
& HASHED_FV_FLAG_SKIP_BOOT_MODE (BootMode
)) != 0) {
162 DEBUG ((DEBUG_INFO
, "Skip FV[%016lX] for boot mode[%d]\r\n",
163 FvInfo
[FvIndex
].Base
, BootMode
));
169 "Pre-hashed[alg=%04X,size=%d,flag=%016lX] FV: 0x%016lX (%08lX) (Flag=%016lX)\r\n",
170 HashInfo
->HashAlgoId
,
173 FvInfo
[FvIndex
].Base
,
174 FvInfo
[FvIndex
].Length
,
179 // Copy FV to permanent memory to avoid potential TOC/TOU.
181 FvBuffer
= AllocatePages (EFI_SIZE_TO_PAGES((UINTN
)FvInfo
[FvIndex
].Length
));
182 ASSERT (FvBuffer
!= NULL
);
183 CopyMem (FvBuffer
, (CONST VOID
*)(UINTN
)FvInfo
[FvIndex
].Base
, (UINTN
)FvInfo
[FvIndex
].Length
);
185 if (!AlgInfo
->HashAll (FvBuffer
, (UINTN
)FvInfo
[FvIndex
].Length
, FvHashValue
)) {
186 Status
= EFI_ABORTED
;
191 // Report the FV measurement.
193 if ((FvInfo
[FvIndex
].Flag
& HASHED_FV_FLAG_MEASURED_BOOT
) != 0) {
194 InstallPreHashFvPpi (
196 (UINTN
)FvInfo
[FvIndex
].Length
,
197 HashInfo
->HashAlgoId
,
204 // Don't keep the hash value of current FV if we don't need to verify it.
206 if ((FvInfo
[FvIndex
].Flag
& HASHED_FV_FLAG_VERIFIED_BOOT
) != 0) {
207 FvHashValue
+= AlgInfo
->HashSize
;
211 // Use memory copy of the FV from now on.
213 FvInfo
[FvIndex
].Base
= (UINT64
)(UINTN
)FvBuffer
;
217 // Check final hash for all FVs.
219 if (FvHashValue
== HashValue
||
220 (AlgInfo
->HashAll (HashValue
, FvHashValue
- HashValue
, FvHashValue
) &&
221 CompareMem (HashInfo
->Hash
, FvHashValue
, AlgInfo
->HashSize
) == 0)) {
222 Status
= EFI_SUCCESS
;
224 Status
= EFI_VOLUME_CORRUPTED
;
228 FreePool (HashValue
);
233 Report FV to PEI and/or DXE core for dispatch.
235 @param[in] FvInfo Information of a FV.
241 IN HASHED_FV_INFO
*FvInfo
244 CONST EFI_GUID
*FvFormat
;
246 if ((FvInfo
->Flag
& HASHED_FV_FLAG_REPORT_FV_HOB
) != 0) {
248 // Require DXE core to process this FV.
251 (EFI_PHYSICAL_ADDRESS
)FvInfo
->Base
,
254 DEBUG ((DEBUG_INFO
, "Reported FV HOB: %016lX (%08lX)\r\n", FvInfo
->Base
, FvInfo
->Length
));
257 if ((FvInfo
->Flag
& HASHED_FV_FLAG_REPORT_FV_INFO_PPI
) != 0) {
259 // Require PEI core to process this FV.
261 FvFormat
= &((EFI_FIRMWARE_VOLUME_HEADER
*)(UINTN
)FvInfo
->Base
)->FileSystemGuid
;
262 PeiServicesInstallFvInfoPpi (
264 (VOID
*)(UINTN
)FvInfo
->Base
,
265 (UINT32
)FvInfo
->Length
,
269 DEBUG ((DEBUG_INFO
, "Reported FV PPI: %016lX (%08lX)\r\n", FvInfo
->Base
, FvInfo
->Length
));
274 Verify and report pre-hashed FVs.
276 Doing this must be at post-memory to make sure there's enough memory to hold
277 all FVs to be verified. This is necessary for mitigating TOCTOU issue.
279 This function will never return if the verification is failed.
281 @param[in] StoredHashFvPpi Pointer to PPI containing hash information.
282 @param[in] BootMode Current boot mode.
284 @retval Pointer to structure containing valid hash information for current boot mode.
285 @retval NULL if there's no hash associated with current boot mode.
290 IN EDKII_PEI_FIRMWARE_VOLUME_INFO_STORED_HASH_FV_PPI
*StoredHashFvPpi
,
291 IN EFI_BOOT_MODE BootMode
294 FV_HASH_INFO
*HashInfo
;
296 if ((StoredHashFvPpi
->HashInfo
.HashFlag
& FV_HASH_FLAG_BOOT_MODE (BootMode
)) != 0) {
297 HashInfo
= &StoredHashFvPpi
->HashInfo
;
306 Verify and report pre-hashed FVs.
308 Doing this must be at post-memory to make sure there's enough memory to hold
309 all FVs to be verified. This is necessary for mitigating TOCTOU issue.
311 This function will never return if the verification is failed.
313 @param[in] PeiServices General purpose services available to every PEIM.
314 @param[in] BootMode Current boot mode.
316 @retval EFI_SUCCESS The function completed successfully.
321 IN CONST EFI_PEI_SERVICES
**PeiServices
,
322 IN EFI_BOOT_MODE BootMode
326 EDKII_PEI_FIRMWARE_VOLUME_INFO_STORED_HASH_FV_PPI
*StoredHashFvPpi
;
327 FV_HASH_INFO
*HashInfo
;
331 // Check pre-hashed FV list
333 StoredHashFvPpi
= NULL
;
334 Status
= PeiServicesLocatePpi (
335 &gEdkiiPeiFirmwareVolumeInfoStoredHashFvPpiGuid
,
338 (VOID
**)&StoredHashFvPpi
340 if (!EFI_ERROR(Status
) && StoredHashFvPpi
!= NULL
&& StoredHashFvPpi
->FvNumber
> 0) {
342 HashInfo
= GetHashInfo (StoredHashFvPpi
, BootMode
);
343 Status
= VerifyHashedFv (HashInfo
, StoredHashFvPpi
->FvInfo
,
344 StoredHashFvPpi
->FvNumber
, BootMode
);
345 if (!EFI_ERROR (Status
)) {
348 // Report the FVs to PEI core and/or DXE core.
350 for (FvIndex
= 0; FvIndex
< StoredHashFvPpi
->FvNumber
; ++FvIndex
) {
351 if ((StoredHashFvPpi
->FvInfo
[FvIndex
].Flag
352 & HASHED_FV_FLAG_SKIP_BOOT_MODE (BootMode
)) == 0) {
353 ReportHashedFv (&StoredHashFvPpi
->FvInfo
[FvIndex
]);
359 PcdGet32 (PcdStatusCodeFvVerificationPass
)
364 DEBUG ((DEBUG_ERROR
, "ERROR: Failed to verify OBB FVs (%r)\r\n", Status
));
366 REPORT_STATUS_CODE_EX (
368 PcdGet32 (PcdStatusCodeFvVerificationFail
),
371 &gEdkiiPeiFirmwareVolumeInfoStoredHashFvPpiGuid
,
373 sizeof (*StoredHashFvPpi
)
376 ASSERT_EFI_ERROR (Status
);
382 DEBUG ((DEBUG_ERROR
, "ERROR: No/invalid StoredHashFvPpi located\r\n"));
384 ASSERT_EFI_ERROR (Status
);
385 ASSERT (StoredHashFvPpi
!= NULL
&& StoredHashFvPpi
->FvNumber
> 0);
387 Status
= EFI_NOT_FOUND
;
394 Main entry for FvReport PEIM.
396 @param[in] FileHandle Handle of the file being invoked.
397 @param[in] PeiServices Pointer to PEI Services table.
399 @retval EFI_SUCCESS If all FVs reported by StoredHashFvPpi are verified.
405 IN EFI_PEI_FILE_HANDLE FileHandle
,
406 IN CONST EFI_PEI_SERVICES
**PeiServices
410 EFI_BOOT_MODE BootMode
;
412 Status
= PeiServicesGetBootMode (&BootMode
);
413 ASSERT_EFI_ERROR (Status
);
415 Status
= CheckStoredHashFv (PeiServices
, BootMode
);
416 if (EFI_ERROR (Status
)) {
418 // Never pass control to left part of BIOS if any error.