Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add addFilterAfter and addFilterBefore to Kotlin DSL #8319

Merged
merged 2 commits into from
Apr 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,56 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
this.http.addFilterAt(filter, atFilter)
}

/**
* Adds the [Filter] after the location of the specified [Filter] class.
*
* Example:
*
* ```
* @EnableWebSecurity
* class SecurityConfig : WebSecurityConfigurerAdapter() {
*
* override fun configure(http: HttpSecurity) {
* http {
* addFilterAfter(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* }
* }
* ```
*
* @param filter the [Filter] to register
* @param afterFilter the location of another [Filter] that is already registered
* (i.e. known) with Spring Security.
*/
fun addFilterAfter(filter: Filter, afterFilter: Class<out Filter>) {
this.http.addFilterAfter(filter, afterFilter)
}

/**
* Adds the [Filter] before the location of the specified [Filter] class.
*
* Example:
*
* ```
* @EnableWebSecurity
* class SecurityConfig : WebSecurityConfigurerAdapter() {
*
* override fun configure(http: HttpSecurity) {
* http {
* addFilterBefore(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* }
* }
* ```
*
* @param filter the [Filter] to register
* @param beforeFilter the location of another [Filter] that is already registered
* (i.e. known) with Spring Security.
*/
fun addFilterBefore(filter: Filter, beforeFilter: Class<out Filter>) {
this.http.addFilterBefore(filter, beforeFilter)
}

/**
* Apply all configurations to the provided [HttpSecurity]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ class HttpSecurityDslTests {
val filters: List<Filter> = filterChain.getFilters("/")

assertThat(filters).hasSize(1)
assertThat(filters[0]).isExactlyInstanceOf(CustomFilterConfig.CustomFilter::class.java)
assertThat(filters[0]).isExactlyInstanceOf(CustomFilter::class.java)
}

@EnableWebSecurity
Expand All @@ -236,7 +236,55 @@ class HttpSecurityDslTests {
addFilterAt(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
}
}
}

@Test
fun `HTTP security when custom filter configured then custom filter added after specific filter to filter chain`() {
this.spring.register(CustomFilterAfterConfig::class.java).autowire()

val filterChain = spring.context.getBean(FilterChainProxy::class.java)
val filters: List<Class<out Filter>> = filterChain.getFilters("/").map { it.javaClass }

assertThat(filters).containsSubsequence(
UsernamePasswordAuthenticationFilter::class.java,
CustomFilter::class.java
)
}

@EnableWebSecurity
@EnableWebMvc
open class CustomFilterAfterConfig : WebSecurityConfigurerAdapter() {
override fun configure(http: HttpSecurity) {
http {
addFilterAfter(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
formLogin {}
}
}
}

@Test
fun `HTTP security when custom filter configured then custom filter added before specific filter to filter chain`() {
this.spring.register(CustomFilterBeforeConfig::class.java).autowire()

val filterChain = spring.context.getBean(FilterChainProxy::class.java)
val filters: List<Class<out Filter>> = filterChain.getFilters("/").map { it.javaClass }

assertThat(filters).containsSubsequence(
CustomFilter::class.java,
UsernamePasswordAuthenticationFilter::class.java
)
}

class CustomFilter : UsernamePasswordAuthenticationFilter()
@EnableWebSecurity
@EnableWebMvc
open class CustomFilterBeforeConfig : WebSecurityConfigurerAdapter() {
override fun configure(http: HttpSecurity) {
http {
addFilterBefore(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
formLogin {}
}
}
}

class CustomFilter : UsernamePasswordAuthenticationFilter()
}