inc/classes/main/rng/class_RandomNumberGenerator.php

   1 <?php
   2 /**
   3  * A standard random number generator
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class RandomNumberGenerator extends BaseFrameworkSystem {
  25         /**
  26          * Prime number for better pseudo random numbers
  27          */
  28         private $prime = 0;
  29
  30         /**
  31          * Add this calculated number to the rng
  32          */
  33         private $extraNumber = 0;
  34
  35         /**
  36          * Extra salt for secured hashing
  37          */
  38         private $extraSalt = '';
  39
  40         /**
  41          * Fixed salt for secured hashing
  42          */
  43         private $fixedSalt = '';
  44
  45         /**
  46          * Maximum length for random string
  47          */
  48         private $rndStrLen = 0;
  49
  50         /**
  51          * Protected constructor
  52          *
  53          * @param       $className      Name of this class
  54          * @return      void
  55          */
  56         protected function __construct ($className = __CLASS__) {
  57                 // Call parent constructor
  58                 parent::__construct($className);
  59         }
  60
  61         /**
  62          * Creates an instance of this class
  63          *
  64          * @param       $extraInstance  An extra instance for more salt (default: null)
  65          * @return      $rngInstance    An instance of this random number generator
  66          */
  67         public static final function createRandomNumberGenerator (FrameworkInterface $extraInstance = null) {
  68                 // Get a new instance
  69                 $rngInstance = new RandomNumberGenerator();
  70
  71                 // Initialize the RNG now
  72                 $rngInstance->initRng($extraInstance);
  73
  74                 // Return the instance
  75                 return $rngInstance;
  76         }
  77
  78         /**
  79          * Initializes the random number generator
  80          *
  81          * @param       $extraInstance  An extra instance for more salt (default: null)
  82          * @return      void
  83          * @todo        Add site key for stronger salt!
  84          */
  85         protected function initRng ($extraInstance) {
  86                 // Get the prime number from config
  87                 $this->prime = $this->getConfigInstance()->getConfigEntry('math_prime');
  88
  89                 // Calculate the extra number which is always the same unless you give
  90                 // a better prime number
  91                 $this->extraNumber = ($this->prime * $this->prime / (pi() ^ 2));
  92
  93                 // Seed mt_rand()
  94                 mt_srand((double) sqrt(microtime() * 100000000 * $this->extraNumber));
  95
  96                 // Set the server IP to cluster
  97                 $serverIp = 'cluster';
  98
  99                 // Do we have a single server?
 100                 if ($this->getConfigInstance()->getConfigEntry('is_single_server') == 'Y') {
 101                         // Then use that IP for extra security
 102                         $serverIp = $this->getConfigInstance()->detectServerAddress();
 103                 } // END - if
 104
 105                 // Yet-another fixed salt. This is not dependend on server software or date
 106                 if ($extraInstance instanceof FrameworkInterface) {
 107                         // With extra instance information
 108                         $this->fixedSalt = sha1($serverIp . ':' . $extraInstance->__toString() . ':' . serialize($this->getDatabaseInstance()->getConnectionData()));
 109                 } else {
 110                         // Without extra information
 111                         $this->fixedSalt = sha1($serverIp . ':' . serialize($this->getDatabaseInstance()->getConnectionData()));
 112                 }
 113
 114                 // One-way data we need for "extra-salting" the random number
 115                 $this->extraSalt = sha1($this->fixedSalt . ':' . getenv('SERVER_SOFTWARE') . ':' . $this->getConfigInstance()->getConfigEntry('date_key') . $this->getConfigInstance()->getConfigEntry('base_url'));
 116
 117                 // Get config entry for max salt length
 118                 $this->rndStrLen = $this->getConfigInstance()->getConfigEntry('rnd_str_length');
 119         }
 120
 121         /**
 122          * Makes a pseudo-random string useable for salts
 123          *
 124          * @param       $length                 Length of the string, default: 128
 125          * @return      $randomString   The pseudo-random string
 126          */
 127         public function randomString ($length = -1) {
 128                 // Is the number <1, then fix it to default length
 129                 if ($length < 1) {
 130                         $length = $this->rndStrLen;
 131                 } // END - if
 132
 133                 // Initialize the string
 134                 $randomString = '';
 135
 136                 // And generate it
 137                 for ($idx = 0; $idx < $length; $idx++) {
 138                         // Add a random character and add it to our string
 139                         $randomString .= chr($this->randomNumber(0, 255));
 140                 } // END - for
 141
 142                 // Return the random string a little mixed up
 143                 return str_shuffle($randomString);
 144         }
 145
 146         /**
 147          * Generate a pseudo-random integer number in a given range
 148          *
 149          * @param       $min    Min value to generate
 150          * @param       $max    Max value to generate
 151          * @return      $num    Pseudo-random number
 152          * @todo        I had a better random number generator here but now it is somewhere lost :(
 153          */
 154         public function randomNumber ($min, $max) {
 155                 return mt_rand($min, $max);
 156         }
 157
 158         /**
 159          * Getter for extra salt
 160          *
 161          * @return      $extraSalt
 162          */
 163         public final function getExtraSalt () {
 164                 return $this->extraSalt;
 165         }
 166
 167         /**
 168          * Getter for fixed salt
 169          *
 170          * @return      $fixedSalt
 171          */
 172         public final function getFixedSalt () {
 173                 return $this->fixedSalt;
 174         }
 175
 176         /**
 177          * Generates a key based on if we have extra (default) or fixed salt enabled
 178          *
 179          * @return      $key    The generated key for encrypion
 180          */
 181         public function generateKey () {
 182                 // Default is extra salt
 183                 $key = md5($this->getExtraSalt());
 184
 185                 // Get key
 186                 if ($this->getConfigInstance()->getConfigEntry('crypt_fixed_salt') == 'Y') {
 187                         $key = md5($this->getFixedSalt());
 188                 } // END - if
 189
 190                 // Return it
 191                 return $key;
 192         }
 193 }
 194
 195 // [EOF]
 196 ?>