Esys_NV_Extend(3)

✨ NAME ✨

okay bestie, welcome to Esys_NV_Extend(3) from the Library Functions Manual — this is the ESAPI function for the TPM2_NV_Extend command. It's giving "extend that NV data" main-character energy, and we're gonna get through it together. 💖

✨ SYNOPSIS ✨

🫶 Functions 🫶

TSS2_RC Esys_NV_Extend_Async (ESYS_CONTEXT *esysContext, ESYS_TR
    authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2,
    ESYS_TR shandle3, const TPM2B_MAX_NV_BUFFER *data)
TSS2_RC Esys_NV_Extend (ESYS_CONTEXT *esysContext, ESYS_TR authHandle,
    ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR
    shandle3, const TPM2B_MAX_NV_BUFFER *data)
TSS2_RC Esys_NV_Extend_Finish (ESYS_CONTEXT *esysContext)

💖 Detailed Description 💖

This is the ESAPI function that lets you invoke the TPM2_NV_Extend command — either as a one-call situation or in an asynchronous manner. Slay. ✨

🔥 Function Documentation 🔥

💅 Esys_NV_Extend — one-call function for TPM2_NV_Extend 💅

TSS2_RC Esys_NV_Extend (ESYS_CONTEXT * esysContext, ESYS_TR authHandle,
    ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3,
    const TPM2B_MAX_NV_BUFFER * data)

Okay so this one is the one-call function for TPM2_NV_Extend. It invokes the TPM2_NV_Extend command in a one-call variant. That means it will block until the TPM response is available. All input parameters are const, and the memory for non-simple output parameters is allocated by the function implementation. No cap. 🫶

Parameters

• esysContext — the ESYS_CONTEXT.
• authHandle — handle indicating the source of the authorization value.
• nvIndex — the NV Index to extend.
• shandle1 — session handle for authorization of authHandle.
• shandle2 — second session handle.
• shandle3 — third session handle.
• data — the data to extend.

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.

🌸 Esys_NV_Extend_Async — asynchronous function for TPM2_NV_Extend 🌸

TSS2_RC Esys_NV_Extend_Async (ESYS_CONTEXT * esysContext, ESYS_TR
    authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR
    shandle3, const TPM2B_MAX_NV_BUFFER * data)

This is the asynchronous function for TPM2_NV_Extend. It invokes the TPM2_NV_Extend command in an asynchronous variant. That means 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_Extend_Finish. Iconic. 💅

Parameters

• esysContext — the ESYS_CONTEXT.
• authHandle — handle indicating the source of the authorization value.
• nvIndex — the NV Index to extend.
• shandle1 — session handle for authorization of authHandle.
• shandle2 — second session handle.
• shandle3 — third session handle.
• data — the data to extend.

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.

🦋 Esys_NV_Extend_Finish — asynchronous finish function for TPM2_NV_Extend 🦋

TSS2_RC Esys_NV_Extend_Finish (ESYS_CONTEXT * esysContext)

This is the asynchronous finish function for TPM2_NV_Extend. It returns the results of a TPM2_NV_Extend command invoked via Esys_NV_Extend_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. 🧚

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.

---

kisses and TPM dreams, bestie 💜 — source/version sign-off: tpm2-tss, Version 4.1.5, for Esys_NV_Extend(3). Periodt. ✨