Esys_Event...ceComplete(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

okay so bestie, this is the Esys_Event...ceComplete(3) page from the Library Functions Manual, and it's literally all about Esys_EventSequenceComplete — the ESAPI function for the TPM2_EventSequenceComplete command. it's giving TPM realness, no cap 💅

🌸 NAME 🌸

Esys_EventSequenceComplete — the ESAPI function for the TPM2_EventSequenceComplete command. periodt.

✨ SYNOPSIS ✨

🦋 Functions 🦋

TSS2_RC Esys_EventSequenceComplete_Async (ESYS_CONTEXT *esysContext,
    ESYS_TR pcrHandle, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer)
TSS2_RC Esys_EventSequenceComplete (ESYS_CONTEXT *esysContext, ESYS_TR
    pcrHandle, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer,
    TPML_DIGEST_VALUES **results)
TSS2_RC Esys_EventSequenceComplete_Finish (ESYS_CONTEXT *esysContext,
    TPML_DIGEST_VALUES **results)

🎀 Detailed Description 🎀

ESAPI function to invoke the TPM2_EventSequenceComplete command either as a one-call or in an asynchronous manner. that's the whole vibe check: pick your lane, bestie 🫶

💖 Function Documentation 💖

🌟 Esys_EventSequenceComplete — the one-call bestie 🌟

TSS2_RC Esys_EventSequenceComplete (ESYS_CONTEXT * esysContext, ESYS_TR
    pcrHandle, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_MAX_BUFFER * buffer, TPML_DIGEST_VALUES **
    results)

One-Call function for TPM2_EventSequenceComplete ✨

This function invokes the TPM2_EventSequenceComplete command in a one-call variant. That 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. iconic behavior, honestly 👑

🍓 Parameters 🍓

  • esysContext — The ESYS_CONTEXT.
  • pcrHandle — PCR to be extended with the Event data.
  • sequenceHandle — Authorization for the sequence.
  • shandle1 — Session handle for authorization of pcrHandle
  • shandle2 — Session handle for authorization of sequenceHandle
  • shandle3 — Third session handle.
  • buffer — Data to be added to the Event.
  • results — List of digests computed for the PCR. (callee-allocated)

🌈 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.

🦋 Esys_EventSequenceComplete_Async — the async icon 🦋

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

Asynchronous function for TPM2_EventSequenceComplete ⚡

This function invokes the TPM2_EventSequenceComplete 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_EventSequenceComplete_Finish. it's giving send-it-and-circle-back energy, fr fr 💅

🍓 Parameters 🍓

  • esysContext — The ESYS_CONTEXT.
  • pcrHandle — PCR to be extended with the Event data.
  • sequenceHandle — Authorization for the sequence.
  • shandle1 — Session handle for authorization of pcrHandle
  • shandle2 — Session handle for authorization of sequenceHandle
  • shandle3 — Third session handle.
  • buffer — Data to be added to the Event.

🌈 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.

🧚 Esys_EventSequenceComplete_Finish — the finish-line fairy 🧚

TSS2_RC Esys_EventSequenceComplete_Finish (ESYS_CONTEXT * esysContext,
    TPML_DIGEST_VALUES ** results)

Asynchronous finish function for TPM2_EventSequenceComplete 🎀

This function returns the results of a TPM2_EventSequenceComplete command invoked via Esys_EventSequenceComplete_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. lowkey generous of it, honestly 🫶

🍓 Parameters 🍓

  • esysContext — The ESYS_CONTEXT.
  • results — List of digests computed for the PCR. (callee-allocated)

🌈 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. the robots wrote this one, bestie 🤖💖

okay that's the whole page! source/version from the footer: tpm2-tss, Version 4.1.5 — and the footer doesn't list a separate date, so no invented date, periodt. stay slay and may your TPM responses always verify 💖✨🌸

📦 where this page comes from