Skip to content

OF-3170: Implement basic rate limiting for new connections (C2S and S2S) #3127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
guusdk wants to merge 7 commits into
base: main
Choose a base branch
from
Open

OF-3170: Implement basic rate limiting for new connections (C2S and S2S) #3127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8352e08
OF-3171: Implement basic rate limiting for new connections (C2S and S2S)
guusdk Jan 22, 2026
0af0873
OF-3173: Expose rate-limiting statistics via Statistics API
guusdk Feb 12, 2026
99dd7d1
OF-3171: Enforce connection rate limiting before pipeline initialization
guusdk Mar 6, 2026
47593f3
OF-3171: Fix thread safety, overflow, and unlimited correctness in To…
guusdk Mar 6, 2026
b036b2a
OF-3171: Fix token bucket refill precision and clarify refill logic
guusdk Mar 26, 2026
3c566f8
OF-3173: Use new fake clock in TokenBucketRateLimiter tests
guusdk Mar 26, 2026
d09f100
OF-3172: Add admin UI for connection rate limiting settings
guusdk Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions i18n/src/main/resources/openfire_i18n.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1339,6 +1339,13 @@ system_property.xmpp.xml.xml-declaration.suppress=Controls if an XML declaration
system_property.xmpp.xml.xml-declaration.suppress-newline=Controls if a newline is added after a generated XML declaration and the 'stream' open tag.
system_property.plugins.unloading.directory.destroy.delay=A delay that is observed between the time a plugin's unloading starts, and the plugin directory actually being removed.
system_property.plugins.unloading.directory.destroy.timeout=The maximum time that Openfire will wait for a plugin directory to be destroyed after the plugin is unloaded.
system_property.xmpp.ratelimit.newconnections.c2s.enabled=Enables or disables rate limiting for new client-to-server (C2S) connections.
system_property.xmpp.ratelimit.newconnections.c2s.max_burst=The maximum number of new client-to-server connection attempts that can be accepted in a short burst. Helps absorb spikes without exceeding the sustained rate.
system_property.xmpp.ratelimit.newconnections.c2s.permits_per_second=The sustained rate of new client-to-server connection attempts allowed per second. This applies to all C2S types (TCP, BOSH, WebSocket) combined.
system_property.xmpp.ratelimit.newconnections.logging.suppress=The minimum time to suppress repeated log messages for rejected new connection attempts of the same connection type; a value of zero or less disables log suppression.
system_property.xmpp.ratelimit.newconnections.s2s.enabled=Enables or disables rate limiting for new server-to-server (S2S) connections.
system_property.xmpp.ratelimit.newconnections.s2s.max_burst=The maximum number of new server-to-server connection attempts that can be accepted in a short burst. Allows temporary bursts without violating the sustained rate.
system_property.xmpp.ratelimit.newconnections.s2s.permits_per_second=The sustained rate of new server-to-server connection attempts allowed per second. Applies to all S2S (federation) connection types, which currently is just TCP.
system_property.plugins.upload.enabled=Defines if the admin console can be used to upload plugins.
system_property.plugins.upload.content-type-check.enabled=Determines if the content-type of uploaded plugin files is verified.
system_property.plugins.upload.content-type-check.expected-value=Defines the expected content-type of uploaded plugin files.
Expand Down Expand Up @@ -1639,6 +1646,13 @@ server2server.settings.confirm.updated=Remote server information updated success
server2server.settings.confirm.allowed=Remote server is now allowed to connect to the server.
server2server.settings.confirm.blocked=Remote server is now not allowed to connect to the server.
server2server.settings.confirm.deleted=Remote server information was deleted.
server2server.settings.ratelimit.title=New Connection Rate Limiting
server2server.settings.ratelimit.enable=Enable rate limiting for new connections.
server2server.settings.ratelimit.info=Configure how quickly new server-to-server connections can be accepted.
server2server.settings.ratelimit.permits=Permits per second
server2server.settings.ratelimit.max_burst=Maximum burst
server2server.settings.ratelimit.permits.invalid=Permits per second must be a positive whole number.
server2server.settings.ratelimit.max_burst.invalid=Maximum burst must be a positive whole number.
server2server.settings.testing.title=Server to Server Test
server2server.settings.testing.info=This page can be used to test the connectivity to a remote XMPP domain. Please be \
aware that during the test, any pre-existing connection to the remote domain will be disconnected. This might \
Expand Down Expand Up @@ -3631,6 +3645,13 @@ client.connections.settings.ping.footnote=The XMPP specification requires all cl
If a client does not support the XMPP Ping request, it must return an error (which in itself is a response too).
client.connections.settings.ping.enable=Send an XMPP Ping request to idle clients.
client.connections.settings.ping.disable=Do not send XMPP Ping requests to idle clients.
client.connections.settings.ratelimit.title=New Connection Rate Limiting
client.connections.settings.ratelimit.enable=Enable rate limiting for new connections.
client.connections.settings.ratelimit.info=Configure how quickly new client-to-server connections (TCP, WebSocket and BOSH combined) can be accepted.
client.connections.settings.ratelimit.permits=Permits per second
client.connections.settings.ratelimit.max_burst=Maximum burst
client.connections.settings.ratelimit.permits.invalid=Permits per second must be a positive whole number.
client.connections.settings.ratelimit.max_burst.invalid=Maximum burst must be a positive whole number.

