Esys_NV_ChangeAuth(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Esys_NV_ChangeAuth(3) — like, the Library Functions Manual bestie, but make it fashion 💅

okay so real talk: this is the ESAPI glow-up page for TPM2_NV_ChangeAuth, straight out of the Library Functions Manual section of your fave doc set. It's giving "I want to change the auth on my NV index and I want it to slay" ✨

🌸 NAME 🌸

Esys_NV_ChangeAuth — the ESAPI function for the TPM2_NV_ChangeAuth command. that's it, that's the whole vibe 🎀

🦋 SYNOPSIS 🦋

✨ Functions ✨

TSS2_RC Esys_NV_ChangeAuth_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const
    TPM2B_AUTH *newAuth)
TSS2_RC Esys_NV_ChangeAuth (ESYS_CONTEXT *esysContext, ESYS_TR nvIndex,
    ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const
    TPM2B_AUTH *newAuth)
TSS2_RC Esys_NV_ChangeAuth_Finish (ESYS_CONTEXT *esysContext)

💖 Detailed Description 💖

ESAPI function to invoke the TPM2_NV_ChangeAuth command either as a one-call or in an asynchronous manner. literally both flavors, pick your fighter 🫶

👑 Function Documentation 👑

🌈 TSS2_RC Esys_NV_ChangeAuth (ESYS_CONTEXT * esysContext, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH * newAuth)

One-Call function for TPM2_NV_ChangeAuth 💅

This function invokes the TPM2_NV_ChangeAuth command in a one-call variant. This means the function will block until the TPM response is available — yes bestie, it waits, main character energy, no playing around 😤. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation.

Parameters

  • esysContext — The ESYS_CONTEXT.
  • nvIndex — Handle of the entity.
  • shandle1 — Session handle for authorization of nvIndex
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • newAuth — New authorization value. (the fresh ✨vibe✨, literally)

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. 😭 corruption is not the vibe.
  • 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. one thing at a time, 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_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_NV_ChangeAuth_Async (ESYS_CONTEXT * esysContext, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH * newAuth)

Asynchronous function for TPM2_NV_ChangeAuth 🔥

This function invokes the TPM2_NV_ChangeAuth command in an asynchronous variant. This means the function will return as soon as the command has been sent downwards the stack to the TPM — no waiting around, she's out ✈️. All input parameters are const. In order to retrieve the TPM's response call Esys_NV_ChangeAuth_Finish. (yes, that's your callback era, iykyk 💅)

Parameters

  • esysContext — The ESYS_CONTEXT.
  • nvIndex — Handle of the entity.
  • shandle1 — Session handle for authorization of nvIndex
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.
  • newAuth — New authorization value.

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

Asynchronous finish function for TPM2_NV_ChangeAuth 🫶

This function returns the results of a TPM2_NV_ChangeAuth command invoked via Esys_NV_ChangeAuth_Finish. (yes, the docs really do say that — it's the finish of the thing you started, okay 😭💀). 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 — very "no thoughts, head empty" of you, and honestly? valid 🙈

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. (she's not ghosting you, she's just slow ⏳)
  • 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.
⚠️ heads up bestie: the one-call and async flavors do not list TSS2_ESYS_RC_TRY_AGAIN — that one only shows up in Finish. and note the async one says ESYS_RC_SUCCESS (no TSS2_ prefix) at the top while Finish lists both. keep those exactly as-is, no cap. 🫡

🌟 Author 🌟

Generated automatically by Doxygen for tpm2-tss from the source code. (the robots wrote this one, not me, but I did add the sparkle ✨🤖)

and that's the whole page bestie!! 🍓💜 this cutie came from tpm2-tss, Version 4.1.5 — go drink some water and change that auth value, you absolute icon 👑💅🌸

📦 where this page comes from