UNPKG

ares-ide

Version:

A browser-based code editor and UI designer for Enyo 2 projects

47 lines (46 loc) 5.36 kB
{ "name": "tunnel", "version": "0.0.3", "description": "Node HTTP/HTTPS Agents for tunneling proxies", "keywords": [ "http", "https", "agent", "proxy" ], "homepage": "https://github.com/koichik/node-tunnel/", "author": { "name": "Koichi Kobayashi", "email": "koichik@improvement.jp" }, "main": "./index.js", "licenses": { "type": "The MIT License", "url": "http://www.opensource.org/licenses/mit-license.php" }, "repository": { "type": "git", "url": "https://github.com/koichik/node-tunnel" }, "engines": { "node": ">=0.6.11 <=0.7.0 || >=0.7.3" }, "devDependencies": { "mocha": "*", "should": "*" }, "scripts": { "test": "./node_modules/mocha/bin/mocha" }, "readme": "# node-tunnel - HTTP/HTTPS Agents for tunneling proxies\n\n## Example\n\n```javascript\nvar tunnel = require('tunnel');\n\nvar tunnelingAgent = tunnel.httpsOverHttp({\n proxy: {\n host: 'localhost',\n port: 3128\n }\n});\n\nvar req = https.request({\n host: 'example.com',\n port: 443,\n agent: tunnelingAgent\n});\n```\n\n## Installation\n\n $ npm install tunnel\n\n## Usages\n\n### HTTP over HTTP tunneling\n\n```javascript\nvar tunnelingAgent = tunnel.httpOverHttp({\n maxSockets: poolSize, // Defaults to 5\n\n proxy: { // Proxy settings\n host: proxyHost, // Defaults to 'localhost'\n port: proxyPort, // Defaults to 80\n localAddress: localAddress, // Local interface if necessary\n\n // Basic authorization for proxy server if necessary\n proxyAuth: 'user:password',\n\n // Header fields for proxy server if necessary\n headers: {\n 'User-Agent': 'Node'\n }\n }\n});\n\nvar req = http.request({\n host: 'example.com',\n port: 80,\n agent: tunnelingAgent\n});\n```\n\n### HTTPS over HTTP tunneling\n\n```javascript\nvar tunnelingAgent = tunnel.httpsOverHttp({\n maxSockets: poolSize, // Defaults to 5\n\n // CA for origin server if necessary\n ca: [ fs.readFileSync('origin-server-ca.pem')],\n\n // Client certification for origin server if necessary\n key: fs.readFileSync('origin-server-key.pem'),\n cert: fs.readFileSync('origin-server-cert.pem'),\n\n proxy: { // Proxy settings\n host: proxyHost, // Defaults to 'localhost'\n port: proxyPort, // Defaults to 80\n localAddress: localAddress, // Local interface if necessary\n\n // Basic authorization for proxy server if necessary\n proxyAuth: 'user:password',\n\n // Header fields for proxy server if necessary\n headers: {\n 'User-Agent': 'Node'\n },\n }\n});\n\nvar req = https.request({\n host: 'example.com',\n port: 443,\n agent: tunnelingAgent\n});\n```\n\n### HTTP over HTTPS tunneling\n\n```javascript\nvar tunnelingAgent = tunnel.httpOverHttps({\n maxSockets: poolSize, // Defaults to 5\n\n proxy: { // Proxy settings\n host: proxyHost, // Defaults to 'localhost'\n port: proxyPort, // Defaults to 443\n localAddress: localAddress, // Local interface if necessary\n\n // Basic authorization for proxy server if necessary\n proxyAuth: 'user:password',\n\n // Header fields for proxy server if necessary\n headers: {\n 'User-Agent': 'Node'\n },\n\n // CA for proxy server if necessary\n ca: [ fs.readFileSync('origin-server-ca.pem')],\n\n // Server name for verification if necessary\n servername: 'example.com',\n\n // Client certification for proxy server if necessary\n key: fs.readFileSync('origin-server-key.pem'),\n cert: fs.readFileSync('origin-server-cert.pem'),\n }\n});\n\nvar req = http.request({\n host: 'example.com',\n port: 80,\n agent: tunnelingAgent\n});\n```\n\n### HTTPS over HTTPS tunneling\n\n```javascript\nvar tunnelingAgent = tunnel.httpsOverHttps({\n maxSockets: poolSize, // Defaults to 5\n\n // CA for origin server if necessary\n ca: [ fs.readFileSync('origin-server-ca.pem')],\n\n // Client certification for origin server if necessary\n key: fs.readFileSync('origin-server-key.pem'),\n cert: fs.readFileSync('origin-server-cert.pem'),\n\n proxy: { // Proxy settings\n host: proxyHost, // Defaults to 'localhost'\n port: proxyPort, // Defaults to 443\n localAddress: localAddress, // Local interface if necessary\n\n // Basic authorization for proxy server if necessary\n proxyAuth: 'user:password',\n\n // Header fields for proxy server if necessary\n headers: {\n 'User-Agent': 'Node'\n }\n\n // CA for proxy server if necessary\n ca: [ fs.readFileSync('origin-server-ca.pem')],\n\n // Server name for verification if necessary\n servername: 'example.com',\n\n // Client certification for proxy server if necessary\n key: fs.readFileSync('origin-server-key.pem'),\n cert: fs.readFileSync('origin-server-cert.pem'),\n }\n});\n\nvar req = https.request({\n host: 'example.com',\n port: 443,\n agent: tunnelingAgent\n});\n```\n\n## License\n\nThis module is released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).\n", "readmeFilename": "README.md", "bugs": { "url": "https://github.com/koichik/node-tunnel/issues" }, "_id": "tunnel@0.0.3", "dist": { "shasum": "ce298b8011df1d3048c4d61d6752cc04f0c274b9" }, "_from": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.3.tgz", "_resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.3.tgz" }