summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_cipher_init.3
blob: 3a44563fbd7984ac96ba32320d786c7d4d9baa3c (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
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_cipher_init" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_cipher_init \- API function
.SH SYNOPSIS
.B #include <gnutls/crypto.h>
.sp
.BI "int gnutls_cipher_init(gnutls_cipher_hd_t * " handle ", gnutls_cipher_algorithm_t " cipher ", const gnutls_datum_t * " key ", const gnutls_datum_t * " iv ");"
.SH ARGUMENTS
.IP "gnutls_cipher_hd_t * handle" 12
is a \fBgnutls_cipher_hd_t\fP type
.IP "gnutls_cipher_algorithm_t cipher" 12
the encryption algorithm to use
.IP "const gnutls_datum_t * key" 12
the key to be used for encryption/decryption
.IP "const gnutls_datum_t * iv" 12
the IV to use (if not applicable set NULL)
.SH "DESCRIPTION"
This function will initialize the  \fIhandle\fP context to be usable
for encryption/decryption of data. This will effectively use the
current crypto backend in use by gnutls or the cryptographic
accelerator in use.
.SH "RETURNS"
Zero or a negative error code on error.
.SH "SINCE"
2.10.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