Esys_PolicySigned(3)

okay bestie, welcome to the Esys_PolicySigned(3) page from the Library Functions Manual — it’s giving very specific TPM policy-session energy, and we’re gonna get through every param, return code, and function shape together. 💅✨

✨ NAME ✨

Esys_PolicySigned — the ESAPI function for the TPM2_PolicySigned command. That’s the whole name situation, and yes, it’s iconic. 💅

🌸 SYNOPSIS 🌸

🧚 Functions 🧚

Here are the three function shapes, copied exactly so you can trust the vibes:

TSS2_RC Esys_PolicySigned_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    authObject, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA,
    const TPM2B_NONCE *policyRef, INT32 expiration, const TPMT_SIGNATURE *auth)
TSS2_RC Esys_PolicySigned (ESYS_CONTEXT *esysContext, ESYS_TR
    authObject, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA,
    const TPM2B_NONCE *policyRef, INT32 expiration, const TPMT_SIGNATURE *auth,
    TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket)
TSS2_RC Esys_PolicySigned_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket)

🦋 Detailed Description 🦋

ESAPI function to invoke the TPM2_PolicySigned command either as a one-call or in an asynchronous manner. Lowkey the whole page is about those two modes, bestie. ✨

💖 Function Documentation 💖

💅 TSS2_RC Esys_PolicySigned — One-Call function for TPM2_PolicySigned

TSS2_RC Esys_PolicySigned (ESYS_CONTEXT * esysContext, ESYS_TR authObject,
    ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR
    shandle3, const TPM2B_NONCE * nonceTPM, const TPM2B_DIGEST * cpHashA,
    const TPM2B_NONCE * policyRef, INT32 expiration, const TPMT_SIGNATURE *
    auth, TPM2B_TIMEOUT ** timeout, TPMT_TK_AUTH ** policyTicket)

This function invokes the TPM2_PolicySigned command in a one-call variant. This 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. So yeah, it waits for the TPM to answer — main character behavior, honestly. 👑

🌸 Parameters 🌸

• esysContext — the ESYS_CONTEXT. The context bestie in question. 🫶
• authObject — handle for a key that will validate the signature.
• policySession — handle for the policy session being extended.
• shandle1 — first session handle.
• shandle2 — second session handle.
• shandle3 — third session handle.
• nonceTPM — the policy nonce for the session.
• cpHashA — digest of the command parameters to which this authorization is limited.
• policyRef — a reference to a policy relating to the authorization.
  • may be the Empty Buffer.
• expiration — time when authorization will expire, measured in seconds from the time that nonceTPM was generated.
• auth — signed authorization (not optional). Not optional, bestie — it’s literally right there. 😭
• timeout — implementation-specific time value, used to indicate to the TPM when the ticket expires. (callee-allocated)
• policyTicket — produced if the command succeeds and expiration in the command was non-zero; this ticket will use the TPMT_ST_AUTH_SIGNED structure tag. See 23.2.5. (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_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_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

⚡ TSS2_RC Esys_PolicySigned_Async — Asynchronous function for TPM2_PolicySigned

TSS2_RC Esys_PolicySigned_Async (ESYS_CONTEXT * esysContext, ESYS_TR
    authObject, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_NONCE * nonceTPM, const TPM2B_DIGEST *
    cpHashA, const TPM2B_NONCE * policyRef, INT32 expiration, const
    TPMT_SIGNATURE * auth)

This function invokes the TPM2_PolicySigned command in a 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_PolicySigned_Finish. Yes bestie, it yeets the command down the stack and dips — then you come back with Finish for the answer. 🦋

🌸 Parameters 🌸

• esysContext — the ESYS_CONTEXT.
• authObject — handle for a key that will validate the signature.
• policySession — handle for the policy session being extended.
• shandle1 — first session handle.
• shandle2 — second session handle.
• shandle3 — third session handle.
• nonceTPM — the policy nonce for the session.
• cpHashA — digest of the command parameters to which this authorization is limited.
• policyRef — a reference to a policy relating to the authorization.
  • may be the Empty Buffer.
• expiration — time when authorization will expire, measured in seconds from the time that nonceTPM was generated.
• auth — signed authorization (not optional).

💜 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_RC Esys_PolicySigned_Finish — Asynchronous finish function for TPM2_PolicySigned

TSS2_RC Esys_PolicySigned_Finish (ESYS_CONTEXT * esysContext, TPM2B_TIMEOUT
    ** timeout, TPMT_TK_AUTH ** policyTicket)

This function returns the results of a TPM2_PolicySigned command invoked via Esys_PolicySigned_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. So if you don’t need a value, you can literally pass NULL — it’s giving flexible, lowkey luxurious. 🎀

🌸 Parameters 🌸

• esysContext — the ESYS_CONTEXT.
• timeout — implementation-specific time value, used to indicate to the TPM when the ticket expires. (callee-allocated)
• policyTicket — produced if the command succeeds and expiration in the command was non-zero; this ticket will use the TPMT_ST_AUTH_SIGNED structure tag. See 23.2.5. (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.

👑 Author 👑

Generated automatically by Doxygen for tpm2-tss from the source code. The robots made this one, bestie — iconic of them. 🤖💜

---

Final cute footer sign-off: source tpm2-tss, Version 4.1.5, and this is the Esys_PolicySigned(3) manual page. The footer doesn’t show a date, so I’m not inventing one — no cap. 🎀🫶