mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
fde05ad8f6
Creation of a new Tpm2HelpLib which contains the functions from Tpm2Help.c. This new library is meant to replace Tpm2Help.c such that inclusion of Tpm2CommandLib and Tpm2DeviceLib is not required when only needing access to the Tpm2Help.c functions. Due to Tpm2HelpLib being a new library, the prefix Tpm2 has been added to all library functions to indicate where the functions originate from. Signed-off-by: Raymond Diaz <raymonddiaz@microsoft.com>
186 lines
4.8 KiB
C
186 lines
4.8 KiB
C
/** @file
|
|
Declares reusable TPM 2.0 data helper routines that are independent
|
|
of TPM command/device communication libraries. Includes serialization
|
|
and parsing helpers for common TPM data structures.
|
|
|
|
Copyright (c) Microsoft Corporation.
|
|
Copyright (c) 2013 - 2024, Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <IndustryStandard/Tpm20.h>
|
|
|
|
/**
|
|
Return size of digest.
|
|
|
|
@param[in] HashAlgo Hash algorithm
|
|
|
|
@return size of digest
|
|
**/
|
|
UINT16
|
|
EFIAPI
|
|
Tpm2GetHashSizeFromAlgo (
|
|
IN TPMI_ALG_HASH HashAlgo
|
|
);
|
|
|
|
/**
|
|
Get hash mask from algorithm.
|
|
|
|
@param[in] HashAlgo Hash algorithm
|
|
|
|
@return Hash mask
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
Tpm2GetHashMaskFromAlgo (
|
|
IN TPMI_ALG_HASH HashAlgo
|
|
);
|
|
|
|
/**
|
|
Copy AuthSessionIn to TPM2 command buffer.
|
|
|
|
@param [in] AuthSessionIn Input AuthSession data
|
|
@param [out] AuthSessionOut Output AuthSession data in TPM2 command buffer
|
|
|
|
@return AuthSession size
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
Tpm2CopyAuthSessionCommand (
|
|
IN TPMS_AUTH_COMMAND *AuthSessionIn OPTIONAL,
|
|
OUT UINT8 *AuthSessionOut
|
|
);
|
|
|
|
/**
|
|
Copy AuthSessionIn from TPM2 response buffer.
|
|
|
|
@param [in] AuthSessionIn Input AuthSession data in TPM2 response buffer
|
|
@param [out] AuthSessionOut Output AuthSession data
|
|
|
|
@return AuthSession size
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
Tpm2CopyAuthSessionResponse (
|
|
IN UINT8 *AuthSessionIn,
|
|
OUT TPMS_AUTH_RESPONSE *AuthSessionOut OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Return if hash alg is supported in HashAlgorithmMask.
|
|
|
|
@param HashAlg Hash algorithm to be checked.
|
|
@param HashAlgorithmMask Bitfield of allowed hash algorithms.
|
|
|
|
@retval TRUE Hash algorithm is supported.
|
|
@retval FALSE Hash algorithm is not supported.
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
Tpm2IsHashAlgSupportedInHashAlgorithmMask (
|
|
IN TPMI_ALG_HASH HashAlg,
|
|
IN UINT32 HashAlgorithmMask
|
|
);
|
|
|
|
/**
|
|
Copy TPML_DIGEST_VALUES into a buffer
|
|
|
|
@param[in,out] Buffer Buffer to hold copied TPML_DIGEST_VALUES compact binary.
|
|
@param[in] DigestList TPML_DIGEST_VALUES to be copied.
|
|
@param[in] HashAlgorithmMask HASH bits corresponding to the desired digests to copy.
|
|
|
|
@return The end of buffer to hold TPML_DIGEST_VALUES.
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
Tpm2CopyDigestListToBuffer (
|
|
IN OUT VOID *Buffer,
|
|
IN TPML_DIGEST_VALUES *DigestList,
|
|
IN UINT32 HashAlgorithmMask
|
|
);
|
|
|
|
/**
|
|
Copy a buffer into a TPML_DIGEST_VALUES structure.
|
|
|
|
@param[in] Buffer Buffer to hold TPML_DIGEST_VALUES compact binary.
|
|
@param[in] BufferSize Size of Buffer.
|
|
@param[out] DigestList TPML_DIGEST_VALUES.
|
|
|
|
@return EFI_STATUS
|
|
@retval EFI_SUCCESS Buffer was successfully copied to Digest List.
|
|
@retval EFI_BAD_BUFFER_SIZE Bad buffer size passed to function.
|
|
@retval EFI_INVALID_PARAMETER Invalid parameter passed to function: NULL pointer or
|
|
BufferSize bigger than TPML_DIGEST_VALUES
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Tpm2CopyBufferToDigestList (
|
|
IN CONST VOID *Buffer,
|
|
IN UINTN BufferSize,
|
|
OUT TPML_DIGEST_VALUES *DigestList
|
|
);
|
|
|
|
/**
|
|
Get TPML_DIGEST_VALUES data size.
|
|
|
|
@param[in] DigestList TPML_DIGEST_VALUES data.
|
|
|
|
@return TPML_DIGEST_VALUES data size.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
Tpm2GetDigestListSize (
|
|
IN TPML_DIGEST_VALUES *DigestList
|
|
);
|
|
|
|
/**
|
|
Get TPML_DIGEST_VALUES data size from HashAlgorithmMask
|
|
|
|
@param[in] HashAlgorithmMask Bitfield of allowed hash algorithms
|
|
|
|
@return TPML_DIGEST_VALUES data size.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
Tpm2GetDigestListSizeFromHashAlgorithmMask (
|
|
IN UINT32 HashAlgorithmMask
|
|
);
|
|
|
|
/**
|
|
This function get digest from digest list.
|
|
|
|
@param[in] HashAlg Digest algorithm
|
|
@param[in] DigestList Digest list
|
|
@param[out] Digest Digest
|
|
|
|
@retval EFI_SUCCESS Digest is found and returned.
|
|
@retval EFI_NOT_FOUND Digest is not found.
|
|
@retval EFI_INVALID_PARAMETER DigestList or Digest invalid.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
Tpm2GetDigestFromDigestList (
|
|
IN TPMI_ALG_HASH HashAlg,
|
|
IN TPML_DIGEST_VALUES *DigestList,
|
|
OUT VOID *Digest
|
|
);
|
|
|
|
/**
|
|
Check if all hash algorithms supported in HashAlgorithmMask are
|
|
present in the DigestList.
|
|
|
|
@param DigestList Digest list
|
|
@param HashAlgorithmMask Bitfield of allowed hash algorithms.
|
|
|
|
@retval TRUE All hash algorithms present.
|
|
@retval FALSE Some hash algorithms not present.
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
Tpm2IsDigestListInSyncWithHashAlgorithmMask (
|
|
IN TPML_DIGEST_VALUES *DigestList,
|
|
IN UINT32 HashAlgorithmMask
|
|
);
|