Esys_NV_Increment(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💅 Esys_NV_Increment — like, the ESAPI function for TPM2_NV_Increment, bestie

okay so this page is from the Library Functions Manual for Esys_NV_Increment(3) — yes the manual name is literally part of the title, we move ✨

🌸 NAME 🌸

Esys_NV_Increment — the ESAPI function for the TPM2_NV_Increment command. that's it, that's the vibe. it increments your NV index and it does it through ESAPI 🫶

✨ SYNOPSIS ✨

🎀 Functions

TSS2_RC Esys_NV_Increment_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3)
TSS2_RC Esys_NV_Increment (ESYS_CONTEXT *esysContext, ESYS_TR
    authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3)
TSS2_RC Esys_NV_Increment_Finish (ESYS_CONTEXT *esysContext)

like, three functions, one mission 💀

🦋 Detailed Description 🦋

ESAPI function to invoke the TPM2_NV_Increment command either as a one-call or in an asynchronous manner. pick your fighter, both are iconic 👑

💖 Function Documentation 💖

⭐ TSS2_RC Esys_NV_Increment (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

One-Call function for TPM2_NV_Increment — the "just do it and wait" one 🤌

This function invokes the TPM2_NV_Increment command in a one-call variant. This means the function will block until the TPM response is available. no cap, it will literally just sit there waiting 😭 All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation — so like, she handles the malloc for you, queen behavior 💅

🌈 Parameters

  • esysContext — The ESYS_CONTEXT. your whole context, your main character.
  • authHandle — Handle indicating the source of the authorization value. the plug for the auth, iykyk 🔑
  • nvIndex — The NV Index to increment. this is the one getting +1'd ✨
  • shandle1 — Session handle for authorization of authHandle
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.

🍓 Return values

  • TSS2_RC_SUCCESS if the function call was a success. slay ✅
  • 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. the malloc said no 🙈
  • TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous operation already pending. bestie there's already one in the queue, wait your turn 😤
  • 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. the HMAC said "not today" 🚫
  • TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the 'decrypt' attribute bit set. one decrypt session only, we don't do polyamory here 💀
  • TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the 'encrypt' attribute bit set. same energy, one encrypt session 🔒
  • 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. the low-level girlies pass their messages straight up, no filtering 💌

⭐ TSS2_RC Esys_NV_Increment_Async (ESYS_CONTEXT * esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3)

Asynchronous function for TPM2_NV_Increment — the "send it and dip" one 🏃‍♀️💨

This function invokes the TPM2_NV_Increment command in a asynchronous variant. This means the function will return 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. In order to retrieve the TPM's response call Esys_NV_Increment_Finish. you want the answer? go get it yourself bestie 💅

🌈 Parameters

  • esysContext — The ESYS_CONTEXT.
  • authHandle — Handle indicating the source of the authorization value.
  • nvIndex — The NV Index to increment.
  • shandle1 — Session handle for authorization of authHandle
  • shandle2 — Second session handle.
  • shandle3 — Third session handle.

🍓 Return values

  • ESYS_RC_SUCCESS if the function call was a success. (that's the literal spelling on this one, don't come for me 💀)
  • 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_NV_Increment_Finish (ESYS_CONTEXT * esysContext)

Asynchronous finish function for TPM2_NV_Increment — the "okay she's back, what did she say" one 👀

This function returns the results of a TPM2_NV_Increment command invoked via Esys_NV_Increment_Finish. yes, it says Esys_NV_Increment_Finish right there in the original, that's what it says, I'm not touching it 🙈 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. don't care? pass NULL, she won't be offended 🫶

🌈 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. wait your turn, again 😤
  • TSS2_ESYS_RC_TRY_AGAIN if the timeout counter expires before the TPM response is received. she's taking too long, try again later ⏳
  • 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 me being auto-generated 😭💀 she's a bot and she's still iconic

anyway that's the whole thing bestie, go increment that NV index, ily, mwah 💖

sign-off szn 🎀: this lil masterpiece is from tpm2-tss, Version 4.1.5, and it's the Esys_NV_Increment(3) page. periodt. ✨

📦 where this page comes from