framework/main/interfaces/crypto/class_Cryptable.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Crypto;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * A helper class for cryptographical things like hashing passwords and so on
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13 <<<<<<< HEAD:framework/main/interfaces/crypto/class_Cryptable.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/interfaces/crypto/class_Cryptable.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 interface Cryptable extends FrameworkInterface {
  35         /**
  36          * Hashes a string with salt and returns the hash. If an old previous hash
  37          * is supplied the method will use the first X chars of that hash for hashing
  38          * the password. This is useful if you want to check if password is identical
  39          * for authorization purposes.
  40          *
  41          * @param       $str            Unhashed string
  42          * @param       $oldHash        A hash from previous hashed string
  43          * @param       $withFixed      Whether to include a fixed salt (not recommended in p2p applications)
  44          * @return      $hashed         The hashed and salted string
  45          */
  46         function hashString ($str, $oldHash = '', $withFixed = true);
  47
  48         /**
  49          * Encrypt the string with fixed salt
  50          *
  51          * @param       $str            The unencrypted string
  52          * @param       $key            Optional key, if none provided, a random key will be generated
  53          * @return      $encrypted      Encrypted string
  54          */
  55         function encryptString ($str, $key = NULL);
  56
  57         /**
  58          * Decrypt the string with fixed salt
  59          *
  60          * @param       $encrypted      Encrypted string
  61          * @return      $str            The unencrypted string
  62          */
  63         function decryptString ($encrypted);
  64
  65 }