blob: 428aa24b42f01cc0376350d2f6d437d4f69ec2c7 [file] [log] [blame]
/*******************************************************************************
* Copyright 2017-2018, Fraunhofer SIT sponsored by Infineon Technologies AG
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
******************************************************************************/
#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"
/** Store command parameters inside the ESYS_CONTEXT for use during _finish */
/** One-Call function for TPM2_GetTestResult
*
* This function invokes the TPM2_GetTestResult 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] shandle1 First session handle.
* @param[in] shandle2 Second session handle.
* @param[in] shandle3 Third session handle.
* @param[out] outData (callee-allocated) Output parameter
* of type TPM2B_MAX_BUFFER. May be NULL if this value is not required.
* @param[out] testResult (callee-allocated) Output parameter
* of type TPM2_RC. May be NULL if this value is not required.
* @retval TSS2_RC_SUCCESS on success
* @retval TSS2_RC_BAD_SEQUENCE if context is not ready for this function
* \todo add further error RCs to documentation
*/
TSS2_RC
Esys_GetTestResult(
ESYS_CONTEXT *esysContext,
ESYS_TR shandle1,
ESYS_TR shandle2,
ESYS_TR shandle3,
TPM2B_MAX_BUFFER **outData,
TPM2_RC *testResult)
{
TSS2_RC r;
r = Esys_GetTestResult_async(esysContext,
shandle1,
shandle2,
shandle3);
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_GetTestResult_finish(esysContext,
outData,
testResult);
/* 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_GetTestResult
*
* This function invokes the TPM2_GetTestResult 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_GetTestResult_finish.
*
* @param[in,out] esysContext The ESYS_CONTEXT.
* @param[in] shandle1 First session handle.
* @param[in] shandle2 Second session handle.
* @param[in] shandle3 Third session handle.
* @retval TSS2_RC_SUCCESS on success
* @retval TSS2_RC_BAD_SEQUENCE if context is not ready for this function
* \todo add further error RCs to documentation
*/
TSS2_RC
Esys_GetTestResult_async(
ESYS_CONTEXT *esysContext,
ESYS_TR shandle1,
ESYS_TR shandle2,
ESYS_TR shandle3)
{
TSS2_RC r;
LOG_TRACE("context=%p",
esysContext);
TSS2L_SYS_AUTH_COMMAND auths;
/* 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;
/* Check and store input parameters */
r = check_session_feasibility(shandle1, shandle2, shandle3, 0);
return_state_if_error(r, _ESYS_STATE_INIT, "Check session usage");
/* Initial invocation of SAPI to prepare the command buffer with parameters */
r = Tss2_Sys_GetTestResult_Prepare(esysContext->sys);
return_state_if_error(r, _ESYS_STATE_INIT, "SAPI Prepare returned error.");
/* Calculate the cpHash Values */
r = init_session_tab(esysContext, shandle1, shandle2, shandle3);
return_state_if_error(r, _ESYS_STATE_INIT, "Initialize session resources");
iesys_compute_session_value(esysContext->session_tab[0], NULL, NULL);
iesys_compute_session_value(esysContext->session_tab[1], NULL, NULL);
iesys_compute_session_value(esysContext->session_tab[2], NULL, NULL);
/* Generate the auth values and set them in the SAPI command buffer */
r = iesys_gen_auths(esysContext, NULL, NULL, NULL, &auths);
return_state_if_error(r, _ESYS_STATE_INIT, "Error in computation of auth values");
esysContext->authsCount = auths.count;
r = Tss2_Sys_SetCmdAuths(esysContext->sys, &auths);
return_state_if_error(r, _ESYS_STATE_INIT, "SAPI error on SetCmdAuths");
/* 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_GetTestResult
*
* This function returns the results of a TPM2_GetTestResult command
* invoked via Esys_GetTestResult_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] outData (callee-allocated) Output parameter
* of type TPM2B_MAX_BUFFER. May be NULL if this value is not required.
* @param[out] testResult (callee-allocated) Output parameter
* of type TPM2_RC. May be NULL if this value is not required.
* @retval TSS2_RC_SUCCESS on success
* @retval TSS2_RC_BAD_SEQUENCE if context is not ready for this function.
* \todo add further error RCs to documentation
*/
TSS2_RC
Esys_GetTestResult_finish(
ESYS_CONTEXT *esysContext,
TPM2B_MAX_BUFFER **outData,
TPM2_RC *testResult)
{
TSS2_RC r;
LOG_TRACE("context=%p, outData=%p, testResult=%p",
esysContext, outData, testResult);
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 */
if (outData != NULL) {
*outData = calloc(sizeof(TPM2B_MAX_BUFFER), 1);
if (*outData == 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_GetTestResult_async(esysContext,
esysContext->session_type[0],
esysContext->session_type[1],
esysContext->session_type[2]);
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 (r != TSS2_RC_SUCCESS && (r & TSS2_RC_LAYER_MASK) == 0) {
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;
}
/*
* Now the verification of the response (hmac check) and if necessary the
* parameter decryption have to be done.
*/
r = iesys_check_response(esysContext);
goto_state_if_error(r, _ESYS_STATE_INTERNALERROR, "Error: check response",
error_cleanup);
/*
* After the verification of the response we call the complete function
* to deliver the result.
*/
r = Tss2_Sys_GetTestResult_Complete(esysContext->sys,
(outData != NULL) ? *outData : NULL,
testResult);
goto_state_if_error(r, _ESYS_STATE_INTERNALERROR, "Received error from SAPI"
" unmarshaling" ,error_cleanup);
esysContext->state = _ESYS_STATE_INIT;
return TSS2_RC_SUCCESS;
error_cleanup:
if (outData != NULL)
SAFE_FREE(*outData);
return r;
}