135 lines
4.2 KiB
Markdown
135 lines
4.2 KiB
Markdown
socks-proxy-agent
|
|
================
|
|
### A SOCKS proxy `http.Agent` implementation for HTTP and HTTPS
|
|
[](https://travis-ci.org/TooTallNate/node-socks-proxy-agent)
|
|
|
|
This module provides an `http.Agent` implementation that connects to a
|
|
specified SOCKS proxy server, and can be used with the built-in `http`
|
|
or `https` modules.
|
|
|
|
It can also be used in conjunction with the `ws` module to establish a WebSocket
|
|
connection over a SOCKS proxy. See the "Examples" section below.
|
|
|
|
Installation
|
|
------------
|
|
|
|
Install with `npm`:
|
|
|
|
``` bash
|
|
$ npm install socks-proxy-agent
|
|
```
|
|
|
|
|
|
Examples
|
|
--------
|
|
|
|
#### `http` module example
|
|
|
|
``` js
|
|
var url = require('url');
|
|
var http = require('http');
|
|
var SocksProxyAgent = require('socks-proxy-agent');
|
|
|
|
// SOCKS proxy to connect to
|
|
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:9050';
|
|
console.log('using proxy server %j', proxy);
|
|
|
|
// HTTP endpoint for the proxy to connect to
|
|
var endpoint = process.argv[2] || 'http://nodejs.org/api/';
|
|
console.log('attempting to GET %j', endpoint);
|
|
var opts = url.parse(endpoint);
|
|
|
|
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
|
var agent = new SocksProxyAgent(proxy);
|
|
opts.agent = agent;
|
|
|
|
http.get(opts, function (res) {
|
|
console.log('"response" event!', res.headers);
|
|
res.pipe(process.stdout);
|
|
});
|
|
```
|
|
|
|
#### `https` module example
|
|
|
|
``` js
|
|
var url = require('url');
|
|
var https = require('https');
|
|
var SocksProxyAgent = require('socks-proxy-agent');
|
|
|
|
// SOCKS proxy to connect to
|
|
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:9050';
|
|
console.log('using proxy server %j', proxy);
|
|
|
|
// HTTP endpoint for the proxy to connect to
|
|
var endpoint = process.argv[2] || 'https://encrypted.google.com/';
|
|
console.log('attempting to GET %j', endpoint);
|
|
var opts = url.parse(endpoint);
|
|
|
|
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
|
// NOTE: the `true` second argument! Means to use TLS encryption on the socket
|
|
var agent = new SocksProxyAgent(proxy, true);
|
|
opts.agent = agent;
|
|
|
|
https.get(opts, function (res) {
|
|
console.log('"response" event!', res.headers);
|
|
res.pipe(process.stdout);
|
|
});
|
|
```
|
|
|
|
#### `ws` WebSocket connection example
|
|
|
|
``` js
|
|
var WebSocket = require('ws');
|
|
var SocksProxyAgent = require('socks-proxy-agent');
|
|
|
|
// SOCKS proxy to connect to
|
|
var proxy = process.env.socks_proxy || 'socks://127.0.0.1:9050';
|
|
console.log('using proxy server %j', proxy);
|
|
|
|
// WebSocket endpoint for the proxy to connect to
|
|
var endpoint = process.argv[2] || 'ws://echo.websocket.org';
|
|
console.log('attempting to connect to WebSocket %j', endpoint);
|
|
|
|
// create an instance of the `SocksProxyAgent` class with the proxy server information
|
|
var agent = new SocksProxyAgent(proxy);
|
|
|
|
// initiate the WebSocket connection
|
|
var socket = new WebSocket(endpoint, { agent: agent });
|
|
|
|
socket.on('open', function () {
|
|
console.log('"open" event!');
|
|
socket.send('hello world');
|
|
});
|
|
|
|
socket.on('message', function (data, flags) {
|
|
console.log('"message" event! %j %j', data, flags);
|
|
socket.close();
|
|
});
|
|
```
|
|
|
|
License
|
|
-------
|
|
|
|
(The MIT License)
|
|
|
|
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
|
|
|
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.
|