Esys_HashSequenceStart(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 NAME 💖

okay so this is Esys_HashSequenceStart(3) from the Library Functions Manual, and it’s giving ESAPI function energy ✨ — specifically, the ESAPI function for the TPM2_HashSequenceStart command. Obsessed.

✨ SYNOPSIS ✨

Functions

TSS2_RC Esys_HashSequenceStart_Async (ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, TPMI_ALG_HASH hashAlg)
TSS2_RC Esys_HashSequenceStart (ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, TPMI_ALG_HASH hashAlg, ESYS_TR *sequenceHandle)
TSS2_RC Esys_HashSequenceStart_Finish (ESYS_CONTEXT *esysContext, ESYS_TR *sequenceHandle)

🌈 Detailed Description 🌈

ESAPI function to invoke the TPM2_HashSequenceStart command either as a one-call or in an asynchronous manner. Both flavors, bestie 🫶

🧚 Function Documentation 🧚

TSS2_RC Esys_HashSequenceStart (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH * auth, TPMI_ALG_HASH hashAlg, ESYS_TR * sequenceHandle)

One-Call function for TPM2_HashSequenceStart 💅

This function invokes the TPM2_HashSequenceStart 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. Blocking? iconic behavior. 😌

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • auth — Authorization value for subsequent use of the sequence.
  • hashAlg — The hash algorithm to use for the hash sequence.
  • sequenceHandle — ESYS_TR handle of ESYS resource for TPMI_DH_OBJECT.

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_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_HashSequenceStart_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH * auth, TPMI_ALG_HASH hashAlg)

Asynchronous function for TPM2_HashSequenceStart 🦋

This function invokes the TPM2_HashSequenceStart 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_HashSequenceStart_Finish. no waiting around, we’re moving ⚡

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • auth — Authorization value for subsequent use of the sequence.
  • hashAlg — The hash algorithm to use for the hash sequence.

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_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_HashSequenceStart_Finish (ESYS_CONTEXT * esysContext, ESYS_TR * sequenceHandle)

Asynchronous finish function for TPM2_HashSequenceStart 🎀

This function returns the results of a TPM2_HashSequenceStart command invoked via Esys_HashSequenceStart_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. flexible and polite, we love to see it 💖

Parameters

  • esysContext — The ESYS_CONTEXT.
  • sequenceHandle — ESYS_TR handle of ESYS resource for TPMI_DH_OBJECT.

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. slay, automation 🤖✨

okay that’s the whole page, bestie. Source/version: tpm2-tss, Version 4.1.5; footer label: Esys_HashSequenceStart(3); the original footer doesn’t show a separate date, so I’m not inventing one. Mwah 💋🎀

📦 where this page comes from