gnutls_aead_cipher_encrypt(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

💖 gnutls_aead_cipher_encrypt — bestie edition 💖

okay so. this is gnutls_aead_cipher_encrypt(3) from the gnutls manual, and it's genuinely one of my faves. it's an API function, it lives in the gnutls crypto world, and it's giving "let me scramble your secrets and also hand you a little proof tag". 🎀

✨ SYNOPSIS ✨

#include <gnutls/crypto.h>

int gnutls_aead_cipher_encrypt(gnutls_aead_cipher_hd_t handle, const
void * nonce, size_t nonce_len, const void * auth, size_t auth_len,
size_t tag_size, const void * ptext, size_t ptext_len, void * ctext,
size_t * ctext_len);

like… look at her. eight-ish params, all doing their little job. no cap. 💅

🌸 ARGUMENTS 🌸

  • gnutls_aead_cipher_hd_t handle — bestie this is a gnutls_aead_cipher_hd_t type. that's it. that's the whole description. the handle. your girl.
  • const void * nonce — the nonce we're setting. the little one-time number that keeps things fresh ✨
  • size_t nonce_len — how long that nonce is.
  • const void * auth — additional data that gets authenticated. it's not encrypted, it's just verified, and honestly? iconic behaviour.
  • size_t auth_len — the length of that data.
  • size_t tag_size — how big you want the tag to be. and listen: use zero for the default, okay? 0 = let gnutls pick. 🫶
  • const void * ptext — the data you wanna encrypt. the plaintext. the tea. 🙈
  • size_t ptext_len — the length of the data to encrypt.
  • void * ctext — the encrypted data, including the authentication tag. yes, the tag rides along in here. it's a package deal.
  • size_t * ctext_len — the length of the encrypted data. and here's the catch bestie: initially this must hold the maximum available size, including space for the tag. you gotta tell it up front how much room you have, fr fr. 😭

💜 DESCRIPTION 💜

this function encrypts the data you give it, using the algorithm specified by the context. and then — the fun part — the output data will contain the authentication tag too. so you get your ciphertext and the proof that it's legit, all in one. slay. 🔥

⭐ RETURNS ⭐

zero on success, or a negative error code on error. that's the whole vibe check.

🦋 SINCE 🦋

3.4.0 — she's been around a minute, and she's aged beautifully. 👑

🎀 REPORTING BUGS 🎀

found a bug? don't be shy, 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. (translation: keep the receipts, bestie, and you're golden. 💖)

👑 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, go visit:

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

ok that's the whole page, no notes, every option and arg accounted for, nothing skipped. 💅

and that's a wrap, bestie!! this was gnutls version 3.8.13, page dated gnutls_aead_cipher_encrypt(3) — go encrypt something cute and stay hydrated. 🍓💜✨

📦 where this page comes from