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

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