{ "_args": [ [ { "raw": "https-proxy-agent@^1.0.0", "scope": null, "escapedName": "https-proxy-agent", "name": "https-proxy-agent", "rawSpec": "^1.0.0", "spec": ">=1.0.0 <2.0.0", "type": "range" }, "/home/jdaugherty/work/GT2/GT2-Android/node_modules/proxy-agent" ] ], "_from": "https-proxy-agent@>=1.0.0 <2.0.0", "_id": "https-proxy-agent@1.0.0", "_inCache": true, "_location": "/https-proxy-agent", "_nodeVersion": "0.12.6", "_npmUser": { "name": "tootallnate", "email": "nathan@tootallnate.net" }, "_npmVersion": "2.11.2", "_phantomChildren": { "extend": "3.0.1" }, "_requested": { "raw": "https-proxy-agent@^1.0.0", "scope": null, "escapedName": "https-proxy-agent", "name": "https-proxy-agent", "rawSpec": "^1.0.0", "spec": ">=1.0.0 <2.0.0", "type": "range" }, "_requiredBy": [ "/pac-proxy-agent", "/proxy-agent" ], "_resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-1.0.0.tgz", "_shasum": "35f7da6c48ce4ddbfa264891ac593ee5ff8671e6", "_shrinkwrap": null, "_spec": "https-proxy-agent@^1.0.0", "_where": "/home/jdaugherty/work/GT2/GT2-Android/node_modules/proxy-agent", "author": { "name": "Nathan Rajlich", "email": "nathan@tootallnate.net", "url": "http://n8.io/" }, "bugs": { "url": "https://github.com/TooTallNate/node-https-proxy-agent/issues" }, "dependencies": { "agent-base": "2", "debug": "2", "extend": "3" }, "description": "An HTTP(s) proxy `http.Agent` implementation for HTTPS", "devDependencies": { "mocha": "2", "proxy": "~0.2.3", "semver": "~2.2.1" }, "directories": {}, "dist": { "shasum": "35f7da6c48ce4ddbfa264891ac593ee5ff8671e6", "tarball": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-1.0.0.tgz" }, "gitHead": "cb7577b6aa9a2466ca7612b1ebd6fc281407187f", "homepage": "https://github.com/TooTallNate/node-https-proxy-agent#readme", "keywords": [ "https", "proxy", "endpoint", "agent" ], "license": "MIT", "main": "https-proxy-agent.js", "maintainers": [ { "name": "tootallnate", "email": "nathan@tootallnate.net" } ], "name": "https-proxy-agent", "optionalDependencies": {}, "readme": "https-proxy-agent\n================\n### An HTTP(s) proxy `http.Agent` implementation for HTTPS\n[![Build Status](https://travis-ci.org/TooTallNate/node-https-proxy-agent.svg?branch=master)](https://travis-ci.org/TooTallNate/node-https-proxy-agent)\n\nThis module provides an `http.Agent` implementation that connects to a specified\nHTTP or HTTPS proxy server, and can be used with the built-in `https` module.\n\nSpecifically, this `Agent` implementation connects to an intermediary \"proxy\"\nserver and issues the [CONNECT HTTP method][CONNECT], which tells the proxy to\nopen a direct TCP connection to the destination server.\n\nSince this agent implements the CONNECT HTTP method, it also works with other\nprotocols that use this method when connecting over proxies (i.e. WebSockets).\nSee the \"Examples\" section below for more.\n\n\nInstallation\n------------\n\nInstall with `npm`:\n\n``` bash\n$ npm install https-proxy-agent\n```\n\n\nExamples\n--------\n\n#### `https` module example\n\n``` js\nvar url = require('url');\nvar https = require('https');\nvar HttpsProxyAgent = require('https-proxy-agent');\n\n// HTTP/HTTPS proxy to connect to\nvar proxy = process.env.http_proxy || 'http://168.63.76.32:3128';\nconsole.log('using proxy server %j', proxy);\n\n// HTTPS endpoint for the proxy to connect to\nvar endpoint = process.argv[2] || 'https://graph.facebook.com/tootallnate';\nconsole.log('attempting to GET %j', endpoint);\nvar opts = url.parse(endpoint);\n\n// create an instance of the `HttpsProxyAgent` class with the proxy server information\nvar agent = new HttpsProxyAgent(proxy);\nopts.agent = agent;\n\nhttps.get(opts, function (res) {\n console.log('\"response\" event!', res.headers);\n res.pipe(process.stdout);\n});\n```\n\n#### `ws` WebSocket connection example\n\n``` js\nvar url = require('url');\nvar WebSocket = require('ws');\nvar HttpsProxyAgent = require('https-proxy-agent');\n\n// HTTP/HTTPS proxy to connect to\nvar proxy = process.env.http_proxy || 'http://168.63.76.32:3128';\nconsole.log('using proxy server %j', proxy);\n\n// WebSocket endpoint for the proxy to connect to\nvar endpoint = process.argv[2] || 'ws://echo.websocket.org';\nvar parsed = url.parse(endpoint);\nconsole.log('attempting to connect to WebSocket %j', endpoint);\n\n// create an instance of the `HttpsProxyAgent` class with the proxy server information\nvar opts = url.parse(proxy);\n\n// IMPORTANT! Set the `secureEndpoint` option to `false` when connecting\n// over \"ws://\", but `true` when connecting over \"wss://\"\nopts.secureEndpoint = parsed.protocol ? parsed.protocol == 'wss:' : false;\n\nvar agent = new HttpsProxyAgent(opts);\n\n// finally, initiate the WebSocket connection\nvar socket = new WebSocket(endpoint, { agent: agent });\n\nsocket.on('open', function () {\n console.log('\"open\" event!');\n socket.send('hello world');\n});\n\nsocket.on('message', function (data, flags) {\n console.log('\"message\" event! %j %j', data, flags);\n socket.close();\n});\n```\n\nAPI\n---\n\n### new HttpsProxyAgent(opts)\n\nThe `HttpsProxyAgent` class implements an `http.Agent` subclass that connects\nto the specified \"HTTP(s) proxy server\" in order to proxy HTTPS and/or WebSocket\nrequests. This is achieved by using the [HTTP `CONNECT` method][CONNECT].\n\nThe `opts` argument may either be a string URI of the proxy server to use, or an\n\"options\" object with more specific properties:\n\n * `host` - String - Proxy host to connect to (may use `hostname` as well). Required.\n * `port` - Number - Proxy port to connect to. Required.\n * `secureProxy` - Boolean - If `true`, then use TLS to connect to the proxy. Defaults to `false`.\n * `secureEndpoint` - Boolean - If `true` then a TLS connection to the endpoint will be established on top of the proxy socket. Defaults to `true`.\n * Any other options given are passed to the `net.connect()`/`tls.connect()` functions.\n\n\nLicense\n-------\n\n(The MIT License)\n\nCopyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n[CONNECT]: http://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_Tunneling\n", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git://github.com/TooTallNate/node-https-proxy-agent.git" }, "scripts": { "test": "mocha --reporter spec" }, "version": "1.0.0" }