Merge pull request #103 from julienloizelet/feat/test-connexion-button

Feat/test connexion button

Author: julienloizelet

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+
+## [1.6.0] - 2022-06-30
+
+### Added
+- Add "Test bouncing" action in settings view
+
 ## [1.5.1] - 2022-06-24
 
 ### Added

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: 1.5.1
+ * Version: 1.6.0
  * Author: CrowdSec
  * Author URI: https://www.crowdsec.net/
  * Github: https://github.com/crowdsecurity/cs-wordpress-blocker
@@ -13,7 +13,7 @@
  * Requires PHP: 7.2
  * Requires at least: 4.9
  * Tested up to: 6.0
- * Stable tag: 1.5.1
+ * Stable tag: 1.6.0
  * Text Domain: crowdsec-wp
  * First release: 2021.
  */

docs/USER_GUIDE.md

@@ -96,6 +96,17 @@ mode makes it possible to never ban an IP but only to offer a Captcha, in the wo
 
 If enabled, the admin is not bounced.
 
+***
+
+`Test your settings`
+
+Click the "Test bouncing" button and the configured bouncer will try to get the remediation (bypass, captcha or ban) 
+for 
+the IP entered in the text field. By default, tested IP is the current detected remote IP.
+
+This test allows you to know if your connection, bouncing and cache settings are correct.
+
+
 ***
 
 

docs/images/screenshots/config-connection.jpg

@@ -104,6 +104,27 @@ function pruneBouncerCacheInAdminPage()
         }
     }
 
+    function testBouncerConnexionInAdminPage($ip)
+    {
+        try {
+            $settings = getDatabaseSettings();
+            $bouncer = getBouncerInstance($settings);
+            $remediation = $bouncer->getRemediationForIp($ip);
+            $message = __("Bouncing has been successfully tested for IP: $ip. Result is: $remediation.");
+
+            AdminNotice::displaySuccess($message);
+        } catch (BouncerException $e) {
+            getCrowdSecLoggerInstance()->error('', [
+                'type' => 'WP_EXCEPTION_WHILE_TESTING_CONNECTION',
+                'message' => $e->getMessage(),
+                'code' => $e->getCode(),
+                'file' => $e->getFile(),
+                'line' => $e->getLine(),
+            ]);
+            AdminNotice::displayError('Technical error while testing bouncer connection: '.$e->getMessage());
+        }
+    }
+
     // ACTIONS
     add_action('admin_post_crowdsec_clear_cache', function () {
         if (
@@ -132,6 +153,16 @@ function pruneBouncerCacheInAdminPage()
         header("Location: {$_SERVER['HTTP_REFERER']}");
         exit(0);
     });
+    add_action('admin_post_crowdsec_test_connection', function () {
+        if (
+            !isset($_POST['nonce']) || !wp_verify_nonce($_POST['nonce'], 'crowdsec_test_connection')) {
+            die('This link expired.');
+        }
+        $ip = isset($_POST['crowdsec_test_connection_ip']) ? $_POST['crowdsec_test_connection_ip'] : $_SERVER['REMOTE_ADDR'];
+        testBouncerConnexionInAdminPage($ip);
+        header("Location: {$_SERVER['HTTP_REFERER']}");
+        exit(0);
+    });
 
     // THEME
     add_action('admin_enqueue_scripts', function () {

inc/admin/init.php

@@ -25,7 +25,6 @@ function adminSettings()
     /************************************
      ** Section "Bouncing refinements" **
      ***********************************/
-
     add_settings_section('crowdsec_admin_boucing', 'Bouncing', function () {
         echo 'Refine bouncing according to your needs.';
     }, 'crowdsec_settings');

inc/admin/settings.php

@@ -8,6 +8,6 @@ function crowdsecDefineConstants(string $crowdsecRandomLogFolder)
         define('CROWDSEC_DEBUG_LOG_PATH', __DIR__."/../logs/$crowdsecRandomLogFolder/debug.log");
         define('CROWDSEC_CACHE_PATH', __DIR__.'/../.cache');
         define('CROWDSEC_CONFIG_PATH', __DIR__.'/standalone-settings.php');
-        define('CROWDSEC_BOUNCER_USER_AGENT', 'WordPress CrowdSec Bouncer/v1.5.1');
+        define('CROWDSEC_BOUNCER_USER_AGENT', 'WordPress CrowdSec Bouncer/v1.6.0');
     }
 }

inc/constants.php

@@ -12,6 +12,17 @@
                 submit_button();
                 ?>
 			</form>
+            <h2><?php echo __("Test your settings");?></h2>
+            <p><?php echo __("Here you can check if your saved settings are correct.");?></p>
+            <p><?php echo __("Click the 'Test bouncing' button and the bouncer will try to get the remediation for the following IP:");?></p>
+            <form action="admin-post.php" method="post" id="crowdsec_action_test_connection">
+                <input type="hidden" name="action" value="crowdsec_test_connection"/>
+                <input type="hidden" name="nonce" value="<?php echo wp_create_nonce('crowdsec_test_connection'); ?>"/>
+                <input type="text" name="crowdsec_test_connection_ip" value="<?php echo $_SERVER['REMOTE_ADDR'];?>"/>
+                <?php
+                submit_button('Test bouncing', 'secondary');
+                ?>
+            </form>
 			<p>
 			Feel free to ask any questions about this plugin, make your suggestions or raise issues on the <a href="https://wordpress.org/support/plugin/crowdsec/">plugin support page</a> or directly on <a href="https://github.com/crowdsecurity/cs-wordpress-bouncer/issues/new">Github</a>.
 			</p>

inc/templates/settings.php

@@ -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.0
-Stable tag: 1.5.1
+Stable tag: 1.6.0
 Requires PHP: 7.2
 License: MIT
 License URI: https://opensource.org/licenses/MIT

readme.txt

@@ -23,7 +23,7 @@
     "jest-playwright-preset": "^1.4.3",
     "jest-runner": "^26.6.3",
     "lodash": "^4.17.21",
-    "playwright-chromium": "^1.7.1",
+    "playwright-chromium": "1.22.2",
     "soap": "^0.42.0",
     "ws": "^7.4.6"
   }