External Libraries: Update Random_Compat from 1.2.1 to 2.0.11.

Notably this fixes PHP7 parse errors of the files and removes the OpenSSL functionality.
Full Changes: https://github.com/paragonie/random_compat/compare/v1.2.1...v2.0.11

Props jrdelarosa.
See #42439.


git-svn-id: https://develop.svn.wordpress.org/trunk@42130 602fd350-edb4-49c9-b593-d223f7449a82

src/wp-includes/random_compat/byte_safe_strings.php

@@ -5,7 +5,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -26,7 +26,7 @@
  * SOFTWARE.
  */
 
-if (!function_exists('RandomCompat_strlen')) {
+if (!is_callable('RandomCompat_strlen')) {
     if (
         defined('MB_OVERLOAD_STRING') &&
         ini_get('mbstring.func_overload') & MB_OVERLOAD_STRING
@@ -51,7 +51,7 @@ if (!function_exists('RandomCompat_strlen')) {
                 );
             }
 
-            return mb_strlen($binary_string, '8bit');
+            return (int) mb_strlen($binary_string, '8bit');
         }
 
     } else {
@@ -73,12 +73,12 @@ if (!function_exists('RandomCompat_strlen')) {
                     'RandomCompat_strlen() expects a string'
                 );
             }
-            return strlen($binary_string);
+            return (int) strlen($binary_string);
         }
     }
 }
 
-if (!function_exists('RandomCompat_substr')) {
+if (!is_callable('RandomCompat_substr')) {
 
     if (
         defined('MB_OVERLOAD_STRING')
@@ -118,14 +118,22 @@ if (!function_exists('RandomCompat_substr')) {
                  * mb_substr($str, 0, NULL, '8bit') returns an empty string on
                  * PHP 5.3, so we have to find the length ourselves.
                  */
-                $length = RandomCompat_strlen($length) - $start;
+                $length = RandomCompat_strlen($binary_string) - $start;
             } elseif (!is_int($length)) {
                 throw new TypeError(
                     'RandomCompat_substr(): Third argument should be an integer, or omitted'
                 );
             }
 
-            return mb_substr($binary_string, $start, $length, '8bit');
+            // Consistency with PHP's behavior
+            if ($start === RandomCompat_strlen($binary_string) && $length === 0) {
+                return '';
+            }
+            if ($start > RandomCompat_strlen($binary_string)) {
+                return '';
+            }
+
+            return (string) mb_substr($binary_string, $start, $length, '8bit');
         }
 
     } else {
@@ -164,10 +172,10 @@ if (!function_exists('RandomCompat_substr')) {
                     );
                 }
 
-                return substr($binary_string, $start, $length);
+                return (string) substr($binary_string, $start, $length);
             }
 
-            return substr($binary_string, $start);
+            return (string) substr($binary_string, $start);
         }
     }
 }

src/wp-includes/random_compat/cast_to_int.php

@@ -5,7 +5,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -26,7 +26,7 @@
  * SOFTWARE.
  */
 
