Limit access to vault interface

postmanlabs · Sep 3, 2024 · 68a3f39 · 68a3f39
1 parent ae8fe4c
commit 68a3f39
Show file tree

Hide file tree

Showing 8 changed files with 165 additions and 18 deletions.
diff --git a/CHANGELOG.yaml b/CHANGELOG.yaml
@@ -1,3 +1,7 @@
+unreleased:
+  fixed bugs:
+    - GH-1040 Only allow `set`, `get` and `unset` operations on `pm.vault`
+
 5.1.1:
   date: 2024-08-01
   fixed bugs:

diff --git a/lib/sandbox/execute.js b/lib/sandbox/execute.js
@@ -10,6 +10,7 @@ const _ = require('lodash'),
     PostmanAPI = require('./pmapi'),
     PostmanCookieStore = require('./cookie-store'),
     createPostmanRequire = require('./pm-require'),
+    { Vault, getVaultInterface } = require('./vault'),
     { isNonLegacySandbox, getNonLegacyCodeMarker } = require('./non-legacy-codemarkers'),
 
     EXECUTION_RESULT_EVENT_BASE = 'execution.result.',
@@ -166,6 +167,7 @@ module.exports = function (bridge, glob) {
 
         let waiting,
             timers,
+            vault,
             skippedExecution = false;
 
         execution.return.async = false;
@@ -188,6 +190,7 @@ module.exports = function (bridge, glob) {
             }
 
             // remove listener of disconnection event
+            vault.dispose();
             bridge.off(abortEventName);
             bridge.off(responseEventName);
             bridge.off(cookiesEventName);
@@ -254,10 +257,7 @@ module.exports = function (bridge, glob) {
             disabledAPIs.push('require');
         }
 
-        // @todo: throw helpful error message if script access to vault is disabled
-        if (!context.vaultSecrets) {
-            disabledAPIs.push('vault');
-        }
+        vault = new Vault(id, bridge, timers);
 
         // send control to the function that executes the context and prepares the scope
         executeContext(scope, code, execution,
@@ -283,6 +283,7 @@ module.exports = function (bridge, glob) {
                     },
                     dispatchAssertions,
                     new PostmanCookieStore(id, bridge, timers),
+                    getVaultInterface(vault.exec.bind(vault)),
                     createPostmanRequire(options.resolvedPackages, scope),
                     { disabledAPIs })
             ),

diff --git a/lib/sandbox/execution.js b/lib/sandbox/execution.js
@@ -18,7 +18,7 @@ const _ = require('lodash'),
         test: true
     },
 
-    CONTEXT_VARIABLE_SCOPES = ['_variables', 'environment', 'collectionVariables', 'globals', 'vaultSecrets'],
+    CONTEXT_VARIABLE_SCOPES = ['_variables', 'environment', 'collectionVariables', 'globals'],
 
     trackingOptions = { autoCompact: true };
 

diff --git a/lib/sandbox/pmapi.js b/lib/sandbox/pmapi.js
@@ -47,11 +47,12 @@ const _ = require('lodash'),
  * @param {Function} onSkipRequest - callback to execute when pm.execution.skipRequest() called
  * @param {Function} onAssertion - callback to execute when pm.expect() called
  * @param {Object} cookieStore - cookie store
+ * @param {Vault} vault - vault
  * @param {Function} requireFn - requireFn
  * @param {Object} [options] - options
  * @param {Array.<String>} [options.disabledAPIs] - list of disabled APIs
  */
