Source for file RC42.php

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP Version 5                                                        |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2004 The PHP Group                                |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license,       |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.php.net/license/2_02.txt.                                 |
// | If you did not receive a copy of the PHP license and are unable to   |
// | obtain it through the world-wide-web, please send a note to          |
// | license@php.net so we can mail you a copy immediately.               |
// +----------------------------------------------------------------------+
// | Authors: Dave Mertens <zyprexia@php.net>                             |
// +----------------------------------------------------------------------+
//
// $Id: RC42.php 304006 2010-10-04 13:15:17Z clockwerx $
 
 
/**
 * RC4 stream cipher routines implementation.
 *
 * in PHP5(!) based on code written by Damien Miller <djm@mindrot.org>
 * This class <b>BREAKS COMPABILITY</b> with earlier PHP 4 versions of the RC4 class.
 * PHP 4 versions are available at http://pear.php.net/package/Crypt_RC42, download version 1.x
 *
 *
 * Basic usage of this class
 * <code>
 * $key = "pear";
 * $message = "PEAR rulez!";
 *
 * $rc4 = new Crypt_RC42();
 * $rc4->key($key);
 * echo "Original message: $message <br />\n";
 *
 * $message = $rc4->encrypt($message);
 * $safe_codedmessage = base64_encode($message);
 * echo "Encrypted message: $safe_codedmessage <br />\n";
 *
 * $message $rc4->decrypt($message);
 * echo "Decrypted message: $message <br />\n";
 * </code>
 *
 * Another example how the class can be used
 * <code>
 * $origmessage = "PEAR Rulez!";
 *
 * $rc4 = new Crypt_RC42("pear");
 * $codedmessage = $rc4->encrypt($origmessage);
 * $safe_codedmessage = base64_encode($codedmessage);
 * echo "Encrypted message: $safe_codedmessage <br />\n";
 * </code>
 *
 * Note: The encrypted output is binary, and therefore cannot be properly
 * displayed in shell or a browser. If you would like to display, please
 * use the base64_encode function as above.
 *
 * @category Crypt
 * @package Crypt
 * @author Dave Mertens <zyprexia@php.net>
 * @version $Revision: 304006 $
 * @access public
 */
 
class Crypt_RC42 {
 
    /**
     * Contains salt key used by en(de)cryption function
     *
     * @var array 
     * @access protected
     */
    protected $s= array();
 
    /**
     * First Part of encryption matrix
     *
     * @var array 
     * @access protected
     */
    protected $i= 0;
 
    /**
     * Second part of encryption matrix
     *
     * @var array 
     * @access protected
     */
    protected $j= 0;
 
    /**
     * symmetric key used for encryption.
     *
     * @var string 
     * @access public
     */
    protected $key;    //variable itself is protected, but is made accessibly using __get and __set method
 
    /**
     * Constructor for encryption class
     * Pass encryption key to key()
     *
     * @param  string $key a key which will be used for encryption
     * @return void 
     * @access public
     * @see    Key()
     */
    function __construct($key = null)
    {
        if ($key != null) {
            $this->key($key);
        }
    }
 
    /**
     * Encrypt function
     *
     * Note: The encrypted output of this function isa  binary string, and
     * therefore cannot be properly displayed in shell or a browser. If you
     * would like to display, please use the base64_encode function before
     * before output.
     *
     * @param  string $paramstr string that will decrypted
     * @return string Encrypted string
     * @access public
     */
    public function encrypt($paramstr)
    {
        //Decrypt is exactly the same as encrypting the string. Reuse (en)crypt code
        return $this->_crypt($paramstr);
    }
 
    /**
     * Decrypt function
     *
     * @param  string $paramstr string that will decrypted
     * @return string Decrypted string
     * @access public
     */
    public function decrypt($paramstr)
    {
        //Decrypt is exactly the same as encrypting the string. Reuse (en)crypt code
        return $this->_crypt($paramstr);
    }
 
    /**
     * Assign encryption key to class
     *
     * @param  string $key Key which will be used for encryption
     * @return void 
     * @access public
     */
    public function key($key)
    {
        $this->_initializeKey($key);
    }
 
 
    /**
     * The only way for retrieving the encryption key
     *
     * @param string $property Only property 'key' is supported
     * @return string Enecryption key
     * @access protected
     */
    public function __get($property)
    {
        switch (strtolower($property)) {
            case "key":
                return $this->key;
                break;
        }
    }
 
    /**
     * Alternative way to set the encryption key
     *
     * @param string $property Only property 'key' is supported
     * @param string $value Value for property
     * @return void 
     * @access protected
     */
    public function __set($property, $value)
    {
        switch (strtolower($property)) {
            case "key":
                return $this->_initializeKey($value);
                break;
        }
    }
 
    // PROTECTED FUNCTIONS
 
    /**
     * (en/de) crypt function.
     * Function can be used for encrypting and decrypting a message
     *
     * @param  string $paramstr string that will encrypted
     * @return Encrypted or decrypted message
     * @access protected
     */
    protected function _crypt($paramstr)
    {
        //Init key for every call, Bugfix for PHP issue #22316
        $temp_matrix = $this->s;
        $this->i = 0;
        $this->j = 0;
 
        $this->_initializeKey($this->key);
 
        //length of message
        $len= strlen($paramstr);
 
        //Encrypt message
        for ($c= 0; $c < $len; $c++) {
            $this->i = ($this->i + 1) % 256;
            $this->j = ($this->j + $this->s[$this->i]) % 256;
            $t = $this->s[$this->i];
            $this->s[$this->i] = $this->s[$this->j];
            $this->s[$this->j] = $t;
 
            $t = ($this->s[$this->i] + $this->s[$this->j]) % 256;
 
            $paramstr[$c] = chr(ord($paramstr[$c]) ^ $this->s[$t]);
        }
 
        $this->s = $temp_matrix;
        return $paramstr;
    }
 
    /**
     * This method prevents changes to the key during the encryption procedure.
     *
     * @param  string $key key which will be used for encryption
     * @return void 
     * @access protected
     * @todo   Implement error handling!
     */
    protected function _initializeKey($key)
    {
        //better string validation
        if ( is_string($key) && strlen($key) > 0 ) {
 
            //Only initialize key if it's different
            if ($key != $this->key) {
                $this->key = $key;
 
                $len= strlen($key);
 
                //Create array matrix
                for ($this->i = 0; $this->i < 256; $this->i++) {
                    $this->s[$this->i] = $this->i;
                }
 
                //Initialize encryption matrix
                $this->j = 0;
 
                for ($this->i = 0; $this->i < 256; $this->i++) {
                    $this->j = ($this->j + $this->s[$this->i] + ord($key[$this->i % $len])) % 256;
                    $t = $this->s[$this->i];
                    $this->s[$this->i] = $this->s[$this->j];
                    $this->s[$this->j] = $t;
                }
                $this->i = $this->j = 0;
            }
        }
        else {
            //throw exception (which exception are available in php5 by default??)
            //throw new Exception("Please provide an valid encryption key");
        }
    }
}    //end of RC4 class
?>