Add support for TPM2 event logs on EFI systems
Subsystems (3)
PATCH v3 1/1 Add support for TPM2 event logs on EFI systems
Updated with review feedback comments, no functional change.
PATCH v3 1/4 tpm: Abstract crypto agile event size calculations
From: Matthew Garrett <[email protected]>
We need to calculate the size of crypto agile events in multiple locations, including in the EFI boot stub. The easiest way to do this is to put it in a header file as an inline and leave a wrapper to ensure we don't end up with multiple copies of it embedded in the existing code.
--- drivers/char/tpm/eventlog/tpm2.c | 47 +--------------------- include/linux/tpm_eventlog.h | 68 ++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 46 deletions(-)
drivers/char/tpm/eventlog/tpm2.c +1 -46
@@ -40,52 +40,7 @@static int calc_tpm2_event_size (struct tcg_pcr_event2_head *event,struct tcg_pcr_event *event_header) { -struct tcg_efi_specid_event_head *efispecid; -struct tcg_event_field *event_field; -void *marker; -void *marker_start; -u32 halg_size; -size_t size; -u16 halg; -int i; -int j; - - marker = event; - marker_start = marker; - marker = marker +sizeof (event->pcr_idx) +sizeof (event->event_type) - +sizeof (event->count); - - efispecid = (struct tcg_efi_specid_event_head *)event_header->event; - -/* Check if event is malformed. */ -if (event->count > efispecid->num_algs) -return 0 ; - -for (i =0 ; i < event->count; i++) { - halg_size =sizeof (event->digests[i].alg_id); -memcpy (&halg, marker, halg_size); - marker = marker + halg_size; -for (j =0 ; j < efispecid->num_algs; j++) { -if (halg == efispecid->digest_sizes[j].alg_id) { - marker += - efispecid->digest_sizes[j].digest_size; -break ; - } - } -/* Algorithm without known length. Such event is unparseable. */ -if (j == efispecid->num_algs) -return 0 ; - } - - event_field = (struct tcg_event_field *)marker; - marker = marker +sizeof (event_field->event_size) - + event_field->event_size; - size = marker - marker_start; - -if ((event->event_type ==0 ) && (event_field->event_size ==0 )) -return 0 ; - -return size; +return __calc_tpm2_event_size (event, event_header); }static void *tpm2_bios_measurements_start (struct seq_file *m,loff_t *pos)
include/linux/tpm_eventlog.h +68 -0
72 lines not on this page · raw message
Signature · 1 line
2.20.1.791.gb4d0f1c61a-goog
Re: [PATCH V3 1/4] tpm: Abstract crypto agile event size calculations
Quoted 8 lines · Matthew Garrett
From: Matthew Garrett <[email protected]>
We need to calculate the size of crypto agile events in multiple locations, including in the EFI boot stub. The easiest way to do this is to put it in a header file as an inline and leave a wrapper to ensure we don't end up with multiple copies of it embedded in the existing code.
Signed-off-by Matthew Garrett <[email protected]>
/Jarkko
PATCH v3 2/4 tpm: Reserve the TPM final events table
In reply to Matthew GarrettFrom: Matthew Garrett <[email protected]>
UEFI systems provide a boot services protocol for obtaining the TPM event log, but this is unusable after ExitBootServices() is called. Unfortunately ExitBootServices() itself triggers additional TPM events that then can't be obtained using this protocol. The platform provides a mechanism for the OS to obtain these events by recording them to a separate UEFI configuration table which the OS can then map.
Unfortunately this table isn't self describing in terms of providing its length, so we need to parse the events inside it to figure out how long it is. Since the table isn't mapped at this point, we need to extend the length calculation function to be able to map the event as it goes along.
--- drivers/char/tpm/eventlog/tpm2.c | 2 +- drivers/firmware/efi/efi.c | 2 + drivers/firmware/efi/tpm.c | 51 ++++++++++++++++- include/linux/efi.h | 9 +++ include/linux/tpm_eventlog.h | 94 +++++++++++++++++++++++++++++--- 5 files changed, 148 insertions(+), 10 deletions(-)
drivers/char/tpm/eventlog/tpm2.c +1 -1
@@ -40,7 +40,7 @@static int calc_tpm2_event_size (struct tcg_pcr_event2_head *event,struct tcg_pcr_event *event_header) { -return __calc_tpm2_event_size (event, event_header); +return __calc_tpm2_event_size (event, event_header, false); }static void *tpm2_bios_measurements_start (struct seq_file *m,loff_t *pos)
drivers/firmware/efi/efi.c +2 -0
@@ -53,6 +53,7 @@ struct efi __read_mostly efi = { .mem_attr_table = EFI_INVALID_TABLE_ADDR, .rng_seed = EFI_INVALID_TABLE_ADDR, .tpm_log = EFI_INVALID_TABLE_ADDR, + .tpm_final_log = EFI_INVALID_TABLE_ADDR, .mem_reserve = EFI_INVALID_TABLE_ADDR, };EXPORT_SYMBOL (efi);
@@ -485,6 +486,7 @@ static __initdata efi_config_table_type_t common_tables[] = { {EFI_MEMORY_ATTRIBUTES_TABLE_GUID, "MEMATTR", &efi.mem_attr_table}, {LINUX_EFI_RANDOM_SEED_TABLE_GUID, "RNG", &efi.rng_seed}, {LINUX_EFI_TPM_EVENT_LOG_GUID, "TPMEventLog", &efi.tpm_log}, + {LINUX_EFI_TPM_FINAL_LOG_GUID, "TPMFinalLog", &efi.tpm_final_log}, {LINUX_EFI_MEMRESERVE_TABLE_GUID, "MEMRESERVE", &efi.mem_reserve}, {NULL_GUID, NULL, NULL}, };
drivers/firmware/efi/tpm.c +49 -2
79 lines not on this page · raw message
include/linux/efi.h +9 -0
@@ -676,6 +676,7 @@ void efi_native_runtime_setup(void);#define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)#define LINUX_EFI_RANDOM_SEED_TABLE_GUID EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2, 0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)#define LINUX_EFI_TPM_EVENT_LOG_GUID EFI_GUID(0xb7799cb0, 0xeca2, 0x4943, 0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa) +#define LINUX_EFI_TPM_FINAL_LOG_GUID EFI_GUID(0x1e2ed096, 0x30e2, 0x4254, 0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)#define LINUX_EFI_MEMRESERVE_TABLE_GUID EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5, 0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2) typedef struct {
@@ -983,6 +984,7 @@ extern struct efi {unsigned long mem_attr_table;/* memory attributes table */ unsigned long rng_seed;/* UEFI firmware random seed */ unsigned long tpm_log;/* TPM2 Event Log table */ +unsigned long tpm_final_log;/* TPM2 Final Events Log table */ unsigned long mem_reserve;/* Linux EFI memreserve table */ efi_get_time_t *get_time;efi_set_time_t *set_time;
@@ -1700,6 +1702,13 @@ struct linux_efi_tpm_eventlog {extern int efi_tpm_eventlog_init (void ); +struct efi_tcg2_final_events_table { +u64 version; +u64 nr_events; +u8 events[]; +}; +extern int efi_tpm_final_log_size; +/* * efi_runtime_service() function identifiers. * "NONE" is used by efi_recover_from_page_fault() to check if the page
include/linux/tpm_eventlog.h +87 -7
143 lines not on this page · raw message
Signature · 1 line
2.20.1.791.gb4d0f1c61a-goog
Re: [PATCH V3 2/4] tpm: Reserve the TPM final events table
Quoted 9 lines · Matthew Garrett
From: Matthew Garrett <[email protected]>
UEFI systems provide a boot services protocol for obtaining the TPM event log, but this is unusable after
ExitBootServices()is called. UnfortunatelyExitBootServices()itself triggers additional TPM events that then can't be obtained using this protocol. The platform provides a mechanism for the OS to obtain these events by recording them to a separate UEFI configuration table which the OS can then map.
Quoted 7 lines
Unfortunately this table isn't self describing in terms of providing its length, so we need to parse the events inside it to figure out how long it is. Since the table isn't mapped at this point, we need to extend the length calculation function to be able to map the event as it goes along.
Signed-off-by Matthew Garrett <[email protected]>
/Jarkko
PATCH v3 3/4 tpm: Append the final event log to the TPM event log
In reply to Matthew GarrettFrom: Matthew Garrett <[email protected]>
Any events that are logged after GetEventsLog() is called are logged to the EFI Final Events table. These events are defined as being in the crypto agile log format, so we can just append them directly to the existing log if it's in the same format. In theory we can also construct old-style SHA1 log entries for devices that only return logs in that format, but EDK2 doesn't generate the final event log in that case so it doesn't seem worth it at the moment.
--- drivers/char/tpm/eventlog/efi.c | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-)
drivers/char/tpm/eventlog/efi.c +32 -1
@@ -21,10 +21,12 @@int tpm_read_log_efi (struct tpm_chip *chip) { +struct efi_tcg2_final_events_table *final_tbl =NULL ;struct linux_efi_tpm_eventlog *log_tbl;struct tpm_bios_log *log;u32 log_size;u8 tpm_log_version; +void *tmp;if (!(chip->flags &TPM_CHIP_FLAG_TPM2 ))return -ENODEV ;
@@ -55,12 +57,41 @@ int tpm_read_log_efi(struct tpm_chip *chip)if (!log->bios_event_log) goto err_memunmap; log->bios_event_log_end = log->bios_event_log + log_size; - tpm_log_version = log_tbl->version; + +if (efi.tpm_final_log !=EFI_INVALID_TABLE_ADDR && + efi_tpm_final_log_size !=0 ) { +if (tpm_log_version ==EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 ) { + final_tbl =memremap (efi.tpm_final_log, +sizeof (*final_tbl) + efi_tpm_final_log_size, +MEMREMAP_WB ); +if (!final_tbl) { +pr_err ("Could not map UEFI TPM final log\n" ); +kfree (log->bios_event_log); + goto err_memunmap; + } + + tmp =krealloc (log->bios_event_log, + log_size + efi_tpm_final_log_size, +GFP_KERNEL ); +if (!tmp) { +kfree (log->bios_event_log); + goto err_memunmap; + } + + log->bios_event_log = tmp; +memcpy ((void *)log->bios_event_log + log_size, + final_tbl->events, efi_tpm_final_log_size); + log->bios_event_log_end = log->bios_event_log + + log_size + efi_tpm_final_log_size; + } + } +memunmap (final_tbl);memunmap (log_tbl);return tpm_log_version; err_memunmap: +memunmap (final_tbl);memunmap (log_tbl);return -ENOMEM ; }
Signature · 1 line
2.20.1.791.gb4d0f1c61a-goog
Re: [PATCH V3 3/4] tpm: Append the final event log to the TPM event log
drivers/char/tpm/eventlog/efi.c int tpm_read_log_efi(struct tpm_chip *chip) · line 64
Quoted 3 lines · Matthew Garrett
drivers/char/tpm/eventlog/efi.c +3
-0+if (efi.tpm_final_log !=EFI_INVALID_TABLE_ADDR && + efi_tpm_final_log_size !=0 ) { +if (tpm_log_version ==EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 ) {
Instead of nesting code heavily I would just:
if (efi.tpm_final_log == EFI_INVALID_TABLE_ADDR ||
efi_tpm_final_log_size == 0 ||
tpm_log_version != EFI_TCG2_EVENT_LOG_FORMAT_TCG_2)
goto out_memunmap;And in the tail:
out_munmap:
memunmap(final_tbl); memunmap(log_tb); return tpm_log_version;
err_munmap:
memunmap(final_tbl); memunmap(log_tb); return -ENOMEM; }
/Jarkko
PATCH v3 4/4 efi: Attempt to get the TCG2 event log in the boot stub
In reply to Matthew GarrettFrom: Matthew Garrett <[email protected]>
Right now we only attempt to obtain the SHA1-only event log. The protocol also supports a crypto agile log format, which contains digests for all algorithms in use. Attempt to obtain this first, and fall back to obtaining the older format if the system doesn't support it. This is lightly complicated by the event sizes being variable (as we don't know in advance which algorithms are in use), and the interface giving us back a pointer to the start of the final entry rather than a pointer to the end of the log - as a result, we need to parse the final entry to figure out its length in order to know how much data to copy up to the OS.
--- drivers/firmware/efi/libstub/tpm.c | 50 ++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 17 deletions(-)
drivers/firmware/efi/libstub/tpm.c +33 -17
@@ -59,7 +59,7 @@ void efi_enable_reset_attack_mitigation(efi_system_table_t *sys_table_arg)#endif -static void efi_retrieve_tpm2_eventlog_1_2 (efi_system_table_t *sys_table_arg) +void efi_retrieve_tpm2_eventlog (efi_system_table_t *sys_table_arg) {efi_guid_t tcg2_guid =EFI_TCG2_PROTOCOL_GUID ;efi_guid_t linux_eventlog_guid =LINUX_EFI_TPM_EVENT_LOG_GUID ;
@@ -69,6 +69,7 @@ static void efi_retrieve_tpm2_eventlog_1_2(efi_system_table_t *sys_table_arg)unsigned long first_entry_addr, last_entry_addr;size_t log_size, last_entry_size;efi_bool_t truncated; +int version =EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 ;void *tcg2_protocol =NULL ; status = efi_call_early(locate_protocol, &tcg2_guid, NULL,
@@ -76,14 +77,20 @@ static void efi_retrieve_tpm2_eventlog_1_2(efi_system_table_t *sys_table_arg)if (status !=EFI_SUCCESS )return ; - status =efi_call_proto (efi_tcg2_protocol, get_event_log, tcg2_protocol, -EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2 , - &log_location, &log_last_entry, &truncated); -if (status !=EFI_SUCCESS ) -return ; + status =efi_call_proto (efi_tcg2_protocol, get_event_log, + tcg2_protocol, version, &log_location, + &log_last_entry, &truncated); + +if (status !=EFI_SUCCESS || !log_location) { + version =EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2 ; + status =efi_call_proto (efi_tcg2_protocol, get_event_log, + tcg2_protocol, version, &log_location, + &log_last_entry, &truncated); +if (status !=EFI_SUCCESS || !log_location) +return ; + + } -if (!log_location) -return ; first_entry_addr = (unsigned long ) log_location;/*
@@ -98,8 +105,23 @@ static void efi_retrieve_tpm2_eventlog_1_2(efi_system_table_t *sys_table_arg)* We need to calculate its size to deduce the full size of * the logs. */ - last_entry_size =sizeof (struct tcpa_event ) + - ((struct tcpa_event *) last_entry_addr)->event_size; +if (version ==EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 ) { +/* +* The TCG2 log format has variable length entries, +* and the information to decode the hash algorithms +* back into a size is contained in the first entry - +* pass a pointer to the final entry (to calculate its +* size) and the first entry (so we know how long each +* digest is) +*/ + last_entry_size = +__calc_tpm2_event_size ((void *)last_entry_addr, + (void *)log_location, + false); + }else { + last_entry_size =sizeof (struct tcpa_event ) + + ((struct tcpa_event *) last_entry_addr)->event_size; + } log_size = log_last_entry - log_location + last_entry_size; }
@@ -116,7 +138,7 @@ static void efi_retrieve_tpm2_eventlog_1_2(efi_system_table_t *sys_table_arg)memset (log_tbl,0 ,sizeof (*log_tbl) + log_size); log_tbl->size = log_size; - log_tbl->version =EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2 ; + log_tbl->version = version;memcpy (log_tbl->log, (void *) first_entry_addr, log_size); status = efi_call_early(install_configuration_table,
@@ -128,9 +150,3 @@ static void efi_retrieve_tpm2_eventlog_1_2(efi_system_table_t *sys_table_arg) err_free:efi_call_early (free_pool, log_tbl); } - -void efi_retrieve_tpm2_eventlog (efi_system_table_t *sys_table_arg) -{ -/* Only try to retrieve the logs in 1.2 format. */ -efi_retrieve_tpm2_eventlog_1_2 (sys_table_arg); -}
Signature · 1 line
2.20.1.791.gb4d0f1c61a-goog
Re: [PATCH V3 4/4] efi: Attempt to get the TCG2 event log in the boot stub
Quoted 13 lines · Matthew Garrett
From: Matthew Garrett <[email protected]>
Right now we only attempt to obtain the SHA1-only event log. The protocol also supports a crypto agile log format, which contains digests for all algorithms in use. Attempt to obtain this first, and fall back to obtaining the older format if the system doesn't support it. This is lightly complicated by the event sizes being variable (as we don't know in advance which algorithms are in use), and the interface giving us back a pointer to the start of the final entry rather than a pointer to the end of the log - as a result, we need to parse the final entry to figure out its length in order to know how much data to copy up to the OS.
Quoted 1 line
Signed-off-by Matthew Garrett <[email protected]>
/Jarkko
Quoted 1 line · Matthew Garrett
Updated with review feedback comments, no functional change.
Tried to test with a Geminilake NUC but for some reason do not see the log file with this machine.
The final log *does* get reported:
[ 0.000000] efi: ACPI 2.0=0x69ca2000 ACPI=0x69ca2000 TPMFinalLog=0x69ce4000 SMBIOS=0x69f63000 SMBIOS 3.0=0x69f62000 ESRT=0x69f3e818 MEMATTR=0x63474118
I'll try to debug this further later on.
/Jarkko
Quoted 11 lines · Jarkko Sakkinen
Quoted 1 line · Matthew Garrett
Updated with review feedback comments, no functional change.
Tried to test with a Geminilake NUC but for some reason do not see the log file with this machine.
The final log *does* get reported:
[ 0.000000] efi: ACPI 2.0=0x69ca2000 ACPI=0x69ca2000 TPMFinalLog=0x69ce4000 SMBIOS=0x69f63000 SMBIOS 3.0=0x69f62000 ESRT=0x69f3e818 MEMATTR=0x63474118I'll try to debug this further later on.
PS. Can you send the next version so that it gets CC'd to linux-security-module and main linux-kernel list or if we come to the conclusion that this patch set version is sufficient, do a resend (--subject-prefix="PATCH v3, RESEND")?
Probably good timing is when I get this tested first...
/Jarkko
Quoted 2 lines · Jarkko Sakkinen
Tried to test with a Geminilake NUC but for some reason do not see the log file with this machine.
I'll retest a rebased tree on my NUC on Friday - just ran out of time to get a build done before I had to leave for a trip.
Quoted 7 lines · Matthew Garrett
Quoted 2 lines · Jarkko Sakkinen
Tried to test with a Geminilake NUC but for some reason do not see the log file with this machine.
I'll retest a rebased tree on my NUC on Friday - just ran out of time to get a build done before I had to leave for a trip.
Great, thanks. I'm in process of getting v19 of SGX patch set out hopefully next week so probably won't have time to look at this before latter part of that week.
/Jarkko
Quoted 7 lines · Jarkko Sakkinen
Quoted 5 lines · Matthew Garrett
Quoted 2 lines · Jarkko Sakkinen
Tried to test with a Geminilake NUC but for some reason do not see the log file with this machine.
Quoted 6 lines
Quoted 2 lines
I'll retest a rebased tree on my NUC on Friday - just ran out of time to get a build done before I had to leave for a trip.
Great, thanks. I'm in process of getting v19 of SGX patch set out hopefully next week so probably won't have time to look at this before latter part of that week.
Tested on an Apollo Lake NUC and I see /sys/kernel/security/tpm0/binary_bios_measurements with this. dmesg shows both the TPMFinalLog and the TPMEventLog.