Code syncronized with shipsimu code base
[mailer.git] / inc / classes / main / crypto / class_CryptoHelper.php
index 4ec02ad9171256c275b26311527851df3b475cc7..2ebafd8ed9c9dfdeffcda10ef4473645e620ccbc 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class CryptoHelper extends BaseFrameworkSystem {
+class CryptoHelper extends BaseFrameworkSystem implements Cryptable {
+       // Exception constants
+       const EXCEPTION_ENCRYPT_MISSING = 0x1f0;
+       const EXCEPTION_ENCRYPT_INVALID = 0x1f1;
+
        /**
         * An instance of this own clas
         */
@@ -46,12 +50,6 @@ class CryptoHelper extends BaseFrameworkSystem {
                // Call parent constructor
                parent::__construct(__CLASS__);
 
-               // Set part description
-               $this->setObjectDescription("Cryptographical helper");
-
-               // Create unique ID number
-               $this->generateUniqueId();
-
                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
@@ -64,7 +62,7 @@ class CryptoHelper extends BaseFrameworkSystem {
         */
        public final static function createCryptoHelper () {
                // Get a new instance
-               $cryptoInstance = self::getInstance();
+               $cryptoInstance = new CryptoHelper();
 
                // Initialize the hasher
                $cryptoInstance->initHasher();
@@ -82,7 +80,7 @@ class CryptoHelper extends BaseFrameworkSystem {
                // Is no instance there?
                if (is_null(self::$selfInstance)) {
                        // Then get a new one
-                       self::$selfInstance = new CryptoHelper();
+                       self::$selfInstance = self::createCryptoHelper();
                }
 
                // Return the instance
@@ -109,7 +107,7 @@ class CryptoHelper extends BaseFrameworkSystem {
         */
        private function generateSalt () {
                // Get a random string from the RNG
-               $randomString = $this->rngInstance->makeRandomString();
+               $randomString = $this->rngInstance->randomString();
 
                // Get config entry for salt length
                $length = $this->getConfigInstance()->readConfig('salt_length');
@@ -119,38 +117,138 @@ class CryptoHelper extends BaseFrameworkSystem {
        }
 
        /**
-        * Hashes a password with salt and returns the hash. If an old previous hash
+        * Hashes a string with salt and returns the hash. If an old previous hash
         * is supplied the method will use the first X chars of that hash for hashing
         * the password. This is useful if you want to check if the password is
         * identical for authorization purposes.
         *
-        * @param       $plainPassword  The plain password to use
-        * @param       $oldHash                A previously hashed password
-        * @return      $hashed                 The hashed and salted password
+        * @param       $str            Unhashed string
+        * @param       $oldHash        A hash from previous hashed string
+        * @return      $hashed         The hashed and salted string
         */
-       public function hashPassword ($plainPassword, $oldHash = "") {
+       public function hashString ($str, $oldHash = "") {
+               // Cast the string
+               $str = (string) $str;
+
+               // Default is the default salt ;-)
+               $salt = $this->salt;
+
                // Is the old password set?
-               if (empty($oldHash)) {
-                       // No, then use the current salt
-                       $salt = $this->salt;
-               } else {
+               if (!empty($oldHash)) {
                        // Use the salt from hash, first get length
                        $length = $this->getConfigInstance()->readConfig('salt_length');
 
                        // Then extract the X first characters from the hash as our salt
                        $salt = substr($oldHash, 0, $length);
-               }
+               } // END - if
 
                // Hash the password with salt
+               //* DEBUG: */ echo "salt=".$salt."/plain=".$str."<br />\n";
                $hashed = $salt . md5(sprintf($this->getConfigInstance()->readConfig('hash_mask'),
                        $salt,
-                       $this->rngInstance->getExtraSalt(),
-                       $plainPassword
+                       $this->rngInstance->getFixedSalt(),
+                       $str
                ));
 
                // And return it
                return $hashed;
        }
+
+       /**
+        * Encrypt the string with fixed salt
+        *
+        * @param       $str            The unencrypted string
+        * @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))."|".base64_encode($str)."|".crc32($this->rngInstance->randomString(20));
+                               break;
+
+                       case 1:
+                               $garbageString = crc32($this->rngInstance->randomString(10))."|".base64_encode($str)."|".md5($this->rngInstance->randomString(20));
+                               break;
+
+                       case 2:
+                               $garbageString = crc32($this->rngInstance->randomString(10))."|".base64_encode($str)."|".sha1($this->rngInstance->randomString(20));
+                               break;
+
+                       case 3:
+                               $garbageString = md5($this->rngInstance->randomString(10))."|".base64_encode($str)."|".crc32($this->rngInstance->randomString(20));
+                               break;
+
+                       case 4:
+                               $garbageString = md5($this->rngInstance->randomString(10))."|".base64_encode($str)."|".md5($this->rngInstance->randomString(20));
+                               break;
+
+                       case 5:
+                               $garbageString = md5($this->rngInstance->randomString(10))."|".base64_encode($str)."|".sha1($this->rngInstance->randomString(20));
+                               break;
+
+                       case 6:
+                               $garbageString = sha1($this->rngInstance->randomString(10))."|".base64_encode($str)."|".crc32($this->rngInstance->randomString(20));
+                               break;
+
+                       case 7:
+                               $garbageString = sha1($this->rngInstance->randomString(10))."|".base64_encode($str)."|".md5($this->rngInstance->randomString(20));
+                               break;
+
+                       case 8:
+                               $garbageString = sha1($this->rngInstance->randomString(10))."|".base64_encode($str)."|".sha1($this->rngInstance->randomString(20));
+                               break;
+               }
+
+               // Encrypt the string
+               $encrypted = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $garbageString, MCRYPT_MODE_ECB, $iv);
+
+               // Return the string
+               return $encrypted;
+       }
+
+       /**
+        * Decrypt the string with fixed salt
+        *
+        * @param       $encrypted      Encrypted string
+        * @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("|", $garbageString);
+               $str = base64_decode($strArray[1]);
+
+               // Trim trailing nulls away
+               $str = rtrim($str, "\0");
+
+               // Return the string
+               return $str;
+       }
 }
 
 // [EOF]