EnableReactiveMethodSecurity

Spring Security 通过使用 Reactor 的 Context 来支持方法安全，该 Context 由 ReactiveSecurityContextHolder 设置。以下示例展示了如何检索当前登录用户的消息

要使此示例工作，方法的返回类型必须是 org.reactivestreams.Publisher（即 Mono 或 Flux）。这是与 Reactor Context 集成所必需的。

EnableReactiveMethodSecurity 与 AuthorizationManager

在 Spring Security 5.8 中，我们可以通过在任何 @Configuration 实例上使用 @EnableReactiveMethodSecurity(useAuthorizationManager=true) 注解来启用基于注解的安全性。

这在许多方面改进了 @EnableReactiveMethodSecurity。@EnableReactiveMethodSecurity(useAuthorizationManager=true)

  1. 使用简化的 AuthorizationManager API，而不是元数据源、配置属性、决策管理器和投票器。这简化了重用和定制。

  2. 支持响应式返回类型，包括 Kotlin 协程。

  3. 使用原生 Spring AOP 构建，消除了抽象，允许您使用 Spring AOP 构建块进行定制

  4. 检查冲突的注解，以确保安全配置明确无歧义

  5. 符合 JSR-250

对于早期版本，请阅读有关 @EnableReactiveMethodSecurity 的类似支持。

例如，以下将启用 Spring Security 的 @PreAuthorize 注解

方法安全配置

  • Java

@EnableReactiveMethodSecurity(useAuthorizationManager=true)
public class MethodSecurityConfig {
	// ...
}

然后，将注解添加到方法（在类或接口上）会相应地限制对该方法的访问。Spring Security 的原生注解支持为方法定义了一组属性。这些属性将被传递给各种方法拦截器，例如 AuthorizationManagerBeforeReactiveMethodInterceptor，以便它做出实际决策

方法安全注解用法

  • Java

public interface BankService {
	@PreAuthorize("hasRole('USER')")
	Mono<Account> readAccount(Long id);

	@PreAuthorize("hasRole('USER')")
	Flux<Account> findAccounts();

	@PreAuthorize("@func.apply(#account)")
	Mono<Account> post(Account account, Double amount);
}

在这种情况下，hasRole 指的是 SecurityExpressionRoot 中由 SpEL 求值引擎调用的方法。

@bean 指的是您自定义定义的组件，其中 apply 可以返回 Boolean 或 Mono<Boolean> 来指示授权决策。这样的 bean 可能看起来像这样

方法安全响应式布尔表达式

  • Java

@Bean
public Function<Account, Mono<Boolean>> func() {
    return (account) -> Mono.defer(() -> Mono.just(account.getId().equals(12)));
}

方法授权是方法前授权和方法后授权的组合。

方法前授权在方法调用之前执行。如果该授权拒绝访问，则不调用该方法，并抛出 AccessDeniedException。方法后授权在方法调用之后、但在方法返回给调用者之前执行。如果该授权拒绝访问，则不返回该值，并抛出 AccessDeniedException

要重现添加 @EnableReactiveMethodSecurity(useAuthorizationManager=true) 默认执行的操作，您可以发布以下配置

完整的 Pre-post 方法安全配置

  • Java

