Blame doc/manpages/gnutls_aead_cipher_decrypt.3

Packit Service 4684c1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 4684c1
.TH "gnutls_aead_cipher_decrypt" 3 "3.6.14" "gnutls" "gnutls"
Packit Service 4684c1
.SH NAME
Packit Service 4684c1
gnutls_aead_cipher_decrypt \- API function
Packit Service 4684c1
.SH SYNOPSIS
Packit Service 4684c1
.B #include <gnutls/crypto.h>
Packit Service 4684c1
.sp
Packit Service 4684c1
.BI "int gnutls_aead_cipher_decrypt(gnutls_aead_cipher_hd_t " handle ", const void * " nonce ", size_t " nonce_len ", const void * " auth ", size_t " auth_len ", size_t " tag_size ", const void * " ctext ", size_t " ctext_len ", void * " ptext ", size_t * " ptext_len ");"
Packit Service 4684c1
.SH ARGUMENTS
Packit Service 4684c1
.IP "gnutls_aead_cipher_hd_t handle" 12
Packit Service 4684c1
is a \fBgnutls_aead_cipher_hd_t\fP type.
Packit Service 4684c1
.IP "const void * nonce" 12
Packit Service 4684c1
the nonce to set
Packit Service 4684c1
.IP "size_t nonce_len" 12
Packit Service 4684c1
The length of the nonce
Packit Service 4684c1
.IP "const void * auth" 12
Packit Service 4684c1
additional data to be authenticated
Packit Service 4684c1
.IP "size_t auth_len" 12
Packit Service 4684c1
The length of the data
Packit Service 4684c1
.IP "size_t tag_size" 12
Packit Service 4684c1
The size of the tag to use (use zero for the default)
Packit Service 4684c1
.IP "const void * ctext" 12
Packit Service 4684c1
the data to decrypt (including the authentication tag)
Packit Service 4684c1
.IP "size_t ctext_len" 12
Packit Service 4684c1
the length of data to decrypt (includes tag size)
Packit Service 4684c1
.IP "void * ptext" 12
Packit Service 4684c1
the decrypted data
Packit Service 4684c1
.IP "size_t * ptext_len" 12
Packit Service 4684c1
the length of decrypted data (initially must hold the maximum available size)
Packit Service 4684c1
.SH "DESCRIPTION"
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
.SH "RETURNS"
Packit Service 4684c1
Zero or a negative error code on verification failure or other error.
Packit Service 4684c1
.SH "SINCE"
Packit Service 4684c1
3.4.0
Packit Service 4684c1
.SH "REPORTING BUGS"
Packit Service 4684c1
Report bugs to <bugs@gnutls.org>.
Packit Service 4684c1
.br
Packit Service 4684c1
Home page: https://www.gnutls.org
Packit Service 4684c1
Packit Service 4684c1
.SH COPYRIGHT
Packit Service 4684c1
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit Service 4684c1
.br
Packit Service 4684c1
Copying and distribution of this file, with or without modification,
Packit Service 4684c1
are permitted in any medium without royalty provided the copyright
Packit Service 4684c1
notice and this notice are preserved.
Packit Service 4684c1
.SH "SEE ALSO"
Packit Service 4684c1
The full documentation for
Packit Service 4684c1
.B gnutls
Packit Service 4684c1
is maintained as a Texinfo manual.
Packit Service 4684c1
If the /usr/share/doc/gnutls/
Packit Service 4684c1
directory does not contain the HTML form visit
Packit Service 4684c1
.B
Packit Service 4684c1
.IP https://www.gnutls.org/manual/
Packit Service 4684c1
.PP