ssh_tunnel_proxy 1.2.6 → 1.2.8

package/.vscode/launch.json

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

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,44 @@ 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>"
+}]
+```
+
+Start a terminal session on the remote host:
+```
+node main.js -c -S
+```
+
+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

@@ -18,6 +18,7 @@ License: MIT
 
 const net = require('net');
 const process = require('process');
+const { Buffer } = require('node:buffer');
 const { Client } = require('electron-ssh2');
 
 const KeypairStorage = require('./keypair_storage');
@@ -157,27 +158,42 @@ 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);
+    exec_cmd(cmd, dataStream, errStream) {
+
+        return new Promise((resolve, reject) => {
+            var bufs = [];
+            var errs = [];
+
+            const remote_exec = (err, stream) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                stream.on('close', () => {
+                    var buf = Buffer.concat(bufs);
+                    var err = Buffer.concat(errs);
+                    resolve(buf, err);
+                })
+
+                if (dataStream) {
+                    stream.pipe(dataStream);
+                } else {
+                    stream.on('data', (data) => {
+                        bufs.push(data);
+                    })
+                }
+
+                if (errStream) {
+                    stream.stderr.pipe(errStream);
+                } else {
+                    stream.stderr.on('data', (data) => {
+                        errs.push(data);
+                    });
+                }
+
+            }
             this.exec(cmd, remote_exec);
-            return true;
-        }
-        return false;
+        })
     }
 
     // handle remote shell stream processing
@@ -227,7 +243,7 @@ class SSHTunnelProxy extends Client {
                 _this.listener[opts.server_name] = {};
             }
 
-            _this.on('ready', () => {
+            _this.on('ready', async () => {
 
                 // stop any pending retry timeouts
                 if (_this._tunnelReadyTimeout) {
@@ -242,14 +258,21 @@ class SSHTunnelProxy extends Client {
                     // if exec requested, exec series of cmds
                 } else {
                     if (opts.exec && opts.exec.length > 0) {
-                        _this.exec_cmds = opts.exec;
-                        _this.exec_next();
+                        for (var i = 0; i < opts.exec.length; i++) {
+                            var cmd = opts.exec[i];
+                            console.log(opts.username + '@' + opts.hostname + ':' + cmd);
+                            var result = await _this.exec_cmd(cmd);
+                            console.log(result.toString());
+                        }
+                        process.exit();
                     }
                 }
 
                 // 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);
+                } else {
+                    resolve();
                 }
             });
 
@@ -310,6 +333,9 @@ class SSHTunnelProxy extends Client {
 
     // validate local forwards for correct format and valid ports
     validate_local_forward(proxy_ports, whitelist) {
+
+        if (!proxy_ports) return;
+
         const local_ports = [];
         const remote_ports = [];
         proxy_ports.forEach(proxy_port => {

package/main.js

@@ -6,6 +6,7 @@ const keypairStorage = new KeypairStorage();
 const homedir = require('os').homedir();
 var debug = false;
 var exec = [];
+var remote_host = null;
 var proxies = [];
 var configs = null;
 var host = null;
@@ -92,6 +93,10 @@ function main(args) {
             case '--ngrok':
                 ngrokAPIKey = value;
                 break;
+            case '-r':
+            case '--remote':
+                remote_host = value;
+                break;
             case '-R':
             case '--RemoteForward':
                 forwardIn.push(value);
@@ -140,6 +145,9 @@ function main(args) {
         // skip tunnel if not enabled
         if (!config.enabled) return;
 
+        // if remote host specified, only select tunnel for remote host
+        if (remote_host && remote_host !== config.alias) return;
+
         // if system key storage name specified get key from system keychain
         if (config.server_name) {
             const service_name = config.service_name || 'ssh_tunnel_proxy';

package/package.json

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