Blame doc/manpages/gnutls_cipher_decrypt2.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_cipher_decrypt2" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_cipher_decrypt2 \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/crypto.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_cipher_decrypt2(gnutls_cipher_hd_t " handle ", const void * " ctext ", size_t " ctext_len ", void * " ptext ", size_t " ptext_len ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_cipher_hd_t handle" 12
Packit aea12f
is a \fBgnutls_cipher_hd_t\fP type
Packit aea12f
.IP "const void * ctext" 12
Packit aea12f
the data to decrypt
Packit aea12f
.IP "size_t ctext_len" 12
Packit aea12f
the length of data to decrypt
Packit aea12f
.IP "void * ptext" 12
Packit aea12f
the decrypted data
Packit aea12f
.IP "size_t ptext_len" 12
Packit aea12f
the available length for decrypted data
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will decrypt the given data using the algorithm
Packit aea12f
specified by the context. For block ciphers the  \fIctext_len\fP must be
Packit aea12f
a multiple of the block size. For the supported ciphers the plaintext
Packit aea12f
data length will equal the ciphertext size.
Packit aea12f
Packit aea12f
Note that in AEAD ciphers, this will not check the tag. You will
Packit aea12f
need to compare the tag sent with the value returned from \fBgnutls_cipher_tag()\fP.
Packit aea12f
.SH "RETURNS"
Packit aea12f
Zero or a negative error code on error.
Packit aea12f
.SH "SINCE"
Packit aea12f
2.12.0
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit Service 991b93
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP