/* SPDX-License-Identifier: BSD-2 */ /******************************************************************************* * Copyright 2017-2018, Fraunhofer SIT sponsored by Infineon Technologies AG * All rights reserved. ******************************************************************************/ #include "tss2_mu.h" #include "tss2_sys.h" #include "tss2_esys.h" #include "esys_types.h" #include "esys_iutil.h" #include "esys_mu.h" #define LOGMODULE esys #include "util/log.h" #include "util/aux_util.h" /** Store command parameters inside the ESYS_CONTEXT for use during _Finish */ static void store_input_parameters ( ESYS_CONTEXT *esysContext, ESYS_TR saveHandle) { esysContext->in.ContextSave.saveHandle = saveHandle; } /** One-Call function for TPM2_ContextSave * * This function invokes the TPM2_ContextSave command in a one-call * variant. This means the function will block until the TPM response is * available. All input parameters are const. The memory for non-simple output * parameters is allocated by the function implementation. * * @param[in,out] esysContext The ESYS_CONTEXT. * @param[in] saveHandle Handle of the resource to save. * @param[out] context . * (callee-allocated) * @retval TSS2_RC_SUCCESS if the function call was a success. * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input * pointers or required output handle references are NULL. * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected. * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for * internal operations or return parameters. * @retval TSS2_ESYS_RC_BAD_SEQUENCE: if the context has an asynchronous * operation already pending. * @retval TSS2_ESYS_RC_INSUFFICIENT_RESPONSE: if the TPM's response does not * at least contain the tag, response length, and response code. * @retval TSS2_ESYS_RC_MALFORMED_RESPONSE: if the TPM's response is corrupted. * @retval TSS2_ESYS_RC_RSP_AUTH_FAILED: if the response HMAC from the TPM did not verify. * @retval TSS2_ESYS_RC_BAD_TR: if any of the ESYS_TR objects are unknown * to the ESYS_CONTEXT or are of the wrong type or if required * ESYS_TR objects are ESYS_TR_NONE. * @retval TSS2_RCs produced by lower layers of the software stack may be * returned to the caller unaltered unless handled internally. */ TSS2_RC Esys_ContextSave( ESYS_CONTEXT *esysContext, ESYS_TR saveHandle, TPMS_CONTEXT **context) { TSS2_RC r; r = Esys_ContextSave_Async(esysContext, saveHandle); return_if_error(r, "Error in async function"); /* Set the timeout to indefinite for now, since we want _Finish to block */ int32_t timeouttmp = esysContext->timeout; esysContext->timeout = -1; /* * Now we call the finish function, until return code is not equal to * from TSS2_BASE_RC_TRY_AGAIN. * Note that the finish function may return TSS2_RC_TRY_AGAIN, even if we * have set the timeout to -1. This occurs for example if the TPM requests * a retransmission of the command via TPM2_RC_YIELDED. */ do { r = Esys_ContextSave_Finish(esysContext, context); /* This is just debug information about the reattempt to finish the command */ if ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN) LOG_DEBUG("A layer below returned TRY_AGAIN: %" PRIx32 " => resubmitting command", r); } while ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN); /* Restore the timeout value to the original value */ esysContext->timeout = timeouttmp; return_if_error(r, "Esys Finish"); return TSS2_RC_SUCCESS; } /** Asynchronous function for TPM2_ContextSave * * This function invokes the TPM2_ContextSave command in a asynchronous * variant. This means the function will return as soon as the command has been * sent downwards the stack to the TPM. All input parameters are const. * In order to retrieve the TPM's response call Esys_ContextSave_Finish. * * @param[in,out] esysContext The ESYS_CONTEXT. * @param[in] saveHandle Handle of the resource to save. * @retval ESYS_RC_SUCCESS if the function call was a success. * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input * pointers or required output handle references are NULL. * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected. * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for * internal operations or return parameters. * @retval TSS2_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally. * @retval TSS2_ESYS_RC_BAD_TR: if any of the ESYS_TR objects are unknown * to the ESYS_CONTEXT or are of the wrong type or if required * ESYS_TR objects are ESYS_TR_NONE. */ TSS2_RC Esys_ContextSave_Async( ESYS_CONTEXT *esysContext, ESYS_TR saveHandle) { TSS2_RC r; LOG_TRACE("context=%p, saveHandle=%"PRIx32 "", esysContext, saveHandle); RSRC_NODE_T *saveHandleNode; /* Check context, sequence correctness and set state to error for now */ if (esysContext == NULL) { LOG_ERROR("esyscontext is NULL."); return TSS2_ESYS_RC_BAD_REFERENCE; } r = iesys_check_sequence_async(esysContext); if (r != TSS2_RC_SUCCESS) return r; esysContext->state = _ESYS_STATE_INTERNALERROR; store_input_parameters(esysContext, saveHandle); /* Retrieve the metadata objects for provided handles */ r = esys_GetResourceObject(esysContext, saveHandle, &saveHandleNode); return_state_if_error(r, _ESYS_STATE_INIT, "saveHandle unknown."); /* Initial invocation of SAPI to prepare the command buffer with parameters */ r = Tss2_Sys_ContextSave_Prepare(esysContext->sys, (saveHandleNode == NULL) ? TPM2_RH_NULL : saveHandleNode->rsrc.handle); return_state_if_error(r, _ESYS_STATE_INIT, "SAPI Prepare returned error."); /* Trigger execution and finish the async invocation */ r = Tss2_Sys_ExecuteAsync(esysContext->sys); return_state_if_error(r, _ESYS_STATE_INTERNALERROR, "Finish (Execute Async)"); esysContext->state = _ESYS_STATE_SENT; return r; } /** Asynchronous finish function for TPM2_ContextSave * * This function returns the results of a TPM2_ContextSave command * invoked via Esys_ContextSave_Finish. All non-simple output parameters * are allocated by the function's implementation. NULL can be passed for every * output parameter if the value is not required. * * @param[in,out] esysContext The ESYS_CONTEXT. * @param[out] context . * (callee-allocated) * @retval TSS2_RC_SUCCESS on success * @retval ESYS_RC_SUCCESS if the function call was a success. * @retval TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input * pointers or required output handle references are NULL. * @retval TSS2_ESYS_RC_BAD_CONTEXT: if esysContext corruption is detected. * @retval TSS2_ESYS_RC_MEMORY: if the ESAPI cannot allocate enough memory for * internal operations or return parameters. * @retval TSS2_ESYS_RC_BAD_SEQUENCE: if the context has an asynchronous * operation already pending. * @retval TSS2_ESYS_RC_TRY_AGAIN: if the timeout counter expires before the * TPM response is received. * @retval TSS2_ESYS_RC_INSUFFICIENT_RESPONSE: if the TPM's response does not * at least contain the tag, response length, and response code. * @retval TSS2_ESYS_RC_RSP_AUTH_FAILED: if the response HMAC from the TPM did * not verify. * @retval TSS2_ESYS_RC_MALFORMED_RESPONSE: if the TPM's response is corrupted. * @retval TSS2_RCs produced by lower layers of the software stack may be * returned to the caller unaltered unless handled internally. */ TSS2_RC Esys_ContextSave_Finish( ESYS_CONTEXT *esysContext, TPMS_CONTEXT **context) { TPMS_CONTEXT *lcontext = NULL; TSS2_RC r; LOG_TRACE("context=%p, context=%p", esysContext, context); if (esysContext == NULL) { LOG_ERROR("esyscontext is NULL."); return TSS2_ESYS_RC_BAD_REFERENCE; } /* Check for correct sequence and set sequence to irregular for now */ if (esysContext->state != _ESYS_STATE_SENT) { LOG_ERROR("Esys called in bad sequence."); return TSS2_ESYS_RC_BAD_SEQUENCE; } esysContext->state = _ESYS_STATE_INTERNALERROR; /* Allocate memory for response parameters */ lcontext = calloc(sizeof(TPMS_CONTEXT), 1); if (lcontext == NULL) { return_error(TSS2_ESYS_RC_MEMORY, "Out of memory"); } /*Receive the TPM response and handle resubmissions if necessary. */ r = Tss2_Sys_ExecuteFinish(esysContext->sys, esysContext->timeout); if ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN) { LOG_DEBUG("A layer below returned TRY_AGAIN: %" PRIx32, r); esysContext->state = _ESYS_STATE_SENT; goto error_cleanup; } /* This block handle the resubmission of TPM commands given a certain set of * TPM response codes. */ if (r == TPM2_RC_RETRY || r == TPM2_RC_TESTING || r == TPM2_RC_YIELDED) { LOG_DEBUG("TPM returned RETRY, TESTING or YIELDED, which triggers a " "resubmission: %" PRIx32, r); if (esysContext->submissionCount >= _ESYS_MAX_SUBMISSIONS) { LOG_WARNING("Maximum number of (re)submissions has been reached."); esysContext->state = _ESYS_STATE_INIT; goto error_cleanup; } esysContext->state = _ESYS_STATE_RESUBMISSION; r = Esys_ContextSave_Async(esysContext, esysContext->in.ContextSave.saveHandle); if (r != TSS2_RC_SUCCESS) { LOG_WARNING("Error attempting to resubmit"); /* We do not set esysContext->state here but inherit the most recent * state of the _async function. */ goto error_cleanup; } r = TSS2_ESYS_RC_TRY_AGAIN; LOG_DEBUG("Resubmission initiated and returning RC_TRY_AGAIN."); goto error_cleanup; } /* The following is the "regular error" handling. */ if (iesys_tpm_error(r)) { LOG_WARNING("Received TPM Error"); esysContext->state = _ESYS_STATE_INIT; goto error_cleanup; } else if (r != TSS2_RC_SUCCESS) { LOG_ERROR("Received a non-TPM Error"); esysContext->state = _ESYS_STATE_INTERNALERROR; goto error_cleanup; } r = Tss2_Sys_ContextSave_Complete(esysContext->sys, lcontext); goto_state_if_error(r, _ESYS_STATE_INTERNALERROR, "Received error from SAPI unmarshaling" , error_cleanup); /* ESYS Special Handling Code: Extend the context with metadata of the object */ IESYS_CONTEXT_DATA esyscontextData; RSRC_NODE_T *esys_object; size_t offset = 0; esyscontextData.reserved = 0; memcpy(&esyscontextData.tpmContext.buffer[0], &(lcontext)->contextBlob.buffer[0], (lcontext)->contextBlob.size); esyscontextData.tpmContext.size = (lcontext)->contextBlob.size; r = esys_GetResourceObject(esysContext, esysContext->in.ContextSave.saveHandle, &esys_object); goto_if_error(r, "Error GetResourceObjectn", error_cleanup); esyscontextData.esysMetadata.size = 0; esyscontextData.esysMetadata.data = esys_object->rsrc; offset = 0; r = iesys_MU_IESYS_CONTEXT_DATA_Marshal(&esyscontextData, &(lcontext)->contextBlob.buffer[0], sizeof(TPMS_CONTEXT_DATA), &offset); goto_if_error(r, "while marshaling context ", error_cleanup); (lcontext)->contextBlob.size = offset; /* * If the ESYS_TR object being saved refers to a session, * the ESYS_TR object is invalidated. */ if (esys_object->rsrc.rsrcType == IESYSC_SESSION_RSRC) { r = Esys_TR_Close(esysContext, &esysContext->in.ContextSave.saveHandle); goto_if_error(r, "invalidate object", error_cleanup); } if (context != NULL) *context = lcontext; else SAFE_FREE(lcontext); esysContext->state = _ESYS_STATE_INIT; return TSS2_RC_SUCCESS; error_cleanup: SAFE_FREE(lcontext); return r; }