<!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>[42016] trunk: Dashboard: Strip ports from IPs to avoid PHP warnings.</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/42016">42016</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/42016","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-25 00:06:06 +0000 (Wed, 25 Oct 2017)</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'>Dashboard: Strip ports from IPs to avoid PHP warnings.
Fixes <a href="https://core.trac.wordpress.org/ticket/41083">#41083</a>.
Props pento, iandunn, EatonZ, birgire, dd32.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpcommunityeventsphp">trunk/src/wp-admin/includes/class-wp-community-events.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesCommunityEventsphp">trunk/tests/phpunit/tests/admin/includesCommunityEvents.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpcommunityeventsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-community-events.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-community-events.php 2017-10-25 00:01:29 UTC (rev 42015)
+++ trunk/src/wp-admin/includes/class-wp-community-events.php 2017-10-25 00:06:06 UTC (rev 42016)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -233,7 +233,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_unsafe_client_ip() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $client_ip = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $client_ip = $netmask = false;
+ $ip_prefix = '';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // In order of preference, with the best ones for this purpose first.
</span><span class="cx" style="display: block; padding: 0 10px"> $address_headers = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -260,18 +261,47 @@
</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">- // These functions are not available on Windows until PHP 5.3.
- if ( function_exists( 'inet_pton' ) && function_exists( 'inet_ntop' ) ) {
- if ( 4 === strlen( inet_pton( $client_ip ) ) ) {
- $netmask = '255.255.255.0'; // ipv4.
- } else {
- $netmask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000'; // ipv6.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $client_ip ) {
+ return false;
+ }
+
+ // Detect what kind of IP address this is.
+ $is_ipv6 = substr_count( $client_ip, ':' ) > 1;
+ $is_ipv4 = ( 3 === substr_count( $client_ip, '.' ) );
+
+ if ( $is_ipv6 && $is_ipv4 ) {
+ // IPv6 compatibility mode, temporarily strip the IPv6 part, and treat it like IPv4.
+ $ip_prefix = '::ffff:';
+ $client_ip = preg_replace( '/^\[?[0-9a-f:]*:/i', '', $client_ip );
+ $client_ip = str_replace( ']', '', $client_ip );
+ $is_ipv6 = false;
+ }
+
+ if ( $is_ipv6 ) {
+ // IPv6 addresses will always be enclosed in [] if there's a port.
+ $ip_start = 1;
+ $ip_end = (int) strpos( $client_ip, ']' ) - 1;
+ $netmask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000';
+
+ // Strip the port (and [] from IPv6 addresses), if they exist.
+ if ( $ip_end > 0 ) {
+ $client_ip = substr( $client_ip, $ip_start, $ip_end );
</ins><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">- $client_ip = inet_ntop( inet_pton( $client_ip ) & inet_pton( $netmask ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Partially anonymize the IP by reducing it to the corresponding network ID.
+ if ( function_exists( 'inet_pton' ) && function_exists( 'inet_ntop' ) ) {
+ $client_ip = inet_ntop( inet_pton( $client_ip ) & inet_pton( $netmask ) );
+ }
+ } elseif ( $is_ipv4 ) {
+ // Strip any port and partially anonymize the IP.
+ $last_octet_position = strrpos( $client_ip, '.' );
+ $client_ip = substr( $client_ip, 0, $last_octet_position ) . '.0';
+ } else {
+ return false;
</ins><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">- return $client_ip;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Restore the IPv6 prefix to compatibility mode addresses.
+ return $ip_prefix . $client_ip;
</ins><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></pre></div>
<a id="trunktestsphpunittestsadminincludesCommunityEventsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/includesCommunityEvents.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesCommunityEvents.php 2017-10-25 00:01:29 UTC (rev 42015)
+++ trunk/tests/phpunit/tests/admin/includesCommunityEvents.php 2017-10-25 00:06:06 UTC (rev 42016)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -255,4 +255,113 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'filename' => '',
</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">+
+ /**
+ * Test that get_unsafe_client_ip() properly anonymizes all possible address formats
+ *
+ * @dataProvider data_get_unsafe_client_ip_anonymization
+ *
+ * @ticket 41083
+ */
+ public function test_get_unsafe_client_ip_anonymization( $raw_ip, $expected_result ) {
+ $_SERVER['REMOTE_ADDR'] = $raw_ip;
+ $actual_result = WP_Community_Events::get_unsafe_client_ip();
+
+ $this->assertEquals( $expected_result, $actual_result );
+ }
+
+ public function data_get_unsafe_client_ip_anonymization() {
+ return array(
+ // Invalid IP.
+ array(
+ '', // Raw IP address
+ false, // Expected result
+ ),
+ // Invalid IP. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ 'unknown',
+ false,
+ ),
+ // IPv4, no port
+ array(
+ '10.20.30.45',
+ '10.20.30.0',
+ ),
+ // IPv4, port
+ array(
+ '10.20.30.45:20000',
+ '10.20.30.0',
+ ),
+ // IPv6, no port
+ array(
+ '2a03:2880:2110:df07:face:b00c::1',
+ '2a03:2880:2110:df07::',
+ ),
+ // IPv6, port
+ array(
+ '[2a03:2880:2110:df07:face:b00c::1]:20000',
+ '2a03:2880:2110:df07::',
+ ),
+ // IPv6, no port, reducible representation
+ array(
+ '0000:0000:0000:0000:0000:0000:0000:0001',
+ '::',
+ ),
+ // IPv6, no port, partially reducible representation
+ array(
+ '1000:0000:0000:0000:0000:0000:0000:0001',
+ '1000::',
+ ),
+ // IPv6, port, reducible representation
+ array(
+ '[0000:0000:0000:0000:0000:0000:0000:0001]:1234',
+ '::',
+ ),
+ // IPv6, port, partially reducible representation
+ array(
+ '[1000:0000:0000:0000:0000:0000:0000:0001]:5678',
+ '1000::',
+ ),
+ // IPv6, no port, reduced representation
+ array(
+ '::',
+ '::',
+ ),
+ // IPv6, no port, reduced representation
+ array(
+ '::1',
+ '::',
+ ),
+ // IPv6, port, reduced representation
+ array(
+ '[::]:20000',
+ '::',
+ ),
+ // IPv6, address brackets without port delimiter and number, reduced representation
+ array(
+ '[::1]',
+ '::',
+ ),
+ // IPv6, no port, compatibility mode
+ array(
+ '::ffff:10.15.20.25',
+ '::ffff:10.15.20.0',
+ ),
+ // IPv6, port, compatibility mode
+ array(
+ '[::ffff:10.15.20.25]:30000',
+ '::ffff:10.15.20.0',
+ ),
+ // IPv6, no port, compatibility mode shorthand
+ array(
+ '::127.0.0.1',
+ '::ffff:127.0.0.0',
+ ),
+ // IPv6, port, compatibility mode shorthand
+ array(
+ '[::127.0.0.1]:30000',
+ '::ffff:127.0.0.0',
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>