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

Functions

TSS2_RC Fapi_GetAppData (FAPI_CONTEXT *context, char const *path, uint8_t **appData, size_t *appDataSize)
 
TSS2_RC Fapi_GetAppData_Async (FAPI_CONTEXT *context, char const *path)
 
TSS2_RC Fapi_GetAppData_Finish (FAPI_CONTEXT *context, uint8_t **appData, size_t *appDataSize)
 

Detailed Description

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

Function Documentation

◆ Fapi_GetAppData()

Fapi_GetAppData ( FAPI_CONTEXT context,
char const *  path,
uint8_t **  appData,
size_t *  appDataSize 
)

One-Call function for Fapi_GetAppData

Every object has a description field that can be retrieved in order to obtain additional information in its "path" entry.

Parameters
[in,out]contextThe FAPI_CONTEXT
[in]pathThe path to the object for which the appData is returned
[out]appDataA copy of the appData. May be NULL (callee-allocated)
[out]appDataSizeThe size of the returned AppData. May be NULL
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context or path is NULL.
TSS2_FAPI_RC_BAD_CONTEXTif context corruption is detected.
TSS2_FAPI_RC_BAD_PATHif path does not map to a FAPI entity.
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_KEY_NOT_FOUNDif a key was not found.
TSS2_FAPI_RC_BAD_VALUEif an invalid value was passed into the function.
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_NOT_PROVISIONEDFAPI was not provisioned.

◆ Fapi_GetAppData_Async()

Fapi_GetAppData_Async ( FAPI_CONTEXT context,
char const *  path 
)

Asynchronous function for Fapi_GetAppData

Every object has a description field that can be retrieved in order to obtain additional information in its "path" entry.

Call Fapi_GetAppData_Finish to finish the execution of this command.

Parameters
[in,out]contextThe FAPI_CONTEXT
[in]pathThe path to the object for which the appData is returned
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context or path is NULL.
TSS2_FAPI_RC_BAD_CONTEXTif context corruption is detected.
TSS2_FAPI_RC_BAD_PATHif path does not map to a FAPI entity.
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_KEY_NOT_FOUNDif a key was not found.
TSS2_FAPI_RC_BAD_VALUEif an invalid value was passed into the function.
TSS2_FAPI_RC_NOT_PROVISIONEDFAPI was not provisioned.

◆ Fapi_GetAppData_Finish()

Fapi_GetAppData_Finish ( FAPI_CONTEXT context,
uint8_t **  appData,
size_t *  appDataSize 
)

Asynchronous finish function for Fapi_GetAppData

This function should be called after a previous Fapi_GetAppData_Async.

Parameters
[in,out]contextThe FAPI_CONTEXT
[out]appDataA copy of the appData. May be Null (callee-allocated)
[out]appDataSizeThe size of the returned AppData. May be NULL
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context 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_GENERAL_FAILUREif an internal error occurred.
TSS2_FAPI_RC_BAD_VALUEif an invalid value was passed into the function.