3 namespace CoreFramework\Stream\Crypto;
5 // Import framework stuff
6 use CoreFramework\Crypto\RandomNumber\RandomNumberGenerator;
9 * A mcrypt-based encryption stream
11 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
31 class McryptStream extends BaseStream implements EncryptableStream {
33 * Separator on many places
35 const DATA_PAYLOAD_SEPARATOR = '|';
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this node class
50 * @param $rngInstance An RNG instance
51 * @return $streamInstance An instance of this node class
53 public static final function createMcryptStream (RandomNumberGenerator $rngInstance) {
55 $streamInstance = new McryptStream();
57 // Set the RNG instance
58 $streamInstance->setRngInstance($rngInstance);
60 // Return the instance
61 return $streamInstance;
65 * Encrypt the string with fixed salt
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
71 public function encryptStream ($str, $key = NULL) {
73 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: key[' . gettype($key) . ']=' . $key);
76 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
77 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
79 // Generate key, if none provided
82 $key = $this->getRngInstance()->generateKey();
85 // Add some "payload" to the string
86 switch ($this->getRngInstance()->randomNumber(0, 8)) {
88 $payloadString = crc32($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
92 $payloadString = crc32($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
96 $payloadString = crc32($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
100 $payloadString = md5($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
104 $payloadString = md5($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
108 $payloadString = md5($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
112 $payloadString = sha1($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
116 $payloadString = sha1($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
120 $payloadString = sha1($this->getRngInstance()->randomString(10)) . self::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . self::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
124 // Encrypt the string
125 $encrypted = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $payloadString, MCRYPT_MODE_ECB, $iv);
132 * Decrypt the string with fixed salt
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
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);
143 // Shall we use a default key or custom?
145 // Generate (default) key
146 $key = $this->getRngInstance()->generateKey();
149 // Decrypt the string
150 $payloadString = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, $encrypted, MCRYPT_MODE_ECB, $iv);
152 // Get the real string out
153 $strArray = explode(self::DATA_PAYLOAD_SEPARATOR, $payloadString);
155 // Does the element count match?
156 assert(count($strArray) == 3);
159 $str = base64_decode($strArray[1]);
161 // Trim trailing nulls away
162 $str = rtrim($str, "\0");
169 * Streams the data and maybe does something to it
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)
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);