Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markelog/adit
SSH tunnels – in any way you want it
https://github.com/markelog/adit
adit forwarding reverse ssh ssh-tunnel tunnel
Last synced: 17 days ago
JSON representation
SSH tunnels – in any way you want it
- Host: GitHub
- URL: https://github.com/markelog/adit
- Owner: markelog
- License: mpl-2.0
- Created: 2015-10-05T06:31:16.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-05T21:13:21.000Z (almost 8 years ago)
- Last Synced: 2024-10-28T22:35:14.038Z (about 1 month ago)
- Topics: adit, forwarding, reverse, ssh, ssh-tunnel, tunnel
- Language: JavaScript
- Homepage:
- Size: 128 KB
- Stars: 55
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs-cn - adit - SSH 相关工具 (包 / 其他)
- awesome-nodejs-cn - adit - **star:55** SSH隧道简化 (包 / 杂项)
- awesome-nodejs - adit - SSH tunneling made simple. (Packages / Miscellaneous)
- awesome-nodejs - adit - SSH tunnels – in any way you want it - ★ 21 (Miscellaneous)
- awesome-node - adit - SSH tunneling made simple. (Packages / Miscellaneous)
- awesome-nodejs-cn - adit - SSH 相关工具. (目录 / 其他)
- awesome-network-stuff - **28**星
README
# Adit [](https://travis-ci.org/markelog/adit) [](https://coveralls.io/github/markelog/adit?branch=master)
Forward all your stuff through ssh tunnel.
There is a lot of examples out there how this could be useful, for example, check out "[SSH Tunnel - Local and Remote Port Forwarding Explained With Examples](http://blog.trackets.com/2014/05/17/ssh-tunnel-local-and-remote-port-forwarding-explained-with-examples.html)"
## Usage
### ssh and `Adit`
```sh
$ ssh -L 9000:imgur.com:80 example.com
```
```js
new Adit('9000:imgur.com:80 example.com'/*, password*/).forward().then(adit => {
console.log('success');
adit.close();
});
```
`$ ssh -R 9000:localhost:3000 example.com`
```js
new Adit('9000:localhost:3000 example.com'/*, password*/).reverse().then(adit => {
console.log('success');
adit.close();
});
```
### Listen for events
```js
let server = new Adit(...);
server.on('ready', ...);
server.on('tcp connection', ...)
server.on('error', ...);
server.on('data', ...);
server.forward(...).then(...);
```
### Thorough
```js
import Adit from 'adit';
let adit = new Adit({
host: `example.com`
// Everything else is optional
// username: 'tester' // By default, `USER` environment variable will be used
// port: 22, // 22 By default
// Or port range -
// port: [22, 23], the first available port of the three will be used
// Also, see "Authentification strategy" below -
// "agent": "path",
// "password": "pass",
// "key": Buffer
});
// Or just
let adit = new Adit('example.com');
// `3` - is how many times we want to try to connect, before bailing out */
adit.open(3).then(connection => {
// At this point we established connection with remote server
// Forward all connections from **local** server to remote one
connection.out({
// from
host: 'example.com'
port: 80
}, {
// To
host: 'localhost'
port: 8080,
// Or port range -
// port: [25, 28], the first available port of the three will be used
}).then(() => {
// Forwarding is enabled
});
// Forward all connections from **remote** server to local one
connection.in({
// from
host: 'example.com'
port: 80,
// Or port range -
// port: [25, 28], the first available port of the three will be used
}, {
// To
host: 'localhost'
port: 8080
}).then(() => {
// Forwarding is enabled
});
}, error => {
console.error(error);
});
adit.on('error', () => {
// Report error
});
// Then, after awhile you would want to close it
adit.close();
```
## Authentification strategy
* If `password` is defined - use it
* If `agent` or `key` is defined explicitly - use one of them, prioritize the `agent`
* If `agent` or `key` is not passed - use environment varibles (`SSH_AUTH_SOCK` for `agent`)
Note: if `key` is used, assume it is added without passphrase, otherwise you should use `agent`