summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_aead_cipher_encrypt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functions/gnutls_aead_cipher_encrypt')
-rw-r--r--doc/functions/gnutls_aead_cipher_encrypt33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/functions/gnutls_aead_cipher_encrypt b/doc/functions/gnutls_aead_cipher_encrypt
new file mode 100644
index 0000000..a66c7a9
--- /dev/null
+++ b/doc/functions/gnutls_aead_cipher_encrypt
@@ -0,0 +1,33 @@
+
+
+
+
+@deftypefun {int} {gnutls_aead_cipher_encrypt} (gnutls_aead_cipher_hd_t @var{handle}, const void * @var{nonce}, size_t @var{nonce_len}, const void * @var{auth}, size_t @var{auth_len}, size_t @var{tag_size}, const void * @var{ptext}, size_t @var{ptext_len}, void * @var{ctext}, size_t * @var{ctext_len})
+@var{handle}: is a @code{gnutls_aead_cipher_hd_t} type.
+
+@var{nonce}: the nonce to set
+
+@var{nonce_len}: The length of the nonce
+
+@var{auth}: additional data to be authenticated
+
+@var{auth_len}: The length of the data
+
+@var{tag_size}: The size of the tag to use (use zero for the default)
+
+@var{ptext}: the data to encrypt
+
+@var{ptext_len}: The length of data to encrypt
+
+@var{ctext}: the encrypted data including authentication tag
+
+@var{ctext_len}: the length of encrypted data (initially must hold the maximum available size, including space for tag)
+
+This function will encrypt the given data using the algorithm
+specified by the context. The output data will contain the
+authentication tag.
+
+@strong{Returns:} Zero or a negative error code on error.
+
+@strong{Since:} 3.4.0
+@end deftypefun