Esys_Commit(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

🌸 NAME 🌸

Welcome to Esys_Commit(3), straight out of the Library Functions Manual — this is the ESAPI function for the TPM2_Commit command, and yes bestie, it's giving cryptography main character energy. 💅✨

✨ SYNOPSIS ✨

🦋 Functions 🦋

Okay so here are the three signatures, copy them exactly and do not freestyle the types, iykyk:

TSS2_RC Esys_Commit_Async (ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *P1, const TPM2B_SENSITIVE_DATA *s2, const TPM2B_ECC_PARAMETER *y2)
TSS2_RC Esys_Commit (ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *P1, const TPM2B_SENSITIVE_DATA *s2, const TPM2B_ECC_PARAMETER *y2, TPM2B_ECC_POINT **K, TPM2B_ECC_POINT **L, TPM2B_ECC_POINT **E, UINT16 *counter)
TSS2_RC Esys_Commit_Finish (ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **K, TPM2B_ECC_POINT **L, TPM2B_ECC_POINT **E, UINT16 *counter)

🦋 Detailed Description 🦋

This is the ESAPI function for invoking the TPM2_Commit command, either as a one-call situation or in an asynchronous manner. Two paths, same command, choose your vibe. 🌈

🔥 Function Documentation 🔥

💜 TSS2_RC Esys_Commit — One-Call function for TPM2_Commit 💜

Full signature, bestie:

TSS2_RC Esys_Commit (ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *P1, const TPM2B_SENSITIVE_DATA *s2, const TPM2B_ECC_PARAMETER *y2, TPM2B_ECC_POINT **K, TPM2B_ECC_POINT **L, TPM2B_ECC_POINT **E, UINT16 *counter)

This function invokes the TPM2_Commit command in a one-call variant. That means the function will block until the TPM response is available — no cap, it waits. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. Slay. ✨

Parameters

  • esysContext — the ESYS_CONTEXT.
  • signHandle — handle of the key that will be used in the signing operation.
  • shandle1 — session handle for authorization of signHandle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • P1 — a point (M) on the curve used by signHandle.
  • s2 — octet array used to derive x-coordinate of a base point.
  • y2 — Y coordinate of the point associated with s2.
  • K — ECC point K := [ds](x2, y2). (callee-allocated)
  • L — ECC point L := [r](x2, y2). (callee-allocated)
  • E — ECC point E := [r]P1. (callee-allocated)
  • counter — least-significant 16 bits of commitCount.

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_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

💖 TSS2_RC Esys_Commit_Async — Asynchronous function for TPM2_Commit 💖

Full signature:

TSS2_RC Esys_Commit_Async (ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *P1, const TPM2B_SENSITIVE_DATA *s2, const TPM2B_ECC_PARAMETER *y2)

This function invokes the TPM2_Commit command in an 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_Commit_Finish. It's giving "send it and circle back" energy. 🫶

Parameters

  • esysContext — the ESYS_CONTEXT.
  • signHandle — handle of the key that will be used in the signing operation.
  • shandle1 — session handle for authorization of signHandle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • P1 — a point (M) on the curve used by signHandle.
  • s2 — octet array used to derive x-coordinate of a base point.
  • y2 — Y coordinate of the point associated with s2.

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_RC Esys_Commit_Finish — Asynchronous finish function for TPM2_Commit 🎀

Full signature:

TSS2_RC Esys_Commit_Finish (ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **K, TPM2B_ECC_POINT **L, TPM2B_ECC_POINT **E, UINT16 *counter)

This function returns the results of a TPM2_Commit command invoked via Esys_Commit_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 — yes bestie, optional outputs said "take it or leave it." 💅

Parameters

  • esysContext — the ESYS_CONTEXT.
  • K — ECC point K := [ds](x2, y2). (callee-allocated)
  • L — ECC point L := [r](x2, y2). (callee-allocated)
  • E — ECC point E := [r]P1. (callee-allocated)
  • counter — least-significant 16 bits of commitCount.

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 it; I just gave it a wardrobe change and some glitter. 🤖💅✨

Cute little sign-off: this page is from tpm2-tss, Version 4.1.5 — and the footer does not list a separate date on this page, so that's the timestamp tea. Bye bestie, go commit some ECC math! 🫶💜🌸

📦 where this page comes from