Class FilterChainProxy
- All Implemented Interfaces:
jakarta.servlet.Filter
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanNameAware
,org.springframework.beans.factory.DisposableBean
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.EnvironmentAware
,org.springframework.core.env.EnvironmentCapable
,org.springframework.web.context.ServletContextAware
Filter
requests to a list of Spring-managed filter beans. As of
version 2.0, you shouldn't need to explicitly configure a FilterChainProxy
bean
in your application context unless you need very fine control over the filter chain
contents. Most cases should be adequately covered by the default
<security:http />
namespace configuration options.
The FilterChainProxy
is linked into the servlet container filter chain by
adding a standard Spring DelegatingFilterProxy
declaration in the application
web.xml
file.
Configuration
As of version 3.1, FilterChainProxy
is configured using a list of
SecurityFilterChain
instances, each of which contains a RequestMatcher
and a list of filters which should be applied to matching requests. Most applications
will only contain a single filter chain, and if you are using the namespace, you don't
have to set the chains explicitly. If you require finer-grained control, you can make
use of the <filter-chain>
namespace element. This defines a URI pattern and the
list of filters (as comma-separated bean names) which should be applied to requests
which match the pattern. An example configuration might look like this:
<bean id="myfilterChainProxy" class="org.springframework.security.web.FilterChainProxy"> <constructor-arg> <util:list> <security:filter-chain pattern="/do/not/filter*" filters="none"/> <security:filter-chain pattern="/**" filters="filter1,filter2,filter3"/> </util:list> </constructor-arg> </bean>The names "filter1", "filter2", "filter3" should be the bean names of
Filter
instances defined in the application context. The order of the names defines the order
in which the filters will be applied. As shown above, use of the value "none" for the
"filters" can be used to exclude a request pattern from the security filter chain
entirely. Please consult the security namespace schema file for a full list of
available configuration options.
Request Handling
Each possible pattern that the FilterChainProxy
should service must be entered.
The first match for a given request will be used to define all of the Filter
s
that apply to that request. This means you must put most specific matches at the top of
the list, and ensure all Filter
s that should apply for a given matcher are
entered against the respective entry. The FilterChainProxy
will not iterate
through the remainder of the map entries to locate additional Filter
s.
FilterChainProxy
respects normal handling of Filter
s that elect not to
call
Filter.doFilter(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse, jakarta.servlet.FilterChain)
, in that the remainder of the original or FilterChainProxy
-declared filter
chain will not be called.
Request Firewalling
AnHttpFirewall
instance is used to validate incoming requests and create a
wrapped request which provides consistent path values for matching against. See
StrictHttpFirewall
, for more information on the type of attacks which the
default implementation protects against. A custom implementation can be injected to
provide stricter control over the request contents or if an application needs to
support certain types of request which are rejected by default.
Note that this means that you must use the Spring Security filters in combination with
a FilterChainProxy
if you want this protection. Don't define them explicitly in
your web.xml
file.
FilterChainProxy
will use the firewall instance to obtain both request and
response objects which will be fed down the filter chain, so it is also possible to use
this functionality to control the functionality of the response. When the request has
passed through the security filter chain, the reset
method will be called. With
the default implementation this means that the original values of servletPath
and pathInfo
will be returned thereafter, instead of the modified ones used for
security pattern matching.
Since this additional wrapping functionality is performed by the
FilterChainProxy
, we don't recommend that you use multiple instances in the
same filter chain. It shouldn't be considered purely as a utility for wrapping filter
beans in a single Filter
instance.
Filter Lifecycle
Note the Filter
lifecycle mismatch between the servlet container and IoC
container. As described in the DelegatingFilterProxy
Javadocs, we recommend you
allow the IoC container to manage the lifecycle instead of the servlet container.
FilterChainProxy
does not invoke the standard filter lifecycle methods on any
filter beans that you add to the application context.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
A strategy for decorating the provided filter chain with one that accounts for theSecurityFilterChain
for a given request.static interface
static final class
AFilterChainProxy.FilterChainDecorator
that uses theFilterChainProxy.VirtualFilterChain
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
doFilter
(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) List<jakarta.servlet.Filter>
getFilters
(String url) Convenience method, mainly for testing.void
setFilterChainDecorator
(FilterChainProxy.FilterChainDecorator filterChainDecorator) Used to decorate the originalFilterChain
for each requestvoid
setFilterChainValidator
(FilterChainProxy.FilterChainValidator filterChainValidator) Used (internally) to specify a validation strategy for the filters in each configured chain.void
setFirewall
(HttpFirewall firewall) Sets the "firewall" implementation which will be used to validate and wrap (or potentially reject) the incoming requests.void
setRequestRejectedHandler
(RequestRejectedHandler requestRejectedHandler) Sets theRequestRejectedHandler
to be used for requests rejected by the firewall.void
setSecurityContextHolderStrategy
(SecurityContextHolderStrategy securityContextHolderStrategy) Sets theSecurityContextHolderStrategy
to use.toString()
Methods inherited from class org.springframework.web.filter.GenericFilterBean
addRequiredProperty, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext
-
Constructor Details
-
FilterChainProxy
public FilterChainProxy() -
FilterChainProxy
-
FilterChainProxy
-
-
Method Details
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Overrides:
afterPropertiesSet
in classorg.springframework.web.filter.GenericFilterBean
-
doFilter
public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException - Throws:
IOException
jakarta.servlet.ServletException
-
getFilters
Convenience method, mainly for testing.- Parameters:
url
- the URL- Returns:
- matching filter list
-
getFilterChains
- Returns:
- the list of
SecurityFilterChain
s which will be matched against and applied to incoming requests.
-
setSecurityContextHolderStrategy
public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy) Sets theSecurityContextHolderStrategy
to use. The default action is to use theSecurityContextHolderStrategy
stored inSecurityContextHolder
.- Since:
- 5.8
-
setFilterChainValidator
Used (internally) to specify a validation strategy for the filters in each configured chain.- Parameters:
filterChainValidator
- the validator instance which will be invoked on during initialization to check theFilterChainProxy
instance.
-
setFilterChainDecorator
Used to decorate the originalFilterChain
for each requestBy default, this decorates the filter chain with a
FilterChainProxy.VirtualFilterChain
that iterates through security filters and then delegates to the original chain- Parameters:
filterChainDecorator
- the strategy for constructing the filter chain- Since:
- 6.0
-
setFirewall
Sets the "firewall" implementation which will be used to validate and wrap (or potentially reject) the incoming requests. The default implementation should be satisfactory for most requirements.- Parameters:
firewall
-
-
setRequestRejectedHandler
Sets theRequestRejectedHandler
to be used for requests rejected by the firewall.- Parameters:
requestRejectedHandler
- theRequestRejectedHandler
- Since:
- 5.2
-
toString
-