此版本仍在开发中，尚未被视为稳定版本。如需最新稳定版本，请使用 Spring Security 7.0.4！spring-doc.cadn.net.cn

OAuth2 WebFlux

Spring Security 提供了全面的 OAuth 2.0 支持。 本节讨论如何将 OAuth 2.0 集成到你的响应式应用中。spring-doc.cadn.net.cn

概述

Spring Security 的 OAuth 2.0 支持包括两个主要的功能集：spring-doc.cadn.net.cn

OAuth2 登录 是一个非常强大的 OAuth2 客户端功能，在参考文档中值得拥有自己独立的一节。 然而，它并非一个独立的功能，需要依赖 OAuth2 客户端才能正常运行。spring-doc.cadn.net.cn

这些功能集涵盖了在OAuth 2.0授权框架中定义的资源服务器和客户端角色，而授权服务器角色则由独立项目Spring Authorization Server覆盖，该项目基于Spring Security构建。spring-doc.cadn.net.cn

The 资源服务器和客户端在OAuth2中的角色通常由一个或多个后端应用程序表示。 此外，授权服务器的角色可以由一个或多个第三方代表（例如，在组织内部集中身份管理和/或认证的情况下）-或者-它可以由一个应用程序代表（如Spring Authorization Server所实现的那样）。spring-doc.cadn.net.cn

例如，一个典型的基于 OAuth2 的微服务架构可能包含一个面向用户的客户端应用程序、多个提供 REST API 的后端资源服务器，以及一个用于管理用户和处理身份验证事宜的第三方授权服务器。 通常也会出现这样的情况：单个应用程序仅承担上述角色之一，而需要与一个或多个提供其他角色的第三方进行集成。spring-doc.cadn.net.cn

Spring Security 能处理这些场景及更多情况。 以下章节介绍了 Spring Security 提供的角色，并包含常见场景的示例。spring-doc.cadn.net.cn

OAuth2 资源服务器

本节包含 OAuth2 资源服务器功能的概要及示例。 完整的参考文档请参见OAuth 2.0 资源服务器。spring-doc.cadn.net.cn

首先，将 spring-security-oauth2-resource-server 依赖项添加到您的项目中。 当使用 Spring Boot 时，请添加以下 starter：spring-doc.cadn.net.cn

使用 Spring Boot 的 OAuth2 客户端
implementation 'org.springframework.boot:spring-boot-starter-oauth2-resource-server'
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
</dependency>

有关在不使用 Spring Boot 时的其他选项，请参见获取 Spring Security。spring-doc.cadn.net.cn

考虑以下 OAuth2 资源服务器的使用场景：spring-doc.cadn.net.cn

使用 OAuth2 访问Tokens保护访问

使用 OAuth2 访问Tokens来保护 API 的访问是非常常见的。 在大多数情况下，Spring Security 只需要极少的配置即可使用 OAuth2 保护应用程序。spring-doc.cadn.net.cn

Spring Security 支持两种类型的 Bearer Tokens，每种Tokens使用不同的组件进行验证：spring-doc.cadn.net.cn

JWT 支持

以下示例使用 Spring Boot 配置属性来配置一个 ReactiveJwtDecoder Bean：spring-doc.cadn.net.cn

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          issuer-uri: https://my-auth-server.com

使用 Spring Boot 时，仅需上述配置即可。 Spring Boot 提供的默认配置等同于以下内容：spring-doc.cadn.net.cn

使用 JWT 配置资源服务器
@Configuration
@EnableWebFluxSecurity
public class SecurityConfig {

	@Bean
	public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
		http
			.authorizeExchange((authorize) -> authorize
				.anyExchange().authenticated()
			)
			.oauth2ResourceServer((oauth2) -> oauth2
				.jwt(Customizer.withDefaults())
			);
		return http.build();
	}

	@Bean
	public ReactiveJwtDecoder jwtDecoder() {
		return ReactiveJwtDecoders.fromIssuerLocation("https://my-auth-server.com");
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
@EnableWebFluxSecurity
class SecurityConfig {

	@Bean
	fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		return http {
			authorizeExchange {
				authorize(anyExchange, authenticated)
			}
			oauth2ResourceServer {
				jwt { }
			}
		}
	}

	@Bean
	fun jwtDecoder(): ReactiveJwtDecoder {
		return ReactiveJwtDecoders.fromIssuerLocation("https://my-auth-server.com")
	}

}

非透明Tokens支持

以下示例使用 Spring Boot 配置属性来配置一个 ReactiveOpaqueTokenIntrospector Bean：spring-doc.cadn.net.cn

spring:
  security:
    oauth2:
      resourceserver:
        opaquetoken:
          introspection-uri: https://my-auth-server.com/oauth2/introspect
          client-id: my-client-id
          client-secret: my-client-secret

使用 Spring Boot 时，仅需上述配置即可。 Spring Boot 提供的默认配置等同于以下内容：spring-doc.cadn.net.cn

使用不透明Tokens配置资源服务器
@Configuration
@EnableWebFluxSecurity
public class SecurityConfig {