# Connection type and mode
connection-type.socket-s2s=server-to-server (federation)
Expand Down Expand Up @@ -4141,3 +4162,55 @@ commands.event.vcardmodified.note.vcard-does-not-exist=VCard not found.
commands.generic.ping.label=Request pong from server
commands.generic.ping.form.title=Server ping result (pong!)
commands.generic.ping.form.field.timestamp.label=Server Time

# Rate Limiter Stats

stat.ratelimit.newconnections.socket_c2s.accepted.name=RL: C2S Allowed
stat.ratelimit.newconnections.socket_c2s.accepted.desc=Total number of client-to-server connections (TCP, websocket and BOSH) accepted by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.socket_c2s.accepted.units=connections
stat.ratelimit.newconnections.socket_c2s.rejected.name=RL: C2S Rejected
stat.ratelimit.newconnections.socket_c2s.rejected.desc=Total number of client-to-server connections (TCP, websocket and BOSH) rejected by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.socket_c2s.rejected.units=connections
stat.ratelimit.newconnections.socket_c2s.tokens.name=RL: C2S Tokens
stat.ratelimit.newconnections.socket_c2s.tokens.desc=Currently available tokens in the rate limiter for client-to-server connections (TCP, websocket and BOSH).
stat.ratelimit.newconnections.socket_c2s.tokens.units=tokens

stat.ratelimit.newconnections.socket_s2s.accepted.name=RL: S2S Allowed
stat.ratelimit.newconnections.socket_s2s.accepted.desc=Total number of server-to-server connections accepted by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.socket_s2s.accepted.units=connections
stat.ratelimit.newconnections.socket_s2s.rejected.name=RL: S2S Rejected
stat.ratelimit.newconnections.socket_s2s.rejected.desc=Total number of server-to-server connections rejected by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.socket_s2s.rejected.units=connections
stat.ratelimit.newconnections.socket_s2s.tokens.name=RL: S2S Tokens
stat.ratelimit.newconnections.socket_s2s.tokens.desc=Currently available tokens in the rate limiter for server-to-server connections.
stat.ratelimit.newconnections.socket_s2s.tokens.units=tokens

stat.ratelimit.newconnections.webadmin.accepted.name=RL: Webadmin Allowed
stat.ratelimit.newconnections.webadmin.accepted.desc=Total number of admin console connections accepted by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.webadmin.accepted.units=connections
stat.ratelimit.newconnections.webadmin.rejected.name=RL: Webadmin Rejected
stat.ratelimit.newconnections.webadmin.rejected.desc=Total number of admin console connections rejected by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.webadmin.rejected.units=connections
stat.ratelimit.newconnections.webadmin.tokens.name=RL: Webadmin Tokens
stat.ratelimit.newconnections.webadmin.tokens.desc=Currently available tokens in the rate limiter for admin console connections.
stat.ratelimit.newconnections.webadmin.tokens.units=tokens

stat.ratelimit.newconnections.component.accepted.name=RL: Component Allowed
stat.ratelimit.newconnections.component.accepted.desc=Total number of External Component connections accepted by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.component.accepted.units=connections
stat.ratelimit.newconnections.component.rejected.name=RL: Component Rejected
stat.ratelimit.newconnections.component.rejected.desc=Total number of External Component connections rejected by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.component.rejected.units=connections
stat.ratelimit.newconnections.component.tokens.name=RL: Component Tokens
stat.ratelimit.newconnections.component.tokens.desc=Currently available tokens in the rate limiter for External Component connections.
stat.ratelimit.newconnections.component.tokens.units=tokens

stat.ratelimit.newconnections.connection_manager.accepted.name=RL: ConnMan Allowed
stat.ratelimit.newconnections.connection_manager.accepted.desc=Total number of Connection Manager connections accepted by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.connection_manager.accepted.units=connections
stat.ratelimit.newconnections.connection_manager.rejected.name=RL: ConnMan Rejected
stat.ratelimit.newconnections.connection_manager.rejected.desc=Total number of Connection Manager connections rejected by the rate limiter. This is an absolute number since the last reset of the rate limiter.
stat.ratelimit.newconnections.connection_manager.rejected.units=connections
stat.ratelimit.newconnections.connection_manager.tokens.name=RL: ConnMan Tokens
stat.ratelimit.newconnections.connection_manager.tokens.desc=Currently available tokens in the rate limiter for Connection Manager connections.
stat.ratelimit.newconnections.connection_manager.tokens.units=tokens
Loading
Loading