Merge pull request #130 from julienloizelet/fix/throw-if-instantiated

julienloizelet · web-flow · commit 66d2cc2e72ac · 2023-02-16T15:04:29.000+09:00
fix(error): error is thrown only if bouncer has been successfully ins…
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [2.0.3](https://github.com/crowdsecurity/cs-wordpress-bouncer/releases/tag/v2.0.3) - 2023-02-16
+[_Compare with previous release_](https://github.com/crowdsecurity/cs-wordpress-bouncer/compare/v2.0.2...v2.0.3)
+
+### Fixed
+- If `display_errors` setting is `true`, error is thrown only if bouncer has been successfully instantiated
+
+---
+
 ## [2.0.2](https://github.com/crowdsecurity/cs-wordpress-bouncer/releases/tag/v2.0.2) - 2023-02-16
 [_Compare with previous release_](https://github.com/crowdsecurity/cs-wordpress-bouncer/compare/v2.0.1...v2.0.2)
 
diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
 		}
 	},
 	"require": {
-		"crowdsec/bouncer": "^1.0.1",
+		"crowdsec/bouncer": "^1.1.1",
 		"symfony/polyfill-mbstring": "1.20.0",
 		"symfony/service-contracts": "2.4.1"
 	},
diff --git a/composer.lock b/composer.lock
diff --git a/crowdsec.php b/crowdsec.php
@@ -4,7 +4,7 @@
  * Plugin URI: https://github.com/crowdsecurity/cs-wordpress-bouncer
  * Description: Safer Together. Protect your WordPress application with CrowdSec.
  * Tags: crowdsec-bouncer, wordpress, security, firewall, captcha, ip-scanner, ip-blocker, ip-blocking, ip-address, ip-database, ip-range-check, crowdsec, ban-hosts, ban-management, anti-hacking, hacker-protection, captcha-image, captcha-generator, captcha-generation, captcha-service
- * Version: 2.0.2
+ * Version: 2.0.3
  * Author: CrowdSec
  * Author URI: https://www.crowdsec.net/
  * Github: https://github.com/crowdsecurity/cs-wordpress-bouncer
@@ -13,7 +13,7 @@
  * Requires PHP: 7.2
  * Requires at least: 4.9
  * Tested up to: 6.1
- * Stable tag: 2.0.2
+ * Stable tag: 2.0.3
  * Text Domain: crowdsec-wp
  * First release: 2021.
  */
diff --git a/inc/Constants.php b/inc/Constants.php
@@ -20,7 +20,7 @@ class Constants extends LibConstants
     public const LOG_BASE_PATH = __DIR__ . '/../logs/';
     public const CACHE_PATH = __DIR__ . '/../.cache';
     public const CONFIG_PATH = __DIR__ . '/standalone-settings.php';
-    public const VERSION = 'v2.0.2';
+    public const VERSION = 'v2.0.3';
     public const GEOLOCATION_DIR = __DIR__ . '/../geolocation';
     public const TLS_DIR = __DIR__ . '/../tls';
 }
diff --git a/inc/bounce-current-ip.php b/inc/bounce-current-ip.php
@@ -29,8 +29,9 @@ function safelyBounceCurrentIp()
                               ' in file:' . $e->getFile() .
                               '(line ' . $e->getLine() . ')', true
             ));
+            return;
         }
-        $displayErrors =  (bool)($crowdSecConfigs['crowdsec_display_errors'] ?? false);
+        $displayErrors =  $bouncer->getConfig('display_errors');
         if (true === $displayErrors) {
             throw new BouncerException($e->getMessage(), $e->getCode(), $e);
         }
diff --git a/inc/standalone-bounce.php b/inc/standalone-bounce.php
@@ -24,8 +24,9 @@
                           ' in file:' . $e->getFile() .
                           '(line ' . $e->getLine() . ')', true
         ));
+        return;
     }
-    $displayErrors =  (bool)($crowdSecConfigs['crowdsec_display_errors'] ?? false);
+    $displayErrors =  $bouncer->getConfig('display_errors');
     if (true === $displayErrors) {
         throw new BouncerException($e->getMessage(), $e->getCode(), $e);
     }
diff --git a/readme.txt b/readme.txt
@@ -4,7 +4,7 @@ Donate link: https://crowdsec.net/
 Tags: crowdsec-bouncer, wordpress, security, firewall, captcha, ip-scanner, ip-blocker, ip-blocking, ip-address, ip-database, ip-range-check, crowdsec, ban-hosts, ban-management, anti-hacking, hacker-protection, captcha-image, captcha-generator, captcha-generation, captcha-service
 Requires at least: 4.9
 Tested up to: 6.1
