File::...Stream(3pm)

💖 File::KDBX::Cipher::Stream — the whole vibe 💖

okay so bestie, you found it: this is the manual page for File::KDBX::Cipher::Stream, straight outta the User Contributed Perl Documentation, and the page itself gets filed under the lil' abbreviated name File::...Stream(3pm) (she's got a long government name, it's fine). grab a snack, we're doing stream ciphers 🦋

---

✨ VERSION ✨

version 0.906 — yes she's got a version, she's official, slay 👑

---

🌸 SYNOPSIS 🌸

the whole personality in four lines, no cap:

use File::KDBX::Cipher::Stream;

my $cipher = File::KDBX::Cipher::Stream->new(algorithm => $algorithm, key => $key, iv => $iv);

literally that's it. build her, then she's ready 💅

---

🫶 DESCRIPTION 🫶

so File::KDBX::Cipher::Stream is a subclass of File::KDBX::Cipher, and what she does — her entire job, her main character moment — is encrypting and decrypting data using a stream cipher. that's the assignment and she ate, fr fr 🔥

---

🎀 ATTRIBUTES 🎀

counter

$counter = $cipher->counter;

get the initial counter / block count into the keystream 🧮 like, where in the keystream she's starting from, block-wise.

offset

$offset = $cipher->offset;

get the initial byte offset into the keystream 🌈 one byte at a time, precise lil' thing.

real talk tho: this one has precedence over "counter" if both are set. so if you set both?? offset wins, periodt. no drama, just rules. 👑

---

💜 METHODS 💜

crypt

$ciphertext = $cipher->crypt($plaintext);
$plaintext = $cipher->crypt($ciphertext);

encrypt or decrypt some data 🫧 and here's the iconic part: these ciphers are symmetric, so encryption and decryption are literally the same operation. you hand her plaintext, you get ciphertext. you hand her ciphertext, you get plaintext. she's ambidextrous, she doesn't care, she's just that girl 💅

oh and also? this method is an alias for both "encrypt" in File::KDBX::Cipher and "decrypt" in File::KDBX::Cipher. two names, one function, we love a versatile queen 👑

keystream

$stream = $cipher->keystream;

access the keystream 🌊 the actual stream of bytes doing the work. peek at it, it's right there, it's not shy.

dup

$cipher_copy = $cipher->dup(%attributes);

get a copy of an existing cipher — except with the counter reset 🔄 — and optionally slap some new attributes on while you're at it (%attributes, look at her being flexible). a lil' clone with amnesia about the counter. iconic behavior honestly 🧚

---

😭 BUGS 😭

bestie. if something's broken, please don't suffer in silence.

• report any bugs or feature requests on the bugtracker website: <https://github.com/chazmcgarvey/File-KDBX/issues>

and when you submit a bug or a request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature 🙈 like, show us the receipts, we cannot debug a vibe alone.

---

👑 AUTHOR 👑

Charles McGarvey <ccm@cpan.org> — the legend, the author, we stan. 💖

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2022 by Charles McGarvey.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. ✨ (free software, free as in go off, fr fr)

---

aaaand that's the whole page, we're done here 🎀 this was perl v5.40.1, dated 2025-05-04, and it's the File::...Stream(3pm) page — bye bestie, encrypt responsibly, mwah 💜