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

Functions

TSS2_RC Fapi_NvRead (FAPI_CONTEXT *context, char const *path, uint8_t **data, size_t *size, char **logData)
 
TSS2_RC Fapi_NvRead_Async (FAPI_CONTEXT *context, char const *path)
 
TSS2_RC Fapi_NvRead_Finish (FAPI_CONTEXT *context, uint8_t **data, size_t *size, char **logData)
 

Detailed Description

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

Function Documentation

◆ Fapi_NvRead()

TSS2_RC Fapi_NvRead ( FAPI_CONTEXT context,
char const *  nvPath,
uint8_t **  data,
size_t *  size,
char **  logData 
)

One-Call function for Fapi_NvRead

Reads data from an NV index within the TPM. The FAPI will automatically do the multiple reads if the NV index is larger than the TPM's TPM2_MAX_NV_BUFFER_SIZE.

Parameters
[in,out]contextThe FAPI_CONTEXT
[in]nvPathThe path of the NV index to read
[out]dataThe data that was read from the NV index
[out]sizeThe size of data in bytes. May be NULL
[out]logDataThe log data of the NV index if the index is of type "extend". May be NULL
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context, nvPath or data is NULL.
TSS2_FAPI_RC_BAD_CONTEXTif context corruption is detected.
TSS2_FAPI_RC_BAD_PATHif nvPath is not found.
TSS2_FAPI_RC_AUTHORIZATION_FAILEDif authorization fails.
TSS2_FAPI_RC_AUTHORIZATION_UNKNOWNif don't know how to authenticate.
TSS2_FAPI_RC_NV_NOT_READABLEif the NV is not a readable index.
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_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_NvRead_Async()

TSS2_RC Fapi_NvRead_Async ( FAPI_CONTEXT context,
char const *  nvPath 
)

Asynchronous function for Fapi_NvRead

Reads data from an NV index within the TPM. The FAPI will automatically do the multiple reads if the NV index is larger than the TPM's TPM2_MAX_NV_BUFFER_SIZE.

Call Fapi_NvRead_Finish to finish the execution of this command.

Parameters
[in,out]contextThe FAPI_CONTEXT
[in]nvPathThe path of the NV index to read
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context or nvPath is NULL. *
TSS2_FAPI_RC_BAD_CONTEXTif context corruption is detected.
TSS2_FAPI_RC_BAD_PATHif nvPath is not found.
TSS2_FAPI_RC_AUTHORIZATION_FAILEDif authorization fails.
TSS2_FAPI_RC_AUTHORIZATION_UNKNOWNif don't know how to authenticate.
TSS2_FAPI_RC_NV_NOT_READABLEif the NV is not a readable index.
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_NvRead_Finish()

TSS2_RC Fapi_NvRead_Finish ( FAPI_CONTEXT context,
uint8_t **  data,
size_t *  size,
char **  logData 
)

Asynchronous finish function for Fapi_NvRead

This function should be called after a previous Fapi_NvRead_Async.

Parameters
[in,out]contextThe FAPI_CONTEXT
[out]dataThe data that was read from the NV index
[out]sizeThe size of data in bytes. May be NULL
[out]logDataThe log data of the NV index if the index is of type "extend". May be NULL
Return values
TSS2_RC_SUCCESSif the function call was a success.
TSS2_FAPI_RC_BAD_REFERENCEif context or data 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.
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_ESYS_RC_*possible error codes of ESAPI.
TSS2_FAPI_RC_NOT_PROVISIONEDFAPI was not provisioned.