bittorrent-tracker/server.js

641 lines
19 KiB
JavaScript
Raw Normal View History

module.exports = Server
2014-06-12 00:57:19 +00:00
var bencode = require('bencode')
2014-08-02 20:43:06 +00:00
var debug = require('debug')('bittorrent-tracker')
var dgram = require('dgram')
var EventEmitter = require('events').EventEmitter
var http = require('http')
var inherits = require('inherits')
2014-12-10 15:47:41 +00:00
var series = require('run-series')
2014-12-10 15:51:35 +00:00
var string2compact = require('string2compact')
var WebSocketServer = require('ws').Server
2014-12-10 15:47:41 +00:00
var common = require('./lib/common')
2015-07-29 07:26:44 +00:00
var Swarm = require('./lib/server/swarm')
var parseHttpRequest = require('./lib/server/parse-http')
var parseUdpRequest = require('./lib/server/parse-udp')
var parseWebSocketRequest = require('./lib/server/parse-websocket')
inherits(Server, EventEmitter)
/**
* BitTorrent tracker server.
*
* HTTP service which responds to GET requests from torrent clients. Requests include
* metrics from clients that help the tracker keep overall statistics about the torrent.
* Responses include a peer list that helps the client participate in the torrent.
*
2015-03-20 04:47:47 +00:00
* @param {Object} opts options object
* @param {Number} opts.interval tell clients to announce on this interval (ms)
* @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)
* @param {boolean} opts.ws start a websocket server? (default: true)
2015-03-20 04:47:47 +00:00
* @param {function} opts.filter black/whitelist fn for disallowing/allowing torrents
*/
function Server (opts) {
var self = this
if (!(self instanceof Server)) return new Server(opts)
EventEmitter.call(self)
if (!opts) opts = {}
debug('new server %s', JSON.stringify(opts))
2015-07-29 08:47:09 +00:00
self.intervalMs = opts.interval
2015-01-05 18:55:58 +00:00
? opts.interval
: 10 * 60 * 1000 // 10 min
self._trustProxy = !!opts.trustProxy
if (typeof opts.filter === 'function') self._filter = opts.filter
self._listenCalled = false
self.listening = false
self.destroyed = false
self.torrents = {}
self.http = null
2015-05-02 19:15:14 +00:00
self.udp4 = null
self.udp6 = null
self.ws = null
// start an http tracker unless the user explictly says no
if (opts.http !== false) {
self.http = http.createServer()
self.http.on('error', function (err) { self._onError(err) })
self.http.on('listening', onListening)
// Add default http request handler on next tick to give user the chance to add
// their own handler first. Handle requests untouched by user's handler.
process.nextTick(function () {
self.http.on('request', function (req, res) {
if (res.headersSent) return
self.onHttpRequest(req, res)
})
})
}
// start a udp tracker unless the user explicitly says no
if (opts.udp !== false) {
2015-05-30 04:05:00 +00:00
var isNode10 = /^v0.10./.test(process.version)
self.udp4 = self.udp = dgram.createSocket(
isNode10 ? 'udp4' : { type: 'udp4', reuseAddr: true }
)
self.udp4.on('message', function (msg, rinfo) { self.onUdpRequest(msg, rinfo) })
self.udp4.on('error', function (err) { self._onError(err) })
2015-05-02 19:15:14 +00:00
self.udp4.on('listening', onListening)
2015-05-30 04:05:00 +00:00
self.udp6 = dgram.createSocket(
isNode10 ? 'udp6' : { type: 'udp6', reuseAddr: true }
)
self.udp6.on('message', function (msg, rinfo) { self.onUdpRequest(msg, rinfo) })
self.udp6.on('error', function (err) { self._onError(err) })
2015-05-02 19:15:14 +00:00
self.udp6.on('listening', onListening)
2014-08-07 05:35:43 +00:00
}
// start a websocket tracker (for WebTorrent) unless the user explicitly says no
if (opts.ws !== false) {
if (!self.http) {
self.http = http.createServer()
self.http.on('error', function (err) { self._onError(err) })
self.http.on('listening', onListening)
// Add default http request handler on next tick to give user the chance to add
// their own handler first. Handle requests untouched by user's handler.
process.nextTick(function () {
self.http.on('request', function (req, res) {
if (res.headersSent) return
// For websocket trackers, we only need to handle the UPGRADE http method.
// Return 404 for all other request types.
res.statusCode = 404
res.end('404 Not Found')
})
})
}
self.ws = new WebSocketServer({ server: self.http })
2015-07-17 01:31:13 +00:00
self.ws.address = self.http.address.bind(self.http)
self.ws.on('error', function (err) { self._onError(err) })
self.ws.on('connection', function (socket) { self.onWebSocketConnection(socket) })
}
2015-05-02 19:15:14 +00:00
var num = !!self.http + !!self.udp4 + !!self.udp6
2014-08-07 05:35:43 +00:00
function onListening () {
num -= 1
if (num === 0) {
self.listening = true
debug('listening')
self.emit('listening')
}
}
}
2014-07-13 22:28:23 +00:00
Server.prototype._onError = function (err) {
var self = this
self.emit('error', err)
}
Server.prototype.listen = function (/* port, hostname, onlistening */) {
var self = this
if (self._listenCalled || self.listening) throw new Error('server already listening')
self._listenCalled = true
var lastArg = arguments[arguments.length - 1]
if (typeof lastArg === 'function') self.once('listening', lastArg)
var port = toNumber(arguments[0]) || arguments[0] || 0
var hostname = typeof arguments[1] !== 'function' ? arguments[1] : undefined
2015-12-15 23:19:44 +00:00
debug('listen (port: %o hostname: %o)', port, hostname)
2015-05-04 04:00:38 +00:00
function isObject (obj) {
return typeof obj === 'object' && obj !== null
}
var httpPort = isObject(port) ? (port.http || 0) : port
var udpPort = isObject(port) ? (port.udp || 0) : port
// binding to :: only receives IPv4 connections if the bindv6only sysctl is set 0,
// which is the default on many operating systems
var httpHostname = isObject(hostname) ? hostname.http : hostname
2015-05-04 04:00:38 +00:00
var udp4Hostname = isObject(hostname) ? hostname.udp : hostname
var udp6Hostname = isObject(hostname) ? hostname.udp6 : hostname
if (self.http) self.http.listen(httpPort, httpHostname)
if (self.udp4) self.udp4.bind(udpPort, udp4Hostname)
if (self.udp6) self.udp6.bind(udpPort, udp6Hostname)
}
Server.prototype.close = function (cb) {
var self = this
if (!cb) cb = function () {}
debug('close')
self.listening = false
self.destroyed = true
2015-05-02 19:15:14 +00:00
if (self.udp4) {
try {
2015-05-02 19:15:14 +00:00
self.udp4.close()
} catch (err) {}
}
if (self.udp6) {
try {
self.udp6.close()
} catch (err) {}
}
if (self.ws) {
try {
self.ws.close()
} catch (err) {}
}
if (self.http) self.http.close(cb)
else cb(null)
}
Server.prototype.createSwarm = function (infoHash, cb) {
var self = this
2015-02-19 20:56:09 +00:00
if (Buffer.isBuffer(infoHash)) infoHash = infoHash.toString('hex')
process.nextTick(function () {
var swarm = self.torrents[infoHash] = new Swarm(infoHash, self)
cb(null, swarm)
})
}
Server.prototype.getSwarm = function (infoHash, cb) {
var self = this
if (Buffer.isBuffer(infoHash)) infoHash = infoHash.toString('hex')
process.nextTick(function () {
cb(null, self.torrents[infoHash])
})
}
Server.prototype.onHttpRequest = function (req, res, opts) {
var self = this
if (!opts) opts = {}
opts.trustProxy = opts.trustProxy || self._trustProxy
2014-12-08 22:42:05 +00:00
var params
try {
params = parseHttpRequest(req, opts)
params.httpReq = req
params.httpRes = res
2014-12-08 22:42:05 +00:00
} catch (err) {
res.end(bencode.encode({
'failure reason': err.message
2014-12-08 22:42:05 +00:00
}))
2014-12-08 22:42:05 +00:00
// even though it's an error for the client, it's just a warning for the server.
// don't crash the server because a client sent bad data :)
self.emit('warning', err)
2014-12-08 22:42:05 +00:00
return
}
self._onRequest(params, function (err, response) {
2014-12-09 01:35:05 +00:00
if (err) {
self.emit('warning', err)
2014-12-09 01:35:05 +00:00
response = {
'failure reason': err.message
}
}
if (self.destroyed) return res.end()
2014-12-09 22:18:20 +00:00
delete response.action // only needed for UDP encoding
2014-06-12 00:57:19 +00:00
res.end(bencode.encode(response))
if (params.action === common.ACTIONS.ANNOUNCE) {
self.emit(common.EVENT_NAMES[params.event], params.addr, params)
}
2014-12-09 01:35:05 +00:00
})
}
Server.prototype.onUdpRequest = function (msg, rinfo) {
var self = this
2014-12-08 23:22:36 +00:00
var params
try {
params = parseUdpRequest(msg, rinfo)
} catch (err) {
2014-12-09 01:35:05 +00:00
self.emit('warning', err)
// Do not reply for parsing errors
return
}
self._onRequest(params, function (err, response) {
2014-12-09 01:35:05 +00:00
if (err) {
self.emit('warning', err)
2014-12-09 01:35:05 +00:00
response = {
action: common.ACTIONS.ERROR,
2014-12-09 01:35:05 +00:00
'failure reason': err.message
}
}
if (self.destroyed) return
2014-12-11 20:53:39 +00:00
2014-12-09 01:35:05 +00:00
response.transactionId = params.transactionId
response.connectionId = params.connectionId
2014-12-09 01:35:05 +00:00
var buf = makeUdpPacket(response)
try {
2015-05-02 19:15:14 +00:00
var udp = (rinfo.family === 'IPv4') ? self.udp4 : self.udp6
udp.send(buf, 0, buf.length, rinfo.port, rinfo.address)
} catch (err) {
self.emit('warning', err)
}
if (params.action === common.ACTIONS.ANNOUNCE) {
self.emit(common.EVENT_NAMES[params.event], params.addr, params)
}
2014-12-09 01:35:05 +00:00
})
}
Server.prototype.onWebSocketConnection = function (socket, opts) {
var self = this
if (!opts) opts = {}
opts.trustProxy = opts.trustProxy || self._trustProxy
socket.peerId = null // as hex
2016-03-18 22:02:12 +00:00
socket.infoHashes = [] // swarms that this socket is participating in
socket.onSend = self._onWebSocketSend.bind(self, socket)
2016-03-18 22:06:05 +00:00
socket.onMessageBound = self._onWebSocketRequest.bind(self, socket, opts)
2016-03-18 22:55:07 +00:00
socket.on('message', socket.onMessageBound)
2016-03-18 22:06:05 +00:00
socket.onErrorBound = self._onWebSocketError.bind(self, socket)
2016-03-18 22:55:07 +00:00
socket.on('error', socket.onErrorBound)
2016-03-18 22:06:05 +00:00
socket.onCloseBound = self._onWebSocketClose.bind(self, socket)
2016-03-18 22:55:07 +00:00
socket.on('close', socket.onCloseBound)
}
Server.prototype._onWebSocketRequest = function (socket, opts, params) {
var self = this
try {
params = parseWebSocketRequest(socket, opts, params)
} catch (err) {
socket.send(JSON.stringify({
2016-03-01 18:22:31 +00:00
'failure reason': err.message
}), socket.onSend)
// even though it's an error for the client, it's just a warning for the server.
// don't crash the server because a client sent bad data :)
self.emit('warning', err)
return
}
if (!socket.peerId) socket.peerId = params.peer_id // as hex
self._onRequest(params, function (err, response) {
if (err) {
socket.send(JSON.stringify({
2016-03-16 03:06:39 +00:00
action: params.action === common.ACTIONS.ANNOUNCE ? 'announce' : 'scrape',
'failure reason': err.message,
info_hash: common.hexToBinary(params.info_hash)
}), socket.onSend)
self.emit('warning', err)
return
}
if (self.destroyed) return
2016-03-16 03:06:39 +00:00
response.action = params.action === common.ACTIONS.ANNOUNCE ? 'announce' : 'scrape'
2016-03-16 03:06:39 +00:00
var peers
if (response.action === 'announce') {
peers = response.peers
delete response.peers
2016-03-18 22:02:12 +00:00
params.info_hash.forEach(function (info_hash) {
if (socket.infoHashes.indexOf(info_hash) === -1) {
socket.infoHashes.push(info_hash)
}
})
2016-03-16 03:06:39 +00:00
response.info_hash = common.hexToBinary(params.info_hash)
2016-03-16 03:06:39 +00:00
// WebSocket tracker should have a shorter interval default: 2 minutes
response.interval = Math.ceil(self.intervalMs / 1000 / 5)
}
socket.send(JSON.stringify(response), socket.onSend)
debug('sent response %s to %s', JSON.stringify(response), params.peer_id)
if (params.offers) {
debug('got offers %o from %s', params.offers, params.peer_id)
debug('got %s peers from swarm %s', peers.length, params.info_hash)
peers.forEach(function (peer, i) {
peer.socket.send(JSON.stringify({
offer: params.offers[i].offer,
offer_id: params.offers[i].offer_id,
peer_id: common.hexToBinary(params.peer_id),
info_hash: common.hexToBinary(params.info_hash)
}), peer.socket.onSend)
debug('sent offer to %s from %s', peer.peerId, params.peer_id)
})
}
if (params.answer) {
debug('got answer %s from %s', JSON.stringify(params.answer), params.peer_id)
self.getSwarm(params.info_hash, function (err, swarm) {
if (err) return self.emit('warning', err)
if (!swarm) {
return self.emit('warning', new Error('no swarm with that `info_hash`'))
}
var toPeer = swarm.peers[params.to_peer_id]
if (!toPeer) {
return self.emit('warning', new Error('no peer with that `to_peer_id`'))
}
toPeer.socket.send(JSON.stringify({
answer: params.answer,
offer_id: params.offer_id,
peer_id: common.hexToBinary(params.peer_id),
info_hash: common.hexToBinary(params.info_hash)
}), toPeer.socket.onSend)
debug('sent answer to %s from %s', toPeer.peerId, params.peer_id)
done()
})
} else {
done()
}
function done () {
// emit event once the announce is fully "processed"
if (params.action === common.ACTIONS.ANNOUNCE) {
self.emit(common.EVENT_NAMES[params.event], params.peer_id, params)
}
}
})
}
2014-12-09 01:35:05 +00:00
Server.prototype._onRequest = function (params, cb) {
var self = this
2014-12-09 01:35:05 +00:00
if (params && params.action === common.ACTIONS.CONNECT) {
cb(null, { action: common.ACTIONS.CONNECT })
} else if (params && params.action === common.ACTIONS.ANNOUNCE) {
self._onAnnounce(params, cb)
2014-12-09 01:35:05 +00:00
} else if (params && params.action === common.ACTIONS.SCRAPE) {
self._onScrape(params, cb)
2014-12-09 01:35:05 +00:00
} else {
cb(new Error('Invalid action'))
}
}
2014-12-09 01:35:05 +00:00
Server.prototype._onAnnounce = function (params, cb) {
var self = this
self.getSwarm(params.info_hash, function (err, swarm) {
if (err) return cb(err)
if (swarm) {
announce(swarm)
} else {
createSwarm()
}
})
function createSwarm () {
if (self._filter) {
self._filter(params.info_hash, params, function (allowed) {
if (allowed instanceof Error) {
cb(allowed)
} else if (!allowed) {
cb(new Error('disallowed info_hash'))
} else {
self.createSwarm(params.info_hash, function (err, swarm) {
if (err) return cb(err)
announce(swarm)
})
}
})
} else {
self.createSwarm(params.info_hash, function (err, swarm) {
if (err) return cb(err)
announce(swarm)
})
}
}
function announce (swarm) {
if (!params.event || params.event === 'empty') params.event = 'update'
swarm.announce(params, function (err, response) {
if (err) return cb(err)
if (!response.action) response.action = common.ACTIONS.ANNOUNCE
2015-07-29 08:47:09 +00:00
if (!response.interval) response.interval = Math.ceil(self.intervalMs / 1000)
if (params.compact === 1) {
var peers = response.peers
// Find IPv4 peers
response.peers = string2compact(peers.filter(function (peer) {
return common.IPV4_RE.test(peer.ip)
}).map(function (peer) {
return peer.ip + ':' + peer.port
}))
// Find IPv6 peers
response.peers6 = string2compact(peers.filter(function (peer) {
return common.IPV6_RE.test(peer.ip)
}).map(function (peer) {
return '[' + peer.ip + ']:' + peer.port
}))
} else if (params.compact === 0) {
// IPv6 peers are not separate for non-compact responses
response.peers = response.peers.map(function (peer) {
return {
'peer id': common.hexToBinary(peer.peerId),
ip: peer.ip,
port: peer.port
}
})
} // else, return full peer objects (used for websocket responses)
cb(null, response)
})
}
2014-12-09 01:35:05 +00:00
}
Server.prototype._onScrape = function (params, cb) {
var self = this
2014-12-11 20:53:39 +00:00
if (params.info_hash == null) {
2014-12-09 01:35:05 +00:00
// if info_hash param is omitted, stats for all torrents are returned
// TODO: make this configurable!
params.info_hash = Object.keys(self.torrents)
}
2014-12-11 20:53:39 +00:00
2014-12-10 15:47:41 +00:00
series(params.info_hash.map(function (infoHash) {
return function (cb) {
self.getSwarm(infoHash, function (err, swarm) {
if (err) return cb(err)
if (swarm) {
swarm.scrape(params, function (err, scrapeInfo) {
if (err) return cb(err)
cb(null, {
infoHash: infoHash,
complete: (scrapeInfo && scrapeInfo.complete) || 0,
incomplete: (scrapeInfo && scrapeInfo.incomplete) || 0
})
})
} else {
cb(null, { infoHash: infoHash, complete: 0, incomplete: 0 })
}
})
2014-12-09 01:35:05 +00:00
}
2014-12-10 15:47:41 +00:00
}), function (err, results) {
if (err) return cb(err)
var response = {
action: common.ACTIONS.SCRAPE,
files: {},
2015-07-29 08:47:09 +00:00
flags: { min_request_interval: Math.ceil(self.intervalMs / 1000) }
}
2014-12-10 15:47:41 +00:00
results.forEach(function (result) {
response.files[common.hexToBinary(result.infoHash)] = {
complete: result.complete || 0,
incomplete: result.incomplete || 0,
downloaded: result.complete || 0 // TODO: this only provides a lower-bound
2014-12-10 15:47:41 +00:00
}
})
2014-12-10 15:47:41 +00:00
cb(null, response)
})
}
2014-12-09 01:35:05 +00:00
function makeUdpPacket (params) {
var packet
2014-12-09 01:35:05 +00:00
switch (params.action) {
case common.ACTIONS.CONNECT:
packet = Buffer.concat([
2014-12-09 01:35:05 +00:00
common.toUInt32(common.ACTIONS.CONNECT),
common.toUInt32(params.transactionId),
params.connectionId
])
break
2014-12-09 01:35:05 +00:00
case common.ACTIONS.ANNOUNCE:
packet = Buffer.concat([
2014-12-09 01:35:05 +00:00
common.toUInt32(common.ACTIONS.ANNOUNCE),
common.toUInt32(params.transactionId),
2015-01-05 18:55:58 +00:00
common.toUInt32(params.interval),
2014-12-09 01:35:05 +00:00
common.toUInt32(params.incomplete),
common.toUInt32(params.complete),
params.peers
])
break
2014-12-09 01:35:05 +00:00
case common.ACTIONS.SCRAPE:
var scrapeResponse = [
2014-12-09 01:35:05 +00:00
common.toUInt32(common.ACTIONS.SCRAPE),
common.toUInt32(params.transactionId)
]
for (var infoHash in params.files) {
var file = params.files[infoHash]
scrapeResponse.push(
common.toUInt32(file.complete),
common.toUInt32(file.downloaded), // TODO: this only provides a lower-bound
common.toUInt32(file.incomplete)
)
}
packet = Buffer.concat(scrapeResponse)
break
2014-12-09 01:35:05 +00:00
case common.ACTIONS.ERROR:
packet = Buffer.concat([
2014-12-09 01:35:05 +00:00
common.toUInt32(common.ACTIONS.ERROR),
common.toUInt32(params.transactionId || 0),
new Buffer(params['failure reason'], 'utf8')
2014-12-09 01:35:05 +00:00
])
break
default:
throw new Error('Action not implemented: ' + params.action)
2015-01-29 02:18:47 +00:00
}
return packet
2014-12-09 01:35:05 +00:00
}
Server.prototype._onWebSocketSend = function (socket, err) {
var self = this
if (err) self._onWebSocketError(socket, err)
}
Server.prototype._onWebSocketClose = function (socket) {
var self = this
2016-03-18 22:06:05 +00:00
debug('websocket close %s', socket.peerId)
if (socket.peerId) {
socket.infoHashes.forEach(function (infoHash) {
var swarm = self.torrents[infoHash]
if (swarm) {
swarm.announce({
event: 'stopped',
numwant: 0,
peer_id: socket.peerId
}, function () {})
}
})
}
2016-03-18 22:06:05 +00:00
socket.peerId = null
socket.infoHashes = null
socket.onSend = null
socket.removeListener('message', socket.onMessageBound)
socket.removeListener('error', socket.onErrorBound)
socket.removeListener('close', socket.onCloseBound)
}
Server.prototype._onWebSocketError = function (socket, err) {
var self = this
debug('websocket error %s', err.message || err)
self.emit('warning', err)
self._onWebSocketClose(socket)
}
2015-05-01 21:17:11 +00:00
function toNumber (x) {
x = Number(x)
return x >= 0 ? x : false
}