summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_cipher_init
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/functions/gnutls_cipher_init22
-rw-r--r--doc/functions/gnutls_cipher_init.short1
2 files changed, 23 insertions, 0 deletions
diff --git a/doc/functions/gnutls_cipher_init b/doc/functions/gnutls_cipher_init
new file mode 100644
index 0000000..80737bc
--- /dev/null
+++ b/doc/functions/gnutls_cipher_init
@@ -0,0 +1,22 @@
+
+
+
+
+@deftypefun {int} {gnutls_cipher_init} (gnutls_cipher_hd_t * @var{handle}, gnutls_cipher_algorithm_t @var{cipher}, const gnutls_datum_t * @var{key}, const gnutls_datum_t * @var{iv})
+@var{handle}: is a @code{gnutls_cipher_hd_t} type
+
+@var{cipher}: the encryption algorithm to use
+
+@var{key}: the key to be used for encryption/decryption
+
+@var{iv}: the IV to use (if not applicable set NULL)
+
+This function will initialize the @code{handle} 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.
+
+@strong{Returns:} Zero or a negative error code on error.
+
+@strong{Since:} 2.10.0
+@end deftypefun
diff --git a/doc/functions/gnutls_cipher_init.short b/doc/functions/gnutls_cipher_init.short
new file mode 100644
index 0000000..209eacb
--- /dev/null
+++ b/doc/functions/gnutls_cipher_init.short
@@ -0,0 +1 @@
+@item @var{int} @ref{gnutls_cipher_init} (gnutls_cipher_hd_t * @var{handle}, gnutls_cipher_algorithm_t @var{cipher}, const gnutls_datum_t * @var{key}, const gnutls_datum_t * @var{iv})