	@Bean
	public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
		http
			.authorizeExchange((authorize) -> authorize
				.anyExchange().authenticated()
			)
			.oauth2ResourceServer((oauth2) -> oauth2
				.opaqueToken(Customizer.withDefaults())
			);
		return http.build();
	}

	@Bean
	public ReactiveOpaqueTokenIntrospector opaqueTokenIntrospector() {
		return new SpringReactiveOpaqueTokenIntrospector(
			"https://my-auth-server.com/oauth2/introspect", "my-client-id", "my-client-secret");
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
@EnableWebFluxSecurity
class SecurityConfig {

	@Bean
	fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		return http {
			authorizeExchange {
				authorize(anyExchange, authenticated)
			}
			oauth2ResourceServer {
				opaqueToken { }
			}
		}
	}

	@Bean
	fun opaqueTokenIntrospector(): ReactiveOpaqueTokenIntrospector {
		return SpringReactiveOpaqueTokenIntrospector(
			"https://my-auth-server.com/oauth2/introspect", "my-client-id", "my-client-secret"
		)
	}

}

使用自定义 JWT 保护访问安全

使用 JWT 来保护 API 访问是一种相当常见的目标，尤其是在前端以单页应用程序（SPA）形式开发时。 Spring Security 中的 OAuth2 资源服务器支持可用于任何类型的 Bearer Tokens，包括自定义的 JWT。spring-doc.cadn.net.cn

使用JWT保护API所需的一切是一个ReactiveJwtDecoder Bean，该Bean用于验证签名和解码Tokens。 Spring Security会自动使用提供的Bean在SecurityWebFilterChain中配置保护。spring-doc.cadn.net.cn

以下示例使用 Spring Boot 配置属性来配置一个 ReactiveJwtDecoder Bean：spring-doc.cadn.net.cn

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          public-key-location: classpath:my-public-key.pub

您可以将公钥作为类路径资源提供（在此示例中名为 my-public-key.pub）。spring-doc.cadn.net.cn

使用 Spring Boot 时，仅需上述配置即可。 Spring Boot 提供的默认配置等同于以下内容：spring-doc.cadn.net.cn

使用自定义 JWT 配置资源服务器
@Configuration
@EnableWebFluxSecurity
public class SecurityConfig {

	@Bean
	public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
		http
			.authorizeExchange((authorize) -> authorize
				.anyExchange().authenticated()
			)
			.oauth2ResourceServer((oauth2) -> oauth2
				.jwt(Customizer.withDefaults())
			);
		return http.build();
	}

	@Bean
	public ReactiveJwtDecoder jwtDecoder() {
		return NimbusReactiveJwtDecoder.withPublicKey(publicKey()).build();
	}

	private RSAPublicKey publicKey() {
		// ...
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
@EnableWebFluxSecurity
class SecurityConfig {

	@Bean
	fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		return http {
			authorizeExchange {
				authorize(anyExchange, authenticated)
			}
			oauth2ResourceServer {
				jwt { }
			}
		}
	}

	@Bean
	fun jwtDecoder(): ReactiveJwtDecoder {
		return NimbusReactiveJwtDecoder.withPublicKey(publicKey()).build()
	}

	private fun publicKey(): RSAPublicKey {
		// ...
	}

}

Spring Security 不提供用于生成Tokens的端点。 然而，Spring Security 确实提供了 JwtEncoder 接口以及一个实现类，即 NimbusJwtEncoder。spring-doc.cadn.net.cn

OAuth2 客户端

本节包含 OAuth2 客户端功能的概述及示例。 完整的参考文档请参见 OAuth 2.0 客户端 和 OAuth 2.0 登录。spring-doc.cadn.net.cn

首先，将 spring-security-oauth2-client 依赖项添加到您的项目中。 当使用 Spring Boot 时，请添加以下 starter：spring-doc.cadn.net.cn

使用 Spring Boot 的 OAuth2 客户端
implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>

有关在不使用 Spring Boot 时的其他选项，请参见获取 Spring Security。spring-doc.cadn.net.cn

请考虑以下 OAuth2 客户端的使用场景：spring-doc.cadn.net.cn

使用 OAuth2 登录用户

通常需要用户通过 OAuth2 进行登录。 OpenID Connect 1.0 提供了一种特殊的Tokens，称为 id_token，其设计目的是让 OAuth2 客户端能够验证用户身份并实现用户登录。 在某些情况下，OAuth2 可直接用于用户登录（例如 GitHub 和 Facebook 等流行的社交登录提供商，它们并未实现 OpenID Connect）。spring-doc.cadn.net.cn

以下示例配置应用程序作为 OAuth2 客户端，能够使用 OAuth2 或 OpenID Connect 对用户进行登录：spring-doc.cadn.net.cn

配置 OAuth2 登录
@Configuration
@EnableWebFluxSecurity
public class SecurityConfig {

	@Bean
	public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
		http
			// ...
			.oauth2Login(Customizer.withDefaults());
		return http.build();
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
@EnableWebFluxSecurity
class SecurityConfig {

	@Bean
	fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		return http {
			// ...
			oauth2Login { }
		}
	}

}

除了上述配置外，应用程序需要通过ClientRegistration Bean 配置至少一个 ReactiveClientRegistrationRepository。 以下示例使用 Spring Boot 配置属性来配置一个 InMemoryReactiveClientRegistrationRepository Bean:spring-doc.cadn.net.cn

spring:
  security:
    oauth2:
      client:
        registration:
          my-oidc-client:
            provider: my-oidc-provider
            client-id: my-client-id
            client-secret: my-client-secret
            authorization-grant-type: authorization_code
            scope: openid,profile
        provider:
          my-oidc-provider:
            issuer-uri: https://my-oidc-provider.com

