Feign の呼び出しのトークン
spring.feign.oauth2.enabled=true にすると、すべての Feign クライアントがアクセストークンを送ります。セキュリティコンテキストのユーザーの Authorization: Bearer <token>、client_credentials の登録ではクライアントのものです。OAuth2AccessTokenInterceptor は呼び出しのたびに OAuth2AuthorizedClientManager からそれを取得するため、1 分以内に期限切れになる場合はリフレッシュされます。
使う理由
アプリの Feign クライアントはログイン中のユーザーとして API を呼び、サーバーのクライアントは自身のトークンで他のサービスを呼ぶべきです。それもクライアントにコードを書かずにです。一つのプロパティでこれが有効になり、トークンの扱い (リフレッシュ、期限切れ、失効したトークン) は一か所にとどまります。
例
spring.security.oauth2.client.registration.partner.client-id=shop
spring.security.oauth2.client.registration.partner.client-secret=${PARTNER_SECRET}
spring.security.oauth2.client.registration.partner.authorization-grant-type=client_credentials
spring.security.oauth2.client.provider.partner.token-uri=https://id.partner.example/oauth2/token
spring.feign.oauth2.enabled=true
spring.feign.oauth2.client-registration-id=partner
@FeignClient('orders', url: r'${partner.url}')
abstract interface class OrdersClient {
@GetMapping('/orders')
Future<List<Order>> orders(); // Authorization: Bearer <token>
}
プロパティ
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
spring.feign.oauth2.enabled |
bool |
false |
Feign クライアントが OAuth2 クライアントの登録のアクセストークンを送るかどうか。 |
spring.feign.oauth2.client-registration-id |
String |
なし: Feign クライアントの名前 | Feign クライアントがそのトークンを送る登録。 |
Spring Cloud の spring.cloud.openfeign.oauth2.* の名前は起動を止め、これらのキーを示します。
仕組み
- 登録は、Spring Cloud OpenFeign と同じく、
client-registration-id、なければ Feign クライアントの名前です。クライアント@FeignClient('partner')は登録partnerを使います。 - プリンシパルはセキュリティコンテキストの認証、なければ
anonymousUser(クライアントクレデンシャルのトークンのプリンシパル) です。 authorization_codeの登録で、誰もログインしていない間に行われた呼び出しはClientAuthorizationRequiredExceptionで失敗します。公開エンドポイントも呼ぶクライアントは、代わりに自身の@FeignClient(configuration:)で独自のインターセプターを宣言します。- DPoP にバインドされたトークンは、呼び出しごとに新しい証明とともに
Authorization: DPoP <token>として送られます (DPoP を参照)。 - インターセプターは試行のたびに実行されるため、リトライはリフレッシュされたトークンを運びます。
API が 401 で応答したとき
有効に見えたトークン (失効した、プロバイダーの鍵がローテーションされた) に API が 401 で応答すると、OAuth2AccessTokenErrorDecoder がそれを期限切れとしてマークするため、次の呼び出しでリフレッシュされます。失敗した呼び出しそのものは繰り返されません。Feign のインターセプターは応答を見ず、その ErrorDecoder と Retryer はアプリケーションのものだからです。
スターターがこのデコーダーを宣言するのは、アプリケーションに ErrorDecoder がない場合だけです。動作を保つには、独自のものを包んでください。
@Bean()
ErrorDecoder errorDecoder(OAuth2AccessTokenInterceptor tokens) =>
OAuth2AccessTokenErrorDecoder(MyErrorDecoder(), tokens);
DPoP では、デコーダーはエラー応答の DPoP-Nonce をサーバーごとに次の証明のために覚えておき、nonce だけを求める 401 ではトークンに手を触れません。
ログ
Feign の headers のログは Authorization と DPoP のヘッダーをマスクします。スターターの中の何物もトークンをログに出しません。
Spring (Java) との対応
spring.cloud.openfeign.oauth2.enabled: true
spring.cloud.openfeign.oauth2.clientRegistrationId: partner
spring.feign.oauth2 の下で、Spring Cloud OpenFeign の OAuth2AccessTokenInterceptor と同じ動作です。401 のエラーデコーダーと DPoP は追加されたものです。use_dpop_nonce で応答された呼び出しはまだ繰り返されません。