File Coverage

blib/lib/Crypt/Stream/RC4.pm

Criterion	Covered	Total	%
statement	10	10	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	14	100.0

package Crypt::Stream::RC4;

use strict;
use warnings;
our $VERSION = '0.089';

use CryptX;

sub CLONE_SKIP { 1 } # prevent cloning

1;

=pod

=head1 NAME

Crypt::Stream::RC4 - Stream cipher RC4

=head1 SYNOPSIS

   use Crypt::Stream::RC4;

   # encrypt
   my $key = "1234567890123456";
   my $enc_stream = Crypt::Stream::RC4->new($key);
   my $ct = $enc_stream->crypt("plain message");

   # decrypt
   my $dec_stream = Crypt::Stream::RC4->new($key);
   my $pt = $dec_stream->crypt($ct);

=head1 DESCRIPTION

Provides an interface to the RC4 stream cipher.

=head1 METHODS

Unless noted otherwise, assume C<$stream> is an existing stream object created
via C, for example:

 my $stream = Crypt::Stream::RC4->new($key);

=head2 new

 my $stream = Crypt::Stream::RC4->new($key);
 # $key .. [binary string] length 5-256 bytes (40 - 2048 bits)

=head2 crypt

Encrypts or decrypts data. The output has the same length as the input.
Returns a binary string (raw bytes).

The input is converted using Perl's usual scalar stringification. Passing
C is treated as an empty string with the usual warning, and numeric
scalars are stringified before processing.

 my $ciphertext = $stream->crypt($plaintext);
 #or
 my $plaintext = $stream->crypt($ciphertext);

=head2 keystream

Returns C<$length> bytes of raw keystream as a binary string.

The length is taken using Perl's usual numeric coercion. Values that coerce to
an oversized unsigned length are rejected as too large.

 my $random_key = $stream->keystream($length);

=head2 clone

Returns a copy of the stream cipher object in its current state.

 my $stream2 = $stream->clone();

=head1 SEE ALSO

=over

=item * L, L, L, L

=item * L

=back

=cut