Merge pull request #80 from julienloizelet/feature/update-geoloc-and-cache-configs

Feature/update geoloc and cache configs

Author: julienloizelet

.github/dependabot.yml

@@ -5,3 +5,5 @@ updates:
   schedule:
     interval: monthly
   open-pull-requests-limit: 10
+  ignore:
+    - dependency-name: phpunit/phpunit

CHANGELOG.md

@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+
+## [0.20.0] - 2022-03-31
+
+### Changed
+- Require a minimum of 1 for `clean_ip_cache_duration` and `bad_ip_cache_duration` settings
+- Do not use session for geolocation if `save_in_session` setting is not true.
+
 ## [0.19.0] - 2022-03-24
 
 ### Added

docs/INSTALLATION_GUIDE.md

@@ -25,6 +25,7 @@
 ## Requirements
 
 - PHP >= 7.2
+- required php extensions : `ext-curl`, `ext-gd`
 
 ## Installation
 

src/Configuration.php

@@ -69,10 +69,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->scalarNode('redis_dsn')->end()
                 ->scalarNode('memcached_dsn')->end()
                 ->integerNode('clean_ip_cache_duration')
-                    ->defaultValue(Constants::CACHE_EXPIRATION_FOR_CLEAN_IP)
+                    ->min(1)->defaultValue(Constants::CACHE_EXPIRATION_FOR_CLEAN_IP)
                 ->end()
                 ->integerNode('bad_ip_cache_duration')
-                    ->defaultValue(Constants::CACHE_EXPIRATION_FOR_BAD_IP)
+                    ->min(1)->defaultValue(Constants::CACHE_EXPIRATION_FOR_BAD_IP)
                 ->end()
                 // Geolocation
                 ->arrayNode('geolocation')

src/Constants.php

@@ -20,7 +20,7 @@ class Constants
     public const DEFAULT_LAPI_URL = 'http://localhost:8080';
 
     /** @var string The last version of this library */
-    public const VERSION = 'v0.19.0';
+    public const VERSION = 'v0.20.0';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/'.self::VERSION;

src/Geolocation.php

@@ -76,14 +76,16 @@ public function getCountryResult(array $geolocConfig, string $ip): array
     {
         $result = $this->resultTemplate;
         $saveInSession = !empty($geolocConfig['save_in_session']);
-        if ($country = Session::getSessionVariable('crowdsec_geolocation_country')) {
-            $result['country'] = $country;
+        if ($saveInSession) {
+            if ($country = Session::getSessionVariable('crowdsec_geolocation_country')) {
+                $result['country'] = $country;
 
-            return $result;
-        } elseif ($notFoundError = Session::getSessionVariable('crowdsec_geolocation_not_found')) {
-            $result['not_found'] = $notFoundError;
+                return $result;
+            } elseif ($notFoundError = Session::getSessionVariable('crowdsec_geolocation_not_found')) {
+                $result['not_found'] = $notFoundError;
 
-            return $result;
+                return $result;
+            }
         }
         if (Constants::GEOLOCATION_TYPE_MAXMIND === $geolocConfig['type']) {
             $configPath = $geolocConfig[Constants::GEOLOCATION_TYPE_MAXMIND];

src/StandaloneBounce.php

@@ -30,7 +30,7 @@ class StandaloneBounce extends AbstractBounce implements IBounce
     /**
      * @var string
      */
-    const SESSION_NAME = 'crowdsec';
+    public const SESSION_NAME = 'crowdsec';
 
     /**
      * Initialize the bouncer.