ssh_tunnel_proxy 1.2.4 → 1.2.6

package/.vscode/launch.json

@@ -28,7 +28,7 @@
                 "<node_internals>/**"
             ],
             "program": "${file}",
-            "args":["-c","-d"]
+            "args":["-c","-e=uptime","-e=ls -all"]
         }
     ]
 }

package/lib/index.js

@@ -17,6 +17,7 @@ License: MIT
 */
 
 const net = require('net');
+const process = require('process');
 const { Client } = require('electron-ssh2');
 
 const KeypairStorage = require('./keypair_storage');
@@ -32,6 +33,7 @@ class SSHTunnelProxy extends Client {
         this.retries = 0;
         this.debug_en = false;
         this.debug_ssh = false;
+        this._tunnelReadyTimeout = undefined;
     }
 
     // function to close all active sockets for tunnel restart and exception handling
@@ -61,20 +63,29 @@ class SSHTunnelProxy extends Client {
                 return;
             }
 
+            stream.on('end', () => {
+                socket.resume();
+            });
+
             // pipe the data from the local socket to the remote port and visa versa
-            socket.pipe(stream);
-            stream.pipe(socket);
+            stream.pipe(socket).pipe(stream);
+
+            const shutdown_forward = () => {
+                stream.unpipe(socket);
+                socket.unpipe(stream);
+                stream.end();
+            }
 
             // if socket ends, close stream and pipes
             socket.on('close', () => {
-                stream.end();
+                shutdown_forward();
             });
 
             // if socket error, emit error and close stream
             socket.on('error', (err) => {
                 _this.emit('debug', err);
                 _this.debug_en && _this.debug('socket on error:', err);
-                stream.end();
+                shutdown_forward();
             });
         }
 
@@ -133,6 +144,10 @@ class SSHTunnelProxy extends Client {
                     // if all listeners have been successfully established, resolve setup connection
                     if (listeners++ >= proxy_ports.length - 1) {
                         _this.emit('ssh_tunnel_ready', {});
+                        if (_this._tunnelReadyTimeout) {
+                            clearTimeout(this._tunnelReadyTimeout);
+                            _this._tunnelReadyTimeout = undefined
+                        }
                         resolve();
                     }
                 });
@@ -142,6 +157,58 @@ class SSHTunnelProxy extends Client {
         });
     }
 
+    exec_next() {
+        const _this = this;
+        const remote_exec = (err, stream) => {
+            if (err) throw err;
+            stream.on('close', () => {
+                process.stdout.write('-- exec completed --\n\n');
+                if (!_this.exec_next()) process.exit();
+            }).on('data', (data) => {
+                process.stdout.write(data);
+            }).stderr.on('data', (data) => {
+                process.stderr.write(data);
+            });
+        }
+        if (this.exec_cmds.length > 0) {
+            const cmd = this.exec_cmds[0];
+            this.exec_cmds.shift();
+            console.log('$: ' + cmd);
+            this.exec(cmd, remote_exec);
+            return true;
+        }
+        return false;
+    }
+
+    // handle remote shell stream processing
+    remote_shell(err, stream) {
+        const _this = this;
+        if (err) throw err;
+
+        // disable local echo of input chars, use remote output only
+        process.stdin.setRawMode(true);
+
+        // forward data from local terminal to remote host
+        const stdinListener = (data) => {
+            stream.stdin.write(data);
+        };
+
+        // shutdown this process when stream ends (user logs out)
+        stream.on('close', function () {
+            process.stdin.setRawMode(false);
+            process.stdin.removeListener("data", stdinListener);
+            process.exit();
+        }).stderr.on('data', function (data) {
+            _this.debug_en && _this.debug('shell' + data);
+        });
+
+        // skip next stops double printing of input
+        stream.stdout.on("data", (data) => {
+            process.stdout.write(data);
+        })
+        process.stdin.on("data", stdinListener)
+    }
+
     // handle setting up ssh client and proxy forward ports
     do_ssh_connect(opts) {
 
@@ -161,7 +228,29 @@ class SSHTunnelProxy extends Client {
             }
 
             _this.on('ready', () => {
-                _this.on_ssh_client_ready(opts.server_name, opts.proxy_ports, resolve);
+
+                // stop any pending retry timeouts
+                if (_this._tunnelReadyTimeout) {
+                    clearTimeout(this._tunnelReadyTimeout);
+                    _this._tunnelReadyTimeout = undefined;
+                }
+
+                // if shell requested, enable remote terminal
+                if (opts.shell) {
+                    _this.shell(_this.remote_shell);
+
+                    // if exec requested, exec series of cmds
+                } else {
+                    if (opts.exec && opts.exec.length > 0) {
+                        _this.exec_cmds = opts.exec;
+                        _this.exec_next();
+                    }
+                }
+
+                // if local forward requested, setup local forwarding ports to remote host
+                if (opts.proxy_ports) {
+                    _this.on_ssh_client_ready(opts.server_name, opts.proxy_ports, resolve);
+                }
             });
 
             _this.on('end', () => {
@@ -178,6 +267,10 @@ class SSHTunnelProxy extends Client {
                 _this.debug_en && _this.debug('SSH Client :: error :: ' + err);
                 _this.emit('debug', err);
                 if (_this.listener[opts.server_name]) _this.listener[opts.server_name].isConnected = false;
+                if (_this._tunnelReadyTimeout) {
+                    clearTimeout(this._tunnelReadyTimeout);
+                    _this._tunnelReadyTimeout = undefined
+                }
                 _this.ssh_retry_connect(opts);
                 resolve();
             });
@@ -247,7 +340,7 @@ class SSHTunnelProxy extends Client {
         const invoke = () => {
             _this.connectSSH(opts);
         }
-        if (this.retries++ < 10) setTimeout(invoke, 5000);
+        if (this.retries++ < 10) this._tunnelReadyTimeout = setTimeout(invoke, 5000);
     }
 
     // attempt to establish ssh tunnel to server with supplied parameters.
@@ -262,7 +355,7 @@ class SSHTunnelProxy extends Client {
                     const msg = 'SSH connection to ' + opts.server_name + ' established at ' + hostport;
                     _this.debug(msg);
                 }
-                _this.emit('status', '', 'ready', hostport);
+                //_this.emit('status', '', 'ready', hostport);
                 _this.retries = 0;
                 resolve();
             });

