ssh2shell 1.9.8 → 2.0.1

package/test/keyboard-interactivetest.js

@@ -9,35 +9,18 @@ var host = {
     tryKeyboard:  true
   },
   commands:           [
-    "`Test session text message: passed`",
-    "msg:console test notification: passed",
     "ls -la"
   ],
-  msg: {
-    send: function( message ) {
-      console.log(message);
-    }
-  },
-  verbose: true,
-  debug: true,
+  verbose: false,
+  debug: false,
   onEnd: function( sessionText, sshObj ){
     this.emit("msg", sessionText);
   }
-
 };
 //until npm published use the cloned dir path.
 var SSH2Shell = require ('../lib/ssh2shell');
 
 //run the commands in the shell session
 var SSH = new SSH2Shell(host);
-  
-//Add the keyboard-interactive handler
-SSH.on ('keyboard-interactive', function(name, instructions, instructionsLang, prompts, finish){
-     if (this.sshObj.debug) {
-       this.emit('msg', this.sshObj.server.host + ": instance.keyboard-interactive");
-     }
-     //if only the password is required then it will be the only thing returned in the array
-     finish([this.sshObj.server.password] );
-  });
-  
+
 SSH.connect();

package/test/lots of commands.js

@@ -0,0 +1,87 @@
+var dotenv = require('dotenv').config(),
+    fs = require('fs')
+
+var host = {
+  server:             {     
+    host:         process.env.HOST,
+    port:         process.env.PORT,
+    userName:     process.env.USER_NAME,
+    password:     process.env.PASSWORD
+  },
+  commands:           [
+    "msg: first",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "msg: 11",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "msg: 21",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update",
+    "sudo apt-get -y update"
+  ]
+};
+//until npm published use the cloned dir path.
+var SSH2Shell = require ('../lib/ssh2shell');
+
+//run the commands in the shell session
+var SSH = new SSH2Shell(host),
+locLog = fs.createWriteStream('Lots of commands.log')
+
+SSH.pipe( locLog );
+SSH.connect();

package/test/notificationstest.js

@@ -1,6 +1,6 @@
 var dotenv = require('dotenv').config()
 
-var sshObj = {
+var host = {
   server:             {     
     host:         process.env.HOST,
     port:         process.env.PORT,
@@ -8,7 +8,8 @@ var sshObj = {
     password:     process.env.PASSWORD
   },
   commands: [
-    "ls -l",
+    //hubot throwback
+    "msg: using msg.send",
     "`All done!`",
   ],
   msg: {
@@ -17,17 +18,19 @@ var sshObj = {
     }
   },
   verbose: false,
-  debug: false,
-  onEnd: function( sessionText, sshObj ){
-     //show the full session output. This could be emailed or saved to a log file.
-    this.emit("msg", "\nThis is the full session response:\n\n" + sessionText);
-  }
+  debug: 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 SSH = new SSH2Shell(host);
+
+var callback = function( sessionText ){
+  //show the full session output. This could be emailed or saved to a log file.
+  console.log("\nThis is the full session response: \n\n" + sessionText);
+}
+
+SSH.connect(callback);
 
-SSH.connect();

package/test/sshUserCommandsPosition.js

@@ -0,0 +1,26 @@
+var dotenv = require('dotenv').config()
+
+var sshObj = {
+  server:             {     
+    host:         process.env.HOST,
+    port:         process.env.PORT,
+    userName:     process.env.USER_NAME,
+    password:     process.env.PASSWORD,
+  },
+  commands:           [
+    "echo ssh",
+    "ssh -V",
+    "echo ssh middle"
+  ],  
+  verbose: false,
+  debug: 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);
+SSH.on('end', function( sessionText, sshObj ){
+      this.emit('msg', sessionText);
+  })
+SSH.connect();

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:            true,
+  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("n\n")
+   }
+  },
+  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);

package/test/timeouttest.js

