Update to v2.7.2 (#475)

* fix secrets stored in JSON format

* add more tests

* fix lint and pass token to build

* add test cases

* add debug

* fix ordering of build steps

* fix test string format

* update test check

* fix test string format

* final cleanup

* remove comment

* remove unused var assignment

* simplify more

* simplify code and add more comments

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 * Add changes here
 
+## 2.7.2 (July 6, 2023)
+
+Bugs:
+
+* Fix a regression that broke support for secrets in JSON format [GH-473](https://github.com/hashicorp/vault-action/pull/473)
+
 ## 2.7.1 (July 3, 2023)
 
 Bugs:

dist/index.js

@@ -19004,12 +19004,13 @@ async function getSecrets(secretRequests, client) {
 
 /**
  * Uses a Jsonata selector retrieve a bit of data from the result
- * @param {object} data 
- * @param {string} selector 
+ * @param {object} data
+ * @param {string} selector
  */
 async function selectData(data, selector) {
     const ata = jsonata(selector);
     let result = JSON.stringify(await ata.evaluate(data));
+
     // Compat for custom engines
     if (!result && ((ata.ast().type === "path" && ata.ast()['steps'].length === 1) || ata.ast().type === "string") && selector !== 'data' && 'data' in data) {
         result = JSON.stringify(await jsonata(`data.${selector}`).evaluate(data));
@@ -19018,7 +19019,18 @@ async function selectData(data, selector) {
     }
 
     if (result.startsWith(`"`)) {
+        // Support multi-line secrets like JSON strings and ssh keys, see https://github.com/hashicorp/vault-action/pull/173
+        // Deserialize the value so that newlines and special characters are
+        // not escaped in our return value.
         result = JSON.parse(result);
+    } else {
+        // Support secrets stored in Vault as pure JSON, see https://github.com/hashicorp/vault-action/issues/194
+        // Serialize the value so that any special characters in the data are
+        // properly escaped.
+        result = JSON.stringify(result);
+        // strip the surrounding quotes added by stringify because the data did
+        // not have them in the first place
+        result = result.substring(1, result.length - 1);
     }
     return result;
 }
@@ -19028,6 +19040,7 @@ module.exports = {
     selectData
 }
 
+
 /***/ }),
 
 /***/ 9491:

src/action.test.js

@@ -224,7 +224,7 @@ describe('exportSecrets', () => {
         const jsonData = {"x":1,"y":2};
 
         // for secrets stored in Vault as pure JSON, we call stringify twice
-        // and remove the added surrounding quotes
+        // and remove the surrounding quotes
         let result = JSON.stringify(JSON.stringify(jsonData));
         result = result.substring(1, result.length - 1);
 

src/secrets.js

@@ -67,95 +67,37 @@ async function getSecrets(secretRequests, client) {
 
 /**
  * Uses a Jsonata selector retrieve a bit of data from the result
- * @param {object} data 
- * @param {string} selector 
+ * @param {object} data
+ * @param {string} selector
  */
 async function selectData(data, selector) {
     const ata = jsonata(selector);
-    let d = await ata.evaluate(data);
-
-    console.log(selector)
-    // If we have a Javascript Object, then this data was stored in Vault as
-    // pure JSON (not a JSON string)
-    const storedAsJSONData = isObject(d);
-
-    // if (isJSONString(d)) {
-        // If we already have a JSON string we will not "stringify" it yet so
-        // that we don't end up calling JSON.parse. This would break the
-        // secrets that are stored as pure JSON. See: https://github.com/hashicorp/vault-action/issues/194
-        // result = d;
-    // } else {
-        result = jsonstringify(d, 0);
-    // }
+    let result = JSON.stringify(await ata.evaluate(data));
 
     // Compat for custom engines
     if (!result && ((ata.ast().type === "path" && ata.ast()['steps'].length === 1) || ata.ast().type === "string") && selector !== 'data' && 'data' in data) {
-        result = jsonstringify(await jsonata(`data.${selector}`).evaluate(data), 1);
+        result = JSON.stringify(await jsonata(`data.${selector}`).evaluate(data));
     } else if (!result) {
         throw Error(`Unable to retrieve result for ${selector}. No match data was found. Double check your Key or Selector.`);
     }
 
     if (result.startsWith(`"`)) {
-        // we need to strip the beginning and ending quotes otherwise it will
-        // always successfully parse as a JSON string
+        // Support multi-line secrets like JSON strings and ssh keys, see https://github.com/hashicorp/vault-action/pull/173
+        // Deserialize the value so that newlines and special characters are
+        // not escaped in our return value.
+        result = JSON.parse(result);
+    } else {
+        // Support secrets stored in Vault as pure JSON, see https://github.com/hashicorp/vault-action/issues/194
+        // Serialize the value so that any special characters in the data are
+        // properly escaped.
+        result = JSON.stringify(result);
+        // strip the surrounding quotes added by stringify because the data did
+        // not have them in the first place
         result = result.substring(1, result.length - 1);
-        if (!isJSONString(result)) {
-            // add the quotes back so we can parse it into a Javascript object
-            // to allow support for multi-line secrets. See https://github.com/hashicorp/vault-action/issues/160
-            result = `"${result}"`
-            result = JSON.parse(result);
-        }
-    } else if (isJSONString(result)) {
-        if (storedAsJSONData) {
-            // Support secrets stored in Vault as pure JSON.
-            // See https://github.com/hashicorp/vault-action/issues/194 and https://github.com/hashicorp/vault-action/pull/173
-            result = jsonstringify(result, 2);
-            result = result.substring(1, result.length - 1);
-        } else {
-            // Support secrets stored in Vault as JSON Strings
-            result = jsonstringify(result, 3);
-            result = JSON.parse(result);
-        }
     }
-    console.log()
     return result;
 }
 
-function jsonstringify(input, call) {
-    console.log('stringify', call);
-    return JSON.stringify(input)
-}
-
-/**
- * isOjbect returns true if target is a Javascript object
- * @param {Type} target
- */
-function isObject(target) {
-    console.log('isObject: ', typeof target === 'object' && target !== null)
-    return typeof target === 'object' && target !== null;
-}
-
-/**
- * isJSONString returns true if target parses as a valid JSON string
- * @param {Type} target
- */
-function isJSONString(target) {
-    if (typeof target !== "string"){
-        console.log('isJSONString: false, not string')
-        return false;
-    }
-
-    try {
-        JSON.parse(target);
-    } catch (e) {
-        console.log('isJSONString: false, failed to parse')
-        return false;
-    }
-
-    console.log('isJSONString: true')
-    return true;
-}
-
 module.exports = {
     getSecrets,
     selectData