-if (!function_exists('RandomCompat_intval')) {
+if (!is_callable('RandomCompat_intval')) {
     
     /**
      * Cast to an integer if we can, safely.
@@ -38,15 +38,18 @@ if (!function_exists('RandomCompat_intval')) {
      * through.
      * 
      * @param int|float $number    The number we want to convert to an int
-     * @param boolean   $fail_open Set to true to not throw an exception
+     * @param bool      $fail_open Set to true to not throw an exception
      * 
-     * @return int (or float if $fail_open)
+     * @return float|int
+     * @psalm-suppress InvalidReturnType
      *
      * @throws TypeError
      */
     function RandomCompat_intval($number, $fail_open = false)
     {
-        if (is_numeric($number)) {
+        if (is_int($number) || is_float($number)) {
+            $number += 0;
+        } elseif (is_numeric($number)) {
             $number += 0;
         }
 
@@ -60,12 +63,13 @@ if (!function_exists('RandomCompat_intval')) {
             $number = (int) $number;
         }
 
-        if (is_int($number) || $fail_open) {
+        if (is_int($number)) {
-            return $number;
+            return (int) $number;
-        }
+        } elseif (!$fail_open) {
-
             throw new TypeError(
                 'Expected an integer.'
             );
         }
+        return $number;
+    }
 }

src/wp-includes/random_compat/error_polyfill.php

@@ -5,7 +5,7 @@
  * 
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -35,8 +35,15 @@ if (!class_exists('Error', false)) {
 }
 
 if (!class_exists('TypeError', false)) {
+    if (is_subclass_of('Error', 'Exception')) {
         class TypeError extends Error
         {
             
         }
+    } else {
+        class TypeError extends Exception
+        {
+            
+        }
+    }
 }

src/wp-includes/random_compat/random.php

@@ -3,12 +3,12 @@
  * Random_* Compatibility Library
  * for using the new PHP 7 random_* API in PHP 5 projects
  *
- * @version 1.2.1
+ * @version 2.0.10
- * @released 2016-02-29
+ * @released 2017-03-13
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -31,7 +31,7 @@
 
 if (!defined('PHP_VERSION_ID')) {
     // This constant was introduced in PHP 5.2.7
-    $RandomCompatversion = explode('.', PHP_VERSION);
+    $RandomCompatversion = array_map('intval', explode('.', PHP_VERSION));
     define(
         'PHP_VERSION_ID',
         $RandomCompatversion[0] * 10000
@@ -41,7 +41,12 @@ if (!defined('PHP_VERSION_ID')) {
     $RandomCompatversion = null;
 }
 
-if (PHP_VERSION_ID < 70000) {
+/**
+ * PHP 7.0.0 and newer have these functions natively.
+ */
+if (PHP_VERSION_ID >= 70000) {
+    return;
+}
 
 if (!defined('RANDOM_COMPAT_READ_BUFFER')) {
     define('RANDOM_COMPAT_READ_BUFFER', 8);
@@ -53,7 +58,7 @@ if (PHP_VERSION_ID < 70000) {
 require_once $RandomCompatDIR . '/cast_to_int.php';
 require_once $RandomCompatDIR . '/error_polyfill.php';
 
-    if (!function_exists('random_bytes')) {
+if (!is_callable('random_bytes')) {
     /**
      * PHP 5.2.0 - 5.6.x way to implement random_bytes()
      *
@@ -65,13 +70,12 @@ if (PHP_VERSION_ID < 70000) {
      *   2. fread() /dev/urandom if available (never on Windows)
      *   3. mcrypt_create_iv($bytes, MCRYPT_DEV_URANDOM)
      *   4. COM('CAPICOM.Utilities.1')->GetRandom()
-         *   5. openssl_random_pseudo_bytes() (absolute last resort)
      *
-         * See ERRATA.md for our reasoning behind this particular order
+     * See RATIONALE.md for our reasoning behind this particular order
      */
     if (extension_loaded('libsodium')) {
         // See random_bytes_libsodium.php
-            if (PHP_VERSION_ID >= 50300 && function_exists('\\Sodium\\randombytes_buf')) {
+        if (PHP_VERSION_ID >= 50300 && is_callable('\\Sodium\\randombytes_buf')) {
             require_once $RandomCompatDIR . '/random_bytes_libsodium.php';
         } elseif (method_exists('Sodium', 'randombytes_buf')) {
             require_once $RandomCompatDIR . '/random_bytes_libsodium_legacy.php';
@@ -92,15 +96,15 @@ if (PHP_VERSION_ID < 70000) {
                 PATH_SEPARATOR,
                 strtolower($RandomCompat_basedir)
             );
-                $RandomCompatUrandom = in_array(
+            $RandomCompatUrandom = (array() !== array_intersect(
-                    '/dev',
+                array('/dev', '/dev/', '/dev/urandom'),
                 $RandomCompat_open_basedir
-                );
+            ));
             $RandomCompat_open_basedir = null;
         }
 
         if (
-                !function_exists('random_bytes')
+            !is_callable('random_bytes')
             &&
             $RandomCompatUrandom
             &&
@@ -117,32 +121,54 @@ if (PHP_VERSION_ID < 70000) {
         }
         // Unset variables after use
         $RandomCompat_basedir = null;
-            $RandomCompatUrandom = 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 (
-            !function_exists('random_bytes')
+        !is_callable('random_bytes')
         &&
-            PHP_VERSION_ID >= 50307
+        // Windows on PHP < 5.3.7 is broken, but non-Windows is not known to be.
+        (DIRECTORY_SEPARATOR === '/' || PHP_VERSION_ID >= 50307)
         &&
-            extension_loaded('mcrypt')
-        ) {
         // Prevent this code from hanging indefinitely on non-Windows;
         // see https://bugs.php.net/bug.php?id=69833
-            if (
+        (
             DIRECTORY_SEPARATOR !== '/' ||
             (PHP_VERSION_ID <= 50609 || PHP_VERSION_ID >= 50613)
+        )
+        &&
+        extension_loaded('mcrypt')
     ) {
         // See random_bytes_mcrypt.php
         require_once $RandomCompatDIR . '/random_bytes_mcrypt.php';
     }
-        }
+    $RandomCompatUrandom = null;
 
+    /**
+     * This is a Windows-specific fallback, for when the mcrypt extension
+     * isn't loaded.
+     */
     if (
-            !function_exists('random_bytes')
+        !is_callable('random_bytes')
         &&
         extension_loaded('com_dotnet')
         &&
@@ -168,40 +194,21 @@ if (PHP_VERSION_ID < 70000) {
         $RandomCompatCOMtest = null;
     }
 
-        /**
-         * openssl_random_pseudo_bytes()
-         */
-        if (
-            (
-                // Unix-like with PHP >= 5.3.0 or
-                (
-                    DIRECTORY_SEPARATOR === '/'
-                    &&
-                    PHP_VERSION_ID >= 50300
-                )
-                ||
-                // Windows with PHP >= 5.4.1
-                PHP_VERSION_ID >= 50401
-            )
-            &&
-            !function_exists('random_bytes')
-            &&
-            extension_loaded('openssl')
-        ) {
-            // See random_bytes_openssl.php
-            require_once $RandomCompatDIR.'/random_bytes_openssl.php';
-        }
-
     /**
      * throw new Exception
      */
-        if (!function_exists('random_bytes')) {
+    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
+         * @return void
+         * @throws Exception
          */
         function random_bytes($length)
         {
+            unset($length); // Suppress "variable not used" warnings.
             throw new Exception(
                 'There is no suitable CSPRNG installed on your system'
             );
@@ -209,9 +216,8 @@ if (PHP_VERSION_ID < 70000) {
     }
 }
 
-    if (!function_exists('random_int')) {
+if (!is_callable('random_int')) {
     require_once $RandomCompatDIR . '/random_int.php';
 }
 
 $RandomCompatDIR = null;
-}

src/wp-includes/random_compat/random_bytes_com_dotnet.php

@@ -5,7 +5,7 @@
  * 
  * The MIT License (MIT)
  * 
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -26,6 +26,7 @@
  * SOFTWARE.
  */
 
+if (!is_callable('random_bytes')) {
     /**
      * Windows with PHP < 5.3.0 will not have the function
      * openssl_random_pseudo_bytes() available, so let's use
@@ -54,6 +55,11 @@ function random_bytes($bytes)
         }
 
         $buf = '';
+        if (!class_exists('COM')) {
+            throw new Error(
+                'COM does not exist'
+            );
+        }
         $util = new COM('CAPICOM.Utilities.1');
         $execCount = 0;
 
@@ -79,3 +85,4 @@ function random_bytes($bytes)
             'Could not gather sufficient random data'
         );
     }
+}

src/wp-includes/random_compat/random_bytes_dev_urandom.php

@@ -5,7 +5,7 @@
  * 
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -30,6 +30,7 @@ if (!defined('RANDOM_COMPAT_READ_BUFFER')) {
     define('RANDOM_COMPAT_READ_BUFFER', 8);
 }
 
+if (!is_callable('random_bytes')) {
     /**
      * Unless open_basedir is enabled, use /dev/urandom for
      * random numbers in accordance with best practices
@@ -72,10 +73,10 @@ function random_bytes($bytes)
                  *
                  * stream_set_read_buffer returns 0 on success
                  */
-            if (function_exists('stream_set_read_buffer')) {
+                if (is_callable('stream_set_read_buffer')) {
                     stream_set_read_buffer($fp, RANDOM_COMPAT_READ_BUFFER);
                 }
-            if (function_exists('stream_set_chunk_size')) {
+                if (is_callable('stream_set_chunk_size')) {
                     stream_set_chunk_size($fp, RANDOM_COMPAT_READ_BUFFER);
                 }
             }
@@ -103,33 +104,50 @@ function random_bytes($bytes)
          * page load.
          */
         if (!empty($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)) {
                     if ($read === false) {
                         /**
                          * 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);
-            $buf .= $read;
+                /**
+                 * @var string|bool
+                 */
+                $buf = $buf . $read;
             } while ($remaining > 0);
 
             /**
              * Is our result valid?
              */
-        if ($buf !== false) {
+            if (is_string($buf)) {
                 if (RandomCompat_strlen($buf) === $bytes) {
                     /**
                      * Return our random entropy buffer here:
@@ -146,3 +164,4 @@ function random_bytes($bytes)
             'Error reading from source device'
         );
     }
+}

src/wp-includes/random_compat/random_bytes_libsodium.php

@@ -5,7 +5,7 @@
  * 
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -26,6 +26,7 @@
  * SOFTWARE.
  */
 
+if (!is_callable('random_bytes')) {
     /**
      * If the libsodium PHP extension is loaded, we'll use it above any other
      * solution.
@@ -84,3 +85,4 @@ function random_bytes($bytes)
             'Could not gather sufficient random data'
         );
     }
+}

src/wp-includes/random_compat/random_bytes_libsodium_legacy.php

@@ -5,7 +5,7 @@
  * 
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -26,6 +26,7 @@
  * SOFTWARE.
  */
 
+if (!is_callable('random_bytes')) {
     /**
      * If the libsodium PHP extension is loaded, we'll use it above any other
      * solution.
@@ -55,23 +56,27 @@ function random_bytes($bytes)
             );
         }
 
+        /**
+         * @var string
+         */
+        $buf = '';
+
         /**
          * \Sodium\randombytes_buf() doesn't allow more than 2147483647 bytes to be
          * generated in one invocation.
          */
         if ($bytes > 2147483647) {
-        $buf = '';
             for ($i = 0; $i < $bytes; $i += 1073741824) {
                 $n = ($bytes - $i) > 1073741824
                     ? 1073741824
                     : $bytes - $i;
-            $buf .= Sodium::randombytes_buf($n);
+                $buf .= Sodium::randombytes_buf((int) $n);
             }
         } else {
-        $buf = Sodium::randombytes_buf($bytes);
+            $buf .= Sodium::randombytes_buf((int) $bytes);
         }
 
-    if ($buf !== false) {
+        if (is_string($buf)) {
             if (RandomCompat_strlen($buf) === $bytes) {
                 return $buf;
             }
@@ -84,3 +89,4 @@ function random_bytes($bytes)
             'Could not gather sufficient random data'
         );
     }
+}

src/wp-includes/random_compat/random_bytes_mcrypt.php

@@ -5,7 +5,7 @@
  * 
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+ * Copyright (c) 2015 - 2017 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
@@ -26,7 +26,7 @@
  * SOFTWARE.
  */
 
-
+if (!is_callable('random_bytes')) {
     /**
      * Powered by ext/mcrypt (and thankfully NOT libmcrypt)
      *
@@ -74,3 +74,4 @@ function random_bytes($bytes)
             'Could not gather sufficient random data'
         );
     }
+}

src/wp-includes/random_compat/random_bytes_openssl.php

@@ -1,83 +0,0 @@
-<?php
-/**
- * Random_* Compatibility Library 
- * for using the new PHP 7 random_* API in PHP 5 projects
- * 
- * 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.
- */
-
-/**
- * Since openssl_random_pseudo_bytes() uses openssl's 
- * RAND_pseudo_bytes() API, which has been marked as deprecated by the
- * OpenSSL team, this is our last resort before failure.
- * 
- * @ref https://www.openssl.org/docs/crypto/RAND_bytes.html
- * 
- * @param int $bytes
- * 
- * @throws Exception
- * 
- * @return string
- */
-function random_bytes($bytes)
-{
-    try {
-        $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'
-        );
-    }
-
-    /**
-     * $secure is passed by reference. If it's set to false, fail. Note
-     * that this will only return false if this function fails to return
-     * any data.
-     * 
-     * @ref https://github.com/paragonie/random_compat/issues/6#issuecomment-119564973
-     */
-    $secure = true;
-    $buf = openssl_random_pseudo_bytes($bytes, $secure);
-    if (
-        $buf !== false
-        &&
-        $secure
-        &&
-        RandomCompat_strlen($buf) === $bytes
-    ) {
-        return $buf;
-    }
-
-    /**
-     * If we reach here, PHP has failed us.
-     */
-    throw new Exception(
-        'Could not gather sufficient random data'
-    );
-}

src/wp-includes/random_compat/random_int.php

@@ -1,11 +1,13 @@
 <?php
+
+if (!is_callable('random_int')) {
     /**
      * Random_* Compatibility Library
      * for using the new PHP 7 random_* API in PHP 5 projects
      *
      * The MIT License (MIT)
      *
- * Copyright (c) 2015 Paragon Initiative Enterprises
+     * Copyright (c) 2015 - 2017 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
@@ -76,7 +78,7 @@ function random_int($min, $max)
         }
 
         if ($max === $min) {
-        return $min;
+            return (int) $min;
         }
 
         /**
@@ -132,6 +134,7 @@ function random_int($min, $max)
             $valueShift = $min;
         }
 
+        $val = 0;
         /**
          * Now that we have our parameters set up, let's begin generating
          * random integers until one falls between $min and $max
@@ -151,11 +154,6 @@ function random_int($min, $max)
              * Let's grab the necessary number of random bytes
              */
             $randomByteString = random_bytes($bytes);
-        if ($randomByteString === false) {
-            throw new Exception(
-                'Random number generator failure'
-            );
-        }
 
             /**
              * Let's turn $randomByteString into an integer
@@ -167,7 +165,7 @@ function random_int($min, $max)
              *   159 + 27904 + 3276800 + 201326592 =>
              *   204631455
              */
-        $val = 0;
+            $val &= 0;
             for ($i = 0; $i < $bytes; ++$i) {
                 $val |= ord($randomByteString[$i]) << ($i * 8);
             }
@@ -189,3 +187,4 @@ function random_int($min, $max)
 
         return (int) $val;
     }
+}