Esys_SequenceUpdate(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 NAME

Esys_SequenceUpdate — the ESAPI function for the TPM2_SequenceUpdate command.

Bestie, welcome to the Esys_SequenceUpdate(3) page from the Library Functions Manual. This is the whole vibe: one-call, async, and finish behavior for TPM2_SequenceUpdate, with every parameter and return code kept exactly where it belongs. 🎀

✨ SYNOPSIS

🧚 Functions

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)
TSS2_RC Esys_SequenceUpdate (ESYS_CONTEXT *esysContext, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer)
TSS2_RC Esys_SequenceUpdate_Finish (ESYS_CONTEXT *esysContext)

🦋 Detailed Description

Okay so this is the ESAPI function for invoking the TPM2_SequenceUpdate command — either as a one-call situation or in an asynchronous manner. Both lanes are covered, no cap. ✨

🎀 Function Documentation

🌸 TSS2_RC Esys_SequenceUpdate

TSS2_RC Esys_SequenceUpdate (ESYS_CONTEXT * esysContext, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER * buffer)

One-Call function for TPM2_SequenceUpdate. This function invokes the TPM2_SequenceUpdate command in a one-call variant. That means it 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. 💅

Parameters

  • esysContext — The ESYS_CONTEXT.
  • sequenceHandle — Handle for the sequence object.
  • shandle1 — Session handle for authorization of sequenceHandle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • buffer — Data to be added to hash.

Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers or required output handle references are NULL.
  • TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
  • TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous operation already pending.
  • TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not at least contain the tag, response length, and response code.
  • TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
  • TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did not verify.
  • TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the 'decrypt' attribute bit set.
  • TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the 'encrypt' attribute bit set.
  • 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_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_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🦋 TSS2_RC Esys_SequenceUpdate_Async

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)

Asynchronous function for TPM2_SequenceUpdate. This function invokes the TPM2_SequenceUpdate command in a asynchronous variant. That 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_SequenceUpdate_Finish. 🫶

Parameters

  • esysContext — The ESYS_CONTEXT.
  • sequenceHandle — Handle for the sequence object.
  • shandle1 — Session handle for authorization of sequenceHandle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • buffer — Data to be added to hash.

Return values

  • ESYS_RC_SUCCESS if the function call was a success.
  • TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers or required output handle references are NULL.
  • TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
  • TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.
  • TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the 'decrypt' attribute bit set.
  • TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the 'encrypt' attribute bit set.
  • 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_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_SequenceUpdate_Finish

TSS2_RC Esys_SequenceUpdate_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_SequenceUpdate. This function returns the results of a TPM2_SequenceUpdate command invoked via Esys_SequenceUpdate_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. 🧚

Parameters

  • esysContext — The ESYS_CONTEXT.

Return values

  • TSS2_RC_SUCCESS on success.
  • ESYS_RC_SUCCESS if the function call was a success.
  • TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers or required output handle references are NULL.
  • TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
  • TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for internal operations or return parameters.
  • TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous operation already pending.
  • TSS2_ESYS_RC_TRY_AGAIN if the timeout counter expires before the TPM response is received.
  • TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not at least contain the tag, response length, and response code.
  • TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did not verify.
  • TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
  • TSS2_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

👑 Author

Generated automatically by Doxygen for tpm2-tss from the source code. Iconic behavior, honestly. ✨

That’s the page, bestie — tpm2-tss, Version 4.1.5, Esys_SequenceUpdate(3). 💅🎀

📦 where this page comes from