summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_cipher_decrypt2.3
blob: 4ea0773ed407cb77acb44615ed387a72863b16db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_cipher_decrypt2" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_cipher_decrypt2 \- API function
.SH SYNOPSIS
.B #include <gnutls/crypto.h>
.sp
.BI "int gnutls_cipher_decrypt2(gnutls_cipher_hd_t " handle ", const void * " ctext ", size_t " ctext_len ", void * " ptext ", size_t " ptext_len ");"
.SH ARGUMENTS
.IP "gnutls_cipher_hd_t handle" 12
is a \fBgnutls_cipher_hd_t\fP type
.IP "const void * ctext" 12
the data to decrypt
.IP "size_t ctext_len" 12
the length of data to decrypt
.IP "void * ptext" 12
the decrypted data
.IP "size_t ptext_len" 12
the available length for decrypted data
.SH "DESCRIPTION"
This function will decrypt the given data using the algorithm
specified by the context. For block ciphers the  \fIctext_len\fP must be
a multiple of the block size. For the supported ciphers the plaintext
data length will equal the ciphertext size.

Note that in AEAD ciphers, this will not check the tag. You will
need to compare the tag sent with the value returned from \fBgnutls_cipher_tag()\fP.
.SH "RETURNS"
Zero or a negative error code on error.
.SH "SINCE"
2.12.0
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP