File Coverage

blib/lib/Crypt/PRNG/RC4.pm

Criterion	Covered	Total	%
statement	23	23	100.0
branch			n/a
condition			n/a
subroutine	13	13	100.0
pod	9	9	100.0
total	45	45	100.0

package Crypt::PRNG::RC4;

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

use base qw(Crypt::PRNG Exporter);
our %EXPORT_TAGS = ( all => [qw(random_bytes random_bytes_hex random_bytes_b64 random_bytes_b64u random_string random_string_from rand irand)] );
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
our @EXPORT = qw();

use CryptX;

sub new {
  my ($class, @args) = @_;
  my $obj = Crypt::PRNG->new('RC4', @args);
  return bless $obj, $class;
}

{
  ### stolen from Bytes::Random::Secure
  my $RNG_object = undef;
  my $fetch_RNG = sub { # Lazily, instantiate the RNG object, but only once.
    $RNG_object = Crypt::PRNG::RC4->new unless defined $RNG_object && ref($RNG_object) ne 'SCALAR';
    return $RNG_object;
  };
  sub rand               { return $fetch_RNG->()->double(@_) }
  sub irand              { return $fetch_RNG->()->int32(@_) }
  sub random_bytes       { return $fetch_RNG->()->bytes(@_) }
  sub random_bytes_hex   { return $fetch_RNG->()->bytes_hex(@_) }
  sub random_bytes_b64   { return $fetch_RNG->()->bytes_b64(@_) }
  sub random_bytes_b64u  { return $fetch_RNG->()->bytes_b64u(@_) }
  sub random_string_from { return $fetch_RNG->()->string_from(@_) }
  sub random_string      { return $fetch_RNG->()->string(@_) }
}


1;

=pod

=head1 NAME

Crypt::PRNG::RC4 - Legacy RC4-based PRNG wrapper

=head1 SYNOPSIS

   ### Functional interface:
   use Crypt::PRNG::RC4 qw(random_bytes random_bytes_hex random_bytes_b64 random_bytes_b64u random_string random_string_from rand irand);

   my $octets = random_bytes(45);
   my $hex_string = random_bytes_hex(45);
   my $base64_string = random_bytes_b64(45);
   my $base64url_string = random_bytes_b64u(45);
   my $alphanumeric_string = random_string(30);
   my $string = random_string_from('ACGT', 64);
   my $floating_point_number_0_to_1 = rand;
   my $floating_point_number_0_to_88 = rand(88);
   my $unsigned_32bit_int = irand;

   ### OO interface:
   use Crypt::PRNG::RC4;

   my $prng = Crypt::PRNG::RC4->new;
   my $seeded_prng = Crypt::PRNG::RC4->new("some data used for seeding PRNG");

   my $octets = $prng->bytes(45);
   my $hex_string = $prng->bytes_hex(45);
   my $base64_string = $prng->bytes_b64(45);
   my $base64url_string = $prng->bytes_b64u(45);
   my $alphanumeric_string = $prng->string(30);
   my $string = $prng->string_from('ACGT', 64);
   my $floating_point_number_0_to_1 = $prng->double;
   my $floating_point_number_0_to_88 = $prng->double(88);
   my $unsigned_32bit_int = $prng->int32;

=head1 DESCRIPTION

Provides an interface to the RC4-based pseudo-random number generator.

This is a thin wrapper around L with the algorithm fixed to RC4.
All functions and methods accept the same arguments and return the same values
as the corresponding L entries.

RC4 is provided for compatibility with legacy code only and is not recommended
for new designs.

=head1 EXPORT

Nothing is exported by default.

You can export selected functions:

  use Crypt::PRNG::RC4 qw(random_bytes random_string);

Or all of them at once:

  use Crypt::PRNG::RC4 ':all';

=head1 FUNCTIONS

All functions below behave exactly like the corresponding L
functions, but use a hidden C object internally.

=head2 random_bytes

See L.

=head2 random_bytes_hex

See L.

=head2 random_bytes_b64

See L.

=head2 random_bytes_b64u

See L.

=head2 random_string

See L.

=head2 random_string_from

See L.

=head2 rand

See L.

=head2 irand

See L.

=head1 METHODS

Unless noted otherwise, assume C<$prng> is an existing C
object created via C.

=head2 new

 my $prng = Crypt::PRNG::RC4->new;
 my $seeded_prng = Crypt::PRNG::RC4->new($seed);

Creates a PRNG object using the RC4 algorithm. If C<$seed> is omitted, the
object is automatically seeded by the underlying L logic. If
C<$seed> is provided it must be at least 5 bytes long; empty or shorter seeds
fail during initialization.

=head2 bytes

See L.

=head2 bytes_hex

See L.

=head2 bytes_b64

See L.

=head2 bytes_b64u

See L.

=head2 string

See L.

=head2 string_from

See L.

=head2 double

See L.

=head2 int32

See L.

=head1 SEE ALSO

=over

=item * L

=item * L

=back

=cut