State (see State Pattern) prepared, a lot reworked/refactured
[core.git] / inc / classes / main / crypto / class_CryptoHelper.php
index 004ea24f6bcf357964463bbcb4db052952224dbf..db35284416ecb4011caa28f565c43f455dfcc56d 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -37,14 +37,14 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
        private $rngInstance = null;
 
        /**
-        * Salt for hashing operations
+        * Instance of the crypto stream
         */
-       private $salt = '';
+       private $cryptoStreamInstance = null;
 
        /**
-        * Seperator on many places
+        * Salt for hashing operations
         */
-       private $seperator '|';
+       private $salt = '';
 
        /**
         * Protected constructor
@@ -54,10 +54,6 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Clean up a little
-               $this->removeNumberFormaters();
-               $this->removeSystemArray();
        }
 
        /**
@@ -72,6 +68,9 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
                // Initialize the hasher
                $cryptoInstance->initHasher();
 
+               // Attach a crypto stream
+               $cryptoInstance->attachCryptoStream();
+
                // Return the instance
                return $cryptoInstance;
        }
@@ -86,12 +85,29 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
                if (is_null(self::$selfInstance)) {
                        // Then get a new one
                        self::$selfInstance = self::createCryptoHelper();
-               }
+               } // END - if
 
                // Return the instance
                return self::$selfInstance;
        }
 
+       /**
+        * Attaches a crypto stream to this crypto helper by detecting loaded
+        * modules.
+        *
+        * @return      void
+        */
+       protected function attachCryptoStream () {
+               // Do we have mcrypt loaded?
+               if ($this->isPhpExtensionLoaded('mcrypt')) {
+                       // Then use it
+                       $this->cryptoStreamInstance = ObjectFactory::createObjectByName('McryptStream', array($this->getRngInstance()));
+               } else {
+                       // If nothing works ...
+                       $this->cryptoStreamInstance = ObjectFactory::createObjectByName('NullCryptoStream');
+               }
+       }
+
        /**
         * Initializes the hasher for different purposes.
         *
@@ -99,7 +115,7 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
         */
        protected function initHasher () {
                // Initialize the random number generator which is required by some crypto methods
-               $this->rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
+               $this->setRngInstance(ObjectFactory::createObjectByConfiguredName('rng_class'));
 
                // Generate a salt for the hasher
                $this->generateSalt();
@@ -112,10 +128,10 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
         */
        private function generateSalt () {
                // Get a random string from the RNG
-               $randomString = $this->rngInstance->randomString();
+               $randomString = $this->getRngInstance()->randomString();
 
                // Get config entry for salt length
-               $length = $this->getConfigInstance()->readConfig('salt_length');
+               $length = $this->getConfigInstance()->getConfigEntry('salt_length');
 
                // Keep only defined number of characters
                $this->salt = substr(sha1($randomString), -$length, $length);
@@ -141,7 +157,7 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
                // Is the old password set?
                if (!empty($oldHash)) {
                        // Use the salt from hash, first get length
-                       $length = $this->getConfigInstance()->readConfig('salt_length');
+                       $length = $this->getConfigInstance()->getConfigEntry('salt_length');
 
                        // Then extract the X first characters from the hash as our salt
                        $salt = substr($oldHash, 0, $length);
@@ -149,9 +165,9 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
 
                // Hash the password with salt
                //* DEBUG: */ echo "salt=".$salt."/plain=".$str."<br />\n";
-               $hashed = $salt . md5(sprintf($this->getConfigInstance()->readConfig('hash_mask'),
+               $hashed = $salt . md5(sprintf($this->getConfigInstance()->getConfigEntry('hash_mask'),
                        $salt,
-                       $this->rngInstance->getFixedSalt(),
+                       $this->getRngInstance()->getFixedSalt(),
                        $str
                ));
 
@@ -166,58 +182,8 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
         * @return      $encrypted      Encrypted string
         */
        public function encryptString ($str) {
-               // Init crypto module
-               $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
-               $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
-
-               // Get key
-               if ($this->getConfigInstance()->readConfig('crypt_fixed_salt') == 'Y') {
-                       $key = md5($this->rngInstance->getFixedSalt());
-               } else {
-                       $key = md5($this->rngInstance->getExtraSalt());
-               }
-
-               // Add some "garbage" to the string
-               switch ($this->rngInstance->randomNumber(0, 8)) {
-                       case 0:
-                               $garbageString = crc32($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . crc32($this->rngInstance->randomString(20));
-                               break;
-
-                       case 1:
-                               $garbageString = crc32($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . md5($this->rngInstance->randomString(20));
-                               break;
-
-                       case 2:
-                               $garbageString = crc32($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . sha1($this->rngInstance->randomString(20));
-                               break;
-
-                       case 3:
-                               $garbageString = md5($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . crc32($this->rngInstance->randomString(20));
-                               break;
-
-                       case 4:
-                               $garbageString = md5($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . md5($this->rngInstance->randomString(20));
-                               break;
-
-                       case 5:
-                               $garbageString = md5($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . sha1($this->rngInstance->randomString(20));
-                               break;
-
-                       case 6:
-                               $garbageString = sha1($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . crc32($this->rngInstance->randomString(20));
-                               break;
-
-                       case 7:
-                               $garbageString = sha1($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . md5($this->rngInstance->randomString(20));
-                               break;
-
-                       case 8:
-                               $garbageString = sha1($this->rngInstance->randomString(10)) . $this->seperator . base64_encode($str) . $this->seperator . sha1($this->rngInstance->randomString(20));
-                               break;
-               }
-
-               // Encrypt the string
-               $encrypted = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $garbageString, MCRYPT_MODE_ECB, $iv);
+               // Encrypt the string through the stream
+               $encrypted = $this->cryptoStreamInstance->encryptStream($str);
 
                // Return the string
                return $encrypted;
@@ -230,31 +196,8 @@ class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
         * @return      $str            The unencrypted string
         */
        public function decryptString ($encrypted) {
-               // Init crypto module
-               $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
-               $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
-
-               // Get key
-               if ($this->getConfigInstance()->readConfig('crypt_fixed_salt') == 'Y') {
-                       $key = md5($this->rngInstance->getFixedSalt());
-               } else {
-                       $key = md5($this->rngInstance->getExtraSalt());
-               }
-
-               // Decrypt the string
-               $garbageString = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, $encrypted, MCRYPT_MODE_ECB, $iv);
-
-               // Get the real string out
-               $strArray = explode($this->seperator, $garbageString);
-
-               // Does the element count match?
-               assert(count($strArray) == 3);
-
-               // Decode the string
-               $str = base64_decode($strArray[1]);
-
-               // Trim trailing nulls away
-               $str = rtrim($str, "\0");
+               // Encrypt the string through the stream
+               $str = $this->cryptoStreamInstance->decryptStream($encrypted);
 
                // Return the string
                return $str;