Author image Ron W
and 1 contributors

NAME

Crypt::RS14_PP - A pure Perl implementation of RS14, aka "Spritz", encryption algorithm.

Version

0.03

SYNOPSIS

    use Crypt::RS14_PP;

    my $key   = '16 to 64 bytes of key';
    my $rs14  = Crypt::RS14_PP->new($key);
    my $ctext = $rs14->encrypt('This is my plain text.');
    $rs14->set_key($key);
    my $ptext = $rs14->encrypt($ctext); # or decrypt as both do the same
    print "$ptext\n"; # prints 'This is my plain text.'

DESCRIPTION

RS14, aka "Spritz", is an encryption algorithm, proposed by Ron Rivist and Jacob Schuldt, as a replacement for RC4, created by Ron Rivist. RS14, like RC4, is a stream algorithm. It takes the basic concepts behind RC4, enhancing and updating them for greater security.

Being pure Perl, this module is really just a testing tool. An XS or Inline::C implementation will provide far better performance.

Note: While this module's API is a superset of the Crypt:: API, the RS14 algorithm is not intended for use with Crypt::CBC or similar. By its nature, it already operates in OFB (Output Feedback) mode.

Note: Only the encrypt/decrypt capabilities of RS14 are implmented.

Note: In this module, encrypt/decrypt use bitwise exclusive-or (^) to encipher/decipher the input, as this is commonly used in stream ciphers. As a consequence, encrypt and decrypt are the same. Other operations are possible. This not specified in the algorithm specification.

Note: To encrypt "wide characters", such as Unicode, the character stream must be encoded into a byte stream before encrypting. (For Unicode, use UTF-8 encoding.) Whatever encoding is used, security is enhanced by excluding any byte order marks.

Class Methods

Function new

Creates a RS14 object and optionally sets the cryptographic key.

Parameter scalar $key

Key (optional - used for compatability with other Crypt:: modules)

Instance Methods

Function set_key

Sets the cryptographic key.

Parameter scalar $key

Key - 16 to N/4 bytes of key

Function encrypt

Encrypt (or decrypt) the given data bytes. (This function is identical to decrypt.)

Note: Because this is a stream cipher, encrypt("ab") eq encrypt("a") . encrypt("b"). To encrypt (or decrypt) 2 messages with same key, you must set_key($key) before each message. Also, to encrypt and decrypt with same key, you must set_key($key) between encrypting and decrypting (or use 2 objects).

Parameter scalar $string

Byte string to encrypt or decrypt

Function decrypt

Decrypt (or encrypt) the given data bytes. (This function is identical to encrypt.)

See "encrypt".

REFERENCES

Spritz - a spongy RC4-like stream cipher and hash function, 2014, Ronald L. Rivest, MIT and Jacob C. N. Schuldt, AIST (Japan) http://people.csail.mit.edu/rivest/pubs/RS14.pdf

AUTHOR

RonW, <ronw at cpan.org>

BUGS

Please report any bugs or feature requests to bug-crypt-rs14_pp at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Crypt-RS14_PP. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Crypt::RS14_PP

LICENSE AND COPYRIGHT

Copyright 2015 RonW, ronw at cpan.org

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.