diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
commit | 36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch) | |
tree | 6c68e0c0097987aff85a01dabddd34b862309a7c /doc/functions/gnutls_aead_cipher_encrypt | |
parent | Initial commit. (diff) | |
download | gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip |
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/functions/gnutls_aead_cipher_encrypt')
-rw-r--r-- | doc/functions/gnutls_aead_cipher_encrypt | 33 |
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 |