Esys_EC_Ephemeral(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

🌸 Esys_EC_Ephemeral — the ESAPI glow-up for the TPM2_EC_Ephemeral command 💅

okay so bestie, this is the Esys_EC_Ephemeral(3) page from the tpm2-tss library manual, and it's literally the ESAPI wrapper for the TPM2_EC_Ephemeral command. she's serving cryptography realness and i'm obsessed 🎀

✨ SYNOPSIS ✨

Functions

TSS2_RC Esys_EC_Ephemeral_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE
    curveID)
TSS2_RC Esys_EC_Ephemeral (ESYS_CONTEXT *esysContext, ESYS_TR shandle1,
    ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID,
    TPM2B_ECC_POINT **Q, UINT16 *counter)
TSS2_RC Esys_EC_Ephemeral_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_ECC_POINT **Q, UINT16 *counter)

🦋 Detailed Description 🦋

so what this is, is an ESAPI function that lets you invoke the TPM2_EC_Ephemeral command — and the way it does it? you get two vibes to choose from: either as a one-call (do everything at once, main character energy) or in an asynchronous manner (send it and dip, come back later). pick your fighter, both slay 💖

👑 Function Documentation 👑

🌈 TSS2_RC Esys_EC_Ephemeral (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID, TPM2B_ECC_POINT ** Q, UINT16 * counter)

One-Call function for TPM2_EC_Ephemeral — the "do it all in one go" icon ⭐

This function invokes the TPM2_EC_Ephemeral command in a one-call variant. Translation? the function will block until the TPM response is available — like, she waits, patiently, no cap. All input parameters are const (promise she won't touch ur stuff 🙈). And the memory for non-simple output parameters is allocated by the function implementation, so you don't have to do the malloc-ing yourself, periodt 💅

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • curveID — The curve for the computed ephemeral point .
  • Q — Ephemeral public key Q := [r]G. (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_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.
  • TSS2_RCs produced by lower layers of the software stack — may be returned to the caller unaltered unless handled internally.

🧚 TSS2_RC Esys_EC_Ephemeral_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID)

Asynchronous function for TPM2_EC_Ephemeral — the "send it and ghost" queen 🦋

This function invokes the TPM2_EC_Ephemeral command in a asynchronous variant. Which means the function will return as soon as the command has been sent downwards the stack to the TPM — she does NOT wait around, she has places to be. All input parameters are const. And in order to retrieve the TPM's response, you gotta call Esys_EC_Ephemeral_Finish. that's the whole deal, iykyk 💜

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • curveID — The curve for the computed ephemeral point .

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_DECRYPT_PARAM — if one of the sessions has the 'decrypt' attribute set and the command does not support encryption of the first command parameter.

🍓 TSS2_RC Esys_EC_Ephemeral_Finish (ESYS_CONTEXT * esysContext, TPM2B_ECC_POINT ** Q, UINT16 * counter)

Asynchronous finish function for TPM2_EC_Ephemeral — the "so… what did she say?" follow-up text 😭

This function returns the results of a TPM2_EC_Ephemeral command invoked via Esys_EC_Ephemeral_Finish. All non-simple output parameters are allocated by the function's implementation. and bestie, NULL can be passed for every output parameter if the value is not required — like, don't ask for what you don't need, boundaries are iconic 💅

ngl the original really does say "invoked via Esys_EC_Ephemeral_Finish" — yes, the finish function referencing itself, we don't make the rules, we just transcribe them faithfully 🫶

Parameters

  • esysContext — The ESYS_CONTEXT.
  • Q — Ephemeral public key Q := [r]G. (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. (not a human, just a very diligent little robot doing her thing 🤖✨)

and that's the page!! 🎀 source is tpm2-tss, Version 4.1.5, and the manual page itself is Esys_EC_Ephemeral(3) — love that for us, mwah 💖💅🫶

📦 where this page comes from