1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*******************************************************************************
3 * Copyright 2017-2018, Fraunhofer SIT sponsored by Infineon Technologies AG
4 * All rights reserved.
5 ******************************************************************************/
6
7 #ifdef HAVE_CONFIG_H
8 #include <config.h>
9 #endif
10
11 #include "tss2_mu.h"
12 #include "tss2_sys.h"
13 #include "tss2_esys.h"
14
15 #include "esys_types.h"
16 #include "esys_iutil.h"
17 #include "esys_mu.h"
18 #define LOGMODULE esys
19 #include "util/log.h"
20 #include "util/aux_util.h"
21
22 /** One-Call function for TPM2_SequenceUpdate
23 *
24 * This function invokes the TPM2_SequenceUpdate command in a one-call
25 * variant. This means the function will block until the TPM response is
26 * available. All input parameters are const. The memory for non-simple output
27 * parameters is allocated by the function implementation.
28 *
29 * @param[in,out] esysContext The ESYS_CONTEXT.
30 * @param[in] sequenceHandle Handle for the sequence object.
31 * @param[in] shandle1 Session handle for authorization of sequenceHandle
32 * @param[in] shandle2 Second session handle.
33 * @param[in] shandle3 Third session handle.
34 * @param[in] buffer Data to be added to hash.
35 * @retval TSS2_RC_SUCCESS if the function call was a success.
36 * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
37 * pointers or required output handle references are NULL.
38 * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected.
39 * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for
40 * internal operations or return parameters.
41 * @retval TSS2_ESYS_RC_BAD_SEQUENCE: if the context has an asynchronous
42 * operation already pending.
43 * @retval TSS2_ESYS_RC_INSUFFICIENT_RESPONSE: if the TPM's response does not
44 * at least contain the tag, response length, and response code.
45 * @retval TSS2_ESYS_RC_MALFORMED_RESPONSE: if the TPM's response is corrupted.
46 * @retval TSS2_ESYS_RC_RSP_AUTH_FAILED: if the response HMAC from the TPM
47 did not verify.
48 * @retval TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS: if more than one session has
49 * the 'decrypt' attribute bit set.
50 * @retval TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS: if more than one session has
51 * the 'encrypt' attribute bit set.
52 * @retval TSS2_ESYS_RC_BAD_TR: if any of the ESYS_TR objects are unknown
53 * to the ESYS_CONTEXT or are of the wrong type or if required
54 * ESYS_TR objects are ESYS_TR_NONE.
55 * @retval TSS2_ESYS_RC_NO_ENCRYPT_PARAM: if one of the sessions has the
56 * 'encrypt' attribute set and the command does not support encryption
57 * of the first response parameter.
58 * @retval TSS2_RCs produced by lower layers of the software stack may be
59 * returned to the caller unaltered unless handled internally.
60 */
61 TSS2_RC
Esys_SequenceUpdate(ESYS_CONTEXT * esysContext,ESYS_TR sequenceHandle,ESYS_TR shandle1,ESYS_TR shandle2,ESYS_TR shandle3,const TPM2B_MAX_BUFFER * buffer)62 Esys_SequenceUpdate(
63 ESYS_CONTEXT *esysContext,
64 ESYS_TR sequenceHandle,
65 ESYS_TR shandle1,
66 ESYS_TR shandle2,
67 ESYS_TR shandle3,
68 const TPM2B_MAX_BUFFER *buffer)
69 {
70 TSS2_RC r;
71
72 r = Esys_SequenceUpdate_Async(esysContext, sequenceHandle, shandle1,
73 shandle2, shandle3, buffer);
74 return_if_error(r, "Error in async function");
75
76 /* Set the timeout to indefinite for now, since we want _Finish to block */
77 int32_t timeouttmp = esysContext->timeout;
78 esysContext->timeout = -1;
79 /*
80 * Now we call the finish function, until return code is not equal to
81 * from TSS2_BASE_RC_TRY_AGAIN.
82 * Note that the finish function may return TSS2_RC_TRY_AGAIN, even if we
83 * have set the timeout to -1. This occurs for example if the TPM requests
84 * a retransmission of the command via TPM2_RC_YIELDED.
85 */
86 do {
87 r = Esys_SequenceUpdate_Finish(esysContext);
88 /* This is just debug information about the reattempt to finish the
89 command */
90 if ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN)
91 LOG_DEBUG("A layer below returned TRY_AGAIN: %" PRIx32
92 " => resubmitting command", r);
93 } while ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN);
94
95 /* Restore the timeout value to the original value */
96 esysContext->timeout = timeouttmp;
97 return_if_error(r, "Esys Finish");
98
99 return TSS2_RC_SUCCESS;
100 }
101
102 /** Asynchronous function for TPM2_SequenceUpdate
103 *
104 * This function invokes the TPM2_SequenceUpdate command in a asynchronous
105 * variant. This means the function will return as soon as the command has been
106 * sent downwards the stack to the TPM. All input parameters are const.
107 * In order to retrieve the TPM's response call Esys_SequenceUpdate_Finish.
108 *
109 * @param[in,out] esysContext The ESYS_CONTEXT.
110 * @param[in] sequenceHandle Handle for the sequence object.
111 * @param[in] shandle1 Session handle for authorization of sequenceHandle
112 * @param[in] shandle2 Second session handle.
113 * @param[in] shandle3 Third session handle.
114 * @param[in] buffer Data to be added to hash.
115 * @retval ESYS_RC_SUCCESS if the function call was a success.
116 * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
117 * pointers or required output handle references are NULL.
118 * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected.
119 * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for
120 * internal operations or return parameters.
121 * @retval TSS2_RCs produced by lower layers of the software stack may be
122 returned to the caller unaltered unless handled internally.
123 * @retval TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS: if more than one session has
124 * the 'decrypt' attribute bit set.
125 * @retval TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS: if more than one session has
126 * the 'encrypt' attribute bit set.
127 * @retval TSS2_ESYS_RC_BAD_TR: if any of the ESYS_TR objects are unknown
128 * to the ESYS_CONTEXT or are of the wrong type or if required
129 * ESYS_TR objects are ESYS_TR_NONE.
130 * @retval TSS2_ESYS_RC_NO_ENCRYPT_PARAM: if one of the sessions has the
131 * 'encrypt' attribute set and the command does not support encryption
132 * of the first response parameter.
133 */
134 TSS2_RC
Esys_SequenceUpdate_Async(ESYS_CONTEXT * esysContext,ESYS_TR sequenceHandle,ESYS_TR shandle1,ESYS_TR shandle2,ESYS_TR shandle3,const TPM2B_MAX_BUFFER * buffer)135 Esys_SequenceUpdate_Async(
136 ESYS_CONTEXT *esysContext,
137 ESYS_TR sequenceHandle,
138 ESYS_TR shandle1,
139 ESYS_TR shandle2,
140 ESYS_TR shandle3,
141 const TPM2B_MAX_BUFFER *buffer)
142 {
143 TSS2_RC r;
144 LOG_TRACE("context=%p, sequenceHandle=%"PRIx32 ", buffer=%p",
145 esysContext, sequenceHandle, buffer);
146 TSS2L_SYS_AUTH_COMMAND auths;
147 RSRC_NODE_T *sequenceHandleNode;
148
149 /* Check context, sequence correctness and set state to error for now */
150 if (esysContext == NULL) {
151 LOG_ERROR("esyscontext is NULL.");
152 return TSS2_ESYS_RC_BAD_REFERENCE;
153 }
154 r = iesys_check_sequence_async(esysContext);
155 if (r != TSS2_RC_SUCCESS)
156 return r;
157 esysContext->state = _ESYS_STATE_INTERNALERROR;
158
159 /* Check input parameters */
160 r = check_session_feasibility(shandle1, shandle2, shandle3, 1);
161 return_state_if_error(r, _ESYS_STATE_INIT, "Check session usage");
162
163 /* Retrieve the metadata objects for provided handles */
164 r = esys_GetResourceObject(esysContext, sequenceHandle, &sequenceHandleNode);
165 return_state_if_error(r, _ESYS_STATE_INIT, "sequenceHandle unknown.");
166
167 /* Initial invocation of SAPI to prepare the command buffer with parameters */
168 r = Tss2_Sys_SequenceUpdate_Prepare(esysContext->sys,
169 (sequenceHandleNode == NULL)
170 ? TPM2_RH_NULL
171 : sequenceHandleNode->rsrc.handle,
172 buffer);
173 return_state_if_error(r, _ESYS_STATE_INIT, "SAPI Prepare returned error.");
174
175 /* Calculate the cpHash Values */
176 r = init_session_tab(esysContext, shandle1, shandle2, shandle3);
177 return_state_if_error(r, _ESYS_STATE_INIT, "Initialize session resources");
178 if (sequenceHandleNode != NULL)
179 iesys_compute_session_value(esysContext->session_tab[0],
180 &sequenceHandleNode->rsrc.name, &sequenceHandleNode->auth);
181 else
182 iesys_compute_session_value(esysContext->session_tab[0], NULL, NULL);
183
184 iesys_compute_session_value(esysContext->session_tab[1], NULL, NULL);
185 iesys_compute_session_value(esysContext->session_tab[2], NULL, NULL);
186
187 /* Generate the auth values and set them in the SAPI command buffer */
188 r = iesys_gen_auths(esysContext, sequenceHandleNode, NULL, NULL, &auths);
189 return_state_if_error(r, _ESYS_STATE_INIT,
190 "Error in computation of auth values");
191
192 esysContext->authsCount = auths.count;
193 if (auths.count > 0) {
194 r = Tss2_Sys_SetCmdAuths(esysContext->sys, &auths);
195 return_state_if_error(r, _ESYS_STATE_INIT, "SAPI error on SetCmdAuths");
196 }
197
198 /* Trigger execution and finish the async invocation */
199 r = Tss2_Sys_ExecuteAsync(esysContext->sys);
200 return_state_if_error(r, _ESYS_STATE_INTERNALERROR,
201 "Finish (Execute Async)");
202
203 esysContext->state = _ESYS_STATE_SENT;
204
205 return r;
206 }
207
208 /** Asynchronous finish function for TPM2_SequenceUpdate
209 *
210 * This function returns the results of a TPM2_SequenceUpdate command
211 * invoked via Esys_SequenceUpdate_Finish. All non-simple output parameters
212 * are allocated by the function's implementation. NULL can be passed for every
213 * output parameter if the value is not required.
214 *
215 * @param[in,out] esysContext The ESYS_CONTEXT.
216 * @retval TSS2_RC_SUCCESS on success
217 * @retval ESYS_RC_SUCCESS if the function call was a success.
218 * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input
219 * pointers or required output handle references are NULL.
220 * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected.
221 * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for
222 * internal operations or return parameters.
223 * @retval TSS2_ESYS_RC_BAD_SEQUENCE: if the context has an asynchronous
224 * operation already pending.
225 * @retval TSS2_ESYS_RC_TRY_AGAIN: if the timeout counter expires before the
226 * TPM response is received.
227 * @retval TSS2_ESYS_RC_INSUFFICIENT_RESPONSE: if the TPM's response does not
228 * at least contain the tag, response length, and response code.
229 * @retval TSS2_ESYS_RC_RSP_AUTH_FAILED: if the response HMAC from the TPM did
230 * not verify.
231 * @retval TSS2_ESYS_RC_MALFORMED_RESPONSE: if the TPM's response is corrupted.
232 * @retval TSS2_RCs produced by lower layers of the software stack may be
233 * returned to the caller unaltered unless handled internally.
234 */
235 TSS2_RC
Esys_SequenceUpdate_Finish(ESYS_CONTEXT * esysContext)236 Esys_SequenceUpdate_Finish(
237 ESYS_CONTEXT *esysContext)
238 {
239 TSS2_RC r;
240 LOG_TRACE("context=%p",
241 esysContext);
242
243 if (esysContext == NULL) {
244 LOG_ERROR("esyscontext is NULL.");
245 return TSS2_ESYS_RC_BAD_REFERENCE;
246 }
247
248 /* Check for correct sequence and set sequence to irregular for now */
249 if (esysContext->state != _ESYS_STATE_SENT &&
250 esysContext->state != _ESYS_STATE_RESUBMISSION) {
251 LOG_ERROR("Esys called in bad sequence.");
252 return TSS2_ESYS_RC_BAD_SEQUENCE;
253 }
254 esysContext->state = _ESYS_STATE_INTERNALERROR;
255
256 /*Receive the TPM response and handle resubmissions if necessary. */
257 r = Tss2_Sys_ExecuteFinish(esysContext->sys, esysContext->timeout);
258 if ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN) {
259 LOG_DEBUG("A layer below returned TRY_AGAIN: %" PRIx32, r);
260 esysContext->state = _ESYS_STATE_SENT;
261 return r;
262 }
263 /* This block handle the resubmission of TPM commands given a certain set of
264 * TPM response codes. */
265 if (r == TPM2_RC_RETRY || r == TPM2_RC_TESTING || r == TPM2_RC_YIELDED) {
266 LOG_DEBUG("TPM returned RETRY, TESTING or YIELDED, which triggers a "
267 "resubmission: %" PRIx32, r);
268 if (esysContext->submissionCount++ >= _ESYS_MAX_SUBMISSIONS) {
269 LOG_WARNING("Maximum number of (re)submissions has been reached.");
270 esysContext->state = _ESYS_STATE_INIT;
271 return r;
272 }
273 esysContext->state = _ESYS_STATE_RESUBMISSION;
274 r = Tss2_Sys_ExecuteAsync(esysContext->sys);
275 if (r != TSS2_RC_SUCCESS) {
276 LOG_WARNING("Error attempting to resubmit");
277 /* We do not set esysContext->state here but inherit the most recent
278 * state of the _async function. */
279 return r;
280 }
281 r = TSS2_ESYS_RC_TRY_AGAIN;
282 LOG_DEBUG("Resubmission initiated and returning RC_TRY_AGAIN.");
283 return r;
284 }
285 /* The following is the "regular error" handling. */
286 if (iesys_tpm_error(r)) {
287 LOG_WARNING("Received TPM Error");
288 esysContext->state = _ESYS_STATE_INIT;
289 return r;
290 } else if (r != TSS2_RC_SUCCESS) {
291 LOG_ERROR("Received a non-TPM Error");
292 esysContext->state = _ESYS_STATE_INTERNALERROR;
293 return r;
294 }
295
296 /*
297 * Now the verification of the response (hmac check) and if necessary the
298 * parameter decryption have to be done.
299 */
300 r = iesys_check_response(esysContext);
301 return_state_if_error(r, _ESYS_STATE_INTERNALERROR,
302 "Error: check response");
303
304 /*
305 * After the verification of the response we call the complete function
306 * to deliver the result.
307 */
308 r = Tss2_Sys_SequenceUpdate_Complete(esysContext->sys);
309 return_state_if_error(r, _ESYS_STATE_INTERNALERROR,
310 "Received error from SAPI unmarshaling" );
311
312 esysContext->state = _ESYS_STATE_INIT;
313
314 return TSS2_RC_SUCCESS;
315 }
316