Esys_PolicyAuthorize(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

🌸 NAME 🌸

Welcome to Esys_PolicyAuthorize(3) from the Library Functions Manual — yes bestie, we're doing TPM policy stuff and it's lowkey iconic ✨

Esys_PolicyAuthorize — the ESAPI function for the TPM2_PolicyAuthorize command. That's the whole vibe 💅

✨ SYNOPSIS ✨

🫶 Functions 🫶

TSS2_RC Esys_PolicyAuthorize_Async (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *approvedPolicy, const TPM2B_NONCE *policyRef, const TPM2B_NAME *keySign, const TPMT_TK_VERIFIED *checkTicket)
TSS2_RC Esys_PolicyAuthorize (ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *approvedPolicy, const TPM2B_NONCE *policyRef, const TPM2B_NAME *keySign, const TPMT_TK_VERIFIED *checkTicket)
TSS2_RC Esys_PolicyAuthorize_Finish (ESYS_CONTEXT *esysContext)

🌈 Detailed Description 🌈

It's an ESAPI function for calling the TPM2_PolicyAuthorize command, and you can do it either as a one-call situation or in an asynchronous manner. Two paths, same command, choose your fighter 💖

💜 Function Documentation 💜

💖 TSS2_RC Esys_PolicyAuthorize 💖

TSS2_RC Esys_PolicyAuthorize (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST * approvedPolicy, const TPM2B_NONCE * policyRef, const TPM2B_NAME * keySign, const TPMT_TK_VERIFIED * checkTicket)

This is the one-call function for TPM2_PolicyAuthorize. It invokes the command in a one-call variant, which means it 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. No cap, that's just how it works 🫶

🌸 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.
  • approvedPolicy — Digest of the policy being approved.
  • policyRef — A policy qualifier.
  • keySign — Name of a key that can sign a policy addition.
  • checkTicket — Ticket validating that approvedPolicy and policyRef were signed by keySign.

🎀 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_PolicyAuthorize_Async 🦋

TSS2_RC Esys_PolicyAuthorize_Async (ESYS_CONTEXT * esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST * approvedPolicy, const TPM2B_NONCE * policyRef, const TPM2B_NAME * keySign, const TPMT_TK_VERIFIED * checkTicket)

This is the asynchronous function for TPM2_PolicyAuthorize. It invokes the command in an asynchronous variant, which 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_PolicyAuthorize_Finish. Group-chat energy: send it now, get the reply later 😌

🌸 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.
  • approvedPolicy — Digest of the policy being approved.
  • policyRef — A policy qualifier.
  • keySign — Name of a key that can sign a policy addition.
  • checkTicket — Ticket validating that approvedPolicy and policyRef were signed by keySign.

🎀 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_PolicyAuthorize_Finish 🧚

TSS2_RC Esys_PolicyAuthorize_Finish (ESYS_CONTEXT * esysContext)

This is the asynchronous finish function for TPM2_PolicyAuthorize. It returns the results of a TPM2_PolicyAuthorize command invoked via Esys_PolicyAuthorize_Finish — yep, that's literally what the page says 💀 — and 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. Slay, optional outputs 🎀

🌸 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. Very demure, very generated 💅

This page is brought to you by tpm2-tss, Version 4.1.5 — mwah, bestie 💋✨

📦 where this page comes from