tpm: Support boot measurements
v8 cover tpm: Support boot measurements
This series adds support for measuring the boot images more generically than the existing EFI support. Several EFI functions have been moved to the TPM layer. The series includes optional measurement from the bootm command.
A new test case has been added for the bootm measurement to test the new path, and the sandbox TPM2 driver has been updated to support this use case.
This series is based on Ilias' auto-startup series and Simon's additions.
Changes since v7:
- Change name of tcg2_init_log and add more documentation
- Add a check, when parsing the event log header, to ensure that the previous stage bootloader used all the active PCRs.
- Change name of tcg2_log_find_end
- Fix the greater than or equal to check to exit the log parsing
- Make sure log_position is 0 if there is any error discovering the log
- Return errors parsing the log if the data is corrupt so that we don't end up with half a log
Changes since v6:
- Added comment for bootm_measure
- Fixed line length in bootm_measure
- Added Linaro copyright for all the EFI moved code
- Changed tcg2_init_log (and by extension, tcg2_measurement_init) to copy any discovered event log to the user's log if passed in.
Changes since v5:
- Re-ordered the patches to put the sandbox TPM driver patch second
- Remove unused platform_get_eventlog in efi_tcg2.c
- First look for tpm_event_log_* properties instead of linux,sml-*
- Fix efi_tcg2.c compilation
- Select SHA* configs
- Remove the !SANDBOX dependency for EFI TCG2
- Only compile in the measurement u-boot command when CONFIG_MEASURED_BOOT is enabled
Changes since v4:
- Remove tcg2_measure_event function and check for NULL data in tcg2_measure_data
- Use tpm_auto_startup
- Fix efi_tcg2.c compilation for removing tcg2_pcr_read function
- Change PCR indexes for initrd and dtb
- Drop u8 casting in measurement test
- Use bullets in documentation
Changes since v3:
- Reordered headers
- Refactored more of EFI code into common code
Removed digest_info structure and instead used the common alg_to_mask
and alg_to_len
Improved event log parsing in common code to get it equivalent to EFI
Common code now extends PCR if previous bootloader stage couldn't No need to allocate memory in the common code, so EFI copies the discovered buffer like it did before
Rename efi measure_event function
Changes since v2:
- Add documentation.
- Changed reserved memory address to the top of the RAM for sandbox dts.
- Add measure state to booti and bootz.
- Skip measurement for EFI images that should be measured
Changes since v1:
- Refactor TPM layer functions to allow EFI system to use them, and remove duplicate EFI functions.
- Add test case
- Drop #ifdefs for bootm
- Add devicetree measurement config option
- Update sandbox TPM driver
Eddie James (6):
tpm: Fix spelling for tpmu_ha union
tpm: sandbox: Update for needed TPM2 capabilities
tpm: Support boot measurements
bootm: Support boot measurement
test: Add sandbox TPM boot measurement
doc: Add measured boot documentation
arch/sandbox/dts/sandbox.dtsi | 13 + arch/sandbox/dts/test.dts | 13 + boot/Kconfig | 23 + boot/bootm.c | 72 +++ cmd/booti.c | 1 + cmd/bootm.c | 2 + cmd/bootz.c | 1 + configs/sandbox_defconfig | 1 + doc/usage/index.rst | 1 + doc/usage/measured_boot.rst | 23 + drivers/tpm/tpm2_tis_sandbox.c | 100 ++- include/bootm.h | 11 + include/efi_tcg2.h | 44 -- include/image.h | 1 + include/test/suites.h | 1 + include/tpm-v2.h | 255 +++++++- lib/Kconfig | 4 + lib/efi_loader/Kconfig | 2 - lib/efi_loader/efi_tcg2.c | 1054 +++----------------------------- lib/tpm-v2.c | 815 ++++++++++++++++++++++++ test/boot/Makefile | 1 + test/boot/measurement.c | 66 ++ test/cmd_ut.c | 4 + 23 files changed, 1455 insertions(+), 1053 deletions(-) create mode 100644 doc/usage/measured_boot.rst create mode 100644 test/boot/measurement.c
Signature · 1 line
2.31.1
PATCH v8 1/6 tpm: Fix spelling for tpmu_ha union
tmpu -> tpmu
--- include/tpm-v2.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
include/tpm-v2.h +2 -2
@@ -169,7 +169,7 @@ struct tcg_pcr_event {/** * Definition of TPMU_HA Union */ -union tmpu_ha { +union tpmu_ha {u8 sha1[TPM2_SHA1_DIGEST_SIZE ];u8 sha256[TPM2_SHA256_DIGEST_SIZE ];u8 sm3_256[TPM2_SM3_256_DIGEST_SIZE ];
@@ -185,7 +185,7 @@ union tmpu_ha {*/ struct tpmt_ha {u16 hash_alg; -union tmpu_ha digest; +union tpmu_ha digest; } __packed;/**
Signature · 1 line
2.31.1
PATCH v8 2/6 tpm: sandbox: Update for needed TPM2 capabilities
In reply to Eddie JamesThe driver needs to support getting the PCRs in the capabilities command. Fix various other things and support the max number of PCRs for TPM2.
Remove the !SANDBOX dependency for EFI TCG2 as well.
---
Changes since v5:
- Remove the !SANDBOX dependency for EFI TCG2
drivers/tpm/tpm2_tis_sandbox.c | 100 ++++++++++++++++++++++++--------- lib/efi_loader/Kconfig | 2 - 2 files changed, 72 insertions(+), 30 deletions(-)
drivers/tpm/tpm2_tis_sandbox.c +72 -28
@@ -22,11 +22,6 @@ enum tpm2_hierarchy { TPM2_HIERARCHY_NB, }; -/* Subset of supported capabilities */ -enum tpm2_capability { -TPM_CAP_TPM_PROPERTIES =0x6 , -}; -/* Subset of supported properties */ #define TPM2_PROPERTIES_OFFSET 0x0000020E
@@ -38,7 +33,8 @@ enum tpm2_cap_tpm_property { TPM2_PROPERTY_NB, }; -#define SANDBOX_TPM_PCR_NB 1 +#define SANDBOX_TPM_PCR_NB TPM2_MAX_PCRS +#define SANDBOX_TPM_PCR_SELECT_MAX ((SANDBOX_TPM_PCR_NB + 7) / 8)/* * Information about our TPM emulation. This is preserved in the sandbox
@@ -433,7 +429,7 @@ static int sandbox_tpm2_xfer(struct udevice *dev, const u8 *sendbuf,int i, j;/* TPM2_GetProperty */ -u32 capability, property, property_count; +u32 capability, property, property_count, val;/* TPM2_PCR_Read/Extend variables */ int pcr_index =0 ;
@@ -542,19 +538,32 @@ static int sandbox_tpm2_xfer(struct udevice *dev, const u8 *sendbuf,case TPM2_CC_GET_CAPABILITY : capability =get_unaligned_be32 (sent); sent +=sizeof (capability); -if (capability !=TPM_CAP_TPM_PROPERTIES ) { -printf ("Sandbox TPM only support TPM_CAPABILITIES\n" ); -return TPM2_RC_HANDLE ; - } - property =get_unaligned_be32 (sent); sent +=sizeof (property); - property -=TPM2_PROPERTIES_OFFSET ; - property_count =get_unaligned_be32 (sent); sent +=sizeof (property_count); -if (!property_count || - property + property_count >TPM2_PROPERTY_NB ) { + +switch (capability) { +case TPM2_CAP_PCRS : +break ; +case TPM2_CAP_TPM_PROPERTIES : +if (!property_count) { + rc =TPM2_RC_HANDLE ; +return sandbox_tpm2_fill_buf (recv, recv_len, + tag, rc); + } + +if (property >TPM2_PROPERTIES_OFFSET && + ((property -TPM2_PROPERTIES_OFFSET ) + + property_count >TPM2_PROPERTY_NB )) { + rc =TPM2_RC_HANDLE ; +return sandbox_tpm2_fill_buf (recv, recv_len, + tag, rc); + } +break ; +default : +printf ("Sandbox TPM2 only supports TPM2_CAP_PCRS or " +"TPM2_CAP_TPM_PROPERTIES\n" ); rc =TPM2_RC_HANDLE ;return sandbox_tpm2_fill_buf (recv, recv_len, tag, rc); }
@@ -578,18 +587,53 @@ static int sandbox_tpm2_xfer(struct udevice *dev, const u8 *sendbuf,put_unaligned_be32 (capability, recv); recv +=sizeof (capability); -/* Give the number of properties that follow */ -put_unaligned_be32 (property_count, recv); - recv +=sizeof (property_count); - -/* Fill with the properties */ -for (i =0 ; i < property_count; i++) { -put_unaligned_be32 (TPM2_PROPERTIES_OFFSET + property + - i, recv); - recv +=sizeof (property); -put_unaligned_be32 (tpm->properties[property + i], - recv); - recv +=sizeof (property); +switch (capability) { +case TPM2_CAP_PCRS : +/* Give the number of algorithms supported - just SHA256 */ +put_unaligned_be32 (1 , recv); + recv +=sizeof (u32); + +/* Give SHA256 algorithm */ +put_unaligned_be16 (TPM2_ALG_SHA256 , recv); + recv +=sizeof (u16); + +/* Select the PCRs supported */ + *recv =SANDBOX_TPM_PCR_SELECT_MAX ; + recv++; + +/* Activate all the PCR bits */ +for (i =0 ; i <SANDBOX_TPM_PCR_SELECT_MAX ; ++i) { + *recv =0xff ; + recv++; + } +break ; +case TPM2_CAP_TPM_PROPERTIES : +/* Give the number of properties that follow */ +put_unaligned_be32 (property_count, recv); + recv +=sizeof (property_count); + +/* Fill with the properties */ +for (i =0 ; i < property_count; i++) { +put_unaligned_be32 (property + i, recv); + recv +=sizeof (property); +if (property >TPM2_PROPERTIES_OFFSET ) { + val = tpm->properties[(property - +TPM2_PROPERTIES_OFFSET ) + i]; + }else { +switch (property) { +case TPM2_PT_PCR_COUNT : + val =SANDBOX_TPM_PCR_NB ; +break ; +default : + val =0xffffffff ; +break ; + } + } + +put_unaligned_be32 (val, recv); + recv +=sizeof (property); + } +break ; }/* Add trailing \0 */
lib/efi_loader/Kconfig +0 -2
@@ -333,8 +333,6 @@ config EFI_TCG2_PROTOCOL bool "EFI_TCG2_PROTOCOL support" default y depends on TPM_V2 - # Sandbox TPM currently fails on GetCapabilities needed for TCG2 - depends on !SANDBOX select SHA1 select SHA256 select SHA384
Signature · 1 line
2.31.1
PATCH v8 3/6 tpm: Support boot measurements
In reply to Eddie JamesAdd TPM2 functions to support boot measurement. This includes starting up the TPM, initializing/appending the event log, and measuring the U-Boot version. Much of the code was used in the EFI subsystem, so remove it there and use the common functions.
---
Changes since v7:
- Change name of tcg2_init_log and add more documentation
- Add a check, when parsing the event log header, to ensure that the previous stage bootloader used all the active PCRs.
- Change name of tcg2_log_find_end
- Fix the greater than or equal to check to exit the log parsing
- Make sure log_position is 0 if there is any error discovering the log
- Return errors parsing the log if the data is corrupt so that we don't end up with half a log
Changes since v6:
- Added Linaro copyright for all the EFI moved code
- Changed tcg2_init_log (and by extension, tcg2_measurement_init) to copy any discovered event log to the user's log if passed in.
Changes since v5:
- Remove unused platform_get_eventlog in efi_tcg2.c
- First look for tpm_event_log_* properties instead of linux,sml-*
- Fix efi_tcg2.c compilation
- Select SHA* configs
Changes since v4:
- Remove tcg2_measure_event function and check for NULL data in tcg2_measure_data
- Use tpm_auto_startup
- Fix efi_tcg2.c compilation for removing tcg2_pcr_read function
Changes since v3:
- Reordered headers
- Refactored more of EFI code into common code
Removed digest_info structure and instead used the common alg_to_mask
and alg_to_len
Improved event log parsing in common code to get it equivalent to EFI
Common code now extends PCR if previous bootloader stage couldn't No need to allocate memory in the common code, so EFI copies the discovered buffer like it did before
Rename efi measure_event function
Changes since v1:
- Refactor TPM layer functions to allow EFI system to use them, and remove duplicate EFI functions.
include/efi_tcg2.h | 44 -- include/tpm-v2.h | 251 +++++++++ lib/Kconfig | 4 + lib/efi_loader/efi_tcg2.c | 1054 +++---------------------------------- lib/tpm-v2.c | 815 ++++++++++++++++++++++++++++ 5 files changed, 1147 insertions(+), 1021 deletions(-)
include/efi_tcg2.h +0 -44
@@ -129,50 +129,6 @@ struct efi_tcg2_boot_service_capability {#define BOOT_SERVICE_CAPABILITY_MIN \ offsetof(struct efi_tcg2_boot_service_capability, number_of_pcr_banks) -#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 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; - -/** -* 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; -/** * struct tdEFI_TCG2_FINAL_EVENTS_TABLE - log entries after Get Event Log * @version: version number for this structure
include/tpm-v2.h +251 -0
275 lines not on this page · raw message
lib/Kconfig +4 -0
@@ -411,6 +411,10 @@ config TPM bool "Trusted Platform Module (TPM) Support" depends on DM imply DM_RNG + select SHA1 + select SHA256 + select SHA384 + select SHA512 help This enables support for TPMs which can be used to provide security features for your board. The TPM can be connected via LPC or I2C
lib/efi_loader/efi_tcg2.c +77 -977
1,320 lines not on this page · raw message
lib/tpm-v2.c +815 -0
837 lines not on this page · raw message
Signature · 1 line
2.31.1
PATCH v8 4/6 bootm: Support boot measurement
In reply to Eddie JamesAdd a configuration option to measure the boot through the bootm function. Add the measurement state to the booti and bootz paths as well.
---
Changes since v6:
- Added comment for bootm_measure
- Fixed line length in bootm_measure
boot/Kconfig | 23 ++++++++++++++++ boot/bootm.c | 72 +++++++++++++++++++++++++++++++++++++++++++++++++ cmd/booti.c | 1 + cmd/bootm.c | 2 ++ cmd/bootz.c | 1 + include/bootm.h | 11 ++++++++ include/image.h | 1 + 7 files changed, 111 insertions(+)
boot/Kconfig +23 -0
@@ -629,6 +629,29 @@ config LEGACY_IMAGE_FORMAT loaded. If a board needs the legacy image format support in this case, enable it here. +config MEASURED_BOOT + bool "Measure boot images and configuration to TPM and event log" + depends on HASH && TPM_V2 + help + This option enables measurement of the boot process. Measurement + involves creating cryptographic hashes of the binary images that + are booting and storing them in the TPM. In addition, a log of + these hashes is stored in memory for the OS to verify the booted + images and configuration. Enable this if the OS has configured + some memory area for the event log and you intend to use some + attestation tools on your system. + +if MEASURED_BOOT + config MEASURE_DEVICETREE + bool "Measure the devicetree image" + default y if MEASURED_BOOT + help + On some platforms, the devicetree is not static as it may contain + random MAC addresses or other such data that changes each boot. + Therefore, it should not be measured into the TPM. In that case, + disable the measurement here. +endif # MEASURED_BOOT + config SUPPORT_RAW_INITRD bool "Enable raw initrd images" help
boot/bootm.c +72 -0
90 lines not on this page · raw message
cmd/booti.c +1 -0
@@ -127,6 +127,7 @@ int do_booti(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH BOOTM_STATE_RAMDISK | #endif +BOOTM_STATE_MEASURE |BOOTM_STATE_OS_PREP |BOOTM_STATE_OS_FAKE_GO |BOOTM_STATE_OS_GO , &images, 1);
cmd/bootm.c +2 -0
@@ -161,6 +161,8 @@ int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])BOOTM_STATE_OS_GO ;if (IS_ENABLED (CONFIG_SYS_BOOT_RAMDISK_HIGH )) states |=BOOTM_STATE_RAMDISK ; +if (IS_ENABLED (CONFIG_MEASURED_BOOT )) + states |=BOOTM_STATE_MEASURE ;if (IS_ENABLED (CONFIG_PPC ) ||IS_ENABLED (CONFIG_MIPS )) states |=BOOTM_STATE_OS_CMDLINE ; ret =do_bootm_states (cmdtp, flag, argc, argv, states, &images,1 );
cmd/bootz.c +1 -0
@@ -81,6 +81,7 @@ int do_bootz(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH BOOTM_STATE_RAMDISK | #endif +BOOTM_STATE_MEASURE |BOOTM_STATE_OS_PREP |BOOTM_STATE_OS_FAKE_GO |BOOTM_STATE_OS_GO , &images, 1);
include/bootm.h +11 -0
@@ -55,6 +55,17 @@ ulong bootm_disable_interrupts(void);int bootm_find_images (int flag,int argc,char *const argv[],ulong start,ulong size); +/* +* Measure the boot images. Measurement is the process of hashing some binary +* data and storing it into secure memory, i.e. TPM PCRs. In addition, each +* measurement is logged into the platform event log such that the operating +* system can access it and perform attestation of the boot. +* +* @images: The structure containing the various images to boot (linux, +* initrd, dts, etc.) +*/ +int bootm_measure (struct bootm_headers *images); +int do_bootm_states (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[],int states,struct bootm_headers *images,int boot_progress);
include/image.h +1 -0
@@ -407,6 +407,7 @@ struct bootm_headers {#define BOOTM_STATE_OS_FAKE_GO 0x00000200/* 'Almost' run the OS */ #define BOOTM_STATE_OS_GO 0x00000400#define BOOTM_STATE_PRE_LOAD 0x00000800 +#define BOOTM_STATE_MEASURE 0x00001000int state;#if defined(CONFIG_LMB ) && !defined(USE_HOSTCC )
Signature · 1 line
2.31.1
Re: [PATCH v8 4/6] bootm: Support boot measurement
Quoted 28 lines · Eddie James
Add a configuration option to measure the boot through the bootm function. Add the measurement state to the booti and bootz paths as well.
Signed-off-by Eddie James <[email protected]>Reviewed-by Simon Glass <[email protected]>---
Changes since v6:
- Added comment forbootm_measure
- Fixed line length inbootm_measureboot/Kconfig | 23 ++++++++++++++++ boot/bootm.c | 72 +++++++++++++++++++++++++++++++++++++++++++++++++ cmd/booti.c | 1 + cmd/bootm.c | 2 ++ cmd/bootz.c | 1 + include/bootm.h | 11 ++++++++ include/image.h | 1 + 7 files changed, 111 insertions(+)boot/Kconfig +0
-0@@ -629,6 +629,29 @@ config LEGACY_IMAGE_FORMAT loaded. If a board needs the legacy image format support in this case, enable it here.
boot/Kconfig config LEGACY_IMAGE_FORMAT · line 641
Quoted 10 lines
boot/Kconfig +10
-0+config MEASURED_BOOT + bool "Measure boot images and configuration to TPM and event log" + depends on HASH && TPM_V2 + help + This option enables measurement of the boot process. Measurement + involves creating cryptographic hashes of the binary images that + are booting and storing them in the TPM. In addition, a log of + these hashes is stored in memory for the OS to verify the booted + images and configuration. Enable this if the OS has configured + some memory area for the event log and you intend to use some
It cannot be the OS that configures the memory area for the measurement as we don't even know which OSes will be booted at configuration time. It must be the device-tree that defines if such a memory area exists and where it is located.
Some of the OSes booted by U-Boot may have a driver to read such a memory area. OSes lacking such a driver will ignore that memory area which does not stop them from booting.
boot/Kconfig config LEGACY_IMAGE_FORMAT · line 642
Quoted 1 line
boot/Kconfig +1
-0+ attestation tools on your system.
@Ilias:
This description does not make it clear that this setting does not enable measured boot for the EFI sub-system. We will need some follow up patch to point to the EFI relevant setting.
Best regards
Heinrich
Quoted 183 lines
boot/Kconfig +12
-0+ +if MEASURED_BOOT + config MEASURE_DEVICETREE + bool "Measure the devicetree image" + default y if MEASURED_BOOT + help + On some platforms, the devicetree is not static as it may contain + random MAC addresses or other such data that changes each boot. + Therefore, it should not be measured into the TPM. In that case, + disable the measurement here. +endif # MEASURED_BOOT + config SUPPORT_RAW_INITRD bool "Enable raw initrd images" helpboot/bootm.c +72
-0@@ -22,6 +22,7 @@#include <asm/global_data.h> #include <asm/io.h> #include <linux/sizes.h> +#include <tpm-v2.h> #if defined(CONFIG_CMD_USB )#include <usb.h> #endif @@ -659,6 +660,73 @@ int bootm_process_cmdline_env(int flags)return 0 ; } +int bootm_measure (struct bootm_headers *images) +{ +int ret =0 ; + +/* Skip measurement if EFI is going to do it */ +if (images->os.os ==IH_OS_EFI && +IS_ENABLED (CONFIG_EFI_TCG2_PROTOCOL ) && +IS_ENABLED (CONFIG_BOOTM_EFI )) +return ret; + +if (IS_ENABLED (CONFIG_MEASURED_BOOT )) { +struct tcg2_event_log elog; +struct udevice *dev; +void *initrd_buf; +void *image_buf; +const char *s; +u32 rd_len; + + elog.log_size =0 ; + ret =tcg2_measurement_init (&dev, &elog); +if (ret) +return ret; + + image_buf =map_sysmem (images->os.image_start, + images->os.image_len); + ret =tcg2_measure_data (dev, &elog,8 , images->os.image_len, + image_buf,EV_COMPACT_HASH , +strlen ("linux" ) +1 , (u8 *)"linux" ); +if (ret) + goto unmap_image; + + rd_len = images->rd_end - images->rd_start; + initrd_buf =map_sysmem (images->rd_start, rd_len); + ret =tcg2_measure_data (dev, &elog,9 , rd_len, initrd_buf, +EV_COMPACT_HASH ,strlen ("initrd" ) +1 , + (u8 *)"initrd" ); +if (ret) + goto unmap_initrd; + +if (IS_ENABLED (CONFIG_MEASURE_DEVICETREE )) { + ret =tcg2_measure_data (dev, &elog,0 , images->ft_len, + (u8 *)images->ft_addr, +EV_TABLE_OF_DEVICES , +strlen ("dts" ) +1 , + (u8 *)"dts" ); +if (ret) + goto unmap_initrd; + } + + s =env_get ("bootargs" ); +if (!s) + s ="" ; + ret =tcg2_measure_data (dev, &elog,1 ,strlen (s) +1 , (u8 *)s, +EV_PLATFORM_CONFIG_FLAGS , +strlen (s) +1 , (u8 *)s); + +unmap_initrd: +unmap_sysmem (initrd_buf); + +unmap_image: +unmap_sysmem (image_buf); +tcg2_measurement_term (dev, &elog, ret !=0 ); + } + +return ret; +} +/** * Execute selected states of the bootm command. * @@ -710,6 +778,10 @@ int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc,if (!ret && (states &BOOTM_STATE_FINDOTHER )) ret =bootm_find_other (cmdtp, flag, argc, argv); +if (IS_ENABLED (CONFIG_MEASURED_BOOT ) && !ret && + (states &BOOTM_STATE_MEASURE )) +bootm_measure (images); +/* Load the OS */ if (!ret && (states &BOOTM_STATE_LOADOS )) { iflag =bootm_disable_interrupts ();cmd/booti.c +1
-0@@ -127,6 +127,7 @@ int do_booti(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH BOOTM_STATE_RAMDISK | #endif +BOOTM_STATE_MEASURE |BOOTM_STATE_OS_PREP |BOOTM_STATE_OS_FAKE_GO |BOOTM_STATE_OS_GO , &images, 1);cmd/bootm.c +2
-0@@ -161,6 +161,8 @@ int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])BOOTM_STATE_OS_GO ;if (IS_ENABLED (CONFIG_SYS_BOOT_RAMDISK_HIGH )) states |=BOOTM_STATE_RAMDISK ; +if (IS_ENABLED (CONFIG_MEASURED_BOOT )) + states |=BOOTM_STATE_MEASURE ;if (IS_ENABLED (CONFIG_PPC ) ||IS_ENABLED (CONFIG_MIPS )) states |=BOOTM_STATE_OS_CMDLINE ; ret =do_bootm_states (cmdtp, flag, argc, argv, states, &images,1 );cmd/bootz.c +1
-0@@ -81,6 +81,7 @@ int do_bootz(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH BOOTM_STATE_RAMDISK | #endif +BOOTM_STATE_MEASURE |BOOTM_STATE_OS_PREP |BOOTM_STATE_OS_FAKE_GO |BOOTM_STATE_OS_GO , &images, 1);include/bootm.h +11
-0@@ -55,6 +55,17 @@ ulong bootm_disable_interrupts(void);int bootm_find_images (int flag,int argc,char *const argv[],ulong start,ulong size); +/* +* Measure the boot images. Measurement is the process of hashing some binary +* data and storing it into secure memory, i.e. TPM PCRs. In addition, each +* measurement is logged into the platform event log such that the operating +* system can access it and perform attestation of the boot. +* +* @images: The structure containing the various images to boot (linux, +* initrd, dts, etc.) +*/ +int bootm_measure (struct bootm_headers *images); +int do_bootm_states (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[],int states,struct bootm_headers *images,int boot_progress);include/image.h +1
-0@@ -407,6 +407,7 @@ struct bootm_headers {#define BOOTM_STATE_OS_FAKE_GO 0x00000200/* 'Almost' run the OS */ #define BOOTM_STATE_OS_GO 0x00000400#define BOOTM_STATE_PRE_LOAD 0x00000800 +#define BOOTM_STATE_MEASURE 0x00001000int state;#if defined(CONFIG_LMB ) && !defined(USE_HOSTCC )
PATCH v8 5/6 test: Add sandbox TPM boot measurement
In reply to Eddie JamesUse the sandbox TPM driver to measure some boot images in a unit test case.
---
Changes since v5:
- Only compile in the measurement u-boot command when CONFIG_MEASURED_BOOT is enabled
arch/sandbox/dts/sandbox.dtsi | 13 +++++++ arch/sandbox/dts/test.dts | 13 +++++++ configs/sandbox_defconfig | 1 + include/test/suites.h | 1 + test/boot/Makefile | 1 + test/boot/measurement.c | 66 +++++++++++++++++++++++++++++++++++ test/cmd_ut.c | 4 +++ 7 files changed, 99 insertions(+) create mode 100644 test/boot/measurement.c
arch/sandbox/dts/sandbox.dtsi +13 -0
@@ -4,11 +4,23 @@ * and sandbox64 builds. */ +#include <config.h> #include <dt-bindings/input/input.h> #define USB_CLASS_HUB 9 / { + reserved-memory { + #address-cells = <1>; + #size-cells = <1>; + ranges; + + event_log: tcg_event_log { + no-map; + reg = <(CFG_SYS_SDRAM_SIZE - 0x2000) 0x2000>; + }; + }; + binman { };
@@ -336,6 +348,7 @@ tpm2 { compatible = "sandbox,tpm2"; + memory-region = <&event_log>; }; triangle {
arch/sandbox/dts/test.dts +13 -0
@@ -9,6 +9,7 @@ /dts-v1/; +#include <config.h> #include <dt-bindings/gpio/gpio.h> #include <dt-bindings/gpio/sandbox-gpio.h> #include <dt-bindings/input/input.h>
@@ -66,6 +67,17 @@ osd0 = "/osd"; }; + reserved-memory { + #address-cells = <1>; + #size-cells = <1>; + ranges; + + event_log: tcg_event_log { + no-map; + reg = <(CFG_SYS_SDRAM_SIZE - 0x2000) 0x2000>; + }; + }; + binman: binman { };
@@ -1365,6 +1377,7 @@ tpm2 { compatible = "sandbox,tpm2"; + memory-region = <&event_log>; }; tpm {
configs/sandbox_defconfig +1 -0
@@ -335,3 +335,4 @@ CONFIG_TEST_FDTDEC=y CONFIG_UNIT_TEST=y CONFIG_UT_TIME=y CONFIG_UT_DM=y +CONFIG_MEASURED_BOOT=y
include/test/suites.h +1 -0
@@ -44,6 +44,7 @@ int do_ut_font(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);int do_ut_lib (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[]);int do_ut_loadm (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[]);int do_ut_log (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[]); +int do_ut_measurement (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[]);int do_ut_mem (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[]);int do_ut_optee (struct cmd_tbl *cmdtp,int flag,int argc,char *const argv[]); int do_ut_overlay(struct cmd_tbl *cmdtp, int flag, int argc,
test/boot/Makefile +1 -0
@@ -4,6 +4,7 @@ obj-$(CONFIG_BOOTSTD) += bootdev.o bootstd_common.o bootflow.o bootmeth.o obj-$(CONFIG_FIT) += image.o +obj-$(CONFIG_MEASURED_BOOT) += measurement.o obj-$(CONFIG_EXPO) += expo.o
test/boot/measurement.c new file +66 -0
66 lines not on this page · raw message
test/cmd_ut.c +4 -0
@@ -96,6 +96,10 @@ static struct cmd_tbl cmd_ut_sub[] = {#if CONFIG_IS_ENABLED (UT_UNICODE ) && !defined(API_BUILD ) U_BOOT_CMD_MKENT(unicode, CONFIG_SYS_MAXARGS, 1, do_ut_unicode, "", ""),#endif +#ifdef CONFIG_MEASURED_BOOT + U_BOOT_CMD_MKENT(measurement, CONFIG_SYS_MAXARGS, 1, do_ut_measurement, + "", ""), +#endif #ifdef CONFIG_SANDBOX U_BOOT_CMD_MKENT (compression,CONFIG_SYS_MAXARGS ,1 , do_ut_compression, "", ""),
Signature · 1 line
2.31.1
PATCH v8 6/6 doc: Add measured boot documentation
In reply to Eddie JamesBriefly describe the feature and specify the requirements.
--- doc/usage/index.rst | 1 + doc/usage/measured_boot.rst | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 doc/usage/measured_boot.rst
doc/usage/index.rst +1 -0
@@ -12,6 +12,7 @@ Use U-Boot partitions cmdline semihosting + measured_boot Shell commands --------------
doc/usage/measured_boot.rst new file +23 -0
@@ -0,0 +1,23 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Measured Boot +===================== + +U-Boot can perform a measured boot, the process of hashing various components +of the boot process, extending the results in the TPM and logging the +component's measurement in memory for the operating system to consume. + +Requirements +--------------------- + +* A hardware TPM 2.0 supported by the U-Boot drivers +* CONFIG_TPM=y +* CONFIG_MEASURED_BOOT=y +* Device-tree configuration of the TPM device to specify the memory area + for event logging. The TPM device node must either contain a phandle to + a reserved memory region or "linux,sml-base" and "linux,sml-size" + indicating the address and size of the memory region. An example can be + found in arch/sandbox/dts/test.dts +* The operating system must also be configured to use the memory regions + specified in the U-Boot device-tree in order to make use of the event + log.
Signature · 1 line
2.31.1
Re: [PATCH v8 6/6] doc: Add measured boot documentation
Quoted 28 lines · Eddie James
Briefly describe the feature and specify the requirements.
Signed-off-by Eddie James <[email protected]>Reviewed-by Simon Glass <[email protected]>--- doc/usage/index.rst | 1 + doc/usage/measured_boot.rst | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+)create mode 100644
doc/usage/measured_boot.rstdoc/usage/index.rst +1
-0@@ -12,6 +12,7 @@ Use U-Boot partitions cmdline semihosting + measured_boot Shell commands --------------doc/usage/measured_boot.rst new file +0
-0
doc/usage/measured_boot.rst line 6
Quoted 6 lines
doc/usage/measured_boot.rst new file +6
-0@@ -0,0 +1,23 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Measured Boot +===================== + +U-Boot can perform a measured boot, the process of hashing various components
This text is misleading: U-Boot does not perform measured boot.
U-Boot performing measured boot would imply that it checks if the incoming values of the PCRs match expected values. This is not what is done with this series.
U-Boot assists measured boot by extending PCRs and providing an event log.
Best regards
Heinrich
Quoted 17 lines
doc/usage/measured_boot.rst new file +17
-0+of the boot process, extending the results in the TPM and logging the +component's measurement in memory for the operating system to consume. + +Requirements +--------------------- + +* A hardware TPM 2.0 supported by the U-Boot drivers +* CONFIG_TPM=y +* CONFIG_MEASURED_BOOT=y +* Device-tree configuration of the TPM device to specify the memory area + for event logging. The TPM device node must either contain a phandle to + a reserved memory region or "linux,sml-base" and "linux,sml-size" + indicating the address and size of the memory region. An example can be + found in arch/sandbox/dts/test.dts +* The operating system must also be configured to use the memory regions + specified in the U-Boot device-tree in order to make use of the event + log.
Hi Eddie,
This has a few failures on the CI [0].
Please have a look and let me know if you can't understand the failures
[0] https://source.denx.de/u-boot/custodians/u-boot-tpm/-/pipelines/15471
Regards
/Ilias
Quoted 108 lines · Eddie James
This series adds support for measuring the boot images more generically than the existing EFI support. Several EFI functions have been moved to the TPM layer. The series includes optional measurement from the bootm command.
A new test case has been added for the bootm measurement to test the new path, and the sandbox TPM2 driver has been updated to support this use case.
This series is based on Ilias' auto-startup series and Simon's additions.Changes since v7:
- Change name oftcg2_init_logand add more documentation
- Add a check, when parsing the event log header, to ensure that the previous stage bootloader used all the active PCRs.
- Change name oftcg2_log_find_end
- Fix the greater than or equal to check to exit the log parsing
- Make surelog_positionis 0 if there is any error discovering the log
- Return errors parsing the log if the data is corrupt so that we don't end up with half a logChanges since v6:
- Added comment forbootm_measure
- Fixed line length inbootm_measure
- Added Linaro copyright for all the EFI moved code
- Changedtcg2_init_log(and by extension,tcg2_measurement_init) to copy any discovered event log to the user's log if passed in.Changes since v5:
- Re-ordered the patches to put the sandbox TPM driver patch second
- Remove unusedplatform_get_eventloginefi_tcg2.c
- First look for tpm_event_log_* properties instead of linux,sml-*
- Fixefi_tcg2.ccompilation
- Select SHA* configs
- Remove the !SANDBOX dependency for EFI TCG2
- Only compile in the measurement u-boot command whenCONFIG_MEASURED_BOOTis enabledChanges since v4:
- Removetcg2_measure_eventfunction and check for NULL data intcg2_measure_data
- Usetpm_auto_startup
- Fixefi_tcg2.ccompilation for removingtcg2_pcr_readfunction
- Change PCR indexes for initrd and dtb
- Drop u8 casting in measurement test
- Use bullets in documentationChanges since v3:
- Reordered headers
- Refactored more of EFI code into common code
Removeddigest_infostructure and instead used the commonalg_to_mask
andalg_to_len
Improved event log parsing in common code to get it equivalent to EFI
Common code now extends PCR if previous bootloader stage couldn't No need to allocate memory in the common code, so EFI copies the discovered buffer like it did before
Rename efimeasure_eventfunctionChanges since v2:
- Add documentation.
- Changed reserved memory address to the top of the RAM for sandbox dts.
- Add measure state to booti and bootz.
- Skip measurement for EFI images that should be measuredChanges since v1:
- Refactor TPM layer functions to allow EFI system to use them, and remove duplicate EFI functions.
- Add test case
- Drop #ifdefs for bootm
- Add devicetree measurement config option
- Update sandbox TPM driverEddie James (6):
tpm: Fix spelling fortpmu_haunion
tpm: sandbox: Update for needed TPM2 capabilities
tpm: Support boot measurements
bootm: Support boot measurement
test: Add sandbox TPM boot measurement
doc: Add measured boot documentationarch/sandbox/dts/sandbox.dtsi | 13 + arch/sandbox/dts/test.dts | 13 + boot/Kconfig | 23 + boot/bootm.c | 72 +++ cmd/booti.c | 1 + cmd/bootm.c | 2 + cmd/bootz.c | 1 + configs/sandbox_defconfig | 1 + doc/usage/index.rst | 1 + doc/usage/measured_boot.rst | 23 + drivers/tpm/tpm2_tis_sandbox.c | 100 ++- include/bootm.h | 11 + include/efi_tcg2.h | 44 -- include/image.h | 1 + include/test/suites.h | 1 + include/tpm-v2.h | 255 +++++++- lib/Kconfig | 4 + lib/efi_loader/Kconfig | 2 - lib/efi_loader/efi_tcg2.c | 1054 +++----------------------------- lib/tpm-v2.c | 815 ++++++++++++++++++++++++ test/boot/Makefile | 1 + test/boot/measurement.c | 66 ++ test/cmd_ut.c | 4 + 23 files changed, 1455 insertions(+), 1053 deletions(-) create mode 100644 doc/usage/measured_boot.rst create mode 100644 test/boot/measurement.c--
2.31.1
Quoted 4 lines · Ilias Apalodimas
Hi Eddie,
This has a few failures on the CI [0].
Please have a look and let me know if you can't understand the failures
Hi, I think I have fixed the sandbox ones for v9. I'm unsure about the EFI selftest one in qemu targets...
Thanks,
Eddie
Quoted 114 lines
[0] https://source.denx.de/u-boot/custodians/u-boot-tpm/-/pipelines/15471
Regards
/IliasQuoted 108 lines · Eddie James
This series adds support for measuring the boot images more generically than the existing EFI support. Several EFI functions have been moved to the TPM layer. The series includes optional measurement from the bootm command.
A new test case has been added for the bootm measurement to test the new path, and the sandbox TPM2 driver has been updated to support this use case.
This series is based on Ilias' auto-startup series and Simon's additions.Changes since v7:
- Change name oftcg2_init_logand add more documentation
- Add a check, when parsing the event log header, to ensure that the previous stage bootloader used all the active PCRs.
- Change name oftcg2_log_find_end
- Fix the greater than or equal to check to exit the log parsing
- Make surelog_positionis 0 if there is any error discovering the log
- Return errors parsing the log if the data is corrupt so that we don't end up with half a logChanges since v6:
- Added comment forbootm_measure
- Fixed line length inbootm_measure
- Added Linaro copyright for all the EFI moved code
- Changedtcg2_init_log(and by extension,tcg2_measurement_init) to copy any discovered event log to the user's log if passed in.Changes since v5:
- Re-ordered the patches to put the sandbox TPM driver patch second
- Remove unusedplatform_get_eventloginefi_tcg2.c
- First look for tpm_event_log_* properties instead of linux,sml-*
- Fixefi_tcg2.ccompilation
- Select SHA* configs
- Remove the !SANDBOX dependency for EFI TCG2
- Only compile in the measurement u-boot command whenCONFIG_MEASURED_BOOTis enabledChanges since v4:
- Removetcg2_measure_eventfunction and check for NULL data intcg2_measure_data
- Usetpm_auto_startup
- Fixefi_tcg2.ccompilation for removingtcg2_pcr_readfunction
- Change PCR indexes for initrd and dtb
- Drop u8 casting in measurement test
- Use bullets in documentationChanges since v3:
- Reordered headers
- Refactored more of EFI code into common code
Removeddigest_infostructure and instead used the commonalg_to_mask
andalg_to_len
Improved event log parsing in common code to get it equivalent to EFI
Common code now extends PCR if previous bootloader stage couldn't No need to allocate memory in the common code, so EFI copies the discovered buffer like it did before
Rename efimeasure_eventfunctionChanges since v2:
- Add documentation.
- Changed reserved memory address to the top of the RAM for sandbox dts.
- Add measure state to booti and bootz.
- Skip measurement for EFI images that should be measuredChanges since v1:
- Refactor TPM layer functions to allow EFI system to use them, and remove duplicate EFI functions.
- Add test case
- Drop #ifdefs for bootm
- Add devicetree measurement config option
- Update sandbox TPM driverEddie James (6):
tpm: Fix spelling fortpmu_haunion
tpm: sandbox: Update for needed TPM2 capabilities
tpm: Support boot measurements
bootm: Support boot measurement
test: Add sandbox TPM boot measurement
doc: Add measured boot documentationarch/sandbox/dts/sandbox.dtsi | 13 + arch/sandbox/dts/test.dts | 13 + boot/Kconfig | 23 + boot/bootm.c | 72 +++ cmd/booti.c | 1 + cmd/bootm.c | 2 + cmd/bootz.c | 1 + configs/sandbox_defconfig | 1 + doc/usage/index.rst | 1 + doc/usage/measured_boot.rst | 23 + drivers/tpm/tpm2_tis_sandbox.c | 100 ++- include/bootm.h | 11 + include/efi_tcg2.h | 44 -- include/image.h | 1 + include/test/suites.h | 1 + include/tpm-v2.h | 255 +++++++- lib/Kconfig | 4 + lib/efi_loader/Kconfig | 2 - lib/efi_loader/efi_tcg2.c | 1054 +++----------------------------- lib/tpm-v2.c | 815 ++++++++++++++++++++++++ test/boot/Makefile | 1 + test/boot/measurement.c | 66 ++ test/cmd_ut.c | 4 + 23 files changed, 1455 insertions(+), 1053 deletions(-)create mode 100644
doc/usage/measured_boot.rst
create mode 100644test/boot/measurement.c--
2.31.1