Add possibility to disable token validation

run-as-root · Jun 23, 2023 · 163061f · 163061f
1 parent 8833d6b
commit 163061f
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 10 deletions.
diff --git a/src/Controller/Index/Index.php b/src/Controller/Index/Index.php
@@ -31,16 +31,18 @@ public function __construct(
 
     public function execute(): ResultInterface
     {
-        $token = sprintf('Bearer %s', $this->config->getToken());
-        $authorizationHeader = $this->getRequest()->getHeader('Authorization');
-
-        if ($token !== $authorizationHeader) {
-            /** @var \Magento\Framework\Controller\Result\Raw $result */
-            $result = $this->resultFactory->create(ResultFactory::TYPE_RAW);
-            $result->setHttpResponseCode(Http::STATUS_CODE_401);
-            $result->setContents('You are not allowed to see these metrics.');
-
-            return $result;
+        if ($this->config->getTokenValidationEnabled()) {
+            $token = sprintf('Bearer %s', $this->config->getToken());
+            $authorizationHeader = $this->getRequest()->getHeader('Authorization');
+
+            if ($token !== $authorizationHeader) {
+                /** @var \Magento\Framework\Controller\Result\Raw $result */
+                $result = $this->resultFactory->create(ResultFactory::TYPE_RAW);
+                $result->setHttpResponseCode(Http::STATUS_CODE_401);
+                $result->setContents('You are not allowed to see these metrics.');
+
+                return $result;
+            }
         }
 
         return $this->prometheusResultFactory->create();

diff --git a/src/Data/Config.php b/src/Data/Config.php
@@ -12,6 +12,7 @@ class Config
 {
     private const CONFIG_PATH_METRICS_ENABLED = 'metric_configuration/metric/metric_status';
     private const CONFIG_PATH_AUTH_TOKEN = 'metric_configuration/security/token';
+    private const CONFIG_PATH_TOKEN_VALIDATION_ENABLED = 'metric_configuration/security/enable_token';
 
     private $config;
     private $metricsSource;
@@ -38,6 +39,11 @@ public function getDefaultMetrics(): array
         return array_column($this->metricsSource->toOptionArray(), 'value');
     }
 
+    public function getTokenValidationEnabled(?string $scopeCode = null): bool
+    {
+        return $this->config->isSetFlag(self::CONFIG_PATH_TOKEN_VALIDATION_ENABLED, ScopeInterface::SCOPE_STORE, $scopeCode);
+    }
+
     public function getToken(?string $scopeCode = null): string
     {
         return $this->config->getValue(self::CONFIG_PATH_AUTH_TOKEN, ScopeInterface::SCOPE_STORE, $scopeCode) ?? '';

diff --git a/src/etc/adminhtml/system.xml b/src/etc/adminhtml/system.xml
@@ -25,15 +25,25 @@
                 <label>Security Settings for the Prometheus Scrape Config</label>
                 <comment>This section contains security related configurations. We recommend using the Bearer Token in your Prometheus Scrape Config.</comment>
 
+                <field id="enable_token" showInWebsite="1" showInStore="1" showInDefault="1" type="select">
+                    <label>Enable token authorization</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
                 <field id="token" showInWebsite="1" showInStore="1" showInDefault="1" type="text">
                     <label>Token</label>
                     <frontend_model>RunAsRoot\PrometheusExporter\Block\Adminhtml\System\Config\DisabledText</frontend_model>
+                    <depends>
+                        <field id="metric_configuration/security/enable_token">1</field>
+                    </depends>
                 </field>
 
                 <field id="generate_auth_token" translate="button_label" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
                     <button_label>Generate</button_label>
                     <comment>Click 'Generate' to generate a random auth token, that you can use for your scrape config.</comment>
                     <frontend_model>RunAsRoot\PrometheusExporter\Block\Adminhtml\System\Config\TokenGenerator</frontend_model>
+                    <depends>
+                        <field id="metric_configuration/security/enable_token">1</field>
+                    </depends>
                 </field>
             </group>
         </section>