summaryrefslogtreecommitdiffstats
path: root/src/tpm2/StartupCommands.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/tpm2/StartupCommands.c')
-rw-r--r--src/tpm2/StartupCommands.c349
1 files changed, 349 insertions, 0 deletions
diff --git a/src/tpm2/StartupCommands.c b/src/tpm2/StartupCommands.c
new file mode 100644
index 0000000..1212b46
--- /dev/null
+++ b/src/tpm2/StartupCommands.c
@@ -0,0 +1,349 @@
+/********************************************************************************/
+/* */
+/* Startup Commands */
+/* Written by Ken Goldman */
+/* IBM Thomas J. Watson Research Center */
+/* $Id: StartupCommands.c 1594 2020-03-26 22:15:48Z kgoldman $ */
+/* */
+/* Licenses and Notices */
+/* */
+/* 1. Copyright Licenses: */
+/* */
+/* - Trusted Computing Group (TCG) grants to the user of the source code in */
+/* this specification (the "Source Code") a worldwide, irrevocable, */
+/* nonexclusive, royalty free, copyright license to reproduce, create */
+/* derivative works, distribute, display and perform the Source Code and */
+/* derivative works thereof, and to grant others the rights granted herein. */
+/* */
+/* - The TCG grants to the user of the other parts of the specification */
+/* (other than the Source Code) the rights to reproduce, distribute, */
+/* display, and perform the specification solely for the purpose of */
+/* developing products based on such documents. */
+/* */
+/* 2. Source Code Distribution Conditions: */
+/* */
+/* - Redistributions of Source Code must retain the above copyright licenses, */
+/* this list of conditions and the following disclaimers. */
+/* */
+/* - Redistributions in binary form must reproduce the above copyright */
+/* licenses, this list of conditions and the following disclaimers in the */
+/* documentation and/or other materials provided with the distribution. */
+/* */
+/* 3. Disclaimers: */
+/* */
+/* - THE COPYRIGHT LICENSES SET FORTH ABOVE DO NOT REPRESENT ANY FORM OF */
+/* LICENSE OR WAIVER, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, WITH */
+/* RESPECT TO PATENT RIGHTS HELD BY TCG MEMBERS (OR OTHER THIRD PARTIES) */
+/* THAT MAY BE NECESSARY TO IMPLEMENT THIS SPECIFICATION OR OTHERWISE. */
+/* Contact TCG Administration (admin@trustedcomputinggroup.org) for */
+/* information on specification licensing rights available through TCG */
+/* membership agreements. */
+/* */
+/* - THIS SPECIFICATION IS PROVIDED "AS IS" WITH NO EXPRESS OR IMPLIED */
+/* WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY OR */
+/* FITNESS FOR A PARTICULAR PURPOSE, ACCURACY, COMPLETENESS, OR */
+/* NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS, OR ANY WARRANTY */
+/* OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. */
+/* */
+/* - Without limitation, TCG and its members and licensors disclaim all */
+/* liability, including liability for infringement of any proprietary */
+/* rights, relating to use of information in this specification and to the */
+/* implementation of this specification, and TCG disclaims all liability for */
+/* cost of procurement of substitute goods or services, lost profits, loss */
+/* of use, loss of data or any incidental, consequential, direct, indirect, */
+/* or special damages, whether under contract, tort, warranty or otherwise, */
+/* arising in any way out of use or reliance upon this specification or any */
+/* information herein. */
+/* */
+/* (c) Copyright IBM Corp. and others, 2016 - 2020 */
+/* */
+/********************************************************************************/
+
+/* 9.2 _TPM_Init */
+#include "Tpm.h"
+#include "PlatformACT_fp.h" /* added kgold */
+#include "_TPM_Init_fp.h"
+#include "StateMarshal.h" /* libtpms added */
+// This function is used to process a _TPM_Init indication.
+LIB_EXPORT void
+_TPM_Init(
+ void
+ )
+{
+ BOOL restored = FALSE; /* libtpms added */
+
+ g_powerWasLost = g_powerWasLost | _plat__WasPowerLost();
+#if SIMULATION && !defined NDEBUG /* libtpms changed */
+ // If power was lost and this was a simulation, put canary in RAM used by NV
+ // so that uninitialized memory can be detected more easily
+ if(g_powerWasLost)
+ {
+ memset(&gc, 0xbb, sizeof(gc));
+ memset(&gr, 0xbb, sizeof(gr));
+ memset(&gp, 0xbb, sizeof(gp));
+ memset(&go, 0xbb, sizeof(go));
+ }
+#endif
+#if SIMULATION
+ // Clear the flag that forces failure on self-test
+ g_forceFailureMode = FALSE;
+#endif
+ // Disable the tick processing
+ _plat__ACT_EnableTicks(FALSE);
+ // Set initialization state
+ TPMInit();
+ // Set g_DRTMHandle as unassigned
+ g_DRTMHandle = TPM_RH_UNASSIGNED;
+ // No H-CRTM, yet.
+ g_DrtmPreStartup = FALSE;
+ // Initialize the NvEnvironment.
+ g_nvOk = NvPowerOn();
+ // Initialize cryptographic functions
+ g_inFailureMode |= (CryptInit() == FALSE); /* libtpms changed */
+ if(!g_inFailureMode)
+ {
+ // Load the persistent data
+ NvReadPersistent();
+ // Load the orderly data (clock and DRBG state).
+ // If this is not done here, things break
+ NvRead(&go, NV_ORDERLY_DATA, sizeof(go));
+ // Start clock. Need to do this after NV has been restored.
+ TimePowerOn();
+
+ /* libtpms added begin */
+ VolatileLoad(&restored);
+ if (restored)
+ NVShadowRestore();
+ /* libtpms added end */
+ }
+ return;
+}
+#include "Tpm.h"
+#include "Startup_fp.h"
+#if CC_Startup // Conditional expansion of this file
+TPM_RC
+TPM2_Startup(
+ Startup_In *in // IN: input parameter list
+ )
+{
+ STARTUP_TYPE startup;
+ BYTE locality = _plat__LocalityGet();
+ BOOL OK = TRUE; // The command needs NV update.
+ RETURN_IF_NV_IS_NOT_AVAILABLE;
+ // Get the flags for the current startup locality and the H-CRTM.
+ // Rather than generalizing the locality setting, this code takes advantage
+ // of the fact that the PC Client specification only allows Startup()
+ // from locality 0 and 3. To generalize this probably would require a
+ // redo of the NV space and since this is a feature that is hardly ever used
+ // outside of the PC Client, this code just support the PC Client needs.
+ // Input Validation
+ // Check that the locality is a supported value
+ if(locality != 0 && locality != 3)
+ return TPM_RC_LOCALITY;
+ // If there was a H-CRTM, then treat the locality as being 3
+ // regardless of what the Startup() was. This is done to preserve the
+ // H-CRTM PCR so that they don't get overwritten with the normal
+ // PCR startup initialization. This basically means that g_StartupLocality3
+ // and g_DrtmPreStartup can't both be SET at the same time.
+ if(g_DrtmPreStartup)
+ locality = 0;
+ g_StartupLocality3 = (locality == 3);
+#if USE_DA_USED
+ // If there was no orderly shutdown, then there might have been a write to
+ // failedTries that didn't get recorded but only if g_daUsed was SET in the
+ // shutdown state
+ g_daUsed = (gp.orderlyState == SU_DA_USED_VALUE);
+ if(g_daUsed)
+ gp.orderlyState = SU_NONE_VALUE;
+#endif
+ g_prevOrderlyState = gp.orderlyState;
+ // If there was a proper shutdown, then the startup modifiers are in the
+ // orderlyState. Turn them off in the copy.
+ if(IS_ORDERLY(g_prevOrderlyState))
+ g_prevOrderlyState &= ~(PRE_STARTUP_FLAG | STARTUP_LOCALITY_3);
+ // If this is a Resume,
+ if(in->startupType == TPM_SU_STATE)
+ {
+ // then there must have been a prior TPM2_ShutdownState(STATE)
+ if(g_prevOrderlyState != TPM_SU_STATE)
+ return TPM_RCS_VALUE + RC_Startup_startupType;
+ // and the part of NV used for state save must have been recovered
+ // correctly.
+ // NOTE: if this fails, then the caller will need to do Startup(CLEAR). The
+ // code for Startup(Clear) cannot fail if the NV can't be read correctly
+ // because that would prevent the TPM from ever getting unstuck.
+ if(g_nvOk == FALSE)
+ return TPM_RC_NV_UNINITIALIZED;
+ // For Resume, the H-CRTM has to be the same as the previous boot
+ if(g_DrtmPreStartup != ((gp.orderlyState & PRE_STARTUP_FLAG) != 0))
+ return TPM_RCS_VALUE + RC_Startup_startupType;
+ if(g_StartupLocality3 != ((gp.orderlyState & STARTUP_LOCALITY_3) != 0))
+ return TPM_RC_LOCALITY;
+ }
+ // Clean up the gp state
+ gp.orderlyState = g_prevOrderlyState;
+
+ // Internal Date Update
+ if((gp.orderlyState == TPM_SU_STATE) && (g_nvOk == TRUE))
+ {
+ // Always read the data that is only cleared on a Reset because this is not
+ // a reset
+ NvRead(&gr, NV_STATE_RESET_DATA, sizeof(gr));
+ if(in->startupType == TPM_SU_STATE)
+ {
+ // If this is a startup STATE (a Resume) need to read the data
+ // that is cleared on a startup CLEAR because this is not a Reset
+ // or Restart.
+ NvRead(&gc, NV_STATE_CLEAR_DATA, sizeof(gc));
+ startup = SU_RESUME;
+ }
+ else
+ startup = SU_RESTART;
+ }
+ else
+ // Will do a TPM reset if Shutdown(CLEAR) and Startup(CLEAR) or no shutdown
+ // or there was a failure reading the NV data.
+ startup = SU_RESET;
+ // Startup for cryptographic library. Don't do this until after the orderly
+ // state has been read in from NV.
+ OK = OK && CryptStartup(startup);
+ // When the cryptographic library has been started, indicate that a TPM2_Startup
+ // command has been received.
+ OK = OK && TPMRegisterStartup();
+ // Read the platform unique value that is used as VENDOR_PERMANENT
+ // authorization value
+ g_platformUniqueDetails.t.size
+ = (UINT16)_plat__GetUnique(1, sizeof(g_platformUniqueDetails.t.buffer),
+ g_platformUniqueDetails.t.buffer);
+ // Start up subsystems
+ // Start set the safe flag
+ OK = OK && TimeStartup(startup);
+ // Start dictionary attack subsystem
+ OK = OK && DAStartup(startup);
+ // Enable hierarchies
+ OK = OK && HierarchyStartup(startup);
+ // Restore/Initialize PCR
+ OK = OK && PCRStartup(startup, locality);
+ // Restore/Initialize command audit information
+ OK = OK && CommandAuditStartup(startup);
+ // Restore the ACT
+ OK = OK && ActStartup(startup);
+ //// The following code was moved from Time.c where it made no sense
+ if (OK)
+ {
+ switch (startup)
+ {
+ case SU_RESUME:
+ // Resume sequence
+ gr.restartCount++;
+ break;
+ case SU_RESTART:
+ // Hibernate sequence
+ gr.clearCount++;
+ gr.restartCount++;
+ break;
+ default:
+ // Reset object context ID to 0
+ gr.objectContextID = 0;
+ // Reset clearCount to 0
+ gr.clearCount = 0;
+ // Reset sequence
+ // Increase resetCount
+ gp.resetCount++;
+ // Write resetCount to NV
+ NV_SYNC_PERSISTENT(resetCount);
+ gp.totalResetCount++;
+ // We do not expect the total reset counter overflow during the life
+ // time of TPM. if it ever happens, TPM will be put to failure mode
+ // and there is no way to recover it.
+ // The reason that there is no recovery is that we don't increment
+ // the NV totalResetCount when incrementing would make it 0. When the
+ // TPM starts up again, the old value of totalResetCount will be read
+ // and we will get right back to here with the increment failing.
+#if 0 // libtpms added
+ if(gp.totalResetCount == 0)
+ FAIL(FATAL_ERROR_INTERNAL);
+#endif // libtpms added
+ // Write total reset counter to NV
+ NV_SYNC_PERSISTENT(totalResetCount);
+ // Reset restartCount
+ gr.restartCount = 0;
+ break;
+ }
+ }
+ // Initialize session table
+ OK = OK && SessionStartup(startup);
+ // Initialize object table
+ OK = OK && ObjectStartup();
+ // Initialize index/evict data. This function clears read/write locks
+ // in NV index
+ OK = OK && NvEntityStartup(startup);
+ // Initialize the orderly shut down flag for this cycle to SU_NONE_VALUE.
+ gp.orderlyState = SU_NONE_VALUE;
+ OK = OK && NV_SYNC_PERSISTENT(orderlyState);
+ // This can be reset after the first completion of a TPM2_Startup() after
+ // a power loss. It can probably be reset earlier but this is an OK place.
+ if (OK)
+ g_powerWasLost = FALSE;
+ return (OK) ? TPM_RC_SUCCESS : TPM_RC_FAILURE;
+}
+#endif // CC_Startup
+#include "Tpm.h"
+#include "Shutdown_fp.h"
+#if CC_Shutdown // Conditional expansion of this file
+TPM_RC
+TPM2_Shutdown(
+ Shutdown_In *in // IN: input parameter list
+ )
+{
+ // The command needs NV update. Check if NV is available.
+ // A TPM_RC_NV_UNAVAILABLE or TPM_RC_NV_RATE error may be returned at
+ // this point
+ RETURN_IF_NV_IS_NOT_AVAILABLE;
+ // Input Validation
+ // If PCR bank has been reconfigured, a CLEAR state save is required
+ if(g_pcrReConfig && in->shutdownType == TPM_SU_STATE)
+ return TPM_RCS_TYPE + RC_Shutdown_shutdownType;
+ // Internal Data Update
+ gp.orderlyState = in->shutdownType;
+#if USE_DA_USED
+ // CLEAR g_daUsed so that any future DA-protected access will cause the
+ // shutdown to become non-orderly. It is not sufficient to invalidate the
+ // shutdown state after a DA failure because an attacker can inhibit access
+ // to NV and use the fact that an update of failedTries was attempted as an
+ // indication of an authorization failure. By making sure that the orderly state
+ // is CLEAR before any DA attempt, this prevents the possibility of this 'attack.'
+ g_daUsed = FALSE;
+#endif
+ // PCR private date state save
+ PCRStateSave(in->shutdownType);
+ // Save the ACT state
+ ActShutdown(in->shutdownType);
+ // Save RAM backed NV index data
+ NvUpdateIndexOrderlyData();
+#if ACCUMULATE_SELF_HEAL_TIMER
+ // Save the current time value
+ go.time = g_time;
+#endif
+ // Save all orderly data
+ NvWrite(NV_ORDERLY_DATA, sizeof(ORDERLY_DATA), &go);
+ if(in->shutdownType == TPM_SU_STATE)
+ {
+ // Save STATE_RESET and STATE_CLEAR data
+ NvWrite(NV_STATE_CLEAR_DATA, sizeof(STATE_CLEAR_DATA), &gc);
+ NvWrite(NV_STATE_RESET_DATA, sizeof(STATE_RESET_DATA), &gr);
+ // Save the startup flags for resume
+ if(g_DrtmPreStartup)
+ gp.orderlyState = TPM_SU_STATE | PRE_STARTUP_FLAG;
+ else if(g_StartupLocality3)
+ gp.orderlyState = TPM_SU_STATE | STARTUP_LOCALITY_3;
+ }
+ // only two shutdown options
+ else if(in->shutdownType != TPM_SU_CLEAR)
+ {
+ return TPM_RCS_VALUE + RC_Shutdown_shutdownType;
+ }
+ NV_SYNC_PERSISTENT(orderlyState);
+ return TPM_RC_SUCCESS;
+}
+#endif // CC_Shutdown
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-31 21:48:43 +0000