ssh2shell 1.9.10 → 2.0.3

package/lib/ssh2shell.js

@@ -18,7 +18,9 @@
 
     SSH2Shell.prototype.command = "";
 
-    SSH2Shell.prototype.hosts = [];
+    SSH2Shell.prototype._hosts = [];
+
+    SSH2Shell.prototype._sshToNextHost = false;
 
     SSH2Shell.prototype._primaryhostSessionText = "";
 
@@ -61,7 +63,7 @@
         }
         this.idleTimer = setTimeout((function(_this) {
           return function() {
-            return _this.emit('commandTimeout', _this.command, _this._buffer, _this._stream, _this._connection);
+            return _this.emit('commandTimeout', _this.command, _this._buffer, _this._stream, _this.connection);
           };
         })(this), this.idleTime);
       } else if (this.command.length < 1 && !this.standardPrompt.test(this._buffer)) {
@@ -76,15 +78,9 @@
             clearTimeout(_this.idleTimer);
           }
           if (!_this.sshObj.disableColorFilter) {
-            if (_this.sshObj.verbose && _this.sshObj.debug) {
-              _this.emit('msg', (_this.sshObj.server.host + ": text formatting filter: ") + _this.sshObj.textColorFilter + ", filtered: " + _this.textColorFilter.test(_this._buffer));
-            }
             _this._buffer = _this._buffer.replace(_this.textColorFilter, "");
           }
           if (!_this.sshObj.disableASCIIFilter) {
-            if (_this.sshObj.verbose && _this.sshObj.debug) {
-              _this.emit('msg', (_this.sshObj.server.host + ": Non-standard ASCII filtered: ") + _this.asciiFilter.test(_this._buffer));
-            }
             _this._buffer = _this._buffer.replace(_this.asciiFilter, "");
           }
           switch (true) {
@@ -93,7 +89,7 @@
                 _this.emit('msg', _this.sshObj.server.host + ": Sudo command data");
               }
               return _this._processPasswordPrompt();
-            case _this.command.length > 0 && _this.command.indexOf("ssh ") !== -1:
+            case _this.sshObj.sshToNextHost && _this.command.length > 0 && _this.command.indexOf("ssh ") === 0:
               if (_this.sshObj.debug) {
                 _this.emit('msg', _this.sshObj.server.host + ": SSH command data");
               }
@@ -117,7 +113,7 @@
                 _this.emit('msg', "Data processing: data received timeout");
               }
               return _this.idleTimer = setTimeout(function() {
-                return _this.emit('commandTimeout', _this.command, _this._buffer, _this._stream, _this._connection);
+                return _this.emit('commandTimeout', _this.command, _this._buffer, _this._stream, _this.connection);
               }, _this.idleTime);
           }
         };
