gnutls_crypto_register_cipher(3) — Linux manual page


gnutls_crypto_register_cipher(3)   gnutls   gnutls_crypto_register_cipher(3)

NAME         top

       gnutls_crypto_register_cipher - API function

SYNOPSIS         top

       #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         top

       gnutls_cipher_algorithm_t algorithm
                   is the gnutls algorithm identifier

       int priority
                   is 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

       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         top

       This function will register a cipher algorithm to be used by gnutls.
       Any algorithm registered will override the included algorithms and by
       convention 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
       registering a cipher to be used with the new AEAD API introduced in
       GnuTLS 3.4.0. Internally GnuTLS uses the new AEAD API.

RETURNS         top

       GNUTLS_E_SUCCESS on success, otherwise a negative error code.

SINCE         top


REPORTING BUGS         top

       Report bugs to <>.
       Home page:

COPYRIGHT         top

       Copyright © 2001-2019 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         top

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

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug report for this manual
       page, send it to  This page was obtained from the
       tarball gnutls-3.6.9.tar.xz fetched from
       ⟨⟩ on 2020-09-18.  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail

gnutls                              3.6.9   gnutls_crypto_register_cipher(3)