[pull] master from webtorrent:master

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - name: Cache
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-npm-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-
+      - name: Install dependencies
+        run: npm i
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.github/workflows/stale.yml

@@ -0,0 +1,23 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '0 12 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v4
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?'
+        stale-pr-message: 'Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?'
+        exempt-issue-labels: accepted,blocked,bug,dependency,enhancement,'help wanted',question,security,meta
+        exempt-pr-labels: accepted,blocked,bug,dependency,enhancement,'help wanted',question,security,meta
+        stale-issue-label: 'stale'
+        stale-pr-label: 'stale'

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+package-lock.json

AUTHORS.md

@@ -50,5 +50,12 @@
 - Koushik Dutta ([email protected])
 - KayleePop ([email protected])
 - Diego Rodriguez Baquero ([email protected])
+- Diego Rodríguez Baquero ([email protected])
+- Renovate Bot ([email protected])
+- Diego Rodríguez Baquero ([email protected])
+- Diego Rodriguez Baquero ([email protected])
+- semantic-release-bot ([email protected])
+- renovate[bot] (29139614+renovate[bot]@users.noreply.github.com)
+- Jocelyn Liu ([email protected])
 
 #### Generated by tools/update-authors.sh.

CHANGELOG.md

@@ -0,0 +1,56 @@
+## [9.18.2](https://github.com/webtorrent/bittorrent-tracker/compare/v9.18.1...v9.18.2) (2021-09-02)
+
+
+### Bug Fixes
+
+* **deps:** update dependency socks to v2 ([#394](https://github.com/webtorrent/bittorrent-tracker/issues/394)) ([353e1f4](https://github.com/webtorrent/bittorrent-tracker/commit/353e1f40093a5e74cb54219abbae8ef0cc3d9e0b))
+
+## [9.18.1](https://github.com/webtorrent/bittorrent-tracker/compare/v9.18.0...v9.18.1) (2021-09-01)
+
+
+### Bug Fixes
+
+* disable socks in chromeapp ([#398](https://github.com/webtorrent/bittorrent-tracker/issues/398)) ([7fd5877](https://github.com/webtorrent/bittorrent-tracker/commit/7fd587789548453a852ea01e54900a5e9155db67))
+
+# [9.18.0](https://github.com/webtorrent/bittorrent-tracker/compare/v9.17.4...v9.18.0) (2021-08-20)
+
+
+### Features
+
+* add proxy support for tracker clients ([#356](https://github.com/webtorrent/bittorrent-tracker/issues/356)) ([ad64dc3](https://github.com/webtorrent/bittorrent-tracker/commit/ad64dc3a68cddccc2c1f05d0d8bb833f2c4860b2))
+
+## [9.17.4](https://github.com/webtorrent/bittorrent-tracker/compare/v9.17.3...v9.17.4) (2021-07-22)
+
+
+### Bug Fixes
+
+* if websocket closed, don't produce a response ([ca88435](https://github.com/webtorrent/bittorrent-tracker/commit/ca88435617e59714a456031c75b3a329897d97bd))
+
+## [9.17.3](https://github.com/webtorrent/bittorrent-tracker/compare/v9.17.2...v9.17.3) (2021-07-02)
+
+
+### Bug Fixes
+
+* auto update authors on version ([b5ffc70](https://github.com/webtorrent/bittorrent-tracker/commit/b5ffc708ada0bef66e7fa0cd1872527ea6dd8d53))
+
+## [9.17.2](https://github.com/webtorrent/bittorrent-tracker/compare/v9.17.1...v9.17.2) (2021-06-15)
+
+
+### Bug Fixes
+
+* modernize ([e5994d2](https://github.com/webtorrent/bittorrent-tracker/commit/e5994d2ebdec10fe2165e31f5b498382eeeaaf5f))
+
+## [9.17.1](https://github.com/webtorrent/bittorrent-tracker/compare/v9.17.0...v9.17.1) (2021-06-15)
+
+
+### Bug Fixes
+
+* add package-lock ([0e486b0](https://github.com/webtorrent/bittorrent-tracker/commit/0e486b09d80d30e1c13d4624e29c4251000d4092))
+* **deps:** update dependency bn.js to ^5.2.0 ([2d36e4a](https://github.com/webtorrent/bittorrent-tracker/commit/2d36e4ae60b1bac51773f2dca81c1a158b51cb28))
+* **deps:** update dependency chrome-dgram to ^3.0.6 ([a82aaaa](https://github.com/webtorrent/bittorrent-tracker/commit/a82aaaa31963a0d9adb640166f417142c5d7b970))
+* **deps:** update dependency run-parallel to ^1.2.0 ([fcf25ed](https://github.com/webtorrent/bittorrent-tracker/commit/fcf25ed40e1fd64e630b10a0281bc09604b901d3))
+* **deps:** update dependency run-series to ^1.1.9 ([fa2c33f](https://github.com/webtorrent/bittorrent-tracker/commit/fa2c33fc91f8ef0a47d0f40b7a046ae179ee328a))
+* **deps:** update dependency simple-websocket to ^9.1.0 ([96fedbd](https://github.com/webtorrent/bittorrent-tracker/commit/96fedbdf56ddcf6627eb373a33589db885cb4fb7))
+* **deps:** update dependency ws to ^7.4.5 ([6ad7ead](https://github.com/webtorrent/bittorrent-tracker/commit/6ad7ead994e5cb99980a406aea908e4b9ff6151c))
+* **deps:** update webtorrent ([1e8d47d](https://github.com/webtorrent/bittorrent-tracker/commit/1e8d47dcd8f5f53b42aa75265a129f950d16feef))
+* UDP url parsing ([8e24a8c](https://github.com/webtorrent/bittorrent-tracker/commit/8e24a8c97b55bbaaf2c92a496d1cd30b0c008934))

README.md

@@ -65,6 +65,12 @@ var requiredOpts = {
 }
 
 var optionalOpts = {
+  // RTCPeerConnection config object (only used in browser)
+  rtcConfig: {},
+  // User-Agent header for http requests
+  userAgent: '',
+  // Custom webrtc impl, useful in node to specify [wrtc](https://npmjs.com/package/wrtc)
+  wrtc: {},
   getAnnounceOpts: function () {
     // Provide a callback that will be called whenever announce() is called
     // internally (on timer), or by the user
@@ -75,12 +81,44 @@ var optionalOpts = {
       customParam: 'blah' // custom parameters supported
     }
   },
-  // RTCPeerConnection config object (only used in browser)
-  rtcConfig: {},
-  // User-Agent header for http requests
-  userAgent: '',
-  // Custom webrtc impl, useful in node to specify [wrtc](https://npmjs.com/package/wrtc)
-  wrtc: {},
+  // Proxy config object
+  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: {}
+  },
 }
 
 var client = new Client(requiredOpts)

bin/cmd.js

@@ -39,7 +39,7 @@ if (argv.version) {
 }
 
 if (argv.help) {
-  console.log(function () {
+  console.log((() => {
   /*
   bittorrent-tracker - Start a bittorrent tracker server
 
@@ -64,7 +64,7 @@ if (argv.help) {
     -v, --version                 print the current version
 
   */
-  }.toString().split(/\n/).slice(2, -2).join('\n'))
+  }).toString().split(/\n/).slice(2, -2).join('\n'))
   process.exit(0)
 }
 
@@ -85,23 +85,23 @@ const server = new Server({
   ws: argv.ws
 })
 
-server.on('error', function (err) {
-  if (!argv.silent) console.error('ERROR: ' + err.message)
+server.on('error', err => {
+  if (!argv.silent) console.error(`ERROR: ${err.message}`)
 })
-server.on('warning', function (err) {
-  if (!argv.quiet) console.log('WARNING: ' + err.message)
+server.on('warning', err => {
+  if (!argv.quiet) console.log(`WARNING: ${err.message}`)
 })
-server.on('update', function (addr) {
-  if (!argv.quiet) console.log('update: ' + addr)
+server.on('update', addr => {
+  if (!argv.quiet) console.log(`update: ${addr}`)
 })
-server.on('complete', function (addr) {
-  if (!argv.quiet) console.log('complete: ' + addr)
+server.on('complete', addr => {
+  if (!argv.quiet) console.log(`complete: ${addr}`)
 })
-server.on('start', function (addr) {
-  if (!argv.quiet) console.log('start: ' + addr)
+server.on('start', addr => {
+  if (!argv.quiet) console.log(`start: ${addr}`)
 })
-server.on('stop', function (addr) {
-  if (!argv.quiet) console.log('stop: ' + addr)
+server.on('stop', addr => {
+  if (!argv.quiet) console.log(`stop: ${addr}`)
 })
 
 const hostname = {
@@ -110,35 +110,35 @@ const hostname = {
   udp6: argv['udp6-hostname']
 }
 
-server.listen(argv.port, hostname, function () {
+server.listen(argv.port, hostname, () => {
   if (server.http && argv.http && !argv.quiet) {
     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(`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(`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(`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(`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(`Tracker stats: http://${statsHost}:${statsPort}/stats`)
   }
 })

client.js

@@ -24,6 +24,7 @@ const WebSocketTracker = require('./lib/client/websocket-tracker')
  * @param {number} opts.rtcConfig                RTCPeerConnection configuration object
  * @param {number} opts.userAgent                User-Agent header for http requests
  * @param {number} opts.wrtc                     custom webrtc impl (useful in node.js)
+ * @param {object} opts.proxyOpts                proxy options (useful in node.js)
  */
 class Client extends EventEmitter {
   constructor (opts = {}) {
@@ -54,6 +55,7 @@ class Client extends EventEmitter {
     this._getAnnounceOpts = opts.getAnnounceOpts
     this._rtcConfig = opts.rtcConfig
     this._userAgent = opts.userAgent
+    this._proxyOpts = opts.proxyOpts
 
     // Support lazy 'wrtc' module initialization
     // See: https://github.com/webtorrent/webtorrent-hybrid/issues/46
@@ -281,9 +283,7 @@ Client.scrape = (opts, cb) => {
   })
 
   opts.infoHash = Array.isArray(opts.infoHash)
-    ? opts.infoHash.map(infoHash => {
-        return Buffer.from(infoHash, 'hex')
-      })
+    ? opts.infoHash.map(infoHash => Buffer.from(infoHash, 'hex'))
     : Buffer.from(opts.infoHash, 'hex')
   client.scrape({ infoHash: opts.infoHash })
   return client

examples/express-embed/server.js

@@ -13,7 +13,7 @@ const server = new Server({
   http: false, // we do our own
   udp: false, // not interested
   ws: false, // not interested
-  filter: function (params) {
+  filter (params) {
     // black/whitelist for disallowing/allowing specific clients [default=allow all]
     // this example only allows the uTorrent client
     const client = params.peer_id[1] + params.peer_id[2]

lib/client/http-tracker.js

@@ -1,8 +1,10 @@
 const arrayRemove = require('unordered-array-remove')
 const bencode = require('bencode')
+const clone = require('clone')
 const compact2string = require('compact2string')
 const debug = require('debug')('bittorrent-tracker:http-tracker')
 const get = require('simple-get')
+const Socks = require('socks')
 
 const common = require('../common')
 const Tracker = require('./tracker')
@@ -17,7 +19,7 @@ const HTTP_SCRAPE_SUPPORT = /\/(announce)[^/]*$/
  * @param {Object} opts         options object
  */
 class HTTPTracker extends Tracker {
-  constructor (client, announceUrl, opts) {
+  constructor (client, announceUrl) {
     super(client, announceUrl)
 
     debug('new http tracker %s', announceUrl)
@@ -62,9 +64,7 @@ class HTTPTracker extends Tracker {
     }
 
     const infoHashes = (Array.isArray(opts.infoHash) && opts.infoHash.length > 0)
-      ? opts.infoHash.map(infoHash => {
-          return infoHash.toString('binary')
-        })
+      ? opts.infoHash.map(infoHash => infoHash.toString('binary'))
       : (opts.infoHash && opts.infoHash.toString('binary')) || this.client._infoHashBinary
     const params = {
       info_hash: infoHashes
@@ -112,13 +112,20 @@ class HTTPTracker extends Tracker {
 
   _request (requestUrl, params, cb) {
     const self = this
-    const u = requestUrl + (!requestUrl.includes('?') ? '?' : '&') +
-      common.querystringStringify(params)
+    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:'))
+      }
+    }
 
     this.cleanupFns.push(cleanup)
 
     let request = get.concat({
-      url: u,
+      url: parsedUrl.toString(),
+      agent: agent,
       timeout: common.REQUEST_TIMEOUT,
       headers: {
         'user-agent': this.client._userAgent || ''