Skip to content

Add reified function variants to security DSL #8771

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

Merged
merged 1 commit into from
Jul 1, 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,32 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
this.http.addFilterAt(filter, atFilter)
}

/**
* Adds the [Filter] at the location of the specified [Filter] class.
* Variant that is leveraging Kotlin reified type parameters.
*
* Example:
*
* ```
* @EnableWebSecurity
* class SecurityConfig : WebSecurityConfigurerAdapter() {
*
* override fun configure(http: HttpSecurity) {
* http {
* addFilterAt<UsernamePasswordAuthenticationFilter>(CustomFilter())
* }
* }
* }
* ```
*
* @param filter the [Filter] to register
* @param T the location of another [Filter] that is already registered
* (i.e. known) with Spring Security.
*/
inline fun <reified T: Filter> addFilterAt(filter: Filter) {
this.addFilterAt(filter, T::class.java)
}

/**
* Adds the [Filter] after the location of the specified [Filter] class.
*
Expand All @@ -694,6 +720,32 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
this.http.addFilterAfter(filter, afterFilter)
}

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

/**
* Adds the [Filter] before the location of the specified [Filter] class.
*
Expand All @@ -719,6 +771,32 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
this.http.addFilterBefore(filter, beforeFilter)
}

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

/**
* Apply all configurations to the provided [HttpSecurity]
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,18 @@ class UserInfoEndpointDsl {
customUserTypePair = Pair(customUserType, clientRegistrationId)
}

/**
* Sets a custom [OAuth2User] type and associates it to the provided
* client [ClientRegistration.getRegistrationId] registration identifier.
* Variant that is leveraging Kotlin reified type parameters.
*
* @param T a custom [OAuth2User] type
* @param clientRegistrationId the client registration identifier
*/
inline fun <reified T: OAuth2User> customUserType(clientRegistrationId: String) {
customUserType(T::class.java, clientRegistrationId)
}

internal fun get(): (OAuth2LoginConfigurer<HttpSecurity>.UserInfoEndpointConfig) -> Unit {
return { userInfoEndpoint ->
userService?.also { userInfoEndpoint.userService(userService) }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,27 @@ class HttpSecurityDslTests {
}
}

@Test
fun `HTTP security when custom filter configured with reified variant then custom filter added to filter chain`() {
this.spring.register(CustomFilterConfigReified::class.java).autowire()

val filterChain = spring.context.getBean(FilterChainProxy::class.java)
val filters: List<Filter> = filterChain.getFilters("/")

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

@EnableWebSecurity
@EnableWebMvc
open class CustomFilterConfigReified : WebSecurityConfigurerAdapter(true) {
override fun configure(http: HttpSecurity) {
http {
addFilterAt<UsernamePasswordAuthenticationFilter>(CustomFilter())
}
}
}

@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()
Expand All @@ -262,6 +283,30 @@ class HttpSecurityDslTests {
}
}

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

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

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

@EnableWebSecurity
@EnableWebMvc
open class CustomFilterAfterConfigReified : WebSecurityConfigurerAdapter() {
override fun configure(http: HttpSecurity) {
http {
addFilterAfter<UsernamePasswordAuthenticationFilter>(CustomFilter())
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()
Expand All @@ -286,5 +331,29 @@ class HttpSecurityDslTests {
}
}

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

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

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

@EnableWebSecurity
@EnableWebMvc
open class CustomFilterBeforeConfigReified : WebSecurityConfigurerAdapter() {
override fun configure(http: HttpSecurity) {
http {
addFilterBefore<UsernamePasswordAuthenticationFilter>(CustomFilter())
formLogin { }
}
}
}

class CustomFilter : UsernamePasswordAuthenticationFilter()
}