Provide http and https agents for proxy.

Change proxy options structure and auto populate socks HTTP agents.

Author: yciabaud

README.md

@@ -73,26 +73,43 @@ var optionalOpts = {
       customParam: 'blah' // custom parameters supported
     }
   },
-  // NodeJS HTTP agent implementation (used to proxy HTTP and Websocket requests in node)
-  httpAgent: {},
-  // Socks proxy options (used to proxy UDP requests in node)
-  socksProxyOpts: {
-      // Configuration from socks module (https://github.com/JoshGlazebrook/socks)
-      proxy: {
-          // IP Address of Proxy (Required)
-          ipaddress: "1.2.3.4",
-          // TCP Port of Proxy (Required)
-          port: 1080,
-          // Proxy Type 5 (Required)
-          // Type 4 does not support UDP association relay 
-          type: 5,
 
-          // Authentication used for SOCKS 5 (when it's required) (Optional)
-          authentication: {
-              username: "Josh",
-              password: "somepassword"
-          }
-      }
+  proxyOpts: {
+      // Socks proxy options (used to proxy requests in node)
+      socksProxyOpts: {
+          // Configuration from socks module (https://github.com/JoshGlazebrook/socks)
+          proxy: {
+              // IP Address of Proxy (Required)
+              ipaddress: "1.2.3.4",
+              // TCP Port of Proxy (Required)
+              port: 1080,
+              // Proxy Type [4, 5] (Required)
+              // Note: 4 works for both 4 and 4a.
+              // Type 4 does not support UDP association relay 
+              type: 5,
+              
+              // SOCKS 4 Specific:
+              
+              // UserId used when making a SOCKS 4/4a request. (Optional)
+              userid: "someuserid",
+
+              // SOCKS 5 Specific:
+      
+              // Authentication used for SOCKS 5 (when it's required) (Optional)
+              authentication: {
+                  username: "Josh",
+                  password: "somepassword"
+              }
+          },
+          
+          // Amount of time to wait for a connection to be established. (Optional)
+          // - defaults to 10000ms (10 seconds)
+          timeout: 10000
+      },
+      // NodeJS HTTP agents (used to proxy HTTP and Websocket requests in node)
+      // Populated with Socks.Agent if socksProxyOpts is provided
+      httpAgent: {},
+      httpsAgent: {}
   }
 }
 

client.js

@@ -8,6 +8,7 @@ var inherits = require('inherits')
 var once = require('once')
 var parallel = require('run-parallel')
 var Peer = require('simple-peer')
+var Socks = require('socks')
 var uniq = require('uniq')
 var url = require('url')
 
@@ -31,8 +32,7 @@ inherits(Client, EventEmitter)
  * @param {function} opts.getAnnounceOpts        callback to provide data to tracker
  * @param {number} opts.rtcConfig                RTCPeerConnection configuration object
  * @param {number} opts.wrtc                     custom webrtc impl (useful in node.js)
