<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34981] trunk/src/wp-includes: Use PHP7's `random_int()` CSPRNG functionality in `wp_rand()` with a fallback to the `random_compat` library for PHP 5.x.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34981">34981</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34981","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-09 04:27:41 +0000 (Fri, 09 Oct 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Use PHP7's `random_int()` CSPRNG functionality in `wp_rand()` with a fallback to the `random_compat` library for PHP 5.x.
`random_compat` offers a set of compatible functions for older versions of PHP, filling in the gap by using other PHP extensions when available.
We still include our existing `wp_rand()` functionality as a fallback for when no proper CSPRNG exists on the system.
Take Two, this was previously committed in <a href="https://core.trac.wordpress.org/changeset/34922">[34922]</a> but had an issue on PHP 5.2 which sarciszewski has now resolved.
Props sarciszewski
See <a href="https://core.trac.wordpress.org/ticket/28633">#28633</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescompatphp">trunk/src/wp-includes/compat.php</a></li>
<li><a href="#trunksrcwpincludespluggablephp">trunk/src/wp-includes/pluggable.php</a></li>
<li><a href="#trunksrcwpincludesrandom_compaterror_polyfillphp">trunk/src/wp-includes/random_compat/error_polyfill.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/src/wp-includes/random_compat/</li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescompatphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/compat.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/compat.php 2015-10-09 04:25:23 UTC (rev 34980)
+++ trunk/src/wp-includes/compat.php 2015-10-09 04:27:41 UTC (rev 34981)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -332,3 +332,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function jsonSerialize();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+// random_int was introduced in PHP 7.0
+if ( ! function_exists( 'random_int' ) ) {
+ require ABSPATH . WPINC . '/random_compat/random.php';
+}
</ins></span></pre></div>
<a id="trunksrcwpincludespluggablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/pluggable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/pluggable.php 2015-10-09 04:25:23 UTC (rev 34980)
+++ trunk/src/wp-includes/pluggable.php 2015-10-09 04:27:41 UTC (rev 34981)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2138,9 +2138,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Generates a random number
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.2
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4 Uses PHP7 random_int() or the random_compat library if avaialble.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $rnd_value
</span><span class="cx" style="display: block; padding: 0 10px"> * @staticvar string $seed
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @staticvar bool $external_rand_source_available
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $min Lower limit for the generated number
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $max Upper limit for the generated number
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2149,6 +2151,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_rand( $min = 0, $max = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $rnd_value;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Some misconfigured 32bit environments (Entropy PHP, for example) truncate integers larger than PHP_INT_MAX to PHP_INT_MAX rather than overflowing them to floats.
+ $max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
+
+ // We only handle Ints, floats are truncated to their integer value.
+ $min = (int) $min;
+ $max = (int) $max;
+
+ // Use PHP's CSPRNG, or a compatible method
+ static $use_random_int_functionality = true;
+ if ( $use_random_int_functionality ) {
+ try {
+ $_max = ( 0 != $max ) ? $max : $max_random_number;
+ // wp_rand() can accept arguements in either order, PHP cannot.
+ $_max = max( $min, $_max );
+ $_min = min( $min, $_max );
+ $val = random_int( $_min, $_max );
+ if ( false !== $val ) {
+ return absint( $val );
+ } else {
+ $use_random_int_functionality = false;
+ }
+ } catch ( Throwable $t ) {
+ $use_random_int_functionality = false;
+ } catch ( Exception $e ) {
+ $use_random_int_functionality = false;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Reset $rnd_value after 14 uses
</span><span class="cx" style="display: block; padding: 0 10px"> // 32(md5) + 40(sha1) + 40(sha1) / 8 = 14 random numbers from $rnd_value
</span><span class="cx" style="display: block; padding: 0 10px"> if ( strlen($rnd_value) < 8 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2173,9 +2203,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $value = abs(hexdec($value));
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Some misconfigured 32bit environments (Entropy PHP, for example) truncate integers larger than PHP_INT_MAX to PHP_INT_MAX rather than overflowing them to floats.
- $max_random_number = 3000000000 === 2147483647 ? (float) "4294967295" : 4294967295; // 4294967295 = 0xffffffff
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Reduce the value to be within the min - max range
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $max != 0 )
</span><span class="cx" style="display: block; padding: 0 10px"> $value = $min + ( $max - $min + 1 ) * $value / ( $max_random_number + 1 );
</span></span></pre></div>
<a id="trunksrcwpincludesrandom_compaterror_polyfillphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/random_compat/error_polyfill.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/random_compat/error_polyfill.php 2015-10-08 00:10:41 UTC (rev 34923)
+++ trunk/src/wp-includes/random_compat/error_polyfill.php 2015-10-09 04:27:41 UTC (rev 34981)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,14 +29,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if (!interface_exists('Throwable', false)) {
</span><span class="cx" style="display: block; padding: 0 10px"> interface Throwable
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function getMessage();
- public function getCode();
- public function getFile();
- public function getLine();
- public function getTrace();
- public function getTraceAsString();
- public function getPrevious();
- public function __toString();
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,4 +45,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+}
</ins></span></pre>
</div>
</div>
</body>
</html>