EnableReactiveMethodSecurity

Spring Security 使用 Reactor 的上下文 来支持方法安全性，该上下文由 ReactiveSecurityContextHolder 设置。以下示例展示了如何检索当前登录用户的邮件

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

使用 AuthorizationManager 启用 EnableReactiveMethodSecurity

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

这在多个方面改进了 @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)));
}

自定义授权

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

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

自定义 MethodSecurityExpressionHandler

  • 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）。

自定义授权管理器

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

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

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

完整的前后方法安全配置

  • 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 构建的。因此，拦截器会根据指定的顺序进行调用。可以通过对拦截器实例调用 setOrder 来对其进行自定义，如下所示

发布自定义顾问

  • Java

@Bean
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
Advisor postFilterAuthorizationMethodInterceptor() {
	PostFilterAuthorizationMethodInterceptor interceptor = new PostFilterAuthorizationReactiveMethodInterceptor();
	interceptor.setOrder(AuthorizationInterceptorOrders.POST_AUTHORIZE.getOrder() - 1);
	return interceptor;
}

你可能只想在你的应用程序中支持 @PreAuthorize，在这种情况下，你可以执行以下操作

仅 @PreAuthorize 配置

  • Java

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

	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	Advisor preAuthorize() {
		return AuthorizationManagerBeforeMethodInterceptor.preAuthorize();
	}
}

或者，你可能有一个自定义的 before-method ReactiveAuthorizationManager，你想将其添加到列表中。

在这种情况下，你需要告诉 Spring Security ReactiveAuthorizationManager 和你的授权管理器适用的方法和类。

因此，你可以配置 Spring Security 在 @PreAuthorize 和 @PostAuthorize 之间调用你的 ReactiveAuthorizationManager，如下所示

自定义 Before 顾问

  • Java

@EnableReactiveMethodSecurity(useAuthorizationManager=true)
class MethodSecurityConfig {
	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	public Advisor customAuthorize() {
		JdkRegexpMethodPointcut pattern = new JdkRegexpMethodPointcut();
		pattern.setPattern("org.mycompany.myapp.service.*");
		ReactiveAuthorizationManager<MethodInvocation> rule = AuthorityAuthorizationManager.isAuthenticated();
		AuthorizationManagerBeforeReactiveMethodInterceptor interceptor = new AuthorizationManagerBeforeReactiveMethodInterceptor(pattern, rule);
		interceptor.setOrder(AuthorizationInterceptorsOrder.PRE_AUTHORIZE_ADVISOR_ORDER.getOrder() + 1);
		return interceptor;
    }
}

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

对于 after-method 授权，也可以执行相同操作。after-method 授权通常涉及分析返回值以验证访问权限。

例如，你可能有一个方法来确认请求的帐户实际上属于已登录用户，如下所示

@PostAuthorize 示例

  • Java

public interface BankService {

	@PreAuthorize("hasRole('USER')")
	@PostAuthorize("returnObject.owner == authentication.name")
	Mono<Account> readAccount(Long id);
}

你可以提供你自己的 AuthorizationMethodInterceptor 来自定义如何评估对返回值的访问权限。

例如，如果你有自己的自定义注解，则可以对其进行如下配置

自定义 After 顾问

  • Java

@EnableReactiveMethodSecurity(useAuthorizationManager=true)
class MethodSecurityConfig {
	@Bean
	@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
	public Advisor customAuthorize(ReactiveAuthorizationManager<MethodInvocationResult> rules) {
		AnnotationMethodMatcher pattern = new AnnotationMethodMatcher(MySecurityAnnotation.class);
		AuthorizationManagerAfterReactiveMethodInterceptor interceptor = new AuthorizationManagerAfterReactiveMethodInterceptor(pattern, rules);
		interceptor.setOrder(AuthorizationInterceptorsOrder.POST_AUTHORIZE_ADVISOR_ORDER.getOrder() + 1);
		return interceptor;
	}
}

它将在 @PostAuthorize 拦截器之后被调用。

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 集成时，Spring Security 会根据经过身份验证的用户自动建立 Reactor 上下文

  • 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 中找到一个完整的示例。