OAuth 2.0 クライアント
OAuth 2.0 クライアント機能は、OAuth 2.0 認証フレームワーク [IETF] (英語) で定義されているクライアントロールのサポートを提供します。
大まかに言うと、利用可能なコア機能は次のとおりです。
サーブレット環境の
WebClient統合 (保護されたリソースをリクエストするため)
HttpSecurity.oauth2Client() DSL は、OAuth 2.0 クライアントが使用するコアコンポーネントをカスタマイズするための多くの設定オプションを提供します。さらに、HttpSecurity.oauth2Client().authorizationCodeGrant() では、認可コードの付与をカスタマイズできます。
次のコードは、HttpSecurity.oauth2Client() DSL によって提供される完全な構成オプションを示しています。
Java
Kotlin
@Configuration
@EnableWebSecurity
public class OAuth2ClientSecurityConfig {
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.oauth2Client(oauth2 -> oauth2
.clientRegistrationRepository(this.clientRegistrationRepository())
.authorizedClientRepository(this.authorizedClientRepository())
.authorizedClientService(this.authorizedClientService())
.authorizationCodeGrant(codeGrant -> codeGrant
.authorizationRequestRepository(this.authorizationRequestRepository())
.authorizationRequestResolver(this.authorizationRequestResolver())
.accessTokenResponseClient(this.accessTokenResponseClient())
)
);
return http.build();
}
}@Configuration
@EnableWebSecurity
class OAuth2ClientSecurityConfig {
@Bean
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
http {
oauth2Client {
clientRegistrationRepository = clientRegistrationRepository()
authorizedClientRepository = authorizedClientRepository()
authorizedClientService = authorizedClientService()
authorizationCodeGrant {
authorizationRequestRepository = authorizationRequestRepository()
authorizationRequestResolver = authorizationRequestResolver()
accessTokenResponseClient = accessTokenResponseClient()
}
}
}
return http.build()
}
}HttpSecurity.oauth2Client() DSL に加えて、XML 構成もサポートされています。
次のコードは、セキュリティ名前空間で使用できる完全な構成オプションを示しています。
<http>
<oauth2-client client-registration-repository-ref="clientRegistrationRepository"
authorized-client-repository-ref="authorizedClientRepository"
authorized-client-service-ref="authorizedClientService">
<authorization-code-grant
authorization-request-repository-ref="authorizationRequestRepository"
authorization-request-resolver-ref="authorizationRequestResolver"
access-token-response-client-ref="accessTokenResponseClient"/>
</oauth2-client>
</http>OAuth2AuthorizedClientManager は、1 つ以上の OAuth2AuthorizedClientProvider と協力して、OAuth 2.0 クライアントの認可（または再認可）を管理します。
次のコードは、OAuth2AuthorizedClientManager@Bean を登録し、それを authorization_code、refresh_token、client_credentials、password 認可認可型のサポートを提供する OAuth2AuthorizedClientProvider コンポジットに関連付ける方法の例を示しています。
Java
Kotlin
@Bean
public OAuth2AuthorizedClientManager authorizedClientManager(
ClientRegistrationRepository clientRegistrationRepository,
OAuth2AuthorizedClientRepository authorizedClientRepository) {
OAuth2AuthorizedClientProvider authorizedClientProvider =
OAuth2AuthorizedClientProviderBuilder.builder()
.authorizationCode()
.refreshToken()
.clientCredentials()
.password()
.build();
DefaultOAuth2AuthorizedClientManager authorizedClientManager =
new DefaultOAuth2AuthorizedClientManager(
clientRegistrationRepository, authorizedClientRepository);
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider);
return authorizedClientManager;
}@Bean
fun authorizedClientManager(
clientRegistrationRepository: ClientRegistrationRepository,
authorizedClientRepository: OAuth2AuthorizedClientRepository): OAuth2AuthorizedClientManager {
val authorizedClientProvider: OAuth2AuthorizedClientProvider = OAuth2AuthorizedClientProviderBuilder.builder()
.authorizationCode()
.refreshToken()
.clientCredentials()
.password()
.build()
val authorizedClientManager = DefaultOAuth2AuthorizedClientManager(
clientRegistrationRepository, authorizedClientRepository)
authorizedClientManager.setAuthorizedClientProvider(authorizedClientProvider)
return authorizedClientManager
}
