summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_aead_cipher_encryptv.3
blob: 60f99a39810ebf3ca4679ccc8e33ef4b40cfadf3 (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
52
53
54
55
56
57
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_aead_cipher_encryptv" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_aead_cipher_encryptv \- API function
.SH SYNOPSIS
.B #include <gnutls/crypto.h>
.sp
.BI "int gnutls_aead_cipher_encryptv(gnutls_aead_cipher_hd_t " handle ", const void * " nonce ", size_t " nonce_len ", const giovec_t * " auth_iov ", int " auth_iovcnt ", size_t " tag_size ", const giovec_t * " iov ", int " iovcnt ", void * " ctext ", size_t * " ctext_len ");"
.SH ARGUMENTS
.IP "gnutls_aead_cipher_hd_t handle" 12
is a \fBgnutls_aead_cipher_hd_t\fP type.
.IP "const void * nonce" 12
the nonce to set
.IP "size_t nonce_len" 12
The length of the nonce
.IP "const giovec_t * auth_iov" 12
additional data to be authenticated
.IP "int auth_iovcnt" 12
The number of buffers in  \fIauth_iov\fP 
.IP "size_t tag_size" 12
The size of the tag to use (use zero for the default)
.IP "const giovec_t * iov" 12
the data to be encrypted
.IP "int iovcnt" 12
The number of buffers in  \fIiov\fP 
.IP "void * ctext" 12
the encrypted data including authentication tag
.IP "size_t * ctext_len" 12
the length of encrypted data (initially must hold the maximum available size, including space for tag)
.SH "DESCRIPTION"
This function will encrypt the provided data buffers using the algorithm
specified by the context. The output data will contain the
authentication tag.
.SH "RETURNS"
Zero or a negative error code on error.
.SH "SINCE"
3.6.3
.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