CIRC-9167 base64 encode variable values when they're replaced inside …

…other variable queries
circonus-labs · Sep 15, 2022 · 71291ae · 71291ae
1 parent 800fb63
commit 71291ae
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 35 deletions.
diff --git a/dist/module.js b/dist/module.js
diff --git a/dist/module.js.map b/dist/module.js.map
diff --git a/dist/plugin.json b/dist/plugin.json
@@ -21,8 +21,8 @@
             { "name": "Project site", "url": "https://www.circonus.com/irondb/" },
             { "name": "License", "url": "https://github.com/circonus-labs/circonusllhist/blob/master/LICENSE" }
         ],
-        "version": "0.9.21",
-        "updated": "2022-08-09"
+        "version": "0.9.23",
+        "updated": "2022-09-15"
     },
 
     "dependencies": {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "circonus-irondb-datasource",
-    "version": "0.9.22",
+    "version": "0.9.23",
     "description": "IRONdb Data Source for Grafana.",
     "scripts": {
         "build": "grafana-toolkit plugin:build",

diff --git a/src/datasource.ts b/src/datasource.ts
@@ -498,30 +498,6 @@ export default class IrondbDatasource extends DataSourceApi<IrondbQueryInterface
         });
     }
 
-    interpolateExpr(value: string | string[] = [], variable: any) {
-        // if no multi or include all do not regexEscape
-        if (!variable.multi && !variable.includeAll) {
-            return value;
-        }
-
-        if (typeof value === 'string') {
-            return value;
-        }
-
-        if (value.length === 1) {
-            return value[0];
-        }
-
-        let q = '';
-        for (let i = 0; i < value.length; i++) {
-            if (i > 0) {
-                q = q + ',';
-            }
-            q = q + value[i];
-            i = i + 1;
-        }
-        return q;
-    }
 
     // This is used to load variable values (in the dashboard config variable setup
     // and also whenever refreshing variable values when viewing a dashboard.
@@ -582,7 +558,9 @@ export default class IrondbDatasource extends DataSourceApi<IrondbQueryInterface
         if (q !== undefined) {
             const queryType = (q && q.queryType) || (q.tagCategory ? 'tag values' : 'metric names');
             const resultsLimit = (q && q.resultsLimit) || 100;
-            let metricQuery = this.templateSrv.replace(q.metricFindQuery, null, this.interpolateExpr);
+            //let metricQuery = this.templateSrv.replace(q.metricFindQuery, null, this.processVariableValue);
+            let self = this;
+            let metricQuery = this.templateSrv.replace(q.metricFindQuery, null, (value: string | string[] = [], variable: any) => { return self.processVariableValue(value, variable); });
 
             if (
                 'graphite style' !== queryType &&
@@ -707,12 +685,22 @@ export default class IrondbDatasource extends DataSourceApi<IrondbQueryInterface
     }
 
     decodeBase64(str) {
-        if (/^b(["!]{1}).+\1$/.test(str)) {
+        var is_encoded = /^b(["!]{1}).+\1$/.test(str);
+        if (is_encoded) {
             str = atob(str.slice(2, str.length - 1));
         }
         return str;
     }
 
+    encodeBase64(str) {
+        var is_encoded           = /^b(["!]{1}).+\1$/.test(str),
+            has_disallowed_chars = /[^`+A-Za-z0-9!@#\$%^&"'\/\?\._\*-]/.test(str);
+        if (!is_encoded && has_disallowed_chars) {
+            str = 'b"'+ btoa(str) +'"';
+        }
+        return str;
+    }
+
     getAccountId() {
         return this.irondbType === 'standalone' ? '/' + this.accountId : '';
     }
@@ -1468,6 +1456,32 @@ export default class IrondbDatasource extends DataSourceApi<IrondbQueryInterface
         });
     }
 
+    // process a variable value during the nested variable replacement process
+    processVariableValue(value: string | string[] = [], variable: any) {
+        // if no multi or include all do not regexEscape
+        if (!variable.multi && !variable.includeAll) {
+            return this.encodeBase64(value);
+        }
+
+        if (typeof value === 'string') {
+            return this.encodeBase64(value);
+        }
+
+        if (value.length === 1) {
+            return this.encodeBase64(value[0]);
+        }
+
+        let q = '';
+        for (let i = 0; i < value.length; i++) {
+            if (i > 0) {
+                q = q + ',';
+            }
+            q = q + value[i];
+            i = i + 1;
+        }
+        return q;
+    }
+
     static readonly MAX_DATAPOINTS_THRESHOLD = 1.5;
     static readonly MAX_EXACT_DATAPOINTS_THRESHOLD = 1.5;
     static readonly MIN_DURATION_MS_FETCH = 1;
@@ -2035,9 +2049,9 @@ export default class IrondbDatasource extends DataSourceApi<IrondbQueryInterface
             let valRegExp;
             try {
                 let slashedVal = slashifyCharsRegExp.test(val) ? val.replace(slashifyCharsRegExp, '\\$1') : val;
-                valRegExp = new RegExp(':' + slashedVal, 'g');
+                valRegExp = new RegExp(':'+ slashedVal, 'g');
                 if (valRegExp.test(query)) {
-                    query = query.replace(valRegExp, ':b"' + btoa(val) + '"');
+                    query = query.replace(valRegExp, ':'+ this.encodeBase64(val));
                 }
             } catch (e) {}
         });

diff --git a/src/plugin.json b/src/plugin.json
@@ -21,8 +21,8 @@
             { "name": "Project site", "url": "https://www.circonus.com/irondb/" },
             { "name": "License", "url": "https://github.com/circonus-labs/circonusllhist/blob/master/LICENSE" }
         ],
-        "version": "0.9.22",
-        "updated": "2022-08-10"
+        "version": "0.9.23",
+        "updated": "2022-09-15"
     },
 
     "dependencies": {