fixed package.json, added totp test

Signed-off-by: Rod Anami <[email protected]>

Author: rod4n4m1

Diff for: CHANGELOG.md

@@ -7,7 +7,7 @@
   * Improved AD secret management documentation
   * Upgraded all dependencies to the latest
   * Added *TOTP secret engine* functions:
-    * 
+    * `createTOTPKey` and `readTOTPKey`
 
 * `0.4.14`
   * Updated HashiCorp Vault license

Diff for: README.md

@@ -270,7 +270,7 @@ Check below docs for more information on specific function groups.
 | **System Backend** | System | SEAL operations | [Doc file](/docs/Sys-Seal-Functions.md) |
 | **TLS Certificate** | Auth method | `/auth/cert` | [Doc file](/docs/TLS-Cert-Functions.md) |
 | **Token** | Auth method | `/auth/token` | [Doc file](/docs/Token-Functions.md) |
-| **TOTP** | Secret engine | `totp` | [Doc file](/docs/TOTP-Functions.md) |
+| **TOTP** | Secret engine | `/totp` | [Doc file](/docs/TOTP-Functions.md) |
 | **Userpass** | Auth method | `/auth/userpass` | [Doc file](/docs/Userpass-Functions.md) |
 |  |  |  |  |
 

Diff for: Vault.js

@@ -3971,17 +3971,17 @@ class Vault {
   * @param {string} name
   * @param {Object} params
   * @param {boolean} params.generate
-  * @param {boolean} [params.exported]
+  * @param {boolean} [params.exported] - whether the key is exportable as QR code
   * @param {number} [params.key_size=20]
   * @param {string} [params.key_url]
   * @param {string} [params.key]
-  * @param {string} [params.issuer]
+  * @param {string} [params.issuer] - key issuing entity
   * @param {string} [params.account_name]
-  * @param {number} [params.period]
-  * @param {string} [params.algorithm]
-  * @param {number} [params.digits]
-  * @param {number} [params.skew]
-  * @param {number} [params.gr_size]
+  * @param {number} [params.period=30] - length of time for the counter on the code calculation
+  * @param {string} [params.algorithm=sha1] - code generator algorithm, either "SHA1", "SHA256", or "SHA512"
+  * @param {number} [params.digits] - number of code digits, either 6 or 8
+  * @param {number} [params.skew=1] - number of delay periods valid for code validation, either 0 or 1
+  * @param {number} [params.gr_size=200] - pixel size of the QR code image
   * @param {string} [mount]
   * @returns {PromiseLike<Object>}
   */
@@ -4001,8 +4001,8 @@ class Vault {
   // Defaults - most are probably already defaults from Vault itself
   params = {
     generate: true,
-    account_name: "Vault",
-    issuer: "Vault",
+    account_name: "vault",
+    issuer: "vault",
     ...params
   };
 
@@ -4039,6 +4039,42 @@ class Vault {
     throw parseAxiosError(err);
   }
  }
+  
+  /**
+  * @param {string} token
+  * @param {string} name
+  * @param {string} [mount]
+  * @returns {PromiseLike<Object>}
+  */
+  async readTOTPKey(token, name, mount) {
+    assert(token, 'readTOTPKey: required parameter missing - token');
+    assert(name, 'readTOTPKey: required parameter missing - name');
+    let url = "";
+    let rootPath = "";
+    if (mount) {
+      rootPath = mount;
+    } else if (this.rootPath) {
+      rootPath = this.rootPath;
+    } else {
+      rootPath = config.totpRootPath;
+    }
+    
+    url = `${rootPath}/${config.totpReadKey[0]}/${name}`;
+    const Options = {
+      url: url,
+      method: config.totpReadKey[1],
+      headers: {
+        "X-Vault-Token": token
+      }
+    };
+  
+    try {
+      const response = await this.instance(Options);
+      return parseAxiosResponse(response);
+    } catch(err) {
+      throw parseAxiosError(err);
+    }
+   }
 
 }
 

Diff for: package-lock.json

