random_bytes_openssl.php 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. if ( ! is_callable( 'random_bytes' ) ):
  29. /**
  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.
  33. *
  34. * @ref https://www.openssl.org/docs/crypto/RAND_bytes.html
  35. *
  36. * @param int $bytes
  37. *
  38. * @throws Exception
  39. *
  40. * @return string
  41. */
  42. function random_bytes($bytes)
  43. {
  44. try {
  45. $bytes = RandomCompat_intval($bytes);
  46. } catch (TypeError $ex) {
  47. throw new TypeError(
  48. 'random_bytes(): $bytes must be an integer'
  49. );
  50. }
  51. if ($bytes < 1) {
  52. throw new Error(
  53. 'Length must be greater than 0'
  54. );
  55. }
  56. /**
  57. * $secure is passed by reference. If it's set to false, fail. Note
  58. * that this will only return false if this function fails to return
  59. * any data.
  60. *
  61. * @ref https://github.com/paragonie/random_compat/issues/6#issuecomment-119564973
  62. */
  63. $secure = true;
  64. $buf = openssl_random_pseudo_bytes($bytes, $secure);
  65. if (
  66. $buf !== false
  67. &&
  68. $secure
  69. &&
  70. RandomCompat_strlen($buf) === $bytes
  71. ) {
  72. return $buf;
  73. }
  74. /**
  75. * If we reach here, PHP has failed us.
  76. */
  77. throw new Exception(
  78. 'Could not gather sufficient random data'
  79. );
  80. }
  81. endif;