---
name: "Fapi_ExportKey"
section: "3"
platform: "linux"
package: "tpm2-tss"
version: "4.2.0-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Fapi_ExportKey"
---

# Fapi\_ExportKey(3)

Fapi\_ExportKey

## NAME

Fapi\_ExportKey - Fapi\_ExportKey

## 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

FAPI functions to invoke ExportKey either as one-call or in an asynchronous manner.

## Function Documentation

### TSS2\_RC Fapi\_ExportKey (FAPI\_CONTEXT \* context, char const \* pathOfKeyToDuplicate, char const \* pathToPublicKeyOfNewParent, char \*\* exportedData)

One-Call function for Fapi\_ExportKey

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.

**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 (FAPI\_CONTEXT \* context, char const \* pathOfKeyToDuplicate, char const \* pathToPublicKeyOfNewParent)

Asynchronous function for Fapi\_ExportKey

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.

Call Fapi\_ExportKey\_Finish to finish the execution of this command.

**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 (FAPI\_CONTEXT \* context, char \*\* exportedData)

Asynchronous finish function for Fapi\_ExportKey

This function should be called after a previous Fapi\_ExportKey\_Async.

**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

Generated automatically by Doxygen for tpm2-tss from the source code.