1
0
mirror of https://github.com/hack-chat/main.git synced 2024-03-22 13:20:33 +08:00

Completed protocol decoupling

This commit is contained in:
marzavec 2018-06-03 11:08:35 -07:00
parent 71e940ddba
commit 62daa4893f
17 changed files with 519 additions and 446 deletions

View File

@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file.
## [Unreleased]
## [2.0.3] - 2018-06-03
### Added
- `./server/src/commands/mod/dumb.js` module for server-wide shadow muting
- `./server/src/commands/mod/speak.js` module unmuting
- `./server/src/commands/internal/socketreply.js` module to route warning to clients
- `./server/src/commands/core/ping.js` module to prevent `didYouMean` errors on legacy sources
### Changed
- Moved `disconnect.js` into servers internal modules directory
- Restructured `server.js` and `commands.js`, removing hardcoded protocol use
## [2.0.2] - 2018-05-19
### Added
- `./documentation/DOCUMENTATION.md` document which gives overview of the applications protocol

View File

@ -40,6 +40,7 @@ See [DEPLOY.md](documentation/DEPLOY.md)
* [**MinusGix**](https://github.com/MinusGix) - *Base updates*
* [**Neel Kamath**](https://github.com/neelkamath) - *Base Documentation*
* [**Carlos Villavicencio**](https://github.com/po5i) - *Syntax Highlighting Integration*
* [**OpSimple**](https://github.com/OpSimple) - *Modules Added: dumb.js & speak.js*
* Andrew Belt, https://github.com/AndrewBelt, for original base work
* [wwandrew](https://github.com/wwandrew), for finding server flaws (including attack vectors) and submitting ~~___incredibly detailed___~~ bug reports
* [Everyone else](https://github.com/hack-chat/main/graphs/contributors) who participated in this project.

View File

@ -32,10 +32,10 @@
"resolved": "https://registry.npmjs.org/ecstatic/-/ecstatic-3.2.0.tgz",
"integrity": "sha512-Goilx/2cfU9vvfQjgtNgc2VmJAD8CasQ6rZDqCd2u4Hsyd/qFET6nBf60jiHodevR3nl3IGzNKtrzPXWP88utQ==",
"requires": {
"he": "1.1.1",
"mime": "1.6.0",
"minimist": "1.2.0",
"url-join": "2.0.5"
"he": "^1.1.1",
"mime": "^1.4.1",
"minimist": "^1.1.0",
"url-join": "^2.0.2"
}
},
"eventemitter3": {
@ -48,7 +48,7 @@
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.0.tgz",
"integrity": "sha512-fdrt472/9qQ6Kgjvb935ig6vJCuofpBUD14f9Vb+SLlm7xIe4Qva5gey8EKtv8lp7ahE1wilg3xL1znpVGtZIA==",
"requires": {
"debug": "3.1.0"
"debug": "^3.1.0"
}
},
"he": {
@ -61,9 +61,9 @@
"resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.17.0.tgz",
"integrity": "sha512-Taqn+3nNvYRfJ3bGvKfBSRwy1v6eePlm3oc/aWVxZp57DQr5Eq3xhKJi7Z4hZpS8PC3H4qI+Yly5EmFacGuA/g==",
"requires": {
"eventemitter3": "3.1.0",
"follow-redirects": "1.5.0",
"requires-port": "1.0.0"
"eventemitter3": "^3.0.0",
"follow-redirects": "^1.0.0",
"requires-port": "^1.0.0"
}
},
"http-server": {
@ -72,13 +72,13 @@
"integrity": "sha512-6JeGDGoujJLmhjiRGlt8yK8Z9Kl0vnl/dQoQZlc4oeqaUoAKQg94NILLfrY3oWzSyFaQCVNTcKE5PZ3cH8VP9w==",
"requires": {
"colors": "1.0.3",
"corser": "2.0.1",
"ecstatic": "3.2.0",
"http-proxy": "1.17.0",
"opener": "1.4.3",
"optimist": "0.6.1",
"portfinder": "1.0.13",
"union": "0.4.6"
"corser": "~2.0.0",
"ecstatic": "^3.0.0",
"http-proxy": "^1.8.1",
"opener": "~1.4.0",
"optimist": "0.6.x",
"portfinder": "^1.0.13",
"union": "~0.4.3"
}
},
"mime": {
@ -121,8 +121,8 @@
"resolved": "https://registry.npmjs.org/optimist/-/optimist-0.6.1.tgz",
"integrity": "sha1-2j6nRob6IaGaERwybpDrFaAZZoY=",
"requires": {
"minimist": "0.0.10",
"wordwrap": "0.0.3"
"minimist": "~0.0.1",
"wordwrap": "~0.0.2"
},
"dependencies": {
"minimist": {
@ -137,9 +137,9 @@
"resolved": "https://registry.npmjs.org/portfinder/-/portfinder-1.0.13.tgz",
"integrity": "sha1-uzLs2HwnEErm7kS1o8y/Drsa7ek=",
"requires": {
"async": "1.5.2",
"debug": "2.6.9",
"mkdirp": "0.5.1"
"async": "^1.5.2",
"debug": "^2.2.0",
"mkdirp": "0.5.x"
},
"dependencies": {
"debug": {
@ -167,7 +167,7 @@
"resolved": "https://registry.npmjs.org/union/-/union-0.4.6.tgz",
"integrity": "sha1-GY+9rrolTniLDvy2MLwR8kopWeA=",
"requires": {
"qs": "2.3.3"
"qs": "~2.3.3"
}
},
"url-join": {

View File

@ -1,6 +1,6 @@
{
"name": "hack.chat-v2",
"version": "2.0.1",
"version": "2.0.3",
"description": "a minimal distraction free chat application",
"main": "index.js",
"repository": {

652
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{
"name": "hack.chat-v2",
"version": "2.0.2",
"version": "2.0.3",
"description": "a minimal distraction free chat application",
"main": "index.js",
"repository": {

100
server/package-lock.json generated
View File

@ -9,7 +9,7 @@
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
"integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
"requires": {
"color-convert": "1.9.1"
"color-convert": "^1.9.0"
}
},
"async": {
@ -27,8 +27,8 @@
"resolved": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-6.26.0.tgz",
"integrity": "sha1-llxwWGaOgrVde/4E/yM3vItWR/4=",
"requires": {
"core-js": "2.5.6",
"regenerator-runtime": "0.11.1"
"core-js": "^2.4.0",
"regenerator-runtime": "^0.11.0"
}
},
"balanced-match": {
@ -46,7 +46,7 @@
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
"integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
"requires": {
"balanced-match": "1.0.0",
"balanced-match": "^1.0.0",
"concat-map": "0.0.1"
}
},
@ -55,9 +55,9 @@
"resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.1.tgz",
"integrity": "sha512-ObN6h1v2fTJSmUXoS3nMQ92LbDK9be4TV+6G+omQlGJFdcUX5heKi1LZ1YnRMIgwTLEj3E24bT6tYni50rlCfQ==",
"requires": {
"ansi-styles": "3.2.1",
"escape-string-regexp": "1.0.5",
"supports-color": "5.4.0"
"ansi-styles": "^3.2.1",
"escape-string-regexp": "^1.0.5",
"supports-color": "^5.3.0"
}
},
"color-convert": {
@ -65,7 +65,7 @@
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.1.tgz",
"integrity": "sha512-mjGanIiwQJskCC18rPR6OmrZ6fm2Lc7PeGFYwCmy5J34wC6F1PzdGL6xeMfmgicfYcNLGuVFA3WzXtIDCQSZxQ==",
"requires": {
"color-name": "1.1.3"
"color-name": "^1.1.1"
}
},
"color-name": {
@ -83,7 +83,7 @@
"resolved": "https://registry.npmjs.org/common-tags/-/common-tags-1.7.2.tgz",
"integrity": "sha512-joj9ZlUOjCrwdbmiLqafeUSgkUM74NqhLsZtSqDmhKudaIY197zTrb8JMl31fMnCUuxwFT23eC/oWvrZzDLRJQ==",
"requires": {
"babel-runtime": "6.26.0"
"babel-runtime": "^6.26.0"
}
},
"concat-map": {
@ -111,8 +111,8 @@
"resolved": "https://registry.npmjs.org/deasync/-/deasync-0.1.13.tgz",
"integrity": "sha512-/6ngYM7AapueqLtvOzjv9+11N2fHDSrkxeMF1YPE20WIfaaawiBg+HZH1E5lHrcJxlKR42t6XPOEmMmqcAsU1g==",
"requires": {
"bindings": "1.2.1",
"nan": "2.10.0"
"bindings": "~1.2.1",
"nan": "^2.0.7"
}
},
"deep-equal": {
@ -125,8 +125,8 @@
"resolved": "https://registry.npmjs.org/didyoumean2/-/didyoumean2-1.3.0.tgz",
"integrity": "sha1-bjT0AUM1HJIGlulyO7oB/8C5ZAI=",
"requires": {
"leven": "2.1.0",
"lodash": "4.17.10"
"leven": "^2.0.0",
"lodash": "^4.17.2"
}
},
"escape-string-regexp": {
@ -144,9 +144,9 @@
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-5.0.0.tgz",
"integrity": "sha512-66Pm4RYbjzdyeuqudYqhFiNBbCIuI9kgRqLPSHIlXHidW8NIQtVdkM1yeZ4lXwuhbTETv3EUGMNHAAw6hiundQ==",
"requires": {
"graceful-fs": "4.1.11",
"jsonfile": "4.0.0",
"universalify": "0.1.1"
"graceful-fs": "^4.1.2",
"jsonfile": "^4.0.0",
"universalify": "^0.1.0"
}
},
"fs.realpath": {
@ -159,12 +159,12 @@
"resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz",
"integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==",
"requires": {
"fs.realpath": "1.0.0",
"inflight": "1.0.6",
"inherits": "2.0.3",
"minimatch": "3.0.4",
"once": "1.4.0",
"path-is-absolute": "1.0.1"
"fs.realpath": "^1.0.0",
"inflight": "^1.0.4",
"inherits": "2",
"minimatch": "^3.0.4",
"once": "^1.3.0",
"path-is-absolute": "^1.0.0"
}
},
"graceful-fs": {
@ -187,8 +187,8 @@
"resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
"integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=",
"requires": {
"once": "1.4.0",
"wrappy": "1.0.2"
"once": "^1.3.0",
"wrappy": "1"
}
},
"inherits": {
@ -206,7 +206,7 @@
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
"integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=",
"requires": {
"graceful-fs": "4.1.11"
"graceful-fs": "^4.1.6"
}
},
"leven": {
@ -224,7 +224,7 @@
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
"integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
"requires": {
"brace-expansion": "1.1.11"
"brace-expansion": "^1.1.7"
}
},
"minimist": {
@ -260,7 +260,7 @@
"resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
"integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
"requires": {
"wrappy": "1.0.2"
"wrappy": "1"
}
},
"path-is-absolute": {
@ -278,12 +278,12 @@
"resolved": "https://registry.npmjs.org/prompt/-/prompt-1.0.0.tgz",
"integrity": "sha1-jlcSPDlquYiJf7Mn/Trtw+c15P4=",
"requires": {
"colors": "1.2.5",
"pkginfo": "0.4.1",
"read": "1.0.7",
"revalidator": "0.1.8",
"utile": "0.3.0",
"winston": "2.1.1"
"colors": "^1.1.2",
"pkginfo": "0.x.x",
"read": "1.0.x",
"revalidator": "0.1.x",
"utile": "0.3.x",
"winston": "2.1.x"
}
},
"read": {
@ -291,7 +291,7 @@
"resolved": "https://registry.npmjs.org/read/-/read-1.0.7.tgz",
"integrity": "sha1-s9oZvQUkMal2cdRKQmNK33ELQMQ=",
"requires": {
"mute-stream": "0.0.7"
"mute-stream": "~0.0.4"
}
},
"readdir-recursive": {
@ -314,7 +314,7 @@
"resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.2.tgz",
"integrity": "sha512-lreewLK/BlghmxtfH36YYVg1i8IAce4TI7oao75I1g245+6BctqTVQiBP3YUJ9C6DQOXJmkYR9X9fCLtCOJc5w==",
"requires": {
"glob": "7.1.2"
"glob": "^7.0.5"
}
},
"stack-trace": {
@ -327,7 +327,7 @@
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.4.0.tgz",
"integrity": "sha512-zjaXglF5nnWpsq470jSv6P9DwPvgLkuapYmfDm3JWOm0vkNTVF2tI4UrN2r6jH1qM/uc/WtxYY1hYoA2dOKj5w==",
"requires": {
"has-flag": "3.0.0"
"has-flag": "^3.0.0"
}
},
"universalify": {
@ -340,12 +340,12 @@
"resolved": "https://registry.npmjs.org/utile/-/utile-0.3.0.tgz",
"integrity": "sha1-E1LDQOuCDk2N26A5pPv6oy7U7zo=",
"requires": {
"async": "0.9.2",
"deep-equal": "0.2.2",
"i": "0.3.6",
"mkdirp": "0.5.1",
"ncp": "1.0.1",
"rimraf": "2.6.2"
"async": "~0.9.0",
"deep-equal": "~0.2.1",
"i": "0.3.x",
"mkdirp": "0.x.x",
"ncp": "1.0.x",
"rimraf": "2.x.x"
}
},
"winston": {
@ -353,13 +353,13 @@
"resolved": "https://registry.npmjs.org/winston/-/winston-2.1.1.tgz",
"integrity": "sha1-PJNJ0ZYgf9G9/51LxD73JRDjoS4=",
"requires": {
"async": "1.0.0",
"colors": "1.0.3",
"cycle": "1.0.3",
"eyes": "0.1.8",
"isstream": "0.1.2",
"pkginfo": "0.3.1",
"stack-trace": "0.0.10"
"async": "~1.0.0",
"colors": "1.0.x",
"cycle": "1.0.x",
"eyes": "0.1.x",
"isstream": "0.1.x",
"pkginfo": "0.3.x",
"stack-trace": "0.0.x"
},
"dependencies": {
"async": {
@ -389,7 +389,7 @@
"resolved": "https://registry.npmjs.org/ws/-/ws-5.1.1.tgz",
"integrity": "sha512-bOusvpCb09TOBLbpMKszd45WKC2KPtxiyiHanv+H2DE3Az+1db5a/L7sVJZVDPUC1Br8f0SKRr1KjLpD1U/IAw==",
"requires": {
"async-limiter": "1.0.0"
"async-limiter": "~1.0.0"
}
}
}

View File

@ -1,6 +1,6 @@
{
"name": "hack.chat-v2",
"version": "2.0.1",
"version": "2.0.3",
"description": "a minimal distraction free chat application",
"main": "main.js",
"repository": {

View File

@ -48,6 +48,7 @@ exports.run = async (core, server, socket, data) => {
payload.trip = socket.trip;
}
// TODO: Add a more contained way for modules to interact, event hooks or something?
if(core.muzzledHashes && core.muzzledHashes[socket.hash]){
server.broadcast( payload, { channel: socket.channel, hash: socket.hash });
if(core.muzzledHashes[socket.hash].allies){

View File

@ -1,21 +0,0 @@
/*
Description: This module will be directly called by the server event handler
when a socket connection is closed or lost. It can calso be called
by a client to have the connection severed.
*/
exports.run = async (core, server, socket, data) => {
if (socket.channel) {
server.broadcast({
cmd: 'onlineRemove',
nick: socket.nick
}, { channel: socket.channel });
}
socket.terminate();
};
exports.info = {
name: 'disconnect',
description: 'Event handler or force disconnect (if your into that kind of thing)'
};

View File

@ -0,0 +1,12 @@
/*
Description: This module is only in place to supress error notices legacy sources may get
*/
exports.run = async (core, server, socket, data) => {
return;
};
exports.info = {
name: 'ping',
description: 'This module is only in place to supress error notices legacy sources may get'
};

View File

@ -0,0 +1,30 @@
/*
Description: This module will be directly called by the server event handler
when a socket connection is closed or lost.
*/
exports.run = async (core, server, socket, data) => {
if (data.cmdKey !== server._cmdKey) {
// internal command attempt by client, increase rate limit chance and ignore
server._police.frisk(socket.remoteAddress, 20);
return;
}
if (socket.channel) {
server.broadcast({
cmd: 'onlineRemove',
nick: socket.nick
}, { channel: socket.channel });
}
socket.terminate();
};
exports.requiredData = ['cmdKey'];
exports.info = {
name: 'disconnect',
usage: 'Internal Use Only',
description: 'Internally used to relay `onlineRemove` event to clients'
};

View File

@ -0,0 +1,22 @@
/*
Description: Used to relay warnings to clients internally
*/
exports.run = async (core, server, socket, data) => {
if (data.cmdKey !== server._cmdKey) {
// internal command attempt by client, increase rate limit chance and ignore
server._police.frisk(socket.remoteAddress, 20);
return;
}
server.reply({ cmd: 'warn', text: data.text }, socket);
};
exports.requiredData = ['cmdKey', 'text'];
exports.info = {
name: 'socketreply',
usage: 'Internal Use Only',
description: 'Internally used to relay warnings to clients'
};

View File

@ -59,5 +59,5 @@ exports.requiredData = ['nick'];
exports.info = {
name: 'dumb',
usage: 'dumb {nick} [allies...]',
description: 'Cleanly disable a user messages and make him dumb'
description: 'Globally shadow mute a connection. Optional allies array will see muted messages.'
};

View File

@ -3,7 +3,6 @@
* Author: simple
*/
exports.run = async (core, server, socket, data) => {
if (socket.uType == 'user') {
// ignore if not mod or admin

View File

@ -11,6 +11,7 @@ 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 internalCmdKey = (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
@ -26,6 +27,8 @@ class server extends wsServer {
this._core = core;
this._police = new Police();
this._cmdBlacklist = {};
this._cmdKey = internalCmdKey;
this._heartBeat = setInterval(((data) => {
this.beatHeart();
}).bind(this), pulseSpeed);
@ -90,7 +93,11 @@ class server extends wsServer {
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);
this._core.commands.handleCommand(this, socket, {
cmd: 'socketreply',
cmdKey: this._cmdKey,
text: 'Your IP is being rate-limited or blocked.'
});
return;
}
@ -116,7 +123,7 @@ class server extends wsServer {
return;
}
if (typeof args.cmd === 'undefined' || args.cmd == 'ping') {
if (typeof args.cmd === 'undefined') {
return;
}
@ -142,7 +149,10 @@ class server extends wsServer {
* @param {Object} socket Closing socket object
*/
handleClose (socket) {
this._core.commands.handleCommand(this, socket, { cmd: 'disconnect' });
this._core.commands.handleCommand(this, socket, {
cmd: 'disconnect',
cmdKey: this._cmdKey
});
}
/**

View File

@ -182,10 +182,11 @@ class CommandManager {
if (maybe) {
// Found a suggestion, pass it on to their dyslexic self
return server.reply({
cmd: 'warn',
return this.handleCommand(server, socket, {
cmd: 'socketreply',
cmdKey: server._cmdKey,
text: `Command not found, did you mean: \`${maybe}\`?`
}, socket);
});
}
// Request so mangled that I don't even, silently fail
@ -209,12 +210,12 @@ class CommandManager {
}
if (missing.length > 0) {
let errText = `Failed to execute '${command.info.name}': missing required ${missing.join(', ')}\n\n`;
server.reply({
cmd: 'warn',
text: errText
}, socket);
console.log(`Failed to execute '${command.info.name}': missing required ${missing.join(', ')}\n\n`);
this.handleCommand(server, socket, {
cmd: 'socketreply',
cmdKey: server._cmdKey,
text: `Failed to execute '${command.info.name}': missing required ${missing.join(', ')}\n\n`
});
return null;
}
@ -226,10 +227,11 @@ class CommandManager {
let errText = `Failed to execute '${command.info.name}': ${err}`;
console.log(errText);
server.reply({
cmd: 'warn',
this.handleCommand(server, socket, {
cmd: 'socketreply',
cmdKey: server._cmdKey,
text: errText
}, socket);
});
return null;
}