ssh2shell 1.9.6 → 1.9.9

package/lib/ssh2shell.js

@@ -133,66 +133,74 @@
       response = this._sanitizeResponse().trim();
       passwordPrompt = this.passwordPrompt.test(response);
       standardPrompt = this.standardPrompt.test(response);
-      if (this.sshObj.verbose) {
-        this.emit('msg', this.sshObj.server.host + ": Password previously sent: " + this.sshObj.pwSent);
-      }
       if (this.sshObj.debug) {
-        this.emit('msg', this.sshObj.server.host + ": Password prompt: Password previously sent: " + this.sshObj.pwSent);
+        this.emit('msg', this.sshObj.server.host + ": Sudo Password prompt detected: " + passwordPrompt);
       }
-      if (this.sshObj.verbose) {
-        this.emit('msg', this.sshObj.server.host + ": Response: " + response);
+      if (this.sshObj.debug) {
+        this.emit('msg', this.sshObj.server.host + ": Sudo Password prompt: Password sent: " + this.sshObj.pwSent);
       }
-      if (this.sshObj.verbose) {
-        this.emit('msg', this.sshObj.server.host + ": Sudo Password Prompt: " + passwordPrompt);
+      if (this.sshObj.debug) {
+        this.emit('msg', this.sshObj.server.host + ": Sudo Password: " + this.sshObj.server.password);
       }
       if (this.sshObj.verbose) {
-        this.emit('msg', this.sshObj.server.host + ": Sudo Password: " + this.sshObj.server.password);
+        this.emit('msg', this.sshObj.server.host + ": Sudo Response: " + response);
       }
-      if (standardPrompt) {
-        if (this.sshObj.debug) {
-          this.emit('msg', this.sshObj.server.host + ": Password prompt: Standard prompt detected");
-        }
-        this._commandComplete();
-        return this.sshObj.pwSent = true;
-      } else if (!this.sshObj.pwSent) {
-        if (passwordPrompt) {
+      switch (true) {
+        case passwordPrompt && !this.sshObj.server.password:
+          if (this.sshObj.debug) {
+            this.emit('msg', this.sshObj.server.host + ": Sudo password prompt no password");
+          }
+          return this._resetFromSudoError();
+        case passwordPrompt && !this.sshObj.pwSent:
           if (this.sshObj.verbose) {
-            this.emit('msg', this.sshObj.server.host + ": Password prompt: Buffer: " + response);
+            this.emit('msg', this.sshObj.server.host + ": Sudo password prompt: Buffer: " + response);
           }
           if (this.sshObj.debug) {
-            this.emit('msg', this.sshObj.server.host + ": Password prompt: Send password ");
+            this.emit('msg', this.sshObj.server.host + ": Sudo password prompt: Send password ");
           }
           if (this.sshObj.verbose) {
-            this.emit('msg', this.sshObj.server.host + ": Sent password: " + this.sshObj.server.password);
+            this.emit('msg', this.sshObj.server.host + ": Sudo sent password: " + this.sshObj.server.password);
           }
           this.sshObj.pwSent = true;
           return this._runCommand("" + this.sshObj.server.password);
-        } else {
+        case passwordPrompt && this.sshObj.pwSent:
+          if (this.sshObj.verbose) {
+            this.emit('msg', this.sshObj.server.host + ": Sudo password faied: response: " + response);
+          }
+          if (this.sshObj.debug) {
+            this.emit('error', this.sshObj.server.host + ": Sudo password was incorrect for " + this.sshObj.server.userName + ", Sudo authentication");
+          }
           if (this.sshObj.debug) {
-            this.emit('msg', this.sshObj.server.host + ": Password prompt: not detected");
+            this.emit('msg', this.sshObj.server.host + ": Sudo failed password prompt: Password: [" + this.sshObj.server.password + "]");
           }
+          this.sshObj.pwSent = false;
+          return this._resetFromSudoError();
+        case standardPrompt:
+          if (this.sshObj.debug) {
+            this.emit('msg', this.sshObj.server.host + ": Sudo prompt: Standard prompt detected");
+          }
+          this.sshObj.pwSent = false;
           if (this.sshObj.verbose) {
-            this.emit('msg', this.sshObj.server.host + ": Password prompt " + this.sshObj.passwordPrompt);
+            this.emit('msg', this.sshObj.server.host + ": Sudo Standard Response: " + response);
           }
-          return this._runExit();
-        }
-      } else if (passwordPrompt) {
-        if (this.sshObj.verbose) {
-          this.emit('msg', this.sshObj.server.host + ": Sudo password faied: response: " + response);
-        }
-        if (this.sshObj.debug) {
-          this.emit('error', this.sshObj.server.host + ": Sudo password was incorrect for " + this.sshObj.server.userName, "Sudo authentication");
-        }
-        if (this.sshObj.debug) {
-          this.emit('msg', this.sshObj.server.host + ": Failed password prompt: Password: [" + this.sshObj.server.password + "]");
-        }
-        this.sshObj.sessionText += "" + this._buffer;
-        this._buffer = "";
-        this.command = "";
-        return this._stream.write('\x03');
+          return this._commandComplete();
+        default:
+          return this.idleTimer = setTimeout((function(_this) {
+            return function() {
+              return _this.emit('commandTimeout', _this.command, response, _this._stream, _this._connection);
+            };
+          })(this), this.idleTime);
       }
     };
 
+    SSH2Shell.prototype._resetFromSudoError = function() {
+      this.sshObj.pwSent = false;
+      this.sshObj.sessionText += "" + this._buffer;
+      this._buffer = "";
+      this.command = "";
+      return this._stream.write('\x03');
+    };
+
     SSH2Shell.prototype._processSSHPrompt = function() {
       var passphrasePrompt, passwordPrompt, response, standardPrompt, using;
       response = this._sanitizeResponse().trim();
@@ -225,22 +233,22 @@
           return this._runCommand("" + this.sshObj.server.passPhrase);
         } else if (standardPrompt) {
           if (this.sshObj.debug) {
-            this.emit('msg', this.sshObj.server.host + ": SSH: standard prompt: connection failed");
+            this.emit('msg', this.sshObj.server.host + ": SSH standard prompt: connection failed");
           }
           this.emit('msg', this.sshObj.server.host + ": SSH connection failed");
           this.emit('msg', this.sshObj.server.host + ": SSH failed response: " + response);
           this.sshObj.sessionText += this.sshObj.server.host + ": SSH failed: response: " + response;
           return this._runExit();
         } else {
-          this.emit('msg', this.sshObj.server.host + ": SSH: no prompt was not detected");
+          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 + ": Password prompt " + this.sshObj.passwordPrompt);
+            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 + ": 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 + ": Standard prompt " + this.sshObj.standardPrompt);
+            this.emit('msg', this.sshObj.server.host + ": SSH standard prompt " + this.sshObj.standardPrompt);
           }
           return this._runExit();
         }
