3 * Random_* Compatibility Library
4 * for using the new PHP 7 random_* API in PHP 5 projects
6 * The MIT License (MIT)
8 * Copyright (c) 2015 Paragon Initiative Enterprises
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 * Since openssl_random_pseudo_bytes() uses openssl's
31 * RAND_pseudo_bytes() API, which has been marked as deprecated by the
32 * OpenSSL team, this is our last resort before failure.
34 * @ref https://www.openssl.org/docs/crypto/RAND_bytes.html
42 function random_bytes($bytes)
45 $bytes = RandomCompat_intval($bytes);
46 } catch (TypeError $ex) {
48 'random_bytes(): $bytes must be an integer'
54 'Length must be greater than 0'
59 * $secure is passed by reference. If it's set to false, fail. Note
60 * that this will only return false if this function fails to return
63 * @ref https://github.com/paragonie/random_compat/issues/6#issuecomment-119564973
66 $buf = openssl_random_pseudo_bytes($bytes, $secure);
72 RandomCompat_strlen($buf) === $bytes
78 * If we reach here, PHP has failed us.
81 'Could not gather sufficient random data'