通过上述配置，应用程序现在支持两个额外的端点：spring-doc.cadn.net.cn

  1. 登录端点（例如 /oauth2/authorization/my-oidc-client）用于启动登录流程，并重定向到第三方授权服务器。spring-doc.cadn.net.cn

  2. 重定向端点（例如 /login/oauth2/code/my-oidc-client）由授权服务器用于重定向回客户端应用程序，其中将包含一个 code 参数，该参数用于通过访问Tokens请求获取 id_token 和/或 access_token。spring-doc.cadn.net.cn

上述配置中包含 openid 范围表明应使用 OpenID Connect 1.0。 这会指示 Spring Security 在请求处理过程中使用 OIDC 特定的组件（例如 OidcReactiveOAuth2UserService）。 如果没有此范围，Spring Security 将改用 OAuth2 特定的组件（例如 DefaultReactiveOAuth2UserService）。spring-doc.cadn.net.cn

访问受保护的资源

向受 OAuth2 保护的第三方 API 发起请求是 OAuth2 客户端的核心使用场景。 这通过授权一个客户端（在 Spring Security 中由 OAuth2AuthorizedClient 类表示）来实现，并在出站请求的 Bearer 头中放置一个 Authorization Tokens，以访问受保护的资源。spring-doc.cadn.net.cn

以下示例将应用程序配置为充当 OAuth2 客户端，能够向第三方 API 请求受保护的资源：spring-doc.cadn.net.cn

配置 OAuth2 客户端
@Configuration
@EnableWebFluxSecurity
public class SecurityConfig {

	@Bean
	public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
		http
			// ...
			.oauth2Client(Customizer.withDefaults());
		return http.build();
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
@EnableWebFluxSecurity
class SecurityConfig {

	@Bean
	fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		return http {
			// ...
			oauth2Client { }
		}
	}

}

上述示例未提供用户登录的方式。 您可以使用任何其他登录机制（例如 formLogin()）。 有关将 #oauth2-client-access-protected-resources-current-user 与 oauth2Client() 结合使用的示例，请参见下一节。spring-doc.cadn.net.cn

除了上述配置外，应用程序需要通过ClientRegistration Bean 配置至少一个 ReactiveClientRegistrationRepository。 以下示例使用 Spring Boot 配置属性来配置一个 InMemoryReactiveClientRegistrationRepository Bean:spring-doc.cadn.net.cn

spring:
  security:
    oauth2:
      client:
        registration:
          my-oauth2-client:
            provider: my-auth-server
            client-id: my-client-id
            client-secret: my-client-secret
            authorization-grant-type: authorization_code
            scope: message.read,message.write
        provider:
          my-auth-server:
            issuer-uri: https://my-auth-server.com

除了配置 Spring Security 以支持 OAuth2 Client 特性外，您还需要决定如何访问受保护的资源，并相应地进行配置。 Spring Security 提供了获取访问Tokens的 ReactiveOAuth2AuthorizedClientManager 的实现，这些访问Tokens可以用来访问受保护的资源。spring-doc.cadn.net.cn

Spring Security 会为你注册一个默认的 ReactiveOAuth2AuthorizedClientManager Bean，如果不存在的话。spring-doc.cadn.net.cn

使用ReactiveOAuth2AuthorizedClientManager的最简单方法是通过ExchangeFilterFunction中的WebClient来拦截请求。spring-doc.cadn.net.cn

以下示例使用默认的 ReactiveOAuth2AuthorizedClientManager 来配置一个 WebClient，该客户端能够通过在每个请求的 Bearer 头中放置 Authorization Tokens来访问受保护的资源：spring-doc.cadn.net.cn

使用 WebClient 配置 ExchangeFilterFunction
@Configuration
public class WebClientConfig {

	@Bean
	public WebClient webClient(ReactiveOAuth2AuthorizedClientManager authorizedClientManager) {
		ServerOAuth2AuthorizedClientExchangeFilterFunction filter =
				new ServerOAuth2AuthorizedClientExchangeFilterFunction(authorizedClientManager);
		return WebClient.builder()
				.filter(filter)
				.build();
	}

}
@Configuration
class WebClientConfig {

	@Bean
	fun webClient(authorizedClientManager: ReactiveOAuth2AuthorizedClientManager): WebClient {
		val filter = ServerOAuth2AuthorizedClientExchangeFilterFunction(authorizedClientManager)
		return WebClient.builder()
			.filter(filter)
			.build()
	}

}

这个已配置的WebClient可按以下示例使用：spring-doc.cadn.net.cn

使用 WebClient 访问受保护的资源
import static org.springframework.security.oauth2.client.web.reactive.function.client.ServerOAuth2AuthorizedClientExchangeFilterFunction.clientRegistrationId;

@RestController
public class MessagesController {

	private final WebClient webClient;

	public MessagesController(WebClient webClient) {
		this.webClient = webClient;
	}

	@GetMapping("/messages")
	public Mono<ResponseEntity<List<Message>>> messages() {
		return this.webClient.get()
				.uri("http://localhost:8090/messages")
				.attributes(clientRegistrationId("my-oauth2-client"))
				.retrieve()
				.toEntityList(Message.class);
	}

	public record Message(String message) {
	}

}
import org.springframework.security.oauth2.client.web.reactive.function.client.ServerOAuth2AuthorizedClientExchangeFilterFunction.clientRegistrationId

@RestController
class MessagesController(private val webClient: WebClient) {

	@GetMapping("/messages")
	fun messages(): Mono<ResponseEntity<List<Message>>> {
		return webClient.get()
			.uri("http://localhost:8090/messages")
			.attributes(clientRegistrationId("my-oauth2-client"))
			.retrieve()
			.toEntityList<Message>()
	}

