Spring との違い
spring_boot_starter_oauth2_client は、Spring Security の spring-security-oauth2-client と -oauth2-core に、Spring Boot の自動構成と Spring Cloud OpenFeign の OAuth2 インターセプターを組み合わせたものに従います。同じプロパティ、型、ルールです。このページでは、そうでない箇所とその理由を挙げます。
使う理由
このパッケージはサーバーだけでなく Flutter アプリやブラウザーでも動かなければならないため、Web サーバーを取り込むことはできず、すべてのネットワーク呼び出しは非同期です。いくつかの動作は Spring のデフォルトより安全で、Sign in with Apple とクライアント側の DPoP は追加されたものです。
例
# Spring Boot と同じキー:
spring.security.oauth2.client.registration.keycloak.client-id=neon-web
spring.security.oauth2.client.provider.keycloak.issuer-uri=https://login.example.com/realms/neon
# Spring Cloud の Feign のキーから cloud.openfeign を除いたもの:
spring.feign.oauth2.enabled=true
パッケージ構成とプロパティ
| Spring | ここ | 理由 |
|---|---|---|
spring-boot-starter-oauth2-client は Web セキュリティと oauth2Login() を取り込む |
クライアントだけ。サーバーは spring_boot_starter_security、アプリは spring_boot_starter_flutter_security を加える |
dart:io のサーバーがない場所でも動かなければならない。 |
spring.cloud.openfeign.oauth2.* |
spring.feign.oauth2.*。古い名前は起動を止める |
Spring Cloud は Dart では意味を持たない。 |
| 発行者の検出は起動時 | 最初の使用時。失敗は 10 秒以上後の使用時に再試行される | プロバイダーに到達できない間でもアプリが起動する。 |
平文の http:// の URI は黙って受け入れられる |
ループバック以外では登録ごとに一度警告する | http:// 上のトークンは読まれたり変更されたりしうる。 |
動作
ClientRegistrationRepository.findByRegistrationId、認可済みクライアントのサービス、マネージャー、トークンクライアント、ユーザーサービスはFutureを返します。- クライアントシークレットも
client-authentication-methodもないauthorization_codeの登録は、client_secret_basicを指定する共通のプロバイダーであっても、パブリッククライアント (none) です。 - Spring Security 7.1 と同じく、PKCE は、コンフィデンシャルクライアントも含むすべての
authorization_codeの登録で有効です。 - トークン応答クライアントは
spring_web_dartのHttpTransportの上で動きます (Spring 7 のRestClient*TokenResponseClient)。 AuthorizedClientServiceOAuth2AuthorizedClientManagerはそのプロバイダーを必要とし (Spring のデフォルトはクライアントクレデンシャルだけ)、登録とプリンシパルごとに一度に一つの認可を実行し、invalid_grantやinvalid_tokenの後に保存されたクライアントを取り除きます。OAuth2AuthorizedClientは ID トークンを保持します。リフレッシュは新しいものをそれと照合し、セッションのないログアウトはそれをid_token_hintとして必要とします。- リフレッシュされた ID トークンは、Spring Security 6.3 の
OidcAuthorizedClientRefreshedEventListenerと同じく、OpenID Connect Core §12.2 のとおりにチェックされます。 - トークンクライアント、ユーザーサービス、
OidcIdTokenDecoderは Bean です (Spring はそれらをコンフィギュラーの内部で作ります)。 TokenEndpointOidcIdTokenDecoderは署名をチェックする代わりに TLS を信頼します。サーバーでは、Spring と同じく、セキュリティスターターの Bean が署名をチェックします。- 発行者のメタデータの検索は公開されています (
ClientRegistrations.configurationForIssuerLocation)。Spring のものは内部的なものです。
追加されたもの
- Sign in with Apple:
CommonOAuth2Provider.apple、response-mode(ResponseMode)、OAuth2AuthorizationResponse.fromParameters、OAuth2ClientSecretResolver、JwtClientSecretとJwtClientSecretResolver(client-secret-jwt.*)、native-sign-in、JwkSetOidcIdTokenDecoder。コードのトークンリクエストは、認可リクエストにredirect_uriがなかった場合にはそれを省きます。 - クライアント側の DPoP:
dpopプロパティ、DPoPKey、SoftwareDPoPKey、DPoPProofBuilder、ECDSA.transcodeSignatureToConcat、そしてトークンクライアント、ユーザーサービス、Feign のインターセプターの DPoP の部分。 OAuth2AccessTokenErrorDecoder: 401 は Feign のトークンを期限切れとしてマークします。OAuth2AccessTokenHeaders: スターターが行わないリクエストのためのトークンのヘッダー。
まだサポートされていないもの
oauth2Login()そのもの (セキュリティスターターのもの)。private_key_jwtとclient_secret_jwt(client_assertion)、tls_client_auth。- パスワード、デバイス、トークン交換 (RFC 8693)、JWT Bearer (RFC 7523) のグラント。
- HTTP クライアントの
@ClientRegistrationId。 - データベースを使う認可済みクライアントのサービス。
- Web での WebCrypto の DPoP の鍵、
use_dpop_nonceで応答された Feign の呼び出しのリトライ。