summaryrefslogtreecommitdiffstats
path: root/src/tpm2/PP.c
blob: 2c73010121bed35fa7e4625aab58f2f4525ae620 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/********************************************************************************/
/*										*/
/*			     				*/
/*			     Written by Ken Goldman				*/
/*		       IBM Thomas J. Watson Research Center			*/
/*            $Id: PP.c 1490 2019-07-26 21:13:22Z 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					*/
/*										*/
/********************************************************************************/

/* 8.8 PP.c */
/* 8.8.1 Introduction */
/* This file contains the functions that support the physical presence operations of the TPM. */
/* 8.8.2 Includes */
#include "Tpm.h"
/* 8.8.3 Functions */
/* 8.8.3.1 PhysicalPresencePreInstall_Init() */
/* This function is used to initialize the array of commands that always require confirmation with
   physical presence. The array is an array of bits that has a correspondence with the command
   code. */
/* This command should only ever be executable in a manufacturing setting or in a simulation. */
/* When set, these cannot be cleared. */
void
PhysicalPresencePreInstall_Init(
				void
				)
{
    COMMAND_INDEX        commandIndex;
    // Clear all the PP commands
    MemorySet(&gp.ppList, 0, sizeof(gp.ppList));
    // Any command that is PP_REQUIRED should be SET
    for(commandIndex = 0; commandIndex < COMMAND_COUNT; commandIndex++)
	{
	    if(s_commandAttributes[commandIndex] & IS_IMPLEMENTED
	       &&  s_commandAttributes[commandIndex] & PP_REQUIRED)
		SET_BIT(commandIndex, gp.ppList);
	}
    // Write PP list to NV
    NV_SYNC_PERSISTENT(ppList);
    return;
}
/* 8.8.3.2 PhysicalPresenceCommandSet() */
/* This function is used to set the indicator that a command requires PP confirmation. */
void
PhysicalPresenceCommandSet(
			   TPM_CC           commandCode    // IN: command code
			   )
{
    COMMAND_INDEX       commandIndex = CommandCodeToCommandIndex(commandCode);
    // if the command isn't implemented, the do nothing
    if(commandIndex == UNIMPLEMENTED_COMMAND_INDEX)
	return;
    // only set the bit if this is a command for which PP is allowed
    if(s_commandAttributes[commandIndex] & PP_COMMAND)
	SET_BIT(commandIndex, gp.ppList);
    return;
}
/* 8.8.3.3 PhysicalPresenceCommandClear() */
/* This function is used to clear the indicator that a command requires PP confirmation. */
void
PhysicalPresenceCommandClear(
			     TPM_CC           commandCode    // IN: command code
			     )
{
    COMMAND_INDEX       commandIndex = CommandCodeToCommandIndex(commandCode);
    // If the command isn't implemented, then don't do anything
    if(commandIndex == UNIMPLEMENTED_COMMAND_INDEX)
	return;
    // Only clear the bit if the command does not require PP
    if((s_commandAttributes[commandIndex] & PP_REQUIRED) == 0)
	CLEAR_BIT(commandIndex, gp.ppList);
    return;
}
/* 8.8.3.4 PhysicalPresenceIsRequired() */
/* This function indicates if PP confirmation is required for a command. */
/* Return Values Meaning */
/* TRUE if physical presence is required */
/* FALSE if physical presence is not required */
BOOL
PhysicalPresenceIsRequired(
			   COMMAND_INDEX    commandIndex   // IN: command index
			   )
{
    // Check the bit map.  If the bit is SET, PP authorization is required
    return (TEST_BIT(commandIndex, gp.ppList));
}
/* 8.8.3.5 PhysicalPresenceCapGetCCList() */
/* This function returns a list of commands that require PP confirmation. The list starts from the
   first implemented command that has a command code that the same or greater than commandCode. */
/* Return Values Meaning */
/* YES if there are more command codes available */
/* NO all the available command codes have been returned */
TPMI_YES_NO
PhysicalPresenceCapGetCCList(
			     TPM_CC           commandCode,   // IN: start command code
			     UINT32           count,         // IN: count of returned TPM_CC
			     TPML_CC         *commandList    // OUT: list of TPM_CC
			     )
{
    TPMI_YES_NO     more = NO;
    COMMAND_INDEX   commandIndex;
    // Initialize output handle list
    commandList->count = 0;
    // The maximum count of command we may return is MAX_CAP_CC
    if(count > MAX_CAP_CC) count = MAX_CAP_CC;
    // Collect PP commands
    for(commandIndex = GetClosestCommandIndex(commandCode);
	commandIndex != UNIMPLEMENTED_COMMAND_INDEX;
	commandIndex = GetNextCommandIndex(commandIndex))
	{
	    if(PhysicalPresenceIsRequired(commandIndex))
		{
		    if(commandList->count < count)
			{
			    // If we have not filled up the return list, add this command
			    // code to it
			    commandList->commandCodes[commandList->count]
				= GetCommandCode(commandIndex);
			    commandList->count++;
			}
		    else
			{
			    // If the return list is full but we still have PP command
			    // available, report this and stop iterating
			    more = YES;
			    break;
			}
		}
	}
    return more;
}