vboot2: read secdata and nvdata

This code ports antirollback module and tpm library from platform/vboot_reference.
names are modified to conform to coreboot's style.

The rollback_index module is split in a bottom half and top half. The top half
contains generic code which hides the underlying storage implementation.
The bottom half implements the storage abstraction.
With this change, the bottom half is moved to coreboot, while the top half stays
in vboot_reference.

TEST=Built with USE=+/-vboot2 for Blaze. Built Samus, Link.
BUG=none
Branch=none
Original-Signed-off-by: Daisuke Nojiri <dnojiri@chromium.org>
Original-Change-Id: I77e3ae1a029e09d3cdefe8fd297a3b432bbb9e9e
Original-Reviewed-on: https://chromium-review.googlesource.com/206065
Original-Reviewed-by: Randall Spangler <rspangler@chromium.org>
Original-Reviewed-by: Luigi Semenzato <semenzato@chromium.org>

(cherry picked from commit 6b66140ac979a991237bf1fe25e0a55244a406d0)

Change-Id: Ia3b8f27d6b1c2055e898ce716c4a93782792599c
Signed-off-by: Aaron Durbin <adurbin@chromium.org>
Signed-off-by: Marc Jones <marc.jones@se-eng.com>
Reviewed-on: http://review.coreboot.org/8615
Tested-by: build bot (Jenkins)
Reviewed-by: Aaron Durbin <adurbin@google.com>

2 files changed, 40 insertions, 214 deletions

diff --git a/src/include/antirollback.h b/src/include/antirollback.h
index dd0de32aef..0473e2446c 100644
--- a/src/include/antirollback.h
+++ b/src/include/antirollback.h
@@ -6,133 +6,39 @@
  * stored in the TPM NVRAM.
  */
 
-#ifndef VBOOT_REFERENCE_ROLLBACK_INDEX_H_
-#define VBOOT_REFERENCE_ROLLBACK_INDEX_H_
+#ifndef ANTIROLLBACK_H_
+#define ANTIROLLBACK_H_
 
-#include "sysincludes.h"
-#include "tss_constants.h"
+#include "2sysincludes.h"
+#include <2api.h>
+#include "tpm_lite/tss_constants.h"
 
 /* TPM NVRAM location indices. */
 #define FIRMWARE_NV_INDEX               0x1007
-#define KERNEL_NV_INDEX                 0x1008
-/* This is just an opaque space for backup purposes */
-#define BACKUP_NV_INDEX                 0x1009
-#define BACKUP_NV_SIZE 16
-
 
 /* Structure definitions for TPM spaces */
 
-/* Kernel space - KERNEL_NV_INDEX, locked with physical presence. */
-#define ROLLBACK_SPACE_KERNEL_VERSION 2
-#define ROLLBACK_SPACE_KERNEL_UID 0x4752574C  /* 'GRWL' */
-
-typedef struct RollbackSpaceKernel {
-	/* Struct version, for backwards compatibility */
-	uint8_t struct_version;
-	/* Unique ID to detect space redefinition */
-	uint32_t uid;
-	/* Kernel versions */
-	uint32_t kernel_versions;
-	/* Reserved for future expansion */
-	uint8_t reserved[3];
-	/* Checksum (v2 and later only) */
-	uint8_t crc8;
-} __attribute__((packed)) RollbackSpaceKernel;
-
 /* Flags for firmware space */
+
 /*
  * Last boot was developer mode.  TPM ownership is cleared when transitioning
  * to/from developer mode.
  */
 #define FLAG_LAST_BOOT_DEVELOPER 0x01
-/*
- * Some systems may not have a dedicated dev-mode switch, but enter and leave
- * dev-mode through some recovery-mode magic keypresses. For those systems, the
- * dev-mode "switch" state is in this bit (0=normal, 1=dev). To make it work, a
- * new flag is passed to VbInit(), indicating that the system lacks a physical
- * dev-mode switch. If a physical switch is present, this bit is ignored.
- */
-#define FLAG_VIRTUAL_DEV_MODE_ON 0x02
-
-/* Firmware space - FIRMWARE_NV_INDEX, locked with global lock. */
-#define ROLLBACK_SPACE_FIRMWARE_VERSION 2
-
-typedef struct RollbackSpaceFirmware {
-	/* Struct version, for backwards compatibility */
-	uint8_t struct_version;
-	/* Flags (see FLAG_* above) */
-	uint8_t flags;
-	/* Firmware versions */
-	uint32_t fw_versions;
-	/* Reserved for future expansion */
-	uint8_t reserved[3];
-	/* Checksum (v2 and later only) */
-	uint8_t crc8;
-} __attribute__((packed)) RollbackSpaceFirmware;
-
 
 /* All functions return TPM_SUCCESS (zero) if successful, non-zero if error */
 
