Changeset 39296

Timestamp:

11/18/2016 07:32:03 PM (8 years ago)

Author:

joehoyle

Message:

REST API: Change “ipv4” types to “ip” to support ipv6.

Stop presuming IP address are IPv4, instead make the type “ip” to be agnostic of IP version. This fixes requests with ipv6 addresses for comments in core.

Props dd32, schlessera, danielbachhuber.
Fixes #38818.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-sanitization.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-validation.php (modified) (1 diff)

trunk/src/wp-includes/rest-api.php

@@ -870 +870 @@
 
 /**
- * Determines if a IPv4 address is valid.
- *
- * Does not handle IPv6 addresses.
+ * Determines if an IP address is valid.
+ *
+ * Handles both IPv4 and IPv6 addresses.
  *
  * @since 4.7.0
  *
- * @param  string $ipv4 IP 32-bit address.
- * @return string|false The valid IPv4 address, otherwise false.
- */
-function rest_is_ip_address( $ipv4 ) {
-    $pattern = '/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/';
-
-    if ( ! preg_match( $pattern, $ipv4 ) ) {
+ * @param  string $ip IP address.
+ * @return string|false The valid IP address, otherwise false.
+ */
+function rest_is_ip_address( $ip ) {
+    $ipv4_pattern = '/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/';
+
+    if ( ! preg_match( $ipv4_pattern, $ip ) && ! Requests_IPv6::check_ipv6( $ip ) ) {
         return false;
     }
 
-    return $ipv4;
+    return $ip;
 }
 
@@ -1054 +1054 @@
                 }
                 break;
-            case 'ipv4' :
+            case 'ip' :
                 if ( ! rest_is_ip_address( $value ) ) {
-                    /* translators: %s: IP address */ 
+                    /* translators: %s: IP address */
                     return new WP_Error( 'rest_invalid_param', sprintf( __( '%s is not a valid IP address.' ), $value ) );
                 }
@@ -1157 +1157 @@
                 return esc_url_raw( $value );
 
-            case 'ipv4' :
+            case 'ip' :
                 return sanitize_text_field( $value );
         }

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -1116 +1116 @@
                     'description'  => __( 'IP address for the object author.' ),
                     'type'         => 'string',
-                    'format'       => 'ipv4',
+                    'format'       => 'ip',
                     'context'      => array( 'edit' ),
                     'default'      => '127.0.0.1',

trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php

@@ -64 +64 @@
         $this->assertEquals( 'a@b.c', rest_sanitize_value_from_schema( 'a@b.c', $schema ) );
         $this->assertEquals( 'invalid', rest_sanitize_value_from_schema( 'invalid', $schema ) );
+    }
+
+    public function test_format_ip() {
+        $schema = array(
+            'type'  => 'string',
+            'format' => 'ip',
+        );
+
+        $this->assertEquals( '127.0.0.1', rest_sanitize_value_from_schema( '127.0.0.1', $schema ) );
+        $this->assertEquals( 'hello', rest_sanitize_value_from_schema( 'hello', $schema ) );
+        $this->assertEquals( '2001:DB8:0:0:8:800:200C:417A', rest_sanitize_value_from_schema( '2001:DB8:0:0:8:800:200C:417A', $schema ) );
     }
 

trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php

@@ -84 +84 @@
     }
 
-    public function test_format_ipv4() {
+    public function test_format_ip() {
         $schema = array(
             'type'  => 'string',
-            'format' => 'ipv4',
+            'format' => 'ip',
         );
+
+        // IPv4.
         $this->assertTrue( rest_validate_value_from_schema( '127.0.0.1', $schema ) );
         $this->assertWPError( rest_validate_value_from_schema( '3333.3333.3333.3333', $schema ) );
         $this->assertWPError( rest_validate_value_from_schema( '1', $schema ) );
+
+        // IPv6.
+        $this->assertTrue( rest_validate_value_from_schema( '::1', $schema ) ); // Loopback, compressed, non-routable.
+        $this->assertTrue( rest_validate_value_from_schema( '::', $schema ) ); // Unspecified, compressed, non-routable.
+        $this->assertTrue( rest_validate_value_from_schema( '0:0:0:0:0:0:0:1', $schema ) ); // Loopback, full.
+        $this->assertTrue( rest_validate_value_from_schema( '0:0:0:0:0:0:0:0', $schema ) ); // Unspecified, full.
+        $this->assertTrue( rest_validate_value_from_schema( '2001:DB8:0:0:8:800:200C:417A', $schema ) ); // Unicast, full.
+        $this->assertTrue( rest_validate_value_from_schema( 'FF01:0:0:0:0:0:0:101', $schema ) ); // Multicast, full.
+        $this->assertTrue( rest_validate_value_from_schema( '2001:DB8::8:800:200C:417A', $schema ) ); // Unicast, compressed.
+        $this->assertTrue( rest_validate_value_from_schema( 'FF01::101', $schema ) ); // Multicast, compressed.
+        $this->assertTrue( rest_validate_value_from_schema( 'fe80::217:f2ff:fe07:ed62', $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( '', $schema ) ); // Empty string.
+        $this->assertWPError( rest_validate_value_from_schema( '2001:DB8:0:0:8:800:200C:417A:221', $schema ) ); // Unicast, full.
+        $this->assertWPError( rest_validate_value_from_schema( 'FF01::101::2', $schema ) ); // Multicast, compressed.
     }