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

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

.in +1c
.ti -1c
.RI "TSS2_RC \fBFapi_Encrypt\fP (\fBFAPI_CONTEXT\fP *context, char const *keyPath, uint8_t const *plainText, size_t plainTextSize, uint8_t **cipherText, size_t *cipherTextSize)"
.br
.ti -1c
.RI "TSS2_RC \fBFapi_Encrypt_Async\fP (\fBFAPI_CONTEXT\fP *context, char const *keyPath, uint8_t const *plainText, size_t plainTextSize)"
.br
.ti -1c
.RI "TSS2_RC \fBFapi_Encrypt_Finish\fP (\fBFAPI_CONTEXT\fP *context, uint8_t **cipherText, size_t *cipherTextSize)"
.br
.in -1c
.SH "Detailed Description"
.PP 
FAPI functions to invoke Encrypt either as one-call or in an asynchronous manner\&. 
.SH "Function Documentation"
.PP 
.SS "TSS2_RC Fapi_Encrypt (\fBFAPI_CONTEXT\fP * context, char const * keyPath, uint8_t const * plainText, size_t plainTextSize, uint8_t ** cipherText, size_t * cipherTextSize)"
One-Call function for Fapi_Encrypt
.PP
Encrypt the provided data for the target key using the TPM encryption schemes as specified in the crypto profile\&. This function does not use the TPM; i\&.e\&. works in non-TPM mode\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIkeyPath\fP THe path to the encryption key 
.br
\fIplainText\fP The plaintext data to encrypt 
.br
\fIplainTextSize\fP The size of the plainText in bytes 
.br
\fIcipherText\fP The encoded cipher text\&. 
.br
\fIcipherTextSize\fP The size of the encoded cipher text\&.
.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, keyPath, plainText, or cipherText is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_KEY_NOT_FOUND\fP if keyPath does not map to a FAPI key\&. 
.br
\fITSS2_FAPI_RC_BAD_KEY\fP if the key at keyPath is unsuitable for encryption\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if plainTextSize is 0\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_NO_TPM\fP if FAPI was initialized in no-TPM-mode via its config file\&. 
.br
\fITSS2_FAPI_RC_IO_ERROR\fP if an error occurred while accessing the object store\&. 
.br
\fITSS2_FAPI_RC_NOT_IMPLEMENTED\fP if the encryption algorithm is not available\&. 
.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_PATH_NOT_FOUND\fP if a FAPI object path was not found during authorization\&. 
.br
\fITSS2_FAPI_RC_GENERAL_FAILURE\fP if an internal error occurred\&. 
.br
\fITSS2_FAPI_RC_AUTHORIZATION_UNKNOWN\fP if a required authorization callback is not set\&. 
.br
\fITSS2_FAPI_RC_AUTHORIZATION_FAILED\fP if the authorization attempt fails\&. 
.br
\fITSS2_FAPI_RC_POLICY_UNKNOWN\fP if policy search for a certain policy digest was not successful\&. 
.br
\fITSS2_ESYS_RC_*\fP possible error codes of ESAPI\&. 
.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_Encrypt_Async (\fBFAPI_CONTEXT\fP * context, char const * keyPath, uint8_t const * plainText, size_t plainTextSize)"
Asynchronous function for Fapi_Encrypt
.PP
Encrypt the provided data for the target key using the TPM encryption schemes as specified in the crypto profile\&. This function does not use the TPM; i\&.e\&. works in non-TPM mode\&.
.PP
Call Fapi_Encrypt_Finish to finish the execution of this command\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIkeyPath\fP The path to the encryption key 
.br
\fIplainText\fP The plainText data to encrypt 
.br
\fIplainTextSize\fP The size of the plainText in bytes
.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, keyPath or plainText is NULL\&. 
.br
\fITSS2_FAPI_RC_BAD_CONTEXT\fP if context corruption is detected\&. 
.br
\fITSS2_FAPI_RC_KEY_NOT_FOUND\fP if keyPath does not map to a FAPI key\&. 
.br
\fITSS2_FAPI_RC_BAD_KEY\fP if the key at keyPath is unsuitable for encryption\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if plainTextSize is 0\&. 
.br
\fITSS2_FAPI_RC_BAD_SEQUENCE\fP if the context has an asynchronous operation already pending\&. 
.br
\fITSS2_FAPI_RC_MEMORY\fP if the FAPI cannot allocate enough memory for internal operations or return parameters\&. 
.br
\fITSS2_FAPI_RC_NO_TPM\fP if FAPI was initialized in no-TPM-mode via its config file\&. 
.RE
.PP

.SS "TSS2_RC Fapi_Encrypt_Finish (\fBFAPI_CONTEXT\fP * context, uint8_t ** cipherText, size_t * cipherTextSize)"
Asynchronous finish function for Fapi_Encrypt
.PP
This function should be called after a previous Fapi_Encrypt_Async\&.
.PP
\fBParameters:\fP
.RS 4
\fIcontext\fP The \fBFAPI_CONTEXT\fP 
.br
\fIcipherText\fP The encoded ciphertext 
.br
\fIcipherTextSize\fP The size of the encoded cipher text\&.
.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 or ciphertext 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_NOT_IMPLEMENTED\fP if the encryption algorithm is not available\&. 
.br
\fITSS2_FAPI_RC_BAD_VALUE\fP if an invalid value was passed into the function\&. 
.br
\fITSS2_FAPI_RC_PATH_NOT_FOUND\fP if a FAPI object path was not found during authorization\&. 
.br
\fITSS2_FAPI_RC_KEY_NOT_FOUND\fP if a key was not found\&. 
.br
\fITSS2_FAPI_RC_GENERAL_FAILURE\fP if an internal error occurred\&. 
.br
\fITSS2_FAPI_RC_AUTHORIZATION_UNKNOWN\fP if a required authorization callback is not set\&. 
.br
\fITSS2_FAPI_RC_AUTHORIZATION_FAILED\fP if the authorization attempt fails\&. 
.br
\fITSS2_FAPI_RC_POLICY_UNKNOWN\fP if policy search for a certain policy digest was not successful\&. 
.br
\fITSS2_ESYS_RC_*\fP possible error codes of ESAPI\&. 
.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

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