ssh_tunnel_proxy 1.2.5 → 1.2.7

package/.vscode/launch.json

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

package/README.md

@@ -3,9 +3,13 @@ Initiate a ssh reverse tunnel proxy with forwarding ports
 
 ssh_tunnel_proxy can function as a stand-alone api, nodejs command line script or as part of an electron_js app. To setup a ssh tunnel, parameters are suppled for host, port, authentication and a list of proxy ports. If a ngrok api key is provided the host and port of the ngrok tunnel are obtained. A list of port forwards is provided and is validated to restrict connections to system ports on the remote host to a list of pre-defined ports such as http or https. After establishing a ssh connection on the remote server, local proxy port forwards are opened. If the connection is interrupted or connection errors occur, attempts are made re-establish the tunnel.
 
-Example command line usage:
+Example command line to establish a list of local forwards:
 
-config file, located at:
+```
+node main.js -c
+```
+
+default config file, located at:
 ~/.config/ssh_tunnel_proxy/config.json
 ```json
 [{
@@ -28,21 +32,40 @@ config file, located at:
   "server_name": "test",
   "ngrok_api": "<ngrok api key>"
 }]
+```
 
+Command line to execute a series of commands on remote host:
+```
+node main.js -c -e='uptime' -e='ls -all'
 ```
-start tunnel with default config, located at ~/.config/ssh_tunnel_proxy/config.json
 
+Or execute commands defined in default config:
 ```
-node main.js -c -d
+node main.js -c
 ```
+```json
+[{
+  "enabled": true,
+  "username": "<username>",
+  "service_name": "ssh_proxy_client",
+  "server_name": "test",
+  "exec" : [
+    "uptime",
+    "ls -all"
+  ],
+  "ngrok_api": "<ngrok api key>"
+}]
+
+```
+
+The following code is an example of use of the api with electronjs.
 
-The following code is an example of use of the api with electronjs and is to be installed in main.js, preload.js and the render process.
 main.js:
 ```js
 
 async function init_sshTunnelProxy(win) {
 
-  const SSHTunnelProxy = require('ssh_tunnel_proxy');
+  const { SSHTunnelProxy } = require('ssh_tunnel_proxy');
   const sshTunnelProxy = new SSHTunnelProxy();
   
   ipcMain.on('connect_ssh_sync', async function(event,opts) {

package/lib/index.js

@@ -157,6 +157,29 @@ 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;
@@ -206,16 +229,27 @@ class SSHTunnelProxy extends Client {
 
             _this.on('ready', () => {
 
+                // 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();
+                    }
                 }
 
-                // setup local forwarding ports to remote host
-                _this.on_ssh_client_ready(opts.server_name, opts.proxy_ports, resolve);
-                if (_this._tunnelReadyTimeout) {
-                    clearTimeout(this._tunnelReadyTimeout);
-                    _this._tunnelReadyTimeout = undefined
+                // 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);
                 }
             });
 

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;
@@ -51,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;
@@ -68,10 +76,6 @@ function main(args) {
             case '--port':
                 port = value;
                 break;
-            case '-u':
-            case '--username':
-                username = value;
-                break;
             case '-P':
             case '--password':
                 password = value;
@@ -80,28 +84,29 @@ function main(args) {
             case '--key':
                 privateKey = value;
                 break;
-            case '-s':
-            case '--service':
-                service = value;
-                break;
-            case '-S':
-            case '--shell':
-                shell = true;
-                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);
@@ -145,9 +150,11 @@ function main(args) {
             config.private_key = get_key_from_file(config.private_key);
         }
         if (shell) {
-            config.shell=true;
+            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.5",
+  "version": "1.2.7",
   "description": "obtain ngrok host port from api and establish a ssh connection",
   "main": "lib/index.js",
   "scripts": {