3 namespace CoreFramework\Stream\Crypto;
5 // Import framework stuff
6 use CoreFramework\Generic\UnsupportedOperationException;
7 use CoreFramework\Stream\BaseStream;
10 * A null-encryption stream does not encrypt anything but can be used if e.e.
11 * mcrypt is not installed.
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class NullCryptoStream extends BaseStream implements EncryptableStream {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this node class
46 * @return $streamInstance An instance of this node class
48 public static final function createNullCryptoStream () {
50 $streamInstance = new NullCryptoStream();
52 // Return the instance
53 return $streamInstance;
57 * Encrypt the string with fixed salt
59 * @param $str The unencrypted string
60 * @param $key Optional key, if none provided, a random key will be generated
61 * @return $encrypted Encrypted string
63 public function encryptStream ($str, $key = NULL) {
64 // Just handle it over
65 $encrypted = (string) $str;
72 * Decrypt the string with fixed salt
74 * @param $encrypted Encrypted string
75 * @return $str The unencrypted string
77 public function decryptStream ($encrypted) {
78 // Just handle it over
79 $str = (string) $encrypted;
86 * Streams the data and maybe does something to it
88 * @param $data The data (string mostly) to "stream"
89 * @return $data The data (string mostly) to "stream"
90 * @throws UnsupportedOperationException If this method is called (which is a mistake)
92 public function streamData ($data) {
93 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
94 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);