Esys_PolicyPassword(3)

💅 Esys_PolicyPassword(3) 💅

okay bestie, you're looking at Esys_PolicyPassword(3) from the Library Functions Manual, and it's giving ESAPI wrapper for the TPM2_PolicyPassword command. We're keeping every parameter, every return code, and every literal detail — no cap. 🫶

---

🌸 NAME 🌸

Esys_PolicyPassword — the ESAPI function for the TPM2_PolicyPassword command. Short, iconic, done. ✨

✨ SYNOPSIS ✨

🎀 Functions 🎀

TSS2_RC Esys_PolicyPassword_Async (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_PolicyPassword (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_PolicyPassword_Finish (ESYS_CONTEXT *esysContext)

💫 Detailed Description 💫

ESAPI function to invoke the TPM2_PolicyPassword command either as a one-call or in an asynchronous manner. Literally the whole vibe: one-call mode or async mode, bestie. 💖

👑 Function Documentation 👑

🎀 TSS2_RC Esys_PolicyPassword (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 🎀

One-Call function for TPM2_PolicyPassword

okay so this one invokes the TPM2_PolicyPassword 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. It's the "just wait for it" girlie. ⏳

🧸 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.

🚨 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_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_PolicyPassword_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 🎀

Asynchronous function for TPM2_PolicyPassword

This function invokes the TPM2_PolicyPassword command in an asynchronous variant. This 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_PolicyPassword_Finish. It's giving "send it and come back later" energy. 🦋

🧸 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.

🚨 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_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_PolicyPassword_Finish (ESYS_CONTEXT * esysContext) 🎀

Asynchronous finish function for TPM2_PolicyPassword

This function returns the results of a TPM2_PolicyPassword command invoked via Esys_PolicyPassword_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. The finish-line moment, periodt. 🏁

🧸 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. 🤖💖

---

okay that's the whole page, bestie. It came from tpm2-tss, Version 4.1.5, and the footer labels this page Esys_PolicyPassword(3). There's no date printed in that footer, so I'm not inventing one — periodt. 💅✨