Merge pull request #103 from julienloizelet/feat/disable-prod-log

Feat/disable prod log

Author: julienloizelet

CHANGELOG.md

@@ -5,6 +5,15 @@ 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.28.0] - 2022-08-04
+
+### Changed
+- *Breaking change*: Rename `ClientAbstract` class to `AbstractClient`
+- Hide `api_key` in log.
+
+### Added
+- Add `disable_prod_log` configuration 
+
 
 ## [0.27.0] - 2022-07-29
 

docs/USER_GUIDE.md

@@ -123,14 +123,15 @@ Here is the list of available settings:
 
 - `api_url`: Define the URL to your LAPI server, default to `http://localhost:8080`.
 
-- `api_timeout`: In seconds. The timeout when calling LAPI. Must be greater or equal than 1. Defaults to 1 sec.
+- `api_timeout`: In seconds. The timeout when calling LAPI. Must be greater or equal than 1. Default to 1 sec.
 
 - `use_curl`: By default, this lib call the REST LAPI using `file_get_contents` method (`allow_url_fopen` is required).
   You can set `use_curl` to `true` in order to use `cURL` request instead (`curl` is in then required)
 
 ##### Debug
-- `debug_mode`:true to enable verbose debug log.
+- `debug_mode`: `true` to enable verbose debug log. Default to `false`.
 
+- `disable_prod_log`: `true` to disable prod log. Default to `false`.
 
 - `log_directory_path`: Absolute path to store log files. Important note: be sur this path won't be publicly accessible
 

scripts/auto-prepend/settings.example.php

@@ -27,6 +27,8 @@
 
     // true to enable verbose debug log.
     'debug_mode' => false,
+    // true to disable prod log
+    'disable_prod_log' => false,
 
     /** Absolute path to store log files.
      *

src/AbstractBounce.php

@@ -135,10 +135,12 @@ protected function initLoggerHelper(array $configs, string $loggerName): void
 
         $this->logger = new Logger($loggerName);
         $logDir = $configs['log_directory_path']??__DIR__.'/.logs';
-        $logPath = $logDir . '/prod.log';
-        $fileHandler = new RotatingFileHandler($logPath, 0, Logger::INFO);
-        $fileHandler->setFormatter(new LineFormatter("%datetime%|%level%|%context%\n"));
-        $this->logger->pushHandler($fileHandler);
+        if (empty($configs['disable_prod_log'])) {
+            $logPath = $logDir . '/prod.log';
+            $fileHandler = new RotatingFileHandler($logPath, 0, Logger::INFO);
+            $fileHandler->setFormatter(new LineFormatter("%datetime%|%level%|%context%\n"));
+            $this->logger->pushHandler($fileHandler);
+        }
 
         // Set custom readable logger when debug=true
         if (!empty($configs['debug_mode'])) {

src/ApiClient.php

@@ -7,7 +7,7 @@
 use Psr\Log\LoggerInterface;
 use CrowdSecBouncer\RestClient\FileGetContents;
 use CrowdSecBouncer\RestClient\Curl;
-use CrowdSecBouncer\RestClient\ClientAbstract;
+use CrowdSecBouncer\RestClient\AbstractClient;
 
 /**
  * The LAPI REST Client. This is used to retrieve decisions.
@@ -27,7 +27,7 @@ class ApiClient
     private $configs;
 
     /**
-     * @var ClientAbstract
+     * @var AbstractClient
      */
     private $restClient;
 
@@ -88,7 +88,7 @@ public function getStreamedDecisions(
         );
     }
 
-    public function getRestClient(): ClientAbstract
+    public function getRestClient(): AbstractClient
     {
         return $this->restClient;
     }

src/Bouncer.php

@@ -6,7 +6,7 @@
 require_once __DIR__ . '/templates/access-forbidden.php';
 
 use CrowdSecBouncer\Fixes\Gregwar\Captcha\CaptchaBuilder;
-use CrowdSecBouncer\RestClient\ClientAbstract;
+use CrowdSecBouncer\RestClient\AbstractClient;
 use ErrorException;
 use Gregwar\Captcha\PhraseBuilder;
 use IPLib\Factory;
@@ -74,7 +74,7 @@ public function __construct(array $configs, LoggerInterface $logger = null)
             'type' => 'BOUNCER_INIT',
             'logger' => \get_class($this->logger),
             'max_remediation_level' => $this->maxRemediationLevelIndex,
-            'configs' => $this->configs
+            'configs' => array_merge($this->configs, ['api_key' => '***'])
         ]);
     }
 
@@ -317,7 +317,7 @@ public function getClient(): ApiClient
         return $this->getApiCache()->getClient();
     }
 
-    public function getRestClient(): ClientAbstract
+    public function getRestClient(): AbstractClient
     {
         return $this->getClient()->getRestClient();
     }

src/Configuration.php

@@ -40,6 +40,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->scalarNode('forced_test_ip')->defaultValue('')->end()
                 ->scalarNode('forced_test_forwarded_ip')->defaultValue('')->end()
                 ->booleanNode('debug_mode')->defaultValue(false)->end()
+                ->booleanNode('disable_prod_log')->defaultValue(false)->end()
                 ->scalarNode('log_directory_path')->end()
                 ->booleanNode('display_errors')->defaultValue(false)->end()
                 // Bouncer

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.27.0';
+    public const VERSION = 'v0.28.0';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/' . self::VERSION;

src/RestClient/ClientAbstract.php renamed to src/RestClient/AbstractClient.php

@@ -18,7 +18,7 @@
  * @copyright Copyright (c) 2020+ CrowdSec
  * @license   MIT License
  */
-abstract class ClientAbstract
+abstract class AbstractClient
 {
     /** @var int|mixed|null */
     protected $timeout = null;

src/RestClient/Curl.php

@@ -8,7 +8,7 @@
 
 use CrowdSecBouncer\BouncerException;
 
-class Curl extends ClientAbstract
+class Curl extends AbstractClient
 {
     /**
      * Send an HTTP request using cURL and parse its JSON result if any.

src/RestClient/FileGetContents.php

@@ -7,7 +7,7 @@
 use CrowdSecBouncer\BouncerException;
 use Psr\Log\LoggerInterface;
 
-class FileGetContents extends ClientAbstract
+class FileGetContents extends AbstractClient
 {
     /** @var string|null */
     private $headerString;