@@ -6,6 +6,7 @@
   "types": "dist/Vault.d.ts",
   "scripts": {
     "compile": "npx tsc",
+    "test": "bash -c 'source tests/process.env && jest tests/*.test.js'",
     "test:approle": "bash -c 'source tests/process.env && jest tests/AppRole.test.js'",
     "test-ts:approle": "bash -c 'source tests/process.env && jest tests/AppRole.test.ts'",
     "test:kv": "bash -c 'source tests/process.env && jest tests/KV.test.js'",
@@ -20,7 +21,8 @@
     "test:k8s": "bash -c 'source tests/process.env && jest tests/K8s.test.js'",
     "test:ad-config": "bash -c 'source tests/process.env && jest tests/AD-config.test.js'",
     "test:ad-roles": "bash -c 'source tests/process.env && jest tests/AD-roles.test.js'",
-    "test:ad-libraries": "bash -c 'source tests/process.env && jest tests/AD-libraries.test.js'"
+    "test:ad-libraries": "bash -c 'source tests/process.env && jest tests/AD-libraries.test.js'",
+    "test:totp": "bash -c 'source tests/process.env && jest tests/TOTP.test.js'"
   },
   "repository": {
     "type": "git",
@@ -57,16 +59,29 @@
     "@types/jest": "^29.5.12",
     "@types/node": "^20.14.2",
     "jest": "^29.7.0",
+    "jest-config": "^29.7.0",
+    "jest-environment-node": "^29.7.0",
     "random-words": "^2.0.1",
     "ts-jest": "^29.1.4",
     "typescript": "^5.4.5"
   },
   "jest": {
+    "verbose": true,
     "testEnvironment": "node",
+    "testEnvironmentOptions": {
+      "NODE_ENV": "test"
+    },
     "transform": {
       "^.+\\.ts?$": "ts-jest"
     },
-    "testRegex": "/tests/.*\\.(test|spec)?\\.(ts|tsx)$",
-    "moduleFileExtensions": [ "ts", "tsx", "js", "jsx", "json", "node" ]
+    "testRegex": "/tests/.*\\.(test|spec)?\\.(js|ts|tsx)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
+    ]
   }
 }

Diff for: package.json

@@ -21,14 +21,24 @@ const vault = new Vault( {
 const name = "my-totp-key";
 
 const params = {
-    issuer: "hashi-vault-js",
-    account_name: "hashi-vault-js",
-    algorithm: "SHA256",
-    generate: true
+  generate: true,
+  exported: true,
+  issuer: "hashi-vault-js",
+  account_name: "chatopsknight",
+  algorithm: "SHA512",  
+  digits: 8,
+  period: 60,
+  skew: 0,
+  qr_size: 400
 };
 
 vault.createTOTPKey(RootToken, name, params).then(function(data){
     console.log('1> createTOTPKey output:\n',data);
+    vault.readTOTPKey(RootToken, name).then(function(data){
+        console.log('2> readTOTPKey output:\n',data);
+    }).catch(function(readError){
+        console.error('2> readTOTPKey error:\n',readError);
+    });
 }).catch(function(createError){
     console.error('1> createTOTPKey error:\n',createError);
     console.error('1> createTOTPKey error:\n',createError.response.data);

Diff for: tests/TOTP-smoke-test.js

@@ -0,0 +1,44 @@
+const Vault = require('../Vault');
+
+const ClientCert = process.env.CLIENT_CERT;
+const ClientKey = process.env.CLIENT_KEY;
+const CACert = process.env.CA_CERT;
+const VaultUrl = process.env.VAULT_URL;
+const RootToken = process.env.VAULT_ROOT_TOKEN;
+
+const vault = new Vault( {
+    https: true,
+    cert: ClientCert,
+    key: ClientKey,
+    cacert: CACert,
+    baseUrl: VaultUrl,
+    rootPath: 'totp',
+    timeout: 3000,
+    proxy: false
+});
+
+const KeyName = "my-totp-key";
+
+const KeyParams = {
+  generate: true,
+  exported: true,
+  issuer: "hashi-vault-js",
+  account_name: "chatopsknight",
+  algorithm: "SHA512",  
+  digits: 8,
+  period: 60,
+  skew: 0,
+  qr_size: 400
+};
+
+test('createTOTPKey: the result is a TOTP key created - HTTP 200', async () => {
+  const data = await vault.createTOTPKey(RootToken, KeyName, KeyParams);
+    console.log(data);
+	return expect(data).toBeDefined();
+});
+
+test('readTOTPKey: the result is a TOTP key information retrieved', async () => {
+  const data = await vault.readTOTPKey(RootToken, KeyName);
+    console.log(data);
+	return expect(data).toBeDefined();
+});