Changeset 43082

Timestamp:

05/02/2018 12:48:23 AM (8 years ago)

Author:

SergeyBiryukov

Message:

Privacy: add helper function for anonymizing data in a standardized way.

Props jesperher, allendav, iandunn, birgire, azaozz, joemcgill.
Merges [42971] and [43081] to the 4.9 branch.
Fixes #43545.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/class-wp-community-events.php (modified) (2 diffs)
• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/tests/admin/includesCommunityEvents.php (modified) (1 diff)
• tests/phpunit/tests/functions/anonymization.php (added)

branches/4.9/src/wp-admin/includes/class-wp-community-events.php

@@ -235 +235 @@
         public static function get_unsafe_client_ip() {
                 $client_ip = $netmask = false;
-                $ip_prefix = '';
 
                 // In order of preference, with the best ones for this purpose first.
@@ -266 +265 @@
                 }
 
-                // 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 );
-                        }
-
-                        // 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 {
+                $anon_ip = wp_privacy_anonymize_ip( $client_ip, true );
+
+                if ( '0.0.0.0' === $anon_ip || '::' === $anon_ip ) {
                         return false;
                 }
 
-                // Restore the IPv6 prefix to compatibility mode addresses.
-                return $ip_prefix . $client_ip;
+                return $anon_ip;
         }
 

branches/4.9/src/wp-includes/functions.php

@@ -5817 +5817 @@
         ), $email_change_email['message'], $email_change_email['headers'] );
 }
+
+/**
+ * Return an anonymized IPv4 or IPv6 address.
+ *
+ * @since 4.9.6 Abstracted from `WP_Community_Events::get_unsafe_client_ip()`.
+ *
+ * @param  string $ip_addr        The IPv4 or IPv6 address to be anonymized.
+ * @param  bool   $ipv6_fallback  Optional. Whether to return the original IPv6 address if the needed functions
+ *                                to anonymize it are not present. Default false, return `::` (unspecified address).
+ * @return string  The anonymized IP address.
+ */
+function wp_privacy_anonymize_ip( $ip_addr, $ipv6_fallback = false ) {
+        // Detect what kind of IP address this is.
+        $ip_prefix = '';
+        $is_ipv6   = substr_count( $ip_addr, ':' ) > 1;
+        $is_ipv4   = ( 3 === substr_count( $ip_addr, '.' ) );
+
+        if ( $is_ipv6 && $is_ipv4 ) {
+                // IPv6 compatibility mode, temporarily strip the IPv6 part, and treat it like IPv4.
+                $ip_prefix = '::ffff:';
+                $ip_addr   = preg_replace( '/^\[?[0-9a-f:]*:/i', '', $ip_addr );
+                $ip_addr   = str_replace( ']', '', $ip_addr );
+                $is_ipv6   = false;
+        }
+
+        if ( $is_ipv6 ) {
+                // IPv6 addresses will always be enclosed in [] if there's a port.
+                $left_bracket  = strpos( $ip_addr, '[' );
+                $right_bracket = strpos( $ip_addr, ']' );
+                $percent       = strpos( $ip_addr, '%' );
+                $netmask       = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000';
+
+                // Strip the port (and [] from IPv6 addresses), if they exist.
+                if ( false !== $left_bracket && false !== $right_bracket ) {
+                        $ip_addr = substr( $ip_addr, $left_bracket + 1, $right_bracket - $left_bracket - 1 );
+                } elseif ( false !== $left_bracket || false !== $right_bracket ) {
+                        // The IP has one bracket, but not both, so it's malformed.
+                        return '::';
+                }
+
+                // Strip the reachability scope.
+                if ( false !== $percent ) {
+                        $ip_addr = substr( $ip_addr, 0, $percent );
+                }
+
+                // No invalid characters should be left.
+                if ( preg_match( '/[^0-9a-f:]/i', $ip_addr ) ) {
+                        return '::';
+                }
+
+                // Partially anonymize the IP by reducing it to the corresponding network ID.
+                if ( function_exists( 'inet_pton' ) && function_exists( 'inet_ntop' ) ) {
+                        $ip_addr = inet_ntop( inet_pton( $ip_addr ) & inet_pton( $netmask ) );
+                        if ( false === $ip_addr) {
+                                return '::';
+                        }
+                } elseif ( ! $ipv6_fallback ) {
+                        return '::';
+                }
+        } elseif ( $is_ipv4 ) {
+                // Strip any port and partially anonymize the IP.
+                $last_octet_position = strrpos( $ip_addr, '.' );
+                $ip_addr             = substr( $ip_addr, 0, $last_octet_position ) . '.0';
+        } else {
+                return '0.0.0.0';
+        }
+
+        // Restore the IPv6 prefix to compatibility mode addresses.
+        return $ip_prefix . $ip_addr;
+}
+
+/**
+ * Return uniform "anonymous" data by type.
+ *
+ * @since 4.9.6
+ *
+ * @param  string $type The type of data to be anonymized.
+ * @param  string $data Optional The data to be anonymized.
+ * @return string The anonymous data for the requested type.
+ */
+function wp_privacy_anonymize_data( $type, $data = '' ) {
+
+        switch ( $type ) {
+                case 'email':
+                        $anonymous = 'deleted@site.invalid';
+                        break;
+                case 'url':
+                        $anonymous = 'https://site.invalid';
+                        break;
+                case 'ip':
+                        $anonymous = wp_privacy_anonymize_ip( $data );
+                        break;
+                case 'date':
+                        $anonymous = '0000-00-00 00:00:00';
+                        break;
+                case 'text':
+                        /* translators: deleted text */
+                        $anonymous = __( '[deleted]' );
+                        break;
+                case 'longtext':
+                        /* translators: deleted long text */
+                        $anonymous = __( 'This content was deleted by the author.' );
+                        break;
+                default:
+                        $anonymous = '';
+        }
+
+        /**
+         * Filters the anonymous data for each type.
+         *
+         * @since 4.9.6
+         *
+         * @param string $anonymous Anonymized data.
+         * @param string $type      Type of the data.
+         * @param string $data      Original data.
+         */
+        return apply_filters( 'wp_privacy_anonymize_data', $anonymous, $type, $data );
+}

