3 namespace Org\Mxchange\CoreFramework\Stream\Crypto;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Crypto\RandomNumber\RandomNumberGenerator;
7 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
8 use Org\Mxchange\CoreFramework\Stream\BaseStream;
11 * A mcrypt-based encryption stream
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
18 * @todo mcrypt will become deprecated, rewrite to OpenSSL
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class McryptStream extends BaseStream implements EncryptableStream {
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this node class
47 * @param $rngInstance An RNG instance
48 * @return $streamInstance An instance of this node class
50 public static final function createMcryptStream (RandomNumberGenerator $rngInstance) {
52 $streamInstance = new McryptStream();
54 // Set the RNG instance
55 $streamInstance->setRngInstance($rngInstance);
57 // Return the instance
58 return $streamInstance;
62 * Encrypt the string with fixed salt
64 * @param $str The unencrypted string
65 * @param $key Optional key, if none provided, a random key will be generated
66 * @return $encrypted Encrypted string
68 public function encryptStream ($str, $key = NULL) {
70 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('MCRYPT-STREAM: key[' . gettype($key) . ']=' . $key);
73 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
74 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
76 // Generate key, if none provided
79 $key = $this->getRngInstance()->generateKey();
82 // Add some "payload" to the string
83 switch ($this->getRngInstance()->randomNumber(0, 8)) {
85 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
89 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
93 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
97 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
101 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
105 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
109 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
113 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
117 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
121 // Encrypt the string
122 $encrypted = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $payloadString, MCRYPT_MODE_ECB, $iv);
129 * Decrypt the string with fixed salt
131 * @param $encrypted Encrypted string
132 * @param $key Optional key, if none provided, a random key will be generated
133 * @return $str The unencrypted string
135 public function decryptStream ($encrypted, $key = NULL) {
136 // Init crypto module
137 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
138 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
140 // Shall we use a default key or custom?
142 // Generate (default) key
143 $key = $this->getRngInstance()->generateKey();
146 // Decrypt the string
147 $payloadString = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, $encrypted, MCRYPT_MODE_ECB, $iv);
149 // Get the real string out
150 $strArray = explode(EncryptableStream::DATA_PAYLOAD_SEPARATOR, $payloadString);
152 // Does the element count match?
153 assert(count($strArray) == 3);
156 $str = base64_decode($strArray[1]);
158 // Trim trailing nulls away
159 $str = rtrim($str, "\0");
166 * Streams the data and maybe does something to it
168 * @param $data The data (string mostly) to "stream"
169 * @return $data The data (string mostly) to "stream"
170 * @throws UnsupportedOperationException If this method is called (which is a mistake)
172 public function streamData ($data) {
173 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
174 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);