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 <<<<<<< HEAD:framework/main/classes/streams/crypto/class_McryptStream.php
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
19 >>>>>>> Some updates::inc/main/classes/streams/crypto/class_McryptStream.php
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
22 * @todo mcrypt will become deprecated, rewrite to OpenSSL
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class McryptStream extends BaseStream implements EncryptableStream {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this node class
51 * @param $rngInstance An RNG instance
52 * @return $streamInstance An instance of this node class
54 public static final function createMcryptStream (RandomNumberGenerator $rngInstance) {
56 $streamInstance = new McryptStream();
58 // Set the RNG instance
59 $streamInstance->setRngInstance($rngInstance);
61 // Return the instance
62 return $streamInstance;
66 * Encrypt the string with fixed salt
68 * @param $str The unencrypted string
69 * @param $key Optional key, if none provided, a random key will be generated
70 * @return $encrypted Encrypted string
72 public function encryptStream ($str, $key = NULL) {
74 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: key[' . gettype($key) . ']=' . $key);
77 $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
78 $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
80 // Generate key, if none provided
83 $key = $this->getRngInstance()->generateKey();
86 // Add some "payload" to the string
87 switch ($this->getRngInstance()->randomNumber(0, 8)) {
89 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
93 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
97 $payloadString = crc32($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
101 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
105 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
109 $payloadString = md5($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
113 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . crc32($this->getRngInstance()->randomString(20));
117 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . md5($this->getRngInstance()->randomString(20));
121 $payloadString = sha1($this->getRngInstance()->randomString(10)) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . base64_encode($str) . EncryptableStream::DATA_PAYLOAD_SEPARATOR . sha1($this->getRngInstance()->randomString(20));
125 // Encrypt the string
126 $encrypted = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $payloadString, MCRYPT_MODE_ECB, $iv);
133 * Decrypt the string with fixed salt
135 * @param $encrypted Encrypted string
136 * @param $key Optional key, if none provided, a random key will be generated
137 * @return $str The unencrypted string
139 public function decryptStream ($encrypted, $key = NULL) {
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);
144 // Shall we use a default key or custom?
146 // Generate (default) key
147 $key = $this->getRngInstance()->generateKey();
150 // Decrypt the string
151 $payloadString = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, $encrypted, MCRYPT_MODE_ECB, $iv);
153 // Get the real string out
154 $strArray = explode(EncryptableStream::DATA_PAYLOAD_SEPARATOR, $payloadString);
156 // Does the element count match?
157 assert(count($strArray) == 3);
160 $str = base64_decode($strArray[1]);
162 // Trim trailing nulls away
163 $str = rtrim($str, "\0");
170 * Streams the data and maybe does something to it
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)
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);