	data class Message(val message: String)

}

访问当前用户的受保护资源

当用户通过 OAuth2 或 OpenID Connect 登录时，授权服务器可能会提供一个访问Tokens，该Tokens可直接用于访问受保护的资源。 这非常方便，因为只需配置一个 ClientRegistration 即可同时满足这两种使用场景。spring-doc.cadn.net.cn

本节将使用 OAuth2 登录用户和访问受保护资源合并为单一配置。 还存在其他高级场景，例如为登录配置一个ClientRegistration，为访问受保护资源配置另一个3。 所有这些场景都使用相同的基本配置。spring-doc.cadn.net.cn

以下示例将应用程序配置为一个 OAuth2 客户端，能够登录用户并向第三方 API 请求受保护的资源：spring-doc.cadn.net.cn

配置 OAuth2 登录和 OAuth2 客户端
@Configuration
@EnableWebFluxSecurity
public class SecurityConfig {

	@Bean
	public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
		http
			// ...
			.oauth2Login(Customizer.withDefaults())
			.oauth2Client(Customizer.withDefaults());
		return http.build();
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
@EnableWebFluxSecurity
class SecurityConfig {

	@Bean
	fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		return http {
			// ...
			oauth2Login { }
			oauth2Client { }
		}
	}

}

除了上述配置外，应用程序需要通过ClientRegistration Bean 配置至少一个 ReactiveClientRegistrationRepository。 以下示例使用 Spring Boot 配置属性来配置一个 InMemoryReactiveClientRegistrationRepository Bean:spring-doc.cadn.net.cn

spring:
  security:
    oauth2:
      client:
        registration:
          my-combined-client:
            provider: my-auth-server
            client-id: my-client-id
            client-secret: my-client-secret
            authorization-grant-type: authorization_code
            scope: openid,profile,message.read,message.write
        provider:
          my-auth-server:
            issuer-uri: https://my-auth-server.com

与前面的示例（使用 OAuth2 登录用户、访问受保护资源）相比，本示例的主要区别在于通过 scope 属性所配置的内容，它将标准作用域 openid 和 profile 与自定义作用域 message.read 和 message.write 结合在一起。spring-doc.cadn.net.cn

除了配置 Spring Security 以支持 OAuth2 Client 特性外，您还需要决定如何访问受保护的资源，并相应地进行配置。 Spring Security 提供了获取访问Tokens的 ReactiveOAuth2AuthorizedClientManager 的实现，这些访问Tokens可以用来访问受保护的资源。spring-doc.cadn.net.cn

Spring Security 会为你注册一个默认的 ReactiveOAuth2AuthorizedClientManager Bean，如果不存在的话。spring-doc.cadn.net.cn

使用ReactiveOAuth2AuthorizedClientManager的最简单方法是通过ExchangeFilterFunction中的WebClient来拦截请求。spring-doc.cadn.net.cn

以下示例使用默认的 ReactiveOAuth2AuthorizedClientManager 来配置一个 WebClient，该客户端能够通过在每个请求的 Bearer 头中放置 Authorization Tokens来访问受保护的资源：spring-doc.cadn.net.cn

使用 WebClient 配置 ExchangeFilterFunction
@Configuration
public class WebClientConfig {

	@Bean
	public WebClient webClient(ReactiveOAuth2AuthorizedClientManager authorizedClientManager) {
		ServerOAuth2AuthorizedClientExchangeFilterFunction filter =
				new ServerOAuth2AuthorizedClientExchangeFilterFunction(authorizedClientManager);
		return WebClient.builder()
				.filter(filter)
				.build();
	}

}
@Configuration
class WebClientConfig {

	@Bean
	fun webClient(authorizedClientManager: ReactiveOAuth2AuthorizedClientManager): WebClient {
		val filter = ServerOAuth2AuthorizedClientExchangeFilterFunction(authorizedClientManager)
		return WebClient.builder()
			.filter(filter)
			.build()
	}

}

这个已配置的WebClient可按以下示例使用：spring-doc.cadn.net.cn

使用 WebClient 访问受保护的资源（当前用户）
@RestController
public class MessagesController {

	private final WebClient webClient;

	public MessagesController(WebClient webClient) {
		this.webClient = webClient;
	}

	@GetMapping("/messages")
	public Mono<ResponseEntity<List<Message>>> messages() {
		return this.webClient.get()
				.uri("http://localhost:8090/messages")
				.retrieve()
				.toEntityList(Message.class);
	}

	public record Message(String message) {
	}

}
@RestController
class MessagesController(private val webClient: WebClient) {

	@GetMapping("/messages")
	fun messages(): Mono<ResponseEntity<List<Message>>> {
		return webClient.get()
			.uri("http://localhost:8090/messages")
			.retrieve()
			.toEntityList<Message>()
	}

	data class Message(val message: String)

}

与上一个示例不同，请注意我们无需告诉 Spring Security 要使用的 clientRegistrationId。 这是因为该值可以从当前登录的用户推导得出。spring-doc.cadn.net.cn

启用扩展授权类型

一个常见的使用场景涉及启用和/或配置扩展授权类型。 例如，Spring Security 提供了对 jwt-bearer 和 token-exchange 授权类型的支持，但默认情况下并未启用它们，因为这些授权类型不属于 OAuth 2.0 核心规范的一部分。spring-doc.cadn.net.cn

