Esys_PolicyTicket(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 Esys_PolicyTicket(3) — the ESAPI glow-up for TPM2_PolicyTicket 💖

okay bestie, so this is a page from the tpm2-tss library manual, and it's literally all about Esys_PolicyTicket — the ESAPI function that lets you invoke the TPM2_PolicyTicket command. she's giving very much "security middleware main character energy" and honestly? we're obsessed. 🎀

✨ NAME ✨

Esys_PolicyTicket — the ESAPI function for the TPM2_PolicyTicket command. that's it, that's the vibe. 💅

🌸 SYNOPSIS 🌸

🦋 Functions

TSS2_RC Esys_PolicyTicket_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_TIMEOUT *timeout, const TPM2B_DIGEST *cpHashA, const
    TPM2B_NONCE *policyRef, const TPM2B_NAME *authName, const TPMT_TK_AUTH
    *ticket)
TSS2_RC Esys_PolicyTicket (ESYS_CONTEXT *esysContext, ESYS_TR
    policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_TIMEOUT *timeout, const TPM2B_DIGEST *cpHashA, const
    TPM2B_NONCE *policyRef, const TPM2B_NAME *authName, const TPMT_TK_AUTH
    *ticket)
TSS2_RC Esys_PolicyTicket_Finish (ESYS_CONTEXT *esysContext)

three whole functions, no cap. one-call, async, and the finish that wraps it up. 🫶

🌈 Detailed Description 🌈

so basically, this is the ESAPI function to invoke the TPM2_PolicyTicket command either as a one-call or in an asynchronous manner. that's the whole tea. ☕✨

👑 Function Documentation 👑

⭐ TSS2_RC Esys_PolicyTicket (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_TIMEOUT * timeout, const TPM2B_DIGEST * cpHashA, const TPM2B_NONCE * policyRef, const TPM2B_NAME * authName, const TPMT_TK_AUTH * ticket)

💫 One-Call function for TPM2_PolicyTicket

this one is the one-call variant, bestie — meaning it invokes the TPM2_PolicyTicket command and blocks until the TPM response is available. yeah, she waits. patient queen. 💅 all input parameters are const, and the memory for non-simple output parameters is allocated by the function implementation. iconic behavior honestly.

🌸 Parameters

  • esysContext — The ESYS_CONTEXT. the whole context of the situation, iykyk.
  • policySession — Handle for the policy session being extended. she's getting longer, fr fr.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • timeout — Time when authorization will expire. clock is ticking bestie ⏰
  • cpHashA — Digest of the command parameters to which this authorization is limited.
  • policyRef — Reference to a qualifier for the policy — may be the Empty Buffer. lowkey flexible.
  • authName — Name of the object that provided the authorization.
  • ticket — An authorization ticket returned by the TPM in response to a TPM2_PolicySigned() or TPM2_PolicySecret().

💀 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_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_PolicyTicket_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_TIMEOUT * timeout, const TPM2B_DIGEST * cpHashA, const TPM2B_NONCE * policyRef, const TPM2B_NAME * authName, const TPMT_TK_AUTH * ticket)

💜 Asynchronous function for TPM2_PolicyTicket

the async girlie of the group! this invokes the TPM2_PolicyTicket command in an asynchronous variant, meaning the function returns as soon as the command has been sent downwards the stack to the TPM — she does not wait around, she has places to be. 🦋 all input parameters are const. and to actually retrieve the TPM's response you gotta call Esys_PolicyTicket_Finish, okay? don't leave her hanging.

🌸 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.
  • timeout — Time when authorization will expire.
  • cpHashA — Digest of the command parameters to which this authorization is limited.
  • policyRef — Reference to a qualifier for the policy — may be the Empty Buffer.
  • authName — Name of the object that provided the authorization.
  • ticket — An authorization ticket returned by the TPM in response to a TPM2_PolicySigned() or TPM2_PolicySecret().

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

🔥 Asynchronous finish function for TPM2_PolicyTicket

the grand finale!! 🎬 this returns the results of a TPM2_PolicyTicket command invoked via Esys_PolicyTicket_Finish. yes, the manpage literally says Esys_PolicyTicket_Finish there — we're keeping it exactly as written, don't come for me. all non-simple output parameters are allocated by the function's implementation, and NULL can be passed for every output parameter if the value is not required. so chill, you don't have to want everything.

🌸 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. so no human wrote this one — the robot did it, and honestly it ate. 🤖💅

heads up bestie: this page is auto-generated documentation, so treat the source code as the real authority. no invented lore here, just what's on the page. 🫶

and that's the whole page!! 💖 mwah 💋 — this lil manual moment came to you from tpm2-tss, Version 4.1.5, dated alongside Esys_PolicyTicket(3). go forth and extend those policy sessions, queen. 👑✨

📦 where this page comes from