node-vault-client 0.6.1 → 1.0.0

package/README.md

@@ -1,154 +1,154 @@
-# Node.js Vault Client
-
-[![Build Status](https://travis-ci.org/namecheap/node-vault-client.svg?branch=master)](https://travis-ci.org/namecheap/node-vault-client)
-![npm](https://img.shields.io/npm/v/node-vault-client)
-![npm](https://img.shields.io/npm/dm/node-vault-client)
-
-A Vault Client implemented in pure javascript for [HashiCorp Vault](https://github.com/hashicorp/vault).
-It supports variety of Auth Backends and performs lease renewal for issued auth token.
-
-## Install
-```
-npm install --save node-vault-client
-```
-
-## Example
-
-```javascript
-const VaultClient = require('node-vault-client');
-
-const vaultClient = VaultClient.boot('main', {
-    api: { url: 'https://vault.example.com:8200/' },
-    auth: { 
-        type: 'appRole', // or 'token', 'iam'
-        config: { role_id: '637c065f-c644-5e12-d3d1-e9fa4363af61' } 
-    },
-});
-
-vaultClient.read('secret/tst').then(v => {
-    console.log(v);
-}).catch(e => console.error(e));
-```
-
-## Supported Auth Backends
-
-* [AWS IAM](https://www.vaultproject.io/docs/auth/aws.html#iam-auth-method)
-* [AppRole](https://www.vaultproject.io/docs/auth/approle.html)
-* [Token](https://www.vaultproject.io/docs/auth/token.html)
-
-## API
-
-<a name="VaultClient"></a>
-
-### VaultClient 
-
-* [VaultClient](#VaultClient)
-    * [new VaultClient(options)](#new_VaultClient_new)
-    * _instance_
-        * [.fillNodeConfig()](#VaultClient+fillNodeConfig)
-        * [.read(path)](#VaultClient+read) ⇒ <code>Promise.&lt;Lease&gt;</code>
-        * [.list(path)](#VaultClient+list) ⇒ <code>Promise.&lt;Lease&gt;</code>
-        * [.write(path, data)](#VaultClient+write) ⇒ <code>Promise.&lt;(T\|never)&gt;</code>
-    * _static_
-        * [.boot(name, [options])](#VaultClient.boot) ⇒
-        * [.get(name)](#VaultClient.get) ⇒
-        * [.clear([name])](#VaultClient.clear)
-
-<a name="new_VaultClient_new"></a>
-
-#### new VaultClient(options)
-Client constructor function.
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| options | `Object` |  |  |
-| options.api | <code>Object</code> |  |  |
-| options.api.url | <code>String</code> |  | the url of the vault server |
-| [options.api.apiVersion] | <code>String</code> | `v1` |  |
-| options.auth | <code>Object</code> |  |  |
-| options.auth.type | <code>String</code> |  |  |
-| options.auth.config | <code>Object</code> |  | auth configuration variables |
-| options.logger | <code>Object</code> | `false` |  | Logger that supports "error", "info", "warn", "trace", "debug" methods. Uses `console` by default. Pass `false` to disable logging. |
-
-#### vaultClient.fillNodeConfig()
-Populates Vault's values to NPM "config" module
-
-**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
-<a name="VaultClient+read"></a>
-
-#### vaultClient.read(path) ⇒ <code>Promise.&lt;Lease&gt;</code>
-Read secret from Vault
-
-**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| path | <code>string</code> | path to the secret |
-
-<a name="VaultClient+list"></a>
-
-#### vaultClient.list(path) ⇒ <code>Promise.&lt;Lease&gt;</code>
-Retrieves secrets list
-
-**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| path | <code>string</code> | path to the secret |
-
-<a name="VaultClient+write"></a>
-
-#### vaultClient.write(path, data) ⇒ <code>Promise.&lt;(T\|never)&gt;</code>
-Writes data to Vault
-
-**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| path |  | path used to write data |
-| data | <code>object</code> | data to write |
-
-<a name="VaultClient.boot"></a>
-
-#### VaultClient.boot(name, [options]) ⇒
-Boot an instance of Vault
-
-The instance will be stored in a local hash. Calling Vault.boot multiple
-times with the same name will return the same instance.
-
-**Kind**: static method of [<code>VaultClient</code>](#VaultClient)  
-**Returns**: Vault  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| name | <code>String</code> | Vault instance name |
-| [options] | <code>Object</code> | options for [Vault#constructor](#new_VaultClient_new). |
-
-<a name="VaultClient.get"></a>
-
-#### VaultClient.get(name) ⇒
-Get an instance of Vault
-
-The instance will be stored in a local hash. Calling Vault.pop multiple
-times with the same name will return the same instance.
-
-**Kind**: static method of [<code>VaultClient</code>](#VaultClient)  
-**Returns**: Vault  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| name | <code>String</code> | Vault instance name |
-
-<a name="VaultClient.clear"></a>
-
-#### VaultClient.clear([name])
-Clear named Vault instance
-
-If no name passed all named instances will be cleared.
-
-**Kind**: static method of [<code>VaultClient</code>](#VaultClient)  
-
-| Param | Type | Description |
-| --- | --- | --- |
+# Node.js Vault Client
+
+[![Build Status](https://travis-ci.org/namecheap/node-vault-client.svg?branch=master)](https://travis-ci.org/namecheap/node-vault-client)
+![npm](https://img.shields.io/npm/v/node-vault-client)
+![npm](https://img.shields.io/npm/dm/node-vault-client)
+
+A Vault Client implemented in pure javascript for [HashiCorp Vault](https://github.com/hashicorp/vault).
+It supports variety of Auth Backends and performs lease renewal for issued auth token.
+
+## Install
+```
+npm install --save node-vault-client
+```
+
+## Example
+
+```javascript
+const VaultClient = require('node-vault-client');
+
+const vaultClient = VaultClient.boot('main', {
+    api: { url: 'https://vault.example.com:8200/' },
+    auth: { 
+        type: 'appRole', // or 'token', 'iam'
+        config: { role_id: '637c065f-c644-5e12-d3d1-e9fa4363af61' } 
+    },
+});
+
+vaultClient.read('secret/tst').then(v => {
+    console.log(v);
+}).catch(e => console.error(e));
+```
+
+## Supported Auth Backends
+
+* [AWS IAM](https://www.vaultproject.io/docs/auth/aws.html#iam-auth-method)
+* [AppRole](https://www.vaultproject.io/docs/auth/approle.html)
+* [Token](https://www.vaultproject.io/docs/auth/token.html)
+
+## API
+
+<a name="VaultClient"></a>
+
+### VaultClient 
+
+* [VaultClient](#VaultClient)
+    * [new VaultClient(options)](#new_VaultClient_new)
+    * _instance_
+        * [.fillNodeConfig()](#VaultClient+fillNodeConfig)
+        * [.read(path)](#VaultClient+read) ⇒ <code>Promise.&lt;Lease&gt;</code>
+        * [.list(path)](#VaultClient+list) ⇒ <code>Promise.&lt;Lease&gt;</code>
+        * [.write(path, data)](#VaultClient+write) ⇒ <code>Promise.&lt;(T\|never)&gt;</code>
+    * _static_
+        * [.boot(name, [options])](#VaultClient.boot) ⇒
+        * [.get(name)](#VaultClient.get) ⇒
+        * [.clear([name])](#VaultClient.clear)
+
+<a name="new_VaultClient_new"></a>
+
+#### new VaultClient(options)
+Client constructor function.
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| options | `Object` |  |  |
+| options.api | <code>Object</code> |  |  |
+| options.api.url | <code>String</code> |  | the url of the vault server |
+| [options.api.apiVersion] | <code>String</code> | `v1` |  |
+| options.auth | <code>Object</code> |  |  |
+| options.auth.type | <code>String</code> |  |  |
+| options.auth.config | <code>Object</code> |  | auth configuration variables |
+| options.logger | <code>Object</code> | `false` |  | Logger that supports "error", "info", "warn", "trace", "debug" methods. Uses `console` by default. Pass `false` to disable logging. |
+
+#### vaultClient.fillNodeConfig()
+Populates Vault's values to NPM "config" module
+
+**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
+<a name="VaultClient+read"></a>
+
+#### vaultClient.read(path) ⇒ <code>Promise.&lt;Lease&gt;</code>
+Read secret from Vault
+
+**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| path | <code>string</code> | path to the secret |
+
+<a name="VaultClient+list"></a>
+
+#### vaultClient.list(path) ⇒ <code>Promise.&lt;Lease&gt;</code>
+Retrieves secrets list
+
+**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| path | <code>string</code> | path to the secret |
+
+<a name="VaultClient+write"></a>
+
+#### vaultClient.write(path, data) ⇒ <code>Promise.&lt;(T\|never)&gt;</code>
+Writes data to Vault
+
+**Kind**: instance method of [<code>VaultClient</code>](#VaultClient)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| path |  | path used to write data |
+| data | <code>object</code> | data to write |
+
+<a name="VaultClient.boot"></a>
+
+#### VaultClient.boot(name, [options]) ⇒
+Boot an instance of Vault
+
+The instance will be stored in a local hash. Calling Vault.boot multiple
+times with the same name will return the same instance.
+
+**Kind**: static method of [<code>VaultClient</code>](#VaultClient)  
+**Returns**: Vault  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| name | <code>String</code> | Vault instance name |
+| [options] | <code>Object</code> | options for [Vault#constructor](#new_VaultClient_new). |
+
+<a name="VaultClient.get"></a>
+
+#### VaultClient.get(name) ⇒
+Get an instance of Vault
+
+The instance will be stored in a local hash. Calling Vault.pop multiple
+times with the same name will return the same instance.
+
+**Kind**: static method of [<code>VaultClient</code>](#VaultClient)  
+**Returns**: Vault  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| name | <code>String</code> | Vault instance name |
+
+<a name="VaultClient.clear"></a>
+
+#### VaultClient.clear([name])
+Clear named Vault instance
+
+If no name passed all named instances will be cleared.
+
+**Kind**: static method of [<code>VaultClient</code>](#VaultClient)  
+
+| Param | Type | Description |
+| --- | --- | --- |
 | [name] | <code>String</code> | Vault instance name, all instances will be cleared if no name were passed |

package/package.json

@@ -1,43 +1,42 @@
-{
-  "name": "node-vault-client",
-  "version": "0.6.1",
-  "description": "A Vault Client implemented in pure javascript for HashiCorp Vault. It supports variety of Auth Backends and performs lease renewal for issued auth token.",
-  "repository": "github:namecheap/node-vault-client",
-  "engines": {
-    "node": ">=6.0.0"
-  },
-  "main": "src/VaultClient.js",
-  "files": [
-    "src"
-  ],
-  "scripts": {
-    "test": "mocha test/**/*.test.js",
-    "version": "git add -A ."
-  },
-  "author": "Namecheap <opensource@namecheap.com>",
-  "license": "Apache-2.0",
-  "dependencies": {
-    "assign-deep": "^1.0.1",
-    "aws4": "^1.8.0",
-    "bluebird": "^3.7.0",
-    "lodash": "^4.17.15",
-    "long-timeout": "^0.1.1",
-    "pretty-ms": "^2.1.0",
-    "request": "^2.88.0",
-    "request-promise": "^4.2.4",
-    "url-join": "^2.0.5"
-  },
-  "peerDependencies": {
-    "config": ">=1 <4",
-    "aws-sdk": "^2.67.0"
-  },
-  "devDependencies": {
-    "aws-sdk": "^2.544.0",
-    "chai": "^3.5.0",
-    "co-mocha": "^1.2.2",
-    "deep-freeze": "^0.0.1",
-    "mocha": "^3.5.3",
-    "sinon": "^2.4.1",
-    "sinon-chai": "^2.14.0"
-  }
-}
+{
+  "name": "node-vault-client",
+  "version": "1.0.0",
+  "description": "A Vault Client implemented in pure javascript for HashiCorp Vault. It supports variety of Auth Backends and performs lease renewal for issued auth token.",
+  "repository": "github:namecheap/node-vault-client",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "main": "src/VaultClient.js",
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "test": "mocha test/**/*.test.js",
+    "version": "git add -A ."
+  },
+  "author": "Namecheap <opensource@namecheap.com>",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@aws-sdk/credential-providers": "^3.382.0",
+    "assign-deep": "^1.0.1",
+    "aws4": "^1.8.0",
+    "bluebird": "^3.7.0",
+    "lodash": "^4.17.15",
+    "long-timeout": "^0.1.1",
+    "pretty-ms": "^2.1.0",
+    "request": "^2.88.0",
+    "request-promise": "^4.2.4",
+    "url-join": "^2.0.5"
+  },
+  "peerDependencies": {
+    "config": ">=1 <4"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "co-mocha": "^1.2.2",
+    "deep-freeze": "^0.0.1",
+    "mocha": "^3.5.3",
+    "sinon": "^2.4.1",
+    "sinon-chai": "^2.14.0"
+  }
+}

package/src/Lease.js

@@ -1,57 +1,57 @@
-'use strict';
-
-const _ = require('lodash');
-
-class Lease {
-    constructor(
-        requestId,
-        leaseId,
-        leaseDuration,
-        renewable,
-        data
-    ) {
-        this.__requestId = requestId;
-        this.__leaseId = leaseId;
-        this.__leaseDuration = leaseDuration;
-        this.__renewable = renewable;
-        this.__data = data === undefined ? {} : data;
-    }
-
-    static fromResponse(response) {
-        return new Lease(
-            response.request_id,
-            response.lease_id,
-            response.lease_duration,
-            response.renewable,
-            response.data
-        );
-    }
-
-    /**
-     * @param {String} key
-     * @returns {String}
-     */
-    getValue(key) {
-        if (this.__data[key] === undefined) {
-            throw new Error('Requested key does not exist');
-        }
-
-        return this.__data[key];
-    }
-
-    /**
-     * @returns {Object}
-     */
-    getData() {
-        return _.cloneDeep(this.__data);
-    }
-
-    /**
-     * @returns {bool}
-     */
-    isRenewable() {
-        return this.__renewable;
-    }
-}
-
-module.exports = Lease;
+'use strict';
+
+const _ = require('lodash');
+
+class Lease {
+    constructor(
+        requestId,
+        leaseId,
+        leaseDuration,
+        renewable,
+        data
+    ) {
+        this.__requestId = requestId;
+        this.__leaseId = leaseId;
+        this.__leaseDuration = leaseDuration;
+        this.__renewable = renewable;
+        this.__data = data === undefined ? {} : data;
+    }
+
+    static fromResponse(response) {
+        return new Lease(
+            response.request_id,
+            response.lease_id,
+            response.lease_duration,
+            response.renewable,
+            response.data
+        );
+    }
+
+    /**
+     * @param {String} key
+     * @returns {String}
+     */
+    getValue(key) {
+        if (this.__data[key] === undefined) {
+            throw new Error('Requested key does not exist');
+        }
+
+        return this.__data[key];
+    }
+
+    /**
+     * @returns {Object}
+     */
+    getData() {
+        return _.cloneDeep(this.__data);
+    }
+
+    /**
+     * @returns {bool}
+     */
+    isRenewable() {
+        return this.__renewable;
+    }
+}
+
+module.exports = Lease;

package/src/VaultApiClient.js

@@ -1,55 +1,55 @@
-'use strict';
-
-const rp = require('request-promise');
-const urljoin = require('url-join');
-const _ = require('lodash');
-
-class VaultApiClient {
-
-    /**
-     * @param {Object} config
-     * @param {String} config.url - the url of the vault server
-     * @param {String} [config.apiVersion='v1']
-     * @param {Object} logger
-     */
-    constructor(config, logger) {
-        this.__config = _.defaultsDeep(_.cloneDeep(config), {
-            apiVersion: 'v1',
-        });
-
-        this._logger = logger;
-    }
-
-    makeRequest(method, path, data, headers) {
-        data = data === undefined ? null : data;
-        headers = headers === undefined ? {} : headers;
-
-        const requestOptions = {
-            method: method,
-            body: data === null ? undefined : data,
-            uri: urljoin(this.__config.url, this.__config.apiVersion, path),
-            followRedirects: true,
-            followAllRedirects: true,
-            headers,
-            json: true,
-        };
-
-        this._logger.debug(
-            'making request: %s %s',
-            requestOptions.method,
-            requestOptions.uri
-        );
-
-        return rp(requestOptions)
-            .then((response) => {
-                this._logger.debug('%s %s response body:\n%s',
-                    requestOptions.method,
-                    requestOptions.uri,
-                    JSON.stringify(response, null, ' ')
-                );
-                return response;
-            });
-    }
-}
-
-module.exports = VaultApiClient;
+'use strict';
+
+const rp = require('request-promise');
+const urljoin = require('url-join');
+const _ = require('lodash');
+
+class VaultApiClient {
+
+    /**
+     * @param {Object} config
+     * @param {String} config.url - the url of the vault server
+     * @param {String} [config.apiVersion='v1']
+     * @param {Object} logger
+     */
+    constructor(config, logger) {
+        this.__config = _.defaultsDeep(_.cloneDeep(config), {
+            apiVersion: 'v1',
+        });
+
+        this._logger = logger;
+    }
+
+    makeRequest(method, path, data, headers) {
+        data = data === undefined ? null : data;
+        headers = headers === undefined ? {} : headers;
+
+        const requestOptions = {
+            method: method,
+            body: data === null ? undefined : data,
+            uri: urljoin(this.__config.url, this.__config.apiVersion, path),
+            followRedirects: true,
+            followAllRedirects: true,
+            headers,
+            json: true,
+        };
+
+        this._logger.debug(
+            'making request: %s %s',
+            requestOptions.method,
+            requestOptions.uri
+        );
+
+        return rp(requestOptions)
+            .then((response) => {
+                this._logger.debug('%s %s response body:\n%s',
+                    requestOptions.method,
+                    requestOptions.uri,
+                    JSON.stringify(response, null, ' ')
+                );
+                return response;
+            });
+    }
+}
+
+module.exports = VaultApiClient;