Esys_ECDH_ZGen(3)

💖 NAME 💖

Ok bestie, welcome to the Esys_ECDH_ZGen(3) page from the Library Functions Manual. This icon is Esys_ECDH_ZGen — the ESAPI function for the TPM2_ECDH_ZGen command. Periodt. 💅

✨ SYNOPSIS ✨

🫶 Functions

Here are the three function besties, signatures copied exactly because we do not play with code:

TSS2_RC Esys_ECDH_ZGen_Async (ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *inPoint)
TSS2_RC Esys_ECDH_ZGen (ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *inPoint, TPM2B_ECC_POINT **outPoint)
TSS2_RC Esys_ECDH_ZGen_Finish (ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **outPoint)

🦋 Detailed Description 🦋

This is the ESAPI function to invoke the TPM2_ECDH_ZGen command either as a one-call or in an asynchronous manner. Lowkey two modes, one icon. ✨

💜 Function Documentation 💜

🫶 TSS2_RC Esys_ECDH_ZGen — one-call bestie

Full signature, exactly:

TSS2_RC Esys_ECDH_ZGen (ESYS_CONTEXT * esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT * inPoint, TPM2B_ECC_POINT ** outPoint)

One-Call function for TPM2_ECDH_ZGen.

This function invokes the TPM2_ECDH_ZGen command in a one-call variant. Translation: it 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. No cap, that’s the deal. 💅

Parameters

• esysContext — The ESYS_CONTEXT.
• keyHandle — Handle of a loaded ECC key.
• shandle1 — Session handle for authorization of keyHandle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• inPoint — A public key.
• outPoint — X and Y coordinates of the product of the multiplication Z = (xZ , yZ) := [hdS]QB. (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_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🦋 TSS2_RC Esys_ECDH_ZGen_Async — async bestie

Full signature, exactly:

TSS2_RC Esys_ECDH_ZGen_Async (ESYS_CONTEXT * esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT * inPoint)

Asynchronous function for TPM2_ECDH_ZGen.

This function invokes the TPM2_ECDH_ZGen command in an asynchronous variant. It 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_ECDH_ZGen_Finish. Slay, non-blocking behavior. 🦋

Parameters

• esysContext — The ESYS_CONTEXT.
• keyHandle — Handle of a loaded ECC key.
• shandle1 — Session handle for authorization of keyHandle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• inPoint — A public key.

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_ECDH_ZGen_Finish — finish bestie

Full signature, exactly:

TSS2_RC Esys_ECDH_ZGen_Finish (ESYS_CONTEXT * esysContext, TPM2B_ECC_POINT ** outPoint)

Asynchronous finish function for TPM2_ECDH_ZGen.

This function returns the results of a TPM2_ECDH_ZGen command invoked via Esys_ECDH_ZGen_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. Very “you don’t have to collect everything, bestie” energy. 🎀

Parameters

• esysContext — The ESYS_CONTEXT.
• outPoint — X and Y coordinates of the product of the multiplication Z = (xZ , yZ) := [hdS]QB. (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. Slay, automation. 🤖✨

---

And that’s the tea, bestie! Footer vibes: tpm2-tss, Version 4.1.5, and page Esys_ECDH_ZGen(3). There’s no date line in the original footer, so I’m not inventing one — integrity only. 💖