@Configuration
class MethodSecurityConfig {
	@Bean
	BeanDefinitionRegistryPostProcessor aopConfig() {
		return AopConfigUtils::registerAutoProxyCreatorIfNecessary;
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	PreFilterAuthorizationReactiveMethodInterceptor preFilterInterceptor() {
		return new PreFilterAuthorizationReactiveMethodInterceptor();
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	AuthorizationManagerBeforeReactiveMethodInterceptor preAuthorizeInterceptor() {
		return AuthorizationManagerBeforeReactiveMethodInterceptor.preAuthorize();
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	AuthorizationManagerAfterReactiveMethodInterceptor postAuthorizeInterceptor() {
		return AuthorizationManagerAfterReactiveMethodInterceptor.postAuthorize();
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	PostFilterAuthorizationReactiveMethodInterceptor postFilterInterceptor() {
		return new PostFilterAuthorizationReactiveMethodInterceptor();
	}
}

请注意，Spring Security 的方法安全是使用 Spring AOP 构建的。

定制授权

Spring Security 的 @PreAuthorize、@PostAuthorize、@PreFilter 和 @PostFilter 带有丰富的基于表达式的支持。

此外，对于基于角色的授权，Spring Security 会添加默认的 ROLE_ 前缀，在评估像 hasRole 这样的表达式时使用它。您可以通过暴露 GrantedAuthorityDefaults bean 来配置授权规则使用不同的前缀，如下所示

自定义 GrantedAuthorityDefaults

  • Java

@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
static GrantedAuthorityDefaults grantedAuthorityDefaults() {
	return new GrantedAuthorityDefaults("MYPREFIX_");
}

我们使用 static 方法暴露 GrantedAuthorityDefaults，以确保 Spring 在初始化 Spring Security 的方法安全 @Configuration 类之前发布它。由于 GrantedAuthorityDefaults bean 是 Spring Security 内部工作的一部分，我们还应该将其暴露为基础设施 bean，从而有效地避免一些与 bean 后处理相关的警告（参见 gh-14751）。

以编程方式授权方法

如您所见，有几种方法可以使用方法安全 SpEL 表达式指定非平凡的授权规则。

有多种方法可以使您的逻辑基于 Java 而不是 SpEL。这使您可以使用整个 Java 语言来提高可测试性和控制流。

在 SpEL 中使用自定义 Bean

以编程方式授权方法的第一种方法是一个两步过程。

首先，声明一个具有接受 MethodSecurityExpressionOperations 实例的方法的 bean，如下所示

  • Java

  • Kotlin

@Component("authz")
public class AuthorizationLogic {
    public decide(MethodSecurityExpressionOperations operations): Mono<Boolean> {
        // ... authorization logic
    }
}
@Component("authz")
open class AuthorizationLogic {
    fun decide(val operations: MethodSecurityExpressionOperations): Mono<Boolean> {
        // ... authorization logic
    }
}

然后，以以下方式在您的注解中引用该 bean

  • Java

  • Kotlin

@Controller
public class MyController {
    @PreAuthorize("@authz.decide(#root)")
    @GetMapping("/endpoint")
    public Mono<String> endpoint() {
        // ...
    }
}
@Controller
open class MyController {
    @PreAuthorize("@authz.decide(#root)")
    @GetMapping("/endpoint")
    fun endpoint(): Mono<String> {
        // ...
    }
}

对于每次方法调用，Spring Security 都将调用该 bean 上的给定方法。

这样做的好处是所有授权逻辑都在一个单独的类中，可以独立进行单元测试和正确性验证。它还可以访问完整的 Java 语言。

除了返回 Mono<Boolean> 外，您还可以返回 Mono.empty() 以表明代码放弃做出决定。

如果您想包含更多关于决策性质的信息，您可以返回一个自定义的 AuthorizationDecision，如下所示

  • Java

  • Kotlin

@Component("authz")
public class AuthorizationLogic {
    public Mono<AuthorizationDecision> decide(MethodSecurityExpressionOperations operations) {
        // ... authorization logic
        return Mono.just(new MyAuthorizationDecision(false, details));
    }
}
@Component("authz")
open class AuthorizationLogic {
    fun decide(val operations: MethodSecurityExpressionOperations): Mono<AuthorizationDecision> {
        // ... authorization logic
        return Mono.just(MyAuthorizationDecision(false, details))
    }
}

或者抛出一个自定义的 AuthorizationDeniedException 实例。但请注意，首选返回一个对象，因为这不会产生生成堆栈跟踪的开销。

然后，当您定制如何处理授权结果时，可以访问自定义详细信息。

使用自定义 Authorization Manager

以编程方式授权方法的第二种方法是创建一个自定义的 AuthorizationManager。

首先，声明一个授权管理器实例，可能像这样

  • Java

  • Kotlin

@Component
public class MyPreAuthorizeAuthorizationManager implements ReactiveAuthorizationManager<MethodInvocation> {
    @Override
    public Mono<AuthorizationDecision> check(Supplier<Authentication> authentication, MethodInvocation invocation) {
        // ... authorization logic
    }

}
@Component
class MyPreAuthorizeAuthorizationManager : ReactiveAuthorizationManager<MethodInvocation> {
    override fun check(authentication: Supplier<Authentication>, invocation: MethodInvocation): Mono<AuthorizationDecision> {
        // ... authorization logic
    }

}

然后，使用与您希望该 ReactiveAuthorizationManager 运行的时间相对应的切入点发布方法拦截器。例如，您可以像这样替换 @PreAuthorize 和 @PostAuthorize 的工作方式

仅 @PreAuthorize 和 @PostAuthorize 配置

  • Java

  • Kotlin

@Configuration
@EnableMethodSecurity(prePostEnabled = false)
class MethodSecurityConfig {
    @Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	Advisor preAuthorize(MyPreAuthorizeAuthorizationManager manager) {
		return AuthorizationManagerBeforeReactiveMethodInterceptor.preAuthorize(manager);
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	Advisor postAuthorize(MyPostAuthorizeAuthorizationManager manager) {
		return AuthorizationManagerAfterReactiveMethodInterceptor.postAuthorize(manager);
	}
}
@Configuration
@EnableMethodSecurity(prePostEnabled = false)
class MethodSecurityConfig {
   	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	fun preAuthorize(val manager: MyPreAuthorizeAuthorizationManager) : Advisor {
		return AuthorizationManagerBeforeReactiveMethodInterceptor.preAuthorize(manager)
	}

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	fun postAuthorize(val manager: MyPostAuthorizeAuthorizationManager) : Advisor {
		return AuthorizationManagerAfterReactiveMethodInterceptor.postAuthorize(manager)
	}
}

您可以使用 AuthorizationInterceptorsOrder 中指定的顺序常量将您的拦截器放置在 Spring Security 方法拦截器之间。

定制表达式处理

或者，第三种方法是定制每个 SpEL 表达式的处理方式。为此，您可以暴露一个自定义的 MethodSecurityExpressionHandler，如下所示

自定义 MethodSecurityExpressionHandler

  • Java

  • Kotlin

@Bean
static MethodSecurityExpressionHandler methodSecurityExpressionHandler(RoleHierarchy roleHierarchy) {
	DefaultMethodSecurityExpressionHandler handler = new DefaultMethodSecurityExpressionHandler();
	handler.setRoleHierarchy(roleHierarchy);
	return handler;
}
companion object {
	@Bean
	fun methodSecurityExpressionHandler(val roleHierarchy: RoleHierarchy) : MethodSecurityExpressionHandler {
		val handler = DefaultMethodSecurityExpressionHandler()
		handler.setRoleHierarchy(roleHierarchy)
		return handler
	}
}

我们使用 static 方法暴露 MethodSecurityExpressionHandler，以确保 Spring 在初始化 Spring Security 的方法安全 @Configuration 类之前发布它

您还可以继承DefaultMessageSecurityExpressionHandler 以添加您自己的自定义授权表达式，而不是使用默认表达式。

EnableReactiveMethodSecurity

  • Java

  • Kotlin

Authentication authentication = new TestingAuthenticationToken("user", "password", "ROLE_USER");

Mono<String> messageByUsername = ReactiveSecurityContextHolder.getContext()
	.map(SecurityContext::getAuthentication)
	.map(Authentication::getName)
	.flatMap(this::findMessageByUsername)
	// In a WebFlux application the `subscriberContext` is automatically setup using `ReactorContextWebFilter`
	.contextWrite(ReactiveSecurityContextHolder.withAuthentication(authentication));

StepVerifier.create(messageByUsername)
	.expectNext("Hi user")
	.verifyComplete();
val authentication: Authentication = TestingAuthenticationToken("user", "password", "ROLE_USER")

val messageByUsername: Mono<String> = ReactiveSecurityContextHolder.getContext()
	.map(SecurityContext::getAuthentication)
	.map(Authentication::getName)
	.flatMap(this::findMessageByUsername) // In a WebFlux application the `subscriberContext` is automatically setup using `ReactorContextWebFilter`
	.contextWrite(ReactiveSecurityContextHolder.withAuthentication(authentication))

StepVerifier.create(messageByUsername)
	.expectNext("Hi user")
	.verifyComplete()

其中 this::findMessageByUsername 定义为

  • Java

  • Kotlin

Mono<String> findMessageByUsername(String username) {
	return Mono.just("Hi " + username);
}
fun findMessageByUsername(username: String): Mono<String> {
	return Mono.just("Hi $username")
}

以下最小方法安全配置在响应式应用中配置了方法安全

  • Java

  • Kotlin

@Configuration
@EnableReactiveMethodSecurity
public class SecurityConfig {
	@Bean
	public MapReactiveUserDetailsService userDetailsService() {
		User.UserBuilder userBuilder = User.withDefaultPasswordEncoder();
		UserDetails rob = userBuilder.username("rob")
			.password("rob")
			.roles("USER")
			.build();
		UserDetails admin = userBuilder.username("admin")
			.password("admin")
			.roles("USER","ADMIN")
			.build();
		return new MapReactiveUserDetailsService(rob, admin);
	}
}
@Configuration
@EnableReactiveMethodSecurity
class SecurityConfig {
	@Bean
	fun userDetailsService(): MapReactiveUserDetailsService {
		val userBuilder: User.UserBuilder = User.withDefaultPasswordEncoder()
		val rob = userBuilder.username("rob")
			.password("rob")
			.roles("USER")
			.build()
		val admin = userBuilder.username("admin")
			.password("admin")
			.roles("USER", "ADMIN")
			.build()
		return MapReactiveUserDetailsService(rob, admin)
	}
}

考虑以下类

  • Java

  • Kotlin

@Component
public class HelloWorldMessageService {
	@PreAuthorize("hasRole('ADMIN')")
	public Mono<String> findMessage() {
		return Mono.just("Hello World!");
	}
}
@Component
class HelloWorldMessageService {
	@PreAuthorize("hasRole('ADMIN')")
	fun findMessage(): Mono<String> {
		return Mono.just("Hello World!")
	}
}

或者，以下类使用 Kotlin 协程

  • Kotlin

@Component
class HelloWorldMessageService {
    @PreAuthorize("hasRole('ADMIN')")
    suspend fun findMessage(): String {
        delay(10)
        return "Hello World!"
    }
}

结合上面的配置，@PreAuthorize("hasRole('ADMIN')") 确保 findByMessage 仅由具有 ADMIN 角色的用户调用。请注意，标准方法安全中的任何表达式都适用于 @EnableReactiveMethodSecurity。但是，目前我们只支持表达式的返回类型为 Boolean 或 boolean。这意味着表达式不能阻塞。

与WebFlux Security 集成时，Reactor Context 会根据认证用户由 Spring Security 自动建立

  • Java

  • Kotlin

@Configuration
@EnableWebFluxSecurity
@EnableReactiveMethodSecurity
public class SecurityConfig {

	@Bean
	SecurityWebFilterChain springWebFilterChain(ServerHttpSecurity http) throws Exception {
		return http
			// Demonstrate that method security works
			// Best practice to use both for defense in depth
			.authorizeExchange(exchanges -> exchanges
				.anyExchange().permitAll()
			)
			.httpBasic(withDefaults())
			.build();
	}

	@Bean
	MapReactiveUserDetailsService userDetailsService() {
		User.UserBuilder userBuilder = User.withDefaultPasswordEncoder();
		UserDetails rob = userBuilder.username("rob")
			.password("rob")
			.roles("USER")
			.build();
		UserDetails admin = userBuilder.username("admin")
			.password("admin")
			.roles("USER","ADMIN")
			.build();
		return new MapReactiveUserDetailsService(rob, admin);
	}
}
@Configuration
@EnableWebFluxSecurity
@EnableReactiveMethodSecurity
class SecurityConfig {
	@Bean
	open fun springWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		return http {
			authorizeExchange {
				authorize(anyExchange, permitAll)
			}
			httpBasic { }
		}
	}

	@Bean
	fun userDetailsService(): MapReactiveUserDetailsService {
		val userBuilder: User.UserBuilder = User.withDefaultPasswordEncoder()
		val rob = userBuilder.username("rob")
			.password("rob")
			.roles("USER")
			.build()
		val admin = userBuilder.username("admin")
			.password("admin")
			.roles("USER", "ADMIN")
			.build()
		return MapReactiveUserDetailsService(rob, admin)
	}
}

您可以在 hellowebflux-method 中找到一个完整的示例。