Files
burrow-server/lib/sfs.js
T
SnipzilandClaude Opus 5.5 e05565787f feat(server): staff tools, player-made items, picture safety, chat, multiplayer games
Staff and moderation
- Invisible staff (!invisible, "xiv"): hidden from players, half see-through
  to other staff, cannot chat while hidden. New permission staff.invisible.
- Summon and goto land on the player's exact spot ("xgt" before the move).
- Custom warnings (!warn PLAYER custom TEXT), shown in the warning popup.
- Mod notes (!note, !notes; lib/modnotes.js), on the player page and the
  dashboard.
- Granular permissions: per-role overrides (setting rolePermissions) and
  per-account grants and denies, applied live to staff who are playing
  (refreshStaff re-sends "xsp").
- Item control (lib/itemcontrol.js): lock items out of the item finder
  (!lock, !unlock, !locked), take an item from a player (!take), delete a
  custom item from the game and every inventory.
- GET items/find: search any item by name or id, marked locked, for the
  dashboards' quick lock.

Player-made items (lib/playeritems.js, "xcm")
- The Item Maker: make, rename, set the worn look, delete. 5 a day, 20 in all;
  names go through the name filter.
- Admin switches: Item Maker on/off, new items wait for approval, and a
  separate switch (on by default) that holds every player-uploaded picture
  for a moderator. Review queue for items.approve (moderator and up).
- Pictures (lib/itemart.js): PNG, JPEG and GIF cleaned of metadata, BMP
  converted to PNG; 512px and 300KB at most once cleaned.