-/*
- * These functions are called from VbInit().  They cannot use global
- * variables.
- */
-
-uint32_t RollbackS3Resume(void);
-
-/*
- * These functions are callable from VbSelectFirmware().  They cannot use
- * global variables.
- */
-
-/**
- * This must be called.
- */
-uint32_t RollbackFirmwareSetup(int is_hw_dev,
-                               int disable_dev_request,
-                               int clear_tpm_owner_request,
-                               /* two outputs on success */
-                               int *is_virt_dev, uint32_t *tpm_version);
+uint32_t antirollback_read_space_firmware(struct vb2_context *ctx);
 
 /**
  * Write may be called if the versions change.
  */
-uint32_t RollbackFirmwareWrite(uint32_t version);
+uint32_t antirollback_write_space_firmware(struct vb2_context *ctx);
 
 /**
  * Lock must be called.
  */
-uint32_t RollbackFirmwareLock(void);
-
-/*
- * These functions are callable from VbSelectAndLoadKernel().  They may use
- * global variables.
- */
-
-/**
- * Read stored kernel version.
- */
-uint32_t RollbackKernelRead(uint32_t *version);
-
-/**
- * Write stored kernel version.
- */
-uint32_t RollbackKernelWrite(uint32_t version);
-
-/**
- * Read backup data.
- */
-uint32_t RollbackBackupRead(uint8_t *raw);
-
-/**
- * Write backup data.
- */
-uint32_t RollbackBackupWrite(uint8_t *raw);
-
-/**
- * Lock must be called.  Internally, it's ignored in recovery mode.
- */
-uint32_t RollbackKernelLock(int recovery_mode);
+uint32_t antirollback_lock_space_firmware(void);
 
 /****************************************************************************/
 
@@ -144,23 +50,23 @@ uint32_t RollbackKernelLock(int recovery_mode);
 /**
  * Issue a TPM_Clear and reenable/reactivate the TPM.
  */
-uint32_t TPMClearAndReenable(void);
+uint32_t tpm_clear_and_reenable(void);
 
 /**
- * Like TlclWrite(), but checks for write errors due to hitting the 64-write
+ * Like tlcl_write(), but checks for write errors due to hitting the 64-write
  * limit and clears the TPM when that happens.  This can only happen when the
  * TPM is unowned, so it is OK to clear it (and we really have no choice).
  * This is not expected to happen frequently, but it could happen.
  */
-uint32_t SafeWrite(uint32_t index, const void *data, uint32_t length);
+uint32_t safe_write(uint32_t index, const void *data, uint32_t length);
 
 /**
- * Similarly to SafeWrite(), this ensures we don't fail a DefineSpace because
+ * Similarly to safe_write(), this ensures we don't fail a DefineSpace because
  * we hit the TPM write limit.  This is even less likely to happen than with
  * writes because we only define spaces once at initialization, but we'd rather
  * be paranoid about this.
  */
-uint32_t SafeDefineSpace(uint32_t index, uint32_t perm, uint32_t size);
+uint32_t safe_define_space(uint32_t index, uint32_t perm, uint32_t size);
 
 /**
  * Perform one-time initializations.
@@ -169,19 +75,11 @@ uint32_t SafeDefineSpace(uint32_t index, uint32_t perm, uint32_t size);
  * nvLocked bit and ensures the physical presence command is enabled and
  * locked.
  */