使用 Spring Security 6.3 及其后版本，我们可以简单地发布一个或多个ReactiveOAuth2AuthorizedClientProvider的 bean，并且它们将被自动拾取。 以下示例仅启用了jwt-bearer 授 权 类型：spring-doc.cadn.net.cn

启用 jwt-bearer 授权类型
@Configuration
public class SecurityConfig {

	@Bean
	public ReactiveOAuth2AuthorizedClientProvider jwtBearer() {
		return new JwtBearerReactiveOAuth2AuthorizedClientProvider();
	}

}
@Configuration
class SecurityConfig {

	@Bean
	fun jwtBearer(): ReactiveOAuth2AuthorizedClientProvider {
		return JwtBearerReactiveOAuth2AuthorizedClientProvider()
	}

}

Spring Security会在未提供自定义的 ReactiveOAuth2AuthorizedClientManager 时自动发布一个默认的 1。spring-doc.cadn.net.cn

任何自定义的 OAuth2AuthorizedClientProvider Bean 也会被自动识别，并在默认授权类型之后应用到所提供的 ReactiveOAuth2AuthorizedClientManager 中。spring-doc.cadn.net.cn

在Spring Security 6.3之前，为了实现上述配置，我们不得不自己发布这个bean，并确保重新启用了默认的授权类型。 要了解幕后进行了哪些配置，这里是一个可能的配置示例：spring-doc.cadn.net.cn

启用 jwt-bearer 授权类型（在 6.3 版本之前）
@Configuration
public class SecurityConfig {

	@Bean
	public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
			ReactiveClientRegistrationRepository clientRegistrationRepository,
			ServerOAuth2AuthorizedClientRepository authorizedClientRepository) {

		ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
			ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
				.authorizationCode()
				.refreshToken()
				.clientCredentials()
				.provider(new JwtBearerReactiveOAuth2AuthorizedClientProvider())
				.build();

		DefaultReactiveOAuth2AuthorizedClientManager authorizedClientManager =
			new DefaultReactiveOAuth2AuthorizedClientManager(
				clientRegistrationRepository, authorizedClientRepository);
		authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);

		return authorizedClientManager;
	}

}
@Configuration
class SecurityConfig {

	@Bean
	fun authorizedClientManager(
		clientRegistrationRepository: ReactiveClientRegistrationRepository,
		authorizedClientRepository: ServerOAuth2AuthorizedClientRepository
	): ReactiveOAuth2AuthorizedClientManager {
		val authorizedClientProvider = ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
			.authorizationCode()
			.refreshToken()
			.clientCredentials()
			.provider(JwtBearerReactiveOAuth2AuthorizedClientProvider())
			.build()

		val authorizedClientManager = DefaultReactiveOAuth2AuthorizedClientManager(
			clientRegistrationRepository, authorizedClientRepository
		)
		authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)

		return authorizedClientManager
	}

}

自定义现有授权类型

The ability to 启用扩展授权类型通过发布一个bean，也提供了无需重新定义默认设置即可自定义现有授权类型的机遇。 例如，如果我们想为ReactiveOAuth2AuthorizedClientProvider授权定制client_credentials的时间偏移量，我们可以简单地发布一个类似的bean:spring-doc.cadn.net.cn

自定义客户端凭证授权类型
@Configuration
public class SecurityConfig {

	@Bean
	public ReactiveOAuth2AuthorizedClientProvider clientCredentials() {
		ClientCredentialsReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
				new ClientCredentialsReactiveOAuth2AuthorizedClientProvider();
		authorizedClientProvider.setClockSkew(Duration.ofMinutes(5));

		return authorizedClientProvider;
	}

}
@Configuration
class SecurityConfig {

	@Bean
	fun clientCredentials(): ReactiveOAuth2AuthorizedClientProvider {
		val authorizedClientProvider = ClientCredentialsReactiveOAuth2AuthorizedClientProvider()
		authorizedClientProvider.setClockSkew(Duration.ofMinutes(5))
		return authorizedClientProvider
	}

}

自定义Tokens请求参数

在获取访问Tokens时，自定义请求参数的需求相当常见。 例如，假设我们希望在Tokens请求中添加一个自定义的 audience 参数，因为提供方要求在使用 authorization_code 授权模式时必须包含此参数。spring-doc.cadn.net.cn

我们可以简单地发布一个类型为ReactiveOAuth2AccessTokenResponseClient且泛型类型为OAuth2AuthorizationCodeGrantRequest的bean，并且Spring Security会使用它来配置OAuth2 Client组件。spring-doc.cadn.net.cn

以下示例自定义了授权码（authorization_code）授予方式的Tokens请求参数：spring-doc.cadn.net.cn

自定义授权码许可的Tokens请求参数
@Configuration
public class SecurityConfig {

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> authorizationCodeAccessTokenResponseClient() {
		WebClientReactiveAuthorizationCodeTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveAuthorizationCodeTokenResponseClient();
		accessTokenResponseClient.addParametersConverter(parametersConverter());

		return accessTokenResponseClient;
	}

	private static Converter<OAuth2AuthorizationCodeGrantRequest, MultiValueMap<String, String>> parametersConverter() {
		return (grantRequest) -> {
			MultiValueMap<String, String> parameters = new LinkedMultiValueMap<>();
			parameters.set("audience", "xyz_value");

			return parameters;
		};
	}

}
@Configuration
class SecurityConfig {

	@Bean
	fun authorizationCodeAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveAuthorizationCodeTokenResponseClient()
		accessTokenResponseClient.addParametersConverter(parametersConverter())