-Stable tag: 2.0.2
+Stable tag: 2.0.3
 Requires PHP: 7.2
 License: MIT
 License URI: https://opensource.org/licenses/MIT
diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json
@@ -81,17 +81,17 @@
         },
         {
             "name": "crowdsec/bouncer",
-            "version": "v1.0.1",
-            "version_normalized": "1.0.1.0",
+            "version": "v1.1.1",
+            "version_normalized": "1.1.1.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/crowdsecurity/php-cs-bouncer.git",
-                "reference": "c508c199a2f5778d878117cf52321df4c8fcbefb"
+                "reference": "f132937b62fbae5efb72c6666afe74de168b16f6"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/crowdsecurity/php-cs-bouncer/zipball/c508c199a2f5778d878117cf52321df4c8fcbefb",
-                "reference": "c508c199a2f5778d878117cf52321df4c8fcbefb",
+                "url": "https://api.github.com/repos/crowdsecurity/php-cs-bouncer/zipball/f132937b62fbae5efb72c6666afe74de168b16f6",
+                "reference": "f132937b62fbae5efb72c6666afe74de168b16f6",
                 "shasum": ""
             },
             "require": {
@@ -109,7 +109,7 @@
                 "mikey179/vfsstream": "^1.6.11",
                 "phpunit/phpunit": "^8.5.30 || ^9.3"
             },
-            "time": "2023-02-10T08:18:52+00:00",
+            "time": "2023-02-16T05:36:26+00:00",
             "type": "library",
             "installation-source": "dist",
             "autoload": {
@@ -148,7 +148,7 @@
             ],
             "support": {
                 "issues": "https://github.com/crowdsecurity/php-cs-bouncer/issues",
-                "source": "https://github.com/crowdsecurity/php-cs-bouncer/tree/v1.0.1"
+                "source": "https://github.com/crowdsecurity/php-cs-bouncer/tree/v1.1.1"
             },
             "install-path": "../crowdsec/bouncer"
         },
diff --git a/vendor/composer/installed.php b/vendor/composer/installed.php
@@ -3,7 +3,7 @@
         'name' => 'crowdsec/wordpress-bouncer',
         'pretty_version' => 'dev-main',
         'version' => 'dev-main',
-        'reference' => 'de6e91744a5574837c9ca5def6e81a70fc213ee1',
+        'reference' => 'd0113a72084f888ce5523938728e75c9e88ba22d',
         'type' => 'project',
         'install_path' => __DIR__ . '/../../',
         'aliases' => array(),
@@ -20,9 +20,9 @@
             'dev_requirement' => false,
         ),
         'crowdsec/bouncer' => array(
-            'pretty_version' => 'v1.0.1',
-            'version' => '1.0.1.0',
-            'reference' => 'c508c199a2f5778d878117cf52321df4c8fcbefb',
+            'pretty_version' => 'v1.1.1',
+            'version' => '1.1.1.0',
+            'reference' => 'f132937b62fbae5efb72c6666afe74de168b16f6',
             'type' => 'library',
             'install_path' => __DIR__ . '/../crowdsec/bouncer',
             'aliases' => array(),
@@ -67,7 +67,7 @@
         'crowdsec/wordpress-bouncer' => array(
             'pretty_version' => 'dev-main',
             'version' => 'dev-main',
-            'reference' => 'de6e91744a5574837c9ca5def6e81a70fc213ee1',
+            'reference' => 'd0113a72084f888ce5523938728e75c9e88ba22d',
             'type' => 'project',
             'install_path' => __DIR__ . '/../../',
             'aliases' => array(),
diff --git a/vendor/crowdsec/bouncer/src/AbstractBouncer.php b/vendor/crowdsec/bouncer/src/AbstractBouncer.php
@@ -84,6 +84,9 @@ public function bounceCurrentIp(): void
         $forcedTestIp = $this->getConfig('forced_test_ip');
         $ip = $forcedTestIp ?: $this->getRemoteIp();
         $ip = $this->handleForwardedFor($ip, $this->configs);
+        $this->logger->info('Bouncing current IP', [
+            'ip' => $ip,
+        ]);
         $remediation = $this->getRemediationForIp($ip);
         $this->handleRemediation($remediation, $ip);
     }
@@ -359,6 +362,9 @@ protected function handleRemediation(string $remediation, string $ip): void
                 $this->handleCaptchaRemediation($ip);
                 break;
             case Constants::REMEDIATION_BAN:
+                $this->logger->debug('Will display a ban wall', [
+                    'ip' => $ip,
+                ]);
                 $this->handleBanRemediation();
                 break;
             case Constants::REMEDIATION_BYPASS:
@@ -454,11 +460,19 @@ private function capRemediationLevel(string $remediation): string
             $maxRemediationLevel,
             $orderedRemediations
         );
