GNUTLS_CRYPTO_REGISTER_AEAD_CIPHER(3)

📦
version 3.8.13 · 7 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, fedora 43, fedora 44, ubuntu stonking

💖 NAME 💖

gnutls_crypto_register_aead_cipher — it's an API function, bestie. That's the whole vibe. It registers an AEAD cipher with GnuTLS. ✨

This page lives in the gnutls manual (section 3, the library-calls girlies), so if you were looking for the man page, you found her. 🎀

🌸 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);

Seven arguments. Seven. She's high maintenance and we love that for her. 💅

🦋 ARGUMENTS 🦋

  • gnutls_cipher_algorithm_t algorithm — this is the GnuTLS AEAD cipher identifier, aka which cipher you're claiming. 👑
  • int priority — the priority of the algorithm. Number go brrr, lowest one wins (more on that below, stay with me). 🌈
  • gnutls_cipher_init_func init — a function which initializes the cipher. Wake her up. ⭐
  • gnutls_cipher_setkey_func setkey — a function which sets the key of the cipher. Give her the keys to the kingdom. 🔑
  • gnutls_cipher_aead_encrypt_func aead_encrypt — perform the AEAD encryption. Lock it in. 🔥
  • gnutls_cipher_aead_decrypt_func aead_decrypt — perform the AEAD decryption. Unlock it. 🔓
  • gnutls_cipher_deinit_func deinit — a function which deinitializes the cipher. Say bye, she's going to sleep. 😴

✨ DESCRIPTION ✨

Okay so. This function will register a cipher algorithm to be used by gnutls. Like, you're sliding your own custom cipher into the rotation. 💖

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. Yes, lowest. Not highest. It's giving backwards but it's canon. 🫶

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. So it's not a fail, it's a "next bestie up" situation. 🙈

The functions registered will be used with the new AEAD API introduced in GnuTLS 3.4.0. Internally GnuTLS uses the new AEAD API. So like, this is the main character path, not the legacy side quest. 👑

💀 DEPRECATED 💀

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

Not me delivering bad news but. Yeah. She's deprecated, bestie. Since 3.7.0 you literally cannot override the cipher implementation anymore. Pour one out. 😭

🌟 RETURNS 🌟

GNUTLS_E_SUCCESS on success, otherwise a negative error code. Classic. Negative means it's not giving what it's supposed to give. 💜

🧚 SINCE 🧚

3.4.0 — she's been around. Vintage. Iconic. ⭐

🍓 REPORTING BUGS 🍓

Found a bug? Tell the gnutls girlies:

Copyright © 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. Slay, legally speaking. 🎀

🌈 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:

https://www.gnutls.org/manual/

And that's the whole page, bestie — no cap, every flag, every argument, every caveat, untouched. 💖

This was the gnutls_crypto_register_aead_cipher(3) page from the gnutls manual, version 3.8.13. Mwah. 🫶✨

📦 where this page comes from