3 * A helper class for cryptographical things like hashing passwords and so on
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface Cryptable extends FrameworkInterface {
26 * Hashes a string with salt and returns the hash. If an old previous hash
27 * is supplied the method will use the first X chars of that hash for hashing
28 * the password. This is useful if you want to check if password is identical
29 * for authorization purposes.
31 * @param $str Unhashed string
32 * @param $oldHash A hash from previous hashed string
33 * @param $withFixed Whether to include a fixed salt (not recommended in p2p applications)
34 * @return $hashed The hashed and salted string
36 function hashString ($str, $oldHash = '', $withFixed = TRUE);
39 * Encrypt the string with fixed salt
41 * @param $str The unencrypted string
42 * @param $key Optional key, if none provided, a random key will be generated
43 * @return $encrypted Encrypted string
45 function encryptString ($str, $key = NULL);
48 * Decrypt the string with fixed salt
50 * @param $encrypted Encrypted string
51 * @return $str The unencrypted string
53 function decryptString ($encrypted);