public class CsrfPreventionFilter extends FilterBase
HttpServletResponse.encodeRedirectURL(String)
and
HttpServletResponse.encodeURL(String)
are used to encode all URLs
returned to the client
Modifier and Type | Class and Description |
---|---|
protected static class |
CsrfPreventionFilter.CsrfResponseWrapper |
sm
Constructor and Description |
---|
CsrfPreventionFilter() |
Modifier and Type | Method and Description |
---|---|
void |
doFilter(javax.servlet.ServletRequest request,
javax.servlet.ServletResponse response,
javax.servlet.FilterChain chain)
The
doFilter method of the Filter is called by the container
each time a request/response pair is passed through the chain due
to a client request for a resource at the end of the chain. |
protected java.lang.String |
generateNonce()
Generate a once time token (nonce) for authenticating subsequent
requests.
|
protected Log |
getLogger() |
void |
init(javax.servlet.FilterConfig filterConfig)
Called by the web container to indicate to a filter that it is being placed into
service.
|
void |
setEntryPoints(java.lang.String entryPoints)
Entry points are URLs that will not be tested for the presence of a valid
nonce.
|
void |
setNonceCacheSize(int nonceCacheSize)
Sets the number of previously issued nonces that will be cached on a LRU
basis to support parallel requests, limited use of the refresh and back
in the browser and similar behaviors that may result in the submission
of a previous nonce rather than the current one.
|
void |
setRandomClass(java.lang.String randomClass)
Specify the class to use to generate the nonces.
|
destroy
protected Log getLogger()
getLogger
in class FilterBase
public void setEntryPoints(java.lang.String entryPoints)
entryPoints
- Comma separated list of URLs to be configured as
entry points.public void setNonceCacheSize(int nonceCacheSize)
nonceCacheSize
- The number of nonces to cachepublic void setRandomClass(java.lang.String randomClass)
Random
.randomClass
- The name of the class to usepublic void init(javax.servlet.FilterConfig filterConfig) throws javax.servlet.ServletException
javax.servlet.Filter
init
in interface javax.servlet.Filter
init
in class FilterBase
javax.servlet.ServletException
public void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) throws java.io.IOException, javax.servlet.ServletException
javax.servlet.Filter
doFilter
method of the Filter is called by the container
each time a request/response pair is passed through the chain due
to a client request for a resource at the end of the chain. The FilterChain passed in to this
method allows the Filter to pass on the request and response to the next entity in the
chain.
A typical implementation of this method would follow the following pattern:-
1. Examine the request
2. Optionally wrap the request object with a custom implementation to
filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to
filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()
),
4. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.
java.io.IOException
javax.servlet.ServletException
protected java.lang.String generateNonce()
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.