Esys_Vendor_TCG_Test(3)

👑 Esys_Vendor_TCG_Test(3) 👑

okay bestie, welcome to the Esys_Vendor_TCG_Test(3) page from the Library Functions Manual — manual name folded in near the top like a little name tag, periodt. This is the TPM2 vendor test ESAPI situation, and it's giving "one-call or async, pick your fighter." 💅

🌸 NAME 🌸

• Esys_Vendor_TCG_Test — The ESAPI function for the TPM2_Vendor_TCG_Test command.

✨ SYNOPSIS ✨

Functions

       TSS2_RC Esys_Vendor_TCG_Test_Async (ESYS_CONTEXT *esysContext, ESYS_TR
           shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA
           *inputData)
       TSS2_RC Esys_Vendor_TCG_Test (ESYS_CONTEXT *esysContext, ESYS_TR
           shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA
           *inputData, TPM2B_DATA **outputData)
       TSS2_RC Esys_Vendor_TCG_Test_Finish (ESYS_CONTEXT *esysContext,
           TPM2B_DATA **outputData)

💖 Detailed Description 💖

okay so this is the ESAPI function to invoke the TPM2_Vendor_TCG_Test command either as a one-call or in an asynchronous manner. Both paths, same command — choose your vibe. ✨

🎀 Function Documentation 🎀

TSS2_RC Esys_Vendor_TCG_Test (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA * inputData, TPM2B_DATA ** outputData)

One-Call function for TPM2_Vendor_TCG_Test. bestie, this is the one-call variant: it invokes the TPM2_Vendor_TCG_Test command and 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. 💅

Parameters

• esysContext — The ESYS_CONTEXT.
• shandle1 — First session handle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• inputData — Dummy data.
• outputData — Dummy data. (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_RCs produced by lower layers of the software stack — may be returned to the caller unaltered unless handled internally.

TSS2_RC Esys_Vendor_TCG_Test_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA * inputData)

Asynchronous function for TPM2_Vendor_TCG_Test. This invokes the TPM2_Vendor_TCG_Test command in an asynchronous variant. It returns 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_Vendor_TCG_Test_Finish. slay, no waiting around. 🦋

Parameters

• esysContext — The ESYS_CONTEXT.
• shandle1 — First session handle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• inputData — Dummy data.

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_RC Esys_Vendor_TCG_Test_Finish (ESYS_CONTEXT * esysContext, TPM2B_DATA ** outputData)

Asynchronous finish function for TPM2_Vendor_TCG_Test. This function returns the results of a TPM2_Vendor_TCG_Test command invoked via Esys_Vendor_TCG_Test_Finish. (Yes, bestie, that's literally the wording on the page — keeping it exactly.) 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. 🫶

Parameters

• esysContext — The ESYS_CONTEXT.
• outputData — Dummy data. (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. so yeah, the robots wrote it, not me. 😭

---

footer vibe check: source is tpm2-tss, version is Version 4.1.5; no separate date line is printed in the footer, so that's the whole cute sign-off. mwah 💋✨