Limit the number of subscription filters per subscriber

A subscriber could keep sending subscribe requests with new filters and
the controller would add every one of them to the subscriber's filter
set without bound, growing memory until it ran out.

Add controller.max_subscription_filters (default 10000) and reject
subscribe and replace requests that would leave a subscriber holding
more filters than that for one event.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-10-08 11:10:03 +00:00
1 parent ce6bfe282f
commit 690b79d2b7
5 files changed
+95 -5

No files matched your search

+1 -1
View File
@@ -83,7 +83,7 @@ export default class Controller {
private _events = new events.EventEmitter<ControllerEvents>();
/** Event subscription controller */
subscriptions = new lib.SubscriptionController();
subscriptions = new lib.SubscriptionController(() => this.config.get("controller.max_subscription_filters"));
/** User manager for the cluster, also contains access to the user records */
users: UserManager;
/** Instance manager for the cluster, also contains access to the user records */
+8
View File
@@ -26,6 +26,7 @@ export interface ControllerConfigFields {
"controller.heartbeat_interval": number;
"controller.session_timeout": number;
"controller.metrics_timeout": number;
"controller.max_subscription_filters": number;
"controller.system_metrics_interval": number;
"controller.proxy_stream_timeout": number;
"controller.factorio_username": string | null;
@@ -208,6 +209,13 @@ export class ControllerConfig extends classes.Config<ControllerConfigFields> {
initialValue: 8,
validator: validators.greaterThanZero,
},
"controller.max_subscription_filters": {
title: "Max Subscription Filters",
description: "Maximum number of filters a single connection can hold for one subscribed event.",
type: "number",
initialValue: 10000,
validator: validators.all(validators.integer, validators.greaterThanZero),
},
"controller.system_metrics_interval": {
title: "System Metrics Interval",
description: "Interval in seconds to collect and update system metrics for the Web UI",
+28
View File
@@ -255,6 +255,14 @@ type EventData = {
export class SubscriptionController {
_events = new Map<string, EventData>();
/**
* @param maxFilters -
* Optional function returning the max number of filters a subscriber can hold for one event.
*/
constructor(
private _maxFilters: () => number = () => Infinity,
) { }
/**
* Allow clients to subscribe to an event by telling the subscription controller to accept them
* Has an optional subscription update handler which is called when a client subscribes
@@ -329,6 +337,24 @@ export class SubscriptionController {
}
}
private _checkFilterCount(filters: SubscriptionFilters, existing?: SubscriptionFilters) {
if (existing?.isAll()) {
return; // union into all is a noop
}
let count = filters.size;
if (existing) {
count = existing.size;
for (const filter of filters) {
if (!existing.has(filter)) {
count += 1;
}
}
}
if (count > this._maxFilters()) {
throw new RequestError(`Subscription exceeds the limit of ${this._maxFilters()} filters`);
}
}
/**
* Handle incoming subscription requests on a link
* @param link - Link message was received on
@@ -359,6 +385,7 @@ export class SubscriptionController {
break;
case "subscribe":
this._checkFilterCount(request.filters, subscriber?.filters);
if (!subscriber) {
eventData.subscriptions.set(index, { link, address, filters: request.filters });
} else {
@@ -367,6 +394,7 @@ export class SubscriptionController {
break;
case "replace":
this._checkFilterCount(request.filters);
if (request.filters.isEmpty()) {
if (!subscriber) {
return false;