@@ -268,9 +276,9 @@
           using = (function() {
             switch (false) {
               case !passwordPrompt:
-                return "password: " + this.sshObj.server.password;
+                return "SSH password: " + this.sshObj.server.password;
               case !passphrasePrompt:
-                return "passphrase: " + this.sshObj.server.passPhrase;
+                return "SSH passphrase: " + this.sshObj.server.passPhrase;
             }
           }).call(this);
           this.emit('error', this.sshObj.server.host + ": SSH authentication failed for " + this.sshObj.server.userName + "@" + this.sshObj.server.host, "Nested host authentication");
@@ -570,6 +578,7 @@
       this._commandComplete = bind(this._commandComplete, this);
       this._processNotifications = bind(this._processNotifications, this);
       this._processSSHPrompt = bind(this._processSSHPrompt, this);
+      this._resetFromSudoError = bind(this._resetFromSudoError, this);
       this._processPasswordPrompt = bind(this._processPasswordPrompt, this);
       this._sanitizeResponse = bind(this._sanitizeResponse, this);
       this._onData = bind(this._onData, this);
@@ -583,7 +592,7 @@
       } else {
         this.hosts = [hosts];
       }
-      this.ssh2Client = require('ssh2');
+      this.ssh2Client = require('ssh2').Client;
       this.on("newPrimmaryHost", this._nextPrimaryHost);
       this.on("data", (function(_this) {
         return function(data) {
@@ -927,34 +936,16 @@
       })(this));
       if (this.sshObj.server && this.sshObj.commands) {
         try {
-          this.connection.connect({
-            host: this.sshObj.server.host,
-            port: this.sshObj.server.port,
-            forceIPv4: this.sshObj.server.forceIPv4,
-            forceIPv6: this.sshObj.server.forceIPv6,
-            hostHash: this.sshObj.server.hashMethod,
-            hostVerifier: this.sshObj.server.hostVerifier,
-            username: this.sshObj.server.userName,
-            password: this.sshObj.server.password,
-            agent: this.sshObj.server.agent,
-            agentForward: this.sshObj.server.agentForward,
-            privateKey: this.sshObj.server.privateKey,
-            passphrase: this.sshObj.server.passPhrase,
-            localHostname: this.sshObj.server.localHostname,
-            localUsername: this.sshObj.server.localUsername,
-            localAddress: this.sshObj.server.localAddress,
-            localPort: this.sshObj.server.localPort,
-            authHandler: this.sshObj.server.authHandler,
-            tryKeyboard: this.sshObj.server.tryKeyboard,
-            keepaliveInterval: this.sshObj.server.keepaliveInterval,
-            keepaliveCountMax: this.sshObj.server.keepaliveCountMax,
-            readyTimeout: this.sshObj.server.readyTimeout,
-            sock: this.sshObj.server.sock,
-            strictVendor: this.sshObj.server.strictVendor,
-            algorithms: this.sshObj.server.algorithms,
-            compress: this.sshObj.server.compress,
-            debug: this.sshObj.server.debug
-          });
+          if (!this.sshObj.server.username) {
+            this.sshObj.server.username = this.sshObj.server.userName;
+          }
+          if (!this.sshObj.server.hostHash) {
+            this.sshObj.server.hostHash = this.sshObj.server.hashMethod;
+          }
+          if (!this.sshObj.server.passphrase) {
+            this.sshObj.server.passphrase = this.sshObj.server.passPhrase;
+          }
+          this.connection.connect(this.sshObj.server);
         } catch (error) {
           e = error;
           this.emit('error', e + " " + e.stack, "Connection.connect", true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh2shell",
-  "version": "1.9.6",
+  "version": "1.9.9",
   "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",
@@ -12,7 +12,7 @@
   },
   "devDependencies": {
     "coffee-script": "^1.12.7",
-    "dotenv": "^8.2.0"
+    "dotenv": "^8.6.0"
   },
   "scripts": {},
   "keywords": [

package/src/ssh2shell.coffee

@@ -88,45 +88,51 @@ class SSH2Shell extends Stream
     return @_buffer.replace(@command.substr(0, @_buffer.length), "")
 
   _processPasswordPrompt: =>
-    #First test for password prompt
+    #First test for password prompt    
     response = @_sanitizeResponse().trim()
     passwordPrompt =  @passwordPrompt.test(response)
     standardPrompt = @standardPrompt.test(response)
-    @.emit 'msg', "#{@sshObj.server.host}: Password previously sent: #{@sshObj.pwSent}" if @sshObj.verbose 
-    @.emit 'msg', "#{@sshObj.server.host}: Password prompt: Password previously sent: #{@sshObj.pwSent}" if @sshObj.debug
-    @.emit 'msg', "#{@sshObj.server.host}: Response: #{response}" if @sshObj.verbose
-    @.emit 'msg', "#{@sshObj.server.host}: Sudo Password Prompt: #{passwordPrompt}" if @sshObj.verbose
-    @.emit 'msg', "#{@sshObj.server.host}: Sudo Password: #{@sshObj.server.password}" if @sshObj.verbose
-    #normal prompt so continue with next command
-    if standardPrompt
-      @.emit 'msg', "#{@sshObj.server.host}: Password prompt: Standard prompt detected" if @sshObj.debug
-      @_commandComplete()
-      @sshObj.pwSent = true
-    #Password prompt detection
-    else unless @sshObj.pwSent
-      if passwordPrompt
-        @.emit 'msg', "#{@sshObj.server.host}: Password prompt: Buffer: #{response}" if @sshObj.verbose
-        @.emit 'msg', "#{@sshObj.server.host}: Password prompt: Send password " if @sshObj.debug
-        @.emit 'msg', "#{@sshObj.server.host}: Sent password: #{@sshObj.server.password}" if @sshObj.verbose
+    @.emit 'msg', "#{@sshObj.server.host}: Sudo Password prompt detected: #{passwordPrompt}" if @sshObj.debug
+    @.emit 'msg', "#{@sshObj.server.host}: Sudo Password prompt: Password sent: #{@sshObj.pwSent}" if @sshObj.debug
+    @.emit 'msg', "#{@sshObj.server.host}: Sudo Password: #{@sshObj.server.password}" if @sshObj.debug
+    @.emit 'msg', "#{@sshObj.server.host}: Sudo Response: #{response}" if @sshObj.verbose
+        
+    #Prompt detection
+    #no password
+    switch (true)    
+      when passwordPrompt and not @sshObj.server.password
+        @.emit 'msg', "#{@sshObj.server.host}: Sudo password prompt no password" if @sshObj.debug
+        @_resetFromSudoError()
+      when passwordPrompt and not @sshObj.pwSent
+        @.emit 'msg', "#{@sshObj.server.host}: Sudo password prompt: Buffer: #{response}" if @sshObj.verbose
+        @.emit 'msg', "#{@sshObj.server.host}: Sudo password prompt: Send password " if @sshObj.debug
+        @.emit 'msg', "#{@sshObj.server.host}: Sudo sent password: #{@sshObj.server.password}" if @sshObj.verbose
         #send password
         @sshObj.pwSent = true
         @_runCommand("#{@sshObj.server.password}")
-      else
-        @.emit 'msg', "#{@sshObj.server.host}: Password prompt: not detected" if @sshObj.debug
-        @.emit 'msg', "#{@sshObj.server.host}: Password prompt #{@sshObj.passwordPrompt}" if @sshObj.verbose        
-        @_runExit()
-    #password sent so either check for failure or run next command
-    else if passwordPrompt
+      when passwordPrompt and @sshObj.pwSent
         @.emit 'msg', "#{@sshObj.server.host}: Sudo password faied: response: #{response}" if @sshObj.verbose
-        @.emit 'error', "#{@sshObj.server.host}: Sudo password was incorrect for #{@sshObj.server.userName}", "Sudo authentication" if @sshObj.debug
-        @.emit 'msg', "#{@sshObj.server.host}: Failed password prompt: Password: [#{@sshObj.server.password}]" if @sshObj.debug
+        @.emit 'error', "#{@sshObj.server.host}: Sudo password was incorrect for #{@sshObj.server.userName}, Sudo authentication" if @sshObj.debug
+        @.emit 'msg', "#{@sshObj.server.host}: Sudo failed password prompt: Password: [#{@sshObj.server.password}]" if @sshObj.debug
+        @sshObj.pwSent = false
         #add buffer to sessionText so the sudo response can be seen
-        @sshObj.sessionText += "#{@_buffer}"
-        @_buffer = ""
-        #@sshObj.commands = []
-        @command = ""
-        @_stream.write '\x03'
-      
+        @_resetFromSudoError()
+      when standardPrompt
+        @.emit 'msg', "#{@sshObj.server.host}: Sudo prompt: Standard prompt detected" if @sshObj.debug
+        @sshObj.pwSent = false
+        @.emit 'msg', "#{@sshObj.server.host}: Sudo Standard Response: #{response}" if @sshObj.verbose
+        @_commandComplete()
+      else
+        @idleTimer = setTimeout( =>
+              @.emit 'commandTimeout', @.command, response, @._stream, @._connection
+          , @idleTime)
+
+  _resetFromSudoError: =>
+    @sshObj.pwSent = false
+    @sshObj.sessionText += "#{@_buffer}"
+    @_buffer = ""
+    @command = ""
+    @_stream.write '\x03'
 
   _processSSHPrompt: =>
     #not authenticated yet so detect prompts
@@ -156,16 +162,16 @@ class SSH2Shell extends Stream
         @_runCommand("#{@sshObj.server.passPhrase}")
       #normal prompt so continue with next command
       else if standardPrompt
-        @.emit 'msg', "#{@sshObj.server.host}: SSH: standard prompt: connection failed" if @sshObj.debug
+        @.emit 'msg', "#{@sshObj.server.host}: SSH standard prompt: connection failed" if @sshObj.debug
         @.emit 'msg', "#{@sshObj.server.host}: SSH connection failed" 
         @.emit 'msg', "#{@sshObj.server.host}: SSH failed response: #{response}"
         @sshObj.sessionText += "#{@sshObj.server.host}: SSH failed: response: #{response}"
         @_runExit()
       else
-        @.emit 'msg', "#{@sshObj.server.host}: SSH: no prompt was not detected"
-        @.emit 'msg', "#{@sshObj.server.host}: Password prompt #{@sshObj.passwordPrompt}" if @sshObj.verbose and not @sshObj.server.hasOwnProperty("passPhrase")        
-        @.emit 'msg', "#{@sshObj.server.host}: Passphrase prompt #{@sshObj.passphrasePrompt}" if @sshObj.verbose and @sshObj.server.hasOwnProperty("passPhrase")
-        @.emit 'msg', "#{@sshObj.server.host}: Standard prompt #{@sshObj.standardPrompt}" if @sshObj.verbose
+        @.emit 'msg', "#{@sshObj.server.host}: SSH no prompt was not detected"
+        @.emit 'msg', "#{@sshObj.server.host}: SSH password prompt #{@sshObj.passwordPrompt}" if @sshObj.verbose and not @sshObj.server.hasOwnProperty("passPhrase")        
+        @.emit 'msg', "#{@sshObj.server.host}: SSH passphrase prompt #{@sshObj.passphrasePrompt}" if @sshObj.verbose and @sshObj.server.hasOwnProperty("passPhrase")
+        @.emit 'msg', "#{@sshObj.server.host}: SSH standard prompt #{@sshObj.standardPrompt}" if @sshObj.verbose
         @_runExit()        
     else
       @.emit 'msg', "#{@sshObj.server.host}: SSH post authentication prompt detection" if @sshObj.debug
@@ -183,8 +189,8 @@ class SSH2Shell extends Stream
         @.emit 'msg', "#{@sshObj.server.host}: SSH: failed response: #{response}" if @sshObj.verbose
         @sshObj.sshAuth = false
         using = switch
-          when passwordPrompt then "password: #{@sshObj.server.password}"
-          when passphrasePrompt then "passphrase: #{@sshObj.server.passPhrase}"
+          when passwordPrompt then "SSH password: #{@sshObj.server.password}"
+          when passphrasePrompt then "SSH passphrase: #{@sshObj.server.passPhrase}"
         @.emit 'error', "#{@sshObj.server.host}: SSH authentication failed for #{@sshObj.server.userName}@#{@sshObj.server.host}", "Nested host authentication"
         @.emit 'msg', "#{@sshObj.server.host}: SSH auth failed: Using " + using if @sshObj.debug
         
@@ -378,7 +384,7 @@ class SSH2Shell extends Stream
       @hosts = hosts
     else
       @hosts = [hosts]
-    @ssh2Client = require('ssh2')  
+    @ssh2Client = require('ssh2').Client  
     @.on "newPrimmaryHost", @_nextPrimaryHost
     @.on "data", (data) =>
       #@.emit 'msg', "#{@sshObj.server.host}: data event: #{data}" if @sshObj.verbose
@@ -578,33 +584,10 @@ class SSH2Shell extends Stream
 
     if @sshObj.server and @sshObj.commands
       try
-        @connection.connect
-          host:             @sshObj.server.host
-          port:             @sshObj.server.port
-          forceIPv4:        @sshObj.server.forceIPv4
-          forceIPv6:        @sshObj.server.forceIPv6
-          hostHash:         @sshObj.server.hashMethod
-          hostVerifier:     @sshObj.server.hostVerifier
-          username:         @sshObj.server.userName
-          password:         @sshObj.server.password
-          agent:            @sshObj.server.agent
-          agentForward:     @sshObj.server.agentForward
-          privateKey:       @sshObj.server.privateKey
-          passphrase:       @sshObj.server.passPhrase
-          localHostname:    @sshObj.server.localHostname
-          localUsername:    @sshObj.server.localUsername
-          localAddress:     @sshObj.server.localAddress
-          localPort:        @sshObj.server.localPort
-          authHandler:      @sshObj.server.authHandler
-          tryKeyboard:      @sshObj.server.tryKeyboard
-          keepaliveInterval:@sshObj.server.keepaliveInterval
-          keepaliveCountMax:@sshObj.server.keepaliveCountMax
-          readyTimeout:     @sshObj.server.readyTimeout
-          sock:             @sshObj.server.sock
-          strictVendor:     @sshObj.server.strictVendor
-          algorithms:       @sshObj.server.algorithms
-          compress:         @sshObj.server.compress
-          debug:            @sshObj.server.debug
+        @sshObj.server.username = @sshObj.server.userName unless @sshObj.server.username
+        @sshObj.server.hostHash = @sshObj.server.hashMethod unless @sshObj.server.hostHash
+        @sshObj.server.passphrase = @sshObj.server.passPhrase unless @sshObj.server.passphrase
+        @connection.connect @sshObj.server
       catch e
         @.emit 'error', "#{e} #{e.stack}", "Connection.connect", true
     else

package/test/sudo no pass test.js

@@ -0,0 +1,40 @@
+var dotenv = require('dotenv').config();
+
+/*
+* Used `sudo visudo` to add `[username] ALL=(ALL) NOPASSWD: ALL` on the first test
+* server to test no password required detecting normal prompt correctly to run the 
+* next command
+*/
+var sshObj = {
+  server:             {     
+    host:         process.env.SERVER2_HOST,
+    port:         process.env.PORT,
+    userName:     process.env.SERVER2_USER_NAME,
+    password:     process.env.SERVER2_PASSWORD
+  },
+  commands:           ["sudo apt-get update","sudo apt-get upgrade", "sudo apt autoremove"],
+  userPromptSent:     false,
+  debug:              true,
+  verbose:            false,
+  onCommandProcessing: function( command, response, sshObj, stream ) {
+   //Check the command and prompt exits and respond with a 'y' but only does it once
+   if (response.indexOf("[Y/n]") != -1 && !sshObj.userPromptSent) {
+     sshObj.userPromptSent = true
+     stream.write("y")
+   }
+  },
+  onCommandComplete:   function( command, response, sshObj ) {
+      if(sshObj.userPromptSent){
+      sshObj.userPromptSent = false;
+      }
+  }
+}
+//until npm published use the cloned dir path.
+var SSH2Shell = require ('../lib/ssh2shell');
+
+//run the commands in the shell session
+var SSH = new SSH2Shell(sshObj);
+var callback = function(sessionText, sshObj) {
+		console.log(`Session End: ` + sessionText);
+	}
+SSH.connect(callback);