add cache expiration for bad ip

Author: mobula9

docs/configuration-reference.md

@@ -23,8 +23,11 @@
        // Optional. Handle unknown remediations as. Select from 'bypass' (minimum remediation), 'captcha' or 'ban' (maximum remediation). Defaults to 'captcha'.
        'fallback_remediation'=> 'captcha',
 
-       // Optional. Set the duration we keep in cache the fact that an IP is clean. In seconds. Defaults to 60 (1 minute).
-       'cache_expiration_for_clean_ip'=> '60',
+       // Optional. Set the duration we keep in cache the fact that an IP is clean. In seconds. Defaults to 5.
+       'cache_expiration_for_clean_ip'=> '5',
+
+       // Optional. Set the duration we keep in cache the fact that an IP is bad. In seconds. Defaults to 20.
+       'cache_expiration_for_bad_ip'=> '20',
    ]
    $cacheAdapter = (...)
    $bouncer = new Bouncer();

examples/live-mode/full-example-live-mode.php

@@ -49,7 +49,8 @@
     'api_timeout' => 1,
     'live_mode' => true,
     'max_remediation_level' => 'ban',
-    'cache_expiration_for_clean_ip' => 1200
+    'cache_expiration_for_clean_ip' => 2,
+    'cache_expiration_for_bad_ip' => 30
 ], $cacheAdapter,);
 
 // Ask remediation to LAPI

src/ApiCache.php

@@ -34,6 +34,9 @@ class ApiCache
     /** @var int */
     private $cacheExpirationForCleanIp;
 
+    /** @var int */
+    private $cacheExpirationForBadIp;
+
     /** @var ApiClient */
     private $apiClient;
 
@@ -56,12 +59,14 @@ public function configure(
         int $timeout,
         string $userAgent,
         string $apiKey,
-        int $cacheExpirationForCleanIp
+        int $cacheExpirationForCleanIp,
+        int $cacheExpirationForBadIp
     ): void {
         $adapter = $adapter ?: new FilesystemAdapter();
         $this->adapter = $adapter;
         $this->liveMode = $liveMode;
         $this->cacheExpirationForCleanIp = $cacheExpirationForCleanIp;
+        $this->cacheExpirationForBadIp = $cacheExpirationForBadIp;
         $cacheConfigItem = $this->adapter->getItem('cacheConfig');
         $cacheConfig = $cacheConfigItem->get();
         $warmedUp = (is_array($cacheConfig) && isset($cacheConfig['warmed_up']) && $cacheConfig['warmed_up'] === true);
@@ -71,6 +76,7 @@ public function configure(
             'adapter' => get_class($adapter),
             'mode' => ($liveMode ? 'live' : 'stream'),
             'exp_clean_ips' => $cacheExpirationForCleanIp,
+            'exp_bad_ips' => $cacheExpirationForBadIp,
             'warmed_up' => ($this->warmedUp ? 'true' : 'false'),
         ]);
         $this->apiClient->configure($apiUrl, $timeout, $userAgent, $apiKey);
@@ -218,9 +224,11 @@ private function formatRemediationFromDecision(?array $decision): array
             return [Constants::REMEDIATION_BYPASS, time() + $this->cacheExpirationForCleanIp, 0];
         }
 
+        $duration = min($this->cacheExpirationForBadIp, self::parseDurationToSeconds($decision['duration']));
+
         return [
             $decision['type'], // ex: ban, captcha
-            time() + self::parseDurationToSeconds($decision['duration']), // expiration timestamp
+            time() + $duration, // expiration timestamp
             $decision['id'],
         ];
     }

src/Bouncer.php

@@ -69,7 +69,8 @@ public function configure(array $config, AbstractAdapter $cacheAdapter = null):
             $this->config['api_timeout'],
             $this->config['api_user_agent'],
             $this->config['api_key'],
-            $this->config['cache_expiration_for_clean_ip']
+            $this->config['cache_expiration_for_clean_ip'],
+            $this->config['cache_expiration_for_bad_ip']
         );
     }
 

src/Configuration.php

@@ -44,6 +44,9 @@ public function getConfigTreeBuilder()
             ->integerNode('cache_expiration_for_clean_ip')
             ->defaultValue(Constants::CACHE_EXPIRATION_FOR_CLEAN_IP)
             ->end()
+            ->integerNode('cache_expiration_for_bad_ip')
+            ->defaultValue(Constants::CACHE_EXPIRATION_FOR_BAD_IP)
+            ->end()
             ->end();
 
             // TODO P2 add "live_mode_max_cache_duration" to avoid manually cache clear in this use case:

src/Constants.php

@@ -27,6 +27,9 @@ class Constants
     /** @var int The duration we keep a clean IP in cache 5s */
     public const CACHE_EXPIRATION_FOR_CLEAN_IP = 5;
 
+    /** @var int The duration we keep a bad IP in cache 20s */
+    public const CACHE_EXPIRATION_FOR_BAD_IP = 20;
+
     /** @var string The ban remediation */
     public const REMEDIATION_BAN = 'ban';