Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpillora/node-ssh-http-agent
An HTTP agent for tunnelling through SSH connections
https://github.com/jpillora/node-ssh-http-agent
Last synced: 3 months ago
JSON representation
An HTTP agent for tunnelling through SSH connections
- Host: GitHub
- URL: https://github.com/jpillora/node-ssh-http-agent
- Owner: jpillora
- Created: 2017-10-03T05:43:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-16T13:05:39.000Z (over 6 years ago)
- Last Synced: 2024-10-10T23:04:25.248Z (3 months ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## `ssh-http-agent`
An HTTP Agent for tunneling through SSH
### Install
```
npm install --save ssh-http-agent
```
### Features
* Simple
* Single ssh client can make multiple requests
### Usage
Simple tunnel via `1.2.3.4`:
```js
const sshAgent = require("ssh-http-agent");
const http = require("http");
http.get(
{
agent: sshAgent.http({
host: "1.2.3.4",
port: 22,
username: "root",
password: "supersecret"
}),
host: "echo.jpillora.com",
path: "/foo/bar"
},
res => {
console.log(res.headers);
}
);
```
Nested tunnels:
```js
const sshAgent = require("ssh-http-agent");
const http = require("http");
http.get(
{
agent: sshAgent.http([
{
host: "first.hop.com",
username: "root",
password: "supersecret"
},
{
host: "second.hop.com",
username: "root",
password: "supersecret"
}
]),
host: "third.hop.com",
path: "/foo/bar"
},
res => {
console.log(res.headers);
}
);
```
With `request`:
```js
const sshAgent = require("ssh-http-agent");
const request = require("request");
request.get(
"http://echo.jpillora.com/foo/bar",
{
agent: sshAgent.http({
host: "1.2.3.4",
username: "root",
password: "supersecret"
})
},
(err, res, body) => {
console.log(err || body);
}
);
```
### API
Create an agent with:
* `sshAgent(httpAgent, sshConfig, opts)`
* `sshAgent.http(sshConfig, opts)`
* `sshAgent.https(sshConfig, opts)`
Where:
* `httpAgent` is an instance of
[`http.Agent`](https://nodejs.org/api/http.html#http_class_http_agent) or
[`https.Agent`](https://nodejs.org/api/https.html#https_class_https_agent)
* `sshConfig` is one or many `ssh2` client configuration
objects(https://github.com/mscdex/ssh2#client-methods)
* `opts` is an object with:
* `debug` is a `boolean` which enabled debug printing
* `disconnectDelay` is a `number` representing milliseconds to wait before
closing idle ssh connections, by default its set to 0ms, so as soon as the
last request completes, the parent ssh connection will be closed.
### Notes
* Requires Node 8+
#### MIT License
Copyright © 2017 Jaime Pillora <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.