Initial stab at solving webtorrent#181 - see notes in PR

Author: Rich Jones

README.md

@@ -70,6 +70,7 @@ var optionalOpts = {
       uploaded: 0,
       downloaded: 0,
       left: 0,
+      ip: 'custom.ip.address.or.hostname',
       customParam: 'blah' // custom parameters supported
     }
   }
@@ -252,6 +253,7 @@ $ bittorrent-tracker --help
 
   Options:
     -p, --port [number]  change the port [default: 8000]
+        --trust-ip       trust 'ip' parameter in GET requests
         --trust-proxy    trust 'x-forwarded-for' header from reverse proxy
         --interval       client announce interval (ms) [default: 600000]
         --http           enable http server

bin/cmd.js

@@ -16,6 +16,7 @@ var argv = minimist(process.argv.slice(2), {
     'http',
     'quiet',
     'silent',
+    'trust-ip',
     'trust-proxy',
     'udp',
     'version',
@@ -53,6 +54,7 @@ if (argv.help) {
         --http-hostname [string]  change the http server hostname [default: '::']
         --udp-hostname [string]   change the udp hostname [default: '0.0.0.0']
         --udp6-hostname [string]  change the udp6 hostname [default: '::']
+        --trust-ip                trust 'ip' parameter in GET requests
         --trust-proxy             trust 'x-forwarded-for' header from reverse proxy
         --interval                client announce interval (ms) [default: 600000]
         --http                    enable http server
@@ -82,6 +84,7 @@ var server = new Server({
   http: argv.http,
   interval: argv.interval,
   stats: argv.stats,
+  trustIp: argv['trust-ip'],
   trustProxy: argv['trust-proxy'],
   udp: argv.udp,
   ws: argv.ws

lib/server/parse-http.js

@@ -31,9 +31,11 @@ function parseHttpRequest (req, opts) {
       common.MAX_ANNOUNCE_PEERS
     )
 
-    params.ip = opts.trustProxy
-      ? req.headers['x-forwarded-for'] || req.connection.remoteAddress
-      : req.connection.remoteAddress.replace(common.REMOVE_IPV4_MAPPED_IPV6_RE, '') // force ipv4
+    params.ip = opts.trustIp
+      ? params.ip || opts.trustProxy
+        ? req.headers['x-forwarded-for'] || req.connection.remoteAddress.replace(common.REMOVE_IPV4_MAPPED_IPV6_RE, '') // force IPv4
+        : req.connection.remoteAddress.replace(common.REMOVE_IPV4_MAPPED_IPV6_RE, '')
+      : req.connection.remoteAddress.replace(common.REMOVE_IPV4_MAPPED_IPV6_RE, '')
     params.addr = (common.IPV6_RE.test(params.ip) ? '[' + params.ip + ']' : params.ip) + ':' + params.port
 
     params.headers = req.headers

server.js

@@ -29,6 +29,7 @@ inherits(Server, EventEmitter)
  *
  * @param {Object}  opts            options object
  * @param {Number}  opts.interval   tell clients to announce on this interval (ms)
+ * @param {Number}  opts.trustIp    trust 'ip' parameter in GET requests
  * @param {Number}  opts.trustProxy trust 'x-forwarded-for' header from reverse proxy
  * @param {boolean} opts.http       start an http server? (default: true)
  * @param {boolean} opts.udp        start a udp server? (default: true)
@@ -49,6 +50,7 @@ function Server (opts) {
     : 10 * 60 * 1000 // 10 min
 
   self._trustProxy = !!opts.trustProxy
+  self._trustIp = !!opts.trustIp
   if (typeof opts.filter === 'function') self._filter = opts.filter
 
   self.peersCacheLength = opts.peersCacheLength
@@ -366,6 +368,7 @@ Server.prototype.onHttpRequest = function (req, res, opts) {
   var self = this
   if (!opts) opts = {}
   opts.trustProxy = opts.trustProxy || self._trustProxy
+  opts.trustIp = opts.trustIp || self._trustIp
 
   var params
   try {
@@ -445,6 +448,7 @@ Server.prototype.onWebSocketConnection = function (socket, opts) {
   var self = this
   if (!opts) opts = {}
   opts.trustProxy = opts.trustProxy || self._trustProxy
+  opts.trustIp = opts.trustIp || self._trustIp
 
   socket.peerId = null // as hex
   socket.infoHashes = [] // swarms that this socket is participating in

test/client.js

@@ -255,7 +255,8 @@ function testClientGetAnnounceOpts (t, serverType) {
       port: port,
       getAnnounceOpts: function () {
         return {
-          testParam: 'this is a test'
+          testParam: 'this is a test',
+          ip: 'test.bittorrenttest.xyz'
         }
       },
       wrtc: {}