org.eclipse.jetty.servlets

Class DoSFilter

java.lang.Object

org.eclipse.jetty.servlets.DoSFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

CloseableDoSFilter

@ManagedObject(value="limits exposure to abuse from request flooding, whether malicious, or as a result of a misconfigured client")
public class DoSFilter
extends Object
implements Filter

Denial of Service filter

This filter is useful for limiting exposure to abuse from 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 a limit is exceeded, the request is either rejected, delayed, or throttled.

When a request is throttled, it is placed in a priority queue. Priority is given first to authenticated users and users with an HttpSession, then connections which can be identified by their IP addresses. Connections with no way to identify them are given lowest priority.

The extractUserId(ServletRequest request) function should be implemented, in order to uniquely identify authenticated users.

The following init parameters control the behavior of the filter:

maxRequestsPerSec

the maximum number of requests from a connection per second. Requests in excess of this are first delayed, then throttled.

delayMs

is the delay given to all requests over the rate limit, before they are considered at all. -1 means just reject request, 0 means no delay, otherwise it is the delay.

maxWaitMs

how long to blocking wait for the throttle semaphore.

throttledRequests

is the number of requests over the rate limit able to be considered at once.

throttleMs

how long to async wait for semaphore.

maxRequestMs

how long to allow this request to run.

maxIdleTrackerMs

how long to keep track of request rates for a connection, before deciding that the user has gone away, and discarding it

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+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 context external mechanism (eg JMX via ContextHandler.MANAGED_ATTRIBUTES) to manage the configuration of the filter.

This filter should be configured for DispatcherType.REQUEST and DispatcherType.ASYNC and with <async-supported>true</async-supported>.

Constructor Summary

Constructors

Constructor and Description
DoSFilter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addWhitelistAddress(String address) Adds the given IP address, either in the form of a dotted decimal notation A.B.C.D or in the CIDR notation A.B.C.D/M, to the list of whitelisted IP addresses.
protected boolean	checkWhitelist(List<String> whitelist, String candidate)
void	clearWhitelist() Clears the list of whitelisted IP addresses
protected void	closeConnection(HttpServletRequest request, HttpServletResponse response, Thread thread) Takes drastic measures to return this response and stop this thread.
void	destroy()
protected void	doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
void	doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
protected void	doFilterChain(FilterChain chain, HttpServletRequest request, HttpServletResponse response)
protected String	extractUserId(ServletRequest request) Returns the user id, used to track this connection.
long	getDelayMs() Get delay (in milliseconds) that is applied to all requests over the rate limit, before they are considered at all.
long	getMaxIdleTrackerMs() Get maximum amount of time (in milliseconds) to keep track of request rates for a connection, before deciding that the user has gone away, and discarding it.
protected int	getMaxPriority()
long	getMaxRequestMs() Get maximum amount of time (in milliseconds) to allow the request to process.
int	getMaxRequestsPerSec() Get maximum number of requests from a connection per second.
long	getMaxWaitMs() Get maximum amount of time (in milliseconds) the filter will blocking wait for the throttle semaphore.
protected int	getPriority(HttpServletRequest request, org.eclipse.jetty.servlets.DoSFilter.RateTracker tracker) Get priority for this request, based on user type
org.eclipse.jetty.servlets.DoSFilter.RateTracker	getRateTracker(ServletRequest request) Return a request rate tracker associated with this connection; keeps track of this connection's request rate.
int	getThrottledRequests() Get number of requests over the rate limit able to be considered at once.
long	getThrottleMs() Get amount of time (in milliseconds) to async wait for semaphore.
String	getWhitelist() Get a list of IP addresses that will not be rate limited.
void	init(FilterConfig filterConfig)
boolean	isEnabled()
boolean	isInsertHeaders() Check flag to insert the DoSFilter headers into the response.
boolean	isRemotePort() Get flag to have usage rate tracked by IP+port (effectively connection) if session tracking is not used.
boolean	isTrackSessions() Get flag to have usage rate tracked by session if a session exists.
boolean	removeWhitelistAddress(String address) Removes the given address from the list of whitelisted IP addresses.
void	setDelayMs(long value) Set delay (in milliseconds) that is applied to all requests over the rate limit, before they are considered at all.
void	setEnabled(boolean enabled)
void	setInsertHeaders(boolean value) Set flag to insert the DoSFilter headers into the response.
void	setMaxIdleTrackerMs(long value) Set maximum amount of time (in milliseconds) to keep track of request rates for a connection, before deciding that the user has gone away, and discarding it.
void	setMaxRequestMs(long value) Set maximum amount of time (in milliseconds) to allow the request to process.
void	setMaxRequestsPerSec(int value) Get maximum number of requests from a connection per second.
void	setMaxWaitMs(long value) Set maximum amount of time (in milliseconds) the filter will blocking wait for the throttle semaphore.
void	setRemotePort(boolean value) Set flag to have usage rate tracked by IP+port (effectively connection) if session tracking is not used.
void	setThrottledRequests(int value) Set number of requests over the rate limit able to be considered at once.
void	setThrottleMs(long value) Set amount of time (in milliseconds) to async wait for semaphore.
void	setTrackSessions(boolean value) Set flag to have usage rate tracked by session if a session exists.
void	setWhitelist(String value) Set a list of IP addresses that will not be rate limited.
protected Scheduler	startScheduler()
protected void	stopScheduler()
protected boolean	subnetMatch(String subnetAddress, String address)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DoSFilter

