tpm2-tss  master
TPM Software stack 2.0 TCG spec compliant implementation
Fapi_ExportKey

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

◆ Fapi_ExportKey()

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
[in,out]contextThe FAPI_CONTEXT
[in]pathOfKeyToDuplicateThe path to the root of the subtree to export.
[in]pathToPublicKeyOfNewParentThe path to the public key of the new parent. May be NULL
[out]exportedDataThe exported subtree
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context, pathOfKeyToDuplicate or exportedData is NULL.
TSS2_FAPI_RC_BAD_CONTEXTif context corruption is detected.
TSS2_FAPI_RC_KEY_NOT_FOUNDif pathOfKeyToDuplicate or pathToPublicKeyOfNewParent does not map to a . FAPI object.
TSS2_FAPI_RC_BAD_KEYif the key at pathToPublicKeyOfNewParent is not suitable for the requeste operation.
TSS2_FAPI_RC_KEY_NOT_DUPLICABLEif the key is not a duplicable key.
TSS2_FAPI_RC_BAD_SEQUENCEif the context has an asynchronous operation already pending.
TSS2_FAPI_RC_IO_ERRORif the data cannot be saved.
TSS2_FAPI_RC_MEMORYif the FAPI cannot allocate enough memory for internal operations or return parameters.
TSS2_FAPI_RC_NO_TPMif FAPI was initialized in no-TPM-mode via its config file.
TSS2_FAPI_RC_PATH_NOT_FOUNDif a FAPI object path was not found during authorization.
TSS2_FAPI_RC_BAD_VALUEif an invalid value was passed into the function.
TSS2_FAPI_RC_BAD_PATHif a path is used in inappropriate context or contains illegal characters.
TSS2_FAPI_RC_TRY_AGAINif an I/O operation is not finished yet and this function needs to be called again.
TSS2_FAPI_RC_GENERAL_FAILUREif an internal error occurred.
TSS2_FAPI_RC_AUTHORIZATION_UNKNOWNif a required authorization callback is not set.
TSS2_FAPI_RC_AUTHORIZATION_FAILEDif the authorization attempt fails.
TSS2_FAPI_RC_POLICY_UNKNOWNif policy search for a certain policy digest was not successful.
TSS2_ESYS_RC_*possible error codes of ESAPI.
TSS2_FAPI_RC_NOT_PROVISIONEDFAPI was not provisioned.

◆ Fapi_ExportKey_Async()

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
[in,out]contextThe FAPI_CONTEXT
[in]pathOfKeyToDuplicateThe path to the root of the subtree to export.
[in]pathToPublicKeyOfNewParentThe path to the public key of the new parent
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context or pathOfKeyToDuplicate is NULL.
TSS2_FAPI_RC_BAD_CONTEXTif context corruption is detected.
TSS2_FAPI_RC_KEY_NOT_FOUNDif pathOfKeyToDuplicate or pathToPublicKeyOfNewParent does not map to a . FAPI object.
TSS2_FAPI_RC_BAD_KEYif the key at pathToPublicKeyOfNewParent is not suitable for the requeste operation.
TSS2_FAPI_RC_KEY_NOT_DUPLICABLEif the key is not a duplicable key.
TSS2_FAPI_RC_BAD_SEQUENCEif the context has an asynchronous operation already pending.
TSS2_FAPI_RC_IO_ERRORif the data cannot be saved.
TSS2_FAPI_RC_MEMORYif the FAPI cannot allocate enough memory for internal operations or return parameters.
TSS2_FAPI_RC_NO_TPMif FAPI was initialized in no-TPM-mode via its config file.
TSS2_FAPI_RC_PATH_NOT_FOUNDif a FAPI object path was not found during authorization.
TSS2_FAPI_RC_BAD_VALUEif an invalid value was passed into the function.
TSS2_FAPI_RC_NOT_PROVISIONEDFAPI was not provisioned.
TSS2_FAPI_RC_BAD_PATHif the path is used in inappropriate context or contains illegal characters.

◆ Fapi_ExportKey_Finish()

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
[in,out]contextThe FAPI_CONTEXT
[out]exportedDataThe exported subtree
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context or exportedData is NULL.
TSS2_FAPI_RC_BAD_CONTEXTif context corruption is detected.
TSS2_FAPI_RC_BAD_SEQUENCEif the context has an asynchronous operation already pending.
TSS2_FAPI_RC_IO_ERRORif the data cannot be saved.
TSS2_FAPI_RC_MEMORYif the FAPI cannot allocate enough memory for internal operations or return parameters.
TSS2_FAPI_RC_TRY_AGAINif the asynchronous operation is not yet complete. Call this function again later.
TSS2_FAPI_RC_BAD_PATHif a path is used in inappropriate context or contains illegal characters.
TSS2_FAPI_RC_BAD_VALUEif an invalid value was passed into the function.
TSS2_FAPI_RC_GENERAL_FAILUREif an internal error occurred.
TSS2_FAPI_RC_PATH_NOT_FOUNDif a FAPI object path was not found during authorization.
TSS2_FAPI_RC_KEY_NOT_FOUNDif a key was not found.
TSS2_FAPI_RC_AUTHORIZATION_UNKNOWNif a required authorization callback is not set.
TSS2_FAPI_RC_AUTHORIZATION_FAILEDif the authorization attempt fails.
TSS2_FAPI_RC_POLICY_UNKNOWNif policy search for a certain policy digest was not successful.
TSS2_FAPI_RC_NO_TPMif FAPI was initialized in no-TPM-mode via its config file.
TSS2_ESYS_RC_*possible error codes of ESAPI.
TSS2_FAPI_RC_NOT_PROVISIONEDFAPI was not provisioned.