bug #49141 [HttpFoundation] Fix bad return type in IpUtils::checkIp4() (tristankretzer)

nicolas-grekas · nicolas-grekas · commit b8c760401bcf · 2023-01-29T12:11:56.000+01:00
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [HttpFoundation] Fix bad return type in IpUtils::checkIp4() | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | see below | License | MIT | Doc PR | - `filter_var` returns the value if it passes the applied filters. This leads to `IpUtils::checkIp4()` returning the address part of the CIDR notation (instead of `true` which is expected) if it is a valid IPv4 address with subnet mask 0. This change fixes this behaviour. Commits ------- f694aa8 [HttpFoundation] Fix bad return type in IpUtils::checkIp4()
diff --git a/src/Symfony/Component/HttpFoundation/IpUtils.php b/src/Symfony/Component/HttpFoundation/IpUtils.php
@@ -86,7 +86,7 @@ public static function checkIp4(?string $requestIp, string $ip)
             [$address, $netmask] = explode('/', $ip, 2);
 
             if ('0' === $netmask) {
-                return self::$checkedIps[$cacheKey] = filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4);
+                return self::$checkedIps[$cacheKey] = false !== filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4);
             }
 
             if ($netmask < 0 || $netmask > 32) {
diff --git a/src/Symfony/Component/HttpFoundation/Tests/IpUtilsTest.php b/src/Symfony/Component/HttpFoundation/Tests/IpUtilsTest.php
@@ -164,4 +164,21 @@ public function anonymizedIpData()
             ['::123.234.235.236', '::123.234.235.0'], // deprecated IPv4-compatible IPv6 address
         ];
     }
+
+    /**
+     * @dataProvider getIp4SubnetMaskZeroData
+     */
+    public function testIp4SubnetMaskZero($matches, $remoteAddr, $cidr)
+    {
+        $this->assertSame($matches, IpUtils::checkIp4($remoteAddr, $cidr));
+    }
+
+    public function getIp4SubnetMaskZeroData()
+    {
+        return [
+            [true, '1.2.3.4', '0.0.0.0/0'],
+            [true, '1.2.3.4', '192.168.1.0/0'],
+            [false, '1.2.3.4', '256.256.256/0'], // invalid CIDR notation
+        ];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public static function checkIp4(?string $requestIp, string $ip)`
`86`	`86`	`[$address, $netmask] = explode('/', $ip, 2);`
`87`	`87`
`88`	`88`	`if ('0' === $netmask) {`
`89`		`- return self::$checkedIps[$cacheKey] = filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4);`
	`89`	`+ return self::$checkedIps[$cacheKey] = false !== filter_var($address, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4);`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`if ($netmask < 0 \|\| $netmask > 32) {`