3 namespace Org\Mxchange\CoreFramework\Stream\Crypto;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Stream\Stream;
9 * An interface for encrypted data streams
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface EncryptableStream extends Stream {
32 * Separator on many places
34 const DATA_PAYLOAD_SEPARATOR = '|';
37 * Encrypt the string with fixed salt
39 * @param $str The unencrypted string
40 * @param $key Optional key, if none provided, a random key will be generated
41 * @return $encrypted Encrypted string
43 function encryptStream (string $str, string $key = NULL);
46 * Decrypt the string with fixed salt
48 * @param $encrypted Encrypted string
49 * @param $key Optional key, if none provided, a random key will be generated
50 * @return $str The unencrypted string
52 function decryptStream (string $encrypted, string $key = NULL);