Blame doc/functions/gnutls_aead_cipher_decrypt

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_aead_cipher_decrypt} (gnutls_aead_cipher_hd_t @var{handle}, const void * @var{nonce}, size_t @var{nonce_len}, const void * @var{auth}, size_t @var{auth_len}, size_t @var{tag_size}, const void * @var{ctext}, size_t @var{ctext_len}, void * @var{ptext}, size_t * @var{ptext_len})
Packit Service 4684c1
@var{handle}: is a @code{gnutls_aead_cipher_hd_t}  type.
Packit Service 4684c1
Packit Service 4684c1
@var{nonce}: the nonce to set
Packit Service 4684c1
Packit Service 4684c1
@var{nonce_len}: The length of the nonce
Packit Service 4684c1
Packit Service 4684c1
@var{auth}: additional data to be authenticated
Packit Service 4684c1
Packit Service 4684c1
@var{auth_len}: The length of the data
Packit Service 4684c1
Packit Service 4684c1
@var{tag_size}: The size of the tag to use (use zero for the default)
Packit Service 4684c1
Packit Service 4684c1
@var{ctext}: the data to decrypt (including the authentication tag)
Packit Service 4684c1
Packit Service 4684c1
@var{ctext_len}: the length of data to decrypt (includes tag size)
Packit Service 4684c1
Packit Service 4684c1
@var{ptext}: the decrypted data
Packit Service 4684c1
Packit Service 4684c1
@var{ptext_len}: the length of decrypted data (initially must hold the maximum available size)
Packit Service 4684c1
Packit Service 4684c1
This function will decrypt the given data using the algorithm
Packit Service 4684c1
specified by the context. This function must be provided the complete
Packit Service 4684c1
data to be decrypted, including the authentication tag. On several
Packit Service 4684c1
AEAD ciphers, the authentication tag is appended to the ciphertext,
Packit Service 4684c1
though this is not a general rule. This function will fail if
Packit Service 4684c1
the tag verification fails.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} Zero or a negative error code on verification failure or other error.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 3.4.0
Packit Service 4684c1
@end deftypefun