aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/core/server.js
blob: 9bea73888fc101fd4247754573fe7aae93a23f66 (plain)
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
/**
  * Main websocket server handling communications and connection events
  *
  * Version: v2.0.0
  * Developer: Marzavec ( https://github.com/marzavec )
  * License: WTFPL ( http://www.wtfpl.net/txt/copying/ )
  *
  */

'use strict';

const wsServer = require('ws').Server;
const socketReady = require('ws').OPEN;
const crypto = require('crypto');
const ipSalt = (Math.random().toString(36).substring(2, 16) + Math.random().toString(36).substring(2, (Math.random() * 16))).repeat(16);
const Police = require('./rateLimiter');
const pulseSpeed = 16000; // ping all clients every X ms

class server extends wsServer {
  /**
   * Create a HackChat server instance.
   *
   * @param {Object} core Reference to the global core object
   */
  constructor (core) {
    super({ port: core.config.websocketPort });

    this._core = core;
    this._police = new Police();
    this._cmdBlacklist = {};
    this._heartBeat = setInterval(((data) => {
      this.beatHeart();
    }).bind(this), pulseSpeed);

    this.on('error', (err) => {
      this.handleError('server', err);
    });

    this.on('connection', (socket, request) => {
      this.newConnection(socket, request);
    });
  }

  /**
    * Send empty `ping` frame to each client
    *
    */
  beatHeart () {
    let targetSockets = this.findSockets({});

    if (targetSockets.length === 0) {
      return;
    }

    for (let i = 0, l = targetSockets.length; i < l; i++) {
      try {
        if (targetSockets[i].readyState === socketReady) {
          targetSockets[i].ping();
        }
      } catch (e) { }
    }
  }

  /**
    * Bind listeners for the new socket created on connection to this class
    *
    * @param {Object} socket New socket object
    * @param {Object} request Initial headers of the new connection
    */
  newConnection (socket, request) {
    socket.remoteAddress = request.headers['x-forwarded-for'] || request.connection.remoteAddress;

  	socket.on('message', ((data) => {
      this.handleData(socket, data);
    }).bind(this));

    socket.on('close', (() => {
      this.handleClose(socket);
    }).bind(this));

    socket.on('error', ((err) => {
      this.handleError(socket, err);
    }).bind(this));
  }

  /**
    * Handle incoming messages from clients, parse and check command, then hand-off
    *
    * @param {Object} socket Calling socket object
    * @param {String} data Message sent from client
    */
  handleData (socket, data) {
    // Don't penalize yet, but check whether IP is rate-limited
    if (this._police.frisk(socket.remoteAddress, 0)) {
      this.reply({ cmd: 'warn', text: "Your IP is being rate-limited or blocked." }, socket);

      return;
    }

    // Penalize here, but don't do anything about it
    this._police.frisk(socket.remoteAddress, 1);

    // ignore ridiculously large packets
    if (data.length > 65536) {
      return;
    }

    // Start sent data verification
    var args = null;
    try {
      args = JSON.parse(data);
    } catch (e) {
      // Client sent malformed json, gtfo
      socket.close();
    }

    if (args === null) {
      return;
    }

    if (typeof args.cmd === 'undefined' || args.cmd == 'ping') {
      return;
    }

    if (typeof args.cmd !== 'string') {
      return;
    }

    if (typeof socket.channel === 'undefined' && args.cmd !== 'join') {
      return;
    }

    if (typeof this._cmdBlacklist[args.cmd] === 'function') {
      return;
    }

    // Finished verification, pass to command modules
    this._core.commands.handleCommand(this, socket, args);
  }

  /**
    * Handle socket close from clients
    *
    * @param {Object} socket Closing socket object
    */
  handleClose (socket) {
    this._core.commands.handleCommand(this, socket, { cmd: 'disconnect' });
  }

  /**
    * "Handle" server or socket errors
    *
    * @param {Object||String} socket Calling socket object, or 'server'
    * @param {String} err The sad stuff
    */
  handleError (socket, err) {
    console.log(`Server error: ${err}`);
  }

  /**
    * Send data payload to specific socket/client
    *
    * @param {Object} data Object to convert to json for transmission
    * @param {Object} socket The target client
    */
  send (data, socket) {
    // Add timestamp to command
    data.time = Date.now();

    try {
      if (socket.readyState === socketReady) {
        socket.send(JSON.stringify(data));
      }
    } catch (e) { }
  }

  /**
    * Overload function for `this.send()`
    *
    * @param {Object} data Object to convert to json for transmission
    * @param {Object} socket The target client
    */
  reply (data, socket) {
    this.send(data, socket);
  }

  /**
    * Finds sockets/clients that meet the filter requirements, then passes the data to them
    *
    * @param {Object} data Object to convert to json for transmission
    * @param {Object} filter see `this.findSockets()`
    */
  broadcast (data, filter) {
    let targetSockets = this.findSockets(filter);

    if (targetSockets.length === 0) {
      return false;
    }

    for (let i = 0, l = targetSockets.length; i < l; i++) {
      this.send(data, targetSockets[i]);
    }

    return true;
  }

  /**
    * Finds sockets/clients that meet the filter requirements, returns result as array
    *
    * @param {Object} data Object to convert to json for transmission
    * @param {Object} filter The socket must of equal or greater attribs matching `filter`
    *                        = {} // matches all
    *                        = { channel: 'programming' } // matches any socket where (`socket.channel` === 'programming')
    *                        = { channel: 'programming', nick: 'Marzavec' } // matches any socket where (`socket.channel` === 'programming' && `socket.nick` === 'Marzavec')
    */
  findSockets (filter) {
    let filterAttribs = Object.keys(filter);
    let reqCount = filterAttribs.length;
    let curMatch;
    let matches = [];
    for ( let socket of this.clients ) {
      curMatch = 0;

      for (let i = 0; i < reqCount; i++) {
        if (typeof socket[filterAttribs[i]] !== 'undefined') {
          switch(typeof filter[filterAttribs[i]]) {
            case 'object': {
              if (Array.isArray(filter[filterAttribs[i]])) {
                if (filter[filterAttribs[i]].indexOf(socket[filterAttribs[i]]) !== -1) {
                  curMatch++;
                }
              } else {
                if (socket[filterAttribs[i]] === filter[filterAttribs[i]]) {
                  curMatch++;
                }
              }
            break;
            }

            case 'function': {
              if (filter[filterAttribs[i]](socket[filterAttribs[i]])) {
                curMatch++;
              }
            break;
            }

            default: {
              if (socket[filterAttribs[i]] === filter[filterAttribs[i]]) {
                curMatch++;
              }
            break;
            }
          }
        }
      }

      if (curMatch === reqCount) {
        matches.push(socket);
      }
    }

    return matches;
  }

  /**
    * Encrypts target socket's remote address using non-static variable length salt
    * encodes and shortens the output, returns that value
    *
    * @param {Object||String} target Either the target socket or ip as string
    */
  getSocketHash (target) {
    let sha = crypto.createHash('sha256');

    if (typeof target === 'string') {
      sha.update(target + ipSalt);
    } else {
      sha.update(target.remoteAddress + ipSalt);
    }

    return sha.digest('base64').substr(0, 15);
  }
}

module.exports = server;