ESYS_INCREMENTALSELFTEST(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Esys_IncrementalSelfTest(3) — Library Functions Manual

okay so bestie, welcome to the ESAPI glow-up page for TPM2_IncrementalSelfTest — this is the Esys_IncrementalSelfTest(3) moment, and honestly? iconic. Let's get into it ✨

🌸 NAME 🌸

Esys_IncrementalSelfTest — the ESAPI function for the TPM2_IncrementalSelfTest command. that's the whole vibe. no notes. 💅

✨ SYNOPSIS ✨

🎀 Functions

TSS2_RC Esys_IncrementalSelfTest_Async (ESYS_CONTEXT *esysContext,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_ALG
    *toTest)
TSS2_RC Esys_IncrementalSelfTest (ESYS_CONTEXT *esysContext, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_ALG
    *toTest, TPML_ALG **toDoList)
TSS2_RC Esys_IncrementalSelfTest_Finish (ESYS_CONTEXT *esysContext,
    TPML_ALG **toDoList)

🦋 Detailed Description 🦋

it's the ESAPI function that lets you invoke the TPM2_IncrementalSelfTest command — either as a one-call situation (you get everything at once, main character energy) or in an asynchronous manner (send it off, come back later, lowkey mysterious). 🫶

👑 Function Documentation 👑

💖 TSS2_RC Esys_IncrementalSelfTest (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_ALG * toTest, TPML_ALG ** toDoList)

One-Call function for TPM2_IncrementalSelfTest ⭐

so this one invokes the TPM2_IncrementalSelfTest command in a one-call variant. translation: the function will block until the TPM response is available — yes, it's gonna sit there and wait, that's the whole point, hold space for it. 😌 All input parameters are const. and the memory for non-simple output parameters? allocated by the function implementation itself. so generous. not you having to do it. 💅

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • toTest — List of algorithms that should be tested.
  • toDoList — List of algorithms that need testing. (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. (iykyk 🔥)

🌈 TSS2_RC Esys_IncrementalSelfTest_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_ALG * toTest)

Asynchronous function for TPM2_IncrementalSelfTest 🦋

this is the async variant, and it's giving "I'll text you later" energy — the function returns as soon as the command has been sent downwards the stack to the TPM. it does not wait around. All input parameters are const. and when you actually want the TPM's response? that's when you call Esys_IncrementalSelfTest_Finish. team work makes the dream work fr fr. 💜

Parameters

  • esysContext — The ESYS_CONTEXT.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • toTest — List of algorithms that should be tested.

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_IncrementalSelfTest_Finish (ESYS_CONTEXT * esysContext, TPML_ALG ** toDoList)

Asynchronous finish function for TPM2_IncrementalSelfTest 🌸

the cleanup era!! this function returns the results of a TPM2_IncrementalSelfTest command invoked via Esys_IncrementalSelfTest_Finish. (yes, the manpage literally says that — it's naming itself, we love a self-referential queen. 👑) All non-simple output parameters are allocated by the function's implementation. and here's a tip: NULL can be passed for every output parameter if the value is not required. no pressure bestie. 🙈

Parameters

  • esysContext — The ESYS_CONTEXT.
  • toDoList — List of algorithms that need testing. (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.
⚠️ reminder that those TSS2_ESYS_RC_* codes are your vibe check failing — they mean something upstream said no. keep them close, don't ignore them.

🌟 Author 🌟

Generated automatically by Doxygen for tpm2-tss from the source code. yes, a robot wrote this, and honestly it ate. 🤖✨

and that's the page, bestie!! this whole thing came to you courtesy of tpm2-tss, Version 4.1.5 🫶 — go forth and incremental-self-test responsibly, mwah 💖🎀🦋

📦 where this page comes from