		return accessTokenResponseClient
	}

	private fun parametersConverter(): Converter<OAuth2AuthorizationCodeGrantRequest, MultiValueMap<String, String>> {
		return Converter<OAuth2AuthorizationCodeGrantRequest, MultiValueMap<String, String>> { grantRequest ->
			LinkedMultiValueMap<String, String>().also { parameters ->
				parameters["audience"] = "xyz_value"
			}
		}
	}

}

请注意，在这种情况下，我们不需要自定义 SecurityWebFilterChain Bean，可以直接使用默认配置。 如果使用 Spring Boot 且没有其他自定义需求，我们实际上可以完全省略 SecurityWebFilterChain Bean。spring-doc.cadn.net.cn

如您所见，提供 ReactiveOAuth2AccessTokenResponseClient 作为 bean 非常方便。 当直接使用 Spring Security DSL 时，我们需要确保在 OAuth2 登录（如果我们使用此功能）和 OAuth2 客户端组件中应用此自定义设置。 为了了解幕后配置了什么内容，以下是使用 DSL 的配置示例：spring-doc.cadn.net.cn

使用DSL自定义授权码授予方式下的Token请求参数
@Configuration
@EnableWebFluxSecurity
public class SecurityConfig {

	@Bean
	public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
		WebClientReactiveAuthorizationCodeTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveAuthorizationCodeTokenResponseClient();
		accessTokenResponseClient.addParametersConverter(parametersConverter());

		http
			.authorizeExchange((authorize) -> authorize
				.anyExchange().authenticated()
			)
			.oauth2Login((oauth2Login) -> oauth2Login
				.authenticationManager(new DelegatingReactiveAuthenticationManager(
					new OidcAuthorizationCodeReactiveAuthenticationManager(
						accessTokenResponseClient, new OidcReactiveOAuth2UserService()
					),
					new OAuth2LoginReactiveAuthenticationManager(
						accessTokenResponseClient, new DefaultReactiveOAuth2UserService()
					)
				))
			)
			.oauth2Client((oauth2Client) -> oauth2Client
				.authenticationManager(new OAuth2AuthorizationCodeReactiveAuthenticationManager(
					accessTokenResponseClient
				))
			);

		return http.build();
	}

	private static Converter<OAuth2AuthorizationCodeGrantRequest, MultiValueMap<String, String>> parametersConverter() {
		// ...
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
@EnableWebFluxSecurity
class SecurityConfig {

	@Bean
	fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
		val accessTokenResponseClient = WebClientReactiveAuthorizationCodeTokenResponseClient()
		accessTokenResponseClient.addParametersConverter(parametersConverter())

		return http {
			authorizeExchange {
				authorize(anyExchange, authenticated)
			}
			oauth2Login {
				authenticationManager = DelegatingReactiveAuthenticationManager(
					OidcAuthorizationCodeReactiveAuthenticationManager(
						accessTokenResponseClient, OidcReactiveOAuth2UserService()
					),
					OAuth2LoginReactiveAuthenticationManager(
						accessTokenResponseClient, DefaultReactiveOAuth2UserService()
					)
				)
			}
			oauth2Client {
				authenticationManager = OAuth2AuthorizationCodeReactiveAuthenticationManager(
					accessTokenResponseClient
				)
			}
		}
	}

	private fun parametersConverter(): Converter<OAuth2AuthorizationCodeGrantRequest, MultiValueMap<String, String>> {
		// ...
	}

}

对于其他授权类型，我们可以发布额外的 ReactiveOAuth2AccessTokenResponseClient Bean 来覆盖默认配置。 例如，要自定义 client_credentials 授权类型的Tokens请求，我们可以发布如下 Bean：spring-doc.cadn.net.cn

为客户端凭证授权自定义Tokens请求参数
@Configuration
public class SecurityConfig {

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest> clientCredentialsAccessTokenResponseClient() {
		WebClientReactiveClientCredentialsTokenResponseClient accessTokenResponseClient =
				new WebClientReactiveClientCredentialsTokenResponseClient();
		accessTokenResponseClient.addParametersConverter(parametersConverter());

		return accessTokenResponseClient;
	}

	private static Converter<OAuth2ClientCredentialsGrantRequest, MultiValueMap<String, String>> parametersConverter() {
		// ...
	}

}
@Configuration
class SecurityConfig {

	@Bean
	fun clientCredentialsAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveClientCredentialsTokenResponseClient()
		accessTokenResponseClient.addParametersConverter(parametersConverter())

		return accessTokenResponseClient
	}

	private fun parametersConverter(): Converter<OAuth2ClientCredentialsGrantRequest, MultiValueMap<String, String>> {
		// ...
	}

}

Spring Security 会自动解析以下通用类型的 ReactiveOAuth2AccessTokenResponseClient Bean：spring-doc.cadn.net.cn

  • OAuth2AuthorizationCodeGrantRequest （参见 WebClientReactiveAuthorizationCodeTokenResponseClient）spring-doc.cadn.net.cn

  • OAuth2RefreshTokenGrantRequest （参见 WebClientReactiveRefreshTokenTokenResponseClient）spring-doc.cadn.net.cn

  • OAuth2ClientCredentialsGrantRequest （参见 WebClientReactiveClientCredentialsTokenResponseClient）spring-doc.cadn.net.cn

  • JwtBearerGrantRequest （参见 WebClientReactiveJwtBearerTokenResponseClient）spring-doc.cadn.net.cn

  • TokenExchangeGrantRequest （参见 WebClientReactiveTokenExchangeTokenResponseClient）spring-doc.cadn.net.cn

