security/vboot: Make mrc_cache hash functions generic

We need to extend the functionality of the mrc_cache hash functions to
work for both recovery and normal mrc_cache data.  Updating the API of
these functions to pass in an index to identify the hash indices for
recovery and normal mode.

BUG=b:150502246
BRANCH=None
TEST=make sure memory training still works on nami

Change-Id: I9c0bb25eafc731ca9c7a95113ab940f55997fc0f
Signed-off-by: Shelley Chen <shchen@google.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/46432
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Furquan Shaikh <furquan@google.com>
This commit is contained in:
Shelley Chen 2020-10-16 13:15:59 -07:00 committed by Julius Werner
parent 1fed53f08a
commit a79803cf29
7 changed files with 78 additions and 61 deletions

View file

@ -10,6 +10,7 @@
#include <fmap.h> #include <fmap.h>
#include <ip_checksum.h> #include <ip_checksum.h>
#include <region_file.h> #include <region_file.h>
#include <security/vboot/antirollback.h>
#include <security/vboot/mrc_cache_hash_tpm.h> #include <security/vboot/mrc_cache_hash_tpm.h>
#include <security/vboot/vboot_common.h> #include <security/vboot/vboot_common.h>
#include <spi_flash.h> #include <spi_flash.h>
@ -179,6 +180,7 @@ static int mrc_data_valid(const struct mrc_metadata *md,
void *data, size_t data_size) void *data, size_t data_size)
{ {
uint16_t checksum; uint16_t checksum;
uint32_t hash_idx = MRC_REC_HASH_NV_INDEX;
if (md->data_size != data_size) if (md->data_size != data_size)
return -1; return -1;
@ -191,7 +193,7 @@ static int mrc_data_valid(const struct mrc_metadata *md,
return -1; return -1;
} }
if (CONFIG(MRC_SAVE_HASH_IN_TPM) && !mrc_cache_verify_hash(data, data_size)) if (CONFIG(MRC_SAVE_HASH_IN_TPM) && !mrc_cache_verify_hash(hash_idx, data, data_size))
return -1; return -1;
return 0; return 0;
@ -393,6 +395,7 @@ static void update_mrc_cache_by_type(int type,
const struct region_device *backing_rdev; const struct region_device *backing_rdev;
struct region_device latest_rdev; struct region_device latest_rdev;
const bool fail_bad_data = false; const bool fail_bad_data = false;
uint32_t hash_idx = MRC_REC_HASH_NV_INDEX;
cr = lookup_region(&region, type); cr = lookup_region(&region, type);
@ -453,7 +456,7 @@ static void update_mrc_cache_by_type(int type,
printk(BIOS_DEBUG, "MRC: updated '%s'.\n", cr->name); printk(BIOS_DEBUG, "MRC: updated '%s'.\n", cr->name);
log_event_cache_update(cr->elog_slot, UPDATE_SUCCESS); log_event_cache_update(cr->elog_slot, UPDATE_SUCCESS);
if (CONFIG(MRC_SAVE_HASH_IN_TPM)) if (CONFIG(MRC_SAVE_HASH_IN_TPM))
mrc_cache_update_hash(new_data, new_data_size); mrc_cache_update_hash(hash_idx, new_data, new_data_size);
} }
} }

View file

