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

Functions

TSS2_RC Fapi_WriteAuthorizeNv (FAPI_CONTEXT *context, char const *nvPath, char const *policyPath)
 
TSS2_RC Fapi_WriteAuthorizeNv_Async (FAPI_CONTEXT *context, char const *nvPath, char const *policyPath)
 
TSS2_RC Fapi_WriteAuthorizeNv_Finish (FAPI_CONTEXT *context)
 

Detailed Description

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

Function Documentation

◆ Fapi_WriteAuthorizeNv()

Fapi_WriteAuthorizeNv ( FAPI_CONTEXT context,
char const *  nvPath,
char const *  policyPath 
)

One-Call function for Fapi_WriteAuthorizeNv

Write the policyDigest of a policy to an NV index so it can be used in policies containing PolicyAuthorizeNV elements.

Parameters
[in,out]contextThe FAPI_CONTEXT
[in]nvPathThe path of the NV index
[in]policyPathThe path of the new policy
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 nvPath or policyPath does not map to a FAPI policy or NV 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_ESYS_RC_*possible error codes of ESAPI.
TSS2_FAPI_RC_NOT_PROVISIONEDFAPI was not provisioned.
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.

◆ Fapi_WriteAuthorizeNv_Async()

Fapi_WriteAuthorizeNv_Async ( FAPI_CONTEXT context,
char const *  nvPath,
char const *  policyPath 
)

Asynchronous function for Fapi_WriteAuthorizeNv

Write the policyDigest of a policy to an NV index so it can be used in policies containing PolicyAuthorizeNV elements.

Call Fapi_WriteAuthorizeNv_Finish to finish the execution of this command.

Parameters
[in,out]contextThe FAPI_CONTEXT
[in]nvPathThe path of the NV index
[in]policyPathThe path of the new policy
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 nvPath or policyPath does not map to a FAPI policy or NV 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_WriteAuthorizeNv_Finish()

Fapi_WriteAuthorizeNv_Finish ( FAPI_CONTEXT context)

Asynchronous finish function for Fapi_WriteAuthorizeNv

This function should be called after a previous Fapi_WriteAuthorizeNv_Async.

Parameters
[in,out]contextThe FAPI_CONTEXT
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_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_ESYS_RC_*possible error codes of ESAPI.
TSS2_FAPI_RC_BAD_PATHif the path is used in inappropriate context or contains illegal characters.
TSS2_FAPI_RC_NOT_PROVISIONEDFAPI was not provisioned.
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.