Jetty/Reference/DoSFilter

Introduction

The Denial of Service (DoS) filter limits exposure to request flooding, whether malicious, or as a result of a misconfigured client. The filter keeps track of the number of requests from a connection per second. If the requests exceed the limit, Jetty rejects, delays, or throttles the request, and sends a warning message. This works on the assumption that the attacker might be written in simple blocking style, so by suspending requests you are hopefully consuming the attacker's resources. The DoS filter is related to the QoS filter, using Jetty/Feature/Continuations#Introduction/Continuations to prioritize requests and avoid thread starvation.

(required) Jetty places throttled requests in a priority queue, giving priority first to authenticated users and users with an HttpSession, then to connections identified by their IP addresses. Connections with no way to identify them have lowest priority. To uniquely identify authenticated users, you should implement the The extractUserId(ServletRequest request) function.

The following init parameters control the behavior of the filter:

• maxRequestsPerSec–Maximum number of requests from a connection per second. Requests in excess of this are first delayed, then throttled.
• delayMs–Delay imposed on all requests over the rate limit, before they are considered at all:
  • -1 = Reject request
  • 0 = No delay
  • any other value = Delay in ms
• maxWaitMs–Length of time, in ms, to blocking wait for the throttle semaphore.
• throttledRequests–Number of requests over the rate limit able to be considered at once.
• throttleMs–Length of time, in ms, to async wait for semaphore.
• maxRequestMs</t>–Length of time, in ms, to allow the request to run.
• <tt>maxIdleTrackerMs</t>–Length of time, in ms, to keep track of request rates for a connection, before deciding that the user has gone away, and discarding it.
• <tt>insertHeaders</t>–If true, insert the DoSFilter headers into the response. Defaults to true.
• <tt>trackSessions</t>–If true, usage rate is tracked by session if a session exists. Defaults to true.
• <tt>remotePortIf true and session tracking is not used, then rate is tracked by IP+port (effectively connection). Defaults to false.
• ipWhitelistA comma-separated list of IP addresses that will not be rate limited.
• managedAttrIf set to true, then this servlet is set as a ServletContext attribute with the filter name as the attribute name. This allows context external mechanism (eg JMX via ContextHandler.MANAGED_ATTRIBUTES) to manage the configuration of the filter.