核心介面/類

ClientRegistration

ClientRegistration 是一個表示已在 OAuth 2.0 或 OpenID Connect 1.0 Provider 註冊的客戶端的類。

客戶端註冊儲存了諸如客戶端 ID、客戶端金鑰、授權授予型別、重定向 URI、範圍、授權 URI、令牌 URI 和其他詳細資訊。

ClientRegistration 及其屬性定義如下

public final class ClientRegistration {
	private String registrationId;	(1)
	private String clientId;	(2)
	private String clientSecret;	(3)
	private ClientAuthenticationMethod clientAuthenticationMethod;	(4)
	private AuthorizationGrantType authorizationGrantType;	(5)
	private String redirectUri;	(6)
	private Set<String> scopes;	(7)
	private ProviderDetails providerDetails;
	private String clientName;	(8)

	public class ProviderDetails {
		private String authorizationUri;	(9)
		private String tokenUri;	(10)
		private UserInfoEndpoint userInfoEndpoint;
		private String jwkSetUri;	(11)
		private String issuerUri;	(12)
		private Map<String, Object> configurationMetadata;  (13)

		public class UserInfoEndpoint {
			private String uri;	(14)
			private AuthenticationMethod authenticationMethod;  (15)
			private String userNameAttributeName;	(16)

		}
	}

	public static final class ClientSettings {
		private boolean requireProofKey; (17)
	}
}

1	`registrationId`：唯一標識 `ClientRegistration` 的 ID。
2	`clientId`：客戶端識別符號。
3	`clientSecret`：客戶端金鑰。
4	`clientAuthenticationMethod`：用於向 Provider 驗證客戶端的方法。支援的值有 client_secret_basic、client_secret_post、private_key_jwt、client_secret_jwt 和 none (公共客戶端)。
5	`authorizationGrantType`：OAuth 2.0 授權框架定義了四種授權授予型別。支援的值有 `authorization_code`、`client_credentials`，以及擴充套件授予型別 `urn:ietf:params:oauth:grant-type:jwt-bearer`。
6	`redirectUri`：客戶端註冊的重定向 URI，授權伺服器在終端使用者認證並授權客戶端訪問後，會將終端使用者的使用者代理重定向到該 URI。
7	`scopes`：客戶端在授權請求流程中請求的範圍，例如 openid、email 或 profile。
8	`clientName`：用於客戶端的描述性名稱。該名稱可能在某些場景中使用，例如在自動生成的登入頁面中顯示客戶端名稱。
9	`authorizationUri`：授權伺服器的授權端點 URI。
10	`tokenUri`：授權伺服器的令牌端點 URI。
11	`jwkSetUri`：用於從授權伺服器檢索 JSON Web Key (JWK) Set 的 URI，其中包含用於驗證 ID 令牌的 JSON Web Signature (JWS) 以及可選的 UserInfo 響應的加密金鑰。
12	`issuerUri`：返回 OpenID Connect 1.0 provider 或 OAuth 2.0 Authorization Server 的發行者識別符號 URI。
13	`configurationMetadata`：OpenID Provider 配置資訊。此資訊僅在配置了 Spring Boot 屬性 `spring.security.oauth2.client.provider.[providerId].issuerUri` 時可用。
14	`(userInfoEndpoint)uri`：UserInfo 端點 URI，用於訪問已認證終端使用者的宣告/屬性。
15	`(userInfoEndpoint)authenticationMethod`：向 UserInfo 端點發送訪問令牌時使用的認證方法。支援的值有 header、form 和 query。
16	`userNameAttributeName`：UserInfo 響應中返回的屬性名稱，該屬性引用終端使用者的名稱或識別符號。
17	`requireProofKey`：如果為 `true` 或 `authorizationGrantType` 為 `none`，則預設啟用 PKCE。

ClientRegistration 可以透過發現 OpenID Connect Provider 的配置端點或授權伺服器的元資料端點進行初步配置。

ClientRegistrations 提供了方便的方法來以這種方式配置 ClientRegistration，如下例所示

Java
Kotlin

ClientRegistration clientRegistration =
	ClientRegistrations.fromIssuerLocation("https://idp.example.com/issuer").build();

val clientRegistration = ClientRegistrations.fromIssuerLocation("https://idp.example.com/issuer").build()

