csu3_am335x/EVSE/GPL/tpm2-tss-3.2.0/doxygen-doc/man/Fapi_VerifyQuote.3

.TH "Fapi_VerifyQuote" 3 "Fri Oct 7 2022" "Version 3.2.0" "tpm2-tss" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Fapi_VerifyQuote
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "TSS2_RC \fBFapi_VerifyQuote\fP (\fBFAPI_CONTEXT\fP *context, char const *publicKeyPath, uint8_t const *qualifyingData, size_t qualifyingDataSize, char const *quoteInfo, uint8_t const *signature, size_t signatureSize, char const *pcrLog)"
.br
.ti -1c
.RI "TSS2_RC \fBFapi_VerifyQuote_Async\fP (\fBFAPI_CONTEXT\fP *context, char const *publicKeyPath, uint8_t const *qualifyingData, size_t qualifyingDataSize, char const *quoteInfo, uint8_t const *signature, size_t signatureSize, char const *pcrLog)"
.br
.ti -1c
.RI "TSS2_RC \fBFapi_VerifyQuote_Finish\fP (\fBFAPI_CONTEXT\fP *context)"
.br
.in -1c
.SH "Detailed Description"
.PP 
FAPI functions to invoke VerifyQuote either as one-call or in an asynchronous manner\&. 
.SH "Function Documentation"
.PP 
.SS "TSS2_RC Fapi_VerifyQuote (\fBFAPI_CONTEXT\fP * context, char const * publicKeyPath, uint8_t const * qualifyingData, size_t qualifyingDataSize, char const * quoteInfo, uint8_t const * signature, size_t signatureSize, char const * pcrLog)"
One-Call function for Fapi_VerifyQuote
.PP
Verifies that the data returned by a quote is valid\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIpublicKeyPath\fP The path to the signing key 
.br
\fIqualifyingData\fP The qualifying data nonce\&. May be NULL 
.br
\fIqualifyingDataSize\fP The size of qualifyingData in bytes\&. Must be 0 if qualifyingData is NULL 
.br
\fIquoteInfo\fP The quote information 
.br
\fIsignature\fP The quote's signature 
.br
\fIsignatureSize\fP The size of signature in bytes 
.br
\fIpcrLog\fP The PCR's log\&. May be NULL
.RE
.PP
\fBReturn values:\fP
.RS 4
\fITSS2_RC_SUCCESS\fP if the function call was a success\&. 
.br
\fITSS2_FAPI_RC_BAD_REFERENCE\fP if context, publicKeyPath, quoteInfo, or signature is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_KEY_NOT_FOUND\fP if path does not map to a FAPI entity\&. 
.br
\fITSS2_FAPI_RC_BAD_KEY\fP if the entity at path is not a key, or is a key that is unsuitable for the requested operation\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if quoteInfo, pcrEventLog, qualifyingData, or signature is invalid\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_IO_ERROR\fP if the data cannot be saved\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_PATH_NOT_FOUND\fP if a FAPI object path was not found during authorization\&. 
.br
\fITSS2_FAPI_RC_TRY_AGAIN\fP if an I/O operation is not finished yet and this function needs to be called again\&. 
.br
\fITSS2_FAPI_RC_GENERAL_FAILURE\fP if an internal error occurred\&. 
.br
\fITSS2_FAPI_RC_SIGNATURE_VERIFICATION_FAILED\fP if the signature could not be verified 
.br
\fITSS2_FAPI_RC_NOT_PROVISIONED\fP FAPI was not provisioned\&. 
.br
\fITSS2_FAPI_RC_BAD_PATH\fP if the path is used in inappropriate context or contains illegal characters\&. 
.RE
.PP

.SS "TSS2_RC Fapi_VerifyQuote_Async (\fBFAPI_CONTEXT\fP * context, char const * publicKeyPath, uint8_t const * qualifyingData, size_t qualifyingDataSize, char const * quoteInfo, uint8_t const * signature, size_t signatureSize, char const * pcrLog)"
Asynchronous function for Fapi_VerifyQuote
.PP
Verifies that the data returned by a quote is valid\&. Call Fapi_VerifyQuote_Finish to finish the execution of this command\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIpublicKeyPath\fP The path to the signing key 
.br
\fIqualifyingData\fP The qualifying data nonce\&. May be NULL 
.br
\fIqualifyingDataSize\fP The size of qualifyingData in bytes\&. Must be 0 if qualifyingData is NULL 
.br
\fIquoteInfo\fP The quote information 
.br
\fIsignature\fP The quote's signature 
.br
\fIsignatureSize\fP The size of signature in bytes 
.br
\fIpcrLog\fP The PCR's log\&. May be NULL
.RE
.PP
\fBReturn values:\fP
.RS 4
\fITSS2_RC_SUCCESS\fP if the function call was a success\&. 
.br
\fITSS2_FAPI_RC_BAD_REFERENCE\fP if context, publicKeyPath, quoteInfo, or signature is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_KEY_NOT_FOUND\fP if path does not map to a FAPI entity\&. 
.br
\fITSS2_FAPI_RC_BAD_KEY\fP if the entity at path is not a key, or is a key that is unsuitable for the requested operation\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if quoteInfo, pcrEventLog, qualifyingData, or signature is invalid\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_IO_ERROR\fP if the data cannot be saved\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_PATH_NOT_FOUND\fP if a FAPI object path was not found during authorization\&. 
.br
\fITSS2_FAPI_RC_NOT_PROVISIONED\fP FAPI was not provisioned\&. 
.br
\fITSS2_FAPI_RC_BAD_PATH\fP if the path is used in inappropriate context or contains illegal characters\&. 
.RE
.PP

.SS "TSS2_RC Fapi_VerifyQuote_Finish (\fBFAPI_CONTEXT\fP * context)"
Asynchronous finish function for Fapi_VerifyQuote
.PP
This function should be called after a previous Fapi_VerifyQuote_Async\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP
.RE
.PP
\fBReturn values:\fP
.RS 4
\fITSS2_RC_SUCCESS\fP if the function call was a success\&. 
.br
\fITSS2_FAPI_RC_BAD_REFERENCE\fP if context is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_IO_ERROR\fP if the data cannot be saved\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_TRY_AGAIN\fP if the asynchronous operation is not yet complete\&. Call this function again later\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if an invalid value was passed into the function\&. 
.br
\fITSS2_FAPI_RC_GENERAL_FAILURE\fP if an internal error occurred\&. 
.br
\fITSS2_FAPI_RC_SIGNATURE_VERIFICATION_FAILED\fP if the signature could not be verified 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for tpm2-tss from the source code\&.