PK 'HMpTL L SECURITY.mdnu W+A # An Invitation to Security Researchers
Every company says they take security "very seriously." Rather than bore anyone
with banal boilerplate, here are some quick answers followed by detailed
elaboration. If you have any questions about our policies, please email them to
`scott@paragonie.com`.
## Quick Answers
* There is no compulsion to disclose vulnerabilities privately, but we
appreciate a head's up.
* `security@paragonie.com` will get your reports to the right person. Our GPG
fingerprint, should you decide to encrypt your report, is
`7F52 D5C6 1D12 55C7 3136 2E82 6B97 A1C2 8264 04DA`.
* **YES**, we will reward security researchers who disclose vulnerabilities in
our software.
* In most cases, **No Proof-of-Concept Required.**
* We have a [bug bounty program on HackerOne](https://hackerone.com/paragonie).
## How to Report a Security Bug to Paragon Initiative Enterprises
### There is no compulsion to disclose privately.
We believe vulnerability disclosure style is a personal choice and enjoy working
with a diverse community. We understand and appreciate the importance of Full
Disclosure in the history and practice of security research.
We would *like* to know about high-severity bugs before they become public
knowledge, so we can fix them in a timely manner, but **we do not believe in
threatening researchers or trying to enforce vulnerability embargoes**.
Ultimately, if you discover a security-affecting vulnerability, what you do with
it is your choice. We would like to work with people, and to celebrate and
reward their skill, experience, and dedication. We appreciate being informed of
our mistakes so we can learn from them and build a better product. Our goal is
to empower the community.
### Where to Send Security Vulnerabilities
Our security email address is `security@paragonie.com`. Also feel free to open a
new issue on Github if you want to disclose publicly.
```
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG
mQENBFUgwRUBCADcIpqNwyYc5UmY/tpx1sF/rQ3knR1YNXYZThzFV+Gmqhp1fDH5
qBs9foh1xwI6O7knWmQngnf/nBumI3x6xj7PuOdEZUh2FwCG/VWnglW8rKmoHzHA
ivjiu9SLnPIPAgHSHeh2XD7q3Ndm3nenbjAiRFNl2iXcwA2cTQp9Mmfw9vVcw0G0
z1o0G3s8cC8ZS6flFySIervvfSRWj7A1acI5eE3+AH/qXJRdEJ+9J8OB65p1JMfk
6+fWgOB1XZxMpz70S0rW6IX38WDSRhEK2fXyZJAJjyt+YGuzjZySNSoQR/V6vNYn
syrNPCJ2i5CgZQxAkyBBcr7koV9RIhPRzct/ABEBAAG0IVNlY3VyaXR5IDxzZWN1
cml0eUBwYXJhZ29uaWUuY29tPokBOQQTAQIAIwUCVSDBFQIbAwcLCQgHAwIBBhUI
AgkKCwQWAgMBAh4BAheAAAoJEGuXocKCZATat2YIAIoejNFEQ2c1iaOEtSuB7Pn/
WLbsDsHNLDKOV+UnfaCjv/vL7D+5NMChFCi2frde/NQb2TsjqmIH+V+XbnJtlrXD
Vj7yvMVal+Jqjwj7v4eOEWcKVcFZk+9cfUgh7t92T2BMX58RpgZF0IQZ6Z1R3FfC
9Ub4X6ykW+te1q0/4CoRycniwmlQi6iGSr99LQ5pfJq2Qlmz/luTZ0UX0h575T7d
cp2T1sX/zFRk/fHeANWSksipdDBjAXR7NMnYZgw2HghEdFk/xRDY7K1NRWNZBf05
WrMHmh6AIVJiWZvI175URxEe268hh+wThBhXQHMhFNJM1qPIuzb4WogxM3UUD7m5
AQ0EVSDBFQEIALNkpzSuJsHAHh79sc0AYWztdUe2MzyofQbbOnOCpWZebYsC3EXU
335fIg59k0m6f+O7GmEZzzIv5v0i99GS1R8CJm6FvhGqtH8ZqmOGbc71WdJSiNVE
0kpQoJlVzRbig6ZyyjzrggbM1eh5OXOk5pw4+23FFEdw7JWU0HJS2o71r1hwp05Z
vy21kcUEobz/WWQQyGS0Neo7PJn+9KS6wOxXul/UE0jct/5f7KLMdWMJ1VgniQmm
hjvkHLPSICteqCI04RfcmMseW9gueHQXeUu1SNIvsWa2MhxjeBej3pDnrZWszKwy
gF45GO9/v4tkIXNMy5J1AtOyRgQ3IUMqp8EAEQEAAYkBHwQYAQIACQUCVSDBFQIb
DAAKCRBrl6HCgmQE2jnIB/4/xFz8InpM7eybnBOAir3uGcYfs3DOmaKn7qWVtGzv
rKpQPYnVtlU2i6Z5UO4c4jDLT/8Xm1UDz3Lxvqt4xCaDwJvBZexU5BMK8l5DvOzH
6o6P2L1UDu6BvmPXpVZz7/qUhOnyf8VQg/dAtYF4/ax19giNUpI5j5o5mX5w80Rx
qSXV9NdSL4fdjeG1g/xXv2luhoV53T1bsycI3wjk/x5tV+M2KVhZBvvuOm/zhJje
oLWp0saaESkGXIXqurj6gZoujJvSvzl0n9F9VwqMEizDUfrXgtD1siQGhP0sVC6q
ha+F/SAEJ0jEquM4TfKWWU2S5V5vgPPpIQSYRnhQW4b1
=xJPW
-----END PGP PUBLIC KEY BLOCK-----
```
### We Will Reward Security Researchers
**This process has not been formalized; nor have dollar amounts been
discussed.**
However, if you report a valid security-affecting bug, we will compensate you
for the time spent finding the vulnerability and reward you for being a good
neighbor.
#### What does a "valid" bug mean?
There are two sides to this:
1. Some have spammed projects with invalid bug reports hoping to collect
bounties for pressing a button and running an automated analysis tool. This
is not cool.
2. There is a potential for the developers of a project to declare all security
bug reports as invalid to save money.
Our team members have an established history of reporting vulnerabilities to
large open source projects. **We aren't in the business of ripping people off.**
When in doubt, our policy is to err on the side of generosity.
### No Proof-of-Concept Required
We might ask for one if we feel we do not understand some of the details
pertaining to a specific vulnerability. We certainly appreciate them if you
include them in your report, but we believe **the burden lies with the developer
to prove their software *is* secure** rather than with the researcher to prove
that it isn't.
In our experience, most bugs are simpler to fix than they are to exploit.
PK 'HM"0R
lib/cast_to_int.phpnu W+A operators might accidentally let a float
* through.
*
* @param int|float $number The number we want to convert to an int
* @param bool $fail_open Set to true to not throw an exception
*
* @return float|int
* @psalm-suppress InvalidReturnType
*
* @throws TypeError
*/
function RandomCompat_intval($number, $fail_open = false)
{
if (is_int($number) || is_float($number)) {
$number += 0;
} elseif (is_numeric($number)) {
/** @psalm-suppress InvalidOperand */
$number += 0;
}
/** @var int|float $number */
if (
is_float($number)
&&
$number > ~PHP_INT_MAX
&&
$number < PHP_INT_MAX
) {
$number = (int) $number;
}
if (is_int($number)) {
return (int) $number;
} elseif (!$fail_open) {
throw new TypeError(
'Expected an integer.'
);
}
return $number;
}
}
PK 'HM lib/random_bytes_com_dotnet.phpnu W+A GetRandom($bytes, 0));
if (RandomCompat_strlen($buf) >= $bytes) {
/**
* Return our random entropy buffer here:
*/
return (string) RandomCompat_substr($buf, 0, $bytes);
}
++$execCount;
} while ($execCount < $bytes);
/**
* If we reach here, PHP has failed us.
*/
throw new Exception(
'Could not gather sufficient random data'
);
}
}
PK 'HM!Kw6 6 lib/random_bytes_dev_urandom.phpnu W+A $st */
$st = fstat($fp);
if (($st['mode'] & 0170000) !== 020000) {
fclose($fp);
$fp = false;
}
}
}
if (is_resource($fp)) {
/**
* stream_set_read_buffer() does not exist in HHVM
*
* If we don't set the stream's read buffer to 0, PHP will
* internally buffer 8192 bytes, which can waste entropy
*
* stream_set_read_buffer returns 0 on success
*/
if (is_callable('stream_set_read_buffer')) {
stream_set_read_buffer($fp, RANDOM_COMPAT_READ_BUFFER);
}
if (is_callable('stream_set_chunk_size')) {
stream_set_chunk_size($fp, RANDOM_COMPAT_READ_BUFFER);
}
}
}
try {
/** @var int $bytes */
$bytes = RandomCompat_intval($bytes);
} catch (TypeError $ex) {
throw new TypeError(
'random_bytes(): $bytes must be an integer'
);
}
if ($bytes < 1) {
throw new Error(
'Length must be greater than 0'
);
}
/**
* This if() block only runs if we managed to open a file handle
*
* It does not belong in an else {} block, because the above
* if (empty($fp)) line is logic that should only be run once per
* page load.
*/
if (is_resource($fp)) {
/**
* @var int
*/
$remaining = $bytes;
/**
* @var string|bool
*/
$buf = '';
/**
* We use fread() in a loop to protect against partial reads
*/
do {
/**
* @var string|bool
*/
$read = fread($fp, $remaining);
if (!is_string($read)) {
/**
* We cannot safely read from the file. Exit the
* do-while loop and trigger the exception condition
*
* @var string|bool
*/
$buf = false;
break;
}
/**
* Decrease the number of bytes returned from remaining
*/
$remaining -= RandomCompat_strlen($read);
/**
* @var string $buf
*/
$buf .= $read;
} while ($remaining > 0);
/**
* Is our result valid?
* @var string|bool $buf
*/
if (is_string($buf)) {
if (RandomCompat_strlen($buf) === $bytes) {
/**
* Return our random entropy buffer here:
*/
return $buf;
}
}
}
/**
* If we reach here, PHP has failed us.
*/
throw new Exception(
'Error reading from source device'
);
}
}
PK 'HM; lib/byte_safe_strings.phpnu W+A RandomCompat_strlen($binary_string)) {
return '';
}
return (string) mb_substr(
(string) $binary_string,
(int) $start,
(int) $length,
'8bit'
);
}
} else {
/**
* substr() implementation that isn't brittle to mbstring.func_overload
*
* This version just uses the default substr()
*
* @param string $binary_string
* @param int $start
* @param int|null $length (optional)
*
* @throws TypeError
*
* @return string
*/
function RandomCompat_substr($binary_string, $start, $length = null)
{
if (!is_string($binary_string)) {
throw new TypeError(
'RandomCompat_substr(): First argument should be a string'
);
}
if (!is_int($start)) {
throw new TypeError(
'RandomCompat_substr(): Second argument should be an integer'
);
}
if ($length !== null) {
if (!is_int($length)) {
throw new TypeError(
'RandomCompat_substr(): Third argument should be an integer, or omitted'
);
}
return (string) substr(
(string )$binary_string,
(int) $start,
(int) $length
);
}
return (string) substr(
(string) $binary_string,
(int) $start
);
}
}
}
PK 'HM`$= = lib/random_int.phpnu W+A operators might accidentally let a float
* through.
*/
try {
/** @var int $min */
$min = RandomCompat_intval($min);
} catch (TypeError $ex) {
throw new TypeError(
'random_int(): $min must be an integer'
);
}
try {
/** @var int $max */
$max = RandomCompat_intval($max);
} catch (TypeError $ex) {
throw new TypeError(
'random_int(): $max must be an integer'
);
}
/**
* Now that we've verified our weak typing system has given us an integer,
* let's validate the logic then we can move forward with generating random
* integers along a given range.
*/
if ($min > $max) {
throw new Error(
'Minimum value must be less than or equal to the maximum value'
);
}
if ($max === $min) {
return (int) $min;
}
/**
* Initialize variables to 0
*
* We want to store:
* $bytes => the number of random bytes we need
* $mask => an integer bitmask (for use with the &) operator
* so we can minimize the number of discards
*/
$attempts = $bits = $bytes = $mask = $valueShift = 0;
/** @var int $attempts */
/** @var int $bits */
/** @var int $bytes */
/** @var int $mask */
/** @var int $valueShift */
/**
* At this point, $range is a positive number greater than 0. It might
* overflow, however, if $max - $min > PHP_INT_MAX. PHP will cast it to
* a float and we will lose some precision.
*
* @var int|float $range
*/
$range = $max - $min;
/**
* Test for integer overflow:
*/
if (!is_int($range)) {
/**
* Still safely calculate wider ranges.
* Provided by @CodesInChaos, @oittaa
*
* @ref https://gist.github.com/CodesInChaos/03f9ea0b58e8b2b8d435
*
* We use ~0 as a mask in this case because it generates all 1s
*
* @ref https://eval.in/400356 (32-bit)
* @ref http://3v4l.org/XX9r5 (64-bit)
*/
$bytes = PHP_INT_SIZE;
/** @var int $mask */
$mask = ~0;
} else {
/**
* $bits is effectively ceil(log($range, 2)) without dealing with
* type juggling
*/
while ($range > 0) {
if ($bits % 8 === 0) {
++$bytes;
}
++$bits;
$range >>= 1;
/** @var int $mask */
$mask = $mask << 1 | 1;
}
$valueShift = $min;
}
/** @var int $val */
$val = 0;
/**
* Now that we have our parameters set up, let's begin generating
* random integers until one falls between $min and $max
*/
/** @psalm-suppress RedundantCondition */
do {
/**
* The rejection probability is at most 0.5, so this corresponds
* to a failure probability of 2^-128 for a working RNG
*/
if ($attempts > 128) {
throw new Exception(
'random_int: RNG is broken - too many rejections'
);
}
/**
* Let's grab the necessary number of random bytes
*/
$randomByteString = random_bytes($bytes);
/**
* Let's turn $randomByteString into an integer
*
* This uses bitwise operators (<< and |) to build an integer
* out of the values extracted from ord()
*
* Example: [9F] | [6D] | [32] | [0C] =>
* 159 + 27904 + 3276800 + 201326592 =>
* 204631455
*/
$val &= 0;
for ($i = 0; $i < $bytes; ++$i) {
$val |= ord($randomByteString[$i]) << ($i * 8);
}
/** @var int $val */
/**
* Apply mask
*/
$val &= $mask;
$val += $valueShift;
++$attempts;
/**
* If $val overflows to a floating point number,
* ... or is larger than $max,
* ... or smaller than $min,
* then try again.
*/
} while (!is_int($val) || $val > $max || $val < $min);
return (int) $val;
}
}
PK 'HM?-
-
lib/random_bytes_mcrypt.phpnu W+A = 70000) {
return;
}
if (!defined('RANDOM_COMPAT_READ_BUFFER')) {
define('RANDOM_COMPAT_READ_BUFFER', 8);
}
$RandomCompatDIR = dirname(__FILE__);
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'byte_safe_strings.php';
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'cast_to_int.php';
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'error_polyfill.php';
if (!is_callable('random_bytes')) {
/**
* PHP 5.2.0 - 5.6.x way to implement random_bytes()
*
* We use conditional statements here to define the function in accordance
* to the operating environment. It's a micro-optimization.
*
* In order of preference:
* 1. Use libsodium if available.
* 2. fread() /dev/urandom if available (never on Windows)
* 3. mcrypt_create_iv($bytes, MCRYPT_DEV_URANDOM)
* 4. COM('CAPICOM.Utilities.1')->GetRandom()
*
* See RATIONALE.md for our reasoning behind this particular order
*/
if (extension_loaded('libsodium')) {
// See random_bytes_libsodium.php
if (PHP_VERSION_ID >= 50300 && is_callable('\\Sodium\\randombytes_buf')) {
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'random_bytes_libsodium.php';
} elseif (method_exists('Sodium', 'randombytes_buf')) {
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'random_bytes_libsodium_legacy.php';
}
}
/**
* Reading directly from /dev/urandom:
*/
if (DIRECTORY_SEPARATOR === '/') {
// DIRECTORY_SEPARATOR === '/' on Unix-like OSes -- this is a fast
// way to exclude Windows.
$RandomCompatUrandom = true;
$RandomCompat_basedir = ini_get('open_basedir');
if (!empty($RandomCompat_basedir)) {
$RandomCompat_open_basedir = explode(
PATH_SEPARATOR,
strtolower($RandomCompat_basedir)
);
$RandomCompatUrandom = (array() !== array_intersect(
array('/dev', '/dev/', '/dev/urandom'),
$RandomCompat_open_basedir
));
$RandomCompat_open_basedir = null;
}
if (
!is_callable('random_bytes')
&&
$RandomCompatUrandom
&&
@is_readable('/dev/urandom')
) {
// Error suppression on is_readable() in case of an open_basedir
// or safe_mode failure. All we care about is whether or not we
// can read it at this point. If the PHP environment is going to
// panic over trying to see if the file can be read in the first
// place, that is not helpful to us here.
// See random_bytes_dev_urandom.php
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'random_bytes_dev_urandom.php';
}
// Unset variables after use
$RandomCompat_basedir = null;
} else {
$RandomCompatUrandom = false;
}
/**
* mcrypt_create_iv()
*
* We only want to use mcypt_create_iv() if:
*
* - random_bytes() hasn't already been defined
* - the mcrypt extensions is loaded
* - One of these two conditions is true:
* - We're on Windows (DIRECTORY_SEPARATOR !== '/')
* - We're not on Windows and /dev/urandom is readabale
* (i.e. we're not in a chroot jail)
* - Special case:
* - If we're not on Windows, but the PHP version is between
* 5.6.10 and 5.6.12, we don't want to use mcrypt. It will
* hang indefinitely. This is bad.
* - If we're on Windows, we want to use PHP >= 5.3.7 or else
* we get insufficient entropy errors.
*/
if (
!is_callable('random_bytes')
&&
// Windows on PHP < 5.3.7 is broken, but non-Windows is not known to be.
(DIRECTORY_SEPARATOR === '/' || PHP_VERSION_ID >= 50307)
&&
// Prevent this code from hanging indefinitely on non-Windows;
// see https://bugs.php.net/bug.php?id=69833
(
DIRECTORY_SEPARATOR !== '/' ||
(PHP_VERSION_ID <= 50609 || PHP_VERSION_ID >= 50613)
)
&&
extension_loaded('mcrypt')
) {
// See random_bytes_mcrypt.php
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'random_bytes_mcrypt.php';
}
$RandomCompatUrandom = null;
/**
* This is a Windows-specific fallback, for when the mcrypt extension
* isn't loaded.
*/
if (
!is_callable('random_bytes')
&&
extension_loaded('com_dotnet')
&&
class_exists('COM')
) {
$RandomCompat_disabled_classes = preg_split(
'#\s*,\s*#',
strtolower(ini_get('disable_classes'))
);
if (!in_array('com', $RandomCompat_disabled_classes)) {
try {
$RandomCompatCOMtest = new COM('CAPICOM.Utilities.1');
if (method_exists($RandomCompatCOMtest, 'GetRandom')) {
// See random_bytes_com_dotnet.php
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'random_bytes_com_dotnet.php';
}
} catch (com_exception $e) {
// Don't try to use it.
}
}
$RandomCompat_disabled_classes = null;
$RandomCompatCOMtest = null;
}
/**
* throw new Exception
*/
if (!is_callable('random_bytes')) {
/**
* We don't have any more options, so let's throw an exception right now
* and hope the developer won't let it fail silently.
*
* @param mixed $length
* @psalm-suppress InvalidReturnType
* @throws Exception
* @return string
*/
function random_bytes($length)
{
unset($length); // Suppress "variable not used" warnings.
throw new Exception(
'There is no suitable CSPRNG installed on your system'
);
return '';
}
}
}
if (!is_callable('random_int')) {
require_once $RandomCompatDIR . DIRECTORY_SEPARATOR . 'random_int.php';
}
$RandomCompatDIR = null;
PK 'HMbZ l l % lib/random_bytes_libsodium_legacy.phpnu W+A 2147483647) {
for ($i = 0; $i < $bytes; $i += 1073741824) {
$n = ($bytes - $i) > 1073741824
? 1073741824
: $bytes - $i;
$buf .= Sodium::randombytes_buf((int) $n);
}
} else {
$buf .= Sodium::randombytes_buf((int) $bytes);
}
if (is_string($buf)) {
if (RandomCompat_strlen($buf) === $bytes) {
return $buf;
}
}
/**
* If we reach here, PHP has failed us.
*/
throw new Exception(
'Could not gather sufficient random data'
);
}
}
PK 'HMiᦁ lib/random_bytes_libsodium.phpnu W+A 2147483647) {
$buf = '';
for ($i = 0; $i < $bytes; $i += 1073741824) {
$n = ($bytes - $i) > 1073741824
? 1073741824
: $bytes - $i;
$buf .= \Sodium\randombytes_buf($n);
}
} else {
/** @var string|bool $buf */
$buf = \Sodium\randombytes_buf($bytes);
}
if (is_string($buf)) {
if (RandomCompat_strlen($buf) === $bytes) {
return $buf;
}
}
/**
* If we reach here, PHP has failed us.
*/
throw new Exception(
'Could not gather sufficient random data'
);
}
}
PK 'HMbi~ ~ lib/error_polyfill.phpnu W+A buildFromDirectory(dirname(__DIR__).'/lib');
rename(
dirname(__DIR__).'/lib/index.php',
dirname(__DIR__).'/lib/random.php'
);
/**
* If we pass an (optional) path to a private key as a second argument, we will
* sign the Phar with OpenSSL.
*
* If you leave this out, it will produce an unsigned .phar!
*/
if ($argc > 1) {
if (!@is_readable($argv[1])) {
echo 'Could not read the private key file:', $argv[1], "\n";
exit(255);
}
$pkeyFile = file_get_contents($argv[1]);
$private = openssl_get_privatekey($pkeyFile);
if ($private !== false) {
$pkey = '';
openssl_pkey_export($private, $pkey);
$phar->setSignatureAlgorithm(Phar::OPENSSL, $pkey);
/**
* Save the corresponding public key to the file
*/
if (!@is_readable($dist.'/random_compat.phar.pubkey')) {
$details = openssl_pkey_get_details($private);
file_put_contents(
$dist.'/random_compat.phar.pubkey',
$details['key']
);
}
} else {
echo 'An error occurred reading the private key from OpenSSL.', "\n";
exit(255);
}
}
PK 'HM; 1+ 1+ README.mdnu W+A # random_compat
[![Build Status](https://travis-ci.org/paragonie/random_compat.svg?branch=master)](https://travis-ci.org/paragonie/random_compat)
[![Scrutinizer](https://scrutinizer-ci.com/g/paragonie/random_compat/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/paragonie/random_compat)
[![Latest Stable Version](https://poser.pugx.org/paragonie/random_compat/v/stable)](https://packagist.org/packages/paragonie/random_compat)
[![Latest Unstable Version](https://poser.pugx.org/paragonie/random_compat/v/unstable)](https://packagist.org/packages/paragonie/random_compat)
[![License](https://poser.pugx.org/paragonie/random_compat/license)](https://packagist.org/packages/paragonie/random_compat)
[![Downloads](https://img.shields.io/packagist/dt/paragonie/random_compat.svg)](https://packagist.org/packages/paragonie/random_compat)
PHP 5.x polyfill for `random_bytes()` and `random_int()` created and maintained
by [Paragon Initiative Enterprises](https://paragonie.com).
Although this library *should* function in earlier versions of PHP, we will only
consider issues relevant to [supported PHP versions](https://secure.php.net/supported-versions.php).
**If you are using an unsupported version of PHP, please upgrade as soon as possible.**
## Important
Although this library has been examined by some security experts in the PHP
community, there will always be a chance that we overlooked something. Please
ask your favorite trusted hackers to hammer it for implementation errors and
bugs before even thinking about deploying it in production.
**Do not use the master branch, use a [stable release](https://github.com/paragonie/random_compat/releases/latest).**
For the background of this library, please refer to our blog post on
[Generating Random Integers and Strings in PHP](https://paragonie.com/blog/2015/07/how-safely-generate-random-strings-and-integers-in-php).
### Usability Notice
If PHP cannot safely generate random data, this library will throw an `Exception`.
It will never fall back to insecure random data. If this keeps happening, upgrade
to a newer version of PHP immediately.
## Installing
**With [Composer](https://getcomposer.org):**
# For libraries and frameworks that support PHP 5 but may be used by
# other software that only supports PHP 7:
composer require paragonie/random_compat:\>=2
# For software that explicitly needs PHP 5 support:
composer require paragonie/random_compat:\<9.99
**Signed PHP Archive:**
As of version 1.2.0, we also ship an ECDSA-signed PHP Archive with each stable
release on Github.
1. Download [the `.phar`, `.phar.pubkey`, and `.phar.pubkey.asc`](https://github.com/paragonie/random_compat/releases/latest) files.
2. (**Recommended** but not required) Verify the PGP signature of `.phar.pubkey`
(contained within the `.asc` file) using the [PGP public key for Paragon Initiative Enterprises](https://paragonie.com/static/gpg-public-key.txt).
3. Extract both `.phar` and `.phar.pubkey` files to the same directory.
4. `require_once "/path/to/random_compat.phar";`
5. When a new version is released, you only need to replace the `.phar` file;
the `.pubkey` will not change (unless our signing key is ever compromised).
**Manual Installation:**
1. Download [a stable release](https://github.com/paragonie/random_compat/releases/latest).
2. Extract the files into your project.
3. `require_once "/path/to/random_compat/lib/random.php";`
The entrypoint should be **`lib/random.php`** directly, not any of the other files in `/lib`.
## Usage
This library exposes the [CSPRNG functions added in PHP 7](https://secure.php.net/manual/en/ref.csprng.php)
for use in PHP 5 projects. Their behavior should be identical.
### Generate a string of random bytes
```php
try {
$string = random_bytes(32);
} catch (TypeError $e) {
// Well, it's an integer, so this IS unexpected.
die("An unexpected error has occurred");
} catch (Error $e) {
// This is also unexpected because 32 is a reasonable integer.
die("An unexpected error has occurred");
} catch (Exception $e) {
// If you get this message, the CSPRNG failed hard.
die("Could not generate a random string. Is our OS secure?");
}
var_dump(bin2hex($string));
// string(64) "5787c41ae124b3b9363b7825104f8bc8cf27c4c3036573e5f0d4a91ad2eeac6f"
```
### Generate a random integer between two given integers (inclusive)
```php
try {
$int = random_int(0, 255);
} catch (TypeError $e) {
// Well, it's an integer, so this IS unexpected.
die("An unexpected error has occurred");
} catch (Error $e) {
// This is also unexpected because 0 and 255 are both reasonable integers.
die("An unexpected error has occurred");
} catch (Exception $e) {
// If you get this message, the CSPRNG failed hard.
die("Could not generate a random int. Is our OS secure?");
}
var_dump($int);
// int(47)
```
### Exception handling
When handling exceptions and errors you must account for differences between
PHP 5 and PHP7.
The differences:
* Catching `Error` works, so long as it is caught before `Exception`.
* Catching `Exception` has different behavior, without previously catching `Error`.
* There is *no* portable way to catch all errors/exceptions.
#### Our recommendation
**Always** catch `Error` before `Exception`.
#### Example
```php
try {
return random_int(1, $userInput);
} catch (TypeError $e) {
// This is okay, so long as `Error` is caught before `Exception`.
throw new Exception('Please enter a number!');
} catch (Error $e) {
// This is required, if you do not need to do anything just rethrow.
throw $e;
} catch (Exception $e) {
// This is optional and maybe omitted if you do not want to handle errors
// during generation.
throw new InternalServerErrorException(
'Oops, our server is bust and cannot generate any random data.',
500,
$e
);
}
```
### Troubleshooting
#### Exception: "Could not gather sufficient random data"
If an Exception is thrown, then your operating system is not secure.
1. If you're on Windows, make sure you enable mcrypt.
2. If you're on any other OS, make sure `/dev/urandom` is readable.
* FreeBSD jails need to expose `/dev/urandom` from the host OS
* If you use `open_basedir`, make sure `/dev/urandom` is allowed
This library does not (and will not accept any patches to) fall back to
an insecure random number generator.
#### Version Conflict with [Other PHP Project]
If you're using a project that has a line like this in its composer.json
"require" {
...
"paragonie/random_compat": "~1.1",
...
}
...and then you try to add random_compat 2 (or another library that explicitly
requires random_compat 2, such as [this secure PHP encryption library](https://github.com/defuse/php-encryption)),
you will get a version conflict.
The solution is to get the project to update its requirement string to allow
version 2 and above to be used instead of hard-locking users to version 1.
```diff
"require" {
...
- "paragonie/random_compat": "~1.1",
+ "paragonie/random_compat": ">=1",
...
}
```
#### Version 9.99.99
**Note**: There is a special version called `9.99.99` which makes this
library do nothing, but is only installable on PHP 7.
If you're writing software (e.g. a library) that supports PHP 5, but may
be used by software that doesn't, you'll want to allow `9.99.99` to be
installed. The above diff is what you want.
Conversely, if you're writing software that (in and of itself) supports
PHP 5, you do not want 9.99.99 to be installed, so you'll want to make
this change instead:
```diff
"require" {
...
- "paragonie/random_compat": "~1.1",
+ "paragonie/random_compat": ">=1 <9.99",
...
}
```
To avoid installing "empty" version `9.99.99` you can add `replace` section
in your root `composer.json`:
"replace": {
"paragonie/random_compat": "9.99.99"
},
#### Manifest Read Length Error
If you're using the PHP Archive (Phar) approach rather than Composer, and
you are getting an error message to the effect of "manifest read length
was `{int1}` should be `{int2}`", the Phar extension may not be enabled.
See [this comment](https://github.com/paragonie/random_compat/issues/134#issuecomment-365696289)
for specific guidance on how to fix this issue.
## Contributors
This project would not be anywhere near as excellent as it is today if it
weren't for the contributions of the following individuals:
* [@AndrewCarterUK (Andrew Carter)](https://github.com/AndrewCarterUK)
* [@asgrim (James Titcumb)](https://github.com/asgrim)
* [@bcremer (Benjamin Cremer)](https://github.com/bcremer)
* [@chriscct7 (Chris Christoff)](https://github.com/chriscct7)
* [@CodesInChaos (Christian Winnerlein)](https://github.com/CodesInChaos)
* [@ConnorVG (Connor S. Parks)](https://github.com/ConnorVG)
* [@cs278 (Chris Smith)](https://github.com/cs278)
* [@cweagans (Cameron Eagans)](https://github.com/cweagans)
* [@dd32 (Dion Hulse)](https://github.com/dd32)
* [@geggleto (Glenn Eggleton)](https://github.com/geggleto)
* [@glensc (Elan Ruusamäe)](https://github.com/glensc)
* [@GrahamCampbell (Graham Campbell)](https://github.com/GrahamCampbell)
* [@ircmaxell (Anthony Ferrara)](https://github.com/ircmaxell)
* [@jdevalk (Joost de Valk)](https://github.com/jdevalk)
* [@jedisct1 (Frank Denis)](https://github.com/jedisct1)
* [@juliangut (Julián Gutiérrez)](https://github.com/juliangut)
* [@kelunik (Niklas Keller)](https://github.com/kelunik)
* [@lt (Leigh)](https://github.com/lt)
* [@MasonM (Mason Malone)](https://github.com/MasonM)
* [@menkaff (Mehran NikNafs)](https://github.com/menkaff)
* [@mmeyer2k (Michael M)](https://github.com/mmeyer2k)
* [@narfbg (Andrey Andreev)](https://github.com/narfbg)
* [@nicolas-grekas (Nicolas Grekas)](https://github.com/nicolas-grekas)
* [@ocean90 (Dominik Schilling)](https://github.com/ocean90)
* [@oittaa](https://github.com/oittaa)
* [@oucil (Kevin Farley)](https://github.com/oucil)
* [@philios33 (Phil Nicholls)](https://github.com/philios33)
* [@redragonx (Stephen Chavez)](https://github.com/redragonx)
* [@relaxnow (Boy Baukema)](https://github.com/relaxnow)
* [@rchouinard (Ryan Chouinard)](https://github.com/rchouinard)
* [@rugk](https://github.com/rugk)
* [@SammyK (Sammy Kaye Powers)](https://github.com/SammyK)
* [@scottchiefbaker (Scott Baker)](https://github.com/scottchiefbaker)
* [@skyosev (Stoyan Kyosev)](https://github.com/skyosev)
* [@sthen (Stuart Henderseon)](https://github.com/sthen)
* [@stof (Christophe Coevoet)](https://github.com/stof)
* [@teohhanhui (Teoh Han Hui)](https://github.com/teohhanhui)
* [@tom-- (Tom Worster)](https://github.com/tom--)
* [@tsyr2ko](https://github.com/tsyr2ko)
* [@trowski (Aaron Piotrowski)](https://github.com/trowski)
* [@twistor (Chris Lepannen)](https://github.com/twistor)
* [@vinkla (Vincent Klaiber)](https://github.com/vinkla)
* [@voku (Lars Moelleken)](https://github.com/voku)
* [@xabbuh (Christian Flothmann)](https://github.com/xabbuh)
PK 'HM|< psalm.xmlnu W+A
PK 'HM psalm-autoload.phpnu W+A
tests/unit
./tests/unit
./lib
PK 'HM9sR
phpunit.shnu W+A #!/usr/bin/env bash
if [ "$1" == 'full' ]; then
fulltest=1
elif [ "$1" == 'each' ]; then
testeach=1
else
fulltest=0
fi
PHP_VERSION=$(php -r "echo PHP_VERSION_ID;")
echo
echo -e "\033[33mBegin Unit Testing\033[0m"
# Run the testing suite
echo "Basic test suite:"
php vendor/bin/phpunit tests/unit
if [ $? -ne 0 ]; then
# Test failure
exit 1
fi
echo "With open_basedir enabled:"
php -d open_basedir=`pwd` vendor/bin/phpunit tests/unit_with_basedir
if [ $? -ne 0 ]; then
# Test failure
exit 1
fi
echo "With open_basedir enabled, allowing /dev:"
php -d open_basedir=`pwd`:/dev vendor/bin/phpunit tests/unit_with_basedir
if [ $? -ne 0 ]; then
# Test failure
exit 1
fi
echo "With mbstring.func_overload enabled:"
php -d mbstring.func_overload=7 vendor/bin/phpunit tests/unit
if [ $? -ne 0 ]; then
# Test failure
exit 1
fi
if [[ "$testeach" == "1" ]]; then
echo " CAPICOM:"
php vendor/bin/phpunit --bootstrap tests/specific/capicom.php tests/unit
echo " /dev/urandom:"
php vendor/bin/phpunit --bootstrap tests/specific/dev_urandom.php tests/unit
echo " libsodium:"
php vendor/bin/phpunit --bootstrap tests/specific/libsodium.php tests/unit
echo " mcrypt:"
php vendor/bin/phpunit --bootstrap tests/specific/mcrypt.php tests/unit
fi
# Should we perform full statistical analyses?
if [[ "$fulltest" == "1" ]]; then
php vendor/bin/phpunit tests/full
if [ $? -ne 0 ]; then
# Test failure
exit 1
fi
fi
PK 'HM:8p5 p5 CHANGELOG.mdnu W+A ### Version 2.0.17 - 2018-07-04
* Version 2.0.16 failed Psalm checks on PHP v5.6 with Psalm v1.
We could not reproduce this failure locally, so we've suppressed the
`MissingReturnType` check (that is to say, demoted it to "info").
### Version 2.0.16 - 2018-07-04
* Fixed type-checking consistencies that forced us to use Psalm in
non-strict mode (i.e. `totallyTyped="false"`).
* README cleanup, added a header to the Version 9.99.99 section.
* If you're confused by `v9.99.99` and it's causing stuff to break, see
[this section of the README](https://github.com/paragonie/random_compat#version-99999)
for the solution to your problem.
* Trimmed down and annotated our `psalm.xml` file with explanations
for why each assertion is suppressed.
### Version 2.0.15 - 2018-06-08
* A reported, but difficult to reproduce, problem with file inclusion on
[some Windows machines](https://github.com/paragonie/random_compat/issues/136)
was fixed by [replacing `/` with `DIRECTORY_SEPARATOR`](https://github.com/paragonie/random_compat/pull/141).
For most users (i.e. not running Windows) this change should be of zero
consequence. For everyone else, it should mean random_compat magically
works when it didn't before.
### Version 2.0.14 - 2018-06-06
* Update version information.
* Updated README with better instructions, including new information
about the `v9.99.99` tag.
### Version 2.0.13 - 2018-06-06
* #139 - Add `polyfill` keyword to composer.json
* Ensure the docblocks are consistent to aid static analysis efforts in
other libraries; see https://github.com/paragonie/random_compat/commit/cbe0b11b78140bc62a921fec33a730fdaa6540d6
### Version 2.0.12 - 2018-04-04
* Minor docblock issue that's breaking Psalm downstream.
### Version 2.0.11 - 2017-09-27
* Minor docblock corrections.
* Re-issuing a PHP Archive to attempt to address an issue with the Phar provided.
See [#134](https://github.com/paragonie/random_compat/issues/134).
### Version 2.0.10 - 2017-03-13
* Mcrypt can now be used on PHP < 5.3.7 if you're not on Windows.
* Minor boyscouting changes.
### Version 2.0.9 - 2017-03-03
* More Psalm integration fixes.
### Version 2.0.8 - 2017-03-03
* Prevent function already declared error for `random_int()` caused by misusing
the library (really you should only ever include `lib/random.php` and never any
of the other files). See [#125](https://github.com/paragonie/random_compat/issues/125).
### Version 2.0.6, 2.0.7 - 2017-02-27
* Just updates to psalm.xml to silence false positives.
### Version 2.0.5 - 2017-02-27
* Run random_compat through the static analysis tool, [psalm](https://github.com/vimeo/psalm),
as part of our continuous integration process.
* Minor readability enhancements ([#122](https://github.com/paragonie/random_compat/issues/122)
and several docblock changes).
### Version 2.0.4 - 2016-11-07
* Don't unnecessarily prevent `mcrypt_create_iv()` from being used.
See [#111](https://github.com/paragonie/random_compat/issues/111).
### Version 2.0.3 - 2016-10-17
* Updated `lib/error_polyfill.php` [to resolve corner cases](https://github.com/paragonie/random_compat/issues/104).
* The README was updated to help users troubleshoot and fix insecure environments.
* Tags will now be signed by [the GnuPG key used by the security team at Paragon Initiative Enterprises, LLC](https://paragonie.com/static/gpg-public-key.txt).
### Version 2.0.2 - 2016-04-03
Added a consistency check (discovered by Taylor Hornby in his
[PHP encryption library](https://github.com/defuse/php-encryption)). It
wasn't likely causing any trouble for us.
### Version 2.0.1 - 2016-03-18
Update comment in random.php
### Version 2.0.0 - 2016-03-18
Due to downstream errors, the OpenSSL removal now belongs in version
2.0.0.
### Version 1.3.1 - 2016-03-18
* Add more possible values to `open_basedir` check.
### Version 1.3.0 - 2016-03-17
* Removed `openssl_random_pseudo_bytes()` entirely. If you are using
random_compat in PHP on a Unix-like OS but cannot access
`/dev/urandom`, version 1.3+ will throw an `Exception`. If you want to
trust OpenSSL, feel free to write your own fallback code. e.g.
```php
try {
$bytes = random_bytes(32);
} catch (Exception $ex) {
$strong = false;
$bytes = openssl_random_pseudo_bytes(32, $strong);
if (!$strong) {
throw $ex;
}
}
```
### Version 1.2.2 - 2016-03-11
* To prevent applications from hanging, if `/dev/urandom` is not
accessible to PHP, skip mcrypt (which just fails before giving OpenSSL
a chance and was morally equivalent to not offering OpenSSL at all).
### Version 1.2.1 - 2016-02-29
* PHP 5.6.10 - 5.6.12 will hang when mcrypt is used on Unix-based operating
systems ([PHP bug 69833](https://bugs.php.net/bug.php?id=69833)). If you are
running one of these versions, please upgrade (or make sure `/dev/urandom` is
readable) otherwise you're relying on OpenSSL.
### Version 1.2.0 - 2016-02-05
* Whitespace and other cosmetic changes
* Added a changelog.
* We now ship with a command line utility to build a PHP Archive from the
command line.
Every time we publish a new release, we will also upload a .phar
to Github. Our public key is signed by our GPG key.
### Version 1.1.6 - 2016-01-29
* Eliminate `open_basedir` warnings by detecting this configuration setting.
(Thanks [@oucil](https://github.com/oucil) for reporting this.)
* Added install instructions to the README.
* Documentation cleanup (there is, in fact, no `MCRYPT_CREATE_IV` constant, I
meant to write `MCRYPT_DEV_URANDOM`)
### Version 1.1.5 - 2016-01-06
Prevent fatal errors on platforms with older versions of libsodium.
### Version 1.1.4 - 2015-12-10
Thanks [@narfbg](https://github.com/narfbg) for [critiquing the previous patch](https://github.com/paragonie/random_compat/issues/79#issuecomment-163590589)
and suggesting a fix.
### Version 1.1.3 - 2015-12-09
The test for COM in disabled_classes is now case-insensitive.
### Version 1.1.2 - 2015-12-09
Don't instantiate COM if it's a disabled class. Removes the E_WARNING on Windows.
### Version 1.1.1 - 2015-11-30
Fix a performance issue with `/dev/urandom` buffering.
### Version 1.1.0 - 2015-11-09
Fix performance issues with ancient versions of PHP on Windows, but dropped
support for PHP < 5.4.1 without mcrypt on Windows 7+ in the process. Since this
is a BC break, semver dictates a minor version bump.
### Version 1.0.10 - 2015-10-23
* Avoid a performance killer with OpenSSL on Windows PHP 5.3.0 - 5.3.3 that was
affecting [WordPress users](https://core.trac.wordpress.org/ticket/34409).
* Use `$var = null` instead of `unset($var)` to avoid triggering the garbage
collector and slowing things down.
### Version 1.0.9 - 2015-10-20
There is an outstanding issue `mcrypt_create_iv()` and PHP 7's `random_bytes()`
on Windows reported by [@nicolas-grekas](https://github.com/nicolas-grekas) caused by `proc_open()` and environment
variable handling (discovered by Appveyor when developing Symfony).
Since the break is consistent, it's not our responsibility to fix it, but we
should fail the same way PHP 7 will (i.e. throw an `Exception` rather than raise
an error and then throw an `Exception`).
### Version 1.0.8 - 2015-10-18
* Fix usability issues with Windows (`new COM('CAPICOM.Utilities.1')` is not
always available).
* You can now test all the possible drivers by running `phpunit.sh each` in the
`tests` directory.
### Version 1.0.7 - 2015-10-16
Several large integer handling bugfixes were contributed by [@oittaa](https://github.com/oittaa).
### Version 1.0.6 - 2015-10-15
Don't let the version number fool you, this was a pretty significant change.
1. Added support for ext-libsodium, if it exists on the system. This is morally
equivalent to adding `getrandom(2)` support without having to expose the
syscall interface in PHP-land.
2. Relaxed open_basedir restrictions. In previous versions, if open_basedir was
set, PHP wouldn't even try to read from `/dev/urandom`. Now it will still do
so if you can.
3. Fixed integer casting inconsistencies between random_compat and PHP 7.
4. Handle edge cases where an integer overflow turns one of the parameters into
a float.
One change that we discussed was making `random_bytes()` and `random_int()`
strict typed; meaning you could *only* pass integers to either function. While
most veteran programmers are probably only doing this already (we strongly
encourage it), it wouldn't be consistent with how these functions behave in PHP
7. Please use these functions responsibly.
We've had even more of the PHP community involved in this release; the
contributors list has been updated. If I forgot anybody, I promise you it's not
because your contributions (either code or ideas) aren't valued, it's because
I'm a bit overloaded with information at the moment. Please let me know
immediately and I will correct my oversight.
Thanks everyone for helping make random_compat better.
### Version 1.0.5 - 2015-10-08
Got rid of the methods in the `Throwable` interface, which was causing problems
on PHP 5.2. While we would normally not care about 5.2 (since [5.4 and earlier are EOL'd](https://secure.php.net/supported-versions.php)),
we do want to encourage widespread adoption (e.g. [Wordpress](https://core.trac.wordpress.org/ticket/28633)).
### Version 1.0.4 - 2015-10-02
Removed redundant `if()` checks, since `lib/random.php` is the entrypoint people
should use.
### Version 1.0.3 - 2015-10-02
This release contains bug fixes contributed by the community.
* Avoid a PHP Notice when PHP is running without the mbstring extension
* Use a compatible version of PHPUnit for testing on older versions of PHP
Although none of these bugs were outright security-affecting, updating ASAP is
still strongly encouraged.
### Version 1.0.2 - 2015-09-23
Less strict input validation on `random_int()` parameters. PHP 7's `random_int()`
accepts strings and floats that look like numbers, so we should too.
Thanks [@dd32](https://github.com/@dd32) for correcting this oversight.
### Version 1.0.1 - 2015-09-10
Instead of throwing an Exception immediately on insecure platforms, only do so
when `random_bytes()` is invoked.
### Version 1.0.0 - 2015-09-07
Our API is now stable and forward-compatible with the CSPRNG features in PHP 7
(as of 7.0.0 RC3).
A lot of great people have contributed their time and expertise to make this
compatibility library possible. That this library has reached a stable release
is more a reflection on the community than it is on PIE.
We are confident that random_compat will serve as the simplest and most secure
CSPRNG interface available for PHP5 projects.
### Version 0.9.7 (pre-release) - 2015-09-01
An attempt to achieve compatibility with Error/TypeError in the RFC.
This should be identical to 1.0.0 sans any last-minute changes or performance enhancements.
### Version 0.9.6 (pre-release) - 2015-08-06
* Split the implementations into their own file (for ease of auditing)
* Corrected the file type check after `/dev/urandom` has been opened (thanks
[@narfbg](https://github.com/narfbg) and [@jedisct1](https://github.com/jedisct1))
### Version 0.9.5 (pre-release) - 2015-07-31
* Validate that `/dev/urandom` is a character device
* Reported by [@lokdnet](https://twitter.com/lokdnet)
* Investigated by [@narfbg](https://github.com/narfbg) and [frymaster](http://stackoverflow.com/users/1226810/frymaster) on [StackOverflow](http://stackoverflow.com/q/31631066/2224584)
* Remove support for `/dev/arandom` which is an old OpenBSD feature, thanks [@jedisct1](https://github.com/jedisct1)
* Prevent race conditions on the `filetype()` check, thanks [@jedisct1](https://github.com/jedisct1)
* Buffer file reads to 8 bytes (performance optimization; PHP defaults to 8192 bytes)
### Version 0.9.4 (pre-release) - 2015-07-27
* Add logic to verify that `/dev/arandom` and `/dev/urandom` are actually devices.
* Some clean-up in the comments
### Version 0.9.3 (pre-release) - 2015-07-22
Unless the Exceptions change to PHP 7 fails, this should be the last pre-release
version. If need be, we'll make one more pre-release version with compatible
behavior.
Changes since 0.9.2:
* Prioritize `/dev/arandom` and `/dev/urandom` over mcrypt.
[@oittaa](https://github.com/oittaa) removed the -1 and +1 juggling on `$range` calculations for `random_int()`
* Whitespace and comment clean-up, plus better variable names
* Actually put a description in the composer.json file...
### Version 0.9.2 (pre-release) - 2015-07-16
* Consolidated `$range > PHP_INT_MAX` logic with `$range <= PHP_INT_MAX` (thanks
[@oittaa](https://github.com/oittaa) and [@CodesInChaos](https://github.com/CodesInChaos))
* `tests/phpunit.sh` now also runs the tests with `mbstring.func_overload` and
`open_basedir`
* Style consistency, whitespace cleanup, more meaningful variable names
### Version 0.9.1 (pre-release) - 2015-07-09
* Return random values on integer ranges > `PHP_INT_MAX` (thanks [@CodesInChaos](https://github.com/CodesInChaos))
* Determined CSPRNG preference:
1. `mcrypt_create_iv()` with `MCRYPT_DEV_URANDOM`
2. `/dev/arandom`
3. `/dev/urandom`
4. `openssl_random_pseudo_bytes()`
* Optimized backend selection (thanks [@lt](https://github.com/lt))
* Fix #3 (thanks [@scottchiefbaker](https://github.com/scottchiefbaker))
### Version 0.9.0 (pre-release) - 2015-07-07
This should be a sane polyfill for PHP 7's `random_bytes()` and `random_int()`.
We hesitate to call it production ready until it has received sufficient third
party review.
PK 'HMw6i i tests/full/DieHardTest.phpnu W+A $i,
'value' => $buckets[$i],
'min' => $min,
'nums' => $nums_to_generate,
'reason' => 'below min'
]);
}
if ($buckets[$i] >= $max ) {
var_dump([
'bucket' => $i,
'value' => $buckets[$i],
'maax' => $max,
'nums' => $nums_to_generate,
'reason' => 'above max'
]);
}
$this->assertTrue($buckets[$i] < $max && $buckets[$i] > $min);
}
}
}
}PK 'HMd tests/full/StatTest.phpnu W+A 30% but less than 170%
*
* This also catches 0 and 1000
*/
public function testDistribution()
{
$integers = array_fill(0, 100, 0);
for ($i = 0; $i < 10000; ++$i) {
++$integers[random_int(0,99)];
}
for ($i = 0; $i < 100; ++$i) {
$this->assertFalse($integers[$i] < 30);
$this->assertFalse($integers[$i] > 170);
}
}
/**
* This should be between 55% and 75%, always
*/
public function testCoverage()
{
$integers = array_fill(0, 2000, 0);
for ($i = 0; $i < 2000; ++$i) {
++$integers[random_int(0,1999)];
}
$coverage = 0;
for ($i = 0; $i < 2000; ++$i) {
if ($integers[$i] > 0) {
++$coverage;
}
}
$this->assertTrue($coverage >= 1150);
$this->assertTrue($coverage <= 1350);
}
public function testCompressionRatios()
{
$some_bytes = random_bytes(65536);
$compressed = gzcompress($some_bytes, 9);
if (function_exists('mb_strlen')) {
$length = mb_strlen($compressed, '8bit');
} else {
$length = strlen($compressed);
}
$this->assertTrue($length >= 65000 && $length <= 67000);
}
}PK 'HM&X- ) tests/unit_with_basedir/RandomIntTest.phpnu W+A assertTrue(function_exists('random_int'));
}
public function testOutput()
{
try {
$half_neg_max = (~PHP_INT_MAX / 2);
$integers = array(
random_int(0, 1000),
random_int(1001,2000),
random_int(-100, -10),
random_int(-1000, 1000),
random_int(~PHP_INT_MAX, PHP_INT_MAX),
random_int("0", "1"),
random_int(0.11111, 0.99999),
random_int($half_neg_max, PHP_INT_MAX),
random_int(0.0, 255.0),
random_int(-4.5, -4.5),
random_int("1337e3","1337e3")
);
$this->assertFalse($integers[0] === $integers[1]);
$this->assertTrue($integers[0] >= 0 && $integers[0] <= 1000);
$this->assertTrue($integers[1] >= 1001 && $integers[1] <= 2000);
$this->assertTrue($integers[2] >= -100 && $integers[2] <= -10);
$this->assertTrue($integers[3] >= -1000 && $integers[3] <= 1000);
$this->assertTrue($integers[4] >= ~PHP_INT_MAX && $integers[4] <= PHP_INT_MAX);
$this->assertTrue($integers[5] >= 0 && $integers[5] <= 1);
$this->assertTrue($integers[6] === 0);
$this->assertTrue($integers[7] >= $half_neg_max && $integers[7] <= PHP_INT_MAX);
$this->assertTrue($integers[8] >= 0 && $integers[8] <= 255);
$this->assertTrue($integers[9] === -4);
$this->assertTrue($integers[10] === 1337000);
} catch (Exception $ex) {
$this->assertEquals(
$ex->getMessage(),
self::NO_BASEDIR
);
return;
}
try {
$h = random_int("2147483648", "2147483647");
$i = random_int("9223372036854775808", "9223372036854775807");
$this->assertFalse(is_int($i));
$h = random_int("-2147483648", "2147483647");
$i = random_int("-9223372036854775808", "9223372036854775807");
$this->fail("One of these options should have thrown an exception.");
} catch (Error $ex) {
$this->assertTrue($ex instanceof Error);
} catch (Exception $ex) {
$this->assertTrue($ex instanceof Exception);
}
}
public function testRandomRange()
{
try {
$try = 64;
$maxLen = strlen(~PHP_INT_MAX);
do {
$rand = random_int(~PHP_INT_MAX, PHP_INT_MAX);
} while (strlen($rand) !== $maxLen && $try--);
$this->assertGreaterThan(0, $try);
} catch (Exception $ex) {
$this->assertEquals(
$ex->getMessage(),
self::NO_BASEDIR
);
return;
}
}
}
PK 'HMuS; ; + tests/unit_with_basedir/RandomBytesTest.phpnu W+A assertTrue(function_exists('random_bytes'));
}
public function testInvalidParams()
{
try {
$bytes = random_bytes('good morning');
$this->fail("random_bytes() should accept only an integer");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
if ($ex->getMessage() === self::NO_BASEDIR) {
return;
}
}
try {
$bytes = random_bytes(array(12));
$this->fail("random_bytes() should accept only an integer");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
}
// This should succeed:
try {
$bytes = random_bytes('123456');
} catch (Exception $ex) {
$this->assertEquals(
$ex->getMessage(),
self::NO_BASEDIR
);
}
}
public function testOutput()
{
try {
$bytes = array(
random_bytes(12),
random_bytes(64),
random_bytes(64),
random_bytes(1.5)
);
} catch (Exception $ex) {
$this->assertEquals(
$ex->getMessage(),
self::NO_BASEDIR
);
return;
}
$this->assertTrue(
strlen(bin2hex($bytes[0])) === 24
);
$this->assertTrue(
strlen(bin2hex($bytes[3])) === 2
);
// This should never generate identical byte strings
$this->assertFalse(
$bytes[1] === $bytes[2]
);
try {
$x = random_bytes(~PHP_INT_MAX - 1000000000);
$this->fail("Integer overflow (~PHP_INT_MAX - 1000000000).");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
}
try {
$x = random_bytes(PHP_INT_MAX + 1000000000);
$this->fail("Requesting too many bytes should fail.");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
}
}
}
PK 'HMXP ' tests/unit_with_basedir/UtilityTest.phpnu W+A markTestSkipped(
'We don\' need to test this in PHP 7.'
);
}
$this->assertEquals(RandomCompat_strlen("\xF0\x9D\x92\xB3"), 4);
}
public function testIntval()
{
if (!function_exists('RandomCompat_intval')) {
return $this->markTestSkipped(
'We don\' need to test this in PHP 7.'
);
}
// Equals
$this->assertEquals(
abs(RandomCompat_intval(-4.5)),
abs(RandomCompat_intval(4.5))
);
// True
$this->assertTrue(
is_int(RandomCompat_intval(PHP_INT_MAX, true))
);
$this->assertTrue(
is_int(RandomCompat_intval(~PHP_INT_MAX, true))
);
$this->assertTrue(
is_int(RandomCompat_intval(~PHP_INT_MAX + 1, true))
);
$this->assertTrue(
is_int(RandomCompat_intval("1337e3", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("1.", true))
);
// False
$this->assertFalse(
is_int(RandomCompat_intval((float) PHP_INT_MAX, true))
);
$this->assertFalse(
is_int(RandomCompat_intval((float) ~PHP_INT_MAX, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(PHP_INT_MAX + 1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(~PHP_INT_MAX - 1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(~PHP_INT_MAX - 0.1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(PHP_INT_MAX + 0.1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval("hello", true))
);
if (PHP_INT_SIZE === 8) {
$this->assertFalse(
is_int(RandomCompat_intval("-9223372036854775809", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("-9223372036854775808", true))
);
$this->assertFalse(
is_int(RandomCompat_intval("9223372036854775808", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("9223372036854775807", true))
);
} else {
$this->assertFalse(
is_int(RandomCompat_intval("2147483648", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("2147483647", true))
);
$this->assertFalse(
is_int(RandomCompat_intval("-2147483649", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("-2147483648", true))
);
}
}
}
PK 'HMQ tests/specific/mcrypt.phpnu W+A assertTrue(function_exists('random_int'));
}
public function testOutput()
{
$half_neg_max = (~PHP_INT_MAX / 2);
$integers = array(
random_int(0, 1000),
random_int(1001,2000),
random_int(-100, -10),
random_int(-1000, 1000),
random_int(~PHP_INT_MAX, PHP_INT_MAX),
random_int("0", "1"),
random_int(0.11111, 0.99999),
random_int($half_neg_max, PHP_INT_MAX),
random_int(0.0, 255.0),
random_int(-4.5, -4.5),
random_int("1337e3","1337e3")
);
$this->assertFalse($integers[0] === $integers[1]);
$this->assertTrue($integers[0] >= 0 && $integers[0] <= 1000);
$this->assertTrue($integers[1] >= 1001 && $integers[1] <= 2000);
$this->assertTrue($integers[2] >= -100 && $integers[2] <= -10);
$this->assertTrue($integers[3] >= -1000 && $integers[3] <= 1000);
$this->assertTrue($integers[4] >= ~PHP_INT_MAX && $integers[4] <= PHP_INT_MAX);
$this->assertTrue($integers[5] >= 0 && $integers[5] <= 1);
$this->assertTrue($integers[6] === 0);
$this->assertTrue($integers[7] >= $half_neg_max && $integers[7] <= PHP_INT_MAX);
$this->assertTrue($integers[8] >= 0 && $integers[8] <= 255);
$this->assertSame($integers[9], -4);
$this->assertSame($integers[10], 1337000);
try {
$h = random_int("2147483648", "2147483647");
$i = random_int("9223372036854775808", "9223372036854775807");
$this->assertFalse(is_int($i));
$h = random_int("-2147483648", "2147483647");
$i = random_int("-9223372036854775808", "9223372036854775807");
$this->fail("One of these options should have thrown an exception.");
} catch (Error $ex) {
$this->assertTrue($ex instanceof Error);
} catch (Exception $ex) {
$this->assertTrue($ex instanceof Exception);
}
}
public function testRandomRange()
{
$try = 64;
$maxLen = strlen(~PHP_INT_MAX);
do {
$rand = random_int(~PHP_INT_MAX, PHP_INT_MAX);
} while (strlen($rand) !== $maxLen && $try--);
$this->assertGreaterThan(0, $try);
}
}
PK 'HMfqC tests/unit/RandomBytesTest.phpnu W+A assertTrue(function_exists('random_bytes'));
}
public function testInvalidParams()
{
try {
$bytes = random_bytes('good morning');
$this->fail("random_bytes() should accept only an integer");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
}
try {
$bytes = random_bytes(array(12));
$this->fail("random_bytes() should accept only an integer");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
}
// This should succeed:
$bytes = random_bytes('123456');
}
public function testOutput()
{
$bytes = array(
random_bytes(12),
random_bytes(64),
random_bytes(64),
random_bytes(1.5)
);
$this->assertTrue(
strlen(bin2hex($bytes[0])) === 24
);
$this->assertTrue(
strlen(bin2hex($bytes[3])) === 2
);
// This should never generate identical byte strings
$this->assertFalse(
$bytes[1] === $bytes[2]
);
try {
$x = random_bytes(~PHP_INT_MAX - 1000000000);
$this->fail("Integer overflow (~PHP_INT_MAX - 1000000000).");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
}
try {
$x = random_bytes(PHP_INT_MAX + 1000000000);
$this->fail("Requesting too many bytes should fail.");
} catch (TypeError $ex) {
$this->assertTrue(true);
} catch (Error $ex) {
$this->assertTrue(true);
} catch (Exception $ex) {
$this->assertTrue(true);
}
}
}
PK 'HMXP tests/unit/UtilityTest.phpnu W+A markTestSkipped(
'We don\' need to test this in PHP 7.'
);
}
$this->assertEquals(RandomCompat_strlen("\xF0\x9D\x92\xB3"), 4);
}
public function testIntval()
{
if (!function_exists('RandomCompat_intval')) {
return $this->markTestSkipped(
'We don\' need to test this in PHP 7.'
);
}
// Equals
$this->assertEquals(
abs(RandomCompat_intval(-4.5)),
abs(RandomCompat_intval(4.5))
);
// True
$this->assertTrue(
is_int(RandomCompat_intval(PHP_INT_MAX, true))
);
$this->assertTrue(
is_int(RandomCompat_intval(~PHP_INT_MAX, true))
);
$this->assertTrue(
is_int(RandomCompat_intval(~PHP_INT_MAX + 1, true))
);
$this->assertTrue(
is_int(RandomCompat_intval("1337e3", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("1.", true))
);
// False
$this->assertFalse(
is_int(RandomCompat_intval((float) PHP_INT_MAX, true))
);
$this->assertFalse(
is_int(RandomCompat_intval((float) ~PHP_INT_MAX, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(PHP_INT_MAX + 1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(~PHP_INT_MAX - 1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(~PHP_INT_MAX - 0.1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval(PHP_INT_MAX + 0.1, true))
);
$this->assertFalse(
is_int(RandomCompat_intval("hello", true))
);
if (PHP_INT_SIZE === 8) {
$this->assertFalse(
is_int(RandomCompat_intval("-9223372036854775809", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("-9223372036854775808", true))
);
$this->assertFalse(
is_int(RandomCompat_intval("9223372036854775808", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("9223372036854775807", true))
);
} else {
$this->assertFalse(
is_int(RandomCompat_intval("2147483648", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("2147483647", true))
);
$this->assertFalse(
is_int(RandomCompat_intval("-2147483649", true))
);
$this->assertTrue(
is_int(RandomCompat_intval("-2147483648", true))
);
}
}
}
PK 'HM E2E E .scrutinizer.ymlnu W+A checks:
php:
code_rating: true
duplication: falsePK 'HMI=Qp p RATIONALE.mdnu W+A ## Rationale (Design Decisions)
### Reasoning Behind the Order of Preferred Random Data Sources
The order is:
1. `libsodium if available`
2. `fread() /dev/urandom if available`
3. `mcrypt_create_iv($bytes, MCRYPT_DEV_URANDOM)`
4. `COM('CAPICOM.Utilities.1')->GetRandom()`
If libsodium is available, we get random data from it. This is the preferred
method on all OSes, but libsodium is not very widely installed, so other
fallbacks are available.
Next, we read `/dev/urandom` (if it exists). This is the preferred file to read
for random data for cryptographic purposes for BSD and Linux. This step
is skipped on Windows, because someone could create a `C:\dev\urandom`
file and PHP would helpfully (but insecurely) return bytes from it.
Despite [strongly urging people not to use mcrypt in their projects](https://paragonie.com/blog/2015/05/if-you-re-typing-word-mcrypt-into-your-code-you-re-doing-it-wrong)
(because libmcrypt is abandonware and the API puts too much responsibility on the
implementor) we prioritize `mcrypt_create_iv()` with `MCRYPT_DEV_URANDOM` above
the remaining implementations.
The reason is simple: `mcrypt_create_iv()` is part of PHP's `ext/mcrypt` code,
and is not part `libmcrypt`. It actually does the right thing:
* On Unix-based operating systems, it reads from `/dev/urandom` which
(unlike `/dev/random`) is the sane and correct thing to do.
* On Windows, it reads from `CryptGenRandom`, which is an exclusively Windows
way to get random bytes.
If we're on Windows and don't have access to `mcrypt`, we use `CAPICOM.Utilities.1`.
As of random_compat 2.0, we no longer fall through to OpenSSL.
PK 'HM> J J LICENSEnu W+A The MIT License (MIT)
Copyright (c) 2015 Paragon Initiative Enterprises
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
PK 'HM;ǻ
composer.jsonnu W+A {
"name": "paragonie/random_compat",
"description": "PHP 5.x polyfill for random_bytes() and random_int() from PHP 7",
"keywords": [
"csprng",
"random",
"polyfill",
"pseudorandom"
],
"license": "MIT",
"type": "library",
"authors": [
{
"name": "Paragon Initiative Enterprises",
"email": "security@paragonie.com",
"homepage": "https://paragonie.com"
}
],
"support": {
"issues": "https://github.com/paragonie/random_compat/issues",
"email": "info@paragonie.com",
"source": "https://github.com/paragonie/random_compat"
},
"require": {
"php": ">=5.2.0"
},
"require-dev": {
"phpunit/phpunit": "4.*|5.*"
},
"suggest": {
"ext-libsodium": "Provides a modern crypto API that can be used to generate random bytes."
},
"autoload": {
"files": [
"lib/random.php"
]
}
}
PK 'HMpTL L SECURITY.mdnu W+A PK 'HM"0R
lib/cast_to_int.phpnu W+A PK 'HM i lib/random_bytes_com_dotnet.phpnu W+A PK 'HM!Kw6 6 }* lib/random_bytes_dev_urandom.phpnu W+A PK 'HM; D lib/byte_safe_strings.phpnu W+A PK 'HM`$= = \ lib/random_int.phpnu W+A PK 'HM?-
-
uw lib/random_bytes_mcrypt.phpnu W+A PK 'HM
lib/random.phpnu W+A PK 'HMbZ l l % 5 lib/random_bytes_libsodium_legacy.phpnu W+A PK 'HMiᦁ lib/random_bytes_libsodium.phpnu W+A PK 'HMbi~ ~ Ÿ lib/error_polyfill.phpnu W+A PK 'HM21 .travis.ymlnu W+A PK 'HM*A| g dist/random_compat.phar.pubkeynu W+A PK 'HM١i " dist/random_compat.phar.pubkey.ascnu W+A PK 'HMI`8ذ other/ide_stubs/README.mdnu W+A PK 'HM~%A A other/ide_stubs/COM.phpnu W+A PK 'HMGWh h ! G other/ide_stubs/com_exception.phpnu W+A PK 'HM] ] other/ide_stubs/libsodium.phpnu W+A PK 'HM.$R R other/build_phar.phpnu W+A PK 'HM; 1+ 1+ @ README.mdnu W+A PK 'HM|< psalm.xmlnu W+A PK 'HM psalm-autoload.phpnu W+A PK 'HMbZB B
.gitignorenu W+A PK 'HMt8Q
7 build-phar.shnu W+A PK 'HM .gitattributesnu W+A PK 'HM
phpunit.xml.distnu W+A PK 'HM9sR
phpunit.shnu W+A PK 'HM:8p5 p5 CHANGELOG.mdnu W+A PK 'HMw6i i M tests/full/DieHardTest.phpnu W+A PK 'HMd dV tests/full/StatTest.phpnu W+A PK 'HM&X- ) 0\ tests/unit_with_basedir/RandomIntTest.phpnu W+A PK 'HMuS; ; + ^h tests/unit_with_basedir/RandomBytesTest.phpnu W+A PK 'HMXP ' s tests/unit_with_basedir/UtilityTest.phpnu W+A PK 'HMQ tests/specific/mcrypt.phpnu W+A PK 'HMj 8 Q tests/specific/capicom.phpnu W+A PK 'HM,}k tests/specific/libsodium.phpnu W+A PK 'HMTtJ $ tests/specific/dev_urandom.phpnu W+A PK 'HMrU% % # tests/specific/libsodium_legacy.phpnu W+A PK 'HM{
~ ~
tests/unit/RandomIntTest.phpnu W+A PK 'HMfqC Ԑ tests/unit/RandomBytesTest.phpnu W+A PK 'HMXP tests/unit/UtilityTest.phpnu W+A PK 'HM E2E E .scrutinizer.ymlnu W+A PK 'HMI=Qp p RATIONALE.mdnu W+A PK 'HM> J J : LICENSEnu W+A PK 'HM;ǻ
composer.jsonnu W+A PK - - F