Esys_SelfTest(3)

🦋 Esys_SelfTest(3) — Library Functions Manual 🦋

🌸 NAME 🌸

Esys_SelfTest — the ESAPI function for the TPM2_SelfTest command. That's the whole name, bestie, and it's kinda iconic — no cap. ✨

✨ SYNOPSIS ✨

🎀 Functions 🎀

TSS2_RC Esys_SelfTest_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO fullTest)
TSS2_RC Esys_SelfTest (ESYS_CONTEXT *esysContext, ESYS_TR shandle1,
    ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO fullTest)
TSS2_RC Esys_SelfTest_Finish (ESYS_CONTEXT *esysContext)

💖 Detailed Description 💖

ESAPI function to invoke the TPM2_SelfTest command either as a one-call or in an asynchronous manner. So yeah: you can either block and chill until the TPM answers, or yeet the command off and come back for the response later. Periodt. 🫶

🔥 Function Documentation 🔥

🌈 TSS2_RC Esys_SelfTest — One-Call function for TPM2_SelfTest 🌈

TSS2_RC Esys_SelfTest (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO fullTest)

This function invokes the TPM2_SelfTest command in a one-call variant. It's lowkey the impatient bestie: it will block until the TPM response is available — no ghosting, no "brb", just waiting. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. 💅

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.
• shandle1 — First session handle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• fullTest — YES if full test to be performed.

😭 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_SelfTest_Async — Asynchronous function for TPM2_SelfTest 🦋

TSS2_RC Esys_SelfTest_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO fullTest)

This function invokes the TPM2_SelfTest 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_SelfTest_Finish. 🫶

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.
• shandle1 — First session handle.
• shandle2 — Second session handle.
• shandle3 — Third session handle.
• fullTest — YES if full test to be performed.

😭 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_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_SelfTest_Finish — Asynchronous finish function for TPM2_SelfTest 🧚

TSS2_RC Esys_SelfTest_Finish (ESYS_CONTEXT * esysContext)

This function returns the results of a TPM2_SelfTest command invoked via Esys_SelfTest_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. 💅

💖 Parameters 💖

• esysContext — The ESYS_CONTEXT.

😭 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. 🫶

---

Bye bestie 💖 — this page is from tpm2-tss, Version 4.1.5, page Esys_SelfTest(3); the footer didn't bring a date, so no fake date energy here. ✨💅