发布类型为ReactiveOAuth2AccessTokenResponseClient<JwtBearerGrantRequest>的bean将会自动启用jwt-bearer授权类型，无需单独进行配置。spring-doc.cadn.net.cn

发布类型为ReactiveOAuth2AccessTokenResponseClient<TokenExchangeGrantRequest>的bean将会自动启用token-exchange授权类型，无需单独进行配置。spring-doc.cadn.net.cn

自定义WebClient被 OAuth2 客户端组件使用

另一个常见的用例是在获取访问Tokens时需要自定义使用的WebClient。 我们可能需要这样做来定制底层的HTTP客户端库（通过一个自定义的ClientHttpConnector）以配置SSL设置或为公司网络应用代理设置。spring-doc.cadn.net.cn

Spring Security 6.3 及其后续版本中，我们可以简单地发布类型为ReactiveOAuth2AccessTokenResponseClient的bean，Spring Security 将为我们配置并发布一个ReactiveOAuth2AuthorizedClientManager bean。spring-doc.cadn.net.cn

以下示例为所有支持的授权类型自定义了 WebClient：spring-doc.cadn.net.cn

为 OAuth2 客户端自定义 WebClient
@Configuration
public class SecurityConfig {

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> authorizationCodeAccessTokenResponseClient() {
		WebClientReactiveAuthorizationCodeTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveAuthorizationCodeTokenResponseClient();
		accessTokenResponseClient.setWebClient(webClient());

		return accessTokenResponseClient;
	}

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<OAuth2RefreshTokenGrantRequest> refreshTokenAccessTokenResponseClient() {
		WebClientReactiveRefreshTokenTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveRefreshTokenTokenResponseClient();
		accessTokenResponseClient.setWebClient(webClient());

		return accessTokenResponseClient;
	}

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest> clientCredentialsAccessTokenResponseClient() {
		WebClientReactiveClientCredentialsTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveClientCredentialsTokenResponseClient();
		accessTokenResponseClient.setWebClient(webClient());

		return accessTokenResponseClient;
	}

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<JwtBearerGrantRequest> jwtBearerAccessTokenResponseClient() {
		WebClientReactiveJwtBearerTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveJwtBearerTokenResponseClient();
		accessTokenResponseClient.setWebClient(webClient());

		return accessTokenResponseClient;
	}

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<TokenExchangeGrantRequest> tokenExchangeAccessTokenResponseClient() {
		WebClientReactiveTokenExchangeTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveTokenExchangeTokenResponseClient();
		accessTokenResponseClient.setWebClient(webClient());

		return accessTokenResponseClient;
	}

	@Bean
	public WebClient webClient() {
		// ...
	}

}
@Configuration
class SecurityConfig {

	@Bean
	fun authorizationCodeAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveAuthorizationCodeTokenResponseClient()
		accessTokenResponseClient.setWebClient(webClient())

		return accessTokenResponseClient
	}

	@Bean
	fun refreshTokenAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<OAuth2RefreshTokenGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveRefreshTokenTokenResponseClient()
		accessTokenResponseClient.setWebClient(webClient())

		return accessTokenResponseClient
	}

	@Bean
	fun clientCredentialsAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<OAuth2ClientCredentialsGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveClientCredentialsTokenResponseClient()
		accessTokenResponseClient.setWebClient(webClient())

		return accessTokenResponseClient
	}

	@Bean
	fun jwtBearerAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<JwtBearerGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveJwtBearerTokenResponseClient()
		accessTokenResponseClient.setWebClient(webClient())

		return accessTokenResponseClient
	}

	@Bean
	fun tokenExchangeAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<TokenExchangeGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveTokenExchangeTokenResponseClient()
		accessTokenResponseClient.setWebClient(webClient())

		return accessTokenResponseClient
	}

	@Bean
	fun webClient(): WebClient {
		// ...
	}

}

Spring Security会在未提供自定义的 ReactiveOAuth2AuthorizedClientManager 时自动发布一个默认的 1。spring-doc.cadn.net.cn

请注意，在这种情况下，我们不需要自定义 SecurityWebFilterChain Bean，可以直接使用默认配置。 如果使用 Spring Boot 且没有其他自定义需求，我们实际上可以完全省略 SecurityWebFilterChain Bean。spring-doc.cadn.net.cn

在Spring Security 6.3之前，我们自己需要确保这种自定义应用到了OAuth2 Client组件上。 尽管我们可以发布一个类型为ReactiveOAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest>的bean用于authorization_code授权类型，但我们仍需为其他授权类型发布一个类型为ReactiveOAuth2AuthorizedClientManager的bean。 为了理解背后的具体配置，这里展示一下可能的配置情况：spring-doc.cadn.net.cn

定制 WebClient 用于 OAuth2 客户端（在 6.3 版本之前）
@Configuration
public class SecurityConfig {

	@Bean
	public ReactiveOAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> authorizationCodeAccessTokenResponseClient() {
		WebClientReactiveAuthorizationCodeTokenResponseClient accessTokenResponseClient =
			new WebClientReactiveAuthorizationCodeTokenResponseClient();
		accessTokenResponseClient.setWebClient(webClient());

		return accessTokenResponseClient;
	}