上述程式碼將依次查詢 idp.example.com/issuer/.well-known/openid-configuration，然後是 idp.example.com/.well-known/openid-configuration/issuer，最後是 idp.example.com/.well-known/oauth-authorization-server/issuer，在第一個返回 200 響應時停止。

作為替代，您可以使用 ClientRegistrations.fromOidcIssuerLocation() 僅查詢 OpenID Connect Provider 的配置端點。

ReactiveClientRegistrationRepository

ReactiveClientRegistrationRepository 作為 OAuth 2.0 / OpenID Connect 1.0 ClientRegistration 的儲存庫。

客戶端註冊資訊最終由關聯的授權伺服器儲存和擁有。此儲存庫提供了檢索儲存在授權伺服器中的主要客戶端註冊資訊子集的能力。

Spring Boot 自動配置將 spring.security.oauth2.client.registration.[registrationId] 下的每個屬性繫結到 ClientRegistration 例項，然後將每個 ClientRegistration 例項組合到 ReactiveClientRegistrationRepository 中。

ReactiveClientRegistrationRepository 的預設實現是 InMemoryReactiveClientRegistrationRepository。

自動配置還將 ReactiveClientRegistrationRepository 註冊為 ApplicationContext 中的 @Bean，以便應用程式需要時可用於依賴注入。

以下列表顯示了一個示例

Java
Kotlin

@Controller
public class OAuth2ClientController {

	@Autowired
	private ReactiveClientRegistrationRepository clientRegistrationRepository;

	@GetMapping("/")
	public Mono<String> index() {
		return this.clientRegistrationRepository.findByRegistrationId("okta")
				...
				.thenReturn("index");
	}
}

@Controller
class OAuth2ClientController {

    @Autowired
    private lateinit var clientRegistrationRepository: ReactiveClientRegistrationRepository

    @GetMapping("/")
    fun index(): Mono<String> {
        return this.clientRegistrationRepository.findByRegistrationId("okta")
            ...
            .thenReturn("index")
    }
}

OAuth2AuthorizedClient

OAuth2AuthorizedClient 是授權客戶端的表示。當終端使用者（資源所有者）授予客戶端訪問其受保護資源的授權時，客戶端被視為已授權。

OAuth2AuthorizedClient 的目的是將 OAuth2AccessToken（和可選的 OAuth2RefreshToken）與 ClientRegistration（客戶端）和資源所有者（授予授權的 Principal 終端使用者）關聯起來。

ServerOAuth2AuthorizedClientRepository / ReactiveOAuth2AuthorizedClientService

ServerOAuth2AuthorizedClientRepository 負責在 Web 請求之間持久化 OAuth2AuthorizedClient。而 ReactiveOAuth2AuthorizedClientService 的主要作用是在應用程式級別管理 OAuth2AuthorizedClient。

從開發人員的角度來看，ServerOAuth2AuthorizedClientRepository 或 ReactiveOAuth2AuthorizedClientService 提供了查詢與客戶端關聯的 OAuth2AccessToken 的能力，以便將其用於發起受保護的資源請求。

以下列表顯示了一個示例

Java
Kotlin

@Controller
public class OAuth2ClientController {

	@Autowired
	private ReactiveOAuth2AuthorizedClientService authorizedClientService;

	@GetMapping("/")
	public Mono<String> index(Authentication authentication) {
		return this.authorizedClientService.loadAuthorizedClient("okta", authentication.getName())
				.map(OAuth2AuthorizedClient::getAccessToken)
				...
				.thenReturn("index");
	}
}

@Controller
class OAuth2ClientController {

    @Autowired
    private lateinit var authorizedClientService: ReactiveOAuth2AuthorizedClientService

    @GetMapping("/")
    fun index(authentication: Authentication): Mono<String> {
        return this.authorizedClientService.loadAuthorizedClient<OAuth2AuthorizedClient>("okta", authentication.name)
            .map { it.accessToken }
            ...
            .thenReturn("index")
    }
}

Spring Boot 自動配置在 ApplicationContext 中註冊一個 ServerOAuth2AuthorizedClientRepository 和/或 ReactiveOAuth2AuthorizedClientService @Bean。但是，應用程式可以選擇覆蓋並註冊自定義的 ServerOAuth2AuthorizedClientRepository 或 ReactiveOAuth2AuthorizedClientService @Bean。

