gnutls_crypto_register_aead_cipher man page

gnutls_crypto_register_aead_cipher — API function

Synopsis

#include <gnutls/crypto.h>

int gnutls_crypto_register_aead_cipher(gnutls_cipher_algorithm_t algorithm, int priority, gnutls_cipher_init_func init, gnutls_cipher_setkey_func setkey, gnutls_cipher_aead_encrypt_func aead_encrypt, gnutls_cipher_aead_decrypt_func aead_decrypt, gnutls_cipher_deinit_func deinit);

Arguments

gnutls_cipher_algorithm_t algorithm
is the gnutls AEAD cipher 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_aead_encrypt_func aead_encrypt
Perform the AEAD encryption
gnutls_cipher_aead_decrypt_func aead_decrypt
Perform the AEAD decryption
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 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 registered will be used with the new AEAD API introduced in GnuTLS 3.4.0. Internally GnuTLS uses the new AEAD API.

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: http://www.gnutls.org

See Also

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

http://www.gnutls.org/manual/

Info

3.5.5 gnutls gnutls