	@Bean
	public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
			ReactiveClientRegistrationRepository clientRegistrationRepository,
			ServerOAuth2AuthorizedClientRepository authorizedClientRepository) {

		WebClientReactiveRefreshTokenTokenResponseClient refreshTokenAccessTokenResponseClient =
			new WebClientReactiveRefreshTokenTokenResponseClient();
		refreshTokenAccessTokenResponseClient.setWebClient(webClient());

		WebClientReactiveClientCredentialsTokenResponseClient clientCredentialsAccessTokenResponseClient =
			new WebClientReactiveClientCredentialsTokenResponseClient();
		clientCredentialsAccessTokenResponseClient.setWebClient(webClient());

		WebClientReactiveJwtBearerTokenResponseClient jwtBearerAccessTokenResponseClient =
			new WebClientReactiveJwtBearerTokenResponseClient();
		jwtBearerAccessTokenResponseClient.setWebClient(webClient());

		JwtBearerReactiveOAuth2AuthorizedClientProvider jwtBearerAuthorizedClientProvider =
			new JwtBearerReactiveOAuth2AuthorizedClientProvider();
		jwtBearerAuthorizedClientProvider.setAccessTokenResponseClient(jwtBearerAccessTokenResponseClient);

		WebClientReactiveTokenExchangeTokenResponseClient tokenExchangeAccessTokenResponseClient =
			new WebClientReactiveTokenExchangeTokenResponseClient();
		tokenExchangeAccessTokenResponseClient.setWebClient(webClient());

		TokenExchangeReactiveOAuth2AuthorizedClientProvider tokenExchangeAuthorizedClientProvider =
			new TokenExchangeReactiveOAuth2AuthorizedClientProvider();
		tokenExchangeAuthorizedClientProvider.setAccessTokenResponseClient(tokenExchangeAccessTokenResponseClient);

		ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
			ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
				.authorizationCode()
				.refreshToken((refreshToken) -> refreshToken
					.accessTokenResponseClient(refreshTokenAccessTokenResponseClient)
				)
				.clientCredentials((clientCredentials) -> clientCredentials
					.accessTokenResponseClient(clientCredentialsAccessTokenResponseClient)
				)
				.provider(jwtBearerAuthorizedClientProvider)
				.provider(tokenExchangeAuthorizedClientProvider)
				.build();

		DefaultReactiveOAuth2AuthorizedClientManager authorizedClientManager =
			new DefaultReactiveOAuth2AuthorizedClientManager(
				clientRegistrationRepository, authorizedClientRepository);
		authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);

		return authorizedClientManager;
	}

	@Bean
	public WebClient webClient() {
		// ...
	}

}
import org.springframework.security.config.web.server.invoke

@Configuration
class SecurityConfig {

	@Bean
	fun authorizationCodeAccessTokenResponseClient(): ReactiveOAuth2AccessTokenResponseClient<OAuth2AuthorizationCodeGrantRequest> {
		val accessTokenResponseClient = WebClientReactiveAuthorizationCodeTokenResponseClient()
		accessTokenResponseClient.setWebClient(webClient())

		return accessTokenResponseClient
	}

	@Bean
	fun authorizedClientManager(
		clientRegistrationRepository: ReactiveClientRegistrationRepository?,
		authorizedClientRepository: ServerOAuth2AuthorizedClientRepository?
	): ReactiveOAuth2AuthorizedClientManager {
		val refreshTokenAccessTokenResponseClient = WebClientReactiveRefreshTokenTokenResponseClient()
		refreshTokenAccessTokenResponseClient.setWebClient(webClient())

		val clientCredentialsAccessTokenResponseClient = WebClientReactiveClientCredentialsTokenResponseClient()
		clientCredentialsAccessTokenResponseClient.setWebClient(webClient())

		val jwtBearerAccessTokenResponseClient = WebClientReactiveJwtBearerTokenResponseClient()
		jwtBearerAccessTokenResponseClient.setWebClient(webClient())

		val jwtBearerAuthorizedClientProvider = JwtBearerReactiveOAuth2AuthorizedClientProvider()
		jwtBearerAuthorizedClientProvider.setAccessTokenResponseClient(jwtBearerAccessTokenResponseClient)

		val tokenExchangeAccessTokenResponseClient = WebClientReactiveTokenExchangeTokenResponseClient()
		tokenExchangeAccessTokenResponseClient.setWebClient(webClient())

		val tokenExchangeAuthorizedClientProvider = TokenExchangeReactiveOAuth2AuthorizedClientProvider()
		tokenExchangeAuthorizedClientProvider.setAccessTokenResponseClient(tokenExchangeAccessTokenResponseClient)

		val authorizedClientProvider = OAuth2AuthorizedClientProviderBuilder.builder()
			.authorizationCode()
			.refreshToken { refreshToken ->
				refreshToken.accessTokenResponseClient(refreshTokenAccessTokenResponseClient)
			}
			.clientCredentials { clientCredentials ->
				clientCredentials.accessTokenResponseClient(clientCredentialsAccessTokenResponseClient)
			}
			.provider(jwtBearerAuthorizedClientProvider)
			.provider(tokenExchangeAuthorizedClientProvider)
			.build()

		val authorizedClientManager = DefaultReactiveOAuth2AuthorizedClientManager(
			clientRegistrationRepository, authorizedClientRepository
		)
		authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)

		return authorizedClientManager
	}

	@Bean
	fun webClient(): WebClient {
		// ...
	}

}

进一步阅读

前面的章节介绍了Spring Security对OAuth2的支持，并提供了常见场景的示例。 您可以在参考文档的相关部分阅读更多关于OAuth2客户端和资源服务器的内容：spring-doc.cadn.net.cn