ssh_tunnel_proxy 1.1.0 → 1.1.2

package/README.md

@@ -3,8 +3,39 @@ Initiate a ssh reverse tunnel proxy with forwarding ports
 
 ssh_tunnel_proxy can function as a stand-alone api or part of an electron_js app. To establish a ssh tunnel proxy a keypair is generated on the client and stored in the system keychain.
 If a ngrok api key is provided the ngrok api endpoint method is invoked to obtain the hostport of
-the tunnel. A list of port forwards is provided to the connect_api function and ports validated to
-restrict connections to system ports on the remote host to a set of pre-defined ports such as http,https.
-After establishing a ssh connection to the remote server, local proxy port forwards are opened. If
-the connection is interrupted then the ssh_connect method will attempt to re-establish the connection.
+the tunnel. A list of port forwards is provided to the connect_api function and ports validated to restrict connections to system ports on the remote host to a set of pre-defined ports such as http,https. After establishing a ssh connection to the remote server, local proxy port forwards are opened. If the connection is interrupted then the ssh_connect method will attempt to re-establish the connection.
 
+Example code for electron_js:
+```js
+async function init_sshTunnelProxy(win) {
+
+  const SSHTunnelProxy = require('ssh_tunnel_proxy');
+  const sshTunnelProxy = new SSHTunnelProxy();
+  
+  ipcMain.on('connect_ssh_sync', async function(event,opts) {
+    // only allow connection on remote server to system ports http,https,ssh and user ports >1023
+    const portWhitelist = {
+      80:true,
+      443:true,
+      22:true
+    }
+    await sshTunnelProxy.connectSSH(opts, portWhitelist);
+    event.returnValue = 'connected';
+  });
+
+  ipcMain.on('generate_keypair', async (event, ...args) => await sshTunnelProxy.generateAndStoreKeypair(...args));
+
+  ipcMain.on('get_public_key', async (event, ...args) => await sshTunnelProxy.getPublicKey(...args));
+
+  ipcMain.on('network_online', (event, ...args) => sshTunnelProxy.onNetworkOnline(...args));
+
+  ipcMain.on('network_offline', (event, ...args) => sshTunnelProxy.onNetworkOffline(...args));
+
+  sshTunnelProxy.on('ready',(...args) => win.webContents.send('ready',...args));
+
+  sshTunnelProxy.on('debug',(...args) => win.webContents.send('debug',...args));
+
+  sshTunnelProxy.on('error',(...args) => win.webContents.send('error',...args));
+
+};
+```

package/lib/index.js

@@ -51,9 +51,6 @@ class sshTunnelProxy extends EventEmitter {
         });
     }
 
-    // ssh client debug function for verbose ssh connection details
-    debug_client = (debug_ssh) ? (msg) => { console.log(msg); } : null;
-
     // create forward out on socket connection
     setup_ssh_forward(ssh_client, socket, remote_hostname, remote_port) {
         const _this = this;
@@ -149,7 +146,7 @@ class sshTunnelProxy extends EventEmitter {
         return new Promise((resolve, reject) => {
 
             // exit if connection already established, avoid redundant connection on retry
-            if (_this.listener[opts.server_name] && listener[opts.server_name].isConnected) reject();
+            if (_this.listener[opts.server_name] && _this.listener[opts.server_name].isConnected) resolve();
 
             // close open sockets on server, otherwise initialize open sockets storage
             if (_this.listener[opts.server_name]) {
@@ -334,6 +331,9 @@ class sshTunnelProxy extends EventEmitter {
         keypairStorage.get_public_key_from_keychain(...args);
     }
 
+    // ssh client debug function for verbose ssh connection details
+    debug_client = (debug_ssh) ? (msg) => { console.log(msg); } : null;
+
     debug = (...args) => { console.log(...args); }
 
 }

package/package.json

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