3 namespace Org\Mxchange\CoreFramework\Stream\Crypto\Mcrypt;
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\Crypto\BaseCryptoStream;
9 use Org\Mxchange\CoreFramework\Stream\Crypto\EncryptableStream;
12 * A mcrypt-based encryption stream
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
19 * @todo mcrypt will become deprecated, rewrite to OpenSSL
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class McryptStream extends BaseCryptoStream implements EncryptableStream {
36 * Protected constructor
40 private function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates an instance of this node class
48 * @param $rngInstance An RNG instance
49 * @return $streamInstance An instance of this node class
51 public static final function createMcryptStream (RandomNumberGenerator $rngInstance) {
53 $streamInstance = new McryptStream();
55 // Set the RNG instance
56 $streamInstance->setRngInstance($rngInstance);
58 // Return the instance
59 return $streamInstance;
63 * Encrypt the string with fixed salt
65 * @param $str The unencrypted string
66 * @param $key Optional key, if none provided, a random key will be generated
67 * @return $encrypted Encrypted string
69 public function encryptStream (string $str, string $key = NULL) {
71 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('MCRYPT-STREAM: key[' . gettype($key) . ']=' . $key);
74 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
75 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
77 // Generate key, if none provided
80 $key = $this->getRngInstance()->generateKey();
83 // Add some "payload" to the string
84 switch ($this->getRngInstance()->randomNumber(0, 8)) {
86 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
90 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
94 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
98 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
102 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
106 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
110 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
114 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
118 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
122 // Encrypt the string
123 $encrypted = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $payloadString, MCRYPT_MODE_ECB, $iv);
130 * Decrypt the string with fixed salt
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
136 public function decryptStream (string $encrypted, string $key = NULL) {
137 // Init crypto module
138 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
139 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
141 // Shall we use a default key or custom?
143 // Generate (default) key
144 $key = $this->getRngInstance()->generateKey();
147 // Decrypt the string
148 $payloadString = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, $encrypted, MCRYPT_MODE_ECB, $iv);
150 // Get the real string out
151 $strArray = explode(EncryptableStream::DATA_PAYLOAD_SEPARATOR, $payloadString);
153 // Does the element count match?
154 assert(count($strArray) == 3);
157 $str = base64_decode($strArray[1]);
159 // Trim trailing nulls away
160 $str = rtrim($str, "\0");
167 * Streams the data and maybe does something to it
169 * @param $data The data (string mostly) to "stream"
170 * @return $data The data (string mostly) to "stream"
171 * @throws UnsupportedOperationException If this method is called (which is a mistake)
173 public function streamData (string $data) {
174 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
175 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);