gnutls_aead_cipher_decrypt(3)

1gnutls_aead_cipher_decrypt(3)       gnutls       gnutls_aead_cipher_decrypt(3)
2
3
4

NAME

6       gnutls_aead_cipher_decrypt - API function
7

SYNOPSIS

9       #include <gnutls/crypto.h>
10
11       int  gnutls_aead_cipher_decrypt(gnutls_aead_cipher_hd_t  handle,  const
12       void * nonce, size_t nonce_len, const void  *  auth,  size_t  auth_len,
13       size_t  tag_size,  const  void * ctext, size_t ctext_len, void * ptext,
14       size_t * ptext_len);
15

ARGUMENTS

17       gnutls_aead_cipher_hd_t handle
18                   is a gnutls_aead_cipher_hd_t type.
19
20       const void * nonce
21                   the nonce to set
22
23       size_t nonce_len
24                   The length of the nonce
25
26       const void * auth
27                   additional data to be authenticated
28
29       size_t auth_len
30                   The length of the data
31
32       size_t tag_size
33                   The size of the tag to use (use zero for the default)
34
35       const void * ctext
36                   the data to decrypt (including the authentication tag)
37
38       size_t ctext_len
39                   the length of data to decrypt (includes tag size)
40
41       void * ptext
42                   the decrypted data
43
44       size_t * ptext_len
45                   the length of decrypted data (initially must hold the maxi‐
46                   mum available size)
47

DESCRIPTION

49       This function will decrypt the given data using the algorithm specified
50       by the context. This function must be provided the complete data to  be
51       decrypted,  including  the authentication tag. On several AEAD ciphers,
52       the authentication tag is appended to the ciphertext,  though  this  is
53       not  a  general  rule.  This function will fail if the tag verification
54       fails.
55

RETURNS

57       Zero or a negative error code on verification failure or other error.
58

SINCE

60       3.4.0
61

REPORTING BUGS

63       Report bugs to <bugs@gnutls.org>.
64       Home page: https://www.gnutls.org
65
66

COPYRIGHT

68       Copyright © 2001-2020 Free Software Foundation, Inc., and others.
69       Copying and distribution of this file, with  or  without  modification,
70       are  permitted  in  any  medium  without royalty provided the copyright
71       notice and this notice are preserved.
72