Esys_PolicyCounterTimer(3)

🎀 NAME 🎀

Bestie, welcome to the Esys_PolicyCounterTimer(3) page from the Library Functions Manual — it's the ESAPI function for the TPM2_PolicyCounterTimer command, and yes, it's giving secure-policy main character energy 💅✨

🌈 SYNOPSIS 🌈

✨ Functions ✨

Here are the three signatures, untouched and iconic:

TSS2_RC Esys_PolicyCounterTimer_Async (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND *operandB, UINT16 offset, TPM2_EO operation)
TSS2_RC Esys_PolicyCounterTimer (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND *operandB, UINT16 offset, TPM2_EO operation)
TSS2_RC Esys_PolicyCounterTimer_Finish (ESYS_CONTEXT *esysContext)

🦋 Detailed Description 🦋

This is the ESAPI function to invoke the TPM2_PolicyCounterTimer command either as a one-call or in an asynchronous manner. Both lanes are valid, bestie — pick your vibe ✨

👑 Function Documentation 👑

💖 TSS2_RC Esys_PolicyCounterTimer (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND * operandB, UINT16 offset, TPM2_EO operation) 💖

One-Call function for TPM2_PolicyCounterTimer — okay so this one invokes the TPM2_PolicyCounterTimer command in a one-call variant. That means it blocks until the TPM response is available, no ghosting, no “seen 2 hours ago” energy. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. Slay 🫶

🍓 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.
• operandB — The second operand.
• offset — The offset in TPMS_TIME_INFO structure for the start of operand A.
• operation — The comparison to make.

🌟 Return values 🌟

• TSS2_RC_SUCCESS — if the function call was a success. Periodt.
• 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_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_PolicyCounterTimer_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND * operandB, UINT16 offset, TPM2_EO operation) 💫

Asynchronous function for TPM2_PolicyCounterTimer — this invokes the TPM2_PolicyCounterTimer command in an asynchronous variant. It returns 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_PolicyCounterTimer_Finish. iykyk 😌

🍓 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.
• operandB — The second operand.
• offset — The offset in TPMS_TIME_INFO structure for the start of operand A.
• operation — The comparison to make.

🌟 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_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_PolicyCounterTimer_Finish (ESYS_CONTEXT * esysContext) 🧚

Asynchronous finish function for TPM2_PolicyCounterTimer — this function returns the results of a TPM2_PolicyCounterTimer command invoked via Esys_PolicyCounterTimer_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. No cap 🧢✨

🍓 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. Not me, but I respect the automation 💅🤖

---

Okay bestie, footer tea time: this page comes from tpm2-tss, Version 4.1.5, and it's the Esys_PolicyCounterTimer(3) page. No date line in this one — just the version and the page name, so that's the whole footer vibe. Bye, love you, go extend that policy session responsibly 💖✨🦋