@ -22,8 +22,9 @@ enum vb2_pcr_digest;
* want to use 0x1009 for something else. */ * want to use 0x1009 for something else. */
#define BACKUP_NV_INDEX 0x1009 #define BACKUP_NV_INDEX 0x1009
#define FWMP_NV_INDEX 0x100a #define FWMP_NV_INDEX 0x100a
#define REC_HASH_NV_INDEX 0x100b /* 0x100b: Hash of MRC_CACHE training data for recovery boot */
#define REC_HASH_NV_SIZE VB2_SHA256_DIGEST_SIZE #define MRC_REC_HASH_NV_INDEX 0x100b
#define HASH_NV_SIZE VB2_SHA256_DIGEST_SIZE
/* Structure definitions for TPM spaces */ /* Structure definitions for TPM spaces */
@ -55,11 +56,25 @@ uint32_t antirollback_write_space_kernel(struct vb2_context *ctx);
*/ */
uint32_t antirollback_lock_space_firmware(void); uint32_t antirollback_lock_space_firmware(void);
/* Read recovery hash data from TPM. */ /*
uint32_t antirollback_read_space_rec_hash(uint8_t *data, uint32_t size); * Read recovery hash data from TPM.
/* Write new hash data to recovery space in TPM. */ * @param index index into TPM NVRAM where hash is stored
uint32_t antirollback_write_space_rec_hash(const uint8_t *data, uint32_t size); * @param data pointer to buffer where hash from TPM read into
/* Lock down recovery hash space in TPM. */ * @param size size of buffer
uint32_t antirollback_lock_space_rec_hash(void); */
uint32_t antirollback_read_space_mrc_hash(uint32_t index, uint8_t *data, uint32_t size);
/*
* Write new hash data to recovery space in TPM.\
* @param index index into TPM NVRAM where hash is stored
* @param data pointer to buffer of hash value to be written
* @param size size of buffer
*/
uint32_t antirollback_write_space_mrc_hash(uint32_t index, const uint8_t *data,
uint32_t size);
/*
* Lock down recovery hash space in TPM.
* @param index index into TPM NVRAM where hash is stored
*/
uint32_t antirollback_lock_space_mrc_hash(uint32_t index);
#endif /* ANTIROLLBACK_H_ */ #endif /* ANTIROLLBACK_H_ */

View file

@ -9,7 +9,7 @@
#include <console/console.h> #include <console/console.h>
#include <string.h> #include <string.h>
void mrc_cache_update_hash(const uint8_t *data, size_t size) void mrc_cache_update_hash(uint32_t index, const uint8_t *data, size_t size)
{ {
uint8_t data_hash[VB2_SHA256_DIGEST_SIZE]; uint8_t data_hash[VB2_SHA256_DIGEST_SIZE];
static const uint8_t dead_hash[VB2_SHA256_DIGEST_SIZE] = { static const uint8_t dead_hash[VB2_SHA256_DIGEST_SIZE] = {
@ -40,26 +40,26 @@ void mrc_cache_update_hash(const uint8_t *data, size_t size)
printk(BIOS_ERR, "MRC: SHA-256 calculation failed for data. " printk(BIOS_ERR, "MRC: SHA-256 calculation failed for data. "
"Not updating TPM hash space.\n"); "Not updating TPM hash space.\n");
/* /*
* Since data is being updated in recovery cache, the hash * Since data is being updated in mrc cache, the hash
* currently stored in TPM recovery hash space is no longer * currently stored in TPM hash space is no longer
* valid. If we are not able to calculate hash of the data being * valid. If we are not able to calculate hash of the
* updated, reset all the bits in TPM recovery hash space to * data being updated, reset all the bits in TPM hash
* pre-defined hash pattern. * space to pre-defined hash pattern.
*/ */
hash_ptr = dead_hash; hash_ptr = dead_hash;
} }
/* Write hash of data to TPM space. */ /* Write hash of data to TPM space. */
if (antirollback_write_space_rec_hash(hash_ptr, VB2_SHA256_DIGEST_SIZE) if (antirollback_write_space_mrc_hash(index, hash_ptr, VB2_SHA256_DIGEST_SIZE)
!= TPM_SUCCESS) { != TPM_SUCCESS) {
printk(BIOS_ERR, "MRC: Could not save hash to TPM.\n"); printk(BIOS_ERR, "MRC: Could not save hash to TPM.\n");
return; return;
} }
printk(BIOS_INFO, "MRC: TPM MRC hash updated successfully.\n"); printk(BIOS_INFO, "MRC: TPM MRC hash idx 0x%x updated successfully.\n", index);
} }
int mrc_cache_verify_hash(const uint8_t *data, size_t size) int mrc_cache_verify_hash(uint32_t index, const uint8_t *data, size_t size)
{ {
uint8_t data_hash[VB2_SHA256_DIGEST_SIZE]; uint8_t data_hash[VB2_SHA256_DIGEST_SIZE];
uint8_t tpm_hash[VB2_SHA256_DIGEST_SIZE]; uint8_t tpm_hash[VB2_SHA256_DIGEST_SIZE];
@ -68,7 +68,7 @@ int mrc_cache_verify_hash(const uint8_t *data, size_t size)
if (!vboot_recovery_mode_enabled()) if (!vboot_recovery_mode_enabled())
return 1; return 1;
/* Calculate hash of data read from RECOVERY_MRC_CACHE. */ /* Calculate hash of data read from MRC_CACHE. */
if (vb2_digest_buffer(data, size, VB2_HASH_SHA256, data_hash, if (vb2_digest_buffer(data, size, VB2_HASH_SHA256, data_hash,
sizeof(data_hash))) { sizeof(data_hash))) {
printk(BIOS_ERR, "MRC: SHA-256 calculation failed for data.\n"); printk(BIOS_ERR, "MRC: SHA-256 calculation failed for data.\n");
@ -82,7 +82,7 @@ int mrc_cache_verify_hash(const uint8_t *data, size_t size)
} }
/* Read hash of MRC data saved in TPM. */ /* Read hash of MRC data saved in TPM. */
if (antirollback_read_space_rec_hash(tpm_hash, sizeof(tpm_hash)) if (antirollback_read_space_mrc_hash(index, tpm_hash, sizeof(tpm_hash))
!= TPM_SUCCESS) { != TPM_SUCCESS) {
printk(BIOS_ERR, "MRC: Could not read hash from TPM.\n"); printk(BIOS_ERR, "MRC: Could not read hash from TPM.\n");
return 0; return 0;
@ -93,7 +93,7 @@ int mrc_cache_verify_hash(const uint8_t *data, size_t size)
return 0; return 0;
} }
printk(BIOS_INFO, "MRC: Hash comparison successful. " printk(BIOS_INFO, "MRC: Hash idx 0x%x comparison successful.\n", index);
"Using data from RECOVERY_MRC_CACHE\n");
return 1; return 1;
} }