public DoSFilter()

Method Detail

init

public void init(FilterConfig filterConfig)
          throws ServletException

Specified by:

init in interface Filter

Throws:

ServletException

startScheduler

protected Scheduler startScheduler()
                            throws ServletException

Throws:

ServletException

doFilter

public void doFilter(ServletRequest request,
            ServletResponse response,
            FilterChain filterChain)
              throws IOException,
                     ServletException

Specified by:

doFilter in interface Filter

Throws:

IOException

ServletException

doFilter

protected void doFilter(HttpServletRequest request,
            HttpServletResponse response,
            FilterChain filterChain)
                 throws IOException,
                        ServletException

Throws:

IOException

ServletException

doFilterChain

protected void doFilterChain(FilterChain chain,
                 HttpServletRequest request,
                 HttpServletResponse response)
                      throws IOException,
                             ServletException

Throws:

IOException

ServletException

closeConnection

protected void closeConnection(HttpServletRequest request,
                   HttpServletResponse response,
                   Thread thread)

Takes drastic measures to return this response and stop this thread. Due to the way the connection is interrupted, may return mixed up headers.

Parameters:

request - current request

response - current response, which must be stopped

thread - the handling thread

getPriority

protected int getPriority(HttpServletRequest request,
              org.eclipse.jetty.servlets.DoSFilter.RateTracker tracker)

Get priority for this request, based on user type

Parameters:

request - the current request

tracker - the rate tracker for this request

Returns:

the priority for this request

getMaxPriority

protected int getMaxPriority()

Returns:

the maximum priority that we can assign to a request

getRateTracker

public org.eclipse.jetty.servlets.DoSFilter.RateTracker getRateTracker(ServletRequest request)

Return a request rate tracker associated with this connection; keeps track of this connection's request rate. If this is not the first request from this connection, return the existing object with the stored stats. If it is the first request, then create a new request tracker.

Assumes that each connection has an identifying characteristic, and goes through them in order, taking the first that matches: user id (logged in), session id, client IP address. Unidentifiable connections are lumped into one.

When a session expires, its rate tracker is automatically deleted.

Parameters:

request - the current request

Returns:

the request rate tracker for the current connection

checkWhitelist

protected boolean checkWhitelist(List<String> whitelist,
                     String candidate)

subnetMatch

protected boolean subnetMatch(String subnetAddress,
                  String address)

destroy

public void destroy()

Specified by:

destroy in interface Filter

stopScheduler

protected void stopScheduler()

extractUserId

protected String extractUserId(ServletRequest request)

Returns the user id, used to track this connection. This SHOULD be overridden by subclasses.

Parameters:

request - the current request

Returns:

a unique user id, if logged in; otherwise null.

getMaxRequestsPerSec

@ManagedAttribute(value="maximum number of requests allowed from a connection per second")
public int getMaxRequestsPerSec()

Get maximum number of requests from a connection per second. Requests in excess of this are first delayed, then throttled.

Returns:

maximum number of requests

setMaxRequestsPerSec

public void setMaxRequestsPerSec(int value)

Get maximum number of requests from a connection per second. Requests in excess of this are first delayed, then throttled.

Parameters:

value - maximum number of requests

getDelayMs

@ManagedAttribute(value="delay applied to all requests over the rate limit (in ms)")
public long getDelayMs()

Get delay (in milliseconds) that is applied to all requests over the rate limit, before they are considered at all.

setDelayMs

public void setDelayMs(long value)

Set delay (in milliseconds) that is applied to all requests over the rate limit, before they are considered at all.

Parameters:

value - delay (in milliseconds), 0 - no delay, -1 - reject request

getMaxWaitMs

@ManagedAttribute(value="maximum time the filter will block waiting throttled connections, (0 for no delay, -1 to reject requests)")
public long getMaxWaitMs()

