Fapi_ExportKey(3)

💖 Fapi_ExportKey(3) 💖

okay so this is the Fapi_ExportKey(3) page from the Library Functions Manual, and bestie, it's literally all about Fapi_ExportKey. no cap. 💅

---

✨ NAME ✨

Fapi_ExportKey — yep, the name is Fapi_ExportKey. iconic. 🎀

---

🌸 SYNOPSIS 🌸

🫶 Functions 🫶

TSS2_RC Fapi_ExportKey (FAPI_CONTEXT *context, char const
    *pathOfKeyToDuplicate, char const *pathToPublicKeyOfNewParent, char
    **exportedData)
TSS2_RC Fapi_ExportKey_Async (FAPI_CONTEXT *context, char const
    *pathOfKeyToDuplicate, char const *pathToPublicKeyOfNewParent)
TSS2_RC Fapi_ExportKey_Finish (FAPI_CONTEXT *context, char
    **exportedData)

---

🦋 Detailed Description 🦋

These are the FAPI functions that invoke ExportKey — either as a one-call situation or in an asynchronous manner. slay. ✨

---

💜 Function Documentation 💜

💖 TSS2_RC Fapi_ExportKey — the one-call cutie 💖

TSS2_RC Fapi_ExportKey (FAPI_CONTEXT * context, char const *
    pathOfKeyToDuplicate, char const * pathToPublicKeyOfNewParent, char **
    exportedData)

One-Call function for Fapi_ExportKey. okay so you give it a key, and — if the key is a storage key — it will duplicate the key and package up the duplicated key plus all the keys below it into a file that's ready to move to a new TPM. that's the whole vibe. 🫶

🌸 Parameters 🌸

• context — The FAPI_CONTEXT.
• pathOfKeyToDuplicate — The path to the root of the subtree to export.
• pathToPublicKeyOfNewParent — The path to the public key of the new parent. May be NULL.
• exportedData — The exported subtree.

💀 Return values 💀

• TSS2_RC_SUCCESS — if the function call was a success. 💖
• TSS2_FAPI_RC_BAD_REFERENCE — if context, pathOfKeyToDuplicate or exportedData is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if pathOfKeyToDuplicate or pathToPublicKeyOfNewParent does not map to a . FAPI object.
• TSS2_FAPI_RC_BAD_KEY — if the key at pathToPublicKeyOfNewParent is not suitable for the requeste operation.
• TSS2_FAPI_RC_KEY_NOT_DUPLICABLE — if the key is not a duplicable key.
• 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_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_BAD_PATH — if a path is used in inappropriate context or contains illegal characters.
• 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_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_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

🦋 TSS2_RC Fapi_ExportKey_Async — the async bestie 🦋

TSS2_RC Fapi_ExportKey_Async (FAPI_CONTEXT * context, char const *
    pathOfKeyToDuplicate, char const * pathToPublicKeyOfNewParent)

Asynchronous function for Fapi_ExportKey. same energy as above: given a key, it will — if the key is a storage key — duplicate the key and package up the duplicated key and all keys below it into a file ready to move to a new TPM. then you call Fapi_ExportKey_Finish to finish the execution of this command. periodt. ✨

🌸 Parameters 🌸

• context — The FAPI_CONTEXT.
• pathOfKeyToDuplicate — The path to the root of the subtree to export.
• pathToPublicKeyOfNewParent — The path to the public key of the new parent.

💀 Return values 💀

• TSS2_RC_SUCCESS — if the function call was a success. 💖
• TSS2_FAPI_RC_BAD_REFERENCE — if context or pathOfKeyToDuplicate is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if pathOfKeyToDuplicate or pathToPublicKeyOfNewParent does not map to a . FAPI object.
• TSS2_FAPI_RC_BAD_KEY — if the key at pathToPublicKeyOfNewParent is not suitable for the requeste operation.
• TSS2_FAPI_RC_KEY_NOT_DUPLICABLE — if the key is not a duplicable key.
• 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_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_BAD_PATH — if the path is used in inappropriate context or contains illegal characters.

---

🎀 TSS2_RC Fapi_ExportKey_Finish — the finish-line fairy 🎀

TSS2_RC Fapi_ExportKey_Finish (FAPI_CONTEXT * context, char ** exportedData)

Asynchronous finish function for Fapi_ExportKey. this one should be called after a previous Fapi_ExportKey_Async. like, don't skip it, bestie. 😭

🌸 Parameters 🌸

• context — The FAPI_CONTEXT.
• exportedData — The exported subtree.

💀 Return values 💀

• TSS2_RC_SUCCESS — if the function call was a success. 💖
• TSS2_FAPI_RC_BAD_REFERENCE — if context or exportedData 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_PATH — if a path is used in inappropriate context or contains illegal characters.
• 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_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_FAPI_RC_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.

---

👑 Author 👑

This page was generated automatically by Doxygen for tpm2-tss from the source code. no cap, that's the author situation. 🫶

---

okay bye bestie 💅 this page is from tpm2-tss Version 4.1.5, and the footer is literally Fapi_ExportKey(3) — no date in sight, just vibes. 🌈