vboot2: Move old struct handling to lib20/
This is part 4 of a series of changes to rearrange the vboot2 library
so that it's possible to start using the new-style data structs. This
change moves knowledge of the old vboot1 data structs into lib20; 2lib
now contains only code which is common to both vboot2.x libraries
(that is, code which is data structure version agnostic).
No functional changes; just rearranging code and tests.
BUG=chromium:423882
BRANCH=none
TEST=make runtests && VBOOT2=1 make runtests (works with/withoug VBOOT2 flag)
And compile firmware for veyron_pinky
CQ-DEPEND=CL:233051
Change-Id: I8f9e67157575e5be14952ef4809c3dfafd92596d
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/233021
Reviewed-by: Bill Richardson <wfrichar@chromium.org>
diff --git a/tests/vb20_misc_tests.c b/tests/vb20_misc_tests.c
new file mode 100644
index 0000000..aa602ac
--- /dev/null
+++ b/tests/vb20_misc_tests.c
@@ -0,0 +1,377 @@
+/* Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ *
+ * Tests for misc library
+ */
+
+#include <stdio.h>
+
+#include "2sysincludes.h"
+#include "2api.h"
+#include "2common.h"
+#include "2misc.h"
+#include "2nvstorage.h"
+#include "2secdata.h"
+#include "vb2_common.h"
+#include "test_common.h"
+
+/* Common context for tests */
+static uint8_t workbuf[VB2_WORKBUF_RECOMMENDED_SIZE]
+ __attribute__ ((aligned (16)));
+static struct vb2_context cc;
+static struct vb2_shared_data *sd;
+
+/* Mocked function data */
+
+static struct {
+ struct vb2_gbb_header h;
+ struct vb2_packed_key rootkey;
+ char rootkey_data[32];
+} mock_gbb;
+
+static struct {
+ /* Keyblock */
+ struct {
+ struct vb2_keyblock kb;
+ char data_key_data[16];
+ uint8_t kbdata[128];
+ } k;
+ /* Preamble follows keyblock */
+ struct {
+ struct vb2_fw_preamble pre;
+ uint8_t predata[128];
+ } p;
+
+} mock_vblock;
+
+static int mock_read_res_fail_on_call;
+static int mock_unpack_key_retval;
+static int mock_verify_keyblock_retval;
+static int mock_verify_preamble_retval;
+
+/* Type of test to reset for */
+enum reset_type {
+ FOR_KEYBLOCK,
+ FOR_PREAMBLE
+};
+
+static void reset_common_data(enum reset_type t)
+{
+ struct vb2_keyblock *kb = &mock_vblock.k.kb;
+ struct vb2_fw_preamble *pre = &mock_vblock.p.pre;
+
+ memset(workbuf, 0xaa, sizeof(workbuf));
+
+ memset(&cc, 0, sizeof(cc));
+ cc.workbuf = workbuf;
+ cc.workbuf_size = sizeof(workbuf);
+
+ vb2_init_context(&cc);
+ sd = vb2_get_sd(&cc);
+
+ vb2_nv_init(&cc);
+
+ vb2_secdata_create(&cc);
+ vb2_secdata_init(&cc);
+
+ mock_read_res_fail_on_call = 0;
+ mock_unpack_key_retval = VB2_SUCCESS;
+ mock_verify_keyblock_retval = VB2_SUCCESS;
+ mock_verify_preamble_retval = VB2_SUCCESS;
+
+ /* Set up mock data for verifying keyblock */
+ vb2_secdata_set(&cc, VB2_SECDATA_VERSIONS, 0x20002);
+
+ sd->gbb_rootkey_offset = vb2_offset_of(&mock_gbb, &mock_gbb.rootkey);
+ sd->gbb_rootkey_size = sizeof(mock_gbb.rootkey_data);
+ sd->last_fw_result = VB2_FW_RESULT_SUCCESS;
+
+ mock_gbb.rootkey.algorithm = 11;
+ mock_gbb.rootkey.key_offset =
+ vb2_offset_of(&mock_gbb.rootkey,
+ &mock_gbb.rootkey_data);
+ mock_gbb.rootkey.key_size = sizeof(mock_gbb.rootkey_data);
+
+ kb->keyblock_size = sizeof(mock_vblock.k);
+ kb->data_key.algorithm = 7;
+ kb->data_key.key_version = 2;
+ kb->data_key.key_offset =
+ vb2_offset_of(&mock_vblock.k, &mock_vblock.k.data_key_data) -
+ vb2_offset_of(&mock_vblock.k, &kb->data_key);
+ kb->data_key.key_size = sizeof(mock_vblock.k.data_key_data);
+ strcpy(mock_vblock.k.data_key_data, "data key data!!");
+
+ pre->preamble_size = sizeof(mock_vblock.p);
+ pre->firmware_version = 2;
+
+ /* If verifying preamble, verify keyblock first to set up data key */
+ if (t == FOR_PREAMBLE)
+ vb2_load_fw_keyblock(&cc);
+};
+
+/* Mocked functions */
+
+int vb2ex_read_resource(struct vb2_context *ctx,
+ enum vb2_resource_index index,
+ uint32_t offset,
+ void *buf,
+ uint32_t size)
+{
+ uint8_t *rptr;
+ uint32_t rsize;
+
+ if (--mock_read_res_fail_on_call == 0)
+ return VB2_ERROR_EX_READ_RESOURCE_INDEX;
+
+ switch(index) {
+ case VB2_RES_GBB:
+ rptr = (uint8_t *)&mock_gbb;
+ rsize = sizeof(mock_gbb);
+ break;
+ case VB2_RES_FW_VBLOCK:
+ rptr = (uint8_t *)&mock_vblock;
+ rsize = sizeof(mock_vblock);
+ break;
+ default:
+ return VB2_ERROR_EX_READ_RESOURCE_INDEX;
+ }
+
+ if (offset > rsize || offset + size > rsize)
+ return VB2_ERROR_EX_READ_RESOURCE_SIZE;
+
+ memcpy(buf, rptr + offset, size);
+ return VB2_SUCCESS;
+}
+
+int vb2_unpack_key(struct vb2_public_key *key,
+ const uint8_t *buf,
+ uint32_t size)
+{
+ return mock_unpack_key_retval;
+}
+
+int vb2_verify_keyblock(struct vb2_keyblock *block,
+ uint32_t size,
+ const struct vb2_public_key *key,
+ const struct vb2_workbuf *wb)
+{
+ return mock_verify_keyblock_retval;
+}
+
+int vb2_verify_fw_preamble(struct vb2_fw_preamble *preamble,
+ uint32_t size,
+ const struct vb2_public_key *key,
+ const struct vb2_workbuf *wb)
+{
+ return mock_verify_preamble_retval;
+}
+
+/* Tests */
+
+static void verify_keyblock_tests(void)
+{
+ struct vb2_keyblock *kb = &mock_vblock.k.kb;
+ struct vb2_packed_key *k;
+ int wb_used_before;
+
+ /* Test successful call */
+ reset_common_data(FOR_KEYBLOCK);
+ wb_used_before = cc.workbuf_used;
+ TEST_SUCC(vb2_load_fw_keyblock(&cc), "keyblock verify");
+ TEST_EQ(sd->fw_version, 0x20000, "keyblock version");
+ TEST_EQ(sd->vblock_preamble_offset, sizeof(mock_vblock.k),
+ "preamble offset");
+ TEST_EQ(sd->workbuf_data_key_offset,
+ (wb_used_before + (VB2_WORKBUF_ALIGN - 1)) &
+ ~(VB2_WORKBUF_ALIGN - 1),
+ "keyblock data key offset");
+ TEST_EQ(cc.workbuf_used,
+ sd->workbuf_data_key_offset + sd->workbuf_data_key_size,
+ "workbuf used");
+
+ /* Make sure data key was properly saved */
+ k = (struct vb2_packed_key *)(cc.workbuf + sd->workbuf_data_key_offset);
+ TEST_EQ(k->algorithm, 7, "data key algorithm");
+ TEST_EQ(k->key_version, 2, "data key version");
+ TEST_EQ(k->key_size, sizeof(mock_vblock.k.data_key_data),
+ "data key size");
+ TEST_EQ(memcmp(cc.workbuf + sd->workbuf_data_key_offset +
+ k->key_offset, mock_vblock.k.data_key_data,
+ sizeof(mock_vblock.k.data_key_data)),
+ 0, "data key data");
+ TEST_EQ(cc.workbuf_used,
+ sd->workbuf_data_key_offset + sd->workbuf_data_key_size,
+ "workbuf used after");
+
+ /* Test failures */
+ reset_common_data(FOR_KEYBLOCK);
+ cc.workbuf_used = cc.workbuf_size - sd->gbb_rootkey_size + 8;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_FW_KEYBLOCK_WORKBUF_ROOT_KEY,
+ "keyblock not enough workbuf for root key");
+
+ reset_common_data(FOR_KEYBLOCK);
+ sd->gbb_rootkey_size = sizeof(mock_gbb);
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_EX_READ_RESOURCE_SIZE,
+ "keyblock read root key");
+
+ reset_common_data(FOR_KEYBLOCK);
+ mock_unpack_key_retval = VB2_ERROR_UNPACK_KEY_SIG_ALGORITHM;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_UNPACK_KEY_SIG_ALGORITHM,
+ "keyblock unpack root key");
+
+ reset_common_data(FOR_KEYBLOCK);
+ cc.workbuf_used = cc.workbuf_size - sd->gbb_rootkey_size - 8;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_FW_KEYBLOCK_WORKBUF_HEADER,
+ "keyblock not enough workbuf for header");
+
+ reset_common_data(FOR_KEYBLOCK);
+ mock_read_res_fail_on_call = 2;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_EX_READ_RESOURCE_INDEX,
+ "keyblock read keyblock header");
+
+ reset_common_data(FOR_KEYBLOCK);
+ cc.workbuf_used = cc.workbuf_size - sd->gbb_rootkey_size
+ - sizeof(struct vb2_keyblock);
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_FW_KEYBLOCK_WORKBUF,
+ "keyblock not enough workbuf for entire keyblock");
+
+ reset_common_data(FOR_KEYBLOCK);
+ kb->keyblock_size = sizeof(mock_vblock) + 1;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_EX_READ_RESOURCE_SIZE,
+ "keyblock read keyblock");
+
+ reset_common_data(FOR_KEYBLOCK);
+ mock_verify_keyblock_retval = VB2_ERROR_KEYBLOCK_MAGIC;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_KEYBLOCK_MAGIC,
+ "keyblock verify keyblock");
+
+ reset_common_data(FOR_KEYBLOCK);
+ kb->data_key.key_version = 0x10000;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_FW_KEYBLOCK_VERSION_RANGE,
+ "keyblock version range");
+
+ reset_common_data(FOR_KEYBLOCK);
+ kb->data_key.key_version = 1;
+ TEST_EQ(vb2_load_fw_keyblock(&cc),
+ VB2_ERROR_FW_KEYBLOCK_VERSION_ROLLBACK,
+ "keyblock rollback");
+}
+
+static void verify_preamble_tests(void)
+{
+ struct vb2_fw_preamble *pre = &mock_vblock.p.pre;
+ int wb_used_before;
+ uint32_t v;
+
+ /* Test successful call */
+ reset_common_data(FOR_PREAMBLE);
+ wb_used_before = cc.workbuf_used;
+ TEST_SUCC(vb2_load_fw_preamble(&cc), "preamble good");
+ TEST_EQ(sd->fw_version, 0x20002, "combined version");
+ TEST_EQ(sd->workbuf_preamble_offset,
+ (wb_used_before + (VB2_WORKBUF_ALIGN - 1)) &
+ ~(VB2_WORKBUF_ALIGN - 1),
+ "preamble offset");
+ TEST_EQ(sd->workbuf_preamble_size, pre->preamble_size, "preamble size");
+ TEST_EQ(cc.workbuf_used,
+ sd->workbuf_preamble_offset + sd->workbuf_preamble_size,
+ "workbuf used");
+
+ /* Expected failures */
+ reset_common_data(FOR_PREAMBLE);
+ sd->workbuf_data_key_size = 0;
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_FW_PREAMBLE2_DATA_KEY,
+ "preamble no data key");
+
+ reset_common_data(FOR_PREAMBLE);
+ mock_unpack_key_retval = VB2_ERROR_UNPACK_KEY_HASH_ALGORITHM;
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_UNPACK_KEY_HASH_ALGORITHM,
+ "preamble unpack data key");
+
+ reset_common_data(FOR_PREAMBLE);
+ cc.workbuf_used = cc.workbuf_size - sizeof(struct vb2_fw_preamble) + 8;
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_FW_PREAMBLE2_WORKBUF_HEADER,
+ "preamble not enough workbuf for header");
+
+ reset_common_data(FOR_PREAMBLE);
+ sd->vblock_preamble_offset = sizeof(mock_vblock);
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_EX_READ_RESOURCE_SIZE,
+ "preamble read header");
+
+ reset_common_data(FOR_PREAMBLE);
+ cc.workbuf_used = cc.workbuf_size - sizeof(mock_vblock.p) + 8;
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_FW_PREAMBLE2_WORKBUF,
+ "preamble not enough workbuf");
+
+ reset_common_data(FOR_PREAMBLE);
+ pre->preamble_size = sizeof(mock_vblock);
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_EX_READ_RESOURCE_SIZE,
+ "preamble read full");
+
+ reset_common_data(FOR_PREAMBLE);
+ mock_verify_preamble_retval = VB2_ERROR_PREAMBLE_SIG_INVALID;
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_PREAMBLE_SIG_INVALID,
+ "preamble verify");
+
+ reset_common_data(FOR_PREAMBLE);
+ pre->firmware_version = 0x10000;
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_FW_PREAMBLE2_VERSION_RANGE,
+ "preamble version range");
+
+ reset_common_data(FOR_PREAMBLE);
+ pre->firmware_version = 1;
+ TEST_EQ(vb2_load_fw_preamble(&cc),
+ VB2_ERROR_FW_PREAMBLE2_VERSION_ROLLBACK,
+ "preamble version rollback");
+
+ reset_common_data(FOR_PREAMBLE);
+ pre->firmware_version = 3;
+ TEST_SUCC(vb2_load_fw_preamble(&cc),
+ "preamble version roll forward");
+ vb2_secdata_get(&cc, VB2_SECDATA_VERSIONS, &v);
+ TEST_EQ(v, 0x20003, "roll forward");
+
+ /* Newer version without result success doesn't roll forward */
+ reset_common_data(FOR_PREAMBLE);
+ pre->firmware_version = 3;
+ sd->last_fw_result = VB2_FW_RESULT_UNKNOWN;
+ TEST_SUCC(vb2_load_fw_preamble(&cc),
+ "preamble version no roll forward 1");
+ vb2_secdata_get(&cc, VB2_SECDATA_VERSIONS, &v);
+ TEST_EQ(v, 0x20002, "no roll forward");
+
+ /* Newer version with success but for other slot doesn't roll forward */
+ reset_common_data(FOR_PREAMBLE);
+ pre->firmware_version = 3;
+ sd->last_fw_slot = 1;
+ TEST_SUCC(vb2_load_fw_preamble(&cc),
+ "preamble version no roll forward 2");
+ vb2_secdata_get(&cc, VB2_SECDATA_VERSIONS, &v);
+ TEST_EQ(v, 0x20002, "no roll forward");
+}
+
+int main(int argc, char* argv[])
+{
+ verify_keyblock_tests();
+ verify_preamble_tests();
+
+ return gTestSuccess ? 0 : 255;
+}