-function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore, requireFn, options = {}) {
+function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore, vault, requireFn, options = {}) {
     // @todo - ensure runtime passes data in a scope format
     let iterationData = new VariableScope();
 
@@ -63,7 +64,6 @@ function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore,
     execution._variables.addLayer(execution.environment.values);
     execution._variables.addLayer(execution.collectionVariables.values);
     execution._variables.addLayer(execution.globals.values);
-    execution._variables.addLayer(execution.vaultSecrets.values);
 
     execution.cookies && (execution.cookies.jar = function () {
         return new PostmanCookieJar(cookieStore);
@@ -126,9 +126,39 @@ function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore,
         }),
 
         /**
-         * @type {VariableScope}
+         * @interface Vault
+        */
+
+        /**
+         * Get a value from the vault.
+         *
+         * @function
+         * @name Vault#get
+         * @param {string} key -
+         * @returns {Promise<string|undefined>}
+        */
+        /**
+         * Set a value in the vault.
+         *
+         * @function
+         * @name Vault#set
+         * @param {string} key -
+         * @param {string} value -
+         * @returns {Promise<void>}
+        */
+        /**
+         * Unset a value in the vault.
+         *
+         * @function
+         * @name Vault#unset
+         * @param {string} key -
+         * @returns {Promise<void>}
+         */
+
+        /**
+         * @type {Vault}
          */
-        vault: execution.vaultSecrets,
+        vault: vault,
 
         /**
          * @type {VariableScope}

diff --git a/lib/sandbox/vault.js b/lib/sandbox/vault.js
@@ -0,0 +1,52 @@
+class Vault {
+    constructor (id, bridge, timers) {
+        this._bridge = bridge;
+        this._timers = timers;
+        this._event = `execution.vault.${id}`;
+
+        this._handler = (eventId, ...args) => {
+            this._timers.clearEvent(eventId, ...args);
+        };
+
+        this._bridge.on(this._event, this._handler);
+    }
+
+    exec (...args) {
+        return new Promise((resolve, reject) => {
+            const eventId = this._timers.setEvent((err, ...args) => {
+                if (err) {
+                    return reject(err instanceof Error ? err : new Error(err.message || err));
+                }
+
+                resolve(...args);
+            });
+
+            this._bridge.dispatch(this._event, eventId, ...args);
+        });
+    }
+
+    dispose () {
+        this._bridge.off(this._event, this._handler);
+    }
+}
+
+const getVaultInterface = (vault) => {
+    return {
+        get: (key) => {
+            return vault('get', key);
+        },
+
+        set: (key, value) => {
+            return vault('set', key, value);
+        },
+
+        unset: (key) => {
+            return vault('unset', key);
+        }
+    };
+};
+
+module.exports = {
+    Vault,
+    getVaultInterface
+};
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for postman-sandbox 5.0.0
+// Type definitions for postman-sandbox 5.1.1
 // Project: https://github.com/postmanlabs/postman-sandbox
 // Definitions by: PostmanLabs
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -161,12 +161,13 @@ declare function createPostmanRequire(fileCache: FileCache, scope: any): (...par
  * @param onSkipRequest - callback to execute when pm.execution.skipRequest() called
  * @param onAssertion - callback to execute when pm.expect() called
  * @param cookieStore - cookie store
+ * @param vault - vault
  * @param requireFn - requireFn
  * @param [options] - options
  * @param [options.disabledAPIs] - list of disabled APIs
  */
 declare class Postman {
-    constructor(execution: Execution, onRequest: (...params: any[]) => any, onSkipRequest: (...params: any[]) => any, onAssertion: (...params: any[]) => any, cookieStore: any, requireFn: (...params: any[]) => any, options?: {
+    constructor(execution: Execution, onRequest: (...params: any[]) => any, onSkipRequest: (...params: any[]) => any, onAssertion: (...params: any[]) => any, cookieStore: any, vault: Vault, requireFn: (...params: any[]) => any, options?: {
         disabledAPIs?: string[];
     });
     /**
@@ -175,7 +176,7 @@ declare class Postman {
      * stored inside of this object.
      */
     info: Info;
-    vault: VariableScope;
+    vault: Vault;
     globals: VariableScope;
     environment: VariableScope;
     collectionVariables: VariableScope;
@@ -247,6 +248,25 @@ declare interface Info {
     requestId: string;
 }
 
+declare interface Vault {
+    /**
+     * Get a value from the vault.
+     * @param key - -
+     */
+    get(key: string): Promise;
+    /**
+     * Set a value in the vault.
+     * @param key - -
+     * @param value - -
+     */
+    set(key: string, value: string): Promise;
+    /**
+     * Unset a value in the vault.
+     * @param key - -
+     */
+    unset(key: string): Promise;
+}
+
 declare interface Visualizer {
     /**
      * Set visualizer template and its options

diff --git a/types/sandbox/prerequest.d.ts b/types/sandbox/prerequest.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for postman-sandbox 5.0.0
+// Type definitions for postman-sandbox 5.1.1
 // Project: https://github.com/postmanlabs/postman-sandbox
 // Definitions by: PostmanLabs
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -95,12 +95,13 @@ declare var cheerio;
  * @param onSkipRequest - callback to execute when pm.execution.skipRequest() called
  * @param onAssertion - callback to execute when pm.expect() called
  * @param cookieStore - cookie store
+ * @param vault - vault
  * @param requireFn - requireFn
  * @param [options] - options
  * @param [options.disabledAPIs] - list of disabled APIs
  */
 declare class Postman {
-    constructor(execution: Execution, onRequest: (...params: any[]) => any, onSkipRequest: (...params: any[]) => any, onAssertion: (...params: any[]) => any, cookieStore: any, requireFn: (...params: any[]) => any, options?: {
+    constructor(execution: Execution, onRequest: (...params: any[]) => any, onSkipRequest: (...params: any[]) => any, onAssertion: (...params: any[]) => any, cookieStore: any, vault: Vault, requireFn: (...params: any[]) => any, options?: {
         disabledAPIs?: string[];
     });
     /**
@@ -109,7 +110,7 @@ declare class Postman {
      * stored inside of this object.
      */
     info: Info;
-    vault: import("postman-collection").VariableScope;
+    vault: Vault;
     globals: import("postman-collection").VariableScope;
     environment: import("postman-collection").VariableScope;
     collectionVariables: import("postman-collection").VariableScope;
@@ -176,6 +177,25 @@ declare interface Info {
     requestId: string;
 }
 
+declare interface Vault {
+    /**
+     * Get a value from the vault.
+     * @param key - -
+     */
+    get(key: string): Promise;
+    /**
+     * Set a value in the vault.
+     * @param key - -
+     * @param value - -
+     */
+    set(key: string, value: string): Promise;
+    /**
+     * Unset a value in the vault.
+     * @param key - -
+     */
+    unset(key: string): Promise;
+}
+
 declare interface Visualizer {
     /**
      * Set visualizer template and its options

diff --git a/types/sandbox/test.d.ts b/types/sandbox/test.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for postman-sandbox 5.0.0
+// Type definitions for postman-sandbox 5.1.1
 // Project: https://github.com/postmanlabs/postman-sandbox
 // Definitions by: PostmanLabs
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -125,12 +125,13 @@ declare var cheerio;
  * @param onSkipRequest - callback to execute when pm.execution.skipRequest() called
  * @param onAssertion - callback to execute when pm.expect() called
  * @param cookieStore - cookie store
+ * @param vault - vault
  * @param requireFn - requireFn
  * @param [options] - options
  * @param [options.disabledAPIs] - list of disabled APIs
  */
 declare class Postman {
-    constructor(execution: Execution, onRequest: (...params: any[]) => any, onSkipRequest: (...params: any[]) => any, onAssertion: (...params: any[]) => any, cookieStore: any, requireFn: (...params: any[]) => any, options?: {
+    constructor(execution: Execution, onRequest: (...params: any[]) => any, onSkipRequest: (...params: any[]) => any, onAssertion: (...params: any[]) => any, cookieStore: any, vault: Vault, requireFn: (...params: any[]) => any, options?: {
         disabledAPIs?: string[];
     });
     /**
@@ -139,7 +140,7 @@ declare class Postman {
      * stored inside of this object.
      */
     info: Info;
-    vault: import("postman-collection").VariableScope;
+    vault: Vault;
     globals: import("postman-collection").VariableScope;
     environment: import("postman-collection").VariableScope;
     collectionVariables: import("postman-collection").VariableScope;
@@ -212,6 +213,25 @@ declare interface Info {
     requestId: string;
 }
 
+declare interface Vault {
+    /**
+     * Get a value from the vault.
+     * @param key - -
+     */
+    get(key: string): Promise;
+    /**
+     * Set a value in the vault.
+     * @param key - -
+     * @param value - -
+     */
+    set(key: string, value: string): Promise;
+    /**
+     * Unset a value in the vault.
+     * @param key - -
+     */
+    unset(key: string): Promise;
+}
+
 declare interface Visualizer {
     /**
      * Set visualizer template and its options