[jira] [Updated] (SHIRO-792) ShiroWebFilterConfiguration seems to conflict with other FilterRegistrationBean

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[jira] [Updated] (SHIRO-792) ShiroWebFilterConfiguration seems to conflict with other FilterRegistrationBean

Benjamin Marwell (Jira)

     [ https://issues.apache.org/jira/browse/SHIRO-792?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Brian Demers updated SHIRO-792:
    Fix Version/s:     (was: 1.6.1)

> ShiroWebFilterConfiguration seems to conflict with other FilterRegistrationBean
> -------------------------------------------------------------------------------
>                 Key: SHIRO-792
>                 URL: https://issues.apache.org/jira/browse/SHIRO-792
>             Project: Shiro
>          Issue Type: Bug
>          Components: Integration: Spring
>    Affects Versions: 1.6.0
>            Reporter: Ricardo Mendes
>            Assignee: Francois Papon
>            Priority: Major
>             Fix For: 2.0.0, 1.7.0
>          Time Spent: 3h
>  Remaining Estimate: 0h
> I'm using {{shiro-spring-boot-web-starter 1.6.0}} within a web application developed with {{Spring Boot v2.3.2.RELEASE}}.
> When I add one or more filters to the application using {{@Bean}}/{{FilterRegistrationBean}} (example below), the Shiro filter is not properly loaded anymore, and all requests that depend on {{SecurityUtils}} to be fulfilled start to fail.
> {code:java}
> @Bean
> public FilterRegistrationBean<LogoutFilter> logoutFilter() {
>   final FilterRegistrationBean<LogoutFilter> registrationBean = new FilterRegistrationBean<>();
>   registrationBean.addUrlPatterns("/security/logout");
>   registrationBean.setFilter(new LogoutFilter());
>   registrationBean.setName("logoutFilter");
>   return registrationBean;
> }
> {code}
> I ran some tests to figure out what's going on and it turns out the {{@ConditionalOnMissingBean}} used to annotate {{filterShiroFilterRegistrationBean()}} [here|https://github.com/apache/shiro/blob/shiro-root-1.6.0/support/spring-boot/spring-boot-web-starter/src/main/java/org/apache/shiro/spring/config/web/autoconfigure/ShiroWebFilterConfiguration.java#L48] seems to be the culprit: the condition evaluates to false when there are more {{FilterRegistrationBean}}'s annotated with {{@ConditionalOnMissingBean}} in the application, so the method is not called, and hence the Shiro filter is not loaded.
> As a workaround, I've added the below configuration to override the standard one and now everything works fine:
> {code:java}
> @Configuration
> public class ShiroWebFilterConfig extends AbstractShiroWebFilterConfiguration {    
>   @Bean
>   protected FilterRegistrationBean<AbstractShiroFilter> shiroFilter() throws Exception {
>     final FilterRegistrationBean<AbstractShiroFilter> registrationBean = new FilterRegistrationBean<>();
>     registrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.FORWARD, DispatcherType.INCLUDE, DispatcherType.ERROR);
>     registrationBean.setFilter((AbstractShiroFilter) shiroFilterFactoryBean().getObject());
>     registrationBean.setOrder(1);
>     return registrationBean;
>   }
> }
> {code}
> Maybe it's worth adding a {{name}} or {{type}} element to {{@ConditionalOnMissingBean}} in order to provide a more robust solution. Makes sense?
> Kind regards, Ricardo.

This message was sent by Atlassian Jira