inc/classes/main/crypto/class_CryptoHelper.php

   1 <?php
   2 /**
   3  * A helper class for cryptographical things like hashing passwords and so on
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
  25         // Exception constants
  26         const EXCEPTION_ENCRYPT_MISSING = 0x1f0;
  27         const EXCEPTION_ENCRYPT_INVALID = 0x1f1;
  28
  29         /**
  30          * An instance of this own clas
  31          */
  32         private static $selfInstance = null;
  33
  34         /**
  35          * Instance of the random number generator
  36          */
  37         private $rngInstance = null;
  38
  39         /**
  40          * Instance of the crypto stream
  41          */
  42         private $cryptoStreamInstance = null;
  43
  44         /**
  45          * Salt for hashing operations
  46          */
  47         private $salt = '';
  48
  49         /**
  50          * Protected constructor
  51          *
  52          * @return      void
  53          */
  54         protected function __construct () {
  55                 // Call parent constructor
  56                 parent::__construct(__CLASS__);
  57         }
  58
  59         /**
  60          * Creates an instance of this class
  61          *
  62          * @return      $cryptoInstance         An instance of this crypto helper class
  63          */
  64         public static final function createCryptoHelper () {
  65                 // Get a new instance
  66                 $cryptoInstance = new CryptoHelper();
  67
  68                 // Initialize the hasher
  69                 $cryptoInstance->initHasher();
  70
  71                 // Attach a crypto stream
  72                 $cryptoInstance->attachCryptoStream();
  73
  74                 // Return the instance
  75                 return $cryptoInstance;
  76         }
  77
  78         /**
  79          * Get a singleton instance of this class
  80          *
  81          * @return      $selfInstance   An instance of this crypto helper class
  82          */
  83         public static final function getInstance () {
  84                 // Is no instance there?
  85                 if (is_null(self::$selfInstance)) {
  86                         // Then get a new one
  87                         self::$selfInstance = self::createCryptoHelper();
  88                 } // END - if
  89
  90                 // Return the instance
  91                 return self::$selfInstance;
  92         }
  93
  94         /**
  95          * Attaches a crypto stream to this crypto helper by detecting loaded
  96          * modules.
  97          *
  98          * @return      void
  99          */
 100         protected function attachCryptoStream () {
 101                 // Do we have mcrypt loaded?
 102                 if ($this->isPhpExtensionLoaded('mcrypt')) {
 103                         // Then use it
 104                         $this->cryptoStreamInstance = ObjectFactory::createObjectByName('McryptStream', array($this->getRngInstance()));
 105                 } else {
 106                         // If nothing works ...
 107                         $this->cryptoStreamInstance = ObjectFactory::createObjectByName('NullCryptoStream');
 108                 }
 109         }
 110
 111         /**
 112          * Initializes the hasher for different purposes.
 113          *
 114          * @return      void
 115          */
 116         protected function initHasher () {
 117                 // Initialize the random number generator which is required by some crypto methods
 118                 $this->setRngInstance(ObjectFactory::createObjectByConfiguredName('rng_class'));
 119
 120                 // Generate a salt for the hasher
 121                 $this->generateSalt();
 122         }
 123
 124         /**
 125          * Generates the salt based on configured length
 126          *
 127          * @return      void
 128          */
 129         private function generateSalt () {
 130                 // Get a random string from the RNG
 131                 $randomString = $this->getRngInstance()->randomString();
 132
 133                 // Get config entry for salt length
 134                 $length = $this->getConfigInstance()->getConfigEntry('salt_length');
 135
 136                 // Keep only defined number of characters
 137                 $this->salt = substr(sha1($randomString), -$length, $length);
 138         }
 139
 140         /**
 141          * Hashes a string with salt and returns the hash. If an old previous hash
 142          * is supplied the method will use the first X chars of that hash for hashing
 143          * the password. This is useful if you want to check if password is identical
 144          * for authorization purposes.
 145          *
 146          * @param       $str            Unhashed string
 147          * @param       $oldHash        A hash from previous hashed string
 148          * @return      $hashed         The hashed and salted string
 149          */
 150         public function hashString ($str, $oldHash = '') {
 151                 // Cast the string
 152                 $str = (string) $str;
 153
 154                 // Default is the default salt ;-)
 155                 $salt = $this->salt;
 156
 157                 // Is the old password set?
 158                 if (!empty($oldHash)) {
 159                         // Use the salt from hash, first get length
 160                         $length = $this->getConfigInstance()->getConfigEntry('salt_length');
 161
 162                         // Then extract the X first characters from the hash as our salt
 163                         $salt = substr($oldHash, 0, $length);
 164                 } // END - if
 165
 166                 // Hash the password with salt
 167                 //* DEBUG: */ echo "salt=".$salt."/plain=".$str."<br />\n";
 168                 $hashed = $salt . md5(sprintf($this->getConfigInstance()->getConfigEntry('hash_mask'),
 169                         $salt,
 170                         $this->getRngInstance()->getFixedSalt(),
 171                         $str
 172                 ));
 173
 174                 // And return it
 175                 return $hashed;
 176         }
 177
 178         /**
 179          * Encrypt the string with fixed salt
 180          *
 181          * @param       $str            The unencrypted string
 182          * @param       $key            Optional key, if none provided, a random key will be generated
 183          * @return      $encrypted      Encrypted string
 184          */
 185         public function encryptString ($str, $key = null) {
 186                 // Encrypt the string through the stream
 187                 $encrypted = $this->cryptoStreamInstance->encryptStream($str, $key);
 188
 189                 // Return the string
 190                 return $encrypted;
 191         }
 192
 193         /**
 194          * Decrypt the string with fixed salt
 195          *
 196          * @param       $encrypted      Encrypted string
 197          * @return      $str            The unencrypted string
 198          */
 199         public function decryptString ($encrypted) {
 200                 // Encrypt the string through the stream
 201                 $str = $this->cryptoStreamInstance->decryptStream($encrypted);
 202
 203                 // Return the string
 204                 return $str;
 205         }
 206 }
 207
 208 // [EOF]
 209 ?>