Deprecate passing null as $requestIp to IpUtils::checkIp(), checkIp4() and checkIp6()

Author: W0rma

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 5.4
 ---
 
+ * Deprecate passing `null` as `$requestIp` to `IpUtils::__checkIp()`, `IpUtils::__checkIp4()` or `IpUtils::__checkIp6()`, pass an empty string instead.
  * Add the `litespeed_finish_request` method to work with Litespeed
  * Deprecate `upload_progress.*` and `url_rewriter.tags` session options
 

IpUtils.php

@@ -37,6 +37,8 @@ private function __construct()
     public static function checkIp(?string $requestIp, $ips)
     {
         if (null === $requestIp) {
+            trigger_deprecation('symfony/http-foundation', '5.4', 'Passing null as $requestIp to "%s()" is deprecated, pass an empty string instead.', __METHOD__);
+
             return false;
         }
 
@@ -65,6 +67,12 @@ public static function checkIp(?string $requestIp, $ips)
      */
     public static function checkIp4(?string $requestIp, string $ip)
     {
+        if (null === $requestIp) {
+            trigger_deprecation('symfony/http-foundation', '5.4', 'Passing null as $requestIp to "%s()" is deprecated, pass an empty string instead.', __METHOD__);
+
+            return false;
+        }
+
         $cacheKey = $requestIp.'-'.$ip;
         if (isset(self::$checkedIps[$cacheKey])) {
             return self::$checkedIps[$cacheKey];
@@ -112,6 +120,12 @@ public static function checkIp4(?string $requestIp, string $ip)
      */
     public static function checkIp6(?string $requestIp, string $ip)
     {
+        if (null === $requestIp) {
+            trigger_deprecation('symfony/http-foundation', '5.4', 'Passing null as $requestIp to "%s()" is deprecated, pass an empty string instead.', __METHOD__);
+
+            return false;
+        }
+
         $cacheKey = $requestIp.'-'.$ip;
         if (isset(self::$checkedIps[$cacheKey])) {
             return self::$checkedIps[$cacheKey];

RequestMatcher.php

@@ -185,7 +185,7 @@ public function matches(Request $request)
             return false;
         }
 
-        if (IpUtils::checkIp($request->getClientIp(), $this->ips)) {
+        if (IpUtils::checkIp($request->getClientIp() ?? '', $this->ips)) {
             return true;
         }
 

Tests/IpUtilsTest.php

@@ -12,10 +12,13 @@
 namespace Symfony\Component\HttpFoundation\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\HttpFoundation\IpUtils;
 
 class IpUtilsTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     /**
      * @dataProvider getIpv4Data
      */
@@ -40,7 +43,6 @@ public function getIpv4Data()
             [false, '1.2.3.4', '256.256.256/0'], // invalid CIDR notation
             [false, 'an_invalid_ip', '192.168.1.0/24'],
             [false, '', '1.2.3.4/1'],
-            [false, null, '1.2.3.4/1'],
         ];
     }
 
@@ -72,10 +74,36 @@ public function getIpv6Data()
             [false, '}__test|O:21:"JDatabaseDriverMysqli":3:{s:2', '::1'],
             [false, '2a01:198:603:0:396e:4789:8e99:890f', 'unknown'],
             [false, '', '::1'],
-            [false, null, '::1'],
         ];
     }
 
+    /**
+     * @group legacy
+     */
+    public function testIpTriggersDeprecationOnNull()
+    {
+        $this->expectDeprecation('Since symfony/http-foundation 5.4: Passing null as $requestIp to "Symfony\Component\HttpFoundation\IpUtils::checkIp()" is deprecated, pass an empty string instead.');
+        $this->assertFalse(IpUtils::checkIp(null, '192.168.1.1'));
+    }
+
+    /**
+     * @group legacy
+     */
+    public function testIp4TriggersDeprecationOnNull()
+    {
+        $this->expectDeprecation('Since symfony/http-foundation 5.4: Passing null as $requestIp to "Symfony\Component\HttpFoundation\IpUtils::checkIp4()" is deprecated, pass an empty string instead.');
+        $this->assertFalse(IpUtils::checkIp4(null, '192.168.1.1'));
+    }
+
+    /**
+     * @group legacy
+     */
+    public function testIp6TriggersDeprecationOnNull()
+    {
+        $this->expectDeprecation('Since symfony/http-foundation 5.4: Passing null as $requestIp to "Symfony\Component\HttpFoundation\IpUtils::checkIp6()" is deprecated, pass an empty string instead.');
+        $this->assertFalse(IpUtils::checkIp6(null, '2a01:198:603:0::/65'));
+    }
+
     /**
      * @requires extension sockets
      */