mirror of
https://github.com/smaeul/u-boot.git
synced 2025-10-31 03:58:17 +00:00
9f9797aaa8
Rename the arguments of tcg2_get_pcr_info() to clarify they are bank masks, not PCR mask. Remove the unused local variable. Signed-off-by: Raymond Mao <raymond.mao@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
349 lines
10 KiB
C
349 lines
10 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* Defines APIs and structures that adhere to
|
|
* https://trustedcomputinggroup.org/resource/pc-client-specific-platform-firmware-profile-specification/
|
|
* https://trustedcomputinggroup.org/resource/tcg-efi-protocol-specification/
|
|
*
|
|
* Copyright (c) 2020 Linaro Limited
|
|
*/
|
|
|
|
#ifndef __TPM_TCG_V2_H
|
|
#define __TPM_TCG_V2_H
|
|
|
|
#include <tpm-v2.h>
|
|
|
|
/*
|
|
* event types, cf.
|
|
* "TCG Server Management Domain Firmware Profile Specification",
|
|
* rev 1.00, 2020-05-01
|
|
*/
|
|
#define EV_POST_CODE ((u32)0x00000001)
|
|
#define EV_NO_ACTION ((u32)0x00000003)
|
|
#define EV_SEPARATOR ((u32)0x00000004)
|
|
#define EV_ACTION ((u32)0x00000005)
|
|
#define EV_TAG ((u32)0x00000006)
|
|
#define EV_S_CRTM_CONTENTS ((u32)0x00000007)
|
|
#define EV_S_CRTM_VERSION ((u32)0x00000008)
|
|
#define EV_CPU_MICROCODE ((u32)0x00000009)
|
|
#define EV_PLATFORM_CONFIG_FLAGS ((u32)0x0000000A)
|
|
#define EV_TABLE_OF_DEVICES ((u32)0x0000000B)
|
|
#define EV_COMPACT_HASH ((u32)0x0000000C)
|
|
|
|
/*
|
|
* event types, cf.
|
|
* "TCG PC Client Platform Firmware Profile Specification", Family "2.0"
|
|
* Level 00 Version 1.05 Revision 23, May 7, 2021
|
|
*/
|
|
#define EV_EFI_EVENT_BASE ((u32)0x80000000)
|
|
#define EV_EFI_VARIABLE_DRIVER_CONFIG ((u32)0x80000001)
|
|
#define EV_EFI_VARIABLE_BOOT ((u32)0x80000002)
|
|
#define EV_EFI_BOOT_SERVICES_APPLICATION ((u32)0x80000003)
|
|
#define EV_EFI_BOOT_SERVICES_DRIVER ((u32)0x80000004)
|
|
#define EV_EFI_RUNTIME_SERVICES_DRIVER ((u32)0x80000005)
|
|
#define EV_EFI_GPT_EVENT ((u32)0x80000006)
|
|
#define EV_EFI_ACTION ((u32)0x80000007)
|
|
#define EV_EFI_PLATFORM_FIRMWARE_BLOB ((u32)0x80000008)
|
|
#define EV_EFI_HANDOFF_TABLES ((u32)0x80000009)
|
|
#define EV_EFI_PLATFORM_FIRMWARE_BLOB2 ((u32)0x8000000A)
|
|
#define EV_EFI_HANDOFF_TABLES2 ((u32)0x8000000B)
|
|
#define EV_EFI_VARIABLE_BOOT2 ((u32)0x8000000C)
|
|
#define EV_EFI_HCRTM_EVENT ((u32)0x80000010)
|
|
#define EV_EFI_VARIABLE_AUTHORITY ((u32)0x800000E0)
|
|
#define EV_EFI_SPDM_FIRMWARE_BLOB ((u32)0x800000E1)
|
|
#define EV_EFI_SPDM_FIRMWARE_CONFIG ((u32)0x800000E2)
|
|
|
|
#define EFI_CALLING_EFI_APPLICATION \
|
|
"Calling EFI Application from Boot Option"
|
|
#define EFI_RETURNING_FROM_EFI_APPLICATION \
|
|
"Returning from EFI Application from Boot Option"
|
|
#define EFI_EXIT_BOOT_SERVICES_INVOCATION \
|
|
"Exit Boot Services Invocation"
|
|
#define EFI_EXIT_BOOT_SERVICES_FAILED \
|
|
"Exit Boot Services Returned with Failure"
|
|
#define EFI_EXIT_BOOT_SERVICES_SUCCEEDED \
|
|
"Exit Boot Services Returned with Success"
|
|
#define EFI_DTB_EVENT_STRING \
|
|
"DTB DATA"
|
|
|
|
/**
|
|
* struct TCG_EfiSpecIdEventAlgorithmSize - hashing algorithm information
|
|
*
|
|
* @algorithm_id: algorithm defined in enum tpm2_algorithms
|
|
* @digest_size: size of the algorithm
|
|
*/
|
|
struct tcg_efi_spec_id_event_algorithm_size {
|
|
u16 algorithm_id;
|
|
u16 digest_size;
|
|
} __packed;
|
|
|
|
/**
|
|
* SHA1 Event Log Entry Format
|
|
*
|
|
* @pcr_index: PCRIndex event extended to
|
|
* @event_type: Type of event (see EFI specs)
|
|
* @digest: Value extended into PCR index
|
|
* @event_size: Size of event
|
|
* @event: Event data
|
|
*/
|
|
struct tcg_pcr_event {
|
|
u32 pcr_index;
|
|
u32 event_type;
|
|
u8 digest[TPM2_SHA1_DIGEST_SIZE];
|
|
u32 event_size;
|
|
u8 event[];
|
|
} __packed;
|
|
|
|
/**
|
|
* tcg2_get_pcr_info() - get the supported, active banks and number of banks
|
|
*
|
|
* @dev: TPM device
|
|
* @supported_bank: bitmask with the algorithms supported
|
|
* @active_bank: bitmask with the active algorithms
|
|
* @bank_num: number of PCR banks
|
|
*
|
|
* @return 0 on success, code of operation or negative errno on failure
|
|
*/
|
|
int tcg2_get_pcr_info(struct udevice *dev, u32 *supported_bank, u32 *active_bank,
|
|
u32 *bank_num);
|
|
|
|
/**
|
|
* Crypto Agile Log Entry Format
|
|
*
|
|
* @pcr_index: PCRIndex event extended to
|
|
* @event_type: Type of event
|
|
* @digests: List of digestsextended to PCR index
|
|
* @event_size: Size of the event data
|
|
* @event: Event data
|
|
*/
|
|
struct tcg_pcr_event2 {
|
|
u32 pcr_index;
|
|
u32 event_type;
|
|
struct tpml_digest_values digests;
|
|
u32 event_size;
|
|
u8 event[];
|
|
} __packed;
|
|
|
|
/**
|
|
* struct TCG_EfiSpecIDEventStruct - content of the event log header
|
|
*
|
|
* @signature: signature, set to Spec ID Event03
|
|
* @platform_class: class defined in TCG ACPI Specification
|
|
* Client Common Header.
|
|
* @spec_version_minor: minor version
|
|
* @spec_version_major: major version
|
|
* @spec_version_errata: major version
|
|
* @uintn_size: size of the efi_uintn_t fields used in various
|
|
* data structures used in this specification.
|
|
* 0x01 indicates u32 and 0x02 indicates u64
|
|
* @number_of_algorithms: hashing algorithms used in this event log
|
|
* @digest_sizes: array of number_of_algorithms pairs
|
|
* 1st member defines the algorithm id
|
|
* 2nd member defines the algorithm size
|
|
*/
|
|
struct tcg_efi_spec_id_event {
|
|
u8 signature[16];
|
|
u32 platform_class;
|
|
u8 spec_version_minor;
|
|
u8 spec_version_major;
|
|
u8 spec_errata;
|
|
u8 uintn_size;
|
|
u32 number_of_algorithms;
|
|
struct tcg_efi_spec_id_event_algorithm_size digest_sizes[];
|
|
} __packed;
|
|
|
|
#define TCG_EFI_SPEC_ID_EVENT_SIGNATURE_03 "Spec ID Event03"
|
|
#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MAJOR_TPM2 2
|
|
#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_MINOR_TPM2 0
|
|
#define TCG_EFI_SPEC_ID_EVENT_SPEC_VERSION_ERRATA_TPM2 2
|
|
/**
|
|
* struct tcg2_event_log - Container for managing the platform event log
|
|
*
|
|
* @log: Address of the log
|
|
* @log_position: Current entry position
|
|
* @log_size: Log space available
|
|
* @found: Boolean indicating if an existing log was discovered
|
|
*/
|
|
struct tcg2_event_log {
|
|
u8 *log;
|
|
u32 log_position;
|
|
u32 log_size;
|
|
bool found;
|
|
};
|
|
|
|
/**
|
|
* Create a list of digests of the supported PCR banks for a given input data
|
|
*
|
|
* @dev TPM device
|
|
* @input Data
|
|
* @length Length of the data to calculate the digest
|
|
* @digest_list List of digests to fill in
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_create_digest(struct udevice *dev, const u8 *input, u32 length,
|
|
struct tpml_digest_values *digest_list);
|
|
|
|
/**
|
|
* Get the event size of the specified digests
|
|
*
|
|
* @digest_list List of digests for the event
|
|
*
|
|
* Return: Size in bytes of the event
|
|
*/
|
|
u32 tcg2_event_get_size(struct tpml_digest_values *digest_list);
|
|
|
|
/**
|
|
* tcg2_get_active_pcr_banks
|
|
*
|
|
* @dev TPM device
|
|
* @active_pcr_banks Bitmask of PCR algorithms supported
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_get_active_pcr_banks(struct udevice *dev, u32 *active_pcr_banks);
|
|
|
|
/**
|
|
* tcg2_log_append - Append an event to an event log
|
|
*
|
|
* @pcr_index Index of the PCR
|
|
* @event_type Type of event
|
|
* @digest_list List of digests to add
|
|
* @size Size of event
|
|
* @event Event data
|
|
* @log Log buffer to append the event to
|
|
*/
|
|
void tcg2_log_append(u32 pcr_index, u32 event_type,
|
|
struct tpml_digest_values *digest_list, u32 size,
|
|
const u8 *event, u8 *log);
|
|
|
|
/**
|
|
* Extend the PCR with specified digests
|
|
*
|
|
* @dev TPM device
|
|
* @pcr_index Index of the PCR
|
|
* @digest_list List of digests to extend
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_pcr_extend(struct udevice *dev, u32 pcr_index,
|
|
struct tpml_digest_values *digest_list);
|
|
|
|
/**
|
|
* Read the PCR into a list of digests
|
|
*
|
|
* @dev TPM device
|
|
* @pcr_index Index of the PCR
|
|
* @digest_list List of digests to extend
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_pcr_read(struct udevice *dev, u32 pcr_index,
|
|
struct tpml_digest_values *digest_list);
|
|
|
|
/**
|
|
* Measure data into the TPM PCRs and the platform event log.
|
|
*
|
|
* @dev TPM device
|
|
* @log Platform event log
|
|
* @pcr_index Index of the PCR
|
|
* @size Size of the data or 0 for event only
|
|
* @data Pointer to the data or NULL for event only
|
|
* @event_type Event log type
|
|
* @event_size Size of the event
|
|
* @event Pointer to the event
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_measure_data(struct udevice *dev, struct tcg2_event_log *elog,
|
|
u32 pcr_index, u32 size, const u8 *data, u32 event_type,
|
|
u32 event_size, const u8 *event);
|
|
|
|
#define tcg2_measure_event(dev, elog, pcr_index, event_type, size, event) \
|
|
tcg2_measure_data(dev, elog, pcr_index, 0, NULL, event_type, size, \
|
|
event)
|
|
|
|
/**
|
|
* Prepare the event log buffer. This function tries to discover an existing
|
|
* event log in memory from a previous bootloader stage. If such a log exists
|
|
* and the PCRs are not extended, the log is "replayed" to extend the PCRs.
|
|
* If no log is discovered, create the log header.
|
|
*
|
|
* @dev TPM device
|
|
* @elog Platform event log. The log pointer and log_size
|
|
* members must be initialized to either 0 or to a valid
|
|
* memory region, in which case any existing log
|
|
* discovered will be copied to the specified memory
|
|
* region.
|
|
* @ignore_existing_log Boolean to indicate whether or not to ignore an
|
|
* existing platform log in memory
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_log_prepare_buffer(struct udevice *dev, struct tcg2_event_log *elog,
|
|
bool ignore_existing_log);
|
|
|
|
/**
|
|
* Begin measurements.
|
|
*
|
|
* @dev TPM device
|
|
* @elog Platform event log. The log pointer and log_size
|
|
* members must be initialized to either 0 or to a valid
|
|
* memory region, in which case any existing log
|
|
* discovered will be copied to the specified memory
|
|
* region.
|
|
* @ignore_existing_log Boolean to indicate whether or not to ignore an
|
|
* existing platform log in memory
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_measurement_init(struct udevice **dev, struct tcg2_event_log *elog,
|
|
bool ignore_existing_log);
|
|
|
|
/**
|
|
* Stop measurements and record separator events.
|
|
*
|
|
* @dev TPM device
|
|
* @elog Platform event log
|
|
* @error Boolean to indicate whether an error ocurred or not
|
|
*/
|
|
void tcg2_measurement_term(struct udevice *dev, struct tcg2_event_log *elog,
|
|
bool error);
|
|
|
|
/**
|
|
* Get the platform event log address and size.
|
|
*
|
|
* @dev TPM device
|
|
* @addr Address of the log
|
|
* @size Size of the log
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_platform_get_log(struct udevice *dev, void **addr, u32 *size);
|
|
|
|
/**
|
|
* Get the first TPM2 device found.
|
|
*
|
|
* @dev TPM device
|
|
*
|
|
* Return: zero on success, negative errno otherwise
|
|
*/
|
|
int tcg2_platform_get_tpm2(struct udevice **dev);
|
|
|
|
/**
|
|
* Platform-specific function for handling TPM startup errors
|
|
*
|
|
* @dev TPM device
|
|
* @rc The TPM response code
|
|
*/
|
|
void tcg2_platform_startup_error(struct udevice *dev, int rc);
|
|
|
|
/**
|
|
* tcg2_algorithm_to_mask() - Get a TCG hash mask for algorithm
|
|
*
|
|
* @hash_alg: TCG defined algorithm
|
|
* Return: TCG hashing algorithm bitmaps (or 0 if algo not supported)
|
|
*/
|
|
u32 tcg2_algorithm_to_mask(enum tpm2_algorithms);
|
|
|
|
#endif /* __TPM_TCG_V2_H */
|