Esys_ZGen_2Phase(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💜 Esys_ZGen_2Phase — the TPM2_ZGen_2Phase ESAPI glow-up 💜

okay so bestie, this page lives in the Library Functions Manual for tpm2-tss, and it's literally all about Esys_ZGen_2Phase(3) — the ESAPI function that calls the TPM2_ZGen_2Phase command. no cap, that's the whole vibe. 🦋

✨ NAME ✨

Esys_ZGen_2Phase — the ESAPI function for the TPM2_ZGen_2Phase command. that's it, that's the name, she's iconic 💅

🌸 SYNOPSIS 🌸

🎀 Functions 🎀

TSS2_RC Esys_ZGen_2Phase_Async (ESYS_CONTEXT *esysContext, ESYS_TR keyA,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const
    TPM2B_ECC_POINT *inQsB, const TPM2B_ECC_POINT *inQeB,
    TPMI_ECC_KEY_EXCHANGE inScheme, UINT16 counter)
TSS2_RC Esys_ZGen_2Phase (ESYS_CONTEXT *esysContext, ESYS_TR keyA,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const
    TPM2B_ECC_POINT *inQsB, const TPM2B_ECC_POINT *inQeB,
    TPMI_ECC_KEY_EXCHANGE inScheme, UINT16 counter, TPM2B_ECC_POINT
    **outZ1, TPM2B_ECC_POINT **outZ2)
TSS2_RC Esys_ZGen_2Phase_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_ECC_POINT **outZ1, TPM2B_ECC_POINT **outZ2)

💫 Detailed Description 💫

okay so real talk: this is the ESAPI function you use to invoke the TPM2_ZGen_2Phase command — and you've got options, bestie. you can do it as a one-call situation (blocking, simple, cute) or in an asynchronous manner (fire it off and come back later, main character energy). ✨

🔥 Function Documentation 🔥

🧚 TSS2_RC Esys_ZGen_2Phase (ESYS_CONTEXT * esysContext, ESYS_TR keyA, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT * inQsB, const TPM2B_ECC_POINT * inQeB, TPMI_ECC_KEY_EXCHANGE inScheme, UINT16 counter, TPM2B_ECC_POINT ** outZ1, TPM2B_ECC_POINT ** outZ2) 🧚

One-Call function for TPM2_ZGen_2Phase — the "just do it all in one go" version. 💖

this function invokes the TPM2_ZGen_2Phase command in a one-call variant. what that means: the function will block until the TPM response is available, so like, sit tight, she's working on it. 😭 all input parameters are const. and the memory for non-simple output parameters is allocated by the function implementation — so the callee's got you, you don't have to malloc anything yourself. periodt.

🫶 Parameters 🫶

  • esysContext — The ESYS_CONTEXT.
  • keyA — handle of an unrestricted decryption key ECC.
  • shandle1 — session handle for authorization of keyA.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • inQsB — other party's static public key (Qs,B = (Xs,B, Ys,B)).
  • inQeB — other party's ephemeral public key (Qe,B = (Xe,B, Ye,B)).
  • inScheme — the key exchange scheme.
  • counter — value returned by TPM2_EC_Ephemeral().
  • outZ1 — X and Y coordinates of the computed value (scheme dependent). (callee-allocated)
  • outZ2 — X and Y coordinates of the second computed value (scheme dependent). (callee-allocated)

💀 Return values 💀

  • TSS2_RC_SUCCESS — if the function call was a success. slay. ✅
  • 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. one thing at a time, bestie.
  • 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. (iykyk) 🌀

🌈 TSS2_RC Esys_ZGen_2Phase_Async (ESYS_CONTEXT * esysContext, ESYS_TR keyA, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT * inQsB, const TPM2B_ECC_POINT * inQeB, TPMI_ECC_KEY_EXCHANGE inScheme, UINT16 counter) 🌈

Asynchronous function for TPM2_ZGen_2Phase — the "text you later" version. 🦋

this function invokes the TPM2_ZGen_2Phase command in an asynchronous variant. translation: the function will return as soon as the command has been sent downwards the stack to the TPM — she does not wait around. ✨ all input parameters are const. and in order to retrieve the TPM's response, you call Esys_ZGen_2Phase_Finish. don't forget, bestie, or you'll just be standing there with no results 😭

🫶 Parameters 🫶

  • esysContext — The ESYS_CONTEXT.
  • keyA — handle of an unrestricted decryption key ECC.
  • shandle1 — session handle for authorization of keyA.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • inQsB — other party's static public key (Qs,B = (Xs,B, Ys,B)).
  • inQeB — other party's ephemeral public key (Qe,B = (Xe,B, Ye,B)).
  • inScheme — the key exchange scheme.
  • counter — value returned by TPM2_EC_Ephemeral().

💀 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_ZGen_2Phase_Finish (ESYS_CONTEXT * esysContext, TPM2B_ECC_POINT ** outZ1, TPM2B_ECC_POINT ** outZ2) ⭐

Asynchronous finish function for TPM2_ZGen_2Phase — the "okay come back, here's your stuff" moment. 💖

this function returns the results of a TPM2_ZGen_2Phase command invoked via Esys_ZGen_2Phase_Finish. all non-simple output parameters are allocated by the function's implementation. and here's the cute part: NULL can be passed for every output parameter if the value is not required — so if you don't care about a value, just pass NULL and move on with your life. 🙈

🫶 Parameters 🫶

  • esysContext — The ESYS_CONTEXT.
  • outZ1 — X and Y coordinates of the computed value (scheme dependent). (callee-allocated)
  • outZ2 — X and Y coordinates of the second computed value (scheme dependent). (callee-allocated)

💀 Return values 💀

  • TSS2_RC_SUCCESS — on success. ✅
  • ESYS_RC_SUCCESS — if the function call was a success. ✅ (yes bestie, she's listed twice, that's just how the page is 💅)
  • 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.
ngl the return-value lists are long, but every single one of those codes matters — don't skip the vibe check on error handling, bestie 🫶

👑 Author 👑

generated automatically by Doxygen for tpm2-tss from the source code. she wrote herself, honestly iconic of her. 🎀

so yeah, that's the page 💅 — brought to you by tpm2-tss, Version 4.1.5, dated the day she shipped. go forth and call your TPM, bestie, you've got this 🌸🦋✨

📦 where this page comes from