branches/4.9/tests/phpunit/tests/admin/includesCommunityEvents.php

@@ -260 +260 @@
          * Test that get_unsafe_client_ip() properly anonymizes all possible address formats
          *
-         * @dataProvider data_get_unsafe_client_ip_anonymization
+         * @dataProvider data_get_unsafe_client_ip
          *
          * @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();
+        public function test_get_unsafe_client_ip( $raw_ip, $expected_result ) {
+                $_SERVER['REMOTE_ADDR']    = 'this should not be used';
+                $_SERVER['HTTP_CLIENT_IP'] = $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.
+        /**
+         * Provide test cases for `test_get_unsafe_client_ip()`.
+         *
+         * @return array
+         */
+        public function data_get_unsafe_client_ip() {
+                return array(
+                        // Handle '::' returned from `wp_privacy_anonymize_ip()`.
                         array(
-                                '',    // Raw IP address
-                                false, // Expected result
-                        ),
-                        // Invalid IP. Sometimes proxies add things like this, or other arbitrary strings.
+                                'or=\"[1000:0000:0000:0000:0000:0000:0000:0001',
+                                false,
+                        ),
+
+                        // Handle '0.0.0.0' returned from `wp_privacy_anonymize_ip()`.
                         array(
                                 'unknown',
                                 false,
                         ),
-                        // IPv4, no port
+
+                        // Valid IPv4.
                         array(
-                                '10.20.30.45',
-                                '10.20.30.0',
-                        ),
-                        // IPv4, port
-                        array(
-                                '10.20.30.45:20000',
-                                '10.20.30.0',
-                        ),
-                        // IPv6, no port
+                                '198.143.164.252',
+                                '198.143.164.0',
+                        ),
+
+                        // Valid IPv6.
                         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',
-                        ),
                 );
         }