Merge pull request #4 from interactive-solutions/blur-response-keys

Allow to filter values for keys when logging request

Author: awartoft

config/config.php.dist

@@ -18,6 +18,10 @@ return [
                     ElasticsearchAdapter::class,
                 ],
                 'alwaysLogRoutes' => [],
+                'blurredKeys' => [
+                    'password'
+                ],
+                'blurredKeysValue' => '***FILTERED***'
             ],
 
             ElasticsearchOptions::class => [

src/Options/LogHandlerOptions.php

@@ -22,6 +22,16 @@ final class LogHandlerOptions extends AbstractOptions
      */
     protected $alwaysLogRoutes = [];
 
+    /**
+     * @var array
+     */
+    protected $blurredKeys = ['password'];
+
+    /**
+     * @var string
+     */
+    protected $blurredKeysValue = '***FILTERED***';
+
     /**
      * @var array
      */
@@ -116,4 +126,36 @@ public function setHost(string $host)
     {
         $this->host = $host;
     }
+
+    /**
+     * @return array
+     */
+    public function getBlurredKeys(): array
+    {
+        return $this->blurredKeys;
+    }
+
+    /**
+     * @param array $blurredKeys
+     */
+    public function setBlurredKeys(array $blurredKeys)
+    {
+        $this->blurredKeys = $blurredKeys;
+    }
+
+    /**
+     * @return string
+     */
+    public function getBlurredKeysValue(): string
+    {
+        return $this->blurredKeysValue;
+    }
+
+    /**
+     * @param string $blurredKeysValue
+     */
+    public function setBlurredKeysValue(string $blurredKeysValue)
+    {
+        $this->blurredKeysValue = $blurredKeysValue;
+    }
 }

src/Service/LogHandlerService.php

@@ -97,8 +97,8 @@ public function handleRequestResponse(
                     'headers'    => $request->getHeaders()->toString(),
                     'routeMatch' => $routeMatch ? $routeMatch->getMatchedRouteName() : '',
                     'url'        => $request->getUriString(),
-                    'body'       => $request->getContent(),
-                    'query'      => $request->getQuery()->toString(),
+                    'body'       => $this->blurKeywords($request->getContent()),
+                    'query'      => $this->blurKeywords($request->getQuery()->toString()),
                     'method'     => $request->getMethod(),
                 ],
                 'response'    => [
@@ -127,6 +127,40 @@ public function getAdapters(): array
         return $this->adapters;
     }
 
+    /**
+     * Check if string contains keys that should be blurred out
+     * This will only check top-level
+     *
+     * @param string $body
+     * @return string
+     */
+    private function blurKeywords(string $body): string
+    {
+        try {
+            $isJson = true;
+            $bodyAsArray = Json::decode($body, true);
+        } catch (RuntimeException $e) {
+            $isJson = false;
+            parse_str($body, $bodyAsArray);
+        }
+
+        if (!is_array($bodyAsArray)) {
+            return $body;
+        }
+
+        foreach ($bodyAsArray as $key => $value) {
+            if (in_array($key, $this->options->getBlurredKeys(), false)) {
+                $bodyAsArray[$key] = $this->options->getBlurredKeysValue();
+            }
+        }
+
+        if ($isJson) {
+            return Json::encode($bodyAsArray);
+        }
+
+        return http_build_query($bodyAsArray);
+    }
+
     /**
      * Check if matched route should always be logged for http request/response
      *