3 namespace CoreFramework\Stream\Crypto;
5 // Import framework stuff
6 use CoreFramework\Stream\BaseStream;
9 * A null-encryption stream does not encrypt anything but can be used if e.e.
10 * mcrypt is not installed.
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
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 NullCryptoStream extends BaseStream implements EncryptableStream {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates an instance of this node class
45 * @return $streamInstance An instance of this node class
47 public static final function createNullCryptoStream () {
49 $streamInstance = new NullCryptoStream();
51 // Return the instance
52 return $streamInstance;
56 * Encrypt the string with fixed salt
58 * @param $str The unencrypted string
59 * @param $key Optional key, if none provided, a random key will be generated
60 * @return $encrypted Encrypted string
62 public function encryptStream ($str, $key = NULL) {
63 // Just handle it over
64 $encrypted = (string) $str;
71 * Decrypt the string with fixed salt
73 * @param $encrypted Encrypted string
74 * @return $str The unencrypted string
76 public function decryptStream ($encrypted) {
77 // Just handle it over
78 $str = (string) $encrypted;
85 * Streams the data and maybe does something to it
87 * @param $data The data (string mostly) to "stream"
88 * @return $data The data (string mostly) to "stream"
89 * @throws UnsupportedOperationException If this method is called (which is a mistake)
91 public function streamData ($data) {
92 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
93 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);