Merge branch 'webtorrent:master' into master

Author: babico

AUTHORS.md

@@ -63,5 +63,8 @@
 - Paul Sharypov ([email protected])
 - Cas ([email protected])
 - Tom Snelling ([email protected])
+- Cas_ ([email protected])
+- Arsène Fougerouse ([email protected])
+- Brad Marsden ([email protected])
 
 #### Generated by tools/update-authors.sh.

CHANGELOG.md

@@ -1,3 +1,39 @@
+## [11.0.2](https://github.com/webtorrent/bittorrent-tracker/compare/v11.0.1...v11.0.2) (2024-03-12)
+
+
+### Bug Fixes
+
+* **parse-http:** ignore announcements from peers with invalid announcement ports. ([#513](https://github.com/webtorrent/bittorrent-tracker/issues/513)) ([fe75272](https://github.com/webtorrent/bittorrent-tracker/commit/fe75272d51653e626583689081afb0b7aeadb84f))
+
+## [11.0.1](https://github.com/webtorrent/bittorrent-tracker/compare/v11.0.0...v11.0.1) (2024-01-16)
+
+
+### Bug Fixes
+
+* update build badge url ([#506](https://github.com/webtorrent/bittorrent-tracker/issues/506)) ([3f59b58](https://github.com/webtorrent/bittorrent-tracker/commit/3f59b58a020ea8c0926be135471a6666fe8e8b21))
+
+# [11.0.0](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.12...v11.0.0) (2023-10-31)
+
+
+### Features
+
+* **major:** drop simple-get ([#443](https://github.com/webtorrent/bittorrent-tracker/issues/443)) ([bce64e1](https://github.com/webtorrent/bittorrent-tracker/commit/bce64e155df6ff9fa605898cbf7498bf76188d8b))
+
+
+### BREAKING CHANGES
+
+* **major:** drop simple-get
+
+* perf: drop simple-get
+
+* feat: undici agent and socks
+
+* fix: undici as dev dependency
+
+* feat: require user passed proxy objects for http and ws
+
+* chore: include undici for tests
+
 ## [10.0.12](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.11...v10.0.12) (2023-08-09)
 
 

README.md

@@ -1,6 +1,6 @@
 # bittorrent-tracker [![ci][ci-image]][ci-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
 
-[ci-image]: https://img.shields.io/github/workflow/status/webtorrent/bittorrent-tracker/ci/master
+[ci-image]: https://img.shields.io/github/actions/workflow/status/webtorrent/bittorrent-tracker/ci.yml
 [ci-url]: https://github.com/webtorrent/bittorrent-tracker/actions
 [npm-image]: https://img.shields.io/npm/v/bittorrent-tracker.svg
 [npm-url]: https://npmjs.org/package/bittorrent-tracker
@@ -57,16 +57,16 @@ npm install https://github.com/babico/bittorrent-tracker.git --save
 To connect to a tracker, just do this:
 
 ```js
-var Client = require('bittorrent-tracker')
+import Client from 'bittorrent-tracker'
 
-var requiredOpts = {
+const requiredOpts = {
   infoHash: new Buffer('012345678901234567890'), // hex string or Buffer
   peerId: new Buffer('01234567890123456789'), // hex string or Buffer
   announce: [], // list of tracker server urls
   port: 6881 // torrent client port, (in browser, optional)
 }
 
-var optionalOpts = {
+const optionalOpts = {
   // RTCPeerConnection config object (only used in browser)
   rtcConfig: {},
   // User-Agent header for http requests
@@ -83,47 +83,24 @@ var optionalOpts = {
       customParam: 'blah' // custom parameters supported
     }
   },
-  // Proxy config object
+  // Proxy options (used to proxy requests in node)
   proxyOpts: {
-      // Socks proxy options (used to proxy requests in node)
-      socksProxy: {
-          // 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 socksProxy is provided
-      httpAgent: {},
-      httpsAgent: {}
+      // For WSS trackers this is always a http.Agent
+      // For UDP trackers this is an object of options for the Socks Connection
+      // For HTTP trackers this is either an undici Agent if using Node16 or later, or http.Agent if using versions prior to Node 16, ex:
+      // import Socks from 'socks'
+      // proxyOpts.socksProxy = new Socks.Agent(optionsObject, isHttps)
+      // or if using Node 16 or later
+      // import { socksDispatcher } from 'fetch-socks'
+      // proxyOpts.socksProxy = socksDispatcher(optionsObject)
+      socksProxy: new SocksProxy(socksOptionsObject),
+      // Populated with socksProxy if it's provided
+      httpAgent: new http.Agent(agentOptionsObject),
+      httpsAgent: new https.Agent(agentOptionsObject)
   },
 }
 
-var client = new Client(requiredOpts)
+const client = new Client(requiredOpts)
 
 client.on('error', function (err) {
   // fatal client error!
@@ -184,7 +161,7 @@ client.on('scrape', function (data) {
 To start a BitTorrent tracker server to track swarms of peers:
 
 ```js
-const Server = require('bittorrent-tracker').Server
+import { Server } from 'bittorrent-tracker'
 
 const server = new Server({
   udp: true, // enable udp server? [default=true]
@@ -291,7 +268,7 @@ The http server will handle requests for the following paths: `/announce`, `/scr
 Scraping multiple torrent info is possible with a static `Client.scrape` method:
 
 ```js
-var Client = require('bittorrent-tracker')
+import Client from 'bittorrent-tracker'
 Client.scrape({ announce: announceUrl, infoHash: [ infoHash1, infoHash2 ]}, function (err, results) {
   results[infoHash1].announce
   results[infoHash1].infoHash

bin/cmd.js

@@ -86,22 +86,22 @@ const server = new Server({
 })
 
 server.on('error', err => {
-  if (!argv.silent) console.error(`ERROR: ${err.message}`)
+  if (!argv.silent) console.error(`${new Date().toISOString()} ERROR: ${err.message}`)
 })
 server.on('warning', err => {
-  if (!argv.quiet) console.log(`WARNING: ${err.message}`)
+  if (!argv.quiet) console.log(`${new Date().toISOString()} WARNING: ${err.message}`)
 })
 server.on('update', addr => {
-  if (!argv.quiet) console.log(`update: ${addr}`)
+  if (!argv.quiet) console.log(`${new Date().toISOString()} update: ${addr}`)
 })
 server.on('complete', addr => {
-  if (!argv.quiet) console.log(`complete: ${addr}`)
+  if (!argv.quiet) console.log(`${new Date().toISOString()} complete: ${addr}`)
 })
 server.on('start', addr => {
-  if (!argv.quiet) console.log(`start: ${addr}`)
+  if (!argv.quiet) console.log(`${new Date().toISOString()} start: ${addr}`)
 })
 server.on('stop', addr => {
-  if (!argv.quiet) console.log(`stop: ${addr}`)
+  if (!argv.quiet) console.log(`${new Date().toISOString()} stop: ${addr}`)
 })
 
 const hostname = {
@@ -115,30 +115,30 @@ server.listen(argv.port, hostname, () => {
     const httpAddr = server.http.address()
     const httpHost = httpAddr.address !== '::' ? httpAddr.address : 'localhost'
     const httpPort = httpAddr.port
-    console.log(`HTTP tracker: http://${httpHost}:${httpPort}/announce`)
+    console.log(`${new Date().toISOString()} HTTP tracker: http://${httpHost}:${httpPort}/announce`)
   }
   if (server.udp && !argv.quiet) {
     const udpAddr = server.udp.address()
     const udpHost = udpAddr.address
     const udpPort = udpAddr.port
-    console.log(`UDP tracker: udp://${udpHost}:${udpPort}`)
+    console.log(`${new Date().toISOString()} UDP tracker: udp://${udpHost}:${udpPort}`)
   }
   if (server.udp6 && !argv.quiet) {
     const udp6Addr = server.udp6.address()
     const udp6Host = udp6Addr.address !== '::' ? udp6Addr.address : 'localhost'
     const udp6Port = udp6Addr.port
-    console.log(`UDP6 tracker: udp://${udp6Host}:${udp6Port}`)
+    console.log(`${new Date().toISOString()} UDP6 tracker: udp://${udp6Host}:${udp6Port}`)
   }
   if (server.ws && !argv.quiet) {
     const wsAddr = server.http.address()
     const wsHost = wsAddr.address !== '::' ? wsAddr.address : 'localhost'
     const wsPort = wsAddr.port
-    console.log(`WebSocket tracker: ws://${wsHost}:${wsPort}`)
+    console.log(`${new Date().toISOString()} WebSocket tracker: ws://${wsHost}:${wsPort}`)
   }
   if (server.http && argv.stats && !argv.quiet) {
     const statsAddr = server.http.address()
     const statsHost = statsAddr.address !== '::' ? statsAddr.address : 'localhost'
     const statsPort = statsAddr.port
-    console.log(`Tracker stats: http://${statsHost}:${statsPort}/stats`)
+    console.log(`${new Date().toISOString()} Tracker stats: http://${statsHost}:${statsPort}/stats`)
   }
 })

lib/client/http-tracker.js

@@ -1,9 +1,7 @@
 import arrayRemove from 'unordered-array-remove'
 import bencode from 'bencode'
-import clone from 'clone'
 import Debug from 'debug'
-import get from 'simple-get'
-import Socks from 'socks'
+import fetch from 'cross-fetch-ponyfill'
 import { bin2hex, hex2bin, arr2text, text2arr, arr2hex } from 'uint8-util'
 
 import common from '../common.js'
@@ -13,6 +11,14 @@ import compact2string from 'compact2string'
 const debug = Debug('bittorrent-tracker:http-tracker')
 const HTTP_SCRAPE_SUPPORT = /\/(announce)[^/]*$/
 
+function abortTimeout (ms) {
+  const controller = new AbortController()
+  setTimeout(() => {
+    controller.abort()
+  }, ms).unref?.()
+  return controller
+}
+
 /**
  * HTTP torrent tracker client (for an individual tracker)
  *
@@ -112,70 +118,72 @@ class HTTPTracker extends Tracker {
     }
   }
 
-  _request (requestUrl, params, cb) {
-    const self = this
+  async _request (requestUrl, params, cb) {
     const parsedUrl = new URL(requestUrl + (requestUrl.indexOf('?') === -1 ? '?' : '&') + common.querystringStringify(params))
     let agent
     if (this.client._proxyOpts) {
       agent = parsedUrl.protocol === 'https:' ? this.client._proxyOpts.httpsAgent : this.client._proxyOpts.httpAgent
       if (!agent && this.client._proxyOpts.socksProxy) {
-        agent = new Socks.Agent(clone(this.client._proxyOpts.socksProxy), (parsedUrl.protocol === 'https:'))
+        agent = this.client._proxyOpts.socksProxy
       }
     }
 
-    this.cleanupFns.push(cleanup)
-
-    let request = get.concat({
-      url: parsedUrl.toString(),
-      agent,
-      timeout: common.REQUEST_TIMEOUT,
-      headers: {
-        'user-agent': this.client._userAgent || ''
-      }
-    }, onResponse)
-
-    function cleanup () {
-      if (request) {
-        arrayRemove(self.cleanupFns, self.cleanupFns.indexOf(cleanup))
-        request.abort()
-        request = null
+    const cleanup = () => {
+      if (!controller.signal.aborted) {
+        arrayRemove(this.cleanupFns, this.cleanupFns.indexOf(cleanup))
+        controller.abort()
+        controller = null
       }
-      if (self.maybeDestroyCleanup) self.maybeDestroyCleanup()
+      if (this.maybeDestroyCleanup) this.maybeDestroyCleanup()
     }
 
-    function onResponse (err, res, data) {
-      cleanup()
-      if (self.destroyed) return
+    this.cleanupFns.push(cleanup)
 
+    let res
+    let controller = abortTimeout(common.REQUEST_TIMEOUT)
+    try {
+      res = await fetch(parsedUrl.toString(), {
+        agent,
+        signal: controller.signal,
+        dispatcher: agent,
+        headers: {
+          'user-agent': this.client._userAgent || ''
+        }
+      })
+    } catch (err) {
       if (err) return cb(err)
-      if (res.statusCode !== 200) {
-        return cb(new Error(`Non-200 response code ${res.statusCode} from ${self.announceUrl}`))
-      }
-      if (!data || data.length === 0) {
-        return cb(new Error(`Invalid tracker response from${self.announceUrl}`))
-      }
-
-      try {
-        data = bencode.decode(data)
-      } catch (err) {
-        return cb(new Error(`Error decoding tracker response: ${err.message}`))
-      }
-      const failure = data['failure reason'] && arr2text(data['failure reason'])
-      if (failure) {
-        debug(`failure from ${requestUrl} (${failure})`)
-        return cb(new Error(failure))
-      }
+    }
+    let data = new Uint8Array(await res.arrayBuffer())
+    cleanup()
+    if (this.destroyed) return
 
-      const warning = data['warning message'] && arr2text(data['warning message'])
-      if (warning) {
-        debug(`warning from ${requestUrl} (${warning})`)
-        self.client.emit('warning', new Error(warning))
-      }
+    if (res.status !== 200) {
+      return cb(new Error(`Non-200 response code ${res.statusCode} from ${this.announceUrl}`))
+    }
+    if (!data || data.length === 0) {
+      return cb(new Error(`Invalid tracker response from${this.announceUrl}`))
+    }
 
-      debug(`response from ${requestUrl}`)
+    try {
+      data = bencode.decode(data)
+    } catch (err) {
+      return cb(new Error(`Error decoding tracker response: ${err.message}`))
+    }
+    const failure = data['failure reason'] && arr2text(data['failure reason'])
+    if (failure) {
+      debug(`failure from ${requestUrl} (${failure})`)
+      return cb(new Error(failure))
+    }
 
-      cb(null, data)
+    const warning = data['warning message'] && arr2text(data['warning message'])
+    if (warning) {
+      debug(`warning from ${requestUrl} (${warning})`)
+      this.client.emit('warning', new Error(warning))
     }
+
+    debug(`response from ${requestUrl}`)
+
+    cb(null, data)
   }
 
   _onAnnounceResponse (data) {

lib/client/websocket-tracker.js

@@ -1,8 +1,6 @@
-import clone from 'clone'
 import Debug from 'debug'
 import Peer from '@thaunknown/simple-peer/lite.js'
 import Socket from '@thaunknown/simple-websocket'
-import Socks from 'socks'
 import { arr2text, arr2hex, hex2bin, bin2hex, randomBytes } from 'uint8-util'
 
 import common from '../common.js'
@@ -185,7 +183,7 @@ class WebSocketTracker extends Tracker {
       if (this.client._proxyOpts) {
         agent = parsedUrl.protocol === 'wss:' ? this.client._proxyOpts.httpsAgent : this.client._proxyOpts.httpAgent
         if (!agent && this.client._proxyOpts.socksProxy) {
-          agent = new Socks.Agent(clone(this.client._proxyOpts.socksProxy), (parsedUrl.protocol === 'wss:'))
+          agent = this.client._proxyOpts.socksProxy
         }
       }
       this.socket = socketPool[this.announceUrl] = new Socket({ url: this.announceUrl, agent })

lib/server/parse-http.js

@@ -22,7 +22,7 @@ export default function (req, opts) {
     params.peer_id = bin2hex(params.peer_id)
 
     params.port = Number(params.port)
-    if (!params.port) throw new Error('invalid port')
+    if (!params.port || params.port <= 0 || params.port > 65535) throw new Error('invalid port')
 
     params.left = Number(params.left)
     if (Number.isNaN(params.left)) params.left = Infinity