- Worn as the maker chooses: a sticker (the picture) or a texture (the
  item's shape painted with the picture).

Picture safety
- A picture waiting for approval is never served publicly: /itemart/ 404s it,
  and it is only shown through /account|/mod|/admin/api/itemart to its maker
  and to staff who review or make items.
- A picture turned away or taken off is remembered by SHA-256 and cannot be
  uploaded again.
- Three strikes: three pictures turned away stops a player's uploads until a
  moderator lets them again. Staff can stop or allow uploads by hand.
- Accounts under 24 hours old cannot upload pictures (AJ_ITEM_ART_MIN_HOURS);
  uploads capped at 10 a day.
- Optional Google Cloud Vision SafeSearch (lib/image-moderation.js) for item
  pictures and Art Studio paintings when AJ_GOOGLE_VISION_API_KEY is set;
  fails closed when the scanner is unreachable.

Chat
- Emoji: Twemoji pictures served at /emoji/<codepoints>.png and cached in
  data/emoji (lib/emoji.js).
- Smart spam filtering before the word filter (lib/chatspam.js): long runs of
  one character, repeated words and lines, huge words and emoji floods are
  tidied, and repeats within 20 seconds are dropped.
- Typing indicator: "xty" is passed on to everyone in the room who can see
  the player, at most every 2 seconds.

Games (lib/minigames.js)
- Room games can be played together: a MULTIPLAYER table gives a game a
  waiting list (Single Player / Multiplayer). Players in the same room are
  matched, taken into the game together, and each one's moves are relayed to
  the others. Gem Breaker is the first: two players, "pos", "shoot" and
  "playerLost" relayed.
- Gem Breaker's start message now lists each player's id. Without it no
  player counted as local, so even single player could not aim.

Other
- Players stay connected through the client's new 75-minute AFK limit
  (idleTimeoutMs 80 minutes).
- Jam-a-Grams carry custom items and colours; Jammer Wall avatar photos are
  validated (walls.js photoParam).
- Weak passwords refused (common words, or containing the username).
- Code-scanning fixes: every logged value goes through logText
  (lib/logtext.js) against log injection, HSTS, path-only error logs, a
  single file read in lib/names.js.

Tests: items (pictures, approval, strikes, re-upload refusal, the hidden
waiting picture, the dashboard search), staff (invisibility, goto and summon
spots, custom warnings, notes), buddygames (two-player Gem Breaker, the
typing relay), and updates for main's verified badge and spawn rooms.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 21:44:10 -04:00

281 lines
9.5 KiB
JavaScript

"use strict";
const {logText} = require("./logtext.js");
const crypto = require("crypto");
const fs = require("fs");
const net = require("net");
const tls = require("tls");
const config = require("../config.js");
const limits = require("./limits.js");
// SmartFoxServer 1.x wire protocol as spoken by the client's SmartFoxClient:
// messages are UTF-8, terminated by a NUL byte, and come in three flavours
// told apart by their first character:
// <msg t='sys'><body action='..' r='roomId'>..</body></msg> system (XML)
// %xt%<ext>%<cmd>%<roomId>%<param>%...% extension (raw)
// {"t":"xt","b":{...}} extension (JSON)
const POLICY = '<cross-domain-policy><allow-access-from domain="*" to-ports="*"/></cross-domain-policy>';
const MAX_MESSAGE = 64 * 1024;
const RATE_WINDOW_MS = 10000;
const MAX_BACKLOG = 4 * 1024 * 1024;
const MAX_ERRORS_PER_WINDOW = 20;
// the Create Account screens are done in a few minutes; a guest connection
// does not get to stay for as long as it keeps sending something.
const SIGNUP_LIFETIME_MS = 5 * 60000;
// the login message carries the account's login token; keep it out of the log.
const forLog = message => message.replace(/(<pword><!\[CDATA\[)[\s\S]*?(\]\]>)/, "$1(hidden)$2");
const connections = new Map(); // remote address -> open sockets
let nextUserId = 1;
class Session {
constructor(socket) {
this.socket = socket;
this.id = nextUserId++;
this.key = null;
this.account = null;
this.room = null;
this.pos = null;
this.address = socket.remoteAddress || "";
this.remote = `${this.address}:${socket.remotePort}`;
}
get name() {
return this.account ? this.account.username : `#${this.id}`;
}
write(message) {
if (this.socket.writable) {
if (config.logPackets) {
console.log(`[game] -> ${logText(this.name)} ${logText(message)}`);
}
this.socket.write(message + "\0");
// A client that stopped reading must not pile up messages here forever.
if (this.socket.writableLength > MAX_BACKLOG) {
this.socket.destroy();
}
}
}
sendSys(action, roomId, body = "") {
this.write(`<msg t='sys'><body action='${action}' r='${roomId}'>${body}</body></msg>`);
}
// raw extension message. the client reads params starting at index 2 of
// [cmd, roomId, ...params].
// "%" separates fields and NUL ends the message, so neither may appear
// inside one: a player-chosen string could otherwise forge fields.
sendXt(cmd, roomId, ...params) {
this.write(`%xt%${[cmd, roomId, ...params].map(param => String(param).replace(/[%\0]/g, "")).join("%")}%`);
}
sendXtJson(roomId, obj) {
this.write(JSON.stringify({t: "xt", b: {r: roomId, o: obj}}));
}
close() {
this.socket.destroy();
}
}
const parseSys = message => {
const body = /<body action='([^']*)' r='(-?\d+)'>([\s\S]*)<\/body>/.exec(message);
if (!body) {
return null;
}
const cdata = tag => {
const match = new RegExp(`<${tag}><!\\[CDATA\\[([\\s\\S]*?)\\]\\]></${tag}>`).exec(body[3]);
return match ? match[1] : null;
};
return {action: body[1], roomId: Number(body[2]), raw: body[3], cdata};
};
// handlers: {sys(session, msg), xt(session, cmd, roomId, params), close(session)}
const start = handlers => new Promise((resolve, reject) => {
const dispatch = (session, message) => {
if (config.logPackets) {
console.log(`[game] <- ${logText(session.name)} ${logText(forLog(message))}`);
}
if (message.startsWith("<policy-file-request")) {
session.socket.end(POLICY + "\0");
return;
}
if (message[0] === "<") {
const msg = parseSys(message);
if (!msg) {
return;
}
switch (msg.action) {
case "verChk":
session.sendSys("apiOK", 0);
return;
case "rndK":
session.key = crypto.randomBytes(16).toString("hex");
session.sendSys("rndK", -1, `<k>${session.key}</k>`);
return;
default:
handlers.sys(session, msg);
return;
}
}
if (message[0] === "%") {
// %xt%o%rj%1%a%b% -> ["", "xt", "o", "rj", "1", "a", "b", ""]
const parts = message.split("%");
if (parts[1] === "xt" && parts.length >= 6) {
handlers.xt(session, parts[3], Number(parts[4]), parts.slice(5, -1));
}
return;
}
if (message[0] === "{") {
const body = JSON.parse(message).b || {};
const params = Array.isArray(body.p) ? body.p : Object.values(Object(body.p));
handlers.xt(session, String(body.c), Number(body.r), params.map(String));
}
};
const onConnection = socket => {
const address = limits.key(socket.remoteAddress);
const open = connections.get(address) || 0;
const total = [...connections.values()].reduce((sum, count) => sum + count, 0);
socket.on("error", () => {});
if (open >= config.maxConnectionsPerAddress || total >= config.maxConnections) {
socket.destroy();
return;
}
connections.set(address, open + 1);
const session = new Session(socket);
let buffer = Buffer.alloc(0);
let windowStart = Date.now();
let messagesInWindow = 0;
let bytesInWindow = 0;
let errorsInWindow = 0;
socket.setNoDelay(true);
console.log(`[game] ${logText(session.remote)} connected as #${logText(session.id)}`);
// whoever connects has to log in (or start signing up) promptly, and
// nobody may sit silent for long: the client sends keep-alives.
const loginTimer = setTimeout(() => {
if (!session.account && !session.signingUp) {
socket.destroy();
}
}, config.loginTimeoutMs);
const signupTimer = setTimeout(() => {
if (!session.account) {
socket.destroy();
}
}, SIGNUP_LIFETIME_MS);
socket.setTimeout(config.idleTimeoutMs, () => socket.destroy());
socket.on("data", chunk => {
if (Date.now() - windowStart > RATE_WINDOW_MS) {
windowStart = Date.now();
messagesInWindow = 0;
bytesInWindow = 0;
errorsInWindow = 0;
}
bytesInWindow += chunk.length;
if (bytesInWindow > config.maxBytesPerTenSeconds) {
console.log(`[game] ${logText(session.name)} disconnected for flooding`);
socket.destroy();
return;
}
buffer = Buffer.concat([buffer, chunk]);
let end;
while ((end = buffer.indexOf(0)) !== -1) {
if (end > MAX_MESSAGE) {
socket.destroy();
return;
}
if (++messagesInWindow > config.maxMessagesPerTenSeconds) {
console.log(`[game] ${logText(session.name)} disconnected for flooding`);
socket.destroy();
return;
}
const message = buffer.toString("utf8", 0, end);
buffer = buffer.subarray(end + 1);
try {
dispatch(session, message);
}
catch (err) {
// one line a failure, and an end to them: a client that sends
// nonsense in a loop is not to fill the log.
const where = String(err.stack || "").split("\n")[1] || "";
console.log(`[game] error handling message from ${logText(session.name)}: ${logText(err.message)}${logText(where ? ` (${where.trim()})` : "")}`);
if (++errorsInWindow > MAX_ERRORS_PER_WINDOW) {
console.log(`[game] ${logText(session.name)} disconnected: too many messages that could not be handled`);
socket.destroy();
return;
}
}
if (socket.destroyed) {
return;
}
}
if (buffer.length > MAX_MESSAGE) {
socket.destroy();
}
});
socket.on("close", () => {
clearTimeout(loginTimer);
clearTimeout(signupTimer);
const left = connections.get(address) - 1;
if (left > 0) {
connections.set(address, left);
}
else {
connections.delete(address);
}
console.log(`[game] ${logText(session.name)} disconnected`);
// nothing thrown while a player is seen off may take the server down.
try {
handlers.close(session);
}
catch (err) {
console.log(`[game] error while ${logText(session.name)} left: ${logText(err.stack)}`);
}
});
};
const server = config.tls
? tls.createServer({cert: fs.readFileSync(config.tls.certFile), key: fs.readFileSync(config.tls.keyFile),
handshakeTimeout: config.tlsHandshakeTimeoutMs}, onConnection)
: net.createServer(onConnection);
server.on("tlsClientError", () => {});
server.maxConnections = config.maxConnections * 2;
if (config.tls) {
// connections that have not finished their TLS greeting are counted
// too: the limit above is only reached once they have.
const greeting = new Map(); // address -> connections not yet through it
server.on("connection", raw => {
const address = limits.key(raw.remoteAddress);
const count = (greeting.get(address) || 0) + 1;
if (count > config.maxConnectionsPerAddress * 2) {
raw.destroy();
return;
}
greeting.set(address, count);
const done = () => {
const left = greeting.get(address) - 1;
if (left > 0) {
greeting.set(address, left);
}
else {
greeting.delete(address);
}
};
raw.once("close", done);
});
}
server.once("error", reject);
server.listen(config.gamePort, config.gameBindAddress, () => {
console.log(`[game] listening on ${logText(config.gameBindAddress)}:${logText(config.gamePort)}${logText(config.tls ? " (TLS)" : "")}`);
resolve(server);
});
});
module.exports = {start};