ReactiveOAuth2AuthorizedClientService 的預設實現是 InMemoryReactiveOAuth2AuthorizedClientService，它將 OAuth2AuthorizedClient 儲存在記憶體中。

或者，可以配置 R2DBC 實現 R2dbcReactiveOAuth2AuthorizedClientService 以將 OAuth2AuthorizedClient 持久化到資料庫中。

R2dbcReactiveOAuth2AuthorizedClientService 依賴於 OAuth 2.0 客戶端模式中描述的表定義。

ReactiveOAuth2AuthorizedClientManager / ReactiveOAuth2AuthorizedClientProvider

ReactiveOAuth2AuthorizedClientManager 負責 OAuth2AuthorizedClient 的整體管理。

主要職責包括

使用 ReactiveOAuth2AuthorizedClientProvider 授權（或重新授權）OAuth 2.0 客戶端。
委託 OAuth2AuthorizedClient 的持久化，通常使用 ReactiveOAuth2AuthorizedClientService 或 ServerOAuth2AuthorizedClientRepository。
當 OAuth 2.0 客戶端成功授權（或重新授權）時，委託給 ReactiveOAuth2AuthorizationSuccessHandler。
當 OAuth 2.0 客戶端授權（或重新授權）失敗時，委託給 ReactiveOAuth2AuthorizationFailureHandler。

ReactiveOAuth2AuthorizedClientProvider 實現了授權（或重新授權）OAuth 2.0 客戶端的策略。實現通常會實現一種授權授予型別，例如 authorization_code、client_credentials 等。

ReactiveOAuth2AuthorizedClientManager 的預設實現是 DefaultReactiveOAuth2AuthorizedClientManager，它與一個 ReactiveOAuth2AuthorizedClientProvider 相關聯，該提供者可以透過基於委託的組合支援多種授權授予型別。ReactiveOAuth2AuthorizedClientProviderBuilder 可用於配置和構建基於委託的組合。

以下程式碼顯示瞭如何配置和構建一個 ReactiveOAuth2AuthorizedClientProvider 組合，以支援 authorization_code、refresh_token 和 client_credentials 授權授予型別

Java
Kotlin

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

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

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

	return authorizedClientManager;
}

@Bean
fun authorizedClientManager(
        clientRegistrationRepository: ReactiveClientRegistrationRepository,
        authorizedClientRepository: ServerOAuth2AuthorizedClientRepository): ReactiveOAuth2AuthorizedClientManager {
    val authorizedClientProvider: ReactiveOAuth2AuthorizedClientProvider = ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
            .authorizationCode()
            .refreshToken()
            .clientCredentials()
            .build()
    val authorizedClientManager = DefaultReactiveOAuth2AuthorizedClientManager(
            clientRegistrationRepository, authorizedClientRepository)
    authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
    return authorizedClientManager
}

當授權嘗試成功時，DefaultReactiveOAuth2AuthorizedClientManager 將委託給 ReactiveOAuth2AuthorizationSuccessHandler，後者（預設情況下）將透過 ServerOAuth2AuthorizedClientRepository 儲存 OAuth2AuthorizedClient。在重新授權失敗的情況下，例如重新整理令牌不再有效，之前儲存的 OAuth2AuthorizedClient 將透過 RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler 從 ServerOAuth2AuthorizedClientRepository 中移除。預設行為可以透過 setAuthorizationSuccessHandler(ReactiveOAuth2AuthorizationSuccessHandler) 和 setAuthorizationFailureHandler(ReactiveOAuth2AuthorizationFailureHandler) 進行自定義。

DefaultReactiveOAuth2AuthorizedClientManager 還與一個型別為 Function<OAuth2AuthorizeRequest, Mono<Map<String, Object>>> 的 contextAttributesMapper 相關聯，該對映器負責將 OAuth2AuthorizeRequest 中的屬性對映到與 OAuth2AuthorizationContext 關聯的屬性 Map。當您需要向 ReactiveOAuth2AuthorizedClientProvider 提供所需（支援的）屬性時，這會很有用。

以下程式碼顯示了 contextAttributesMapper 的示例