-uint32_t OneTimeInitializeTPM(RollbackSpaceFirmware *rsf,
-                              RollbackSpaceKernel *rsk);
-
-/**
- * Start the TPM and establish the root of trust for the anti-rollback
- * mechanism.
- */
-uint32_t SetupTPM(int developer_mode, int disable_dev_request,
-                  int clear_tpm_owner_request, RollbackSpaceFirmware *rsf);
+uint32_t factory_initialize_tpm(struct vb2_context *ctx);
 
 /**
- * Utility function to turn the virtual dev-mode flag on or off. 0=off, 1=on.
+ * Start the TPM and establish the root of trust for the antirollback mechanism.
  */
-uint32_t SetVirtualDevMode(int val);
+uint32_t setup_tpm(struct vb2_context *ctx);
 
-#endif  /* VBOOT_REFERENCE_ROLLBACK_INDEX_H_ */
+#endif  /* ANTIROLLBACK_H_ */
diff --git a/src/include/tpm_lite/tlcl.h b/src/include/tpm_lite/tlcl.h
index 5373120066..77245922c9 100644
--- a/src/include/tpm_lite/tlcl.h
+++ b/src/include/tpm_lite/tlcl.h
@@ -21,45 +21,27 @@
 /**
  * Call this first.  Returns 0 if success, nonzero if error.
  */
-uint32_t TlclLibInit(void);
-
-/**
- * Call this on shutdown.  Returns 0 if success, nonzero if error.
- */
-uint32_t TlclLibClose(void);
-
-/* Low-level operations */
+uint32_t tlcl_lib_init(void);
 
 /**
  * Perform a raw TPM request/response transaction.
  */
