text: /*******************************************************************************
   * 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 */
  static void store_input_parameters (
      ESYS_CONTEXT *esysContext,
      ESYS_TR auth,
      ESYS_TR objectHandle,
      TPMI_DH_PERSISTENT persistentHandle)
  {
      esysContext->in.EvictControl.auth = auth;
      esysContext->in.EvictControl.objectHandle = objectHandle;
      esysContext->in.EvictControl.persistentHandle = persistentHandle;
  }
  
  /** One-Call function for TPM2_EvictControl
   *
   * This function invokes the TPM2_EvictControl 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]  auth TPM2_RH_OWNER or TPM2_RH_PLATFORM+{PP}.
   * @param[in]  objectHandle The handle of a loaded object.
   * @param[in]  shandle1 Session handle for authorization of auth
   * @param[in]  shandle2 Second session handle.
   * @param[in]  shandle3 Third session handle.
   * @param[in]  persistentHandle If objectHandle is a transient object handle, then
   *             this is the persistent handle for the object.
   * @param[out] newObjectHandle  ESYS_TR handle of ESYS resource for TPM2_HANDLE.
   * @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_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_MULTIPLE_DECRYPT_SESSIONS: if more than one session has
   *         the 'decrypt' attribute bit set.
   * @retval TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS: if more than one session has
   *         the 'encrypt' attribute bit set.
   * @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_ESYS_RC_NO_DECRYPT_PARAM: if one of the sessions has the
   *         'decrypt' attribute set and the command does not support encryption
   *         of the first command parameter.
   * @retval TSS2_ESYS_RC_NO_ENCRYPT_PARAM: if one of the sessions has the
   *         'encrypt' attribute set and the command does not support encryption
   *          of the first response parameter.
   * @retval TSS2_RCs produced by lower layers of the software stack may be
   *         returned to the caller unaltered unless handled internally.
   */
  TSS2_RC
  Esys_EvictControl(
      ESYS_CONTEXT *esysContext,
      ESYS_TR auth,
      ESYS_TR objectHandle,
      ESYS_TR shandle1,
      ESYS_TR shandle2,
      ESYS_TR shandle3,
      TPMI_DH_PERSISTENT persistentHandle,
      ESYS_TR *newObjectHandle)
  {
      TSS2_RC r;
  
      r = Esys_EvictControl_Async(esysContext,
                  auth,
                  objectHandle,
                  shandle1,
                  shandle2,
                  shandle3,
                  persistentHandle);
      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_EvictControl_Finish(esysContext,
                  newObjectHandle);
          /* 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_EvictControl
   *
   * This function invokes the TPM2_EvictControl 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_EvictControl_Finish.
   *
   * @param[in,out] esysContext The ESYS_CONTEXT.
   * @param[in]  auth TPM2_RH_OWNER or TPM2_RH_PLATFORM+{PP}.
   * @param[in]  objectHandle The handle of a loaded object.
   * @param[in]  shandle1 Session handle for authorization of auth
   * @param[in]  shandle2 Second session handle.
   * @param[in]  shandle3 Third session handle.
   * @param[in]  persistentHandle If objectHandle is a transient object handle, then
   *             this is the persistent handle for the object.
   * @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_MULTIPLE_DECRYPT_SESSIONS: if more than one session has
   *         the 'decrypt' attribute bit set.
   * @retval TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS: if more than one session has
   *         the 'encrypt' attribute bit set.
   * @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_ESYS_RC_NO_DECRYPT_PARAM: if one of the sessions has the
   *         'decrypt' attribute set and the command does not support encryption
   *         of the first command parameter.
   * @retval TSS2_ESYS_RC_NO_ENCRYPT_PARAM: if one of the sessions has the
   *         'encrypt' attribute set and the command does not support encryption
   *          of the first response parameter.
   */
  TSS2_RC
  Esys_EvictControl_Async(
      ESYS_CONTEXT *esysContext,
      ESYS_TR auth,
      ESYS_TR objectHandle,
      ESYS_TR shandle1,
      ESYS_TR shandle2,
      ESYS_TR shandle3,
      TPMI_DH_PERSISTENT persistentHandle)
  {
      TSS2_RC r;
      LOG_TRACE("context=%p, auth=%"PRIx32 ", objectHandle=%"PRIx32 ","
                "persistentHandle=%"PRIx32 "",
                esysContext, auth, objectHandle, persistentHandle);
      TSS2L_SYS_AUTH_COMMAND auths;
      RSRC_NODE_T *authNode;
      RSRC_NODE_T *objectHandleNode;
  
      /* 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, 1);
      return_state_if_error(r, _ESYS_STATE_INIT, "Check session usage");
      store_input_parameters(esysContext, auth, objectHandle,
                  persistentHandle);
  
      /* Retrieve the metadata objects for provided handles */
      r = esys_GetResourceObject(esysContext, auth, &authNode);
      return_state_if_error(r, _ESYS_STATE_INIT, "auth unknown.");
      r = esys_GetResourceObject(esysContext, objectHandle, &objectHandleNode);
      return_state_if_error(r, _ESYS_STATE_INIT, "objectHandle unknown.");
       /* Use resource handle if object is already persistent */
       if (objectHandleNode != NULL &&
           iesys_get_handle_type(objectHandleNode->rsrc.handle) == TPM2_HT_PERSISTENT) {
           persistentHandle = objectHandleNode->rsrc.handle;
      }
  
      /* Initial invocation of SAPI to prepare the command buffer with parameters */
      r = Tss2_Sys_EvictControl_Prepare(esysContext->sys,
                  (authNode == NULL) ? TPM2_RH_NULL : authNode->rsrc.handle,
                  (objectHandleNode == NULL) ? TPM2_RH_NULL : objectHandleNode->rsrc.handle,
                  persistentHandle);
      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],
                  &authNode->rsrc.name, &authNode->auth);
      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, authNode, objectHandleNode, 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_EvictControl
   *
   * This function returns the results of a TPM2_EvictControl command
   * invoked via Esys_EvictControl_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] newObjectHandle  ESYS_TR handle of ESYS resource for TPM2_HANDLE.
   * @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_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_EvictControl_Finish(
      ESYS_CONTEXT *esysContext,
      ESYS_TR *newObjectHandle)
  {
      TSS2_RC r;
      LOG_TRACE("context=%p, newObjectHandle=%p",
                esysContext, newObjectHandle);
  
      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;
      RSRC_NODE_T *newObjectHandleNode = NULL;
  
      /* Allocate memory for response parameters */
      if (newObjectHandle == NULL) {
          LOG_ERROR("Handle newObjectHandle may not be NULL");
          return TSS2_ESYS_RC_BAD_REFERENCE;
      }
      *newObjectHandle = esysContext->esys_handle_cnt++;
      r = esys_CreateResourceObject(esysContext, *newObjectHandle, &newObjectHandleNode);
      if (r != TSS2_RC_SUCCESS)
          return r;
  
  
      /*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_EvictControl_Async(esysContext,
                  esysContext->in.EvictControl.auth,
                  esysContext->in.EvictControl.objectHandle,
                  esysContext->session_type[0],
                  esysContext->session_type[1],
                  esysContext->session_type[2],
                  esysContext->in.EvictControl.persistentHandle);
          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_EvictControl_Complete(esysContext->sys);
      goto_state_if_error(r, _ESYS_STATE_INTERNALERROR, "Received error from SAPI"
                          " unmarshaling" ,error_cleanup);
      ESYS_TR objectHandle = esysContext->in.EvictControl.objectHandle;
      RSRC_NODE_T *objectHandleNode;
      r = esys_GetResourceObject(esysContext, objectHandle, &objectHandleNode);
      goto_if_error(r, "get resource", error_cleanup);
  
      /* The object was already persistent */
      if (iesys_get_handle_type(objectHandleNode->rsrc.handle) == TPM2_HT_PERSISTENT) {
          *newObjectHandle = ESYS_TR_NONE;
      } else {
          /* A new resource is created and updated with date from the not persistent object */
          RSRC_NODE_T *newObjectHandleNode = NULL;
          *newObjectHandle = esysContext->esys_handle_cnt++;
          r = esys_CreateResourceObject(esysContext, *newObjectHandle, &newObjectHandleNode);
          if (r != TSS2_RC_SUCCESS)
              return r;
          newObjectHandleNode->rsrc = objectHandleNode->rsrc;
          newObjectHandleNode->rsrc.handle = esysContext->in.EvictControl.persistentHandle;
      }
      esysContext->state = _ESYS_STATE_INIT;
  
      return TSS2_RC_SUCCESS;
  
  error_cleanup:
      Esys_TR_Close(esysContext, newObjectHandle);
  
      return r;
  }
  