ssh-client-wrapper 2.1.1 → 2.2.1

package/lib/fork.js

@@ -1,7 +1,6 @@
 "use strict";
 const debug = require("debug")("sshClientWrapper:debug:fork");
 const debugVerbose = require("debug")("sshClientWrapper:verbose:fork");
-const debugMasterVerbose = require("debug")("sshClientWrapper:insecure:fork_masterPty");
 const debugSendPty = require("debug")("sshClientWrapper:insecure:fork_sendpty");
 const { spawn } = require("node-pty");
 
@@ -13,45 +12,53 @@ const nodePtyOpt = {
 };
 
 function sshLoginCallback(output, ptyProcess, pw, ph, logger = debugSendPty) {
-  if (reNewHostPrompt.test(output)) {
-    sendPty(ptyProcess, "yes\n", logger, 17);
-    return;
-  }
-  if (rePwPrompt.test(output)) {
-    if (typeof pw === "string") {
-      debug("use given password");
-      sendPty(ptyProcess, `${pw}\n`, logger, 23);
-      return;
-    }
-    if (typeof pw === "function") {
-      debug("call password callback function");
-      pw()
-        .then((v)=>{
-          sendPty(ptyProcess, `${v}\n`, logger, 30);
-        });
-      return;
+  return new Promise((resolve, reject)=>{
+    if (reNewHostPrompt.test(output)) {
+      sendPty(ptyProcess, "yes\n", logger, 17);
+      resolve();
     }
-  }
-  if (rePhPrompt.test(output)) {
-    if (typeof ph === "string") {
-      debug("use given passphrase");
-      sendPty(ptyProcess, `${ph}\n`, logger, 38);
-      return;
+    if (rePwPrompt.test(output)) {
+      if (typeof pw === "string") {
+        debug("use given password");
+        sendPty(ptyProcess, `${pw}\n`, logger, 23);
+        resolve();
+      }
+      if (typeof pw === "function") {
+        debug("call password callback function");
+        pw()
+          .then((v)=>{
+            sendPty(ptyProcess, `${v}\n`, logger, 30);
+          })
+          .catch((e)=>{
+            reject(e);
+          });
+        resolve();
+      }
     }
-    if (typeof ph === "function") {
-      debug("call passphrase callback function");
-      ph()
-        .then((v)=>{
-          sendPty(ptyProcess, `${v}\n`, logger, 45);
-        });
+    if (rePhPrompt.test(output)) {
+      if (typeof ph === "string") {
+        debug("use given passphrase");
+        sendPty(ptyProcess, `${ph}\n`, logger, 38);
+        resolve();
+      }
+      if (typeof ph === "function") {
+        debug("call passphrase callback function");
+        ph()
+          .then((v)=>{
+            sendPty(ptyProcess, `${v}\n`, logger, 45);
+          })
+          .catch((e)=>{
+            reject(e);
+          });
+      }
     }
-  }
+  });
 }
 
 /**
  * create pty for master ssh session and store to hostInfo.masterPty
  */
-function getMasterPty(hostInfo, logger) {
+function createMasterPty(hostInfo) {
   debug("fork pty for master connection");
 
   if (hostInfo.masterPty) {
@@ -59,11 +66,6 @@ function getMasterPty(hostInfo, logger) {
     hostInfo.masterPty.kill();
   }
   const ptyProcess = spawn(nodePtyOpt.shell, [], nodePtyOpt);
-  ptyProcess.onData(buff2String.bind(null, debugMasterVerbose));
-  ptyProcess.onData((data)=>{
-    const output = data.toString();
-    sshLoginCallback(output, ptyProcess, hostInfo.password, hostInfo.passphrase, logger);
-  });
   hostInfo.masterPty = ptyProcess;
 }
 
@@ -83,9 +85,10 @@ async function fork(hostInfo, cmd, args, timeout, outputCallback) {
     ptyProcess.onData(buff2String.bind(null, debugVerbose));
 
     if (hostInfo !== null) {
-      ptyProcess.onData((data)=>{
+      ptyProcess.onData(async (data)=>{
         const output = data.toString();
-        sshLoginCallback(output, ptyProcess, hostInfo.password, hostInfo.passphrase);
+        sshLoginCallback(output, ptyProcess, hostInfo.password, hostInfo.passphrase)
+          .catch(reject);
 
         if (/kex_exchange_identification: Connection closed by remote host/.test(output)) {
           ptyProcess.kill();
@@ -122,5 +125,6 @@ async function fork(hostInfo, cmd, args, timeout, outputCallback) {
 }
 module.exports = {
   fork,
-  getMasterPty
+  createMasterPty,
+  sshLoginCallback
 };

package/lib/sshExec.js

@@ -5,7 +5,7 @@ const debug = require("debug")("sshClientWrapper:debug:sshExec");
 const debugVerbose = require("debug")("sshClientWrapper:verbose:sshExec");
 const debugSendMasterPty = require("debug")("sshClientWrapper:insecure:sshExec_masterPty");
 const { sendPty, sshCmd, getSshOption, sanityCheck, watchDogTimer } = require("./util.js");
-const { fork, getMasterPty } = require("./fork.js");
+const { fork, createMasterPty, sshLoginCallback } = require("./fork.js");
 
 /**
  * Execute command on remote host.
@@ -15,6 +15,7 @@ const { fork, getMasterPty } = require("./fork.js");
  * @param {Function} outputCallback - Callback routine for stdout and stderr.
  */
 async function sshExec(hostInfo, cmd, timeout, outputCallback) {
+  debug("sshExec called");
   await connect(hostInfo);
   debug("exec", cmd, "on remote server");
   const args = getSshOption(hostInfo, false);
@@ -46,16 +47,13 @@ async function sshExec(hostInfo, cmd, timeout, outputCallback) {
  * @param {Integer} timeout - timeout in secconds
  */
 async function canConnect(hostInfo, timeout = 60) {
-  debug("sanity check");
+  debug("canConnect called");
   sanityCheck(hostInfo);
 
-  debug("check connectibity");
-
-  try {
-    await connect(hostInfo, timeout);
-  } finally {
-    await disconnect(hostInfo);
-  }
+  await connect(hostInfo, timeout);
+  await disconnect(hostInfo);
+  //if connection fail, Error is throwed.
+  //so, if we reach here, connection must be succeeded
   return true;
 }
 
@@ -97,16 +95,17 @@ async function existsMaster(hostInfo, argTimeout) {
  * @param {Object} hostInfo - hostinfo object
  */
 async function connect(hostInfo, timeout = 60) {
+  debug("connect called");
+
   if (await existsMaster(hostInfo, timeout)) {
     debugVerbose("master connection exists");
     return;
   }
 
   debug(`create master pty for ${hostInfo.host}`);
-  getMasterPty(hostInfo, debugSendMasterPty);
+  createMasterPty(hostInfo, debugSendMasterPty);
 
   debug(`create master ssh session to ${hostInfo.host}`);
-
   const words = crypto.randomUUID();
   const re = new RegExp(`^${words}`);
 
@@ -146,6 +145,11 @@ async function connect(hostInfo, timeout = 60) {
         reject(new Error("Operation timed out"));
       }
     });
+    hostInfo.masterPty.onData((data)=>{
+      const output = data.toString();
+      sshLoginCallback(output, hostInfo.masterPty, hostInfo.password, hostInfo.passphrase, debugSendMasterPty)
+        .catch(reject);
+    });
     hostInfo.masterPty.onExit((e)=>{
       debug("master pty exit", e);
       resolve(e);
@@ -172,6 +176,8 @@ async function connect(hostInfo, timeout = 60) {
  * @param {Object} hostInfo - hostinfo object
  */
 async function disconnect(hostInfo) {
+  debug("disconnect called");
+
   if (await existsMaster(hostInfo)) {
     const args = getSshOption(hostInfo);
     args.push("-Oexit");
@@ -213,6 +219,7 @@ async function disconnect(hostInfo) {
  * @returns {string[]} - output from ls
  */
 async function ls(hostInfo, target, lsOpt, timeout) {
+  debug("ls called");
   const outputArray = [];
   try {
     await sshExec(hostInfo, `ls ${lsOpt.join(" ")} ${target}`, timeout, (data)=>{

package/lib/util.js

@@ -26,6 +26,8 @@ const buff2String = (func, data)=>{
  * @param { Object} hostInfo - host information object defined in index.js
  */
 const sanityCheck = (hostInfo)=>{
+  debug("sanityCheck called");
+
   if (typeof hostInfo.host !== "string" || hostInfo.host === "") {
     throw new Error("host must be non-empty string");
   }
@@ -43,6 +45,7 @@ const sanityCheck = (hostInfo)=>{
  * @param {boolean} withoutDestination - return except for hostname
  */
 const getSshOption = (hostInfo, withoutDestination)=>{
+  debug("getSshOption called");
   const args = [];
 
   if (!withoutDestination) {
@@ -140,7 +143,7 @@ const watchDogTimer = (timeout, label, cb)=>{
     })
     .catch((err)=>{
       if (err.name === "AbortError") {
-        debug(`timeout was aborted because ${label} has done`);
+        debug(`timeout was aborted because ${label} has finished or canceled`);
       } else {
         throw err;
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-client-wrapper",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "description": "wrapper library for open ssh client and rsync",
   "keywords": [
     "ssh",
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "debug": "^4.3.4",
-    "glob": "^10.3.4",
+    "glob": "^10.3.10",
     "node-pty": "^0.10.1",
     "nyc": "^15.1.0",
     "promise-retry": "^2.0.1",