Source for file Encrypt.class.php

Documentation is available at Encrypt.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Session
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Encrypted Session Class
  22.  *
  23.  * @category Gumbo
  24.  * @package Session
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc Encrypted Session Class
  30.  * @version 0.0.1
  31.  */
  32.  
  33. gumbo_load ("Interface_Session_Encrypt");
  34. gumbo_load ("Session_Basic");
  35. gumbo_load ("Encrypt");
  36. gumbo_load ("Decrypt");
  37.  
  38. class Gumbo_Session_Encrypt extends    Gumbo_Session_Basic implements Gumbo_Interface_Session_Encrypt {
  39.     
  40.     /** @var Gumbo_Encrypt $_encrypt */
  41.     private $_encrypt;
  42.     /** @var Gumbo_Decrypt $_decrypt */
  43.     private $_decrypt;
  44.     
  45.     
  46.     
  47.     /**
  48.      * Constructor
  49.      * @param string $key Encryption key
  50.      * @param string $cipher Encryption Cipher
  51.      * @param string $mode Encryption Mode
  52.      */
  53.     public function __construct ($key=null, $cipher=null, $mode=null) {
  54.         $this->setEncryptionSettings ($key, $cipher, $mode);
  55.     }
  56.     
  57.     
  58.     
  59.     /** MUTATOR METHODS **/
  60.     /**
  61.      * Sets Encryption/Decryption settings for the Encrypted Session
  62.      * @param string $key 
  63.      * @param string $cipher 
  64.      * @param string $mode 
  65.      * @uses Gumbo_Encrypt, Gumbo_Decrypt
  66.      */
  67.     public function setEncryptionSettings ($key=null, $cipher=null, $mode=null) {
  68.         $this->_encrypt = new Gumbo_Encrypt (null, $key, $cipher, $mode, true);
  69.         $this->_decrypt = new Gumbo_Decrypt (null, $key, $cipher, $mode, true);
  70.     }
  71.     
  72.     /**
  73.      * Sets a value inside the Session array
  74.      * @param string $key 
  75.      * @param mixed $val (primitive values only)
  76.      * @throws Gumbo_Exception
  77.      */
  78.     public function set ($key, $val) {
  79.         try {
  80.             // verify precondition
  81.             if (!is_string ($key)) {
  82.                 throw new Gumbo_Exception ("Invalid Argument 'key:str' => {$key}:" . gettype ($key));
  83.             }
  84.             if (!is_null ($val) && !is_bool ($val) && !is_numeric ($val) && !is_string ($val)) {
  85.                 throw new Gumbo_Exception ("Invalid Argument 'val:num|str|bool' => {$val}:" . gettype ($val));
  86.             }
  87.             
  88.             $this->_encrypt->setData ($key);
  89.             $key = $this->_encrypt->parse ();
  90.             
  91.             if (!is_null ($val)) {
  92.                 $this->_encrypt->setData ($val);
  93.                 $val = $this->_encrypt->parse ();
  94.             }
  95.             
  96.             $_SESSION [$key] = $val;
  97.         } catch (Gumbo_Exception $e) {
  98.             $e->setFunction (__METHOD__);
  99.             gumbo_trigger ($e);
  100.         }
  101.     }
  102.     
  103.     
  104.     
  105.     /** ACCESSOR METHODS **/
  106.     /**
  107.      * Returns the value of the Session variable
  108.      * @param string $key 
  109.      * @return string 
  110.      * @throws Gumbo_Exception
  111.      */
  112.     public function get ($key) {
  113.         try {
  114.             // verify precondition
  115.             if (!is_string ($key)) {
  116.                 throw new Gumbo_Exception ("Invalid Argument 'key:str' => {$key}:" . gettype ($key));
  117.             }
  118.             
  119.             $this->_encrypt->setData ($key);
  120.             $key = $this->_encrypt->parse ();
  121.             if (!isset ($_SESSION [$key])) {
  122.                 throw new Gumbo_Exception ("Invalid Session Variable: {$key}");
  123.             }
  124.             
  125.             $this->_decrypt->setData ($_SESSION [$key]);
  126.             return $this->_decrypt->parse ();
  127.         } catch (Gumbo_Exception $e) {
  128.             $e->setFunction (__METHOD__);
  129.             gumbo_trigger ($e);
  130.         }
  131.         return null;
  132.     }
  133.     
  134. }
  135.  
  136. ?>