Get maximum amount of time (in milliseconds) the filter will blocking wait for the throttle semaphore.

Returns:

maximum wait time

setMaxWaitMs

public void setMaxWaitMs(long value)

Set maximum amount of time (in milliseconds) the filter will blocking wait for the throttle semaphore.

Parameters:

value - maximum wait time

getThrottledRequests

@ManagedAttribute(value="number of requests over rate limit")
public int getThrottledRequests()

Get number of requests over the rate limit able to be considered at once.

Returns:

number of requests

setThrottledRequests

public void setThrottledRequests(int value)

Set number of requests over the rate limit able to be considered at once.

Parameters:

value - number of requests

getThrottleMs

@ManagedAttribute(value="amount of time to async wait for semaphore")
public long getThrottleMs()

Get amount of time (in milliseconds) to async wait for semaphore.

Returns:

wait time

setThrottleMs

public void setThrottleMs(long value)

Set amount of time (in milliseconds) to async wait for semaphore.

Parameters:

value - wait time

getMaxRequestMs

@ManagedAttribute(value="maximum time to allow requests to process (in ms)")
public long getMaxRequestMs()

Get maximum amount of time (in milliseconds) to allow the request to process.

Returns:

maximum processing time

setMaxRequestMs

public void setMaxRequestMs(long value)

Set maximum amount of time (in milliseconds) to allow the request to process.

Parameters:

value - maximum processing time

getMaxIdleTrackerMs

@ManagedAttribute(value="maximum time to track of request rates for connection before discarding")
public long getMaxIdleTrackerMs()

Get maximum amount of time (in milliseconds) to keep track of request rates for a connection, before deciding that the user has gone away, and discarding it.

Returns:

maximum tracking time

setMaxIdleTrackerMs

public void setMaxIdleTrackerMs(long value)

Set maximum amount of time (in milliseconds) to keep track of request rates for a connection, before deciding that the user has gone away, and discarding it.

Parameters:

value - maximum tracking time

isInsertHeaders

@ManagedAttribute(value="inser DoSFilter headers in response")
public boolean isInsertHeaders()

Check flag to insert the DoSFilter headers into the response.

Returns:

value of the flag

setInsertHeaders

public void setInsertHeaders(boolean value)

Set flag to insert the DoSFilter headers into the response.

Parameters:

value - value of the flag

isTrackSessions

@ManagedAttribute(value="usage rate is tracked by session if one exists")
public boolean isTrackSessions()

Get flag to have usage rate tracked by session if a session exists.

Returns:

value of the flag

setTrackSessions

public void setTrackSessions(boolean value)

Set flag to have usage rate tracked by session if a session exists.

Parameters:

value - value of the flag

isRemotePort

@ManagedAttribute(value="usage rate is tracked by IP+port is session tracking not used")
public boolean isRemotePort()

Get flag to have usage rate tracked by IP+port (effectively connection) if session tracking is not used.

Returns:

value of the flag

setRemotePort

public void setRemotePort(boolean value)

Set flag to have usage rate tracked by IP+port (effectively connection) if session tracking is not used.

Parameters:

value - value of the flag

isEnabled

@ManagedAttribute(value="whether this filter is enabled")
public boolean isEnabled()

Returns:

whether this filter is enabled

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - whether this filter is enabled

getWhitelist

@ManagedAttribute(value="list of IPs that will not be rate limited")
public String getWhitelist()

Get a list of IP addresses that will not be rate limited.

Returns:

comma-separated whitelist

setWhitelist

public void setWhitelist(String value)

Set a list of IP addresses that will not be rate limited.

Parameters:

value - comma-separated whitelist

clearWhitelist

@ManagedOperation(value="clears the list of IP addresses that will not be rate limited")
public void clearWhitelist()

Clears the list of whitelisted IP addresses

addWhitelistAddress

@ManagedOperation(value="adds an IP address that will not be rate limited")
public boolean addWhitelistAddress(@Name(value="address")
                                                String address)

Adds the given IP address, either in the form of a dotted decimal notation A.B.C.D or in the CIDR notation A.B.C.D/M, to the list of whitelisted IP addresses.

Parameters:

address - the address to add

Returns:

whether the address was added to the list

See Also:

removeWhitelistAddress(String)

removeWhitelistAddress

@ManagedOperation(value="removes an IP address that will not be rate limited")
public boolean removeWhitelistAddress(@Name(value="address")
                                                   String address)

Removes the given address from the list of whitelisted IP addresses.

Parameters:

address - the address to remove

Returns:

whether the address was removed from the list

See Also:

addWhitelistAddress(String)