node-tunnel - HTTP/HTTPS Agents for tunneling proxies

Example

1var tunnel = require('tunnel');
2
3var tunnelingAgent = tunnel.httpsOverHttp({
4  proxy: {
5    host: 'localhost',
6    port: 3128
7  }
8});
9
10var req = https.request({
11  host: 'example.com',
12  port: 443,
13  agent: tunnelingAgent
14});

Installation

$ npm install tunnel

Usages

HTTP over HTTP tunneling

1var tunnelingAgent = tunnel.httpOverHttp({
2  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets
3
4  proxy: { // Proxy settings
5    host: proxyHost, // Defaults to 'localhost'
6    port: proxyPort, // Defaults to 80
7    localAddress: localAddress, // Local interface if necessary
8
9    // Basic authorization for proxy server if necessary
10    proxyAuth: 'user:password',
11
12    // Header fields for proxy server if necessary
13    headers: {
14      'User-Agent': 'Node'
15    }
16  }
17});
18
19var req = http.request({
20  host: 'example.com',
21  port: 80,
22  agent: tunnelingAgent
23});

HTTPS over HTTP tunneling

1var tunnelingAgent = tunnel.httpsOverHttp({
2  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets
3
4  // CA for origin server if necessary
5  ca: [ fs.readFileSync('origin-server-ca.pem')],
6
7  // Client certification for origin server if necessary
8  key: fs.readFileSync('origin-server-key.pem'),
9  cert: fs.readFileSync('origin-server-cert.pem'),
10
11  proxy: { // Proxy settings
12    host: proxyHost, // Defaults to 'localhost'
13    port: proxyPort, // Defaults to 80
14    localAddress: localAddress, // Local interface if necessary
15
16    // Basic authorization for proxy server if necessary
17    proxyAuth: 'user:password',
18
19    // Header fields for proxy server if necessary
20    headers: {
21      'User-Agent': 'Node'
22    },
23  }
24});
25
26var req = https.request({
27  host: 'example.com',
28  port: 443,
29  agent: tunnelingAgent
30});

HTTP over HTTPS tunneling

1var tunnelingAgent = tunnel.httpOverHttps({
2  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets
3
4  proxy: { // Proxy settings
5    host: proxyHost, // Defaults to 'localhost'
6    port: proxyPort, // Defaults to 443
7    localAddress: localAddress, // Local interface if necessary
8
9    // Basic authorization for proxy server if necessary
10    proxyAuth: 'user:password',
11
12    // Header fields for proxy server if necessary
13    headers: {
14      'User-Agent': 'Node'
15    },
16
17    // CA for proxy server if necessary
18    ca: [ fs.readFileSync('origin-server-ca.pem')],
19
20    // Server name for verification if necessary
21    servername: 'example.com',
22
23    // Client certification for proxy server if necessary
24    key: fs.readFileSync('origin-server-key.pem'),
25    cert: fs.readFileSync('origin-server-cert.pem'),
26  }
27});
28
29var req = http.request({
30  host: 'example.com',
31  port: 80,
32  agent: tunnelingAgent
33});

HTTPS over HTTPS tunneling

1var tunnelingAgent = tunnel.httpsOverHttps({
2  maxSockets: poolSize, // Defaults to http.Agent.defaultMaxSockets
3
4  // CA for origin server if necessary
5  ca: [ fs.readFileSync('origin-server-ca.pem')],
6
7  // Client certification for origin server if necessary
8  key: fs.readFileSync('origin-server-key.pem'),
9  cert: fs.readFileSync('origin-server-cert.pem'),
10
11  proxy: { // Proxy settings
12    host: proxyHost, // Defaults to 'localhost'
13    port: proxyPort, // Defaults to 443
14    localAddress: localAddress, // Local interface if necessary
15
16    // Basic authorization for proxy server if necessary
17    proxyAuth: 'user:password',
18
19    // Header fields for proxy server if necessary
20    headers: {
21      'User-Agent': 'Node'
22    }
23
24    // CA for proxy server if necessary
25    ca: [ fs.readFileSync('origin-server-ca.pem')],
26
27    // Server name for verification if necessary
28    servername: 'example.com',
29
30    // Client certification for proxy server if necessary
31    key: fs.readFileSync('origin-server-key.pem'),
32    cert: fs.readFileSync('origin-server-cert.pem'),
33  }
34});
35
36var req = https.request({
37  host: 'example.com',
38  port: 443,
39  agent: tunnelingAgent
40});

CONTRIBUTORS

• Aleksis Brezas (abresas)
• Jackson Tian (JacksonTian)
• Dmitry Sorin (1999)

License

Licensed under the MIT license.