Esys_TestParms(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

okay so this is Esys_TestParms(3) from the Library Functions Manual, and if you've ever wanted the ESAPI version of TPM2_TestParms to make sense, you're literally in the right place bestie 💖

✨ NAME ✨

Esys_TestParms — the ESAPI function for the TPM2_TestParms command. that's the whole vibe. 🎀

🌸 SYNOPSIS 🌸

Functions

TSS2_RC Esys_TestParms_Async (ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPMT_PUBLIC_PARMS *parameters)
TSS2_RC Esys_TestParms (ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPMT_PUBLIC_PARMS *parameters)
TSS2_RC Esys_TestParms_Finish (ESYS_CONTEXT *esysContext)

🦋 Detailed Description 🦋

this is the ESAPI function that invokes the TPM2_TestParms command, and it can do it either as a one-call situation or in an asynchronous manner. pick your main character energy 💅

👑 Function Documentation 👑

💜 TSS2_RC Esys_TestParms (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPMT_PUBLIC_PARMS * parameters)

one-call function for TPM2_TestParms. yes, she's the "do it all in one go" girlie 🫶

this function invokes the TPM2_TestParms command in a one-call variant. that means the function 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.
  • parameters — algorithm parameters to be validated.

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_TestParms_Async (ESYS_CONTEXT * esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPMT_PUBLIC_PARMS * parameters)

asynchronous function for TPM2_TestParms. she sends it and dips ✌️

this function invokes the TPM2_TestParms command in a asynchronous variant. that means the function 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_TestParms_Finish.

Parameters

  • esysContext — the ESYS_CONTEXT.
  • shandle1 — first session handle.
  • shandle2 — second session handle.
  • shandle3 — third session handle.
  • parameters — algorithm parameters to be validated.

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_TestParms_Finish (ESYS_CONTEXT * esysContext)

asynchronous finish function for TPM2_TestParms. the "okay bestie come back, what did the TPM say?" moment 💅

this function returns the results of a TPM2_TestParms command invoked via Esys_TestParms_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. iconic, honestly.

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. the robots wrote this one, bestie 🤖💖

and that's the whole page, periodt. from tpm2-tss, Version 4.1.5, and this iconic little manual page is Esys_TestParms(3) 🎀✨

📦 where this page comes from