random_bytes_dev_urandom.php 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  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 - 2018 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. if (!defined('RANDOM_COMPAT_READ_BUFFER')) {
  29. define('RANDOM_COMPAT_READ_BUFFER', 8);
  30. }
  31. if (!is_callable('random_bytes')) {
  32. /**
  33. * Unless open_basedir is enabled, use /dev/urandom for
  34. * random numbers in accordance with best practices
  35. *
  36. * Why we use /dev/urandom and not /dev/random
  37. * @ref http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers
  38. *
  39. * @param int $bytes
  40. *
  41. * @throws Exception
  42. *
  43. * @return string
  44. */
  45. function random_bytes($bytes)
  46. {
  47. /** @var resource $fp */
  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. /** @var resource|bool $fp */
  58. $fp = fopen('/dev/urandom', 'rb');
  59. if (is_resource($fp)) {
  60. /** @var array<string, int> $st */
  61. $st = fstat($fp);
  62. if (($st['mode'] & 0170000) !== 020000) {
  63. fclose($fp);
  64. $fp = false;
  65. }
  66. }
  67. if (is_resource($fp)) {
  68. /**
  69. * stream_set_read_buffer() does not exist in HHVM
  70. *
  71. * If we don't set the stream's read buffer to 0, PHP will
  72. * internally buffer 8192 bytes, which can waste entropy
  73. *
  74. * stream_set_read_buffer returns 0 on success
  75. */
  76. if (is_callable('stream_set_read_buffer')) {
  77. stream_set_read_buffer($fp, RANDOM_COMPAT_READ_BUFFER);
  78. }
  79. if (is_callable('stream_set_chunk_size')) {
  80. stream_set_chunk_size($fp, RANDOM_COMPAT_READ_BUFFER);
  81. }
  82. }
  83. }
  84. try {
  85. /** @var int $bytes */
  86. $bytes = RandomCompat_intval($bytes);
  87. } catch (TypeError $ex) {
  88. throw new TypeError(
  89. 'random_bytes(): $bytes must be an integer'
  90. );
  91. }
  92. if ($bytes < 1) {
  93. throw new Error(
  94. 'Length must be greater than 0'
  95. );
  96. }
  97. /**
  98. * This if() block only runs if we managed to open a file handle
  99. *
  100. * It does not belong in an else {} block, because the above
  101. * if (empty($fp)) line is logic that should only be run once per
  102. * page load.
  103. */
  104. if (is_resource($fp)) {
  105. /**
  106. * @var int
  107. */
  108. $remaining = $bytes;
  109. /**
  110. * @var string|bool
  111. */
  112. $buf = '';
  113. /**
  114. * We use fread() in a loop to protect against partial reads
  115. */
  116. do {
  117. /**
  118. * @var string|bool
  119. */
  120. $read = fread($fp, $remaining);
  121. if (!is_string($read)) {
  122. if ($read === false) {
  123. /**
  124. * We cannot safely read from the file. Exit the
  125. * do-while loop and trigger the exception condition
  126. *
  127. * @var string|bool
  128. */
  129. $buf = false;
  130. break;
  131. }
  132. }
  133. /**
  134. * Decrease the number of bytes returned from remaining
  135. */
  136. $remaining -= RandomCompat_strlen($read);
  137. /**
  138. * @var string|bool
  139. */
  140. $buf = $buf . $read;
  141. } while ($remaining > 0);
  142. /**
  143. * Is our result valid?
  144. */
  145. if (is_string($buf)) {
  146. if (RandomCompat_strlen($buf) === $bytes) {
  147. /**
  148. * Return our random entropy buffer here:
  149. */
  150. return $buf;
  151. }
  152. }
  153. }
  154. /**
  155. * If we reach here, PHP has failed us.
  156. */
  157. throw new Exception(
  158. 'Error reading from source device'
  159. );
  160. }
  161. }