此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Security 6.4.1! |
OAuth 2.0 不记名令牌
Bearer Token 解析
默认情况下,Resource Server 在Authorization
页眉。
但是,这可以通过几种方式进行自定义。
从自定义标头读取 Bearer Token
例如,您可能需要从自定义标头中读取不记名令牌。
为此,您可以公开DefaultBearerTokenResolver
作为 Bean,或者将实例连接到 DSL 中,如以下示例所示:
-
Java
-
Kotlin
-
Xml
@Bean
BearerTokenResolver bearerTokenResolver() {
DefaultBearerTokenResolver bearerTokenResolver = new DefaultBearerTokenResolver();
bearerTokenResolver.setBearerTokenHeaderName(HttpHeaders.PROXY_AUTHORIZATION);
return bearerTokenResolver;
}
@Bean
fun bearerTokenResolver(): BearerTokenResolver {
val bearerTokenResolver = DefaultBearerTokenResolver()
bearerTokenResolver.setBearerTokenHeaderName(HttpHeaders.PROXY_AUTHORIZATION)
return bearerTokenResolver
}
<http>
<oauth2-resource-server bearer-token-resolver-ref="bearerTokenResolver"/>
</http>
<bean id="bearerTokenResolver"
class="org.springframework.security.oauth2.server.resource.web.DefaultBearerTokenResolver">
<property name="bearerTokenHeaderName" value="Proxy-Authorization"/>
</bean>
或者,在提供程序同时使用自定义标头和值的情况下,您可以使用HeaderBearerTokenResolver
相反。
从表单参数中读取 Bearer Token
或者,您可能希望从 form 参数中读取令牌,您可以通过配置DefaultBearerTokenResolver
,如下所示:
-
Java
-
Kotlin
-
Xml
DefaultBearerTokenResolver resolver = new DefaultBearerTokenResolver();
resolver.setAllowFormEncodedBodyParameter(true);
http
.oauth2ResourceServer(oauth2 -> oauth2
.bearerTokenResolver(resolver)
);
val resolver = DefaultBearerTokenResolver()
resolver.setAllowFormEncodedBodyParameter(true)
http {
oauth2ResourceServer {
bearerTokenResolver = resolver
}
}
<http>
<oauth2-resource-server bearer-token-resolver-ref="bearerTokenResolver"/>
</http>
<bean id="bearerTokenResolver"
class="org.springframework.security.oauth2.server.resource.web.HeaderBearerTokenResolver">
<property name="allowFormEncodedBodyParameter" value="true"/>
</bean>
Bearer Token 传播
现在,您的资源服务器已验证令牌,将其传递给下游服务可能会很方便。
这很简单,因为ServletBearerExchangeFilterFunction
,您可以在以下示例中看到:
-
Java
-
Kotlin
@Bean
public WebClient rest() {
return WebClient.builder()
.filter(new ServletBearerExchangeFilterFunction())
.build();
}
@Bean
fun rest(): WebClient {
return WebClient.builder()
.filter(ServletBearerExchangeFilterFunction())
.build()
}
当上述WebClient
用于执行请求,Spring Security 将查找当前的Authentication
并提取任何AbstractOAuth2Token
凭据。
然后,它将在Authorization
页眉。
例如:
-
Java
-
Kotlin
this.rest.get()
.uri("https://other-service.example.com/endpoint")
.retrieve()
.bodyToMono(String.class)
.block()
this.rest.get()
.uri("https://other-service.example.com/endpoint")
.retrieve()
.bodyToMono<String>()
.block()
将调用other-service.example.com/endpoint
,添加 Bearer TokenAuthorization
标头。
在需要覆盖此行为的地方,只需自己提供 Headers 即可,如下所示:
-
Java
-
Kotlin
this.rest.get()
.uri("https://other-service.example.com/endpoint")
.headers(headers -> headers.setBearerAuth(overridingToken))
.retrieve()
.bodyToMono(String.class)
.block()
this.rest.get()
.uri("https://other-service.example.com/endpoint")
.headers{ headers -> headers.setBearerAuth(overridingToken)}
.retrieve()
.bodyToMono<String>()
.block()
在这种情况下,过滤器将回退,只需将请求转发到 Web 过滤器链的其余部分。
与 OAuth 2.0 客户端筛选器函数不同,如果令牌过期,此筛选器函数不会尝试续订令牌。 要获得此级别的支持,请使用 OAuth 2.0 客户端过滤器。 |
RestTemplate
支持
没有RestTemplate
等效ServletBearerExchangeFilterFunction
目前,但您可以使用自己的拦截器非常简单地传播请求的 bearer token:
-
Java
-
Kotlin
@Bean
RestTemplate rest() {
RestTemplate rest = new RestTemplate();
rest.getInterceptors().add((request, body, execution) -> {
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
if (authentication == null) {
return execution.execute(request, body);
}
if (!(authentication.getCredentials() instanceof AbstractOAuth2Token)) {
return execution.execute(request, body);
}
AbstractOAuth2Token token = (AbstractOAuth2Token) authentication.getCredentials();
request.getHeaders().setBearerAuth(token.getTokenValue());
return execution.execute(request, body);
});
return rest;
}
@Bean
fun rest(): RestTemplate {
val rest = RestTemplate()
rest.interceptors.add(ClientHttpRequestInterceptor { request, body, execution ->
val authentication: Authentication? = SecurityContextHolder.getContext().authentication
if (authentication == null) {
return execution.execute(request, body)
}
if (authentication.credentials !is AbstractOAuth2Token) {
return execution.execute(request, body)
}
request.headers.setBearerAuth(authentication.credentials.tokenValue)
execution.execute(request, body)
})
return rest
}
与 OAuth 2.0 授权客户端管理器不同,如果令牌过期,此过滤器拦截器不会尝试更新令牌。 要获得此级别的支持,请使用 OAuth 2.0 Authorized Client Manager 创建一个拦截器。 |
Bearer Token 故障
持有者令牌可能由于多种原因而无效。例如,令牌可能不再有效。
在这些情况下,Resource Server 会抛出InvalidBearerTokenException
.
与其他异常一样,这会导致 OAuth 2.0 Bearer Token 错误响应:
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer error_code="invalid_token", error_description="Unsupported algorithm of none", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"
此外,它还作为AuthenticationFailureBadCredentialsEvent
,您可以在应用程序中监听它,如下所示:
-
Java
-
Kotlin
@Component
public class FailureEvents {
@EventListener
public void onFailure(AuthenticationFailureBadCredentialsEvent badCredentials) {
if (badCredentials.getAuthentication() instanceof BearerTokenAuthenticationToken) {
// ... handle
}
}
}
@Component
class FailureEvents {
@EventListener
fun onFailure(badCredentials: AuthenticationFailureBadCredentialsEvent) {
if (badCredentials.authentication is BearerTokenAuthenticationToken) {
// ... handle
}
}
}