.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_crypto_register_aead_cipher" 3 "3.6.7" "gnutls" "gnutls"
.SH NAME
gnutls_crypto_register_aead_cipher \- API function
.SH SYNOPSIS
.B #include <gnutls/crypto.h>
.sp
.BI "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 ");"
.SH ARGUMENTS
.IP "gnutls_cipher_algorithm_t algorithm" 12
is the gnutls AEAD cipher identifier
.IP "int priority" 12
is the priority of the algorithm
.IP "gnutls_cipher_init_func init" 12
A function which initializes the cipher
.IP "gnutls_cipher_setkey_func setkey" 12
A function which sets the key of the cipher
.IP "gnutls_cipher_aead_encrypt_func aead_encrypt" 12
Perform the AEAD encryption
.IP "gnutls_cipher_aead_decrypt_func aead_decrypt" 12
Perform the AEAD decryption
.IP "gnutls_cipher_deinit_func deinit" 12
A function which deinitializes the cipher
.SH "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 \fBGNUTLS_E_NEED_FALLBACK\fP,
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.
.SH "RETURNS"
\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code.
.SH "SINCE"
3.4.0
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001-2021 Free Software Foundation, Inc., and others.
.br
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.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP