]> scripts.mit.edu Git - autoinstalls/wordpress.git/blob - wp-includes/random_compat/random_bytes_dev_urandom.php
WordPress 4.4-scripts
[autoinstalls/wordpress.git] / wp-includes / random_compat / random_bytes_dev_urandom.php
1 <?php
2 /**
3  * Random_* Compatibility Library 
4  * for using the new PHP 7 random_* API in PHP 5 projects
5  * 
6  * The MIT License (MIT)
7  * 
8  * Copyright (c) 2015 Paragon Initiative Enterprises
9  * 
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:
16  * 
17  * The above copyright notice and this permission notice shall be included in
18  * all copies or substantial portions of the Software.
19  * 
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
26  * SOFTWARE.
27  */
28
29 if (!defined('RANDOM_COMPAT_READ_BUFFER')) {
30     define('RANDOM_COMPAT_READ_BUFFER', 8);
31 }
32
33 /**
34  * Unless open_basedir is enabled, use /dev/urandom for
35  * random numbers in accordance with best practices
36  * 
37  * Why we use /dev/urandom and not /dev/random
38  * @ref http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers
39  * 
40  * @param int $bytes
41  * 
42  * @throws Exception
43  * 
44  * @return string
45  */
46 function random_bytes($bytes)
47 {
48     static $fp = null;
49     /**
50      * This block should only be run once
51      */
52     if (empty($fp)) {
53         /**
54          * We use /dev/urandom if it is a char device.
55          * We never fall back to /dev/random
56          */
57         $fp = fopen('/dev/urandom', 'rb');
58         if (!empty($fp)) {
59             $st = fstat($fp);
60             if (($st['mode'] & 0170000) !== 020000) {
61                 fclose($fp);
62                 $fp = false;
63             }
64         }
65         /**
66          * stream_set_read_buffer() does not exist in HHVM
67          * 
68          * If we don't set the stream's read buffer to 0, PHP will
69          * internally buffer 8192 bytes, which can waste entropy
70          * 
71          * stream_set_read_buffer returns 0 on success
72          */
73         if (!empty($fp) && function_exists('stream_set_read_buffer')) {
74             stream_set_read_buffer($fp, RANDOM_COMPAT_READ_BUFFER);
75         }
76     }
77     try {
78         $bytes = RandomCompat_intval($bytes);
79     } catch (TypeError $ex) {
80         throw new TypeError(
81             'random_bytes(): $bytes must be an integer'
82         );
83     }
84     if ($bytes < 1) {
85         throw new Error(
86             'Length must be greater than 0'
87         );
88     }
89     /**
90      * This if() block only runs if we managed to open a file handle
91      * 
92      * It does not belong in an else {} block, because the above 
93      * if (empty($fp)) line is logic that should only be run once per
94      * page load.
95      */
96     if (!empty($fp)) {
97         $remaining = $bytes;
98         $buf = '';
99         /**
100          * We use fread() in a loop to protect against partial reads
101          */
102         do {
103             $read = fread($fp, $remaining); 
104             if ($read === false) {
105                 /**
106                  * We cannot safely read from the file. Exit the
107                  * do-while loop and trigger the exception condition
108                  */
109                 $buf = false;
110                 break;
111             }
112             /**
113              * Decrease the number of bytes returned from remaining
114              */
115             $remaining -= RandomCompat_strlen($read);
116             $buf .= $read;
117         } while ($remaining > 0);
118         
119         /**
120          * Is our result valid?
121          */
122         if ($buf !== false) {
123             if (RandomCompat_strlen($buf) === $bytes) {
124                 /**
125                  * Return our random entropy buffer here:
126                  */
127                 return $buf;
128             }
129         }
130     }
131     /**
132      * If we reach here, PHP has failed us.
133      */
134     throw new Exception(
135         'Error reading from source device'
136     );
137 }