View file

@ -8,12 +8,12 @@
/* /*
* Updates mrc cache hash if it differs. * Updates mrc cache hash if it differs.
*/ */
void mrc_cache_update_hash(const uint8_t *data, size_t size); void mrc_cache_update_hash(uint32_t index, const uint8_t *data, size_t size);
/* /*
* Verifies mrc cache hash which is stored somewhere. * Verifies mrc cache hash which is stored somewhere.
* return 1 verification was successful and 0 for error. * return 1 verification was successful and 0 for error.
*/ */
int mrc_cache_verify_hash(const uint8_t *data, size_t size); int mrc_cache_verify_hash(uint32_t index, const uint8_t *data, size_t size);
#endif /* _MRC_CACHE_HASH_TPM_H_ */ #endif /* _MRC_CACHE_HASH_TPM_H_ */

View file

@ -42,17 +42,17 @@ vb2_error_t antirollback_lock_space_firmware(void)
return VB2_SUCCESS; return VB2_SUCCESS;
} }
vb2_error_t antirollback_lock_space_rec_hash(void) vb2_error_t antirollback_lock_space_mrc_hash(uint32_t index)
{ {
return VB2_SUCCESS; return VB2_SUCCESS;
} }
vb2_error_t antirollback_read_space_rec_hash(uint8_t *data, uint32_t size) vb2_error_t antirollback_read_space_mrc_hash(uint32_t index, uint8_t *data, uint32_t size)
{ {
return VB2_SUCCESS; return VB2_SUCCESS;
} }
vb2_error_t antirollback_write_space_rec_hash(const uint8_t *data, vb2_error_t antirollback_write_space_mrc_hash(uint32_t index, const uint8_t *data,
uint32_t size) uint32_t size)
{ {
return VB2_SUCCESS; return VB2_SUCCESS;

View file

@ -71,10 +71,10 @@ uint32_t antirollback_read_space_kernel(struct vb2_context *ctx)
return TPM_SUCCESS; return TPM_SUCCESS;
} }
static uint32_t read_space_rec_hash(uint8_t *data) static uint32_t read_space_mrc_hash(uint32_t index, uint8_t *data)
{ {
RETURN_ON_FAILURE(tlcl_read(REC_HASH_NV_INDEX, data, RETURN_ON_FAILURE(tlcl_read(index, data,
REC_HASH_NV_SIZE)); HASH_NV_SIZE));
return TPM_SUCCESS; return TPM_SUCCESS;
} }
@ -83,7 +83,7 @@ static uint32_t read_space_rec_hash(uint8_t *data)
* it. Since there is no data available to calculate hash at the point where TPM * it. Since there is no data available to calculate hash at the point where TPM
* space is defined, initialize it to all 0s. * space is defined, initialize it to all 0s.
*/ */
static const uint8_t rec_hash_data[REC_HASH_NV_SIZE] = { }; static const uint8_t mrc_hash_data[HASH_NV_SIZE] = { };
#if CONFIG(TPM2) #if CONFIG(TPM2)
/* /*
@ -162,10 +162,9 @@ static uint32_t set_kernel_space(const void *kernel_blob)
VB2_SECDATA_KERNEL_SIZE, rw_space_attributes, NULL, 0); VB2_SECDATA_KERNEL_SIZE, rw_space_attributes, NULL, 0);
} }
static uint32_t set_rec_hash_space(const uint8_t *data) static uint32_t set_mrc_hash_space(uint32_t index, const uint8_t *data)
{ {
return set_space("MRC Hash", REC_HASH_NV_INDEX, data, return set_space("MRC Hash", index, data, HASH_NV_SIZE,
REC_HASH_NV_SIZE,
ro_space_attributes, pcr0_unchanged_policy, ro_space_attributes, pcr0_unchanged_policy,
sizeof(pcr0_unchanged_policy)); sizeof(pcr0_unchanged_policy));
} }
@ -185,7 +184,7 @@ static uint32_t _factory_initialize_tpm(struct vb2_context *ctx)
RETURN_ON_FAILURE(set_kernel_space(ctx->secdata_kernel)); RETURN_ON_FAILURE(set_kernel_space(ctx->secdata_kernel));
if (CONFIG(VBOOT_HAS_REC_HASH_SPACE)) if (CONFIG(VBOOT_HAS_REC_HASH_SPACE))
RETURN_ON_FAILURE(set_rec_hash_space(rec_hash_data)); RETURN_ON_FAILURE(set_mrc_hash_space(MRC_REC_HASH_NV_INDEX, mrc_hash_data));
RETURN_ON_FAILURE(set_firmware_space(ctx->secdata_firmware)); RETURN_ON_FAILURE(set_firmware_space(ctx->secdata_firmware));
@ -197,9 +196,9 @@ uint32_t antirollback_lock_space_firmware(void)
return tlcl_lock_nv_write(FIRMWARE_NV_INDEX); return tlcl_lock_nv_write(FIRMWARE_NV_INDEX);
} }
uint32_t antirollback_lock_space_rec_hash(void) uint32_t antirollback_lock_space_mrc_hash(uint32_t index)
{ {
return tlcl_lock_nv_write(REC_HASH_NV_INDEX); return tlcl_lock_nv_write(index);
} }
#else #else
@ -239,14 +238,14 @@ static uint32_t safe_define_space(uint32_t index, uint32_t perm, uint32_t size)
} }
} }
static uint32_t set_rec_hash_space(const uint8_t *data) static uint32_t set_mrc_hash_space(uint32_t index, const uint8_t *data)
{ {
RETURN_ON_FAILURE(safe_define_space(REC_HASH_NV_INDEX, RETURN_ON_FAILURE(safe_define_space(index,
TPM_NV_PER_GLOBALLOCK | TPM_NV_PER_GLOBALLOCK |
TPM_NV_PER_PPWRITE, TPM_NV_PER_PPWRITE,
REC_HASH_NV_SIZE)); HASH_NV_SIZE));
RETURN_ON_FAILURE(safe_write(REC_HASH_NV_INDEX, data, RETURN_ON_FAILURE(safe_write(index, data,
REC_HASH_NV_SIZE)); HASH_NV_SIZE));
return TPM_SUCCESS; return TPM_SUCCESS;
} }
@ -307,7 +306,7 @@ static uint32_t _factory_initialize_tpm(struct vb2_context *ctx)
/* Define and set rec hash space, if available. */ /* Define and set rec hash space, if available. */
if (CONFIG(VBOOT_HAS_REC_HASH_SPACE)) if (CONFIG(VBOOT_HAS_REC_HASH_SPACE))
RETURN_ON_FAILURE(set_rec_hash_space(rec_hash_data)); RETURN_ON_FAILURE(set_mrc_hash_space(MRC_REC_HASH_NV_INDEX, mrc_hash_data));
return TPM_SUCCESS; return TPM_SUCCESS;
} }
@ -317,7 +316,7 @@ uint32_t antirollback_lock_space_firmware(void)
return tlcl_set_global_lock(); return tlcl_set_global_lock();
} }
uint32_t antirollback_lock_space_rec_hash(void) uint32_t antirollback_lock_space_mrc_hash(uint32_t index)
{ {
/* /*
* Nothing needs to be done here, since global lock is already set while * Nothing needs to be done here, since global lock is already set while
@ -417,43 +416,43 @@ uint32_t antirollback_write_space_kernel(struct vb2_context *ctx)
return safe_write(KERNEL_NV_INDEX, ctx->secdata_kernel, size); return safe_write(KERNEL_NV_INDEX, ctx->secdata_kernel, size);
} }
uint32_t antirollback_read_space_rec_hash(uint8_t *data, uint32_t size) uint32_t antirollback_read_space_mrc_hash(uint32_t index, uint8_t *data, uint32_t size)
{ {
if (size != REC_HASH_NV_SIZE) { if (size != HASH_NV_SIZE) {
VBDEBUG("TPM: Incorrect buffer size for rec hash. " VBDEBUG("TPM: Incorrect buffer size for hash idx 0x%x. "
"(Expected=0x%x Actual=0x%x).\n", REC_HASH_NV_SIZE, "(Expected=0x%x Actual=0x%x).\n", index, HASH_NV_SIZE,
size); size);
return TPM_E_READ_FAILURE; return TPM_E_READ_FAILURE;
} }
return read_space_rec_hash(data); return read_space_mrc_hash(index, data);
} }
uint32_t antirollback_write_space_rec_hash(const uint8_t *data, uint32_t size) uint32_t antirollback_write_space_mrc_hash(uint32_t index, const uint8_t *data, uint32_t size)
{ {
uint8_t spc_data[REC_HASH_NV_SIZE]; uint8_t spc_data[HASH_NV_SIZE];
uint32_t rv; uint32_t rv;
if (size != REC_HASH_NV_SIZE) { if (size != HASH_NV_SIZE) {
VBDEBUG("TPM: Incorrect buffer size for rec hash. " VBDEBUG("TPM: Incorrect buffer size for hash idx 0x%x. "
"(Expected=0x%x Actual=0x%x).\n", REC_HASH_NV_SIZE, "(Expected=0x%x Actual=0x%x).\n", index, HASH_NV_SIZE,
size); size);
return TPM_E_WRITE_FAILURE; return TPM_E_WRITE_FAILURE;
} }
rv = read_space_rec_hash(spc_data); rv = read_space_mrc_hash(index, spc_data);
if (rv == TPM_E_BADINDEX) { if (rv == TPM_E_BADINDEX) {
/* /*
* If space is not defined already for recovery hash, define * If space is not defined already for hash, define
* new space. * new space.
*/ */
VBDEBUG("TPM: Initializing recovery hash space.\n"); VBDEBUG("TPM: Initializing hash space.\n");
return set_rec_hash_space(data); return set_mrc_hash_space(index, data);
} }
if (rv != TPM_SUCCESS) if (rv != TPM_SUCCESS)
return rv; return rv;
return safe_write(REC_HASH_NV_INDEX, data, size); return safe_write(index, data, size);
} }
vb2_error_t vb2ex_tpm_clear_owner(struct vb2_context *ctx) vb2_error_t vb2ex_tpm_clear_owner(struct vb2_context *ctx)

View file

@ -404,7 +404,7 @@ void verstage_main(void)
/* Lock rec hash space if available. */ /* Lock rec hash space if available. */
if (CONFIG(VBOOT_HAS_REC_HASH_SPACE)) { if (CONFIG(VBOOT_HAS_REC_HASH_SPACE)) {
rv = antirollback_lock_space_rec_hash(); rv = antirollback_lock_space_mrc_hash(MRC_REC_HASH_NV_INDEX);
if (rv) { if (rv) {
printk(BIOS_INFO, "Failed to lock rec hash space(%x)\n", printk(BIOS_INFO, "Failed to lock rec hash space(%x)\n",
rv); rv);