package/main.js

@@ -5,6 +5,7 @@ const { SSHTunnelProxy, KeypairStorage } = require('./lib/index.js');
 const keypairStorage = new KeypairStorage();
 const homedir = require('os').homedir();
 var debug = false;
+var exec = [];
 var proxies = [];
 var configs = null;
 var host = null;
@@ -17,6 +18,7 @@ var ngrokAPIKey = null;
 var privateKey = null;
 var service = null;
 var account = null;
+var shell = null;
 
 function get_key_from_file(filename) {
     try {
@@ -50,15 +52,22 @@ function main(args) {
         const cmd = arg[0];
         const value = arg[1];
         switch (cmd) {
-            case '-d':
-            case '--debug':
-                debug = true;
+            case '--a':
+                account = value;
                 break;
             case '-c':
             case '--config':
                 if (value) get_config(value);
                 else get_default_config();
                 break;
+            case '-d':
+            case '--debug':
+                debug = true;
+                break;
+            case '-e':
+            case '--exec':
+                exec.push(value);
+                break;
             case '-h':
             case '--host':
                 host = value;
@@ -67,10 +76,6 @@ function main(args) {
             case '--port':
                 port = value;
                 break;
-            case '-u':
-            case '--username':
-                username = value;
-                break;
             case '-P':
             case '--password':
                 password = value;
@@ -79,24 +84,29 @@ function main(args) {
             case '--key':
                 privateKey = value;
                 break;
-            case '-s':
-            case '--service':
-                service = value;
-                break;
-            case '--a':
-                account = value;
-                break;
             case '-L':
             case '--LocalForward':
                 forwardOut.push(value);
                 break;
+            case '-n':
+            case '--ngrok':
+                ngrokAPIKey = value;
+                break;
             case '-R':
             case '--RemoteForward':
                 forwardIn.push(value);
                 break;
-            case '-n':
-            case '--ngrok':
-                ngrokAPIKey = value;
+            case '-s':
+            case '--service':
+                service = value;
+                break;
+            case '-S':
+            case '--shell':
+                shell = true;
+                break;
+            case '-u':
+            case '--username':
+                username = value;
                 break;
             default:
                 if (i > 1) console.log('Invalid argument:', arg);
@@ -139,7 +149,12 @@ function main(args) {
         else if (config.private_key) {
             config.private_key = get_key_from_file(config.private_key);
         }
-
+        if (shell) {
+            config.shell = true;
+        }
+        if (exec.length > 0) {
+            config.exec = exec;
+        }
         // create new tunnel and start connection
         var sshTunnelProxy = new SSHTunnelProxy();
         proxies.push(sshTunnelProxy);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh_tunnel_proxy",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "obtain ngrok host port from api and establish a ssh connection",
   "main": "lib/index.js",
   "scripts": {