feat(*): Update mlocati/ip-lib dependency and remove deprecated methods

Author: julienloizelet

composer.json

@@ -34,7 +34,7 @@
         "symfony/cache": "^5.2",
         "monolog/monolog": "^1.17 || ^2.1",
         "gregwar/captcha": "^1.1",
-        "mlocati/ip-lib": "^1.14",
+        "mlocati/ip-lib": "^1.18",
         "geoip2/geoip2": "^2.12.2"
     },
     "require-dev": {

src/AbstractBounce.php

@@ -5,6 +5,8 @@
 require_once __DIR__.'/templates/captcha.php';
 require_once __DIR__.'/templates/access-forbidden.php';
 
+use Bramus\Monolog\Formatter\ColoredLineFormatter;
+use Exception;
 use IPLib\Factory;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\RotatingFileHandler;
@@ -50,6 +52,7 @@ protected function getArraySettings(string $name): array
 
     /**
      * Run a bounce.
+     * @throws Exception
      */
     public function run(
     ): void {
@@ -86,12 +89,15 @@ protected function initLoggerHelper($logDirectoryPath, $loggerName): void
             $debugLogPath = $logDirectoryPath.'/debug.log';
             $debugFileHandler = new RotatingFileHandler($debugLogPath, 0, Logger::DEBUG);
             if (class_exists('\Bramus\Monolog\Formatter\ColoredLineFormatter')) {
-                $debugFileHandler->setFormatter(new \Bramus\Monolog\Formatter\ColoredLineFormatter(null, "[%datetime%] %message% %context%\n", 'H:i:s'));
+                $debugFileHandler->setFormatter(new ColoredLineFormatter(null, "[%datetime%] %message% %context%\n", 'H:i:s'));
                 $this->logger->pushHandler($debugFileHandler);
             }
         }
     }
 
+    /**
+     * @throws Exception
+     */
     protected function bounceCurrentIp()
     {
         $ip = $this->getRemoteIp();
@@ -116,7 +122,7 @@ protected function bounceCurrentIp()
             $this->getBouncerInstance();
             $remediation = $this->bouncer->getRemediationForIp($ip);
             $this->handleRemediation($remediation, $ip);
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $this->logger->warning('', [
                 'type' => 'UNKNOWN_EXCEPTION_WHILE_BOUNCING',
                 'ip' => $ip,
@@ -133,7 +139,7 @@ protected function bounceCurrentIp()
 
     protected function shouldTrustXforwardedFor(string $ip): bool
     {
-        $comparableAddress = Factory::addressFromString($ip)->getComparableString();
+        $comparableAddress = Factory::parseAddressString($ip, 3)->getComparableString();
         if (null === $comparableAddress) {
             $this->logger->warning('', [
                 'type' => 'INVALID_INPUT_IP',
@@ -198,7 +204,7 @@ protected function handleCaptchaResolutionForm(string $ip)
         }
 
         // Handle image refresh.
-        if (null !== $this->getPostedVariable('refresh') && (bool) (int) $this->getPostedVariable('refresh')) {
+        if (null !== $this->getPostedVariable('refresh') && (int) $this->getPostedVariable('refresh')) {
             // Generate new captcha image for the user
             $this->storeNewCaptchaCoupleInSession();
             $this->setSessionVariable('crowdsec_captcha_resolution_failed', false);
@@ -213,7 +219,7 @@ protected function handleCaptchaResolutionForm(string $ip)
                 $this->getSessionVariable('crowdsec_captcha_phrase_to_guess'),
                 $this->getPostedVariable('phrase'),
                 $ip)) {
-                // User has correctly fill the captcha
+                // User has correctly filled the captcha
                 $this->setSessionVariable('crowdsec_captcha_has_to_be_resolved', false);
                 $this->unsetSessionVariable('crowdsec_captcha_phrase_to_guess');
                 $this->unsetSessionVariable('crowdsec_captcha_inline_image');
@@ -235,7 +241,7 @@ protected function handleCaptchaRemediation($ip)
         $this->handleCaptchaResolutionForm($ip);
 
         if (null === $this->getSessionVariable('crowdsec_captcha_has_to_be_resolved')) {
-            // Setup the first captcha remediation.
+            // Set up the first captcha remediation.
 
             $this->storeNewCaptchaCoupleInSession();
             $this->setSessionVariable('crowdsec_captcha_has_to_be_resolved', true);
@@ -257,16 +263,14 @@ protected function handleRemediation(string $remediation, string $ip)
             $this->clearCaptchaSessionContext();
         }
         switch ($remediation) {
-            case Constants::REMEDIATION_BYPASS:
-                return;
             case Constants::REMEDIATION_CAPTCHA:
                 $this->handleCaptchaRemediation($ip);
                 break;
             case Constants::REMEDIATION_BAN:
                 $this->handleBanRemediation();
                 break;
+            case Constants::REMEDIATION_BYPASS:
             default:
-                return;
         }
     }
 }

src/ApiCache.php

@@ -384,7 +384,7 @@ private function saveRemediations(array $decisions): array
             $id = $remediation[2];
 
             if (Constants::SCOPE_IP === $decision['scope']) {
-                $address = Factory::addressFromString($decision['value']);
+                $address = Factory::parseAddressString($decision['value'], 3);
                 if (null === $address) {
                     $this->logger->warning('', [
                         'type' => 'INVALID_IP_TO_ADD_FROM_REMEDIATION',
@@ -395,7 +395,7 @@ private function saveRemediations(array $decisions): array
                 $cacheKey = $this->getCacheKey($decision['scope'], $address->toString());
                 $this->addRemediationToCacheItem($cacheKey, $type, $exp, $id);
             } elseif (Constants::SCOPE_RANGE === $decision['scope']) {
-                $range = Subnet::fromString($decision['value']);
+                $range = Subnet::parseString($decision['value']);
 
                 $addressType = $range->getAddressType();
                 $isIpv6 = (Type::T_IPv6 === $addressType);
@@ -438,7 +438,7 @@ private function removeRemediations(array $decisions): array
         $count = 0;
         foreach ($decisions as $decision) {
             if (Constants::SCOPE_IP === $decision['scope']) {
-                $address = Factory::addressFromString($decision['value']);
+                $address = Factory::parseAddressString($decision['value'], 3);
                 if (null === $address) {
                     $this->logger->warning('', [
                         'type' => 'INVALID_IP_TO_REMOVE_FROM_REMEDIATION',
@@ -457,7 +457,7 @@ private function removeRemediations(array $decisions): array
                     ]);
                 }
             } elseif (Constants::SCOPE_RANGE === $decision['scope']) {
-                $range = Subnet::fromString($decision['value']);
+                $range = Subnet::parseString($decision['value']);
 
                 $addressType = $range->getAddressType();
                 $isIpv6 = (Type::T_IPv6 === $addressType);

src/Bouncer.php

@@ -8,6 +8,7 @@
 use CrowdSecBouncer\Fixes\Gregwar\Captcha\CaptchaBuilder;
 use Gregwar\Captcha\PhraseBuilder;
 use IPLib\Factory;
+use IPLib\ParseStringFlag;
 use Monolog\Handler\NullHandler;
 use Monolog\Logger;
 use Psr\Log\LoggerInterface;
@@ -109,7 +110,7 @@ private function capRemediationLevel(string $remediation): string
      */
     public function getRemediationForIp(string $ip): string
     {
-        $address = Factory::addressFromString($ip, false);
+        $address = Factory::parseAddressString($ip, ParseStringFlag::MAY_INCLUDE_ZONEID);
         if (null === $address) {
             throw new BouncerException("IP $ip format is invalid.");
         }