-uint32_t TlclSendReceive(const uint8_t *request, uint8_t *response,
+uint32_t tlcl_send_receive(const uint8_t *request, uint8_t *response,
                          int max_length);
 
-/**
- * Return the size of a TPM request or response packet.
- */
-int TlclPacketSize(const uint8_t *packet);
-
 /* Commands */
 
 /**
  * Send a TPM_Startup(ST_CLEAR).  The TPM error code is returned (0 for
  * success).
  */
-uint32_t TlclStartup(void);
-
-/**
- * Save the TPM state.  Normally done by the kernel before a suspend, included
- * here for tests.  The TPM error code is returned (0 for success).
- */
-uint32_t TlclSaveState(void);
+uint32_t tlcl_startup(void);
 
 /**
  * Resume by sending a TPM_Startup(ST_STATE).  The TPM error code is returned
  * (0 for success).
  */
-uint32_t TlclResume(void);
+uint32_t tlcl_resume(void);
 
 /**
  * Run the self test.
@@ -67,143 +49,89 @@ uint32_t TlclResume(void);
  * Note---this is synchronous.  To run this in parallel with other firmware,
  * use ContinueSelfTest().  The TPM error code is returned.
  */
-uint32_t TlclSelfTestFull(void);
+uint32_t tlcl_self_test_full(void);
 
 /**
  * Run the self test in the background.
  */
-uint32_t TlclContinueSelfTest(void);
+uint32_t tlcl_continue_self_test(void);
 
 /**
  * Define a space with permission [perm].  [index] is the index for the space,
  * [size] the usable data size.  The TPM error code is returned.
  */
-uint32_t TlclDefineSpace(uint32_t index, uint32_t perm, uint32_t size);
+uint32_t tlcl_define_space(uint32_t index, uint32_t perm, uint32_t size);
 
 /**
  * Write [length] bytes of [data] to space at [index].  The TPM error code is
  * returned.
  */
-uint32_t TlclWrite(uint32_t index, const void *data, uint32_t length);
+uint32_t tlcl_write(uint32_t index, const void *data, uint32_t length);
 
 /**
  * Read [length] bytes from space at [index] into [data].  The TPM error code
  * is returned.
  */
-uint32_t TlclRead(uint32_t index, void *data, uint32_t length);
-
-/**
- * Read PCR at [index] into [data].  [length] must be TPM_PCR_DIGEST or
- * larger. The TPM error code is returned.
- */
-uint32_t TlclPCRRead(uint32_t index, void *data, uint32_t length);
-
-/**
- * Write-lock space at [index].  The TPM error code is returned.
- */
-uint32_t TlclWriteLock(uint32_t index);
-
-/**
- * Read-lock space at [index].  The TPM error code is returned.
- */
-uint32_t TlclReadLock(uint32_t index);
+uint32_t tlcl_read(uint32_t index, void *data, uint32_t length);
 
 /**
  * Assert physical presence in software.  The TPM error code is returned.
  */
-uint32_t TlclAssertPhysicalPresence(void);
+uint32_t tlcl_assert_physical_presence(void);
 
 /**
  * Enable the physical presence command.  The TPM error code is returned.
  */
-uint32_t TlclPhysicalPresenceCMDEnable(void);
+uint32_t tlcl_physical_presence_cmd_enable(void);
 
 /**
  * Finalize the physical presence settings: sofware PP is enabled, hardware PP
  * is disabled, and the lifetime lock is set.  The TPM error code is returned.
  */
-uint32_t TlclFinalizePhysicalPresence(void);
-
-uint32_t TlclAssertPhysicalPresenceResult(void);
-
-/**
- * Turn off physical presence and locks it off until next reboot.  The TPM
- * error code is returned.
- */
-uint32_t TlclLockPhysicalPresence(void);
+uint32_t tlcl_finalize_physical_presence(void);
 
 /**
  * Set the nvLocked bit.  The TPM error code is returned.
  */
-uint32_t TlclSetNvLocked(void);
-
-/**
- * Return 1 if the TPM is owned, 0 otherwise.
- */
-int TlclIsOwned(void);
+uint32_t tlcl_set_nv_locked(void);
 
 /**
  * Issue a ForceClear.  The TPM error code is returned.
  */
-uint32_t TlclForceClear(void);
+uint32_t tlcl_force_clear(void);
 
 /**
  * Issue a PhysicalEnable.  The TPM error code is returned.
  */
-uint32_t TlclSetEnable(void);
-
-/**
- * Issue a PhysicalDisable.  The TPM error code is returned.
- */
-uint32_t TlclClearEnable(void);
+uint32_t tlcl_set_enable(void);
 
 /**
  * Issue a SetDeactivated.  Pass 0 to activate.  Returns result code.
  */
-uint32_t TlclSetDeactivated(uint8_t flag);
+uint32_t tlcl_set_deactivated(uint8_t flag);
 
 /**
  * Get flags of interest.  Pointers for flags you aren't interested in may
  * be NULL.  The TPM error code is returned.
  */
-uint32_t TlclGetFlags(uint8_t *disable, uint8_t *deactivated,
-                      uint8_t *nvlocked);
+uint32_t tlcl_get_flags(uint8_t *disable, uint8_t *deactivated,
+                        uint8_t *nvlocked);
 
 /**
  * Set the bGlobalLock flag, which only a reboot can clear.  The TPM error
  * code is returned.
  */
-uint32_t TlclSetGlobalLock(void);
+uint32_t tlcl_set_global_lock(void);
 
 /**
  * Perform a TPM_Extend.
  */
-uint32_t TlclExtend(int pcr_num, const uint8_t *in_digest, uint8_t *out_digest);
-
-/**
- * Get the permission bits for the NVRAM space with |index|.
- */
-uint32_t TlclGetPermissions(uint32_t index, uint32_t *permissions);
+uint32_t tlcl_extend(int pcr_num, const uint8_t *in_digest,
+                     uint8_t *out_digest);
 
 /**
  * Get the entire set of permanent flags.
  */
-uint32_t TlclGetPermanentFlags(TPM_PERMANENT_FLAGS *pflags);
-
-/**
- * Get the entire set of volatile (ST_CLEAR) flags.
- */
-uint32_t TlclGetSTClearFlags(TPM_STCLEAR_FLAGS *pflags);
-
-/**
- * Get the ownership flag. The TPM error code is returned.
- */
-uint32_t TlclGetOwnership(uint8_t *owned);
-
-/**
- * Request [length] bytes from TPM RNG to be stored in [data]. Actual number of
- * bytes read is stored in [size]. The TPM error code is returned.
- */
-uint32_t TlclGetRandom(uint8_t *data, uint32_t length, uint32_t *size);
+uint32_t tlcl_get_permanent_flags(TPM_PERMANENT_FLAGS *pflags);
 
 #endif  /* TPM_LITE_TLCL_H_ */