.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "File::KDBX::Cipher::Stream 3pm"
.TH File::KDBX::Cipher::Stream 3pm "2022-11-20" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
File::KDBX::Cipher::Stream \- A cipher stream encrypter/decrypter
.SH "VERSION"
.IX Header "VERSION"
version 0.906
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use File::KDBX::Cipher::Stream;
\&
\&    my $cipher = File::KDBX::Cipher::Stream\->new(algorithm => $algorithm, key => $key, iv => $iv);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A subclass of File::KDBX::Cipher for encrypting and decrypting data using a stream cipher.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "counter"
.IX Subsection "counter"
.Vb 1
\&    $counter = $cipher\->counter;
.Ve
.PP
Get the initial counter / block count into the keystream.
.SS "offset"
.IX Subsection "offset"
.Vb 1
\&    $offset = $cipher\->offset;
.Ve
.PP
Get the initial byte offset into the keystream. This has precedence over \*(L"counter\*(R" if both are set.
.SH "METHODS"
.IX Header "METHODS"
.SS "crypt"
.IX Subsection "crypt"
.Vb 2
\&    $ciphertext = $cipher\->crypt($plaintext);
\&    $plaintext = $cipher\->crypt($ciphertext);
.Ve
.PP
Encrypt or decrypt some data. These ciphers are symmetric, so encryption and decryption are the same
operation. This method is an alias for both \*(L"encrypt\*(R" in File::KDBX::Cipher and \*(L"decrypt\*(R" in File::KDBX::Cipher.
.SS "keystream"
.IX Subsection "keystream"
.Vb 1
\&    $stream = $cipher\->keystream;
.Ve
.PP
Access the keystream.
.SS "dup"
.IX Subsection "dup"
.Vb 1
\&    $cipher_copy = $cipher\->dup(%attributes);
.Ve
.PP
Get a copy of an existing cipher with the counter reset, optionally applying new attributes.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
<https://github.com/chazmcgarvey/File\-KDBX/issues>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "AUTHOR"
.IX Header "AUTHOR"
Charles McGarvey <ccm@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2022 by Charles McGarvey.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.