Esys_ECC_Parameters(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

✨ Esys_ECC_Parameters ✨

okay so welcome to the Esys_ECC_Parameters(3) page, bestie 💅 this is the Library Functions Manual entry, and honestly? it's giving "one tiny command, three whole functions." stay with me 🫶

🌸 NAME 🌸

Esys_ECC_Parameters — the ESAPI function for the TPM2_ECC_Parameters command. that's it, that's the whole name section, she's concise 👑

🎀 SYNOPSIS 🎀

Functions

TSS2_RC Esys_ECC_Parameters_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE
    curveID)
TSS2_RC Esys_ECC_Parameters (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE
    curveID, TPMS_ALGORITHM_DETAIL_ECC **parameters)
TSS2_RC Esys_ECC_Parameters_Finish (ESYS_CONTEXT *esysContext,
    TPMS_ALGORITHM_DETAIL_ECC **parameters)

look at her, three signatures, zero notes 💀 copy these exactly, i'm serious, no renaming anything, that's an ick fr fr.

🦋 Detailed Description 🦋

so basically this is the ESAPI function that invokes the TPM2_ECC_Parameters command — and you get to pick your fighter: one-call style, or asynchronous style. iconic of her, honestly ⭐

💖 Function Documentation 💖

🌈 TSS2_RC Esys_ECC_Parameters (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID, TPMS_ALGORITHM_DETAIL_ECC ** parameters)

One-Call function for TPM2_ECC_Parameters — the "just do it and let me know when you're done" version 🫶

this function invokes the TPM2_ECC_Parameters command in a one-call variant. what that means, bestie: the function will block until the TPM response is available. she waits. patiently. main character energy 😌 all input parameters are const. and the memory for non-simple output parameters? allocated by the function implementation, not by you. slay, don't worry about it 💅

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • curveID — Parameter set selector.
  • parameters — ECC parameters for the selected curve. (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_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_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_ECC_Parameters_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID)

Asynchronous function for TPM2_ECC_Parameters — the "i sent the text, i'm not waiting for the reply" version 🙈

this function invokes the TPM2_ECC_Parameters command in a asynchronous variant (yes, "a asynchronous," we don't edit the queen's grammar 💀). what that means: the function returns as soon as the command has been sent downwards the stack to the TPM. all input parameters are const. to actually retrieve the TPM's response, you call Esys_ECC_Parameters_Finish. so like, she leaves you on read but she did call you back, iykyk 📱

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • curveID — Parameter set selector.

Return values

  • ESYS_RC_SUCCESS — if the function call was a success. (yes, this one really is written as ESYS_RC_SUCCESS — copy it exactly, bestie, don't "fix" her 🫶)
  • 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_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_ECC_Parameters_Finish (ESYS_CONTEXT * esysContext, TPMS_ALGORITHM_DETAIL_ECC ** parameters)

Asynchronous finish function for TPM2_ECC_Parameters — the "okay so what did they say" version ✨

this function returns the results of a TPM2_ECC_Parameters command invoked via Esys_ECC_Parameters_Finish. (yes — the docs literally say it's invoked via itself. we're not touching it, that's the canon text, periodt 💅) all non-simple output parameters are allocated by the function's implementation. and good news: NULL can be passed for every output parameter if the value is not required — she's flexible like that 👑

Parameters

  • esysContext — The ESYS_CONTEXT.
  • parameters — ECC parameters for the selected curve. (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.
⚠️ heads up: yes, the Finish list has both TSS2_RC_SUCCESS and ESYS_RC_SUCCESS in it. that's not a typo from me, that's what the page says. keep both, bestie 😭

👑 Author 👑

Generated automatically by Doxygen for tpm2-tss from the source code. so nobody wrote this page, a robot did, and honestly? she ate 🤖💅

and that's the whole page!! mwah 💖 this came from tpm2-tss, Version 4.1.5 — no date on the footer, so that's all we got, bestie 🎀 go forth and query those ECC parameters, slay 🔥

📦 where this page comes from