3 namespace Org\Mxchange\CoreFramework\Crypto;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
9 * A helper class for cryptographical things like hashing passwords and so on
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 Cryptable extends FrameworkInterface {
32 * Hashes a string with salt and returns the hash. If an old previous hash
33 * is supplied the method will use the first X chars of that hash for hashing
34 * the password. This is useful if you want to check if password is identical
35 * for authorization purposes.
37 * @param $str Unhashed string
38 * @param $oldHash A hash from previous hashed string
39 * @param $withFixed Whether to include a fixed salt (not recommended in p2p applications)
40 * @return $hashed The hashed and salted string
42 function hashString (string $str, string $oldHash = '', bool $withFixed = true);
45 * Encrypt the string with fixed salt
47 * @param $str The unencrypted string
48 * @param $key Optional key, if none provided, a random key will be generated
49 * @return $encrypted Encrypted string
51 function encryptString (string $str, string $key = NULL);
54 * Decrypt the string with fixed salt
56 * @param $encrypted Encrypted string
57 * @return $str The unencrypted string
59 function decryptString (string $encrypted);