Fapi_WriteAuthorizeNv(3)

💅 Fapi_WriteAuthorizeNv(3) 💅

Okay bestie, gather round, because this is the Fapi_WriteAuthorizeNv page from the Library Functions Manual, and honestly? It's giving "quietly important TPM lore" and I am obsessed. ✨

---

🌸 NAME 🌸

Fapi_WriteAuthorizeNv — literally just Fapi_WriteAuthorizeNv, no cap. That's the whole name. Iconic minimalism. 💅

---

🦋 SYNOPSIS 🦋

Functions

TSS2_RC Fapi_WriteAuthorizeNv (FAPI_CONTEXT *context, char const
    *nvPath, char const *policyPath)
TSS2_RC Fapi_WriteAuthorizeNv_Async (FAPI_CONTEXT *context, char const
    *nvPath, char const *policyPath)
TSS2_RC Fapi_WriteAuthorizeNv_Finish (FAPI_CONTEXT *context)

---

🎀 Detailed Description 🎀

These are the FAPI functions that let you invoke WriteAuthorizeNv — either as a one-call situation or in a whole asynchronous manner. Two vibes, same destination. 🫶

---

✨ Function Documentation ✨

💖 TSS2_RC Fapi_WriteAuthorizeNv (FAPI_CONTEXT * context, char const * nvPath, char const * policyPath)

The one-call function for Fapi_WriteAuthorizeNv. Main character energy, one shot, done. 🔥

What it does: writes the policyDigest of a policy to an NV index so it can be used in policies that contain PolicyAuthorizeNV elements. That's the whole mission, and it ate. 👑

Parameters

• context — The FAPI_CONTEXT
• nvPath — The path of the NV index
• policyPath — The path of the new policy

Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or path is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_PATH — if nvPath or policyPath does not map to a FAPI policy or NV index.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_TRY_AGAIN — if an I/O operation is not finished yet and this function needs to be called again.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error occurred.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.

---

💜 TSS2_RC Fapi_WriteAuthorizeNv_Async (FAPI_CONTEXT * context, char const * nvPath, char const * policyPath)

The asynchronous function for Fapi_WriteAuthorizeNv. It's giving "we'll get there when we get there" but make it cryptography. 🌈

What it does: writes the policyDigest of a policy to an NV index so it can be used in policies containing PolicyAuthorizeNV elements.

Heads up bestie: you gotta call Fapi_WriteAuthorizeNv_Finish to finish the execution of this command. Don't leave it hanging. 😭

Parameters

• context — The FAPI_CONTEXT
• nvPath — The path of the NV index
• policyPath — The path of the new policy

Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or path is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_PATH — if nvPath or policyPath does not map to a FAPI policy or NV index.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

🧚 TSS2_RC Fapi_WriteAuthorizeNv_Finish (FAPI_CONTEXT * context)

The asynchronous finish function for Fapi_WriteAuthorizeNv. The closing act. The final bow. 🎀

You should call this function after a previous Fapi_WriteAuthorizeNv_Async. Like, that's the whole assignment, bestie. 💅

Parameters

• context — The FAPI_CONTEXT

Return values

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_TRY_AGAIN — if the asynchronous operation is not yet complete. Call this function again later.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error occurred.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_BAD_PATH — if the path is used in inappropriate context or contains illegal characters.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.

---

👑 Author 👑

Generated automatically by Doxygen for tpm2-tss from the source code. The robots wrote it, not me, but I did give it a makeover. 💖

---

✨ Okay that's the whole page, you understood it, I'm so proud, mwah ✨

And a little sign-off from the footer: this is tpm2-tss, Version 4.1.5, dated Fapi_WriteAuthorizeNv(3) — slay, go forth and authorize those NV indexes bestie 🦋🍓💜