framework/main/classes/streams/crypto/class_McryptStream.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Stream\Crypto;
   4
   5 // Import framework stuff
   6 use CoreFramework\Crypto\RandomNumber\RandomNumberGenerator;
   7
   8 /**
   9  * A mcrypt-based encryption stream
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  * @todo                mcrypt will become deprecated, rewrite to OpenSSL
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class McryptStream extends BaseStream implements EncryptableStream {
  32         /**
  33          * Separator on many places
  34          */
  35         const DATA_PAYLOAD_SEPARATOR = '|';
  36
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this node class
  49          *
  50          * @param       $rngInstance            An RNG instance
  51          * @return      $streamInstance         An instance of this node class
  52          */
  53         public static final function createMcryptStream (RandomNumberGenerator $rngInstance) {
  54                 // Get a new instance
  55                 $streamInstance = new McryptStream();
  56
  57                 // Set the RNG instance
  58                 $streamInstance->setRngInstance($rngInstance);
  59
  60                 // Return the instance
  61                 return $streamInstance;
  62         }
  63
  64         /**
  65          * Encrypt the string with fixed salt
  66          *
  67          * @param       $str            The unencrypted string
  68          * @param       $key            Optional key, if none provided, a random key will be generated
  69          * @return      $encrypted      Encrypted string
  70          */
  71         public function encryptStream ($str, $key = NULL) {
  72                 // Debug message
  73                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: key[' . gettype($key) . ']=' . $key);
  74
  75                 // Init crypto module
  76                 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
  77                 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
  78
  79                 // Generate key, if none provided
  80                 if (is_null($key)) {
  81                         // None provided
  82                         $key = $this->getRngInstance()->generateKey();
  83                 } // END - if
  84
  85                 // Add some "payload" to the string
  86                 switch ($this->getRngInstance()->randomNumber(0, 8)) {
  87                         case 0:
  88                                 $payloadString = crc32($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
  89                                 break;
  90
  91                         case 1:
  92                                 $payloadString = crc32($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
  93                                 break;
  94
  95                         case 2:
  96                                 $payloadString = crc32($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
  97                                 break;
  98
  99                         case 3:
 100                                 $payloadString = md5($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
 101                                 break;
 102
 103                         case 4:
 104                                 $payloadString = md5($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
 105                                 break;
 106
 107                         case 5:
 108                                 $payloadString = md5($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
 109                                 break;
 110
 111                         case 6:
 112                                 $payloadString = sha1($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
 113                                 break;
 114
 115                         case 7:
 116                                 $payloadString = sha1($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
 117                                 break;
 118
 119                         case 8:
 120                                 $payloadString = sha1($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
 121                                 break;
 122                 }
 123
 124                 // Encrypt the string
 125                 $encrypted = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $payloadString, MCRYPT_MODE_ECB, $iv);
 126
 127                 // Return the string
 128                 return $encrypted;
 129         }
 130
 131         /**
 132          * Decrypt the string with fixed salt
 133          *
 134          * @param       $encrypted      Encrypted string
 135          * @param       $key            Optional key, if none provided, a random key will be generated
 136          * @return      $str            The unencrypted string
 137          */
 138         public function decryptStream ($encrypted, $key = NULL) {
 139                 // Init crypto module
 140                 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
 141                 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
 142
 143                 // Shall we use a default key or custom?
 144                 if (is_null($key)) {
 145                         // Generate (default) key
 146                         $key = $this->getRngInstance()->generateKey();
 147                 } // END - if
 148
 149                 // Decrypt the string
 150                 $payloadString = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, $encrypted, MCRYPT_MODE_ECB, $iv);
 151
 152                 // Get the real string out
 153                 $strArray = explode(self::DATA_PAYLOAD_SEPARATOR, $payloadString);
 154
 155                 // Does the element count match?
 156                 assert(count($strArray) == 3);
 157
 158                 // Decode the string
 159                 $str = base64_decode($strArray[1]);
 160
 161                 // Trim trailing nulls away
 162                 $str = rtrim($str, "\0");
 163
 164                 // Return the string
 165                 return $str;
 166         }
 167
 168         /**
 169          * Streams the data and maybe does something to it
 170          *
 171          * @param       $data   The data (string mostly) to "stream"
 172          * @return      $data   The data (string mostly) to "stream"
 173          * @throws      UnsupportedOperationException   If this method is called (which is a mistake)
 174          */
 175         public function streamData ($data) {
 176                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
 177                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 178         }
 179
 180 }