2021-10-29 13:06:38 -06:00
= OAuth 2.0 Resource Server Opaque Token
[[webflux-oauth2resourceserver-opaque-minimaldependencies]]
== Minimal Dependencies for Introspection
2021-12-13 16:57:36 -06:00
As described in xref:servlet/oauth2/resource-server/jwt.adoc#oauth2resourceserver-jwt-minimaldependencies[Minimal Dependencies for JWT], most Resource Server support is collected in `spring-security-oauth2-resource-server`.
However, unless you provide a custom <<webflux-oauth2resourceserver-opaque-introspector-bean,`ReactiveOpaqueTokenIntrospector`>>, the Resource Server falls back to `ReactiveOpaqueTokenIntrospector`.
This means that both `spring-security-oauth2-resource-server` and `oauth2-oidc-sdk` are necessary to have a working minimal Resource Server that supports opaque Bearer Tokens.
See `spring-security-oauth2-resource-server` in order to determine the correct version for `oauth2-oidc-sdk`.
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-minimalconfiguration]]
== Minimal Configuration for Introspection
2021-12-13 16:57:36 -06:00
Typically, you can verify an opaque token with an https://tools.ietf.org/html/rfc7662[OAuth 2.0 Introspection Endpoint], hosted by the authorization server.
2021-10-29 13:06:38 -06:00
This can be handy when revocation is a requirement.
2021-12-13 16:57:36 -06:00
When using https://spring.io/projects/spring-boot[Spring Boot], configuring an application as a resource server that uses introspection consists of two steps:
. Include the needed dependencies.
. Indicate the introspection endpoint details.
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-introspectionuri]]
=== Specifying the Authorization Server
2021-12-13 16:57:36 -06:00
You can specify where the introspection endpoint is:
2021-10-29 13:06:38 -06:00
[source,yaml]
----
2022-05-31 11:04:01 -03:00
spring:
security:
oauth2:
resourceserver:
opaque-token:
introspection-uri: https://idp.example.com/introspect
client-id: client
client-secret: secret
2021-10-29 13:06:38 -06:00
----
Where `https://idp.example.com/introspect` is the introspection endpoint hosted by your authorization server and `client-id` and `client-secret` are the credentials needed to hit that endpoint.
2021-12-13 16:57:36 -06:00
Resource Server uses these properties to further self-configure and subsequently validate incoming JWTs.
2021-10-29 13:06:38 -06:00
[NOTE]
2021-12-13 16:57:36 -06:00
====
2021-10-29 13:06:38 -06:00
If the authorization server responses that the token is valid, then it is.
2021-12-13 16:57:36 -06:00
====
2021-10-29 13:06:38 -06:00
=== Startup Expectations
2021-12-13 16:57:36 -06:00
When this property and these dependencies are used, Resource Server automatically configures itself to validate Opaque Bearer Tokens.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
This startup process is quite a bit simpler than for JWTs, since no endpoints need to be discovered and no additional validation rules get added.
2021-10-29 13:06:38 -06:00
=== Runtime Expectations
2021-12-13 16:57:36 -06:00
Once the application has started, Resource Server tries to process any request containing an `Authorization: Bearer` header:
2021-10-29 13:06:38 -06:00
[source,http]
----
GET / HTTP/1.1
Authorization: Bearer some-token-value # Resource Server will process this
----
2021-12-13 16:57:36 -06:00
So long as this scheme is indicated, Resource Server tries to process the request according to the Bearer Token specification.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
Given an Opaque Token, Resource Server:
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
. Queries the provided introspection endpoint by using the provided credentials and the token.
. Inspects the response for an `{ 'active' : true }` attribute.
. Maps each scope to an authority with a prefix of `SCOPE_`.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
By default, the resulting `Authentication#getPrincipal` is a Spring Security `{security-api-url}org/springframework/security/oauth2/core/OAuth2AuthenticatedPrincipal.html[OAuth2AuthenticatedPrincipal]` object, and `Authentication#getName` maps to the token's `sub` property, if one is present.
2021-10-29 13:06:38 -06:00
From here, you may want to jump to:
2021-12-13 16:57:36 -06:00
* <<webflux-oauth2resourceserver-opaque-attributes>>
* <<webflux-oauth2resourceserver-opaque-authorization-extraction>>
* <<webflux-oauth2resourceserver-opaque-jwt-introspector>>
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-attributes]]
2021-12-13 16:57:36 -06:00
== Looking Up Attributes After Authentication
2021-10-29 13:06:38 -06:00
Once a token is authenticated, an instance of `BearerTokenAuthentication` is set in the `SecurityContext`.
2021-12-13 16:57:36 -06:00
This means that it is available in `@Controller` methods when you use `@EnableWebFlux` in your configuration:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@GetMapping("/foo")
public Mono<String> foo(BearerTokenAuthentication authentication) {
return Mono.just(authentication.getTokenAttributes().get("sub") + " is the subject");
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@GetMapping("/foo")
fun foo(authentication: BearerTokenAuthentication): Mono<String> {
return Mono.just(authentication.tokenAttributes["sub"].toString() + " is the subject")
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
Since `BearerTokenAuthentication` holds an `OAuth2AuthenticatedPrincipal`, that also means that it's available to controller methods, too:
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@GetMapping("/foo")
public Mono<String> foo(@AuthenticationPrincipal OAuth2AuthenticatedPrincipal principal) {
return Mono.just(principal.getAttribute("sub") + " is the subject");
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@GetMapping("/foo")
fun foo(@AuthenticationPrincipal principal: OAuth2AuthenticatedPrincipal): Mono<String> {
return Mono.just(principal.getAttribute<Any>("sub").toString() + " is the subject")
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
=== Looking Up Attributes with SpEL
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
You can access attributes with the Spring Expression Language (SpEL).
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
For example, if you use `@EnableReactiveMethodSecurity` so that you can use `@PreAuthorize` annotations, you can do:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@PreAuthorize("principal?.attributes['sub'] = 'foo'")
public Mono<String> forFoosEyesOnly() {
return Mono.just("foo");
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@PreAuthorize("principal.attributes['sub'] = 'foo'")
fun forFoosEyesOnly(): Mono<String> {
return Mono.just("foo")
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-sansboot]]
== Overriding or Replacing Boot Auto Configuration
2021-12-13 16:57:36 -06:00
Spring Boot generates two `@Bean` instances for Resource Server.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
The first is a `SecurityWebFilterChain` that configures the application as a resource server.
When you use an Opaque Token, this `SecurityWebFilterChain` looks like:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
http
.authorizeExchange(exchanges -> exchanges
.anyExchange().authenticated()
)
.oauth2ResourceServer(ServerHttpSecurity.OAuth2ResourceServerSpec::opaqueToken)
return http.build();
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
return http {
authorizeExchange {
authorize(anyExchange, authenticated)
}
oauth2ResourceServer {
opaqueToken { }
}
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
If the application does not expose a `SecurityWebFilterChain` bean, Spring Boot exposes the default bean (shown in the preceding listing).
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
You can replace it by exposing the bean within the application:
2021-10-29 13:06:38 -06:00
.Replacing SecurityWebFilterChain
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
2023-10-02 17:25:46 -06:00
import static org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope;
2022-07-30 03:47:02 +02:00
@Configuration
2021-10-29 13:06:38 -06:00
@EnableWebFluxSecurity
public class MyCustomSecurityConfiguration {
@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
http
.authorizeExchange(exchanges -> exchanges
2023-10-02 17:25:46 -06:00
.pathMatchers("/messages/**").access(hasScope("message:read"))
2021-10-29 13:06:38 -06:00
.anyExchange().authenticated()
)
.oauth2ResourceServer(oauth2 -> oauth2
.opaqueToken(opaqueToken -> opaqueToken
.introspector(myIntrospector())
)
);
return http.build();
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
2023-10-02 17:25:46 -06:00
import org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope
2021-10-29 13:06:38 -06:00
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
return http {
authorizeExchange {
2023-10-02 17:25:46 -06:00
authorize("/messages/**", hasScope("message:read"))
2021-10-29 13:06:38 -06:00
authorize(anyExchange, authenticated)
}
oauth2ResourceServer {
opaqueToken {
introspector = myIntrospector()
}
}
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
The preceding example requires the scope of `message:read` for any URL that starts with `/messages/`.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
Methods on the `oauth2ResourceServer` DSL also override or replace auto configuration.
2021-10-29 13:06:38 -06:00
For example, the second `@Bean` Spring Boot creates is a `ReactiveOpaqueTokenIntrospector`, which decodes `String` tokens into validated instances of `OAuth2AuthenticatedPrincipal`:
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@Bean
public ReactiveOpaqueTokenIntrospector introspector() {
return new NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret);
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun introspector(): ReactiveOpaqueTokenIntrospector {
return NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
If the application does not expose a `ReactiveOpaqueTokenIntrospector` bean, Spring Boot exposes the default one (shown in the preceding listing).
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
You can override its configuration by using `introspectionUri()` and `introspectionClientCredentials()` or replace it by using `introspector()`.
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-introspectionuri-dsl]]
=== Using `introspectionUri()`
2021-12-13 16:57:36 -06:00
You can configure an authorization server's Introspection URI <<webflux-oauth2resourceserver-opaque-introspectionuri,as a configuration property>>, or you can supply in the DSL:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
2022-07-30 03:47:02 +02:00
@Configuration
2021-10-29 13:06:38 -06:00
@EnableWebFluxSecurity
public class DirectlyConfiguredIntrospectionUri {
@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
http
.authorizeExchange(exchanges -> exchanges
.anyExchange().authenticated()
)
.oauth2ResourceServer(oauth2 -> oauth2
.opaqueToken(opaqueToken -> opaqueToken
.introspectionUri("https://idp.example.com/introspect")
.introspectionClientCredentials("client", "secret")
)
);
return http.build();
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
return http {
authorizeExchange {
authorize(anyExchange, authenticated)
}
oauth2ResourceServer {
opaqueToken {
introspectionUri = "https://idp.example.com/introspect"
introspectionClientCredentials("client", "secret")
}
}
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
Using `introspectionUri()` takes precedence over any configuration property.
[[webflux-oauth2resourceserver-opaque-introspector-dsl]]
=== Using `introspector()`
2021-12-13 16:57:36 -06:00
`introspector()` is more powerful than `introspectionUri()`. It completely replaces any Boot auto-configuration of `ReactiveOpaqueTokenIntrospector`:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
2022-07-30 03:47:02 +02:00
@Configuration
2021-10-29 13:06:38 -06:00
@EnableWebFluxSecurity
public class DirectlyConfiguredIntrospector {
@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
http
.authorizeExchange(exchanges -> exchanges
.anyExchange().authenticated()
)
.oauth2ResourceServer(oauth2 -> oauth2
.opaqueToken(opaqueToken -> opaqueToken
.introspector(myCustomIntrospector())
)
);
return http.build();
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
return http {
authorizeExchange {
authorize(anyExchange, authenticated)
}
oauth2ResourceServer {
opaqueToken {
introspector = myCustomIntrospector()
}
}
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
This is handy when deeper configuration, such as <<webflux-oauth2resourceserver-opaque-authorization-extraction,authority mapping>>or <<webflux-oauth2resourceserver-opaque-jwt-introspector,JWT revocation>>, is necessary.
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-introspector-bean]]
=== Exposing a `ReactiveOpaqueTokenIntrospector` `@Bean`
Or, exposing a `ReactiveOpaqueTokenIntrospector` `@Bean` has the same effect as `introspector()`:
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@Bean
public ReactiveOpaqueTokenIntrospector introspector() {
return new NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret);
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun introspector(): ReactiveOpaqueTokenIntrospector {
return NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-authorization]]
== Configuring Authorization
2021-12-13 16:57:36 -06:00
An OAuth 2.0 Introspection endpoint typically returns a `scope` attribute, indicating the scopes (or authorities) it has been granted -- for example:
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
[source,json]
----
{ ..., "scope" : "messages contacts"}
----
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
When this is the case, Resource Server tries to coerce these scopes into a list of granted authorities, prefixing each scope with a string: `SCOPE_`.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
This means that, to protect an endpoint or method with a scope derived from an Opaque Token, the corresponding expressions should include this prefix:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
2023-10-02 17:25:46 -06:00
import static org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope;
2022-07-30 03:47:02 +02:00
@Configuration
2021-10-29 13:06:38 -06:00
@EnableWebFluxSecurity
public class MappedAuthorities {
@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
http
.authorizeExchange(exchange -> exchange
2023-10-02 17:25:46 -06:00
.pathMatchers("/contacts/**").access(hasScope("contacts"))
.pathMatchers("/messages/**").access(hasScope("messages"))
2021-10-29 13:06:38 -06:00
.anyExchange().authenticated()
)
.oauth2ResourceServer(ServerHttpSecurity.OAuth2ResourceServerSpec::opaqueToken);
return http.build();
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
2023-10-02 17:25:46 -06:00
import org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope
2021-10-29 13:06:38 -06:00
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
return http {
authorizeExchange {
2023-10-02 17:25:46 -06:00
authorize("/contacts/**", hasScope("contacts"))
authorize("/messages/**", hasScope("messages"))
2021-10-29 13:06:38 -06:00
authorize(anyExchange, authenticated)
}
oauth2ResourceServer {
opaqueToken { }
}
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
You can do something similar with method security:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
public Flux<Message> getMessages(...) {}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@PreAuthorize("hasAuthority('SCOPE_messages')")
fun getMessages(): Flux<Message> { }
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-authorization-extraction]]
=== Extracting Authorities Manually
2021-12-13 16:57:36 -06:00
By default, Opaque Token support extracts the scope claim from an introspection response and parses it into individual `GrantedAuthority` instances.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
Consider the following example:
2021-10-29 13:06:38 -06:00
[source,json]
----
{
"active" : true,
"scope" : "message:read message:write"
}
----
2021-12-13 16:57:36 -06:00
If the introspection response were as the preceding example shows, Resource Server would generate an `Authentication` with two authorities, one for `message:read` and the other for `message:write`.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
You can customize behavior by using a custom `ReactiveOpaqueTokenIntrospector` that looks at the attribute set and converts in its own way:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
public class CustomAuthoritiesOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
private ReactiveOpaqueTokenIntrospector delegate =
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
public Mono<OAuth2AuthenticatedPrincipal> introspect(String token) {
return this.delegate.introspect(token)
.map(principal -> new DefaultOAuth2AuthenticatedPrincipal(
principal.getName(), principal.getAttributes(), extractAuthorities(principal)));
}
private Collection<GrantedAuthority> extractAuthorities(OAuth2AuthenticatedPrincipal principal) {
List<String> scopes = principal.getAttribute(OAuth2IntrospectionClaimNames.SCOPE);
return scopes.stream()
.map(SimpleGrantedAuthority::new)
.collect(Collectors.toList());
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
class CustomAuthoritiesOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
override fun introspect(token: String): Mono<OAuth2AuthenticatedPrincipal> {
return delegate.introspect(token)
.map { principal: OAuth2AuthenticatedPrincipal ->
DefaultOAuth2AuthenticatedPrincipal(
principal.name, principal.attributes, extractAuthorities(principal))
}
}
private fun extractAuthorities(principal: OAuth2AuthenticatedPrincipal): Collection<GrantedAuthority> {
val scopes = principal.getAttribute<List<String>>(OAuth2IntrospectionClaimNames.SCOPE)
return scopes
.map { SimpleGrantedAuthority(it) }
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
Thereafter, you can configure this custom introspector by exposing it as a `@Bean`:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@Bean
public ReactiveOpaqueTokenIntrospector introspector() {
return new CustomAuthoritiesOpaqueTokenIntrospector();
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun introspector(): ReactiveOpaqueTokenIntrospector {
return CustomAuthoritiesOpaqueTokenIntrospector()
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-jwt-introspector]]
== Using Introspection with JWTs
A common question is whether or not introspection is compatible with JWTs.
2021-12-13 16:57:36 -06:00
Spring Security's Opaque Token support has been designed to not care about the format of the token. It gladly passes any token to the provided introspection endpoint.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
So, suppose you need to check with the authorization server on each request, in case the JWT has been revoked.
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
Even though you are using the JWT format for the token, your validation method is introspection, meaning you would want to do:
2021-10-29 13:06:38 -06:00
[source,yaml]
----
spring:
security:
oauth2:
resourceserver:
opaque-token:
introspection-uri: https://idp.example.org/introspection
client-id: client
client-secret: secret
----
In this case, the resulting `Authentication` would be `BearerTokenAuthentication`.
Any attributes in the corresponding `OAuth2AuthenticatedPrincipal` would be whatever was returned by the introspection endpoint.
2021-12-13 16:57:36 -06:00
However, suppose that, for whatever reason, the introspection endpoint returns only whether or not the token is active.
2021-10-29 13:06:38 -06:00
Now what?
2021-12-13 16:57:36 -06:00
In this case, you can create a custom `ReactiveOpaqueTokenIntrospector` that still hits the endpoint but then updates the returned principal to have the JWTs claims as the attributes:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
public class JwtOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
private ReactiveOpaqueTokenIntrospector delegate =
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
private ReactiveJwtDecoder jwtDecoder = new NimbusReactiveJwtDecoder(new ParseOnlyJWTProcessor());
public Mono<OAuth2AuthenticatedPrincipal> introspect(String token) {
return this.delegate.introspect(token)
.flatMap(principal -> this.jwtDecoder.decode(token))
.map(jwt -> new DefaultOAuth2AuthenticatedPrincipal(jwt.getClaims(), NO_AUTHORITIES));
}
private static class ParseOnlyJWTProcessor implements Converter<JWT, Mono<JWTClaimsSet>> {
public Mono<JWTClaimsSet> convert(JWT jwt) {
try {
return Mono.just(jwt.getJWTClaimsSet());
} catch (Exception ex) {
return Mono.error(ex);
}
}
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
class JwtOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
private val jwtDecoder: ReactiveJwtDecoder = NimbusReactiveJwtDecoder(ParseOnlyJWTProcessor())
override fun introspect(token: String): Mono<OAuth2AuthenticatedPrincipal> {
return delegate.introspect(token)
.flatMap { jwtDecoder.decode(token) }
.map { jwt: Jwt -> DefaultOAuth2AuthenticatedPrincipal(jwt.claims, NO_AUTHORITIES) }
}
private class ParseOnlyJWTProcessor : Converter<JWT, Mono<JWTClaimsSet>> {
override fun convert(jwt: JWT): Mono<JWTClaimsSet> {
return try {
Mono.just(jwt.jwtClaimsSet)
} catch (e: Exception) {
Mono.error(e)
}
}
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
Thereafter, you can configure this custom introspector by exposing it as a `@Bean`:
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@Bean
public ReactiveOpaqueTokenIntrospector introspector() {
return new JwtOpaqueTokenIntropsector();
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun introspector(): ReactiveOpaqueTokenIntrospector {
return JwtOpaqueTokenIntrospector()
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
[[webflux-oauth2resourceserver-opaque-userinfo]]
== Calling a `/userinfo` Endpoint
2021-12-13 16:57:36 -06:00
Generally speaking, a Resource Server does not care about the underlying user but, instead, cares about the authorities that have been granted.
2021-10-29 13:06:38 -06:00
That said, at times it can be valuable to tie the authorization statement back to a user.
2021-12-13 16:57:36 -06:00
If an application also uses `spring-security-oauth2-client`, having set up the appropriate `ClientRegistrationRepository`, you can do so with a custom `OpaqueTokenIntrospector`.
The implementation in the next listing does three things:
2021-10-29 13:06:38 -06:00
2021-12-13 16:57:36 -06:00
* Delegates to the introspection endpoint, to affirm the token's validity.
* Looks up the appropriate client registration associated with the `/userinfo` endpoint.
* Invokes and returns the response from the `/userinfo` endpoint.
2021-10-29 13:06:38 -06:00
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
private final ReactiveOpaqueTokenIntrospector delegate =
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
private final ReactiveOAuth2UserService<OAuth2UserRequest, OAuth2User> oauth2UserService =
new DefaultReactiveOAuth2UserService();
private final ReactiveClientRegistrationRepository repository;
// ... constructor
@Override
public Mono<OAuth2AuthenticatedPrincipal> introspect(String token) {
return Mono.zip(this.delegate.introspect(token), this.repository.findByRegistrationId("registration-id"))
.map(t -> {
OAuth2AuthenticatedPrincipal authorized = t.getT1();
ClientRegistration clientRegistration = t.getT2();
Instant issuedAt = authorized.getAttribute(ISSUED_AT);
Instant expiresAt = authorized.getAttribute(OAuth2IntrospectionClaimNames.EXPIRES_AT);
OAuth2AccessToken accessToken = new OAuth2AccessToken(BEARER, token, issuedAt, expiresAt);
return new OAuth2UserRequest(clientRegistration, accessToken);
})
.flatMap(this.oauth2UserService::loadUser);
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
private val oauth2UserService: ReactiveOAuth2UserService<OAuth2UserRequest, OAuth2User> = DefaultReactiveOAuth2UserService()
private val repository: ReactiveClientRegistrationRepository? = null
// ... constructor
override fun introspect(token: String?): Mono<OAuth2AuthenticatedPrincipal> {
return Mono.zip<OAuth2AuthenticatedPrincipal, ClientRegistration>(delegate.introspect(token), repository!!.findByRegistrationId("registration-id"))
.map<OAuth2UserRequest> { t: Tuple2<OAuth2AuthenticatedPrincipal, ClientRegistration> ->
val authorized = t.t1
val clientRegistration = t.t2
val issuedAt: Instant? = authorized.getAttribute(ISSUED_AT)
val expiresAt: Instant? = authorized.getAttribute(OAuth2IntrospectionClaimNames.EXPIRES_AT)
val accessToken = OAuth2AccessToken(BEARER, token, issuedAt, expiresAt)
OAuth2UserRequest(clientRegistration, accessToken)
}
.flatMap { userRequest: OAuth2UserRequest -> oauth2UserService.loadUser(userRequest) }
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
If you aren't using `spring-security-oauth2-client`, it's still quite simple.
You will simply need to invoke the `/userinfo` with your own instance of `WebClient`:
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
private final ReactiveOpaqueTokenIntrospector delegate =
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
private final WebClient rest = WebClient.create();
@Override
public Mono<OAuth2AuthenticatedPrincipal> introspect(String token) {
return this.delegate.introspect(token)
.map(this::makeUserInfoRequest);
}
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
private val rest: WebClient = WebClient.create()
override fun introspect(token: String): Mono<OAuth2AuthenticatedPrincipal> {
return delegate.introspect(token)
.map(this::makeUserInfoRequest)
}
}
----
2023-06-18 21:30:41 -05:00
======
2021-10-29 13:06:38 -06:00
Either way, having created your `ReactiveOpaqueTokenIntrospector`, you should publish it as a `@Bean` to override the defaults:
2023-06-18 21:30:41 -05:00
[tabs]
======
Java::
+
2021-10-29 13:06:38 -06:00
[source,java,role="primary"]
----
@Bean
ReactiveOpaqueTokenIntrospector introspector() {
return new UserInfoOpaqueTokenIntrospector();
}
----
2023-06-18 21:30:41 -05:00
Kotlin::
+
2021-10-29 13:06:38 -06:00
[source,kotlin,role="secondary"]
----
@Bean
fun introspector(): ReactiveOpaqueTokenIntrospector {
return UserInfoOpaqueTokenIntrospector()
}
----
2023-06-18 21:30:41 -05:00
======