@@ -13,7 +13,7 @@ self.sshObj.idleTimer = setTimeout(function(){
 //commandTimeout is actually a `didn't detect a defined prompt` timeout
 
 var dotenv = require('dotenv').config(),
-debug=true,
+debug=false,
 verbose=false
 
 var conParamsHost2 = {
@@ -40,22 +40,9 @@ host = {
   },
   commands:           [
     "msg:Testing idle time out",
-	"rm -r ~/scripts",
-    "mkdir ~/scripts",
-    "if [ ! -f ~/scripts/myscript.sh ]; then printf '#!/bin/bash\n#\n" +
-    "read -n 1 -p \"First prompt to trigger time out (y,n): \" test' > ~/scripts/myscript.sh; fi",
-    "sudo chmod 700 ~/scripts/myscript.sh",
-    "./scripts/myscript.sh",
-    "cd /home",
-    "cd ~",
-    "read -n 1 -p \"Second prompt to trigger time out (n,y): \" test",
+	"read -n 1 -p \"First prompt to put valid input (Y,n): \" test",
     "read -n 1 -p \"Final unhandled time out: \" test",
   ],
-  msg: {
-    send: function( message ) {
-      console.log(message)
-    }
-  },
   //can't use # and > because prompt detection triggers in the wrong place
   standardPrompt:     "$",
   verbose:            verbose,
@@ -64,71 +51,40 @@ host = {
   FirstPass:		  false,
   SecondPass:         false,
   onCommandTimeout: function( command, response, stream, connection ){
+   //this.emit("msg", "response: [[" + response + " ]]")
    if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": host.onCommandTimeout")}
-   //Here we are trying to handle a timeout from not getting a standard prompt from the host.
-   //The first check makes sure there is no command and the first try flag has not been set.   
-   //a second timeout timer is set to stop the script hanging.
-   //If that fails (no data response from host) then error messages are set. 
-   //The final code adds the text received so far to the session text and closes the connection with an error.
+
    var errorMessage, errorSource
-   if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": timeout")}
-   this.emit("msg", this.sshObj.server.host +  ": fp:" +this.sshObj.FirstPass+". sp:" +this.sshObj.SecondPass)
-   //use flags this.sshObj.connectedPass, this.sshObj.SecondPass and FirstPass to stop loops
-   if (command === "" && response.indexOf("Connected on port 22") != -1 && this.sshObj.connectedPass === true){
-     if(this.sshObj.debug){this.emit("msg", sshObj.server.host + ": Unusual connection prompt timeout second pass")}
-     //second failure so we set the error messages because we probably can't do anything more
-     //or add code to try something else 
-     errorMessage = "No prompt error"
-     errorSource = "No prompt timeout"
-     this.emit("msg", this.sshObj.server.host +  ": fp:" +this.sshObj.FirstPass+". sp:" +this.sshObj.SecondPass)
-   } else if (command === "" && this.sshObj.connectedPass != true ||  
-        response.indexOf("n,y") != -1 && this.sshObj.SecondPass != true || 
-        response.indexOf("y,n") != -1 && this.sshObj.FirstPass != true){
-       //first we are checking for the timeout coming after connection before a prompt is detected and before a command is loaded
-       //on the first try this.sshObj.sentN is not true as it hasn't been set yet
-       if ( command === "" && response.indexOf("Connected on port 22") != -1 && this.sshObj.connectedPass != true){
-         if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": Unusual connection prompt timeout first pass")}
-         //first attemp so set the flag we will use to ignor another timeout attempt
-         this.sshObj.sentN = true
-         
-         //send whatever is required to trigger a response
-         stream.write("\n")
-         //we want to skip the last part so return     
-         return true
-           
-       } else if (response.indexOf("y,n") != -1 && this.sshObj.FirstPass != true){
-         if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": First prompt to trigger timeout: Sending 'y' to the `(y,n):` prompt")}
-         this.sshObj.sessionText += response
+   //this.emit("msg", this.sshObj.server.host +  ": fp:" +this.sshObj.FirstPass)
+   
+   if (response.indexOf("(Y,n)") != -1 && this.sshObj.FirstPass != true){
+         if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": First prompt using correct input: Sending 'y' to the `(y,n):` prompt")}
+         this.sshObj.sessionText += response + this.sshObj.enter
          this._buffer = ""
          this.sshObj.FirstPass = true
-         stream.write("y\n")
          
-       } else if ( response.indexOf("n,y") != -1 && this.sshObj.SecondPass != true){
-        if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": Second to trigger timeout: Sending 'n' to the `(n,y):` prompt")}
-        this.sshObj.sessionText += response
-        this._buffer = ""
-        this.sshObj.SecondPass = true
-        stream.write("n\n")
-       }
-       if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": Stream.write sent so reset timmer to stop the script hanging")} 
-       
-        return
+         stream.write("y" + this.sshObj.enter)
+         return
+         
    }
