326db0c907
Updates the sanitation function names to be lib unique names Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Rahul Kumar <rahul1.kumar@intel.com> Signed-off-by: Doug Flick [MSFT] <doug.edk2@gmail.com> Message-Id: <355aa846a99ca6ac0f7574cf5982661da0d9fea6.1705529990.git.doug.edk2@gmail.com> Reviewed-by: Jiewen Yao <Jiewen.yao@intel.com>
138 lines
4.0 KiB
C
138 lines
4.0 KiB
C
/** @file
|
|
This file includes the function prototypes for the sanitization functions.
|
|
|
|
These are those functions:
|
|
|
|
DxeTpmMeasureBootLibImageRead() function will make sure the PE/COFF image content
|
|
read is within the image buffer.
|
|
|
|
TcgMeasurePeImage() function will accept untrusted PE/COFF image and validate its
|
|
data structure within this image buffer before use.
|
|
|
|
TcgMeasureGptTable() function will receive untrusted GPT partition table, and parse
|
|
partition data carefully.
|
|
|
|
Copyright (c) Microsoft Corporation.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef DXE_TPM_MEASURE_BOOT_LIB_VALIDATION_
|
|
#define DXE_TPM_MEASURE_BOOT_LIB_VALIDATION_
|
|
|
|
#include <Uefi.h>
|
|
#include <Uefi/UefiSpec.h>
|
|
#include <Protocol/BlockIo.h>
|
|
#include <IndustryStandard/UefiTcgPlatform.h>
|
|
|
|
/**
|
|
This function will validate the EFI_PARTITION_TABLE_HEADER structure is safe to parse
|
|
However this function will not attempt to verify the validity of the GPT partition
|
|
It will check the following:
|
|
- Signature
|
|
- Revision
|
|
- AlternateLBA
|
|
- FirstUsableLBA
|
|
- LastUsableLBA
|
|
- PartitionEntryLBA
|
|
- NumberOfPartitionEntries
|
|
- SizeOfPartitionEntry
|
|
- BlockIo
|
|
|
|
@param[in] PrimaryHeader
|
|
Pointer to the EFI_PARTITION_TABLE_HEADER structure.
|
|
|
|
@param[in] BlockIo
|
|
Pointer to the EFI_BLOCK_IO_PROTOCOL structure.
|
|
|
|
@retval EFI_SUCCESS
|
|
The EFI_PARTITION_TABLE_HEADER structure is valid.
|
|
|
|
@retval EFI_INVALID_PARAMETER
|
|
The EFI_PARTITION_TABLE_HEADER structure is invalid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
TpmSanitizeEfiPartitionTableHeader (
|
|
IN CONST EFI_PARTITION_TABLE_HEADER *PrimaryHeader,
|
|
IN CONST EFI_BLOCK_IO_PROTOCOL *BlockIo
|
|
);
|
|
|
|
/**
|
|
This function will validate that the allocation size from the primary header is sane
|
|
It will check the following:
|
|
- AllocationSize does not overflow
|
|
|
|
@param[in] PrimaryHeader
|
|
Pointer to the EFI_PARTITION_TABLE_HEADER structure.
|
|
|
|
@param[out] AllocationSize
|
|
Pointer to the allocation size.
|
|
|
|
@retval EFI_SUCCESS
|
|
The allocation size is valid.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES
|
|
The allocation size is invalid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
TpmSanitizePrimaryHeaderAllocationSize (
|
|
IN CONST EFI_PARTITION_TABLE_HEADER *PrimaryHeader,
|
|
OUT UINT32 *AllocationSize
|
|
);
|
|
|
|
/**
|
|
This function will validate that the Gpt Event Size calculated from the primary header is sane
|
|
It will check the following:
|
|
- EventSize does not overflow
|
|
|
|
Important: This function includes the entire length of the allocated space, including the
|
|
TCG_PCR_EVENT_HDR. When hashing the buffer allocated with this size, the caller must subtract
|
|
the size of the TCG_PCR_EVENT_HDR from the size of the buffer before hashing.
|
|
|
|
@param[in] PrimaryHeader - Pointer to the EFI_PARTITION_TABLE_HEADER structure.
|
|
@param[in] NumberOfPartition - Number of partitions.
|
|
@param[out] EventSize - Pointer to the event size.
|
|
|
|
@retval EFI_SUCCESS
|
|
The event size is valid.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES
|
|
Overflow would have occurred.
|
|
|
|
@retval EFI_INVALID_PARAMETER
|
|
One of the passed parameters was invalid.
|
|
**/
|
|
EFI_STATUS
|
|
TpmSanitizePrimaryHeaderGptEventSize (
|
|
IN CONST EFI_PARTITION_TABLE_HEADER *PrimaryHeader,
|
|
IN UINTN NumberOfPartition,
|
|
OUT UINT32 *EventSize
|
|
);
|
|
|
|
/**
|
|
This function will validate that the PeImage Event Size from the loaded image is sane
|
|
It will check the following:
|
|
- EventSize does not overflow
|
|
|
|
@param[in] FilePathSize - Size of the file path.
|
|
@param[out] EventSize - Pointer to the event size.
|
|
|
|
@retval EFI_SUCCESS
|
|
The event size is valid.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES
|
|
Overflow would have occurred.
|
|
|
|
@retval EFI_INVALID_PARAMETER
|
|
One of the passed parameters was invalid.
|
|
**/
|
|
EFI_STATUS
|
|
TpmSanitizePeImageEventSize (
|
|
IN UINT32 FilePathSize,
|
|
OUT UINT32 *EventSize
|
|
);
|
|
|
|
#endif // DXE_TPM_MEASURE_BOOT_LIB_VALIDATION_
|