@@ -148,7 +144,7 @@
       switch (true) {
         case passwordPrompt && !this.sshObj.server.password:
           if (this.sshObj.debug) {
-            this.emit('msg', this.sshObj.server.host + ": Sudo password prompt no password");
+            this.emit('msg', this.sshObj.server.host + ": Sudo password prompt no password set");
           }
           return this._resetFromSudoError();
         case passwordPrompt && !this.sshObj.pwSent:
@@ -177,7 +173,7 @@
           return this._resetFromSudoError();
         case standardPrompt:
           if (this.sshObj.debug) {
-            this.emit('msg', this.sshObj.server.host + ": Sudo prompt: Standard prompt detected");
+            this.emit('msg', this.sshObj.server.host + ": Sudo password accepted");
           }
           this.sshObj.pwSent = false;
           if (this.sshObj.verbose) {
@@ -241,14 +237,17 @@
           return this._runExit();
         } else {
           this.emit('msg', this.sshObj.server.host + ": SSH no prompt was not detected");
-          if (this.sshObj.verbose && !this.sshObj.server.hasOwnProperty("passPhrase")) {
-            this.emit('msg', this.sshObj.server.host + ": SSH password prompt " + this.sshObj.passwordPrompt);
+          if (this.sshObj.verbose) {
+            this.emit('msg', this.sshObj.server.host + ": SSH response: " + response);
+          }
+          if (this.sshObj.verbose && !this.sshObj.server.hasOwnProperty("password")) {
+            this.emit('msg', this.sshObj.server.host + ": SSH password prompt: " + this.sshObj.passwordPrompt);
           }
           if (this.sshObj.verbose && this.sshObj.server.hasOwnProperty("passPhrase")) {
-            this.emit('msg', this.sshObj.server.host + ": SSH passphrase prompt " + this.sshObj.passphrasePrompt);
+            this.emit('msg', this.sshObj.server.host + ": SSH passphrase prompt: " + this.sshObj.passphrasePrompt);
           }
           if (this.sshObj.verbose) {
-            this.emit('msg', this.sshObj.server.host + ": SSH standard prompt " + this.sshObj.standardPrompt);
+            this.emit('msg', this.sshObj.server.host + ": SSH standard prompt: " + this.sshObj.standardPrompt);
           }
           return this._runExit();
         }
@@ -260,9 +259,16 @@
           if (this.sshObj.debug) {
             this.emit('msg', this.sshObj.server.host + ": SSH complete: normal prompt");
           }
+          if (this.sshObj.showBanner) {
+            this.sshObj.sessionText += "\n " + response;
+          }
           this.sshObj.exitCommands.push("exit");
           this.emit('msg', "" + this.sshObj.connectedMessage);
           this.emit('msg', "" + this.sshObj.readyMessage);
+          if (this.sshObj.debug) {
+            this.emit('msg', this.sshObj.server.host + ": SSH complete: next command");
+          }
+          this.sshObj.sshToNextHost = false;
           return this._nextCommand();
         } else if (passwordPrompt || passphrasePrompt) {
           this.emit('msg', this.sshObj.server.host + ": SSH authentication failed");
@@ -286,7 +292,7 @@
             this.emit('msg', (this.sshObj.server.host + ": SSH auth failed: Using ") + using);
           }
           if (this.sshObj.verbose) {
-            this.emit('msg', this.sshObj.server.host + ": SSH resonse: " + response);
+            this.emit('msg', this.sshObj.server.host + ": SSH response: " + response);
           }
           if (this._connections.length > 0) {
             return this._previousHost();
@@ -330,7 +336,7 @@
     SSH2Shell.prototype._commandComplete = function() {
       var response;
       response = this._buffer.trim();
-      if (this.command !== "" && this.command !== "exit" && this.command.indexOf("ssh ") === -1) {
+      if (this.command !== "" && this.command !== "exit" && this.sshObj.sshToNextHost !== true) {
         if (this.sshObj.verbose) {
           this.emit('msg', this.sshObj.server.host + ": Command complete:\nCommand:\n " + this.command + "\nResponse: " + response);
         }
@@ -396,7 +402,7 @@
         if (this.sshObj.debug) {
           this.emit('msg', this.sshObj.server.host + ": Reload previous host");
         }
-        return this._loadDefaults(this._runExit);
+        return this._runExit();
       } else {
         return this._runExit();
       }
@@ -411,24 +417,32 @@
       if (this.sshObj.debug) {
         this.emit('msg', this.sshObj.server.host + ": Clearing previous event handlers");
       }
+      if (this.sshObj.debug) {
+        this.emit('msg', this.sshObj.server.host + ": Remove previous event handlers");
+      }
+      this._removeEvents();
       this._connections.push(this.sshObj);
       this.sshObj = nextHost;
       return this._initiate(this._sshConnect);
     };
 
-    SSH2Shell.prototype._nextPrimaryHost = function(callback) {
-      if (typeIsArray(this.hosts) && this.hosts.length > 0) {
+    SSH2Shell.prototype._nextPrimaryHost = function(connect) {
+      if (this._hosts.length > 0) {
         if (this.sshObj.server) {
           if (this.sshObj.debug) {
             this.emit('msg', this.sshObj.server.host + ": Current primary host");
           }
+          if (this.sshObj.debug) {
+            this.emit('msg', this.sshObj.server.host + ": Remove previous event handlers");
+          }
+          this._removeEvents();
         }
-        this.sshObj = this.hosts.shift();
+        this.sshObj = this._hosts.shift();
         this._primaryhostSessionText = this.sshObj.server.host + ": ";
         if (this.sshObj.debug) {
           this.emit('msg', this.sshObj.server.host + ": Next primary host");
         }
-        return this._initiate(callback);
+        return this._initiate(connect);
       } else {
         if (this.sshObj.debug) {
           this.emit('msg', this.sshObj.server.host + ": No more primary hosts");
@@ -487,6 +501,7 @@
       sshOptions += ' -o "StrictHostKeyChecking=no"';
       sshOptions += " -p " + this.sshObj.server.port;
       this.sshObj.sshAuth = false;
+      this.sshObj.sshToNextHost = true;
       this.command = "ssh " + sshFlags + " " + sshOptions + " " + this.sshObj.server.userName + "@" + this.sshObj.server.host;
       if (this.sshObj.debug) {
         this.emit('msg', this.sshObj.server.host + ": SSH command: connect");
@@ -504,6 +519,9 @@
         }
         this.command = this.sshObj.exitCommands.pop();
         if (this._connections && this._connections.length > 0) {
+          if (this.sshObj.verbose) {
+            this.emit('msg', this.sshObj.server.host + ": Primary host: " + this._connections[0].server.host);
+          }
           this._connections[0].sessionText += "\n" + this.sshObj.server.host + ": " + this.sshObj.sessionText;
         }
         return this._runCommand(this.command);
@@ -536,18 +554,29 @@
     };
 
     SSH2Shell.prototype._removeEvents = function() {
-      if (this.sshObj.debug) {
-        this.emit('msg', this.sshObj.server.host + ": Clearing host event handlers");
-      }
-      this.removeAllListeners('keyboard-interactive');
-      this.removeAllListeners("error");
+
+      /*
+      if @sshObj.debug
+        @.emit 'msg', "#{@sshObj.server.host}: Event handler count:"
+        @.emit 'msg', "keyboard-interactive: " + (@.listenerCount 'keyboard-interactive')
+        @.emit 'msg', "error: " + (@.listenerCount "error")
+        @.emit 'msg', "data: " + (@.listenerCount "data")
+        @.emit 'msg', "stderrData: " + (@.listenerCount "stderrData")
+        @.emit 'msg', "end: " + (@.listenerCount 'end')
+        @.emit 'msg', "commandProcessing: " + (@.listenerCount 'commandProcessing')
+        @.emit 'msg', "commandComplete: " + (@.listenerCount 'commandComplete')
+        @.emit 'msg', "commandTimeout: " + (@.listenerCount 'commandTimeout')
+        @.emit 'msg', "msg: " + (@.listenerCount 'msg')
+       */
       if (typeof this.sshObj.onData === 'function') {
         this.removeListener("data", this.sshObj.onData);
       }
+      this.removeAllListeners("error");
       if (typeof this.sshObj.onStderrData === 'function') {
         this.removeListener("stderrData", this.sshObj.onStderrData);
       }
       this.removeAllListeners('end');
+      this.removeAllListeners('keyboard-interactive');
       this.removeAllListeners('commandProcessing');
       this.removeAllListeners('commandComplete');
       this.removeAllListeners('commandTimeout');
@@ -587,10 +616,11 @@
       this.onCommandComplete = bind(this.onCommandComplete, this);
       this.onCommandProcessing = bind(this.onCommandProcessing, this);
       this._callback = bind(this._callback, this);
-      if (typeIsArray(hosts)) {
-        this.hosts = hosts;
+      SSH2Shell.__super__.constructor.call(this, hosts);
+      if (typeIsArray(hosts) && hosts.length > 0) {
+        this._hosts = hosts;
       } else {
-        this.hosts = [hosts];
+        this._hosts = [hosts];
       }
       this.ssh2Client = require('ssh2').Client;
       this.on("newPrimmaryHost", this._nextPrimaryHost);
@@ -604,80 +634,72 @@
           return console.error(data);
         };
       })(this));
-      this._allSessions = "";
-    }
-
-    SSH2Shell.prototype._initiate = function(callback) {
-      this._removeEvents();
-      if (this.sshObj.msg && this.sshObj.msg.send && typeof this.sshObj.msg.send === 'function') {
-        this.on("msg", this.sshObj.msg.send);
-      } else if (typeof this.sshObj.msg === 'function') {
-        this.on("msg", this.sshObj.msg);
-      } else {
-        this.on("msg", (function(_this) {
-          return function(message) {
-            return console.log(message);
-          };
-        })(this));
-      }
-      this._loadDefaults();
-      if (this.sshObj.debug) {
-        this.emit('msg', this.sshObj.server.host + ": initiate");
-      }
-      this.on("keyboard-interactive", (function(_this) {
-        return function(name, instructions, instructionsLang, prompts, finish) {
-          var str;
-          if (_this.sshObj.debug) {
-            _this.emit('msg', _this.sshObj.server.host + ": Class.keyboard-interactive");
-          }
-          if (_this.sshObj.verbose) {
-            _this.emit('msg', "name: " + name);
-            _this.emit('msg', "instructions: " + instructions);
-            str = JSON.stringify(prompts, null, 4);
-            return _this.emit('msg', "Prompts object: " + str);
-          }
-        };
-      })(this));
       this.on("error", (function(_this) {
         return function(err, type, close, callback) {
           if (close == null) {
             close = false;
           }
           if (_this.sshObj.debug) {
-            _this.emit('msg', _this.sshObj.server.host + ": Class.error");
+            _this.emit('msg', "Class.error: " + err + ", " + type);
           }
           if (err instanceof Error) {
             _this.emit('msg', "Error: " + err.message + ", Level: " + err.level);
           } else {
             _this.emit('msg', (type + " error: ") + err);
           }
-          if (typeof callback === 'function') {
-            callback(err, type);
-          }
           if (close) {
-            return _this.connection.end();
-          }
-        };
-      })(this));
-      this.on("end", (function(_this) {
-        return function(sessionText, sshObj) {
-          if (_this.sshObj.debug) {
-            return _this.emit('msg', _this.sshObj.server.host + ": Class.end");
+            return _this._stream.close();
           }
         };
       })(this));
-      if (typeof callback === 'function') {
-        return callback();
+      if (this._hosts[0].server.tryKeyboard) {
+        this.on("keyboard-interactive", (function(_this) {
+          return function(name, instructions, instructionsLang, prompts, finish) {
+            var str;
+            if (_this.sshObj.debug) {
+              _this.emit('msg', _this.sshObj.server.host + ": Class.keyboard-interactive");
+            }
+            if (_this.sshObj.verbose) {
+              _this.emit('msg', "name: " + name);
+              _this.emit('msg', "instructions: " + instructions);
+              str = JSON.stringify(prompts, null, 4);
+              return _this.emit('msg', "Prompts object: " + str);
+            }
+          };
+        })(this));
+      }
+      this._allSessions = "";
+    }
+
+    SSH2Shell.prototype._initiate = function(action) {
+      if (this.sshObj.debug) {
+        this.emit('msg', this.sshObj.server.host + ": initiate");
+      }
+      this._loadDefaults();
+      if (typeof action === 'function') {
+        return action();
       }
     };
 
-    SSH2Shell.prototype._loadDefaults = function(callback) {
+    SSH2Shell.prototype._loadDefaults = function() {
       var ref, ref1, ref2, ref3, ref4, ref5, ref6;
+      if (this.sshObj.msg && this.sshObj.msg.send && typeof this.sshObj.msg.send === 'function') {
+        this.on("msg", this.sshObj.msg.send);
+      } else if (this.sshObj.msg && typeof this.sshObj.msg === 'function') {
+        this.on("msg", this.sshObj.msg);
+      } else {
+        this.on("msg", (function(_this) {
+          return function(message) {
+            return console.log(message);
+          };
+        })(this));
+      }
       if (this.sshObj.debug) {
         this.emit('msg', this.sshObj.server.host + ": Load Defaults");
       }
       this.command = "";
       this._buffer = "";
+      this.sshObj.sshToNextHost = false;
       if (!this.sshObj.connectedMessage) {
         this.sshObj.connectedMessage = "Connected";
       }
@@ -787,10 +809,8 @@
           if (_this.sshObj.verbose) {
             _this.emit('msg', _this.sshObj.server.host + ": Timeout command: " + command + " response: " + response);
           }
-          _this._runExit();
-          return _this.emit("error", _this.sshObj.server.host + ": Command timed out after " + (_this.idleTime / 1000) + " seconds", "Timeout", true, function(err, type) {
-            return _this.sshObj.sessionText += _this._buffer;
-          });
+          _this.emit("error", _this.sshObj.server.host + ": Command timed out after " + (_this.idleTime / 1000) + " seconds", "Timeout", true, function(err, type) {});
+          return _this.sshObj.sessionText += _this._buffer;
         };
       })(this);
       if (typeof this.sshObj.onKeyboardInteractive === 'function') {
@@ -815,10 +835,7 @@
         this.emit('msg', this.sshObj.server.host + ": Host loaded");
       }
       if (this.sshObj.verbose) {
-        this.emit('msg', this.sshObj);
-      }
-      if (typeof callback === 'function') {
-        return callback();
+        return this.emit('msg', this.sshObj);
       }
     };
 
@@ -895,7 +912,7 @@
               }
               _this._primaryhostSessionText += _this.sshObj.sessionText + "\n";
               _this._allSessions += _this._primaryhostSessionText;
-              if (typeIsArray(_this.hosts) && _this.hosts.length === 0) {
+              if (_this._hosts.length === 0) {
                 _this.emit('end', _this._allSessions, _this.sshObj);
               }
               return _this._removeEvents();
@@ -922,12 +939,18 @@
           if (_this.sshObj.debug) {
             _this.emit('msg', _this.sshObj.server.host + ": Connection.close");
           }
+          if (_this.idleTimer) {
+            clearTimeout(_this.idleTimer);
+          }
+          if (_this.dataReceivedTimer) {
+            clearTimeout(_this.dataReceivedTimer);
+          }
           if (had_error) {
             _this.emit("error", had_error, "Connection close");
           } else {
             _this.emit('msg', _this.sshObj.closedMessage);
           }
-          if (typeIsArray(_this.hosts) && _this.hosts.length === 0) {
+          if (_this._hosts.length === 0) {
             if (typeof _this._callback === 'function') {
               return _this._callback(_this._allSessions);
             }

package/package.json

@@ -1,57 +1,57 @@
-{
-  "name": "ssh2shell",
-  "version": "1.9.10",
-  "author": "cmp-202",
-  "description": "A wrapper class for ssh2 to run multiple sequential commands in an SSH shell session, handle command responses, and tunnel through to other hosts using nested host objects",
-  "main": "./lib/ssh2shell.js",
-  "engines": {
-    "node": ">=4.5.0"
-  },
-  "dependencies": {
-    "ssh2": "^1.4.0"
-  },
-  "devDependencies": {
-    "coffee-script": "^1.12.7",
-    "dotenv": "^8.6.0"
-  },
-  "scripts": {},
-  "keywords": [
-    "SSH",
-    "ssh2",
-    "shell",
-    "server",
-    "client",
-    "multiple",
-    "command",
-    "commands",
-    "tunnel",
-    "deploy",
-    "host",
-    "hosts",
-    "automation",
-    "fingerprint",
-    "validation",
-    "hash",
-    "cipher",
-    "persistent",
-    "sequential",
-    "console",
-    "sudo",
-    "su",
-    "prompt",
-    "session",
-    "connection"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "http://github.com/cmp-202/ssh2shell"
-  },
-  "bugs": {
-    "url": "https://github.com/cmp-202/ssh2shell/issues"
-  },
-  "homepage": "https://github.com/cmp-202/ssh2shell/wiki",
-  "directories": {
-    "test": "test"
-  },
-  "license": "ISC"
-}
+{
+  "name": "ssh2shell",
+  "version": "2.0.3",
+  "author": "cmp-202",
+  "description": "A wrapper class for ssh2 to run multiple sequential commands in an SSH shell session, handle command responses, and tunnel through to other hosts using nested host objects",
+  "main": "./lib/ssh2shell.js",
+  "engines": {
+    "node": ">=4.5.0"
+  },
+  "dependencies": {
+    "ssh2": "^1.4.0"
+  },
+  "devDependencies": {
+    "coffee-script": "^1.12.7",
+    "dotenv": "^8.6.0"
+  },
+  "scripts": {},
+  "keywords": [
+    "SSH",
+    "ssh2",
+    "shell",
+    "server",
+    "client",
+    "multiple",
+    "command",
+    "commands",
+    "tunnel",
+    "deploy",
+    "host",
+    "hosts",
+    "automation",
+    "fingerprint",
+    "validation",
+    "hash",
+    "cipher",
+    "persistent",
+    "sequential",
+    "console",
+    "sudo",
+    "su",
+    "prompt",
+    "session",
+    "connection"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/cmp-202/ssh2shell"
+  },
+  "bugs": {
+    "url": "https://github.com/cmp-202/ssh2shell/issues"
+  },
+  "homepage": "https://github.com/cmp-202/ssh2shell/wiki",
+  "directories": {
+    "test": "test"
+  },
+  "license": "ISC"
+}