Esys_NV_ReadPublic(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 NAME 💖 — Esys_NV_ReadPublic(3) · Library Functions Manual

okay bestie, welcome to Esys_NV_ReadPublic(3) from the Library Functions Manual — it’s literally the ESAPI function for the TPM2_NV_ReadPublic command, and it’s here to serve. 💅

🌸 SYNOPSIS 🌸

✨ Functions ✨

TSS2_RC Esys_NV_ReadPublic_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)
TSS2_RC Esys_NV_ReadPublic (ESYS_CONTEXT *esysContext, ESYS_TR nvIndex,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPM2B_NV_PUBLIC **nvPublic, TPM2B_NAME **nvName)
TSS2_RC Esys_NV_ReadPublic_Finish (ESYS_CONTEXT *esysContext,
    TPM2B_NV_PUBLIC **nvPublic, TPM2B_NAME **nvName)

🦋 Detailed Description 🦋

So this is the ESAPI function to invoke the TPM2_NV_ReadPublic command — and it can do it either as a one-call situation or in an asynchronous manner. Two paths, same iconic command. 🫶

💅 Function Documentation 💅

👑 Esys_NV_ReadPublic — One-Call function for TPM2_NV_ReadPublic

🌟 Signature 🌟

TSS2_RC Esys_NV_ReadPublic (ESYS_CONTEXT * esysContext, ESYS_TR nvIndex,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    TPM2B_NV_PUBLIC ** nvPublic, TPM2B_NAME ** nvName)

This one invokes the TPM2_NV_ReadPublic command in a one-call variant, which means it will block until the TPM response is available. No cap, it just waits. All input parameters are const, and the memory for non-simple output parameters is allocated by the function implementation. ✨

🍓 Parameters 🍓

  • esysContext — The ESYS_CONTEXT.
  • nvIndex — The NV Index.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • nvPublic — The public area of the NV Index. (callee-allocated)
  • nvName — The Name of the nvIndex. (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_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_RCs — produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

🦋 Esys_NV_ReadPublic_Async — Asynchronous function for TPM2_NV_ReadPublic

🌟 Signature 🌟

TSS2_RC Esys_NV_ReadPublic_Async (ESYS_CONTEXT * esysContext, ESYS_TR
    nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

This one invokes the TPM2_NV_ReadPublic command in an asynchronous variant, meaning it 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_NV_ReadPublic_Finish. iykyk 👑

🍓 Parameters 🍓

  • esysContext — The ESYS_CONTEXT.
  • nvIndex — The NV Index.
  • shandle1 — First session handle.
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.

🔥 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.

🎀 Esys_NV_ReadPublic_Finish — Asynchronous finish function for TPM2_NV_ReadPublic

🌟 Signature 🌟

TSS2_RC Esys_NV_ReadPublic_Finish (ESYS_CONTEXT * esysContext,
    TPM2B_NV_PUBLIC ** nvPublic, TPM2B_NAME ** nvName)

This function returns the results of a TPM2_NV_ReadPublic command invoked via Esys_NV_ReadPublic_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. periodt. 🎀

🍓 Parameters 🍓

  • esysContext — The ESYS_CONTEXT.
  • nvPublic — The public area of the NV Index. (callee-allocated)
  • nvName — The Name of the nvIndex. (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. 🫶

💖 this footer vibe comes from tpm2-tss, Version 4.1.5 — and the page didn’t give me a date, so that’s the whole sign-off, bestie. 🌈

📦 where this page comes from