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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/secureboot/trusted/trustedbootCmds.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2015,2019 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file trustedbootCmds.H
*
* @brief Trustedboot TPM command interfaces
*/
/////////////////////////////////////////////////////////////////
// NOTE: This file is exportable as TSS-Lite for skiboot/PHYP //
/////////////////////////////////////////////////////////////////
#ifndef __TRUSTEDBOOTCMDS_H
#define __TRUSTEDBOOTCMDS_H
// -----------------------------------------------
// Includes
// -----------------------------------------------
#ifdef __HOSTBOOT_MODULE
#include <secureboot/trustedbootif.H>
#include <i2c/tpmddif.H>
using namespace TPMDD;
#endif
#include "trustedboot.H"
#include "trustedTypes.H"
#ifdef __cplusplus
namespace TRUSTEDBOOT
{
#endif
/**
* @brief Transmit the command to the TPM and perform marshaling
* @param[in/out] io_target Current TPM target structure
* @param[in/out] io_buffer Input the command buffer to send, response on exit
* @param[in] i_bufsize Size of io_buffer in bytes
* @param[in] i_locality TPM locality to use
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmTransmitCommand(TpmTarget* io_target,
uint8_t* io_buffer,
size_t i_bufsize,
tpm_locality_t i_locality);
/**
* @brief Take structure pointed to by cmd and format for input into TPM
* @param[in] i_cmd Prefilled command input structure
* @param[out] o_outbuf Buffer to place marshalled data
* @param[in] i_bufsize Size of o_outbuf in bytes
* @param[out] o_cmdSize Byte size of io_outbuf data after marshal
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmMarshalCommandData(TPM2_BaseIn* i_cmd,
uint8_t* o_outbuf,
size_t i_bufsize,
size_t* o_cmdSize);
/**
* @brief Take structure pointed to by cmd and format for input into TPM
* @param[in] i_commandCode Command code that was executed on the TPM
* @param[in] i_respBuf Buffer with response data from TPM
* @param[in] i_respBufSize Byte size of respBuf buffer from TPM
* @param[out] o_outBuf Buffer to place formatted response data
* @param[in] i_outBufSize Byte size of o_outBuf buffer
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmUnmarshalResponseData(uint32_t i_commandCode,
uint8_t* i_respBuf,
size_t i_respBufSize,
TPM2_BaseOut* o_outBuf,
size_t i_outBufSize);
#ifdef __HOSTBOOT_MODULE
/**
* @brief Send the TPM_STARTUP command to the targetted TPM
* @param[in/out] io_target Current TPM target structure
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmCmdStartup(TpmTarget* io_target);
/**
* @brief Send the TPM_GETCAPABILITY command to read FW version from TPM
* @param[in/out] io_target Current TPM target structure
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmCmdGetCapFwVersion(TpmTarget* io_target);
/**
* @brief Send the TPM_GETCAPABILITY command to validate NV indexes
* @param[in/out] io_target Current TPM target structure
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmCmdGetCapNvIndexValidate(TpmTarget* io_target);
#endif
/**
* @brief Send the TPM_Extend command to the targeted TPM and log
* @param[in/out] io_target Current TPM target structure
* @param[in] i_pcr PCR to write to
* @param[in] i_algId Algorithm to use
* @param[in] i_digest Digest value to write to PCR, zeros appended as needed
* @param[in] i_digestSize Byte size of i_digest array
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmCmdPcrExtend(TpmTarget * io_target,
TPM_Pcr i_pcr,
TPM_Alg_Id i_algId,
const uint8_t* i_digest,
size_t i_digestSize);
/**
* @brief Send the TPM_Extend command to the targeted TPM and log
* @param[in/out] io_target Current TPM target structure
* @param[in] i_pcr PCR to write to
* @param[in] i_algId_1 Algorithm to use
* @param[in] i_digest_1 Digest value to write to PCR, zeros appended as needed
* @param[in] i_digestSize_1 Byte size of i_digest_1 array
* @param[in] i_algId_2 Algorithm to use
* @param[in] i_digest_2 Digest value to write to PCR, zeros appended as needed
* NULL if second digest not used
* @param[in] i_digestSize_2 Byte size of i_digest_2 array
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmCmdPcrExtend2Hash(TpmTarget * io_target,
TPM_Pcr i_pcr,
TPM_Alg_Id i_algId_1,
const uint8_t* i_digest_1,
size_t i_digestSize_1,
TPM_Alg_Id i_algId_2,
const uint8_t* i_digest_2,
size_t i_digestSize_2);
/**
* @brief Send the TPM_Read command to the targeted TPM and log
* @param[in/out] io_target Current TPM target structure
* @param[in] i_pcr PCR to read from
* @param[in] i_algId Algorithm back to read from
* @param[out] o_digest Array to store PCR contents
* @param[in] i_digestSize Byte size of i_digest array
* @return errlHndl_t NULL if successful, otherwise a pointer to the
* error log.
*/
errlHndl_t tpmCmdPcrRead(TpmTarget* io_target,
TPM_Pcr i_pcr,
TPM_Alg_Id i_algId,
uint8_t* o_digest,
size_t i_digestSize);
/**
* @brief Send the TPM_CC_Create to the TPM
* @param[in] i_target the target TPM (must not be nullptr)
* @return nullptr if successful; non-nullptr if error
*
*/
errlHndl_t tpmCmdCreateAttestationKeys(TpmTarget* i_target);
/**
* @brief Send the TPM_CC_NV_Read command to the given TPM to read the AK
* certificate from its NVRAM
* @param[in] i_target the TPM target (must not be nullptr)
* @param[out] o_data the pointer to the data contained within NVRAM of the TPM
* @return nullptr on success; non-nullptr on error
*/
errlHndl_t tpmCmdReadAKCertificate(TpmTarget* i_target,
AKCertificate_t* o_data);
/**
* @brief Send the TPM_CC_Quote command to the given TPM to generate quote
* and signature information (returned in o_data)
* @param[in] i_target the TPM target (must not be nullptr)
* @param[in] i_masterNonce the 32-byte master nonce
* @param[out] o_data a pointer to the data structure containing the size of
* the quote data from the TPM and the actual data
* @return nullptr on success; non-nullptr on error
*/
errlHndl_t tpmCmdGenerateQuote(TpmTarget* i_target,
MasterTpmNonce_t* i_masterNonce,
QuoteDataOut* o_data);
/**
* @brief Send the TPM2_FlushContext command to the given TPM to remove
* transient objects
* @param[in] i_target the TPM target (must not be nullptr)
* @return nullptr on success; non-nullptr on error
*/
errlHndl_t tpmCmdFlushContext(TpmTarget* i_target);
#ifdef __cplusplus
} // end TRUSTEDBOOT namespace
#endif
#endif
|
