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

FreeBSD Manual Pages

  
 
  

home | help
gnutls_crypto_register_cipher(3)     gnutls	gnutls_crypto_register_cipher(3)

NAME
     gnutls_crypto_register_cipher - API function

SYNOPSIS
     #include <gnutls/crypto.h>

     int  gnutls_crypto_register_cipher(gnutls_cipher_algorithm_t algorithm, int
     priority, gnutls_cipher_init_func init,  gnutls_cipher_setkey_func  setkey,
     gnutls_cipher_setiv_func	 setiv,    gnutls_cipher_encrypt_func	encrypt,
     gnutls_cipher_decrypt_func decrypt, gnutls_cipher_deinit_func deinit);

ARGUMENTS
     gnutls_cipher_algorithm_t algorithm
		 is the gnutls algorithm identifier

     int priorityis the priority of the algorithm

     gnutls_cipher_init_func init
		 A function which initializes the cipher

     gnutls_cipher_setkey_func setkey
		 A function which sets the key of the cipher

     gnutls_cipher_setiv_func setiv
		 A function which sets the nonce/IV of the cipher (non-AEAD)

     gnutls_cipher_encrypt_func encrypt
		 A function which performs encryption (non-AEAD)

     gnutls_cipher_decrypt_func decrypt
		 A function which performs decryption (non-AEAD)

     gnutls_cipher_deinit_func deinit
		 A function which deinitializes the cipher

DESCRIPTION
     This function will register a cipher algorithm to be used by  gnutls.   Any
     algorithm	registered  will override the included algorithms and by conven-
     tion kernel implemented algorithms have priority of 90 and CPU-assisted  of
     80.  The algorithm with the lowest priority will be used by gnutls.

     In   the	case   the   registered   init	 or   setkey   functions  return
     GNUTLS_E_NEED_FALLBACK, GnuTLS will attempt to use  the  next  in	priority
     registered cipher.

     The  functions which are marked as non-AEAD they are not required when reg-
     istering a cipher to be used with the new AEAD  API  introduced  in  GnuTLS
     3.4.0. Internally GnuTLS uses the new AEAD API.

DEPRECATED
     since 3.7.0 it is no longer possible to override cipher implementation

RETURNS
     GNUTLS_E_SUCCESS on success, otherwise a negative error code.

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_crypto_register_cipher(3)

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

home | help