Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
gnutls_aead_cipher_decrypt(3)	     gnutls	   gnutls_aead_cipher_decrypt(3)

NAME
     gnutls_aead_cipher_decrypt - API function

SYNOPSIS
     #include <gnutls/crypto.h>

     int gnutls_aead_cipher_decrypt(gnutls_aead_cipher_hd_t handle, const void *
     nonce,  size_t  nonce_len,  const	void  *  auth,	size_t	auth_len, size_t
     tag_size, const void * ctext, size_t ctext_len,  void  *  ptext,  size_t  *
     ptext_len);

ARGUMENTS
     gnutls_aead_cipher_hd_t handle
		 is a gnutls_aead_cipher_hd_t type.

     const void * nonce
		 the nonce to set

     size_t nonce_len
		 The length of the nonce

     const void * auth
		 additional data to be authenticated

     size_t auth_len
		 The length of the data

     size_t tag_size
		 The size of the tag to use (use zero for the default)

     const void * ctext
		 the data to decrypt (including the authentication tag)

     size_t ctext_len
		 the length of data to decrypt (includes tag size)

     void * ptextthe decrypted data

     size_t * ptext_len
		 the  length  of decrypted data (initially must hold the maximum
		 available size)

DESCRIPTION
     This function will decrypt the given data using the algorithm specified  by
     the  context.  This  function  must be provided the complete data to be de-
     crypted, including the authentication tag. On several AEAD ciphers, the au-
     thentication tag is appended to the ciphertext, though this is not  a  gen-
     eral rule. This function will fail if the tag verification fails.

RETURNS
     Zero or a negative error code on verification failure or other error.

SINCE
     3.4.0

REPORTING BUGS
     Report bugs to <bugs@gnutls.org>.
     Home page: https://www.gnutls.org

COPYRIGHT
     Copyright (C) 2001-2023 Free Software Foundation, Inc., and others.
     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.

SEE ALSO
     The  full	documentation  for gnutls is maintained as a Texinfo manual.  If
     the /usr/local/share/doc/gnutls/ directory does not contain the  HTML  form
     visit

     https://www.gnutls.org/manual/

gnutls				     3.8.13	   gnutls_aead_cipher_decrypt(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gnutls_aead_cipher_decrypt&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help