+        $finalRemediation = $remediation;
         if ($currentIndex < $maxIndex) {
-            return $orderedRemediations[$maxIndex];
+            $finalRemediation = $orderedRemediations[$maxIndex];
+            $this->logger->debug('Original remediation has been capped', [
+                'origin' => $remediation,
+                'final' => $finalRemediation
+            ]);
         }
+        $this->logger->info('Final remediation', [
+            'remediation' => $finalRemediation,
+        ]);
 
-        return $remediation;
+        return $finalRemediation;
     }
 
     /**
@@ -614,13 +628,22 @@ private function handleCaptchaRemediation(string $ip): void
         if (null === $cachedCaptchaVariables['has_to_be_resolved']) {
             // Set up the first captcha remediation.
             $mustResolve = true;
+            $this->logger->debug('First captcha resolution', [
+                'ip' => $ip,
+            ]);
             $this->initCaptchaResolution($ip);
         }
 
         // Display captcha page if this is required.
         if ($cachedCaptchaVariables['has_to_be_resolved'] || $mustResolve) {
+            $this->logger->debug('Will display a captcha wall', [
+                'ip' => $ip,
+            ]);
             $this->displayCaptchaWall($ip);
         }
+        $this->logger->info('Captcha wall is not required (already solved)', [
+            'ip' => $ip,
+        ]);
     }
 
     /**
diff --git a/vendor/crowdsec/bouncer/src/Constants.php b/vendor/crowdsec/bouncer/src/Constants.php
@@ -39,7 +39,7 @@ class Constants extends RemConstants
     /** @var string Path for html templates folder (e.g. ban and captcha wall) */
     public const TEMPLATES_DIR = __DIR__ . "/templates";
     /** @var string The last version of this library */
-    public const VERSION = 'v1.0.1';
+    public const VERSION = 'v1.1.1';
     /** @var string The "disabled" x-forwarded-for setting */
     public const X_FORWARDED_DISABLED = 'no_forward';
 }

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`}`
`20`	`20`	`},`
`21`	`21`	`"require": {`
`22`		`- "crowdsec/bouncer": "^1.0.1",`
	`22`	`+ "crowdsec/bouncer": "^1.1.1",`
`23`	`23`	`"symfony/polyfill-mbstring": "1.20.0",`
`24`	`24`	`"symfony/service-contracts": "2.4.1"`
`25`	`25`	`},`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class Constants extends LibConstants`
`20`	`20`	`public const LOG_BASE_PATH = __DIR__ . '/../logs/';`
`21`	`21`	`public const CACHE_PATH = __DIR__ . '/../.cache';`
`22`	`22`	`public const CONFIG_PATH = __DIR__ . '/standalone-settings.php';`
`23`		`- public const VERSION = 'v2.0.2';`
	`23`	`+ public const VERSION = 'v2.0.3';`
`24`	`24`	`public const GEOLOCATION_DIR = __DIR__ . '/../geolocation';`
`25`	`25`	`public const TLS_DIR = __DIR__ . '/../tls';`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,9 @@ function safelyBounceCurrentIp()`
`29`	`29`	`' in file:' . $e->getFile() .`
`30`	`30`	`'(line ' . $e->getLine() . ')', true`
`31`	`31`	`));`
	`32`	`+ return;`
`32`	`33`	`}`
`33`		`- $displayErrors = (bool)($crowdSecConfigs['crowdsec_display_errors'] ?? false);`
	`34`	`+ $displayErrors = $bouncer->getConfig('display_errors');`
`34`	`35`	`if (true === $displayErrors) {`
`35`	`36`	`throw new BouncerException($e->getMessage(), $e->getCode(), $e);`
`36`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,9 @@`
`24`	`24`	`' in file:' . $e->getFile() .`
`25`	`25`	`'(line ' . $e->getLine() . ')', true`
`26`	`26`	`));`
	`27`	`+ return;`
`27`	`28`	`}`
`28`		`- $displayErrors = (bool)($crowdSecConfigs['crowdsec_display_errors'] ?? false);`
	`29`	`+ $displayErrors = $bouncer->getConfig('display_errors');`
`29`	`30`	`if (true === $displayErrors) {`
`30`	`31`	`throw new BouncerException($e->getMessage(), $e->getCode(), $e);`
`31`	`32`	`}`