Java
Kotlin

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

	ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
			ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
					.authorizationCode()
					.refreshToken()
					.build();

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

	// Assuming the attributes are supplied as `ServerHttpRequest` parameters,
	// map the `ServerHttpRequest` parameters to `OAuth2AuthorizationContext.getAttributes()`
	authorizedClientManager.setContextAttributesMapper(contextAttributesMapper());

	return authorizedClientManager;
}

private Function<OAuth2AuthorizeRequest, Mono<Map<String, Object>>> contextAttributesMapper() {
	return authorizeRequest -> {
		Map<String, Object> contextAttributes = Collections.emptyMap();
		ServerWebExchange exchange = authorizeRequest.getAttribute(ServerWebExchange.class.getName());
		ServerHttpRequest request = exchange.getRequest();
		String param1 = request.getQueryParams().getFirst("param1");
		String param2 = request.getQueryParams().getFirst("param2");
		if (StringUtils.hasText(param1) && StringUtils.hasText(param2)) {
			contextAttributes = new HashMap<>();
			contextAttributes.put("param1", param1);
			contextAttributes.put("param2", param2);
		}
		return Mono.just(contextAttributes);
	};
}

@Bean
fun authorizedClientManager(
        clientRegistrationRepository: ReactiveClientRegistrationRepository,
        authorizedClientRepository: ServerOAuth2AuthorizedClientRepository): ReactiveOAuth2AuthorizedClientManager {
    val authorizedClientProvider: ReactiveOAuth2AuthorizedClientProvider = ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
            .authorizationCode()
            .refreshToken()
            .build()
    val authorizedClientManager = DefaultReactiveOAuth2AuthorizedClientManager(
            clientRegistrationRepository, authorizedClientRepository)
    authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)

	// Assuming the attributes are supplied as `ServerHttpRequest` parameters,
	// map the `ServerHttpRequest` parameters to `OAuth2AuthorizationContext.getAttributes()`
    authorizedClientManager.setContextAttributesMapper(contextAttributesMapper())
    return authorizedClientManager
}

private fun contextAttributesMapper(): Function<OAuth2AuthorizeRequest, Mono<MutableMap<String, Any>>> {
    return Function { authorizeRequest ->
        var contextAttributes: MutableMap<String, Any> = mutableMapOf()
        val exchange: ServerWebExchange = authorizeRequest.getAttribute(ServerWebExchange::class.java.name)!!
        val request: ServerHttpRequest = exchange.request
        val param1: String? = request.queryParams.getFirst("param1")
        val param2: String? = request.queryParams.getFirst("param2")
        if (StringUtils.hasText(param1) && StringUtils.hasText(param2)) {
            contextAttributes = hashMapOf()
            contextAttributes["param1"] = param1!!
            contextAttributes["param2"] = param2!!
        }
        Mono.just(contextAttributes)
    }
}

DefaultReactiveOAuth2AuthorizedClientManager 設計用於 ServerWebExchange 的上下文**中**。當在 ServerWebExchange 上下文**之外**操作時，請改用 AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager。

服務應用程式是使用 AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager 的常見用例。服務應用程式通常在後臺執行，沒有任何使用者互動，並且通常在系統級帳戶而不是使用者帳戶下執行。配置了 client_credentials 授權授予型別的 OAuth 2.0 客戶端可以被視為一種服務應用程式。

以下程式碼顯示瞭如何配置 AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager 以支援 client_credentials 授予型別的示例

Java
Kotlin

@Bean
public ReactiveOAuth2AuthorizedClientManager authorizedClientManager(
		ReactiveClientRegistrationRepository clientRegistrationRepository,
		ReactiveOAuth2AuthorizedClientService authorizedClientService) {

	ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider =
			ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
					.clientCredentials()
					.build();

	AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager authorizedClientManager =
			new AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager(
					clientRegistrationRepository, authorizedClientService);
	authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);

	return authorizedClientManager;
}

@Bean
fun authorizedClientManager(
        clientRegistrationRepository: ReactiveClientRegistrationRepository,
        authorizedClientService: ReactiveOAuth2AuthorizedClientService): ReactiveOAuth2AuthorizedClientManager {
    val authorizedClientProvider: ReactiveOAuth2AuthorizedClientProvider = ReactiveOAuth2AuthorizedClientProviderBuilder.builder()
            .clientCredentials()
            .build()
    val authorizedClientManager = AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager(
            clientRegistrationRepository, authorizedClientService)
    authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
    return authorizedClientManager
}