1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
| #!/usr/bin/env node
'use strict';
// Utilities and helpers for communication with Jedi Academy and Jedi Outcast servers/clients
// core packages
const dgram = require( 'dgram' );
const EventEmitter = require( 'events' );
// exported object
let jkutils = {};
// protocol support based on:
// dpmaster, doc/techinfo.txt
// id software ftp, idstuff/quake3/docs/server.txt
jkutils.protocolStrings = {
'DarkPlaces': 'DP',
'QuakeArena-1': 'Q3A',
'Wolfenstein-1': 'RtCW',
'EnemyTerritory-1': 'WoET',
};
jkutils.protocolNumbers = {
'15': 'Jedi Outcast 1.02',
'16': 'Jedi Outcast 1.04',
'26': 'Jedi Academy 1.01',
};
//TODO: swap '%' for '.' in net traffic
jkutils.badCharacters = [
'\\',
'/',
';',
'"',
'%'
];
jkutils.oobPrefix = Buffer.from( [0xFF, 0xFF, 0xFF, 0xFF] );
// parse out an infostring
// Object return
// String info
// "k1\v1\k2\v2"
// "\k1\v1\k2\v2"
jkutils.parseInfostring = function( info ) {
if ( info[0] === '\\' ) {
info = info.slice( 1 );
}
let toks = info.split( '\\' );
// this accounts for invalid key/value pairs
let pairs = {};
for ( let i = 0; i < toks.length - 1; i += 2 ) {
pairs[toks[i].toLowerCase()] = toks[i + 1];
}
return pairs;
}
// returns a Buffer of ip+port bytes
jkutils.encodeServer = function( ip, port ) {
let buffer = Buffer.alloc( 6, 0, 'binary' );
let octets = ip.split( '.' );
buffer[0] = octets[0];
buffer[1] = octets[1];
buffer[2] = octets[2];
buffer[3] = octets[3];
buffer[4] = port >> 8;
buffer[5] = port & 0xFF;
return buffer;
}
// returns a { [] ip, Number port } from a Buffer
jkutils.decodeServer = function( buffer ) {
let octets = buffer.slice( 0, 4 ).join( '.' );
let portBuf = buffer.slice( 4, 6 );
let port = portBuf[1];
port |= portBuf[0] << 8;
return {
ip: octets,
port: port,
}
}
// strip Q3 colour codes from a string
jkutils.stripColours = function( s ) {
return s.replace( /\^[0-9]/g, '' );
}
// returns a JKSocket(EventEmitter) with send capabilities
// Function callback
// Error err
// Object socket
// EventEmitter (.on)
// infoResponse
// callback: Object info, String ip, Number port
// statusResponse
// callback: Object info, Array clients, String ip, Number port
// Object sendMasterCommand
// Function getservers( options )
// options:
// String ip
// [Number port] (default: ephemeral port https://en.wikipedia.org/wiki/Ephemeral_port)
// Object sendServerCommand
// Function getinfo( options )
// options:
// String ip
// [Number port] (default: ephemeral port https://en.wikipedia.org/wiki/Ephemeral_port)
// [String challenge] (default: 'jkutils-cli')
// Function getstatus( options )
// options:
// String ip
// [Number port] (default: ephemeral port https://en.wikipedia.org/wiki/Ephemeral_port)
// [String challenge] (default: 'jkutils-cli')
jkutils.createSocket = function( callback ) {
let server = dgram.createSocket( 'udp4' );
class MyEmitter extends EventEmitter {};
const socket = new MyEmitter();
socket.sendMasterCommand = {
"getservers": ( options ) => {
if ( !options.ip ) {
callback( 'IP must be specified' );
return;
}
let port = options.port || 0;
let protocol = options.protocol || '26';
let response = Buffer.from( 'getservers ' + protocol );
server.send(
[jkutils.oobPrefix, response], port, options.ip,
( err ) => {
if ( err ) {
callback( err );
server.close();
server = null;
}
}
);
},
};
socket.sendServerCommand = {
"getinfo": ( options ) => {
if ( !options.ip ) {
callback( 'IP must be specified' );
return;
}
let port = options.port || 0;
let challenge = options.challenge || 'jkutils-query';
let response = Buffer.from( 'getinfo ' + challenge );
server.send(
[jkutils.oobPrefix, response], port, options.ip,
( err ) => {
if ( err ) {
callback( err );
server.close();
server = null;
}
}
);
},
"getstatus": ( options ) => {
if ( !options.ip ) {
return callback( 'IP must be specified' );
}
let port = options.port || 0;
let challenge = options.challenge || 'jkutils-query';
let response = Buffer.from( 'getstatus ' + challenge );
server.send(
[jkutils.oobPrefix, response], port, options.ip,
( err ) => {
if ( err ) {
callback( err );
server.close();
server = null;
}
}
);
}
};
socket.gameServers = {};
socket.close = function() {
if ( server ) {
if ( server.close ) {
server.close();
}
server = null;
}
};
server.on(
'close',
() => {
//server.close();
}
);
server.on(
'error',
( err ) => {
server.close();
callback( err, null );
}
);
server.on(
'listening',
() => {
/*let address = server.address();
console.log( `listening on ${address.address}:${address.port} (UDP)` );*/
//FIXME: should we callback from here instead?
}
);
server.on(
'message',
( msg, rinfo ) => {
let source = {
ip: rinfo.address,
port: rinfo.port
};
let offset = 0;
// read marker, should be [FF, FF, FF, FF]
let marker = msg.readUInt32LE( offset );
offset += 4;
if ( marker !== 0xFFFFFFFF ) {
console.log( 'missing start marker from ' + source.ip + ':' + source.port + ', received ' + marker );
return;
}
let handlers = {
'getserversResponse': ( source, msg, offset, stringArgs ) => {
// dpmaster starts with: [ '\\' ]
// masterjk3.ravensoft.com starts with: [ '\n', '\0' ]
//
// the last transmission ends with: [ '\\', 'E', 'O', 'T' ]
// previous transmissions end with : [ '\\', 'E', 'O', 'F' ]
// dpmaster also appends this to each: [ '\0', '\0', '\0' ]
// masterjk3.ravensoft.com does not
//
// the first character after the message is always skipped, so masterjk3.ravensoft.com has to be
// helped along the way; we will skip to the first non-null byte!
while ( msg.readUInt8( offset ) === 0 ) {
offset++;
}
let serversBufIndex = null;
while ( true ) {
let from = msg.slice( offset + serversBufIndex );
let newIndex = from.indexOf( '\\' );
if ( newIndex === -1 ) {
break;
}
serversBufIndex += newIndex + 1;
let addrBuf = msg.slice( offset, offset + 6 );
offset += 6;
offset += 1; // skip the '\\''
let addrObj = jkutils.decodeServer( addrBuf );
//FIXME: maybe just emit event once with a full list of servers?
// override the timeout if possible?
// that will benefit EOT vs EOF - we can kill the socket immediately on EOT
socket.emit( 'getserversResponse', addrObj );
};
},
'infoResponse': ( source, msg, offset, stringArgs ) => {
let infoString = msg.slice( offset ).toString( 'ascii' );
let info = jkutils.parseInfostring( infoString );
let gameServer = socket.gameServers[source.ip + ':' + source.port];
if ( gameServer ) {
if ( info.challenge !== gameServer.challenge ) {
callback(
'rejecting server infoResponse (' + info.challenge + ' !== ' + gameServer.challenge + ')'
);
return offset;
}
delete info.challenge;
gameServer.infoResponse = info;
}
socket.emit( 'infoResponse', info, source.ip, source.port );
},
'statusResponse': ( source, msg, offset, stringArgs ) => {
let cleanMsg = msg.slice( offset ).toString( 'ascii' );
let lines = cleanMsg.split( '\n' );
let status = jkutils.parseInfostring( lines[0] );
let gameServer = socket.gameServers[source.ip + ':' + source.port];
if ( gameServer ) {
if ( status.challenge !== gameServer.challenge ) {
callback(
'rejecting server statusResponse (' + info.challenge + ' !== ' + gameServer.challenge + ')'
);
return offset;
}
}
// format: Score Ping "Name"
let clients = lines.slice( 1, -1 );
socket.emit( 'statusResponse', status, clients, source.ip, source.port );
},
};
// the rest of the buffer should just be a string, typically space-delimited
// so pass it on to the command handler
let stringArgs = msg.toString( 'ascii', offset ) // to ASCII
.split( /[ \n\r\0\\]/ ); // split on delimiters/special chars
let command = stringArgs[0];
let handler = handlers[command]
if ( !handler ) {
console.log( 'unknown command: ' + command );
console.log( 'data: ' + JSON.stringify( msg.slice( offset ) ) );
return;
}
stringArgs = stringArgs.slice( 1 );
offset += command.length + 1; // + 1 for space at end
offset = handler( source, msg, offset, stringArgs );
}
);
// listen for incoming datagrams on all interfaces
server.bind( '0.0.0.0' );
callback( null, socket );
}
let handlers = {
'getservers': ( args ) => {
if ( args.length < 2 ) {
return console.log( 'usage: getservers <ip[:port]> [protocol]' );
}
let addr = args[1].split( ':' );
let ip = addr[0];
let port = (addr.length === 2) ? addr[1] : '29060';
let protocol = (args.length === 3) ? args[2] : '26';
console.log( 'getting servers from ' + ip + ':' + port );
// chains getservers -> getserversResponse
jkutils.createSocket(
( err, socket ) => {
//FIXME: move the socket timeout into jkutils.createSocket with callback?
function noResponse() {
console.log( 'timeout from ' + ip + ':' + port );
}
function getServersTimeout() {
if ( !socket ) {
// this has already been done, the timeout is useless
return;
}
noResponse();
socket.close();
socket = null;
}
if ( err ) {
return console.log( err );
}
let timeoutResponse = {};
timeoutResponse[ip+':'+port] = {};
if ( !socket ) {
noResponse();
return;
}
else {
timeoutResponse[ip+':'+port]['getservers'] = setTimeout( getServersTimeout, 1000 );
}
console.log( 'getservers to ' + ip + ':' + port );
socket.sendMasterCommand.getservers(
{
ip: ip,
port: port,
protocol: protocol,
},
( err ) => {
if ( err ) {
console.log( 'error: ' + err );
}
}
);
socket.on(
'getserversResponse',
( server ) => {
if ( timeoutResponse[ip+':'+port]['getservers'] ) {
clearTimeout( timeoutResponse[ip+':'+port]['getservers'] );
timeoutResponse[ip+':'+port]['getservers'] = null;
}
console.log( ip + ':' + port + ' told us there is a server at ' + server.ip + ':' + server.port );
//TODO: check for EOT and wait for more?
// keep the socket alive again
timeoutResponse[ip+':'+port]['getservers'] = setTimeout( getServersTimeout, 2500 );
}
);
}
);
},
'serverstatus': ( args ) => {
if ( args.length !== 2 ) {
return console.log( 'usage: serverstatus <ip[:port]>' );
}
let addr = args[1].split( ':' );
let ip = addr[0];
let port = (addr.length === 2) ? addr[1] : '29070';
console.log( 'getting serverstatus for ' + ip + ':' + port );
// chains getinfo -> infoResponse -> getstatus -> statusResponse
// this little dance is necessary to inform some strict firewalls that "we're really real ^_^"
// ...like port knocking!
jkutils.createSocket(
( err, socket ) => {
//FIXME: move the socket timeout into jkutils.createSocket with callback?
function noResponse() {
console.log( 'no response from ' + ip + ':' + port );
}
if ( err ) {
return console.log( err );
}
let timeoutResponse = {};
timeoutResponse[ip+':'+port] = {};
if ( !socket ) {
noResponse();
return;
}
else {
timeoutResponse[ip+':'+port]['getinfo'] = setTimeout(
() => {
if ( !socket ) {
// this has already been done, the timeout is useless
return;
}
console.log( 'timeout for socket on getinfo' );
noResponse();
socket.close();
socket = null;
},
1000
);
}
console.log( 'getinfo to ' + ip + ':' + port );
socket.sendServerCommand.getinfo(
{
ip: ip,
port: port,
challenge: 'jkutils-cli',
},
( err ) => {
if ( err ) {
console.log( 'error: ' + err );
}
}
);
socket.on(
'infoResponse',
( info, ip, port ) => {
if ( timeoutResponse[ip+':'+port]['getinfo'] ) {
clearTimeout( timeoutResponse[ip+':'+port]['getinfo'] );
timeoutResponse[ip+':'+port]['getinfo'] = null;
}
//console.log( 'info: ' + JSON.stringify( info, null, 4 ) );
console.log( 'getstatus to ' + ip + ':' + port );
timeoutResponse[ip+':'+port]['getstatus'] = setTimeout(
() => {
if ( !socket ) {
// this has already been done, the timeout is useless
return;
}
console.log( 'timeout for socket on getstatus' );
noResponse();
socket.close();
socket = null;
},
1000
);
socket.sendServerCommand.getstatus(
{
ip: ip,
port: port,
challenge: 'jkutils-cli',
},
( err ) => {
if ( err ) {
console.log( 'error: ' + err );
}
}
);
socket.on(
'statusResponse',
( status, clients, ip, port ) => {
if ( timeoutResponse[ip+':'+port]['getstatus'] ) {
clearTimeout( timeoutResponse[ip+':'+port]['getstatus'] );
timeoutResponse[ip+':'+port]['getstatus'] = null;
}
console.log( 'clients: ' + JSON.stringify( clients, null, 4 ) );
console.log( 'status: ' + JSON.stringify( status, null, 4 ) );
// we're done, close the socket
socket.close();
socket = null;
}
);
}
);
}
);
},
};
if ( !module.parent ) {
console.log( 'running jkutils from cli' );
// cut off the process and script name
let args = process.argv.slice( 2 );
let handlerFunc = handlers[args[0]];
if ( handlerFunc ) {
return handlerFunc( args );
}
console.log( 'please specify a command:\n ' + Object.keys( handlers ).join( '\n ' ) );
}
module.exports = jkutils; |