+
    if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + "Final timeout: All attempts completed")}
    if(this.sshObj.debug){this.emit("msg", this.sshObj.server.host + ": Timeout details:" + this.sshObj.enter + "Command: " + command + " " + this.sshObj.enter + "Response: " + response)}
    
    //everything failed so update sessionText and raise an error event that closes the connection   
    if(!errorMessage){errorMessage = "Command"}
    if(!errorSource){errorSource = "Command Timeout"}   
-   this.emit("msg", this.sshObj.server.host + ": " + errorMessage + " timed out after " + (this.idleTime / 1000) + " seconds", errorSource, true) 
-   this.emit("end", response, this.sshObj)
+   //this.emit("msg", this.sshObj.server.host + ": " + errorMessage + " timed out after " + (this.idleTime / 1000) + " seconds", errorSource, true) 
+   //this.emit("end", response, this.sshObj)
+   this.sshObj.sessionText += response + this.sshObj.enter
+   this.close()
   },
   
   onEnd: function( sessionText, sshObj ) {
     if(this.sshObj.debug){this.emit("msg", sshObj.server.host + ": host.onEnd")}
     //show the full session output. self could be emailed or saved to a log file.
-    this.emit("msg", "\nThis is the full session response:\n\n" + this.sshObj.sessionText + sessionText + "\n")
-    this.close()
+    this.emit("msg", "\nThis is the full session response:\n\n" + this.sshObj.sessionText + "\n")
+    //this.close()
   }
 }
 //host1.hosts=[host]

package/test/tunneltest.js

@@ -25,7 +25,7 @@ var conParamsHost1 = {
 //Host objects:
 var host1 = {
   server:       conParamsHost1,
-  commands:     [],
+  commands:     [ "echo host1"],
   connectedMessage: "Connected to host1",
   debug: debug,
   verbose: verbose
@@ -41,7 +41,7 @@ host2 = {
 
 host3 = {
   server:       conParamsHost3,
-  commands:     [ "echo host3" ],
+  commands:     [ "echo host3"],
   connectedMessage: "Connected to host3",
   debug: debug,
   verbose: verbose

package/test/tunneltestSshUserCommands.js

@@ -0,0 +1,71 @@
+var dotenv = require('dotenv').config();
+
+var conParamsHost1 = {
+  host:         process.env.HOST,
+  port:         process.env.PORT,
+  userName:     process.env.USER_NAME,
+  password:     process.env.PASSWORD
+ },
+ conParamsHost2 = {
+  host:         process.env.SERVER2_HOST,
+  port:         process.env.PORT,
+  userName:     process.env.SERVER2_USER_NAME,
+  password:     process.env.SERVER2_PASSWORD
+ },
+ //set to fail
+ conParamsHost3 = {
+  host:         process.env.SERVER3_HOST,
+  port:         process.env.PORT,
+  userName:     process.env.SERVER3_USER_NAME,
+  password:     process.env.SERVER3_PASSWORD
+ },
+ debug = false,
+ verbose = false
+
+//Host objects:
+var host1 = {
+  server:       conParamsHost1,
+  commands:     [ "echo host1", "ssh -V"],
+  connectedMessage: "Connected to host1",
+  debug: debug,
+  verbose: verbose
+},
+
+host2 = {
+  server:       conParamsHost2,
+  commands:     [ "echo host2", "echo ssh" ],
+  connectedMessage: "Connected to host2",
+  debug: debug,
+  verbose: verbose
+},
+
+host3 = {
+  server:       conParamsHost3,
+  commands:     [ "echo host3", "echo ssh middle"],
+  connectedMessage: "Connected to host3",
+  debug: debug,
+  verbose: verbose
+}
+
+//host2.hosts = [ host3 ];
+//Set the two hosts you are tunnelling to through host1
+host1.hosts = [ host2, host3  ];
+
+//or the alternative nested tunnelling method outlined above:
+//host2.hosts = [ host3 ];ssh -q george@192.168.0.129 "echo 2>&1" && echo OK || echo NOK
+//host1.hosts = [ host2 ];
+
+//Create the new instance
+//or SSH2Shell = require ('ssh2shell')
+var SSH2Shell = require ('../lib/ssh2shell'),
+    SSH = new SSH2Shell(host1),
+    callback = function( sessionText ){
+          console.log ( "-----Callback session text:\n" + sessionText);
+          console.log ( "-----Callback end" );
+    }
+
+
+//Start the process
+SSH.connect(callback);
+
+