KCAPI_AEAD_STREAM_OP(3)

📦
version 1.5.0 · 7 versions
, in fedora 43

✨ KCAPI_AEAD_STREAM_OP ✨

okay bestie, gather round, because today we're talking about kcapi_aead_stream_op from the libkcapi crew — it's a section 3 library girlie and she is literally the one who hands you back your processed data. stream edition. 💅

🌸 NAME 🌸

kcapi_aead_stream_op — obtain processed data (stream)

🦋 SYNOPSIS 🦋

ssize_t kcapi_aead_stream_op(struct kcapi_handle * handle,
                             struct iovec * iov, size_t iovlen);

🎀 ARGUMENTS 🎀

  • handle — [in] the cipher handle. your main character. the whole vibe depends on her.
  • iov — [out] a scatter/gather list pointing at the buffers that are gonna get filled with the resulting data from a cipher operation. so like, she's not reading from these, she's blessing them with output. 🫶
  • iovlen — [in] the number of outiov scatter/gather list elements. yes, outiov, that's the actual spelling in the docs, we don't make the rules, we just respect them. 🙈

💖 DESCRIPTION 💖

so here's the tea. this function may cause the caller to sleep 😴 if the kernel buffer holding the data is empty. it's not ghosting you, it's just napping. the process will get woken up once more data shows up — and that data arrives by calling kcapi_cipher_stream_update. so basically: no data, no vibes, we wait.

🚨 important note bestie: when you supply buffers that are not a multiple of block size, the buffers will only be filled up to the maximum number of full block sizes that fit into the buffer. she gives you whole blocks only, periodt. the leftover partial block gets left on read. 💀

and the return value, because we love a girl who communicates:

  • on success: the number of bytes obtained from the kernel. slay. ⭐
  • on error: a negative errno-style error code. not slay, but informative. 😭

👑 AUTHOR 👑

Stephan Mueller <smueller@chronox.de> — Author.

(we stan a documented legend ✨)

libkcapi Manual 1.5.0, July 2025 — and that's the whole copyright section, no cap.

💌 sign-off time: this page came to you straight from the libkcapi Manual, version 1.5.0, dated July 2025, filed under KCAPI_AEAD_STREAM_OP(3). read her, love her, call kcapi_cipher_stream_update before you expect anything. bye bestie, go encrypt something iconic 💜🦋🎀
📦 where this page comes from