Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/koichik/node-tunnel

Node HTTP/HTTPS Agents for tunneling proxies
https://github.com/koichik/node-tunnel

Last synced: 3 months ago
JSON representation

Node HTTP/HTTPS Agents for tunneling proxies

Host: GitHub
URL: https://github.com/koichik/node-tunnel
Owner: koichik
License: mit
Archived: true
Created: 2012-02-05T16:40:51.000Z (almost 13 years ago)
Default Branch: master
Last Pushed: 2021-10-06T14:51:49.000Z (over 3 years ago)
Last Synced: 2024-10-29T14:30:06.723Z (3 months ago)
Language: JavaScript
Homepage:
Size: 69.3 KB
Stars: 537
Watchers: 11
Forks: 78
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-nodejs - node-tunnel - Node HTTP/HTTPS Agents for tunneling proxies. ![](https://img.shields.io/github/stars/koichik/node-tunnel.svg?style=social&label=Star) (Repository / Network)
awesome-repositories - koichik/node-tunnel - Node HTTP/HTTPS Agents for tunneling proxies (JavaScript)

README

        # node-tunnel - HTTP/HTTPS Agents for tunneling proxies

[![Build Status](https://img.shields.io/travis/koichik/node-tunnel.svg?style=flat)](https://travis-ci.org/koichik/node-tunnel)

[![Dependency Status](http://img.shields.io/david/koichik/node-tunnel.svg?style=flat)](https://david-dm.org/koichik/node-tunnel#info=dependencies)

[![DevDependency Status](http://img.shields.io/david/dev/koichik/node-tunnel.svg?style=flat)](https://david-dm.org/koichik/node-tunnel#info=devDependencies)

## Example

```javascript

var tunnel = require('tunnel');

var tunnelingAgent = tunnel.httpsOverHttp({

  proxy: {

    host: 'localhost',

    port: 3128

  }

});

var req = https.request({

  host: 'example.com',

  port: 443,

  agent: tunnelingAgent

});

```

## Installation

    $ npm install tunnel

## Usages

### HTTP over HTTP tunneling

```javascript

var tunnelingAgent = tunnel.httpOverHttp({

  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets

  proxy: { // Proxy settings

    host: proxyHost, // Defaults to 'localhost'

    port: proxyPort, // Defaults to 80

    localAddress: localAddress, // Local interface if necessary

    // Basic authorization for proxy server if necessary

    proxyAuth: 'user:password',

    // Header fields for proxy server if necessary

    headers: {

      'User-Agent': 'Node'

    }

  }

});

var req = http.request({

  host: 'example.com',

  port: 80,

  agent: tunnelingAgent

});

```

### HTTPS over HTTP tunneling

```javascript

var tunnelingAgent = tunnel.httpsOverHttp({

  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets

  // CA for origin server if necessary

  ca: [ fs.readFileSync('origin-server-ca.pem')],

  // Client certification for origin server if necessary

  key: fs.readFileSync('origin-server-key.pem'),

  cert: fs.readFileSync('origin-server-cert.pem'),

  proxy: { // Proxy settings

    host: proxyHost, // Defaults to 'localhost'

    port: proxyPort, // Defaults to 80

    localAddress: localAddress, // Local interface if necessary

    // Basic authorization for proxy server if necessary

    proxyAuth: 'user:password',

    // Header fields for proxy server if necessary

    headers: {

      'User-Agent': 'Node'

    },

  }

});

var req = https.request({

  host: 'example.com',

  port: 443,

  agent: tunnelingAgent

});

```

### HTTP over HTTPS tunneling

```javascript

var tunnelingAgent = tunnel.httpOverHttps({

  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets

  proxy: { // Proxy settings

    host: proxyHost, // Defaults to 'localhost'

    port: proxyPort, // Defaults to 443

    localAddress: localAddress, // Local interface if necessary

    // Basic authorization for proxy server if necessary

    proxyAuth: 'user:password',

    // Header fields for proxy server if necessary

    headers: {

      'User-Agent': 'Node'

    },

    // CA for proxy server if necessary

    ca: [ fs.readFileSync('origin-server-ca.pem')],

    // Server name for verification if necessary

    servername: 'example.com',

    // Client certification for proxy server if necessary

    key: fs.readFileSync('origin-server-key.pem'),

    cert: fs.readFileSync('origin-server-cert.pem'),

  }

});

var req = http.request({

  host: 'example.com',

  port: 80,

  agent: tunnelingAgent

});

```

### HTTPS over HTTPS tunneling

```javascript

var tunnelingAgent = tunnel.httpsOverHttps({

  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets

  // CA for origin server if necessary

  ca: [ fs.readFileSync('origin-server-ca.pem')],

  // Client certification for origin server if necessary

  key: fs.readFileSync('origin-server-key.pem'),

  cert: fs.readFileSync('origin-server-cert.pem'),

  proxy: { // Proxy settings

    host: proxyHost, // Defaults to 'localhost'

    port: proxyPort, // Defaults to 443

    localAddress: localAddress, // Local interface if necessary

    // Basic authorization for proxy server if necessary

    proxyAuth: 'user:password',

    // Header fields for proxy server if necessary

    headers: {

      'User-Agent': 'Node'

    }

    // CA for proxy server if necessary

    ca: [ fs.readFileSync('origin-server-ca.pem')],

    // Server name for verification if necessary

    servername: 'example.com',

    // Client certification for proxy server if necessary

    key: fs.readFileSync('origin-server-key.pem'),

    cert: fs.readFileSync('origin-server-cert.pem'),

  }

});

var req = https.request({

  host: 'example.com',

  port: 443,

  agent: tunnelingAgent

});

```

## CONTRIBUTORS

* [Aleksis Brezas (abresas)](https://github.com/abresas)

* [Jackson Tian (JacksonTian)](https://github.com/JacksonTian)

* [Dmitry Sorin (1999)](https://github.com/1999)

## License

Licensed under the [MIT](https://github.com/koichik/node-tunnel/blob/master/LICENSE) license.