open-ssh-tunnel
Easy ssh tunneling function based on ssh2 library
Inspired by tunnel-ssh, but with simplified, more modern code.
Installation
npm install --save open-ssh-tunnel
Usage
const openSshTunnel = ; { const server = await ; // you can now connect to your // forwarded tcp port! // later, when you want to close the tunnel server; }
API
The module exports openSshTunnel
function. It return a promise that resolve
to a node net server instance if tunnel is opened, otherwise is rejected with an error.
Options
-
srcIP and srcPort as the originating address and port and dstIP and dstPort as the remote destination address and port. These are options passed to ssh2
Client.forwardOut
method. -
forwardTimeout - How many millisecond to wait before reject with a timeout error.
-
localAddr and localPort are the address and port of the local endpoint of the tunnel on your machine. They are passed to net server connect method.
-
All other options are passed to ssh2
Client.connect
method.
Related
- electron-tunnel - Awesome Electron app to manage your ssh tunnels - powered by this module.
License
The MIT License (MIT)
Copyright (c) 2015 parro-it