@@ -13,20 +13,20 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | trait LoggerAwareTrait |
| 15 | 15 | { |
| 16 | - /** |
|
| 17 | - * The logger instance. |
|
| 18 | - * |
|
| 19 | - * @var LoggerInterface|null |
|
| 20 | - */ |
|
| 21 | - protected $logger; |
|
| 16 | + /** |
|
| 17 | + * The logger instance. |
|
| 18 | + * |
|
| 19 | + * @var LoggerInterface|null |
|
| 20 | + */ |
|
| 21 | + protected $logger; |
|
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * Sets a logger. |
|
| 25 | - * |
|
| 26 | - * @param LoggerInterface $logger |
|
| 27 | - */ |
|
| 28 | - public function setLogger(LoggerInterface $logger) |
|
| 29 | - { |
|
| 30 | - $this->logger = $logger; |
|
| 31 | - } |
|
| 23 | + /** |
|
| 24 | + * Sets a logger. |
|
| 25 | + * |
|
| 26 | + * @param LoggerInterface $logger |
|
| 27 | + */ |
|
| 28 | + public function setLogger(LoggerInterface $logger) |
|
| 29 | + { |
|
| 30 | + $this->logger = $logger; |
|
| 31 | + } |
|
| 32 | 32 | } |
@@ -25,7 +25,7 @@ |
||
| 25 | 25 | * |
| 26 | 26 | * @param LoggerInterface $logger |
| 27 | 27 | */ |
| 28 | - public function setLogger(LoggerInterface $logger) |
|
| 28 | + public function setLogger( LoggerInterface $logger ) |
|
| 29 | 29 | { |
| 30 | 30 | $this->logger = $logger; |
| 31 | 31 | } |
@@ -11,8 +11,7 @@ discard block |
||
| 11 | 11 | /** |
| 12 | 12 | * Basic Implementation of LoggerAwareInterface. |
| 13 | 13 | */ |
| 14 | -trait LoggerAwareTrait |
|
| 15 | -{ |
|
| 14 | +trait LoggerAwareTrait { |
|
| 16 | 15 | /** |
| 17 | 16 | * The logger instance. |
| 18 | 17 | * |
@@ -25,8 +24,7 @@ discard block |
||
| 25 | 24 | * |
| 26 | 25 | * @param LoggerInterface $logger |
| 27 | 26 | */ |
| 28 | - public function setLogger(LoggerInterface $logger) |
|
| 29 | - { |
|
| 27 | + public function setLogger(LoggerInterface $logger) { |
|
| 30 | 28 | $this->logger = $logger; |
| 31 | 29 | } |
| 32 | 30 | } |
@@ -13,12 +13,12 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | interface LoggerAwareInterface |
| 15 | 15 | { |
| 16 | - /** |
|
| 17 | - * Sets a logger instance on the object. |
|
| 18 | - * |
|
| 19 | - * @param LoggerInterface $logger |
|
| 20 | - * |
|
| 21 | - * @return void |
|
| 22 | - */ |
|
| 23 | - public function setLogger(LoggerInterface $logger); |
|
| 16 | + /** |
|
| 17 | + * Sets a logger instance on the object. |
|
| 18 | + * |
|
| 19 | + * @param LoggerInterface $logger |
|
| 20 | + * |
|
| 21 | + * @return void |
|
| 22 | + */ |
|
| 23 | + public function setLogger(LoggerInterface $logger); |
|
| 24 | 24 | } |
@@ -20,5 +20,5 @@ |
||
| 20 | 20 | * |
| 21 | 21 | * @return void |
| 22 | 22 | */ |
| 23 | - public function setLogger(LoggerInterface $logger); |
|
| 23 | + public function setLogger( LoggerInterface $logger ); |
|
| 24 | 24 | } |
@@ -11,8 +11,7 @@ |
||
| 11 | 11 | /** |
| 12 | 12 | * Describes a logger-aware instance. |
| 13 | 13 | */ |
| 14 | -interface LoggerAwareInterface |
|
| 15 | -{ |
|
| 14 | +interface LoggerAwareInterface { |
|
| 16 | 15 | /** |
| 17 | 16 | * Sets a logger instance on the object. |
| 18 | 17 | * |
@@ -17,8 +17,8 @@ |
||
| 17 | 17 | */ |
| 18 | 18 | class DummyTest |
| 19 | 19 | { |
| 20 | - public function __toString() |
|
| 21 | - { |
|
| 22 | - return 'DummyTest'; |
|
| 23 | - } |
|
| 20 | + public function __toString() |
|
| 21 | + { |
|
| 22 | + return 'DummyTest'; |
|
| 23 | + } |
|
| 24 | 24 | } |
@@ -15,10 +15,8 @@ |
||
| 15 | 15 | * |
| 16 | 16 | * @internal |
| 17 | 17 | */ |
| 18 | -class DummyTest |
|
| 19 | -{ |
|
| 20 | - public function __toString() |
|
| 21 | - { |
|
| 18 | +class DummyTest { |
|
| 19 | + public function __toString() { |
|
| 22 | 20 | return 'DummyTest'; |
| 23 | 21 | } |
| 24 | 22 | } |
@@ -23,8 +23,7 @@ |
||
| 23 | 23 | * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md |
| 24 | 24 | * for the full interface specification. |
| 25 | 25 | */ |
| 26 | -interface LoggerInterface |
|
| 27 | -{ |
|
| 26 | +interface LoggerInterface { |
|
| 28 | 27 | /** |
| 29 | 28 | * System is unusable. |
| 30 | 29 | * |
@@ -26,107 +26,107 @@ |
||
| 26 | 26 | */ |
| 27 | 27 | interface LoggerInterface |
| 28 | 28 | { |
| 29 | - /** |
|
| 30 | - * System is unusable. |
|
| 31 | - * |
|
| 32 | - * @param string $message |
|
| 33 | - * @param mixed[] $context |
|
| 34 | - * |
|
| 35 | - * @return void |
|
| 36 | - */ |
|
| 37 | - public function emergency($message, array $context = []); |
|
| 29 | + /** |
|
| 30 | + * System is unusable. |
|
| 31 | + * |
|
| 32 | + * @param string $message |
|
| 33 | + * @param mixed[] $context |
|
| 34 | + * |
|
| 35 | + * @return void |
|
| 36 | + */ |
|
| 37 | + public function emergency($message, array $context = []); |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Action must be taken immediately. |
|
| 41 | - * |
|
| 42 | - * Example: Entire website down, database unavailable, etc. This should |
|
| 43 | - * trigger the SMS alerts and wake you up. |
|
| 44 | - * |
|
| 45 | - * @param string $message |
|
| 46 | - * @param mixed[] $context |
|
| 47 | - * |
|
| 48 | - * @return void |
|
| 49 | - */ |
|
| 50 | - public function alert($message, array $context = []); |
|
| 39 | + /** |
|
| 40 | + * Action must be taken immediately. |
|
| 41 | + * |
|
| 42 | + * Example: Entire website down, database unavailable, etc. This should |
|
| 43 | + * trigger the SMS alerts and wake you up. |
|
| 44 | + * |
|
| 45 | + * @param string $message |
|
| 46 | + * @param mixed[] $context |
|
| 47 | + * |
|
| 48 | + * @return void |
|
| 49 | + */ |
|
| 50 | + public function alert($message, array $context = []); |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Critical conditions. |
|
| 54 | - * |
|
| 55 | - * Example: Application component unavailable, unexpected exception. |
|
| 56 | - * |
|
| 57 | - * @param string $message |
|
| 58 | - * @param mixed[] $context |
|
| 59 | - * |
|
| 60 | - * @return void |
|
| 61 | - */ |
|
| 62 | - public function critical($message, array $context = []); |
|
| 52 | + /** |
|
| 53 | + * Critical conditions. |
|
| 54 | + * |
|
| 55 | + * Example: Application component unavailable, unexpected exception. |
|
| 56 | + * |
|
| 57 | + * @param string $message |
|
| 58 | + * @param mixed[] $context |
|
| 59 | + * |
|
| 60 | + * @return void |
|
| 61 | + */ |
|
| 62 | + public function critical($message, array $context = []); |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Runtime errors that do not require immediate action but should typically |
|
| 66 | - * be logged and monitored. |
|
| 67 | - * |
|
| 68 | - * @param string $message |
|
| 69 | - * @param mixed[] $context |
|
| 70 | - * |
|
| 71 | - * @return void |
|
| 72 | - */ |
|
| 73 | - public function error($message, array $context = []); |
|
| 64 | + /** |
|
| 65 | + * Runtime errors that do not require immediate action but should typically |
|
| 66 | + * be logged and monitored. |
|
| 67 | + * |
|
| 68 | + * @param string $message |
|
| 69 | + * @param mixed[] $context |
|
| 70 | + * |
|
| 71 | + * @return void |
|
| 72 | + */ |
|
| 73 | + public function error($message, array $context = []); |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Exceptional occurrences that are not errors. |
|
| 77 | - * |
|
| 78 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
| 79 | - * that are not necessarily wrong. |
|
| 80 | - * |
|
| 81 | - * @param string $message |
|
| 82 | - * @param mixed[] $context |
|
| 83 | - * |
|
| 84 | - * @return void |
|
| 85 | - */ |
|
| 86 | - public function warning($message, array $context = []); |
|
| 75 | + /** |
|
| 76 | + * Exceptional occurrences that are not errors. |
|
| 77 | + * |
|
| 78 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
| 79 | + * that are not necessarily wrong. |
|
| 80 | + * |
|
| 81 | + * @param string $message |
|
| 82 | + * @param mixed[] $context |
|
| 83 | + * |
|
| 84 | + * @return void |
|
| 85 | + */ |
|
| 86 | + public function warning($message, array $context = []); |
|
| 87 | 87 | |
| 88 | - /** |
|
| 89 | - * Normal but significant events. |
|
| 90 | - * |
|
| 91 | - * @param string $message |
|
| 92 | - * @param mixed[] $context |
|
| 93 | - * |
|
| 94 | - * @return void |
|
| 95 | - */ |
|
| 96 | - public function notice($message, array $context = []); |
|
| 88 | + /** |
|
| 89 | + * Normal but significant events. |
|
| 90 | + * |
|
| 91 | + * @param string $message |
|
| 92 | + * @param mixed[] $context |
|
| 93 | + * |
|
| 94 | + * @return void |
|
| 95 | + */ |
|
| 96 | + public function notice($message, array $context = []); |
|
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * Interesting events. |
|
| 100 | - * |
|
| 101 | - * Example: User logs in, SQL logs. |
|
| 102 | - * |
|
| 103 | - * @param string $message |
|
| 104 | - * @param mixed[] $context |
|
| 105 | - * |
|
| 106 | - * @return void |
|
| 107 | - */ |
|
| 108 | - public function info($message, array $context = []); |
|
| 98 | + /** |
|
| 99 | + * Interesting events. |
|
| 100 | + * |
|
| 101 | + * Example: User logs in, SQL logs. |
|
| 102 | + * |
|
| 103 | + * @param string $message |
|
| 104 | + * @param mixed[] $context |
|
| 105 | + * |
|
| 106 | + * @return void |
|
| 107 | + */ |
|
| 108 | + public function info($message, array $context = []); |
|
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Detailed debug information. |
|
| 112 | - * |
|
| 113 | - * @param string $message |
|
| 114 | - * @param mixed[] $context |
|
| 115 | - * |
|
| 116 | - * @return void |
|
| 117 | - */ |
|
| 118 | - public function debug($message, array $context = []); |
|
| 110 | + /** |
|
| 111 | + * Detailed debug information. |
|
| 112 | + * |
|
| 113 | + * @param string $message |
|
| 114 | + * @param mixed[] $context |
|
| 115 | + * |
|
| 116 | + * @return void |
|
| 117 | + */ |
|
| 118 | + public function debug($message, array $context = []); |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Logs with an arbitrary level. |
|
| 122 | - * |
|
| 123 | - * @param mixed $level |
|
| 124 | - * @param string $message |
|
| 125 | - * @param mixed[] $context |
|
| 126 | - * |
|
| 127 | - * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
| 128 | - * |
|
| 129 | - * @return void |
|
| 130 | - */ |
|
| 131 | - public function log($level, $message, array $context = []); |
|
| 120 | + /** |
|
| 121 | + * Logs with an arbitrary level. |
|
| 122 | + * |
|
| 123 | + * @param mixed $level |
|
| 124 | + * @param string $message |
|
| 125 | + * @param mixed[] $context |
|
| 126 | + * |
|
| 127 | + * @throws \GravityView\Psr\Log\InvalidArgumentException |
|
| 128 | + * |
|
| 129 | + * @return void |
|
| 130 | + */ |
|
| 131 | + public function log($level, $message, array $context = []); |
|
| 132 | 132 | } |
@@ -34,7 +34,7 @@ discard block |
||
| 34 | 34 | * |
| 35 | 35 | * @return void |
| 36 | 36 | */ |
| 37 | - public function emergency($message, array $context = []); |
|
| 37 | + public function emergency( $message, array $context = [ ] ); |
|
| 38 | 38 | |
| 39 | 39 | /** |
| 40 | 40 | * Action must be taken immediately. |
@@ -47,7 +47,7 @@ discard block |
||
| 47 | 47 | * |
| 48 | 48 | * @return void |
| 49 | 49 | */ |
| 50 | - public function alert($message, array $context = []); |
|
| 50 | + public function alert( $message, array $context = [ ] ); |
|
| 51 | 51 | |
| 52 | 52 | /** |
| 53 | 53 | * Critical conditions. |
@@ -59,7 +59,7 @@ discard block |
||
| 59 | 59 | * |
| 60 | 60 | * @return void |
| 61 | 61 | */ |
| 62 | - public function critical($message, array $context = []); |
|
| 62 | + public function critical( $message, array $context = [ ] ); |
|
| 63 | 63 | |
| 64 | 64 | /** |
| 65 | 65 | * Runtime errors that do not require immediate action but should typically |
@@ -70,7 +70,7 @@ discard block |
||
| 70 | 70 | * |
| 71 | 71 | * @return void |
| 72 | 72 | */ |
| 73 | - public function error($message, array $context = []); |
|
| 73 | + public function error( $message, array $context = [ ] ); |
|
| 74 | 74 | |
| 75 | 75 | /** |
| 76 | 76 | * Exceptional occurrences that are not errors. |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | * |
| 84 | 84 | * @return void |
| 85 | 85 | */ |
| 86 | - public function warning($message, array $context = []); |
|
| 86 | + public function warning( $message, array $context = [ ] ); |
|
| 87 | 87 | |
| 88 | 88 | /** |
| 89 | 89 | * Normal but significant events. |
@@ -93,7 +93,7 @@ discard block |
||
| 93 | 93 | * |
| 94 | 94 | * @return void |
| 95 | 95 | */ |
| 96 | - public function notice($message, array $context = []); |
|
| 96 | + public function notice( $message, array $context = [ ] ); |
|
| 97 | 97 | |
| 98 | 98 | /** |
| 99 | 99 | * Interesting events. |
@@ -105,7 +105,7 @@ discard block |
||
| 105 | 105 | * |
| 106 | 106 | * @return void |
| 107 | 107 | */ |
| 108 | - public function info($message, array $context = []); |
|
| 108 | + public function info( $message, array $context = [ ] ); |
|
| 109 | 109 | |
| 110 | 110 | /** |
| 111 | 111 | * Detailed debug information. |
@@ -115,7 +115,7 @@ discard block |
||
| 115 | 115 | * |
| 116 | 116 | * @return void |
| 117 | 117 | */ |
| 118 | - public function debug($message, array $context = []); |
|
| 118 | + public function debug( $message, array $context = [ ] ); |
|
| 119 | 119 | |
| 120 | 120 | /** |
| 121 | 121 | * Logs with an arbitrary level. |
@@ -128,5 +128,5 @@ discard block |
||
| 128 | 128 | * |
| 129 | 129 | * @return void |
| 130 | 130 | */ |
| 131 | - public function log($level, $message, array $context = []); |
|
| 131 | + public function log( $level, $message, array $context = [ ] ); |
|
| 132 | 132 | } |
@@ -27,164 +27,164 @@ |
||
| 27 | 27 | */ |
| 28 | 28 | |
| 29 | 29 | if (!defined('RANDOM_COMPAT_READ_BUFFER')) { |
| 30 | - define('RANDOM_COMPAT_READ_BUFFER', 8); |
|
| 30 | + define('RANDOM_COMPAT_READ_BUFFER', 8); |
|
| 31 | 31 | } |
| 32 | 32 | |
| 33 | 33 | if (!is_callable('random_bytes')) { |
| 34 | - /** |
|
| 35 | - * Unless open_basedir is enabled, use /dev/urandom for |
|
| 36 | - * random numbers in accordance with best practices |
|
| 37 | - * |
|
| 38 | - * Why we use /dev/urandom and not /dev/random |
|
| 39 | - * @ref https://www.2uo.de/myths-about-urandom |
|
| 40 | - * @ref http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers |
|
| 41 | - * |
|
| 42 | - * @param int $bytes |
|
| 43 | - * |
|
| 44 | - * @throws Exception |
|
| 45 | - * |
|
| 46 | - * @return string |
|
| 47 | - */ |
|
| 48 | - function random_bytes($bytes) |
|
| 49 | - { |
|
| 50 | - /** @var resource $fp */ |
|
| 51 | - static $fp = null; |
|
| 34 | + /** |
|
| 35 | + * Unless open_basedir is enabled, use /dev/urandom for |
|
| 36 | + * random numbers in accordance with best practices |
|
| 37 | + * |
|
| 38 | + * Why we use /dev/urandom and not /dev/random |
|
| 39 | + * @ref https://www.2uo.de/myths-about-urandom |
|
| 40 | + * @ref http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers |
|
| 41 | + * |
|
| 42 | + * @param int $bytes |
|
| 43 | + * |
|
| 44 | + * @throws Exception |
|
| 45 | + * |
|
| 46 | + * @return string |
|
| 47 | + */ |
|
| 48 | + function random_bytes($bytes) |
|
| 49 | + { |
|
| 50 | + /** @var resource $fp */ |
|
| 51 | + static $fp = null; |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * This block should only be run once |
|
| 55 | - */ |
|
| 56 | - if (empty($fp)) { |
|
| 57 | - /** |
|
| 58 | - * We don't want to ever read C:\dev\random, only /dev/urandom on |
|
| 59 | - * Unix-like operating systems. While we guard against this |
|
| 60 | - * condition in random.php, it doesn't hurt to be defensive in depth |
|
| 61 | - * here. |
|
| 62 | - * |
|
| 63 | - * To that end, we only try to open /dev/urandom if we're on a Unix- |
|
| 64 | - * like operating system (which means the directory separator is set |
|
| 65 | - * to "/" not "\". |
|
| 66 | - */ |
|
| 67 | - if (DIRECTORY_SEPARATOR === '/') { |
|
| 68 | - if (!is_readable('/dev/urandom')) { |
|
| 69 | - throw new Exception( |
|
| 70 | - 'Environment misconfiguration: ' . |
|
| 71 | - '/dev/urandom cannot be read.' |
|
| 72 | - ); |
|
| 73 | - } |
|
| 74 | - /** |
|
| 75 | - * We use /dev/urandom if it is a char device. |
|
| 76 | - * We never fall back to /dev/random |
|
| 77 | - */ |
|
| 78 | - /** @var resource|bool $fp */ |
|
| 79 | - $fp = fopen('/dev/urandom', 'rb'); |
|
| 80 | - if (is_resource($fp)) { |
|
| 81 | - /** @var array<string, int> $st */ |
|
| 82 | - $st = fstat($fp); |
|
| 83 | - if (($st['mode'] & 0170000) !== 020000) { |
|
| 84 | - fclose($fp); |
|
| 85 | - $fp = false; |
|
| 86 | - } |
|
| 87 | - } |
|
| 88 | - } |
|
| 53 | + /** |
|
| 54 | + * This block should only be run once |
|
| 55 | + */ |
|
| 56 | + if (empty($fp)) { |
|
| 57 | + /** |
|
| 58 | + * We don't want to ever read C:\dev\random, only /dev/urandom on |
|
| 59 | + * Unix-like operating systems. While we guard against this |
|
| 60 | + * condition in random.php, it doesn't hurt to be defensive in depth |
|
| 61 | + * here. |
|
| 62 | + * |
|
| 63 | + * To that end, we only try to open /dev/urandom if we're on a Unix- |
|
| 64 | + * like operating system (which means the directory separator is set |
|
| 65 | + * to "/" not "\". |
|
| 66 | + */ |
|
| 67 | + if (DIRECTORY_SEPARATOR === '/') { |
|
| 68 | + if (!is_readable('/dev/urandom')) { |
|
| 69 | + throw new Exception( |
|
| 70 | + 'Environment misconfiguration: ' . |
|
| 71 | + '/dev/urandom cannot be read.' |
|
| 72 | + ); |
|
| 73 | + } |
|
| 74 | + /** |
|
| 75 | + * We use /dev/urandom if it is a char device. |
|
| 76 | + * We never fall back to /dev/random |
|
| 77 | + */ |
|
| 78 | + /** @var resource|bool $fp */ |
|
| 79 | + $fp = fopen('/dev/urandom', 'rb'); |
|
| 80 | + if (is_resource($fp)) { |
|
| 81 | + /** @var array<string, int> $st */ |
|
| 82 | + $st = fstat($fp); |
|
| 83 | + if (($st['mode'] & 0170000) !== 020000) { |
|
| 84 | + fclose($fp); |
|
| 85 | + $fp = false; |
|
| 86 | + } |
|
| 87 | + } |
|
| 88 | + } |
|
| 89 | 89 | |
| 90 | - if (is_resource($fp)) { |
|
| 91 | - /** |
|
| 92 | - * stream_set_read_buffer() does not exist in HHVM |
|
| 93 | - * |
|
| 94 | - * If we don't set the stream's read buffer to 0, PHP will |
|
| 95 | - * internally buffer 8192 bytes, which can waste entropy |
|
| 96 | - * |
|
| 97 | - * stream_set_read_buffer returns 0 on success |
|
| 98 | - */ |
|
| 99 | - if (is_callable('stream_set_read_buffer')) { |
|
| 100 | - stream_set_read_buffer($fp, RANDOM_COMPAT_READ_BUFFER); |
|
| 101 | - } |
|
| 102 | - if (is_callable('stream_set_chunk_size')) { |
|
| 103 | - stream_set_chunk_size($fp, RANDOM_COMPAT_READ_BUFFER); |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - } |
|
| 90 | + if (is_resource($fp)) { |
|
| 91 | + /** |
|
| 92 | + * stream_set_read_buffer() does not exist in HHVM |
|
| 93 | + * |
|
| 94 | + * If we don't set the stream's read buffer to 0, PHP will |
|
| 95 | + * internally buffer 8192 bytes, which can waste entropy |
|
| 96 | + * |
|
| 97 | + * stream_set_read_buffer returns 0 on success |
|
| 98 | + */ |
|
| 99 | + if (is_callable('stream_set_read_buffer')) { |
|
| 100 | + stream_set_read_buffer($fp, RANDOM_COMPAT_READ_BUFFER); |
|
| 101 | + } |
|
| 102 | + if (is_callable('stream_set_chunk_size')) { |
|
| 103 | + stream_set_chunk_size($fp, RANDOM_COMPAT_READ_BUFFER); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | - try { |
|
| 109 | - /** @var int $bytes */ |
|
| 110 | - $bytes = RandomCompat_intval($bytes); |
|
| 111 | - } catch (TypeError $ex) { |
|
| 112 | - throw new TypeError( |
|
| 113 | - 'random_bytes(): $bytes must be an integer' |
|
| 114 | - ); |
|
| 115 | - } |
|
| 108 | + try { |
|
| 109 | + /** @var int $bytes */ |
|
| 110 | + $bytes = RandomCompat_intval($bytes); |
|
| 111 | + } catch (TypeError $ex) { |
|
| 112 | + throw new TypeError( |
|
| 113 | + 'random_bytes(): $bytes must be an integer' |
|
| 114 | + ); |
|
| 115 | + } |
|
| 116 | 116 | |
| 117 | - if ($bytes < 1) { |
|
| 118 | - throw new Error( |
|
| 119 | - 'Length must be greater than 0' |
|
| 120 | - ); |
|
| 121 | - } |
|
| 117 | + if ($bytes < 1) { |
|
| 118 | + throw new Error( |
|
| 119 | + 'Length must be greater than 0' |
|
| 120 | + ); |
|
| 121 | + } |
|
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * This if() block only runs if we managed to open a file handle |
|
| 125 | - * |
|
| 126 | - * It does not belong in an else {} block, because the above |
|
| 127 | - * if (empty($fp)) line is logic that should only be run once per |
|
| 128 | - * page load. |
|
| 129 | - */ |
|
| 130 | - if (is_resource($fp)) { |
|
| 131 | - /** |
|
| 132 | - * @var int |
|
| 133 | - */ |
|
| 134 | - $remaining = $bytes; |
|
| 123 | + /** |
|
| 124 | + * This if() block only runs if we managed to open a file handle |
|
| 125 | + * |
|
| 126 | + * It does not belong in an else {} block, because the above |
|
| 127 | + * if (empty($fp)) line is logic that should only be run once per |
|
| 128 | + * page load. |
|
| 129 | + */ |
|
| 130 | + if (is_resource($fp)) { |
|
| 131 | + /** |
|
| 132 | + * @var int |
|
| 133 | + */ |
|
| 134 | + $remaining = $bytes; |
|
| 135 | 135 | |
| 136 | - /** |
|
| 137 | - * @var string|bool |
|
| 138 | - */ |
|
| 139 | - $buf = ''; |
|
| 136 | + /** |
|
| 137 | + * @var string|bool |
|
| 138 | + */ |
|
| 139 | + $buf = ''; |
|
| 140 | 140 | |
| 141 | - /** |
|
| 142 | - * We use fread() in a loop to protect against partial reads |
|
| 143 | - */ |
|
| 144 | - do { |
|
| 145 | - /** |
|
| 146 | - * @var string|bool |
|
| 147 | - */ |
|
| 148 | - $read = fread($fp, $remaining); |
|
| 149 | - if (!is_string($read)) { |
|
| 150 | - /** |
|
| 151 | - * We cannot safely read from the file. Exit the |
|
| 152 | - * do-while loop and trigger the exception condition |
|
| 153 | - * |
|
| 154 | - * @var string|bool |
|
| 155 | - */ |
|
| 156 | - $buf = false; |
|
| 157 | - break; |
|
| 158 | - } |
|
| 159 | - /** |
|
| 160 | - * Decrease the number of bytes returned from remaining |
|
| 161 | - */ |
|
| 162 | - $remaining -= RandomCompat_strlen($read); |
|
| 163 | - /** |
|
| 164 | - * @var string $buf |
|
| 165 | - */ |
|
| 166 | - $buf .= $read; |
|
| 167 | - } while ($remaining > 0); |
|
| 141 | + /** |
|
| 142 | + * We use fread() in a loop to protect against partial reads |
|
| 143 | + */ |
|
| 144 | + do { |
|
| 145 | + /** |
|
| 146 | + * @var string|bool |
|
| 147 | + */ |
|
| 148 | + $read = fread($fp, $remaining); |
|
| 149 | + if (!is_string($read)) { |
|
| 150 | + /** |
|
| 151 | + * We cannot safely read from the file. Exit the |
|
| 152 | + * do-while loop and trigger the exception condition |
|
| 153 | + * |
|
| 154 | + * @var string|bool |
|
| 155 | + */ |
|
| 156 | + $buf = false; |
|
| 157 | + break; |
|
| 158 | + } |
|
| 159 | + /** |
|
| 160 | + * Decrease the number of bytes returned from remaining |
|
| 161 | + */ |
|
| 162 | + $remaining -= RandomCompat_strlen($read); |
|
| 163 | + /** |
|
| 164 | + * @var string $buf |
|
| 165 | + */ |
|
| 166 | + $buf .= $read; |
|
| 167 | + } while ($remaining > 0); |
|
| 168 | 168 | |
| 169 | - /** |
|
| 170 | - * Is our result valid? |
|
| 171 | - * @var string|bool $buf |
|
| 172 | - */ |
|
| 173 | - if (is_string($buf)) { |
|
| 174 | - if (RandomCompat_strlen($buf) === $bytes) { |
|
| 175 | - /** |
|
| 176 | - * Return our random entropy buffer here: |
|
| 177 | - */ |
|
| 178 | - return $buf; |
|
| 179 | - } |
|
| 180 | - } |
|
| 181 | - } |
|
| 169 | + /** |
|
| 170 | + * Is our result valid? |
|
| 171 | + * @var string|bool $buf |
|
| 172 | + */ |
|
| 173 | + if (is_string($buf)) { |
|
| 174 | + if (RandomCompat_strlen($buf) === $bytes) { |
|
| 175 | + /** |
|
| 176 | + * Return our random entropy buffer here: |
|
| 177 | + */ |
|
| 178 | + return $buf; |
|
| 179 | + } |
|
| 180 | + } |
|
| 181 | + } |
|
| 182 | 182 | |
| 183 | - /** |
|
| 184 | - * If we reach here, PHP has failed us. |
|
| 185 | - */ |
|
| 186 | - throw new Exception( |
|
| 187 | - 'Error reading from source device' |
|
| 188 | - ); |
|
| 189 | - } |
|
| 183 | + /** |
|
| 184 | + * If we reach here, PHP has failed us. |
|
| 185 | + */ |
|
| 186 | + throw new Exception( |
|
| 187 | + 'Error reading from source device' |
|
| 188 | + ); |
|
| 189 | + } |
|
| 190 | 190 | } |
@@ -26,11 +26,11 @@ discard block |
||
| 26 | 26 | * SOFTWARE. |
| 27 | 27 | */ |
| 28 | 28 | |
| 29 | -if (!defined('RANDOM_COMPAT_READ_BUFFER')) { |
|
| 30 | - define('RANDOM_COMPAT_READ_BUFFER', 8); |
|
| 29 | +if ( ! defined( 'RANDOM_COMPAT_READ_BUFFER' ) ) { |
|
| 30 | + define( 'RANDOM_COMPAT_READ_BUFFER', 8 ); |
|
| 31 | 31 | } |
| 32 | 32 | |
| 33 | -if (!is_callable('random_bytes')) { |
|
| 33 | +if ( ! is_callable( 'random_bytes' ) ) { |
|
| 34 | 34 | /** |
| 35 | 35 | * Unless open_basedir is enabled, use /dev/urandom for |
| 36 | 36 | * random numbers in accordance with best practices |
@@ -45,7 +45,7 @@ discard block |
||
| 45 | 45 | * |
| 46 | 46 | * @return string |
| 47 | 47 | */ |
| 48 | - function random_bytes($bytes) |
|
| 48 | + function random_bytes( $bytes ) |
|
| 49 | 49 | { |
| 50 | 50 | /** @var resource $fp */ |
| 51 | 51 | static $fp = null; |
@@ -53,7 +53,7 @@ discard block |
||
| 53 | 53 | /** |
| 54 | 54 | * This block should only be run once |
| 55 | 55 | */ |
| 56 | - if (empty($fp)) { |
|
| 56 | + if ( empty( $fp ) ) { |
|
| 57 | 57 | /** |
| 58 | 58 | * We don't want to ever read C:\dev\random, only /dev/urandom on |
| 59 | 59 | * Unix-like operating systems. While we guard against this |
@@ -64,8 +64,8 @@ discard block |
||
| 64 | 64 | * like operating system (which means the directory separator is set |
| 65 | 65 | * to "/" not "\". |
| 66 | 66 | */ |
| 67 | - if (DIRECTORY_SEPARATOR === '/') { |
|
| 68 | - if (!is_readable('/dev/urandom')) { |
|
| 67 | + if ( DIRECTORY_SEPARATOR === '/' ) { |
|
| 68 | + if ( ! is_readable( '/dev/urandom' ) ) { |
|
| 69 | 69 | throw new Exception( |
| 70 | 70 | 'Environment misconfiguration: ' . |
| 71 | 71 | '/dev/urandom cannot be read.' |
@@ -76,18 +76,18 @@ discard block |
||
| 76 | 76 | * We never fall back to /dev/random |
| 77 | 77 | */ |
| 78 | 78 | /** @var resource|bool $fp */ |
| 79 | - $fp = fopen('/dev/urandom', 'rb'); |
|
| 80 | - if (is_resource($fp)) { |
|
| 79 | + $fp = fopen( '/dev/urandom', 'rb' ); |
|
| 80 | + if ( is_resource( $fp ) ) { |
|
| 81 | 81 | /** @var array<string, int> $st */ |
| 82 | - $st = fstat($fp); |
|
| 83 | - if (($st['mode'] & 0170000) !== 020000) { |
|
| 84 | - fclose($fp); |
|
| 82 | + $st = fstat( $fp ); |
|
| 83 | + if ( ( $st[ 'mode' ] & 0170000 ) !== 020000 ) { |
|
| 84 | + fclose( $fp ); |
|
| 85 | 85 | $fp = false; |
| 86 | 86 | } |
| 87 | 87 | } |
| 88 | 88 | } |
| 89 | 89 | |
| 90 | - if (is_resource($fp)) { |
|
| 90 | + if ( is_resource( $fp ) ) { |
|
| 91 | 91 | /** |
| 92 | 92 | * stream_set_read_buffer() does not exist in HHVM |
| 93 | 93 | * |
@@ -96,25 +96,25 @@ discard block |
||
| 96 | 96 | * |
| 97 | 97 | * stream_set_read_buffer returns 0 on success |
| 98 | 98 | */ |
| 99 | - if (is_callable('stream_set_read_buffer')) { |
|
| 100 | - stream_set_read_buffer($fp, RANDOM_COMPAT_READ_BUFFER); |
|
| 99 | + if ( is_callable( 'stream_set_read_buffer' ) ) { |
|
| 100 | + stream_set_read_buffer( $fp, RANDOM_COMPAT_READ_BUFFER ); |
|
| 101 | 101 | } |
| 102 | - if (is_callable('stream_set_chunk_size')) { |
|
| 103 | - stream_set_chunk_size($fp, RANDOM_COMPAT_READ_BUFFER); |
|
| 102 | + if ( is_callable( 'stream_set_chunk_size' ) ) { |
|
| 103 | + stream_set_chunk_size( $fp, RANDOM_COMPAT_READ_BUFFER ); |
|
| 104 | 104 | } |
| 105 | 105 | } |
| 106 | 106 | } |
| 107 | 107 | |
| 108 | 108 | try { |
| 109 | 109 | /** @var int $bytes */ |
| 110 | - $bytes = RandomCompat_intval($bytes); |
|
| 111 | - } catch (TypeError $ex) { |
|
| 110 | + $bytes = RandomCompat_intval( $bytes ); |
|
| 111 | + } catch ( TypeError $ex ) { |
|
| 112 | 112 | throw new TypeError( |
| 113 | 113 | 'random_bytes(): $bytes must be an integer' |
| 114 | 114 | ); |
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - if ($bytes < 1) { |
|
| 117 | + if ( $bytes < 1 ) { |
|
| 118 | 118 | throw new Error( |
| 119 | 119 | 'Length must be greater than 0' |
| 120 | 120 | ); |
@@ -127,7 +127,7 @@ discard block |
||
| 127 | 127 | * if (empty($fp)) line is logic that should only be run once per |
| 128 | 128 | * page load. |
| 129 | 129 | */ |
| 130 | - if (is_resource($fp)) { |
|
| 130 | + if ( is_resource( $fp ) ) { |
|
| 131 | 131 | /** |
| 132 | 132 | * @var int |
| 133 | 133 | */ |
@@ -145,8 +145,8 @@ discard block |
||
| 145 | 145 | /** |
| 146 | 146 | * @var string|bool |
| 147 | 147 | */ |
| 148 | - $read = fread($fp, $remaining); |
|
| 149 | - if (!is_string($read)) { |
|
| 148 | + $read = fread( $fp, $remaining ); |
|
| 149 | + if ( ! is_string( $read ) ) { |
|
| 150 | 150 | /** |
| 151 | 151 | * We cannot safely read from the file. Exit the |
| 152 | 152 | * do-while loop and trigger the exception condition |
@@ -159,19 +159,19 @@ discard block |
||
| 159 | 159 | /** |
| 160 | 160 | * Decrease the number of bytes returned from remaining |
| 161 | 161 | */ |
| 162 | - $remaining -= RandomCompat_strlen($read); |
|
| 162 | + $remaining -= RandomCompat_strlen( $read ); |
|
| 163 | 163 | /** |
| 164 | 164 | * @var string $buf |
| 165 | 165 | */ |
| 166 | 166 | $buf .= $read; |
| 167 | - } while ($remaining > 0); |
|
| 167 | + } while ( $remaining > 0 ); |
|
| 168 | 168 | |
| 169 | 169 | /** |
| 170 | 170 | * Is our result valid? |
| 171 | 171 | * @var string|bool $buf |
| 172 | 172 | */ |
| 173 | - if (is_string($buf)) { |
|
| 174 | - if (RandomCompat_strlen($buf) === $bytes) { |
|
| 173 | + if ( is_string( $buf ) ) { |
|
| 174 | + if ( RandomCompat_strlen( $buf ) === $bytes ) { |
|
| 175 | 175 | /** |
| 176 | 176 | * Return our random entropy buffer here: |
| 177 | 177 | */ |
@@ -45,8 +45,7 @@ |
||
| 45 | 45 | * |
| 46 | 46 | * @return string |
| 47 | 47 | */ |
| 48 | - function random_bytes($bytes) |
|
| 49 | - { |
|
| 48 | + function random_bytes($bytes) { |
|
| 50 | 49 | /** @var resource $fp */ |
| 51 | 50 | static $fp = null; |
| 52 | 51 | |
@@ -1,204 +1,204 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | if (!is_callable('random_int')) { |
| 4 | - /** |
|
| 5 | - * Random_* Compatibility Library |
|
| 6 | - * for using the new PHP 7 random_* API in PHP 5 projects |
|
| 7 | - * |
|
| 8 | - * The MIT License (MIT) |
|
| 9 | - * |
|
| 10 | - * Copyright (c) 2015 - 2018 Paragon Initiative Enterprises |
|
| 11 | - * |
|
| 12 | - * Permission is hereby granted, free of charge, to any person obtaining a copy |
|
| 13 | - * of this software and associated documentation files (the "Software"), to deal |
|
| 14 | - * in the Software without restriction, including without limitation the rights |
|
| 15 | - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
| 16 | - * copies of the Software, and to permit persons to whom the Software is |
|
| 17 | - * furnished to do so, subject to the following conditions: |
|
| 18 | - * |
|
| 19 | - * The above copyright notice and this permission notice shall be included in |
|
| 20 | - * all copies or substantial portions of the Software. |
|
| 21 | - * |
|
| 22 | - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
| 23 | - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
| 24 | - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
| 25 | - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
| 26 | - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
| 27 | - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
| 28 | - * SOFTWARE. |
|
| 29 | - */ |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * Fetch a random integer between $min and $max inclusive |
|
| 33 | - * |
|
| 34 | - * @param int $min |
|
| 35 | - * @param int $max |
|
| 36 | - * |
|
| 37 | - * @throws Exception |
|
| 38 | - * |
|
| 39 | - * @return int |
|
| 40 | - */ |
|
| 41 | - function random_int($min, $max) |
|
| 42 | - { |
|
| 43 | - /** |
|
| 44 | - * Type and input logic checks |
|
| 45 | - * |
|
| 46 | - * If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX) |
|
| 47 | - * (non-inclusive), it will sanely cast it to an int. If you it's equal to |
|
| 48 | - * ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats |
|
| 49 | - * lose precision, so the <= and => operators might accidentally let a float |
|
| 50 | - * through. |
|
| 51 | - */ |
|
| 52 | - |
|
| 53 | - try { |
|
| 54 | - /** @var int $min */ |
|
| 55 | - $min = RandomCompat_intval($min); |
|
| 56 | - } catch (TypeError $ex) { |
|
| 57 | - throw new TypeError( |
|
| 58 | - 'random_int(): $min must be an integer' |
|
| 59 | - ); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - try { |
|
| 63 | - /** @var int $max */ |
|
| 64 | - $max = RandomCompat_intval($max); |
|
| 65 | - } catch (TypeError $ex) { |
|
| 66 | - throw new TypeError( |
|
| 67 | - 'random_int(): $max must be an integer' |
|
| 68 | - ); |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * Now that we've verified our weak typing system has given us an integer, |
|
| 73 | - * let's validate the logic then we can move forward with generating random |
|
| 74 | - * integers along a given range. |
|
| 75 | - */ |
|
| 76 | - if ($min > $max) { |
|
| 77 | - throw new Error( |
|
| 78 | - 'Minimum value must be less than or equal to the maximum value' |
|
| 79 | - ); |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - if ($max === $min) { |
|
| 83 | - return (int) $min; |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Initialize variables to 0 |
|
| 88 | - * |
|
| 89 | - * We want to store: |
|
| 90 | - * $bytes => the number of random bytes we need |
|
| 91 | - * $mask => an integer bitmask (for use with the &) operator |
|
| 92 | - * so we can minimize the number of discards |
|
| 93 | - */ |
|
| 94 | - $attempts = $bits = $bytes = $mask = $valueShift = 0; |
|
| 95 | - /** @var int $attempts */ |
|
| 96 | - /** @var int $bits */ |
|
| 97 | - /** @var int $bytes */ |
|
| 98 | - /** @var int $mask */ |
|
| 99 | - /** @var int $valueShift */ |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * At this point, $range is a positive number greater than 0. It might |
|
| 103 | - * overflow, however, if $max - $min > PHP_INT_MAX. PHP will cast it to |
|
| 104 | - * a float and we will lose some precision. |
|
| 105 | - * |
|
| 106 | - * @var int|float $range |
|
| 107 | - */ |
|
| 108 | - $range = $max - $min; |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Test for integer overflow: |
|
| 112 | - */ |
|
| 113 | - if (!is_int($range)) { |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Still safely calculate wider ranges. |
|
| 117 | - * Provided by @CodesInChaos, @oittaa |
|
| 118 | - * |
|
| 119 | - * @ref https://gist.github.com/CodesInChaos/03f9ea0b58e8b2b8d435 |
|
| 120 | - * |
|
| 121 | - * We use ~0 as a mask in this case because it generates all 1s |
|
| 122 | - * |
|
| 123 | - * @ref https://eval.in/400356 (32-bit) |
|
| 124 | - * @ref http://3v4l.org/XX9r5 (64-bit) |
|
| 125 | - */ |
|
| 126 | - $bytes = PHP_INT_SIZE; |
|
| 127 | - /** @var int $mask */ |
|
| 128 | - $mask = ~0; |
|
| 129 | - |
|
| 130 | - } else { |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * $bits is effectively ceil(log($range, 2)) without dealing with |
|
| 134 | - * type juggling |
|
| 135 | - */ |
|
| 136 | - while ($range > 0) { |
|
| 137 | - if ($bits % 8 === 0) { |
|
| 138 | - ++$bytes; |
|
| 139 | - } |
|
| 140 | - ++$bits; |
|
| 141 | - $range >>= 1; |
|
| 142 | - /** @var int $mask */ |
|
| 143 | - $mask = $mask << 1 | 1; |
|
| 144 | - } |
|
| 145 | - $valueShift = $min; |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** @var int $val */ |
|
| 149 | - $val = 0; |
|
| 150 | - /** |
|
| 151 | - * Now that we have our parameters set up, let's begin generating |
|
| 152 | - * random integers until one falls between $min and $max |
|
| 153 | - */ |
|
| 154 | - /** @psalm-suppress RedundantCondition */ |
|
| 155 | - do { |
|
| 156 | - /** |
|
| 157 | - * The rejection probability is at most 0.5, so this corresponds |
|
| 158 | - * to a failure probability of 2^-128 for a working RNG |
|
| 159 | - */ |
|
| 160 | - if ($attempts > 128) { |
|
| 161 | - throw new Exception( |
|
| 162 | - 'random_int: RNG is broken - too many rejections' |
|
| 163 | - ); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Let's grab the necessary number of random bytes |
|
| 168 | - */ |
|
| 169 | - $randomByteString = random_bytes($bytes); |
|
| 170 | - |
|
| 171 | - /** |
|
| 172 | - * Let's turn $randomByteString into an integer |
|
| 173 | - * |
|
| 174 | - * This uses bitwise operators (<< and |) to build an integer |
|
| 175 | - * out of the values extracted from ord() |
|
| 176 | - * |
|
| 177 | - * Example: [9F] | [6D] | [32] | [0C] => |
|
| 178 | - * 159 + 27904 + 3276800 + 201326592 => |
|
| 179 | - * 204631455 |
|
| 180 | - */ |
|
| 181 | - $val &= 0; |
|
| 182 | - for ($i = 0; $i < $bytes; ++$i) { |
|
| 183 | - $val |= ord($randomByteString[$i]) << ($i * 8); |
|
| 184 | - } |
|
| 185 | - /** @var int $val */ |
|
| 186 | - |
|
| 187 | - /** |
|
| 188 | - * Apply mask |
|
| 189 | - */ |
|
| 190 | - $val &= $mask; |
|
| 191 | - $val += $valueShift; |
|
| 192 | - |
|
| 193 | - ++$attempts; |
|
| 194 | - /** |
|
| 195 | - * If $val overflows to a floating point number, |
|
| 196 | - * ... or is larger than $max, |
|
| 197 | - * ... or smaller than $min, |
|
| 198 | - * then try again. |
|
| 199 | - */ |
|
| 200 | - } while (!is_int($val) || $val > $max || $val < $min); |
|
| 201 | - |
|
| 202 | - return (int) $val; |
|
| 203 | - } |
|
| 4 | + /** |
|
| 5 | + * Random_* Compatibility Library |
|
| 6 | + * for using the new PHP 7 random_* API in PHP 5 projects |
|
| 7 | + * |
|
| 8 | + * The MIT License (MIT) |
|
| 9 | + * |
|
| 10 | + * Copyright (c) 2015 - 2018 Paragon Initiative Enterprises |
|
| 11 | + * |
|
| 12 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
|
| 13 | + * of this software and associated documentation files (the "Software"), to deal |
|
| 14 | + * in the Software without restriction, including without limitation the rights |
|
| 15 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
| 16 | + * copies of the Software, and to permit persons to whom the Software is |
|
| 17 | + * furnished to do so, subject to the following conditions: |
|
| 18 | + * |
|
| 19 | + * The above copyright notice and this permission notice shall be included in |
|
| 20 | + * all copies or substantial portions of the Software. |
|
| 21 | + * |
|
| 22 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
| 23 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
| 24 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
| 25 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
| 26 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
| 27 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
| 28 | + * SOFTWARE. |
|
| 29 | + */ |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * Fetch a random integer between $min and $max inclusive |
|
| 33 | + * |
|
| 34 | + * @param int $min |
|
| 35 | + * @param int $max |
|
| 36 | + * |
|
| 37 | + * @throws Exception |
|
| 38 | + * |
|
| 39 | + * @return int |
|
| 40 | + */ |
|
| 41 | + function random_int($min, $max) |
|
| 42 | + { |
|
| 43 | + /** |
|
| 44 | + * Type and input logic checks |
|
| 45 | + * |
|
| 46 | + * If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX) |
|
| 47 | + * (non-inclusive), it will sanely cast it to an int. If you it's equal to |
|
| 48 | + * ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats |
|
| 49 | + * lose precision, so the <= and => operators might accidentally let a float |
|
| 50 | + * through. |
|
| 51 | + */ |
|
| 52 | + |
|
| 53 | + try { |
|
| 54 | + /** @var int $min */ |
|
| 55 | + $min = RandomCompat_intval($min); |
|
| 56 | + } catch (TypeError $ex) { |
|
| 57 | + throw new TypeError( |
|
| 58 | + 'random_int(): $min must be an integer' |
|
| 59 | + ); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + try { |
|
| 63 | + /** @var int $max */ |
|
| 64 | + $max = RandomCompat_intval($max); |
|
| 65 | + } catch (TypeError $ex) { |
|
| 66 | + throw new TypeError( |
|
| 67 | + 'random_int(): $max must be an integer' |
|
| 68 | + ); |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * Now that we've verified our weak typing system has given us an integer, |
|
| 73 | + * let's validate the logic then we can move forward with generating random |
|
| 74 | + * integers along a given range. |
|
| 75 | + */ |
|
| 76 | + if ($min > $max) { |
|
| 77 | + throw new Error( |
|
| 78 | + 'Minimum value must be less than or equal to the maximum value' |
|
| 79 | + ); |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + if ($max === $min) { |
|
| 83 | + return (int) $min; |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * Initialize variables to 0 |
|
| 88 | + * |
|
| 89 | + * We want to store: |
|
| 90 | + * $bytes => the number of random bytes we need |
|
| 91 | + * $mask => an integer bitmask (for use with the &) operator |
|
| 92 | + * so we can minimize the number of discards |
|
| 93 | + */ |
|
| 94 | + $attempts = $bits = $bytes = $mask = $valueShift = 0; |
|
| 95 | + /** @var int $attempts */ |
|
| 96 | + /** @var int $bits */ |
|
| 97 | + /** @var int $bytes */ |
|
| 98 | + /** @var int $mask */ |
|
| 99 | + /** @var int $valueShift */ |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * At this point, $range is a positive number greater than 0. It might |
|
| 103 | + * overflow, however, if $max - $min > PHP_INT_MAX. PHP will cast it to |
|
| 104 | + * a float and we will lose some precision. |
|
| 105 | + * |
|
| 106 | + * @var int|float $range |
|
| 107 | + */ |
|
| 108 | + $range = $max - $min; |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Test for integer overflow: |
|
| 112 | + */ |
|
| 113 | + if (!is_int($range)) { |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Still safely calculate wider ranges. |
|
| 117 | + * Provided by @CodesInChaos, @oittaa |
|
| 118 | + * |
|
| 119 | + * @ref https://gist.github.com/CodesInChaos/03f9ea0b58e8b2b8d435 |
|
| 120 | + * |
|
| 121 | + * We use ~0 as a mask in this case because it generates all 1s |
|
| 122 | + * |
|
| 123 | + * @ref https://eval.in/400356 (32-bit) |
|
| 124 | + * @ref http://3v4l.org/XX9r5 (64-bit) |
|
| 125 | + */ |
|
| 126 | + $bytes = PHP_INT_SIZE; |
|
| 127 | + /** @var int $mask */ |
|
| 128 | + $mask = ~0; |
|
| 129 | + |
|
| 130 | + } else { |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * $bits is effectively ceil(log($range, 2)) without dealing with |
|
| 134 | + * type juggling |
|
| 135 | + */ |
|
| 136 | + while ($range > 0) { |
|
| 137 | + if ($bits % 8 === 0) { |
|
| 138 | + ++$bytes; |
|
| 139 | + } |
|
| 140 | + ++$bits; |
|
| 141 | + $range >>= 1; |
|
| 142 | + /** @var int $mask */ |
|
| 143 | + $mask = $mask << 1 | 1; |
|
| 144 | + } |
|
| 145 | + $valueShift = $min; |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** @var int $val */ |
|
| 149 | + $val = 0; |
|
| 150 | + /** |
|
| 151 | + * Now that we have our parameters set up, let's begin generating |
|
| 152 | + * random integers until one falls between $min and $max |
|
| 153 | + */ |
|
| 154 | + /** @psalm-suppress RedundantCondition */ |
|
| 155 | + do { |
|
| 156 | + /** |
|
| 157 | + * The rejection probability is at most 0.5, so this corresponds |
|
| 158 | + * to a failure probability of 2^-128 for a working RNG |
|
| 159 | + */ |
|
| 160 | + if ($attempts > 128) { |
|
| 161 | + throw new Exception( |
|
| 162 | + 'random_int: RNG is broken - too many rejections' |
|
| 163 | + ); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Let's grab the necessary number of random bytes |
|
| 168 | + */ |
|
| 169 | + $randomByteString = random_bytes($bytes); |
|
| 170 | + |
|
| 171 | + /** |
|
| 172 | + * Let's turn $randomByteString into an integer |
|
| 173 | + * |
|
| 174 | + * This uses bitwise operators (<< and |) to build an integer |
|
| 175 | + * out of the values extracted from ord() |
|
| 176 | + * |
|
| 177 | + * Example: [9F] | [6D] | [32] | [0C] => |
|
| 178 | + * 159 + 27904 + 3276800 + 201326592 => |
|
| 179 | + * 204631455 |
|
| 180 | + */ |
|
| 181 | + $val &= 0; |
|
| 182 | + for ($i = 0; $i < $bytes; ++$i) { |
|
| 183 | + $val |= ord($randomByteString[$i]) << ($i * 8); |
|
| 184 | + } |
|
| 185 | + /** @var int $val */ |
|
| 186 | + |
|
| 187 | + /** |
|
| 188 | + * Apply mask |
|
| 189 | + */ |
|
| 190 | + $val &= $mask; |
|
| 191 | + $val += $valueShift; |
|
| 192 | + |
|
| 193 | + ++$attempts; |
|
| 194 | + /** |
|
| 195 | + * If $val overflows to a floating point number, |
|
| 196 | + * ... or is larger than $max, |
|
| 197 | + * ... or smaller than $min, |
|
| 198 | + * then try again. |
|
| 199 | + */ |
|
| 200 | + } while (!is_int($val) || $val > $max || $val < $min); |
|
| 201 | + |
|
| 202 | + return (int) $val; |
|
| 203 | + } |
|
| 204 | 204 | } |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | -if (!is_callable('random_int')) { |
|
| 3 | +if ( ! is_callable( 'random_int' ) ) { |
|
| 4 | 4 | /** |
| 5 | 5 | * Random_* Compatibility Library |
| 6 | 6 | * for using the new PHP 7 random_* API in PHP 5 projects |
@@ -38,7 +38,7 @@ discard block |
||
| 38 | 38 | * |
| 39 | 39 | * @return int |
| 40 | 40 | */ |
| 41 | - function random_int($min, $max) |
|
| 41 | + function random_int( $min, $max ) |
|
| 42 | 42 | { |
| 43 | 43 | /** |
| 44 | 44 | * Type and input logic checks |
@@ -52,8 +52,8 @@ discard block |
||
| 52 | 52 | |
| 53 | 53 | try { |
| 54 | 54 | /** @var int $min */ |
| 55 | - $min = RandomCompat_intval($min); |
|
| 56 | - } catch (TypeError $ex) { |
|
| 55 | + $min = RandomCompat_intval( $min ); |
|
| 56 | + } catch ( TypeError $ex ) { |
|
| 57 | 57 | throw new TypeError( |
| 58 | 58 | 'random_int(): $min must be an integer' |
| 59 | 59 | ); |
@@ -61,8 +61,8 @@ discard block |
||
| 61 | 61 | |
| 62 | 62 | try { |
| 63 | 63 | /** @var int $max */ |
| 64 | - $max = RandomCompat_intval($max); |
|
| 65 | - } catch (TypeError $ex) { |
|
| 64 | + $max = RandomCompat_intval( $max ); |
|
| 65 | + } catch ( TypeError $ex ) { |
|
| 66 | 66 | throw new TypeError( |
| 67 | 67 | 'random_int(): $max must be an integer' |
| 68 | 68 | ); |
@@ -73,14 +73,14 @@ discard block |
||
| 73 | 73 | * let's validate the logic then we can move forward with generating random |
| 74 | 74 | * integers along a given range. |
| 75 | 75 | */ |
| 76 | - if ($min > $max) { |
|
| 76 | + if ( $min > $max ) { |
|
| 77 | 77 | throw new Error( |
| 78 | 78 | 'Minimum value must be less than or equal to the maximum value' |
| 79 | 79 | ); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - if ($max === $min) { |
|
| 83 | - return (int) $min; |
|
| 82 | + if ( $max === $min ) { |
|
| 83 | + return (int)$min; |
|
| 84 | 84 | } |
| 85 | 85 | |
| 86 | 86 | /** |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | /** |
| 111 | 111 | * Test for integer overflow: |
| 112 | 112 | */ |
| 113 | - if (!is_int($range)) { |
|
| 113 | + if ( ! is_int( $range ) ) { |
|
| 114 | 114 | |
| 115 | 115 | /** |
| 116 | 116 | * Still safely calculate wider ranges. |
@@ -133,8 +133,8 @@ discard block |
||
| 133 | 133 | * $bits is effectively ceil(log($range, 2)) without dealing with |
| 134 | 134 | * type juggling |
| 135 | 135 | */ |
| 136 | - while ($range > 0) { |
|
| 137 | - if ($bits % 8 === 0) { |
|
| 136 | + while ( $range > 0 ) { |
|
| 137 | + if ( $bits % 8 === 0 ) { |
|
| 138 | 138 | ++$bytes; |
| 139 | 139 | } |
| 140 | 140 | ++$bits; |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | * The rejection probability is at most 0.5, so this corresponds |
| 158 | 158 | * to a failure probability of 2^-128 for a working RNG |
| 159 | 159 | */ |
| 160 | - if ($attempts > 128) { |
|
| 160 | + if ( $attempts > 128 ) { |
|
| 161 | 161 | throw new Exception( |
| 162 | 162 | 'random_int: RNG is broken - too many rejections' |
| 163 | 163 | ); |
@@ -166,7 +166,7 @@ discard block |
||
| 166 | 166 | /** |
| 167 | 167 | * Let's grab the necessary number of random bytes |
| 168 | 168 | */ |
| 169 | - $randomByteString = random_bytes($bytes); |
|
| 169 | + $randomByteString = random_bytes( $bytes ); |
|
| 170 | 170 | |
| 171 | 171 | /** |
| 172 | 172 | * Let's turn $randomByteString into an integer |
@@ -179,8 +179,8 @@ discard block |
||
| 179 | 179 | * 204631455 |
| 180 | 180 | */ |
| 181 | 181 | $val &= 0; |
| 182 | - for ($i = 0; $i < $bytes; ++$i) { |
|
| 183 | - $val |= ord($randomByteString[$i]) << ($i * 8); |
|
| 182 | + for ( $i = 0; $i < $bytes; ++$i ) { |
|
| 183 | + $val |= ord( $randomByteString[ $i ] ) << ( $i * 8 ); |
|
| 184 | 184 | } |
| 185 | 185 | /** @var int $val */ |
| 186 | 186 | |
@@ -197,8 +197,8 @@ discard block |
||
| 197 | 197 | * ... or smaller than $min, |
| 198 | 198 | * then try again. |
| 199 | 199 | */ |
| 200 | - } while (!is_int($val) || $val > $max || $val < $min); |
|
| 200 | + } while ( ! is_int( $val ) || $val > $max || $val < $min ); |
|
| 201 | 201 | |
| 202 | - return (int) $val; |
|
| 202 | + return (int)$val; |
|
| 203 | 203 | } |
| 204 | 204 | } |
@@ -38,8 +38,7 @@ |
||
| 38 | 38 | * |
| 39 | 39 | * @return int |
| 40 | 40 | */ |
| 41 | - function random_int($min, $max) |
|
| 42 | - { |
|
| 41 | + function random_int($min, $max) { |
|
| 43 | 42 | /** |
| 44 | 43 | * Type and input logic checks |
| 45 | 44 | * |
@@ -27,67 +27,67 @@ |
||
| 27 | 27 | */ |
| 28 | 28 | |
| 29 | 29 | if (!is_callable('random_bytes')) { |
| 30 | - /** |
|
| 31 | - * If the libsodium PHP extension is loaded, we'll use it above any other |
|
| 32 | - * solution. |
|
| 33 | - * |
|
| 34 | - * libsodium-php project: |
|
| 35 | - * @ref https://github.com/jedisct1/libsodium-php |
|
| 36 | - * |
|
| 37 | - * @param int $bytes |
|
| 38 | - * |
|
| 39 | - * @throws Exception |
|
| 40 | - * |
|
| 41 | - * @return string |
|
| 42 | - */ |
|
| 43 | - function random_bytes($bytes) |
|
| 44 | - { |
|
| 45 | - try { |
|
| 46 | - /** @var int $bytes */ |
|
| 47 | - $bytes = RandomCompat_intval($bytes); |
|
| 48 | - } catch (TypeError $ex) { |
|
| 49 | - throw new TypeError( |
|
| 50 | - 'random_bytes(): $bytes must be an integer' |
|
| 51 | - ); |
|
| 52 | - } |
|
| 30 | + /** |
|
| 31 | + * If the libsodium PHP extension is loaded, we'll use it above any other |
|
| 32 | + * solution. |
|
| 33 | + * |
|
| 34 | + * libsodium-php project: |
|
| 35 | + * @ref https://github.com/jedisct1/libsodium-php |
|
| 36 | + * |
|
| 37 | + * @param int $bytes |
|
| 38 | + * |
|
| 39 | + * @throws Exception |
|
| 40 | + * |
|
| 41 | + * @return string |
|
| 42 | + */ |
|
| 43 | + function random_bytes($bytes) |
|
| 44 | + { |
|
| 45 | + try { |
|
| 46 | + /** @var int $bytes */ |
|
| 47 | + $bytes = RandomCompat_intval($bytes); |
|
| 48 | + } catch (TypeError $ex) { |
|
| 49 | + throw new TypeError( |
|
| 50 | + 'random_bytes(): $bytes must be an integer' |
|
| 51 | + ); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - if ($bytes < 1) { |
|
| 55 | - throw new Error( |
|
| 56 | - 'Length must be greater than 0' |
|
| 57 | - ); |
|
| 58 | - } |
|
| 54 | + if ($bytes < 1) { |
|
| 55 | + throw new Error( |
|
| 56 | + 'Length must be greater than 0' |
|
| 57 | + ); |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * @var string |
|
| 62 | - */ |
|
| 63 | - $buf = ''; |
|
| 60 | + /** |
|
| 61 | + * @var string |
|
| 62 | + */ |
|
| 63 | + $buf = ''; |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * \Sodium\randombytes_buf() doesn't allow more than 2147483647 bytes to be |
|
| 67 | - * generated in one invocation. |
|
| 68 | - */ |
|
| 69 | - if ($bytes > 2147483647) { |
|
| 70 | - for ($i = 0; $i < $bytes; $i += 1073741824) { |
|
| 71 | - $n = ($bytes - $i) > 1073741824 |
|
| 72 | - ? 1073741824 |
|
| 73 | - : $bytes - $i; |
|
| 74 | - $buf .= Sodium::randombytes_buf((int) $n); |
|
| 75 | - } |
|
| 76 | - } else { |
|
| 77 | - $buf .= Sodium::randombytes_buf((int) $bytes); |
|
| 78 | - } |
|
| 65 | + /** |
|
| 66 | + * \Sodium\randombytes_buf() doesn't allow more than 2147483647 bytes to be |
|
| 67 | + * generated in one invocation. |
|
| 68 | + */ |
|
| 69 | + if ($bytes > 2147483647) { |
|
| 70 | + for ($i = 0; $i < $bytes; $i += 1073741824) { |
|
| 71 | + $n = ($bytes - $i) > 1073741824 |
|
| 72 | + ? 1073741824 |
|
| 73 | + : $bytes - $i; |
|
| 74 | + $buf .= Sodium::randombytes_buf((int) $n); |
|
| 75 | + } |
|
| 76 | + } else { |
|
| 77 | + $buf .= Sodium::randombytes_buf((int) $bytes); |
|
| 78 | + } |
|
| 79 | 79 | |
| 80 | - if (is_string($buf)) { |
|
| 81 | - if (RandomCompat_strlen($buf) === $bytes) { |
|
| 82 | - return $buf; |
|
| 83 | - } |
|
| 84 | - } |
|
| 80 | + if (is_string($buf)) { |
|
| 81 | + if (RandomCompat_strlen($buf) === $bytes) { |
|
| 82 | + return $buf; |
|
| 83 | + } |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | - /** |
|
| 87 | - * If we reach here, PHP has failed us. |
|
| 88 | - */ |
|
| 89 | - throw new Exception( |
|
| 90 | - 'Could not gather sufficient random data' |
|
| 91 | - ); |
|
| 92 | - } |
|
| 86 | + /** |
|
| 87 | + * If we reach here, PHP has failed us. |
|
| 88 | + */ |
|
| 89 | + throw new Exception( |
|
| 90 | + 'Could not gather sufficient random data' |
|
| 91 | + ); |
|
| 92 | + } |
|
| 93 | 93 | } |
@@ -26,7 +26,7 @@ discard block |
||
| 26 | 26 | * SOFTWARE. |
| 27 | 27 | */ |
| 28 | 28 | |
| 29 | -if (!is_callable('random_bytes')) { |
|
| 29 | +if ( ! is_callable( 'random_bytes' ) ) { |
|
| 30 | 30 | /** |
| 31 | 31 | * If the libsodium PHP extension is loaded, we'll use it above any other |
| 32 | 32 | * solution. |
@@ -40,18 +40,18 @@ discard block |
||
| 40 | 40 | * |
| 41 | 41 | * @return string |
| 42 | 42 | */ |
| 43 | - function random_bytes($bytes) |
|
| 43 | + function random_bytes( $bytes ) |
|
| 44 | 44 | { |
| 45 | 45 | try { |
| 46 | 46 | /** @var int $bytes */ |
| 47 | - $bytes = RandomCompat_intval($bytes); |
|
| 48 | - } catch (TypeError $ex) { |
|
| 47 | + $bytes = RandomCompat_intval( $bytes ); |
|
| 48 | + } catch ( TypeError $ex ) { |
|
| 49 | 49 | throw new TypeError( |
| 50 | 50 | 'random_bytes(): $bytes must be an integer' |
| 51 | 51 | ); |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - if ($bytes < 1) { |
|
| 54 | + if ( $bytes < 1 ) { |
|
| 55 | 55 | throw new Error( |
| 56 | 56 | 'Length must be greater than 0' |
| 57 | 57 | ); |
@@ -66,19 +66,19 @@ discard block |
||
| 66 | 66 | * \Sodium\randombytes_buf() doesn't allow more than 2147483647 bytes to be |
| 67 | 67 | * generated in one invocation. |
| 68 | 68 | */ |
| 69 | - if ($bytes > 2147483647) { |
|
| 70 | - for ($i = 0; $i < $bytes; $i += 1073741824) { |
|
| 71 | - $n = ($bytes - $i) > 1073741824 |
|
| 69 | + if ( $bytes > 2147483647 ) { |
|
| 70 | + for ( $i = 0; $i < $bytes; $i += 1073741824 ) { |
|
| 71 | + $n = ( $bytes - $i ) > 1073741824 |
|
| 72 | 72 | ? 1073741824 |
| 73 | 73 | : $bytes - $i; |
| 74 | - $buf .= Sodium::randombytes_buf((int) $n); |
|
| 74 | + $buf .= Sodium::randombytes_buf( (int)$n ); |
|
| 75 | 75 | } |
| 76 | 76 | } else { |
| 77 | - $buf .= Sodium::randombytes_buf((int) $bytes); |
|
| 77 | + $buf .= Sodium::randombytes_buf( (int)$bytes ); |
|
| 78 | 78 | } |
| 79 | 79 | |
| 80 | - if (is_string($buf)) { |
|
| 81 | - if (RandomCompat_strlen($buf) === $bytes) { |
|
| 80 | + if ( is_string( $buf ) ) { |
|
| 81 | + if ( RandomCompat_strlen( $buf ) === $bytes ) { |
|
| 82 | 82 | return $buf; |
| 83 | 83 | } |
| 84 | 84 | } |
@@ -40,8 +40,7 @@ |
||
| 40 | 40 | * |
| 41 | 41 | * @return string |
| 42 | 42 | */ |
| 43 | - function random_bytes($bytes) |
|
| 44 | - { |
|
| 43 | + function random_bytes($bytes) { |
|
| 45 | 44 | try { |
| 46 | 45 | /** @var int $bytes */ |
| 47 | 46 | $bytes = RandomCompat_intval($bytes); |
@@ -28,50 +28,50 @@ |
||
| 28 | 28 | |
| 29 | 29 | if (!is_callable('RandomCompat_intval')) { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Cast to an integer if we can, safely. |
|
| 33 | - * |
|
| 34 | - * If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX) |
|
| 35 | - * (non-inclusive), it will sanely cast it to an int. If you it's equal to |
|
| 36 | - * ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats |
|
| 37 | - * lose precision, so the <= and => operators might accidentally let a float |
|
| 38 | - * through. |
|
| 39 | - * |
|
| 40 | - * @param int|float $number The number we want to convert to an int |
|
| 41 | - * @param bool $fail_open Set to true to not throw an exception |
|
| 42 | - * |
|
| 43 | - * @return float|int |
|
| 44 | - * @psalm-suppress InvalidReturnType |
|
| 45 | - * |
|
| 46 | - * @throws TypeError |
|
| 47 | - */ |
|
| 48 | - function RandomCompat_intval($number, $fail_open = false) |
|
| 49 | - { |
|
| 50 | - if (is_int($number) || is_float($number)) { |
|
| 51 | - $number += 0; |
|
| 52 | - } elseif (is_numeric($number)) { |
|
| 53 | - /** @psalm-suppress InvalidOperand */ |
|
| 54 | - $number += 0; |
|
| 55 | - } |
|
| 56 | - /** @var int|float $number */ |
|
| 31 | + /** |
|
| 32 | + * Cast to an integer if we can, safely. |
|
| 33 | + * |
|
| 34 | + * If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX) |
|
| 35 | + * (non-inclusive), it will sanely cast it to an int. If you it's equal to |
|
| 36 | + * ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats |
|
| 37 | + * lose precision, so the <= and => operators might accidentally let a float |
|
| 38 | + * through. |
|
| 39 | + * |
|
| 40 | + * @param int|float $number The number we want to convert to an int |
|
| 41 | + * @param bool $fail_open Set to true to not throw an exception |
|
| 42 | + * |
|
| 43 | + * @return float|int |
|
| 44 | + * @psalm-suppress InvalidReturnType |
|
| 45 | + * |
|
| 46 | + * @throws TypeError |
|
| 47 | + */ |
|
| 48 | + function RandomCompat_intval($number, $fail_open = false) |
|
| 49 | + { |
|
| 50 | + if (is_int($number) || is_float($number)) { |
|
| 51 | + $number += 0; |
|
| 52 | + } elseif (is_numeric($number)) { |
|
| 53 | + /** @psalm-suppress InvalidOperand */ |
|
| 54 | + $number += 0; |
|
| 55 | + } |
|
| 56 | + /** @var int|float $number */ |
|
| 57 | 57 | |
| 58 | - if ( |
|
| 59 | - is_float($number) |
|
| 60 | - && |
|
| 61 | - $number > ~PHP_INT_MAX |
|
| 62 | - && |
|
| 63 | - $number < PHP_INT_MAX |
|
| 64 | - ) { |
|
| 65 | - $number = (int) $number; |
|
| 66 | - } |
|
| 58 | + if ( |
|
| 59 | + is_float($number) |
|
| 60 | + && |
|
| 61 | + $number > ~PHP_INT_MAX |
|
| 62 | + && |
|
| 63 | + $number < PHP_INT_MAX |
|
| 64 | + ) { |
|
| 65 | + $number = (int) $number; |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - if (is_int($number)) { |
|
| 69 | - return (int) $number; |
|
| 70 | - } elseif (!$fail_open) { |
|
| 71 | - throw new TypeError( |
|
| 72 | - 'Expected an integer.' |
|
| 73 | - ); |
|
| 74 | - } |
|
| 75 | - return $number; |
|
| 76 | - } |
|
| 68 | + if (is_int($number)) { |
|
| 69 | + return (int) $number; |
|
| 70 | + } elseif (!$fail_open) { |
|
| 71 | + throw new TypeError( |
|
| 72 | + 'Expected an integer.' |
|
| 73 | + ); |
|
| 74 | + } |
|
| 75 | + return $number; |
|
| 76 | + } |
|
| 77 | 77 | } |
@@ -26,7 +26,7 @@ discard block |
||
| 26 | 26 | * SOFTWARE. |
| 27 | 27 | */ |
| 28 | 28 | |
| 29 | -if (!is_callable('RandomCompat_intval')) { |
|
| 29 | +if ( ! is_callable( 'RandomCompat_intval' ) ) { |
|
| 30 | 30 | |
| 31 | 31 | /** |
| 32 | 32 | * Cast to an integer if we can, safely. |
@@ -45,29 +45,29 @@ discard block |
||
| 45 | 45 | * |
| 46 | 46 | * @throws TypeError |
| 47 | 47 | */ |
| 48 | - function RandomCompat_intval($number, $fail_open = false) |
|
| 48 | + function RandomCompat_intval( $number, $fail_open = false ) |
|
| 49 | 49 | { |
| 50 | - if (is_int($number) || is_float($number)) { |
|
| 50 | + if ( is_int( $number ) || is_float( $number ) ) { |
|
| 51 | 51 | $number += 0; |
| 52 | - } elseif (is_numeric($number)) { |
|
| 52 | + } elseif ( is_numeric( $number ) ) { |
|
| 53 | 53 | /** @psalm-suppress InvalidOperand */ |
| 54 | 54 | $number += 0; |
| 55 | 55 | } |
| 56 | 56 | /** @var int|float $number */ |
| 57 | 57 | |
| 58 | 58 | if ( |
| 59 | - is_float($number) |
|
| 59 | + is_float( $number ) |
|
| 60 | 60 | && |
| 61 | 61 | $number > ~PHP_INT_MAX |
| 62 | 62 | && |
| 63 | 63 | $number < PHP_INT_MAX |
| 64 | 64 | ) { |
| 65 | - $number = (int) $number; |
|
| 65 | + $number = (int)$number; |
|
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - if (is_int($number)) { |
|
| 69 | - return (int) $number; |
|
| 70 | - } elseif (!$fail_open) { |
|
| 68 | + if ( is_int( $number ) ) { |
|
| 69 | + return (int)$number; |
|
| 70 | + } elseif ( ! $fail_open ) { |
|
| 71 | 71 | throw new TypeError( |
| 72 | 72 | 'Expected an integer.' |
| 73 | 73 | ); |
@@ -45,8 +45,7 @@ |
||
| 45 | 45 | * |
| 46 | 46 | * @throws TypeError |
| 47 | 47 | */ |
| 48 | - function RandomCompat_intval($number, $fail_open = false) |
|
| 49 | - { |
|
| 48 | + function RandomCompat_intval($number, $fail_open = false) { |
|
| 50 | 49 | if (is_int($number) || is_float($number)) { |
| 51 | 50 | $number += 0; |
| 52 | 51 | } elseif (is_numeric($number)) { |
@@ -27,53 +27,53 @@ |
||
| 27 | 27 | */ |
| 28 | 28 | |
| 29 | 29 | if (!is_callable('random_bytes')) { |
| 30 | - /** |
|
| 31 | - * Powered by ext/mcrypt (and thankfully NOT libmcrypt) |
|
| 32 | - * |
|
| 33 | - * @ref https://bugs.php.net/bug.php?id=55169 |
|
| 34 | - * @ref https://github.com/php/php-src/blob/c568ffe5171d942161fc8dda066bce844bdef676/ext/mcrypt/mcrypt.c#L1321-L1386 |
|
| 35 | - * |
|
| 36 | - * @param int $bytes |
|
| 37 | - * |
|
| 38 | - * @throws Exception |
|
| 39 | - * |
|
| 40 | - * @return string |
|
| 41 | - */ |
|
| 42 | - function random_bytes($bytes) |
|
| 43 | - { |
|
| 44 | - try { |
|
| 45 | - /** @var int $bytes */ |
|
| 46 | - $bytes = RandomCompat_intval($bytes); |
|
| 47 | - } catch (TypeError $ex) { |
|
| 48 | - throw new TypeError( |
|
| 49 | - 'random_bytes(): $bytes must be an integer' |
|
| 50 | - ); |
|
| 51 | - } |
|
| 30 | + /** |
|
| 31 | + * Powered by ext/mcrypt (and thankfully NOT libmcrypt) |
|
| 32 | + * |
|
| 33 | + * @ref https://bugs.php.net/bug.php?id=55169 |
|
| 34 | + * @ref https://github.com/php/php-src/blob/c568ffe5171d942161fc8dda066bce844bdef676/ext/mcrypt/mcrypt.c#L1321-L1386 |
|
| 35 | + * |
|
| 36 | + * @param int $bytes |
|
| 37 | + * |
|
| 38 | + * @throws Exception |
|
| 39 | + * |
|
| 40 | + * @return string |
|
| 41 | + */ |
|
| 42 | + function random_bytes($bytes) |
|
| 43 | + { |
|
| 44 | + try { |
|
| 45 | + /** @var int $bytes */ |
|
| 46 | + $bytes = RandomCompat_intval($bytes); |
|
| 47 | + } catch (TypeError $ex) { |
|
| 48 | + throw new TypeError( |
|
| 49 | + 'random_bytes(): $bytes must be an integer' |
|
| 50 | + ); |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - if ($bytes < 1) { |
|
| 54 | - throw new Error( |
|
| 55 | - 'Length must be greater than 0' |
|
| 56 | - ); |
|
| 57 | - } |
|
| 53 | + if ($bytes < 1) { |
|
| 54 | + throw new Error( |
|
| 55 | + 'Length must be greater than 0' |
|
| 56 | + ); |
|
| 57 | + } |
|
| 58 | 58 | |
| 59 | - /** @var string|bool $buf */ |
|
| 60 | - $buf = @mcrypt_create_iv((int) $bytes, (int) MCRYPT_DEV_URANDOM); |
|
| 61 | - if ( |
|
| 62 | - is_string($buf) |
|
| 63 | - && |
|
| 64 | - RandomCompat_strlen($buf) === $bytes |
|
| 65 | - ) { |
|
| 66 | - /** |
|
| 67 | - * Return our random entropy buffer here: |
|
| 68 | - */ |
|
| 69 | - return $buf; |
|
| 70 | - } |
|
| 59 | + /** @var string|bool $buf */ |
|
| 60 | + $buf = @mcrypt_create_iv((int) $bytes, (int) MCRYPT_DEV_URANDOM); |
|
| 61 | + if ( |
|
| 62 | + is_string($buf) |
|
| 63 | + && |
|
| 64 | + RandomCompat_strlen($buf) === $bytes |
|
| 65 | + ) { |
|
| 66 | + /** |
|
| 67 | + * Return our random entropy buffer here: |
|
| 68 | + */ |
|
| 69 | + return $buf; |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * If we reach here, PHP has failed us. |
|
| 74 | - */ |
|
| 75 | - throw new Exception( |
|
| 76 | - 'Could not gather sufficient random data' |
|
| 77 | - ); |
|
| 78 | - } |
|
| 72 | + /** |
|
| 73 | + * If we reach here, PHP has failed us. |
|
| 74 | + */ |
|
| 75 | + throw new Exception( |
|
| 76 | + 'Could not gather sufficient random data' |
|
| 77 | + ); |
|
| 78 | + } |
|
| 79 | 79 | } |
@@ -26,7 +26,7 @@ discard block |
||
| 26 | 26 | * SOFTWARE. |
| 27 | 27 | */ |
| 28 | 28 | |
| 29 | -if (!is_callable('random_bytes')) { |
|
| 29 | +if ( ! is_callable( 'random_bytes' ) ) { |
|
| 30 | 30 | /** |
| 31 | 31 | * Powered by ext/mcrypt (and thankfully NOT libmcrypt) |
| 32 | 32 | * |
@@ -39,29 +39,29 @@ discard block |
||
| 39 | 39 | * |
| 40 | 40 | * @return string |
| 41 | 41 | */ |
| 42 | - function random_bytes($bytes) |
|
| 42 | + function random_bytes( $bytes ) |
|
| 43 | 43 | { |
| 44 | 44 | try { |
| 45 | 45 | /** @var int $bytes */ |
| 46 | - $bytes = RandomCompat_intval($bytes); |
|
| 47 | - } catch (TypeError $ex) { |
|
| 46 | + $bytes = RandomCompat_intval( $bytes ); |
|
| 47 | + } catch ( TypeError $ex ) { |
|
| 48 | 48 | throw new TypeError( |
| 49 | 49 | 'random_bytes(): $bytes must be an integer' |
| 50 | 50 | ); |
| 51 | 51 | } |
| 52 | 52 | |
| 53 | - if ($bytes < 1) { |
|
| 53 | + if ( $bytes < 1 ) { |
|
| 54 | 54 | throw new Error( |
| 55 | 55 | 'Length must be greater than 0' |
| 56 | 56 | ); |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | 59 | /** @var string|bool $buf */ |
| 60 | - $buf = @mcrypt_create_iv((int) $bytes, (int) MCRYPT_DEV_URANDOM); |
|
| 60 | + $buf = @mcrypt_create_iv( (int)$bytes, (int)MCRYPT_DEV_URANDOM ); |
|
| 61 | 61 | if ( |
| 62 | - is_string($buf) |
|
| 62 | + is_string( $buf ) |
|
| 63 | 63 | && |
| 64 | - RandomCompat_strlen($buf) === $bytes |
|
| 64 | + RandomCompat_strlen( $buf ) === $bytes |
|
| 65 | 65 | ) { |
| 66 | 66 | /** |
| 67 | 67 | * Return our random entropy buffer here: |
@@ -40,8 +40,7 @@ |
||
| 40 | 40 | * |
| 41 | 41 | * @return string |
| 42 | 42 | */ |
| 43 | - function random_bytes($bytes) |
|
| 44 | - { |
|
| 43 | + function random_bytes($bytes) { |
|
| 45 | 44 | try { |
| 46 | 45 | /** @var int $bytes */ |
| 47 | 46 | $bytes = RandomCompat_intval($bytes); |