ssh-client-wrapper 2.2.1 → 2.2.4

package/.dockerignore

@@ -1 +1,2 @@
 node_modules
+run_test_all.sh

package/.eslintrc.json

@@ -1,163 +1,34 @@
 {
-  "root": true,
-  "extends": [
-    "eslint"
-  ],
-  "plugins": [
-    "node",
-    "jsdoc"
-  ],
   "env": {
-    "node": true,
-    "es6": true
+    "browser": true,
+    "commonjs": true,
+    "es2021": true
   },
-  "rules": {
-    "no-param-reassign": "warn",
-    "arrow-parens": [
-      "error",
-      "always"
-    ],
-    "arrow-body-style": [
-      "error",
-      "always"
-    ],
-    "arrow-spacing": [
-      "error",
-      {
-        "before": false,
-        "after": false
-      }
-    ],
-    "camelcase": [
-      "error",
-      {
-        "properties": "never"
-      }
-    ],
-    "eqeqeq": [
-      "error",
-      "always",
-      {
-        "null": "ignore"
-      }
-    ],
-    "func-style": [
-      "error",
-      "declaration",
-      {
-        "allowArrowFunctions": true
-      }
-    ],
-    "indent": [
-      "error",
-      2,
-      {
-        "SwitchCase": 1
-      }
-    ],
-    "lines-around-comment": [
-      "error",
-      {
-        "beforeBlockComment": true,
-        "beforeLineComment": false
-      }
-    ],
-    "lines-between-class-members": [
-      "error",
-      "always",
-      {
-        "exceptAfterSingleLine": true
-      }
-    ],
-    "newline-per-chained-call": "error",
-    "no-use-before-define": [
-      "error",
-      {
-        "functions": false
-      }
-    ],
-    "no-warning-comments": "warn",
-    "padded-blocks": [
-      "error",
-      "never"
-    ],
-    "padding-line-between-statements": [
-      "error",
-      {
-        "blankLine": "any",
-        "prev": [
-          "const",
-          "let",
-          "var"
-        ],
-        "next": "*"
+  "extends": ["standard"],
+  "overrides": [
+    {
+      "env": {
+        "node": true
       },
-      {
-        "blankLine": "always",
-        "prev": "*",
-        "next": [
-          "block-like",
-          "class",
-          "do",
-          "for",
-          "function",
-          "multiline-block-like",
-          "switch",
-          "try",
-          "while"
-        ]
-      },
-      {
-        "blankLine": "any",
-        "prev": [
-          "const",
-          "let",
-          "var",
-          "for",
-          "while",
-          "do",
-          "block-like",
-          "multiline-block-like"
-        ],
-        "next": [
-          "block-like",
-          "do",
-          "for",
-          "multiline-block-like",
-          "switch",
-          "try",
-          "while"
-        ]
+      "files": [
+        ".eslintrc.{js,cjs}"
+      ],
+      "parserOptions": {
+        "sourceType": "script"
       }
-    ],
-    "spaced-comment": [
-      "error",
-      "never"
-    ],
-    "node/exports-style": [
-      "error",
-      "module.exports"
-    ],
-    "require-unicode-regexp": "off",
-    "node/no-unsupported-features": [
+    }
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
+  "rules": {
+    "semi": [
       "error",
-      {
-        "version": 10
-      }
-    ],
-    "jsdoc/require-hyphen-before-param-description": [
-      "warn",
       "always"
     ],
-    "jsdoc/newline-after-description": "off",
-    "jsdoc/require-param-description": "warn",
-    "jsdoc/require-param-name": "warn",
-    "jsdoc/require-param-type": "warn",
-    "jsdoc/require-jsdoc": "off",
-    "jsdoc/require-param": "off",
-    "jsdoc/require-returns": "off"
-  },
-  "parserOptions": {
-    "ecmaVersion": 2018
+    "quotes": [
+      "error",
+      "double"
+    ]
   }
 }

package/Dockerfile

@@ -1,10 +1,7 @@
 # syntax=docker/dockerfile:1
-#build WHEEL client code
-FROM --platform=linux/amd64 node:hydrogen-bookworm-slim
-#FROM --platform=linux/amd64 node:hydrogen-bullseye-slim
-#FROM --platform=linux/amd64 node:hydrogen-buster-slim
+FROM --platform=linux/amd64 node:20-bookworm-slim
 
-WORKDIR /work
+WORKDIR /work/ssh-client-wrapper
 RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
-COPY ./ ssh-client-wrapper
-RUN cd  ssh-client-wrapper && npm install
+COPY ./ ./
+RUN npm install

package/Dockerfile-bullseye

@@ -0,0 +1,7 @@
+# syntax=docker/dockerfile:1
+FROM --platform=linux/amd64 node:20-bookworm-slim
+
+WORKDIR /work/ssh-client-wrapper
+RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
+COPY ./ ./
+RUN npm install

package/Dockerfile-buster

@@ -0,0 +1,7 @@
+# syntax=docker/dockerfile:1
+FROM --platform=linux/amd64 node:20-bookworm-slim
+
+WORKDIR /work/ssh-client-wrapper
+RUN apt-get update && apt -y install ssh rsync bzip2 python3 g++ build-essential
+COPY ./ ./
+RUN npm install

package/docker-compose.yml

@@ -1,9 +1,9 @@
 version: "3.8"
 services:
-  test-bed:
+  testbed:
     image: naoso5/test-sshd
     ports:
-      - 4000:22
+      - "4000:22"
     container_name: testbed
   tester:
     build:
@@ -14,4 +14,24 @@ services:
       TEST_PW: passw0rd
       TEST_HOST: testbed
     working_dir: /work/ssh-client-wrapper
-    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run test"
+    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"
+  tester-bullseye:
+    build:
+      context: .
+      dockerfile: Dockerfile-bullseye
+    environment:
+      TEST_USER: testuser
+      TEST_PW: passw0rd
+      TEST_HOST: testbed
+    working_dir: /work/ssh-client-wrapper
+    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"
+  tester-buster:
+    build:
+      context: .
+      dockerfile: Dockerfile-buster
+    environment:
+      TEST_USER: testuser
+      TEST_PW: passw0rd
+      TEST_HOST: testbed
+    working_dir: /work/ssh-client-wrapper
+    command: bash -c "mkdir /root/.ssh 2>/dev/null; npm run mocha"

package/lib/index.js

@@ -67,8 +67,6 @@ class SshClientWrapper {
    * @param {Integer} timeout - timeout in secconds
    * @param { Function } outputCallback - call back routine for output
    * @returns {Integer} - Return code of cmd.
-   *
-   * If stdout and stderr is array, last 5 line of stdout and stderr is stored in them.
    */
   async exec(cmd, timeout = 0, outputCallback = null) {
     debug("exec called", cmd);
@@ -92,33 +90,6 @@ class SshClientWrapper {
     return ls(this.hostInfo, target, lsOpt, timeout);
   }
 
-  /**
-   * Execute command repeatedly until specified keyword is found in stdout and/or stderr.
-   * @param {string} cmd - Cmdline which will be executed.
-   * @param {RegExp} regexp - End condition.
-   * @param {number} retryDelay - Duration between each try (in sec).
-   * @param {number} maxRetry - Max retry count.
-   * @returns {Integer} - Return code of cmd.
-   */
-  async watch(cmd, regexp, retryDelay = 3, maxRetry = null) {
-    debug("watch called", cmd, regexp, retryDelay, maxRetry);
-
-    if (typeof cmd !== "string") {
-      return logAndReject("cmd must be string");
-    }
-    if (!(regexp instanceof RegExp)) {
-      const err = new Error("illegal regexp specified");
-      err.regexp = regexp;
-      err.cmd = cmd;
-      err.retryDelay = retryDelay;
-      err.maxRetry = maxRetry;
-      return Promise.reject(new Error("err"));
-    }
-    //not implemented yet !!!
-    return this.exec(cmd, ()=>{
-    });
-  }
-
   /**
    * Send file or directory and its child to server.
    * @param {string[]} src - File or directory name which to be recieve.

package/lib/util.js

@@ -11,6 +11,53 @@ const rePwPrompt = /password:/;
 const rePhPrompt = /Enter passphrase for key/;
 const reNewHostPrompt = /Are you sure you want to continue connecting/;
 
+const Ajv = require("ajv");
+
+const ajv = new Ajv({
+  allErrors: true,
+  removeAdditional: "all",
+  coerceTypes: true,
+  logger: {
+    log: debug,
+    warn: debug,
+    error: debug
+  }
+});
+require("ajv-keywords")(ajv, "transform");
+
+//never validate password and passphrase value to avoid security insident
+const hostInfoSchema = {
+  type: "object",
+  properties: {
+    host: { type: "string", pattern: "\\S+", transform: ["trim"] },
+    user: { type: "string", pattern: "\\S+", transform: ["trim"] },
+    port: { type: "number", minimum: 0, maximum: 65535 },
+    keyFile: { type: "string", pattern: "\\S+", transform: ["trim"] },
+    noStrictHostkeyChecking: { type: "boolean" },
+    ControlPersist: { type: "number", minimum: 0 },
+    ConnectTimeout: { type: "number", minimum: 0 },
+    maxRetry: { type: "number", minimum: 0 },
+    retryMinTimeout: { type: "number", minimum: 0 },
+    retryMaxTimeout: { type: "number", minimum: 0 },
+    sshOpt: { type: "array", minItems: 1, items: { type: "string", pattern: "\\S+", transform: ["trim"] } }
+  },
+  required: ["host"],
+  additionalProperties: false
+};
+
+const stringOptions = [
+  "user",
+  "keyFile"
+];
+const numberOptions = [
+  "ControlPersist",
+  "ConnectTimeout",
+  "maxRetry",
+  "retryMinTimeout",
+  "retryMaxTimeout"
+];
+
+const validate = ajv.compile(hostInfoSchema);
 
 /**
  * bridge function to functions which need string
@@ -23,20 +70,65 @@ const buff2String = (func, data)=>{
 
 /**
  * check if given hostInfo object is OK
- * @param { Object} hostInfo - host information object defined in index.js
+ * @param { Object } hostInfo - host information object defined in index.js
  */
 const sanityCheck = (hostInfo)=>{
-  debug("sanityCheck called");
+  debug("sanityCheck called", hostInfo);
+  //keep password, passphrase, and masterPty before validate.
+  //these properties can have invalid value for JSON.
+  //ajv will remove that at validation pahse becase of additionalProperties setting
+  //so we keep them here and put back later.
+  const { password, passphrase, masterPty } = hostInfo;
+  validate(hostInfo);
 
-  if (typeof hostInfo.host !== "string" || hostInfo.host === "") {
-    throw new Error("host must be non-empty string");
-  }
-  if (Object.prototype.hasOwnProperty.call(hostInfo, "port") && (typeof hostInfo.port === "string" || Number.isInteger(hostInfo.port))) {
-    const port = Number(hostInfo.port);
-    if (port < 0 || port > 65535) {
-      throw new Error("port number must be in the range of 0 to 65535");
+  if (validate !== null && Array.isArray(validate.errors)) {
+    for (const e of validate.errors) {
+      debug("validation error:", e);
+      const prop = e.instancePath.replace(/^\//, "");
+      if (e.keyword === "required" && e.params.missingProperty === "host") {
+        throw new Error("host is required");
+      }
+      if (prop === "host") {
+        if (hostInfo.host === "") {
+          throw new Error("empty host is not allowed");
+        }
+        const err = new Error("invalid host specified");
+        err.hostInfo = hostInfo;
+        err.validationError = e;
+        throw err;
+      }
+      if (prop.startsWith("sshOpt")) {
+        debug("remove empty member of sshOpt");
+        hostInfo.sshOpt = hostInfo.sshOpt.filter((opt)=>{
+          return opt !== "";
+        });
+        continue;
+      } else if (stringOptions.includes(prop) && hostInfo[prop] === "") {
+        debug("remove empty string option", prop, hostInfo[prop]);
+        delete hostInfo[prop];
+        continue;
+      } else if (numberOptions.includes(prop) && ["minimum", "maximum"].includes(e.keyword)) {
+        debug("remove out of range number option", prop, hostInfo[prop]);
+        delete hostInfo[prop];
+        continue;
+      } else {
+        const err = new Error(`invalid ${prop} specified ${hostInfo[prop]}`);
+        err.hostInfo = hostInfo;
+        err.validationError = e;
+        throw err;
+      }
     }
   }
+  if (["string", "function"].includes(typeof password)) {
+    hostInfo.password = password;
+  }
+  if (["string", "function"].includes(typeof passphrase)) {
+    hostInfo.password = password;
+  }
+  if (masterPty === null || typeof masterPty === "function") {
+    hostInfo.masterPty = masterPty;
+  }
+  return hostInfo;
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "2.2.1",
+  "version": "2.2.4",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",
@@ -34,12 +34,12 @@
     "*.js": "eslint --fix"
   },
   "dependencies": {
+    "ajv": "^8.12.0",
+    "ajv-keywords": "^5.1.0",
     "debug": "^4.3.4",
     "glob": "^10.3.10",
     "node-pty": "^0.10.1",
-    "nyc": "^15.1.0",
-    "promise-retry": "^2.0.1",
-    "rewire": "^7.0.0"
+    "promise-retry": "^2.0.1"
   },
   "devDependencies": {
     "chai": "^4.3.7",
@@ -47,14 +47,18 @@
     "chai-fs": "^2.0.0",
     "eslint": "^8.38.0",
     "eslint-config-eslint": "^7.0.0",
+    "eslint-config-standard": "^17.1.0",
     "eslint-plugin-chai-expect": "^3.0.0",
-    "eslint-plugin-chai-friendly": "^0.7.2",
-    "eslint-plugin-jsdoc": "^43.0.6",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-chai-friendly": "^0.7.4",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-promise": "^6.1.1",
     "fs-extra": "^11.1.1",
     "husky": "^8.0.0",
     "lint-staged": "^13.2.1",
     "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
+    "rewire": "^7.0.0",
     "sinon": "^15.0.3",
     "sinon-chai": "^3.7.0"
   }

package/run_test_all.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+docker-compose up testbed -d
+export TEST_HOST=localhost
+export TEST_USER=testuser
+export TEST_PW=passw0rd
+export TEST_PORT=4000
+npm run test
+docker-compose run --build --rm tester &&
+docker-compose run --build --rm tester-bullseye &&
+docker-compose run --build --rm tester-buster &&
+docker-compose rm --stop --force testbed

package/test/interface.js

@@ -33,20 +33,15 @@ describe("test for interface", ()=>{
       expect(()=>{
         //eslint-disable-next-line no-new
         new SshClientWrapper({});
-      }).to.throw("host must be non-empty string");
-      expect(()=>{
-        //eslint-disable-next-line no-new
-        new SshClientWrapper({ host: 1 });
-      }).to.throw("host must be non-empty string");
+      }).to.throw("host is required");
       expect(()=>{
         //eslint-disable-next-line no-new
         new SshClientWrapper({ host: "" });
-      }).to.throw("host must be non-empty string");
+      }).to.throw("empty host is not allowed");
     });
     it("should successfully instanciate only with host prop", ()=>{
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("exec");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("ls");
-      expect(new SshClientWrapper({ host: "hoge" })).to.have.property("watch");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("send");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("recv");
       expect(new SshClientWrapper({ host: "hoge" })).to.have.property("canConnect");

package/test/rsyncExec.js

@@ -28,7 +28,7 @@ const { checkRsyncVersion, send, recv } = require("../lib/rsyncExec.js");
 
 //test helpers
 const { sshExec, disconnect } = require("../lib/sshExec.js");
-const hostInfo = require("./util/hostInfo.js");
+const hostInfo = require("./testUtil/hostInfo.js");
 const {
   clearLocalTestFiles,
   clearRemoteTestFiles,
@@ -40,7 +40,7 @@ const {
   remoteRoot,
   remoteEmptyDir,
   remoteFiles
-} = require("./util/testFiles");
+} = require("./testUtil/testFiles");
 
 const formatLsOutput = (array)=>{
   const rt = [];

package/test/sshExec.js

@@ -17,8 +17,8 @@ const sshout = sinon.stub();
 const { sshExec, canConnect, disconnect, ls } = require("../lib/sshExec.js");
 
 //test helpers
-const hostInfo = require("./util/hostInfo.js");
-const { clearRemoteTestFiles, clearLocalTestFiles, createRemoteFiles, nonExisting, remoteRoot, remoteEmptyDir } = require("./util/testFiles.js");
+const hostInfo = require("./testUtil/hostInfo.js");
+const { clearRemoteTestFiles, clearLocalTestFiles, createRemoteFiles, nonExisting, remoteRoot, remoteEmptyDir } = require("./testUtil/testFiles.js");
 
 describe("test for ssh execution", function() {
   this.timeout(65000);//eslint-disable-line no-invalid-this
@@ -97,11 +97,11 @@ describe("test for ssh execution", function() {
     });
     it("should be rejected if port number is out of range(-1)", async ()=>{
       hostInfo2.port = -1;
-      return expect(canConnect(hostInfo2, 2)).to.be.rejectedWith(255);
+      return expect(canConnect(hostInfo2, 2)).to.be.rejectedWith("invalid port specified -1");
     });
     it("should be rejected if port number is out of range(65536)", async ()=>{
       hostInfo2.port = 65536;
-      return expect(canConnect(hostInfo2, 2)).to.be.rejectedWith(255);
+      return expect(canConnect(hostInfo2, 2)).to.be.rejectedWith("invalid port specified 65536");
     });
   });
   describe("#ls", ()=>{

package/test/{util → testUtil}/hostInfo.js

@@ -2,7 +2,7 @@
 module.exports = {
   host: process.env.TEST_HOST || "localhost",
   user: process.env.TEST_USER || null,
-  port: process.env.TEST_PORT || null,
+  port: process.env.TEST_PORT || 22,
   password: process.env.TEST_PW,
   passphrase: process.env.TEST_PH,
   keyFile: process.env.TEST_PRIVATE_KEY,

package/test/util.js

@@ -0,0 +1,76 @@
+"use strict";
+process.on("unhandledRejection", console.dir); //eslint-disable-line no-console
+
+//setup test framework
+const chai = require("chai");
+const { expect } = require("chai");
+chai.use(require("chai-as-promised"));
+
+
+//testee
+const { sanityCheck } = require("../lib/util.js");
+
+describe("test for sanityCheck", ()=>{
+  const host = "testHostName";
+  it("should throw error for empty host", ()=>{
+    expect(sanityCheck.bind(null, { host: "   ", user: "   ", port: 22 })).to.throw(/empty host is not allowed/);
+  });
+  it("should throw error if host is not in argument object", ()=>{
+    expect(sanityCheck.bind(null, { user: "   ", port: 22 })).to.throw(/host is required/);
+  });
+  it("should just remove empty string props", ()=>{
+    expect(sanityCheck({ host, user: "   ", port: 22 })).to.deep.equal({ host, port: 22 });
+  });
+  it("should remove empty string member in sshOpt", ()=>{
+    expect(sanityCheck({ host, sshOpt: ["foo", "  ", "bar"], user: "user", port: 33 })).to.deep.equal({ host, sshOpt: ["foo", "bar"], user: "user", port: 33 });
+  });
+  it("should just chage type if string value specified for number", ()=>{
+    expect(sanityCheck({
+      host,
+      port: "11",
+      ControlPersist: "22",
+      ConnectTimeout: "33",
+      maxRetry: "44",
+      retryMinTimeout: "55",
+      retryMaxTimeout: "66"
+    })).to.deep.equal({
+      host,
+      port: 11,
+      ControlPersist: 22,
+      ConnectTimeout: 33,
+      maxRetry: 44,
+      retryMinTimeout: 55,
+      retryMaxTimeout: 66
+    });
+  });
+  it("should remove out of range members", ()=>{
+    expect(sanityCheck({
+      host,
+      ControlPersist: "-1",
+      ConnectTimeout: "-1",
+      maxRetry: "-1",
+      retryMinTimeout: "-1",
+      retryMaxTimeout: "-1"
+    })).to.deep.equal({
+      host
+    });
+  });
+  it("should just chage type if string value specified for boolean member", ()=>{
+    expect(sanityCheck({
+      host,
+      noStrictHostkeyChecking: "true"
+    })).to.deep.equal({
+      host,
+      noStrictHostkeyChecking: true
+    });
+  });
+  it("should just chage type if number value specified for boolean member", ()=>{
+    expect(sanityCheck({
+      host,
+      noStrictHostkeyChecking: 0
+    })).to.deep.equal({
+      host,
+      noStrictHostkeyChecking: false
+    });
+  });
+});