Esys_PolicyNV(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Esys_PolicyNV — the ESAPI glow-up for TPM2_PolicyNV

okay so bestie, this is a Library Functions Manual page for Esys_PolicyNV(3) from tpm2-tss, and it's literally the ESAPI function that lets you invoke the TPM2_PolicyNV command — either as a one-call situation or in an asynchronous manner. two flavors, same slay ✨

🌸 SYNOPSIS 🌸

the functions themselves, no cap:

TSS2_RC Esys_PolicyNV_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    authHandle, ESYS_TR nvIndex, ESYS_TR policySession, ESYS_TR
    shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND
    *operandB, UINT16 offset, TPM2_EO operation)
TSS2_RC Esys_PolicyNV (ESYS_CONTEXT *esysContext, ESYS_TR authHandle,
    ESYS_TR nvIndex, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR
    shandle2, ESYS_TR shandle3, const TPM2B_OPERAND *operandB, UINT16
    offset, TPM2_EO operation)
TSS2_RC Esys_PolicyNV_Finish (ESYS_CONTEXT *esysContext)

🦋 Detailed Description 🦋

ESAPI function to invoke the TPM2_PolicyNV command either as a one-call or in an asynchronous manner. that's the whole vibe. pick your lane 💅

🎀 Function Documentation 🎀

TSS2_RC Esys_PolicyNV (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, 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_PolicyNV

This function invokes the TPM2_PolicyNV command in a one-call variant. Translation: it will block until the TPM response is available — like, it's gonna sit there and wait, bestie, no shortcuts. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. 🫶

✨ Parameters ✨

  • esysContext — The ESYS_CONTEXT.
  • authHandle — Handle indicating the source of the authorization value.
  • nvIndex — The NV Index of the area to read.
  • policySession — Handle for the policy session being extended.
  • shandle1 — Session handle for authorization of authHandle
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • operandB — The second operand.
  • offset — The offset in the NV Index for the start of operand A.
  • operation — The comparison to make.

💀 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_PolicyNV_Async (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, 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_PolicyNV

This function invokes the TPM2_PolicyNV command in a asynchronous variant. Which means — plot twist — 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_PolicyNV_Finish. like, you have to come back for it, ok? 😭

✨ Parameters ✨

  • esysContext — The ESYS_CONTEXT.
  • authHandle — Handle indicating the source of the authorization value.
  • nvIndex — The NV Index of the area to read.
  • policySession — Handle for the policy session being extended.
  • shandle1 — Session handle for authorization of authHandle
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • operandB — The second operand.
  • offset — The offset in the NV Index 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_PolicyNV_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_PolicyNV

This function returns the results of a TPM2_PolicyNV command invoked via Esys_PolicyNV_Finish. (yes, the original literally says that — it's giving "self-referential queen" energy 👑). 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 — flexible icon behavior, honestly.

✨ 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. ⏳ (patience, bestie)
  • 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 a human, just a very diligent robot 🧚)

k bye bestie, this was tpm2-tss Version 4.1.5, dated like the Esys_PolicyNV(3) era — go forth and extend those policy sessions 💜🦋✨

📦 where this page comes from