Esys_NV_Certify(3)

✨ NAME ✨

Okay so this page is Esys_NV_Certify(3) from the Library Functions Manual, bestie — it's the ESAPI function for the TPM2_NV_Certify command. 💅🫶

---

🌸 SYNOPSIS 🌸

💫 Functions 💫

Here are the three entry points in all their exact-signature glory:

TSS2_RC Esys_NV_Certify_Async (ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, UINT16 size, UINT16 offset)
TSS2_RC Esys_NV_Certify (ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, UINT16 size, UINT16 offset, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature)
TSS2_RC Esys_NV_Certify_Finish (ESYS_CONTEXT *esysContext, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature)

---

🦋 Detailed Description 🦋

ESAPI function to invoke the TPM2_NV_Certify command either as a one-call or in an asynchronous manner. Choose your adventure: block until the TPM replies, or send it and come back for the tea later. ✨

---

💖 Function Documentation 💖

🎀 TSS2_RC Esys_NV_Certify — One-Call function for TPM2_NV_Certify 🎀

TSS2_RC Esys_NV_Certify (ESYS_CONTEXT * esysContext, ESYS_TR signHandle, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA * qualifyingData, const TPMT_SIG_SCHEME * inScheme, UINT16 size, UINT16 offset, TPM2B_ATTEST ** certifyInfo, TPMT_SIGNATURE ** signature)

This function invokes the TPM2_NV_Certify command in a one-call variant. That means it will block until the TPM response is available — yes, it waits, no cap. All input parameters are const. The memory for non-simple output parameters is allocated by the function implementation. 🫶

💜 Parameters 💜

• esysContext — The ESYS_CONTEXT.
• signHandle — Handle of the key used to sign the attestation structure.
• authHandle — Handle indicating the source of the authorization value for the NV Index.
• nvIndex — Index for the area to be certified.
• shandle1 — Session handle for authorization of signHandle
• shandle2 — Session handle for authorization of authHandle
• shandle3 — Third session handle.
• qualifyingData — User-provided qualifying data.
• inScheme — TPM2_Signing scheme to use if the scheme for signHandle is TPM2_ALG_NULL.
• size — Number of octets to certify.
• offset — Octet offset into the area.
• certifyInfo — The structure that was signed. (callee-allocated)
• signature — The asymmetric signature over certifyInfo using the key referenced by signHandle. (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_RCs produced by lower layers of the software stack may be returned to the caller unaltered unless handled internally.

---

🦋 TSS2_RC Esys_NV_Certify_Async — Asynchronous function for TPM2_NV_Certify 🦋

TSS2_RC Esys_NV_Certify_Async (ESYS_CONTEXT * esysContext, ESYS_TR signHandle, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA * qualifyingData, const TPMT_SIG_SCHEME * inScheme, UINT16 size, UINT16 offset)

This function invokes the TPM2_NV_Certify command in an asynchronous variant. It will return as soon as the command has been sent down the stack to the TPM. All input parameters are const. In order to retrieve the TPM's response, call Esys_NV_Certify_Finish. 💫

💜 Parameters 💜

• esysContext — The ESYS_CONTEXT.
• signHandle — Handle of the key used to sign the attestation structure.
• authHandle — Handle indicating the source of the authorization value for the NV Index.
• nvIndex — Index for the area to be certified.
• shandle1 — Session handle for authorization of signHandle
• shandle2 — Session handle for authorization of authHandle
• shandle3 — Third session handle.
• qualifyingData — User-provided qualifying data.
• inScheme — TPM2_Signing scheme to use if the scheme for signHandle is TPM2_ALG_NULL.
• size — Number of octets to certify.
• offset — Octet offset into the area.

🌺 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_RC Esys_NV_Certify_Finish — Asynchronous finish function for TPM2_NV_Certify 🧚

TSS2_RC Esys_NV_Certify_Finish (ESYS_CONTEXT * esysContext, TPM2B_ATTEST ** certifyInfo, TPMT_SIGNATURE ** signature)

This function returns the results of a TPM2_NV_Certify command invoked via Esys_NV_Certify_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. So yes, bestie, you can skip outputs you don't need. 🙈

💜 Parameters 💜

• esysContext — The ESYS_CONTEXT.
• certifyInfo — The structure that was signed. (callee-allocated)
• signature — The asymmetric signature over certifyInfo using the key referenced by signHandle. (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. So like, not a human author — a Doxygen bot did this. 💅

---

This page is serving tpm2-tss, Version 4.1.5, per the footer source/version. Date? The footer didn't list one, so that's the whole footer tea. Bye bestie, go certify some NV. 🦋✨