-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Add authorizeHttpRequests to Kotlin DSL #10895
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
253 changes: 253 additions & 0 deletions
253
...ain/kotlin/org/springframework/security/config/annotation/web/AuthorizeHttpRequestsDsl.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,253 @@ | ||
| /* | ||
| * Copyright 2002-2022 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.security.config.annotation.web | ||
|
|
||
| import org.springframework.http.HttpMethod | ||
| import org.springframework.security.authorization.AuthenticatedAuthorizationManager | ||
| import org.springframework.security.authorization.AuthorityAuthorizationManager | ||
| import org.springframework.security.authorization.AuthorizationDecision | ||
| import org.springframework.security.authorization.AuthorizationManager | ||
| import org.springframework.security.config.annotation.web.builders.HttpSecurity | ||
| import org.springframework.security.config.annotation.web.configurers.AuthorizeHttpRequestsConfigurer | ||
| import org.springframework.security.core.Authentication | ||
| import org.springframework.security.web.access.intercept.RequestAuthorizationContext | ||
| import org.springframework.security.web.util.matcher.AnyRequestMatcher | ||
| import org.springframework.security.web.util.matcher.RequestMatcher | ||
| import org.springframework.util.ClassUtils | ||
| import java.util.function.Supplier | ||
|
|
||
| /** | ||
| * A Kotlin DSL to configure [HttpSecurity] request authorization using idiomatic Kotlin code. | ||
| * | ||
| * @author Yuriy Savchenko | ||
| * @since 5.7 | ||
| */ | ||
| class AuthorizeHttpRequestsDsl : AbstractRequestMatcherDsl() { | ||
| private val authorizationRules = mutableListOf<AuthorizationManagerRule>() | ||
|
|
||
| private val HANDLER_MAPPING_INTROSPECTOR = "org.springframework.web.servlet.handler.HandlerMappingIntrospector" | ||
| private val MVC_PRESENT = ClassUtils.isPresent( | ||
| HANDLER_MAPPING_INTROSPECTOR, | ||
| AuthorizeHttpRequestsDsl::class.java.classLoader) | ||
| private val PATTERN_TYPE = if (MVC_PRESENT) PatternType.MVC else PatternType.ANT | ||
|
|
||
| /** | ||
| * Adds a request authorization rule. | ||
| * | ||
| * @param matches the [RequestMatcher] to match incoming requests against | ||
| * @param access the [AuthorizationManager] to secure the matching request | ||
| * (i.e. created via hasAuthority("ROLE_USER")) | ||
| */ | ||
| fun authorize(matches: RequestMatcher = AnyRequestMatcher.INSTANCE, | ||
| access: AuthorizationManager<RequestAuthorizationContext>) { | ||
| authorizationRules.add(MatcherAuthorizationManagerRule(matches, access)) | ||
| } | ||
|
|
||
| /** | ||
| * Adds a request authorization rule for an endpoint matching the provided | ||
| * pattern. | ||
| * If Spring MVC is on the classpath, it will use an MVC matcher. | ||
| * If Spring MVC is not on the classpath, it will use an ant matcher. | ||
| * The MVC will use the same rules that Spring MVC uses for matching. | ||
| * For example, often times a mapping of the path "/path" will match on | ||
| * "/path", "/path/", "/path.html", etc. | ||
| * If the current request will not be processed by Spring MVC, a reasonable default | ||
| * using the pattern as an ant pattern will be used. | ||
| * | ||
| * @param pattern the pattern to match incoming requests against. | ||
| * @param access the [AuthorizationManager] to secure the matching request | ||
| * (i.e. created via hasAuthority("ROLE_USER")) | ||
| */ | ||
| fun authorize(pattern: String, | ||
| access: AuthorizationManager<RequestAuthorizationContext>) { | ||
| authorizationRules.add( | ||
| PatternAuthorizationManagerRule( | ||
| pattern = pattern, | ||
| patternType = PATTERN_TYPE, | ||
| rule = access | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Adds a request authorization rule for an endpoint matching the provided | ||
| * pattern. | ||
| * If Spring MVC is on the classpath, it will use an MVC matcher. | ||
| * If Spring MVC is not on the classpath, it will use an ant matcher. | ||
| * The MVC will use the same rules that Spring MVC uses for matching. | ||
| * For example, often times a mapping of the path "/path" will match on | ||
| * "/path", "/path/", "/path.html", etc. | ||
| * If the current request will not be processed by Spring MVC, a reasonable default | ||
| * using the pattern as an ant pattern will be used. | ||
| * | ||
| * @param method the HTTP method to match the income requests against. | ||
| * @param pattern the pattern to match incoming requests against. | ||
| * @param access the [AuthorizationManager] to secure the matching request | ||
| * (i.e. created via hasAuthority("ROLE_USER")) | ||
| */ | ||
| fun authorize(method: HttpMethod, | ||
| pattern: String, | ||
| access: AuthorizationManager<RequestAuthorizationContext>) { | ||
| authorizationRules.add( | ||
| PatternAuthorizationManagerRule( | ||
| pattern = pattern, | ||
| patternType = PATTERN_TYPE, | ||
| httpMethod = method, | ||
| rule = access | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Adds a request authorization rule for an endpoint matching the provided | ||
| * pattern. | ||
| * If Spring MVC is on the classpath, it will use an MVC matcher. | ||
| * If Spring MVC is not on the classpath, it will use an ant matcher. | ||
| * The MVC will use the same rules that Spring MVC uses for matching. | ||
| * For example, often times a mapping of the path "/path" will match on | ||
| * "/path", "/path/", "/path.html", etc. | ||
| * If the current request will not be processed by Spring MVC, a reasonable default | ||
| * using the pattern as an ant pattern will be used. | ||
| * | ||
| * @param pattern the pattern to match incoming requests against. | ||
| * @param servletPath the servlet path to match incoming requests against. This | ||
| * only applies when using an MVC pattern matcher. | ||
| * @param access the [AuthorizationManager] to secure the matching request | ||
| * (i.e. created via hasAuthority("ROLE_USER")) | ||
| */ | ||
| fun authorize(pattern: String, | ||
| servletPath: String, | ||
| access: AuthorizationManager<RequestAuthorizationContext>) { | ||
| authorizationRules.add( | ||
| PatternAuthorizationManagerRule( | ||
| pattern = pattern, | ||
| patternType = PATTERN_TYPE, | ||
| servletPath = servletPath, | ||
| rule = access | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Adds a request authorization rule for an endpoint matching the provided | ||
| * pattern. | ||
| * If Spring MVC is on the classpath, it will use an MVC matcher. | ||
| * If Spring MVC is not on the classpath, it will use an ant matcher. | ||
| * The MVC will use the same rules that Spring MVC uses for matching. | ||
| * For example, often times a mapping of the path "/path" will match on | ||
| * "/path", "/path/", "/path.html", etc. | ||
| * If the current request will not be processed by Spring MVC, a reasonable default | ||
| * using the pattern as an ant pattern will be used. | ||
| * | ||
| * @param method the HTTP method to match the income requests against. | ||
| * @param pattern the pattern to match incoming requests against. | ||
| * @param servletPath the servlet path to match incoming requests against. This | ||
| * only applies when using an MVC pattern matcher. | ||
| * @param access the [AuthorizationManager] to secure the matching request | ||
| * (i.e. created via hasAuthority("ROLE_USER")) | ||
| */ | ||
| fun authorize(method: HttpMethod, | ||
| pattern: String, | ||
| servletPath: String, | ||
| access: AuthorizationManager<RequestAuthorizationContext>) { | ||
| authorizationRules.add( | ||
| PatternAuthorizationManagerRule( | ||
| pattern = pattern, | ||
| patternType = PATTERN_TYPE, | ||
| servletPath = servletPath, | ||
| httpMethod = method, | ||
| rule = access | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Specify that URLs require a particular authority. | ||
| * | ||
| * @param authority the authority to require (i.e. ROLE_USER, ROLE_ADMIN, etc). | ||
| * @return the [AuthorizationManager] with the provided authority | ||
| */ | ||
| fun hasAuthority(authority: String): AuthorizationManager<RequestAuthorizationContext> { | ||
| return AuthorityAuthorizationManager.hasAuthority(authority) | ||
| } | ||
|
|
||
| /** | ||
| * Specify that URLs require any of the provided authorities. | ||
| * | ||
| * @param authorities the authorities to require (i.e. ROLE_USER, ROLE_ADMIN, etc). | ||
| * @return the [AuthorizationManager] with the provided authorities | ||
| */ | ||
| fun hasAnyAuthority(vararg authorities: String): AuthorizationManager<RequestAuthorizationContext> { | ||
| return AuthorityAuthorizationManager.hasAnyAuthority(*authorities) | ||
| } | ||
|
|
||
| /** | ||
| * Specify that URLs require a particular role. | ||
| * | ||
| * @param role the role to require (i.e. USER, ADMIN, etc). | ||
| * @return the [AuthorizationManager] with the provided role | ||
| */ | ||
| fun hasRole(role: String): AuthorizationManager<RequestAuthorizationContext> { | ||
| return AuthorityAuthorizationManager.hasRole(role) | ||
| } | ||
|
|
||
| /** | ||
| * Specify that URLs require any of the provided roles. | ||
| * | ||
| * @param roles the roles to require (i.e. USER, ADMIN, etc). | ||
| * @return the [AuthorizationManager] with the provided roles | ||
| */ | ||
| fun hasAnyRole(vararg roles: String): AuthorizationManager<RequestAuthorizationContext> { | ||
| return AuthorityAuthorizationManager.hasAnyRole(*roles) | ||
| } | ||
|
|
||
| /** | ||
| * Specify that URLs are allowed by anyone. | ||
| */ | ||
| val permitAll: AuthorizationManager<RequestAuthorizationContext> = | ||
| AuthorizationManager { _: Supplier<Authentication>, _: RequestAuthorizationContext -> AuthorizationDecision(true) } | ||
|
|
||
| /** | ||
| * Specify that URLs are not allowed by anyone. | ||
| */ | ||
| val denyAll: AuthorizationManager<RequestAuthorizationContext> = | ||
| AuthorizationManager { _: Supplier<Authentication>, _: RequestAuthorizationContext -> AuthorizationDecision(false) } | ||
|
|
||
| /** | ||
| * Specify that URLs are allowed by any authenticated user. | ||
| */ | ||
| val authenticated: AuthorizationManager<RequestAuthorizationContext> = | ||
| AuthenticatedAuthorizationManager.authenticated() | ||
|
|
||
| internal fun get(): (AuthorizeHttpRequestsConfigurer<HttpSecurity>.AuthorizationManagerRequestMatcherRegistry) -> Unit { | ||
| return { requests -> | ||
| authorizationRules.forEach { rule -> | ||
| when (rule) { | ||
| is MatcherAuthorizationManagerRule -> requests.requestMatchers(rule.matcher).access(rule.rule) | ||
| is PatternAuthorizationManagerRule -> { | ||
| when (rule.patternType) { | ||
| PatternType.ANT -> requests.antMatchers(rule.httpMethod, rule.pattern).access(rule.rule) | ||
| PatternType.MVC -> requests.mvcMatchers(rule.httpMethod, rule.pattern) | ||
| .apply { if (rule.servletPath != null) servletPath(rule.servletPath) } | ||
| .access(rule.rule) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.