Esys_PolicyCommandCode(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

✨ NAME ✨

Esys_PolicyCommandCode — the ESAPI function for the TPM2_PolicyCommandCode command, bestie 💅 (this is a page from the Library Functions Manual, and we're about to make it make sense)

💖 SYNOPSIS 💖

Functions

TSS2_RC Esys_PolicyCommandCode_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPM2_CC code)
TSS2_RC Esys_PolicyCommandCode (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPM2_CC code)
TSS2_RC Esys_PolicyCommandCode_Finish (ESYS_CONTEXT *esysContext)

🌸 Detailed Description 🌸

Okay so this is the ESAPI function that lets you invoke the TPM2_PolicyCommandCode command — and the vibe is that you can do it either as a one-call situation or in an asynchronous manner. Choose your fighter, both are valid 🫶

🎀 Function Documentation 🎀

TSS2_RC Esys_PolicyCommandCode (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CC code)

One-Call function for TPM2_PolicyCommandCode ✨

This function invokes the TPM2_PolicyCommandCode command in a one-call variant. Translation, bestie: the function will block until the TPM response is available — it is not about to ghost you, it's gonna wait right there 😭. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. Periodt.

Parameters

  • esysContext — The ESYS_CONTEXT. (the main character context, lowkey essential)
  • policySession — Handle for the policy session being extended.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • code — The allowed commandCode. 👑

Return values

  • TSS2_RC_SUCCESS — if the function call was a success. slay 🎉
  • 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_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_PolicyCommandCode_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CC code)

Asynchronous function for TPM2_PolicyCommandCode 🦋

This function invokes the TPM2_PolicyCommandCode command in an asynchronous variant. Meaning: it will return as soon as the command has been sent downwards the stack to the TPM — no waiting around, she has places to be 💨. All input parameters are const. In order to retrieve the TPM's response call Esys_PolicyCommandCode_Finish. Don't forget the finish, bestie, or you'll just have vibes and no results 🙈

Parameters

  • esysContext — The ESYS_CONTEXT.
  • policySession — Handle for the policy session being extended.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • code — The allowed commandCode. 👑

Return values

  • ESYS_RC_SUCCESS — if the function call was a success. (yes, it's written ESYS_RC_SUCCESS here, not TSS2_RC_SUCCESS — we keep it exactly as the page says, no cap)
  • 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_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_PolicyCommandCode_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_PolicyCommandCode 🧚

This function returns the results of a TPM2_PolicyCommandCode command invoked via Esys_PolicyCommandCode_Finish. (Yep — the page literally says Esys_PolicyCommandCode_Finish right there, so we're keeping it exactly, even though the async crowd knows the call that starts it is the _Async one. Facts are facts, bestie.) 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 "no thoughts, head empty, don't need that output" of you 💅

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. Iconic behavior, honestly 🌈

Okay bestie, that's the whole page — every flag, every return value, every little const detail, all kept safe and sound 🫶 Now go forth and policy-command-code responsibly. 💜

tpm2-tss — Version 4.1.5 🎀 Esys_PolicyCommandCode(3), signing off ✨💖

📦 where this page comes from