Version: 9.4.27.v20200227 |

Denial of Service Filter
Previous | Chapter 18. Provided Servlets, Filters, and Handlers Home | Next

##### Contact the core Jetty developers at www.webtide.com

private support for your internal/customer projects ... custom extensions and distributions ... versioned snapshots for indefinite support ... scalability guidance for your apps and Ajax/Comet projects ... development services for sponsored feature development

## Denial of Service Filter

### Info

- Classname: `org.eclipse.jetty.servlets.DoSFilter`
- Maven Artifact: org.eclipse.jetty:jetty-servlets
- Javadoc: http://www.eclipse.org/jetty/javadoc/9.4.27.v20200227/org/eclipse/jetty/servlets/DoSFilter.html

### Usage

The Denial of Service (DoS) filter limits exposure to request flooding, whether malicious, or as a result of a misconfigured client. The DoS 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. The filter 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 Continuations to prioritize requests and avoid thread starvation.

### Using the DoS Filter

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.

#### Required JARs

To use the DoS Filter, these JAR files must be available in WEB-INF/lib:

- $JETTY_HOME/lib/jetty-util.jar
- $JETTY_HOME/lib/jetty-servlets.jar

#### Sample Configuration

Place the configuration in a webapp’s `web.xml` or `jetty-web.xml`. The default configuration allows 25 requests per connection at a time, servicing more important requests first, and queuing up the rest. This example allow 30 requests at a time:

    <filter>
       <filter-name>DoSFilter</filter-name>
       <filter-class>org.eclipse.jetty.servlets.DoSFilter</filter-class>
       <init-param>
         <param-name>maxRequestsPerSec</param-name>
         <param-value>30</param-value>
       </init-param>
     </filter>

#### Configuring DoS Filter Parameters

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. Default is 25.
delayMs

  Delay imposed on all requests over the rate limit, before they are considered at all:

  - 100 (ms) = Default
  - -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. Default is 50 ms.
throttledRequests
  Number of requests over the rate limit able to be considered at once. Default is 5.
throttleMs
  Length of time, in ms, to async wait for semaphore. Default is 30000L.
maxRequestMs
  Length of time, in ms, to allow the request to run. Default is 30000L.
maxIdleTrackerMs
  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. Default is 30000L.
insertHeaders
  If true, insert the DoSFilter headers into the response. Defaults to true.
trackSessions
  If true, usage rate is tracked by session if a session exists. Defaults to true.
remotePort
  If true and session tracking is not used, then rate is tracked by IP and port (effectively connection). Defaults to false.
ipWhitelist
  A comma-separated list of IP addresses that will not be rate limited.
managedAttr
  If set to true, then this servlet is set as a ServletContext attribute with the filter name as the attribute name. This allows a context external mechanism (for example, JMX via `ContextHandler.MANAGED_ATTRIBUTES`) to manage the configuration of the filter.

Previous | Top | Next
Quality of Service Filter | Home | Header Filter

See an error or something missing? Contribute to this documentation at Github!(Generated: 2020-02-27)