1 /* Microsoft Reference Implementation for TPM 2.0
2 *
3 * The copyright in this software is being made available under the BSD License,
4 * included below. This software may be subject to other third party and
5 * contributor rights, including patent rights, and no such rights are granted
6 * under this license.
7 *
8 * Copyright (c) Microsoft Corporation
9 *
10 * All rights reserved.
11 *
12 * BSD License
13 *
14 * Redistribution and use in source and binary forms, with or without modification,
15 * are permitted provided that the following conditions are met:
16 *
17 * Redistributions of source code must retain the above copyright notice, this list
18 * of conditions and the following disclaimer.
19 *
20 * Redistributions in binary form must reproduce the above copyright notice, this
21 * list of conditions and the following disclaimer in the documentation and/or
22 * other materials provided with the distribution.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ""AS IS""
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
28 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
31 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35 #include "Tpm.h"
36 #include "Shutdown_fp.h"
37
38 #if CC_Shutdown // Conditional expansion of this file
39
40 /*(See part 3 specification)
41 // Shut down TPM for power off
42 */
43 // Return Type: TPM_RC
44 // TPM_RC_TYPE if PCR bank has been re-configured, a
45 // Shutdown(CLEAR) is required
46 TPM_RC
TPM2_Shutdown(Shutdown_In * in)47 TPM2_Shutdown(
48 Shutdown_In *in // IN: input parameter list
49 )
50 {
51 // The command needs NV update. Check if NV is available.
52 // A TPM_RC_NV_UNAVAILABLE or TPM_RC_NV_RATE error may be returned at
53 // this point
54 RETURN_IF_NV_IS_NOT_AVAILABLE;
55
56 // Input Validation
57 // If PCR bank has been reconfigured, a CLEAR state save is required
58 if(g_pcrReConfig && in->shutdownType == TPM_SU_STATE)
59 return TPM_RCS_TYPE + RC_Shutdown_shutdownType;
60 // Internal Data Update
61 gp.orderlyState = in->shutdownType;
62
63 #if USE_DA_USED
64 // CLEAR g_daUsed so that any future DA-protected access will cause the
65 // shutdown to become non-orderly. It is not sufficient to invalidate the
66 // shutdown state after a DA failure because an attacker can inhibit access
67 // to NV and use the fact that an update of �failedTries� was attempted as an
68 // indication of an authorization failure. By making sure that the orderly state
69 // is CLEAR before any DA attempt, this prevents the possibility of this 'attack.'
70 g_daUsed = FALSE;
71 #endif
72
73 // PCR private date state save
74 PCRStateSave(in->shutdownType);
75
76 // Save the ACT state
77 ActShutdown(in->shutdownType);
78
79 // Save RAM backed NV index data
80 NvUpdateIndexOrderlyData();
81
82 #if ACCUMULATE_SELF_HEAL_TIMER
83 // Save the current time value
84 go.time = g_time;
85 #endif
86
87 // Save all orderly data
88 NvWrite(NV_ORDERLY_DATA, sizeof(ORDERLY_DATA), &go);
89
90 if(in->shutdownType == TPM_SU_STATE)
91 {
92 // Save STATE_RESET and STATE_CLEAR data
93 NvWrite(NV_STATE_CLEAR_DATA, sizeof(STATE_CLEAR_DATA), &gc);
94 NvWrite(NV_STATE_RESET_DATA, sizeof(STATE_RESET_DATA), &gr);
95
96 // Save the startup flags for resume
97 if(g_DrtmPreStartup)
98 gp.orderlyState = TPM_SU_STATE | PRE_STARTUP_FLAG;
99 else if(g_StartupLocality3)
100 gp.orderlyState = TPM_SU_STATE | STARTUP_LOCALITY_3;
101 }
102 // only two shutdown options.
103 else if(in->shutdownType != TPM_SU_CLEAR)
104 return TPM_RCS_VALUE + RC_Shutdown_shutdownType;
105
106 NV_SYNC_PERSISTENT(orderlyState);
107
108 return TPM_RC_SUCCESS;
109 }
110 #endif // CC_Shutdown