- * @param {object} opts.httpAgent                HTTP agent impl (used to proxy http requests in node.js)
- * @param {object} opts.socksProxyOpts           socks proxy options (used to proxy UDP requests in node.js)
+ * @param {object} opts.proxyOpts                proxy options (useful in node.js)
  */
 function Client (opts) {
   var self = this
@@ -64,9 +64,16 @@ function Client (opts) {
 
   self._rtcConfig = opts.rtcConfig
   self._wrtc = opts.wrtc
-  self._httpAgent = opts.httpAgent
-  self._socksProxyOpts = opts.socksProxyOpts
   self._getAnnounceOpts = opts.getAnnounceOpts
+  self._proxyOpts = opts.proxyOpts
+
+  // Create HTTP agents from socks proxy if needed
+  if (self._proxyOpts && self._proxyOpts.socksProxy && !self._proxyOpts.httpAgent) {
+    self._proxyOpts.httpAgent = new Socks.Agent(self._proxyOpts.socksProxy, false)
+  }
+  if (self._proxyOpts && self._proxyOpts.socksProxy && !self._proxyOpts.httpsAgent) {
+    self._proxyOpts.httpsAgent = new Socks.Agent(self._proxyOpts.socksProxy, true)
+  }
 
   debug('new client %s', self.infoHash)
 

lib/client/http-tracker.js

@@ -6,6 +6,7 @@ var debug = require('debug')('bittorrent-tracker:http-tracker')
 var extend = require('xtend')
 var get = require('simple-get')
 var inherits = require('inherits')
+var url = require('url')
 
 var common = require('../common')
 var Tracker = require('./tracker')
@@ -87,9 +88,15 @@ HTTPTracker.prototype.destroy = function (cb) {
 
 HTTPTracker.prototype._request = function (requestUrl, params, cb) {
   var self = this
+  var parsedUrl = url.parse(requestUrl + (requestUrl.indexOf('?') === -1 ? '?' : '&') + common.querystringStringify(params))
+  var agent
+  if (self.client._proxyOpts) {
+    agent = parsedUrl.protocol === 'https:'
+      ? self.client._proxyOpts.httpsAgent : self.client._proxyOpts.httpAgent
+  }
   var u = {
-    url: requestUrl + (requestUrl.indexOf('?') === -1 ? '?' : '&') + common.querystringStringify(params),
-    agent: self.client._httpAgent
+    url: parsedUrl,
+    agent: agent
   }
 
   get.concat(u, function (err, res, data) {

lib/client/udp-tracker.js

@@ -75,21 +75,23 @@ UDPTracker.prototype._request = function (opts) {
   // Contains the host/port of the socks relay
   var relay
   var transactionId = genTransactionId()
-  if (self.client._socksProxyOpts) {
-    if (!self.client._socksProxyOpts.proxy) {
-      self.client._socksProxyOpts.proxy = {}
+
+  var proxyOpts = self.client._proxyOpts && self.client._proxyOpts.socksProxy
+  if (proxyOpts) {
+    if (!proxyOpts.proxy) {
+      proxyOpts.proxy = {}
     }
     // UDP requests uses the associate command
-    self.client._socksProxyOpts.proxy.command = 'associate'
-    if (!self.client._socksProxyOpts.target) {
+    proxyOpts.proxy.command = 'associate'
+    if (!proxyOpts.target) {
       // This should contain client IP and port but can be set to 0 if we don't have this information
-      self.client._socksProxyOpts.target = {
+      proxyOpts.target = {
         host: '0.0.0.0',
         port: 0
       }
     }
 
-    Socks.createConnection(self.client._socksProxyOpts, onGotConnection)
+    Socks.createConnection(proxyOpts, onGotConnection)
   } else {
     onGotConnection(null)
   }
@@ -141,7 +143,7 @@ UDPTracker.prototype._request = function (opts) {
 
   function onSocketMessage (msg) {
     if (self.destroyed) return
-    if (self.client._socksProxyOpts) msg = msg.slice(10)
+    if (proxySocket) msg = msg.slice(10)
     if (msg.length < 8 || msg.readUInt32BE(4) !== transactionId.readUInt32BE(0)) {
       return onError(new Error('tracker sent invalid transaction id'))
     }

lib/client/websocket-tracker.js

@@ -6,6 +6,7 @@ var hat = require('hat')
 var inherits = require('inherits')
 var Peer = require('simple-peer')
 var Socket = require('simple-websocket')
+var url = require('url')
 
 var common = require('../common')
 var Tracker = require('./tracker')
@@ -167,7 +168,13 @@ WebSocketTracker.prototype._openSocket = function () {
   if (self.socket) {
     socketPool[self.announceUrl].consumers += 1
   } else {
-    self.socket = socketPool[self.announceUrl] = new Socket(self.announceUrl, { agent: self.client._httpAgent })
+    var parsedUrl = url.parse(self.announceUrl)
+    var agent
+    if (self.client._proxyOpts) {
+      agent = parsedUrl.protocol === 'wss:'
+        ? self.client._proxyOpts.httpsAgent : self.client._proxyOpts.httpAgent
+    }
+    self.socket = socketPool[self.announceUrl] = new Socket(self.announceUrl, { agent: agent })
     self.socket.consumers = 1
     self.socket.on('connect', self._onSocketConnectBound)
   }

test/client.js

@@ -399,7 +399,9 @@ function testClientStartHttpAgent (t, serverType) {
       peerId: peerId1,
       port: port,
       wrtc: {},
-      httpAgent: agent
+      proxyOpts: {
+        httpAgent: agent
+      }
     })
 
     if (serverType === 'ws') common.mockWebsocketTracker(client)