Blame doc/functions/gnutls_crypto_register_cipher

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_crypto_register_cipher} (gnutls_cipher_algorithm_t @var{algorithm}, int @var{priority}, gnutls_cipher_init_func @var{init}, gnutls_cipher_setkey_func @var{setkey}, gnutls_cipher_setiv_func @var{setiv}, gnutls_cipher_encrypt_func @var{encrypt}, gnutls_cipher_decrypt_func @var{decrypt}, gnutls_cipher_deinit_func @var{deinit})
Packit Service 4684c1
@var{algorithm}: is the gnutls algorithm identifier
Packit Service 4684c1
Packit Service 4684c1
@var{priority}: is the priority of the algorithm
Packit Service 4684c1
Packit Service 4684c1
@var{init}: A function which initializes the cipher
Packit Service 4684c1
Packit Service 4684c1
@var{setkey}: A function which sets the key of the cipher
Packit Service 4684c1
Packit Service 4684c1
@var{setiv}: A function which sets the nonce/IV of the cipher (non-AEAD)
Packit Service 4684c1
Packit Service 4684c1
@var{encrypt}: A function which performs encryption (non-AEAD)
Packit Service 4684c1
Packit Service 4684c1
@var{decrypt}: A function which performs decryption (non-AEAD)
Packit Service 4684c1
Packit Service 4684c1
@var{deinit}: A function which deinitializes the cipher
Packit Service 4684c1
Packit Service 4684c1
This function will register a cipher algorithm to be used by
Packit Service 4684c1
gnutls.  Any algorithm registered will override the included
Packit Service 4684c1
algorithms and by convention kernel implemented algorithms have
Packit Service 4684c1
priority of 90 and CPU-assisted of 80.  The algorithm with the lowest priority will be
Packit Service 4684c1
used by gnutls.
Packit Service 4684c1
Packit Service 4684c1
In the case the registered init or setkey functions return @code{GNUTLS_E_NEED_FALLBACK} ,
Packit Service 4684c1
GnuTLS will attempt to use the next in priority registered cipher.
Packit Service 4684c1
Packit Service 4684c1
The functions which are marked as non-AEAD they are not required when
Packit Service 4684c1
registering a cipher to be used with the new AEAD API introduced in
Packit Service 4684c1
GnuTLS 3.4.0. Internally GnuTLS uses the new AEAD API.
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} @code{GNUTLS_E_SUCCESS}  on success, otherwise a negative error code.
Packit Service 4684c1
Packit Service 4684c1
@strong{Since:} 3.4.0
Packit Service 4684c1
@end deftypefun