1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057 |
- = OAuth 2.0 Resource Server JWT
- [[webflux-oauth2resourceserver-jwt-minimaldependencies]]
- == Minimal Dependencies for JWT
- Most Resource Server support is collected into `spring-security-oauth2-resource-server`.
- However, the support for decoding and verifying JWTs is in `spring-security-oauth2-jose`, meaning that both are necessary to have a working resource server that supports JWT-encoded Bearer Tokens.
- [[webflux-oauth2resourceserver-jwt-minimalconfiguration]]
- == Minimal Configuration for JWTs
- When using https://spring.io/projects/spring-boot[Spring Boot], configuring an application as a resource server consists of two basic steps.
- First, include the needed dependencies. Second, indicate the location of the authorization server.
- === Specifying the Authorization Server
- In a Spring Boot application, you need to specify which authorization server to use:
- [source,yml]
- ----
- spring:
- security:
- oauth2:
- resourceserver:
- jwt:
- issuer-uri: https://idp.example.com/issuer
- ----
- Where `https://idp.example.com/issuer` is the value contained in the `iss` claim for JWT tokens that the authorization server issues.
- This resource server uses this property to further self-configure, discover the authorization server's public keys, and subsequently validate incoming JWTs.
- [NOTE]
- ====
- To use the `issuer-uri` property, it must also be true that one of `https://idp.example.com/issuer/.well-known/openid-configuration`, `https://idp.example.com/.well-known/openid-configuration/issuer`, or `https://idp.example.com/.well-known/oauth-authorization-server/issuer` is a supported endpoint for the authorization server.
- This endpoint is referred to as a https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig[Provider Configuration] endpoint or a https://tools.ietf.org/html/rfc8414#section-3[Authorization Server Metadata] endpoint.
- ====
- === Startup Expectations
- When this property and these dependencies are used, Resource Server automatically configures itself to validate JWT-encoded Bearer Tokens.
- It achieves this through a deterministic startup process:
- . Hit the Provider Configuration or Authorization Server Metadata endpoint, processing the response for the `jwks_url` property.
- . Configure the validation strategy to query `jwks_url` for valid public keys.
- . Configure the validation strategy to validate each JWT's `iss` claim against `https://idp.example.com`.
- A consequence of this process is that the authorization server must be receiving requests in order for Resource Server to successfully start up.
- [NOTE]
- ====
- If the authorization server is down when Resource Server queries it (given appropriate timeouts), then startup fails.
- ====
- === Runtime Expectations
- Once the application is started up, Resource Server tries to process any request that contains an `Authorization: Bearer` header:
- [source,html]
- ----
- GET / HTTP/1.1
- Authorization: Bearer some-token-value # Resource Server will process this
- ----
- So long as this scheme is indicated, Resource Server tries to process the request according to the Bearer Token specification.
- Given a well-formed JWT, Resource Server:
- . Validates its signature against a public key obtained from the `jwks_url` endpoint during startup and matched against the JWTs header.
- . Validates the JWTs `exp` and `nbf` timestamps and the JWTs `iss` claim.
- . Maps each scope to an authority with the prefix `SCOPE_`.
- [NOTE]
- ====
- As the authorization server makes available new keys, Spring Security automatically rotates the keys used to validate the JWT tokens.
- ====
- By default, the resulting `Authentication#getPrincipal` is a Spring Security `Jwt` object, and `Authentication#getName` maps to the JWT's `sub` property, if one is present.
- From here, consider jumping to:
- * <<webflux-oauth2resourceserver-jwt-jwkseturi,How to Configure without Tying Resource Server startup to an authorization server's availability>>
- * <<webflux-oauth2resourceserver-jwt-sansboot,How to Configure without Spring Boot>>
- [[webflux-oauth2resourceserver-jwt-jwkseturi]]
- === Specifying the Authorization Server JWK Set Uri Directly
- If the authorization server does not support any configuration endpoints, or if Resource Server must be able to start up independently from the authorization server, you can supply `jwk-set-uri` as well:
- [source,yaml]
- ----
- spring:
- security:
- oauth2:
- resourceserver:
- jwt:
- issuer-uri: https://idp.example.com
- jwk-set-uri: https://idp.example.com/.well-known/jwks.json
- ----
- [NOTE]
- ====
- The JWK Set uri is not standardized, but you can typically find it in the authorization server's documentation.
- ====
- Consequently, Resource Server does not ping the authorization server at startup.
- We still specify the `issuer-uri` so that Resource Server still validates the `iss` claim on incoming JWTs.
- [NOTE]
- ====
- You can supply this property directly on the <<webflux-oauth2resourceserver-jwt-jwkseturi-dsl,DSL>>.
- ====
- [[webflux-oauth2resourceserver-jwt-sansboot]]
- === Overriding or Replacing Boot Auto Configuration
- Spring Boot generates two `@Bean` objects on Resource Server's behalf.
- The first bean is a `SecurityWebFilterChain` that configures the application as a resource server. When including `spring-security-oauth2-jose`, this `SecurityWebFilterChain` looks like:
- .Resource Server SecurityWebFilterChain
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange((exchanges) -> exchanges
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer(OAuth2ResourceServerSpec::jwt)
- return http.build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize(anyExchange, authenticated)
- }
- oauth2ResourceServer {
- jwt { }
- }
- }
- }
- ----
- ======
- If the application does not expose a `SecurityWebFilterChain` bean, Spring Boot exposes the default one (shown in the preceding listing).
- To replace it, expose the `@Bean` within the application:
- .Replacing SecurityWebFilterChain
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- import static org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope;
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange((exchanges) -> exchanges
- .pathMatchers("/message/**").access(hasScope("message:read"))
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer((oauth2) -> oauth2
- .jwt(withDefaults())
- );
- return http.build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- import org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize("/message/**", hasScope("message:read"))
- authorize(anyExchange, authenticated)
- }
- oauth2ResourceServer {
- jwt { }
- }
- }
- }
- ----
- ======
- The preceding configuration requires the scope of `message:read` for any URL that starts with `/messages/`.
- Methods on the `oauth2ResourceServer` DSL also override or replace auto configuration.
- For example, the second `@Bean` Spring Boot creates is a `ReactiveJwtDecoder`, which decodes `String` tokens into validated instances of `Jwt`:
- .ReactiveJwtDecoder
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- public ReactiveJwtDecoder jwtDecoder() {
- return ReactiveJwtDecoders.fromIssuerLocation(issuerUri);
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return ReactiveJwtDecoders.fromIssuerLocation(issuerUri)
- }
- ----
- ======
- [NOTE]
- ====
- Calling javadoc:org.springframework.security.oauth2.jwt.ReactiveJwtDecoders#fromIssuerLocation-java.lang.String-[ReactiveJwtDecoders#fromIssuerLocation] invokes the Provider Configuration or Authorization Server Metadata endpoint to derive the JWK Set URI.
- If the application does not expose a `ReactiveJwtDecoder` bean, Spring Boot exposes the above default one.
- ====
- Its configuration can be overridden by using `jwkSetUri()` or replaced by using `decoder()`.
- [[webflux-oauth2resourceserver-jwt-jwkseturi-dsl]]
- ==== Using `jwkSetUri()`
- You can configure an authorization server's JWK Set URI <<webflux-oauth2resourceserver-jwt-jwkseturi,as a configuration property>> or supply it in the DSL:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange((exchanges) -> exchanges
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer((oauth2) -> oauth2
- .jwt((jwt) -> jwt
- .jwkSetUri("https://idp.example.com/.well-known/jwks.json")
- )
- );
- return http.build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize(anyExchange, authenticated)
- }
- oauth2ResourceServer {
- jwt {
- jwkSetUri = "https://idp.example.com/.well-known/jwks.json"
- }
- }
- }
- }
- ----
- ======
- Using `jwkSetUri()` takes precedence over any configuration property.
- [[webflux-oauth2resourceserver-jwt-decoder-dsl]]
- ==== Using `decoder()`
- `decoder()` is more powerful than `jwkSetUri()`, because it completely replaces any Spring Boot auto-configuration of `JwtDecoder`:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange((exchanges) -> exchanges
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer((oauth2) -> oauth2
- .jwt((jwt) -> jwt
- .decoder(myCustomDecoder())
- )
- );
- return http.build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize(anyExchange, authenticated)
- }
- oauth2ResourceServer {
- jwt {
- jwtDecoder = myCustomDecoder()
- }
- }
- }
- }
- ----
- ======
- This is handy when you need deeper configuration, such as <<webflux-oauth2resourceserver-jwt-validation,validation>>.
- [[webflux-oauth2resourceserver-decoder-bean]]
- ==== Exposing a `ReactiveJwtDecoder` `@Bean`
- Alternately, exposing a `ReactiveJwtDecoder` `@Bean` has the same effect as `decoder()`:
- You can construct one with a `jwkSetUri` like so:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- public ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withJwkSetUri(jwkSetUri).build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withJwkSetUri(jwkSetUri).build()
- }
- ----
- ======
- or you can use the issuer and have `NimbusReactiveJwtDecoder` look up the `jwkSetUri` when `build()` is invoked, like the following:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- public ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withIssuerLocation(issuer).build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withIssuerLocation(issuer).build()
- }
- ----
- ======
- Or, if the defaults work for you, you can also use `JwtDecoders`, which does the above in addition to configuring the decoder's validator:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- public ReactiveJwtDecoder jwtDecoder() {
- return ReactiveJwtDecoders.fromIssuerLocation(issuer);
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return ReactiveJwtDecoders.fromIssuerLocation(issuer)
- }
- ----
- ======
- [[webflux-oauth2resourceserver-jwt-decoder-algorithm]]
- == Configuring Trusted Algorithms
- By default, `NimbusReactiveJwtDecoder`, and hence Resource Server, trust and verify only tokens that use `RS256`.
- You can customize this behavior with <<webflux-oauth2resourceserver-jwt-boot-algorithm,Spring Boot>> or by using <<webflux-oauth2resourceserver-jwt-decoder-builder,the NimbusJwtDecoder builder>>.
- [[webflux-oauth2resourceserver-jwt-boot-algorithm]]
- === Customizing Trusted Algorithms with Spring Boot
- The simplest way to set the algorithm is as a property:
- [source,yaml]
- ----
- spring:
- security:
- oauth2:
- resourceserver:
- jwt:
- jws-algorithms: RS512
- jwk-set-uri: https://idp.example.org/.well-known/jwks.json
- ----
- [[webflux-oauth2resourceserver-jwt-decoder-builder]]
- === Customizing Trusted Algorithms by Using a Builder
- For greater power, though, we can use a builder that ships with `NimbusReactiveJwtDecoder`:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
- .jwsAlgorithm(RS512).build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
- .jwsAlgorithm(RS512).build()
- }
- ----
- ======
- Calling `jwsAlgorithm` more than once configures `NimbusReactiveJwtDecoder` to trust more than one algorithm:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
- .jwsAlgorithm(RS512).jwsAlgorithm(ES512).build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
- .jwsAlgorithm(RS512).jwsAlgorithm(ES512).build()
- }
- ----
- ======
- Alternately, you can call `jwsAlgorithms`:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withIssuerLocation(this.jwkSetUri)
- .jwsAlgorithms(algorithms -> {
- algorithms.add(RS512);
- algorithms.add(ES512);
- }).build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withIssuerLocation(this.jwkSetUri)
- .jwsAlgorithms {
- it.add(RS512)
- it.add(ES512)
- }
- .build()
- }
- ----
- ======
- [[webflux-oauth2resourceserver-jwt-decoder-public-key]]
- === Trusting a Single Asymmetric Key
- Simpler than backing a Resource Server with a JWK Set endpoint is to hard-code an RSA public key.
- The public key can be provided with <<webflux-oauth2resourceserver-jwt-decoder-public-key-boot,Spring Boot>> or by <<webflux-oauth2resourceserver-jwt-decoder-public-key-builder,Using a Builder>>.
- [[webflux-oauth2resourceserver-jwt-decoder-public-key-boot]]
- ==== Via Spring Boot
- You can specify a key with Spring Boot:
- [source,yaml]
- ----
- spring:
- security:
- oauth2:
- resourceserver:
- jwt:
- public-key-location: classpath:my-key.pub
- ----
- Alternately, to allow for a more sophisticated lookup, you can post-process the `RsaKeyConversionServicePostProcessor`:
- .BeanFactoryPostProcessor
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- BeanFactoryPostProcessor conversionServiceCustomizer() {
- return beanFactory ->
- beanFactory.getBean(RsaKeyConversionServicePostProcessor.class)
- .setResourceLoader(new CustomResourceLoader());
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun conversionServiceCustomizer(): BeanFactoryPostProcessor {
- return BeanFactoryPostProcessor { beanFactory: ConfigurableListableBeanFactory ->
- beanFactory.getBean<RsaKeyConversionServicePostProcessor>()
- .setResourceLoader(CustomResourceLoader())
- }
- }
- ----
- ======
- Specify your key's location:
- [source,yaml]
- ----
- key.location: hfds://my-key.pub
- ----
- Then autowire the value:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Value("${key.location}")
- RSAPublicKey key;
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Value("\${key.location}")
- val key: RSAPublicKey? = null
- ----
- ======
- [[webflux-oauth2resourceserver-jwt-decoder-public-key-builder]]
- ==== Using a Builder
- To wire an `RSAPublicKey` directly, use the appropriate `NimbusReactiveJwtDecoder` builder:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- public ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withPublicKey(this.key).build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withPublicKey(key).build()
- }
- ----
- ======
- [[webflux-oauth2resourceserver-jwt-decoder-secret-key]]
- === Trusting a Single Symmetric Key
- You can also use a single symmetric key.
- You can load in your `SecretKey` and use the appropriate `NimbusReactiveJwtDecoder` builder:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- public ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withSecretKey(this.key).build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withSecretKey(this.key).build()
- }
- ----
- ======
- [[webflux-oauth2resourceserver-jwt-authorization]]
- === Configuring Authorization
- A JWT that is issued from an OAuth 2.0 Authorization Server typically has either a `scope` or an `scp` attribute, indicating the scopes (or authorities) it has been granted -- for example:
- [source,json]
- ----
- { ..., "scope" : "messages contacts"}
- ----
- When this is the case, Resource Server tries to coerce these scopes into a list of granted authorities, prefixing each scope with the string, `SCOPE_`.
- This means that, to protect an endpoint or method with a scope derived from a JWT, the corresponding expressions should include this prefix:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- import static org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope;
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange((exchanges) -> exchanges
- .mvcMatchers("/contacts/**").access(hasScope("contacts"))
- .mvcMatchers("/messages/**").access(hasScope("messages"))
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer(OAuth2ResourceServerSpec::jwt);
- return http.build();
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- import org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize("/contacts/**", hasScope("contacts"))
- authorize("/messages/**", hasScope("messages"))
- authorize(anyExchange, authenticated)
- }
- oauth2ResourceServer {
- jwt { }
- }
- }
- }
- ----
- ======
- You can do something similar with method security:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @PreAuthorize("hasAuthority('SCOPE_messages')")
- public Flux<Message> getMessages(...) {}
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @PreAuthorize("hasAuthority('SCOPE_messages')")
- fun getMessages(): Flux<Message> { }
- ----
- ======
- [[webflux-oauth2resourceserver-jwt-authorization-extraction]]
- ==== Extracting Authorities Manually
- However, there are a number of circumstances where this default is insufficient.
- For example, some authorization servers do not use the `scope` attribute. Instead, they have their own custom attribute.
- At other times, the resource server may need to adapt the attribute or a composition of attributes into internalized authorities.
- To this end, the DSL exposes `jwtAuthenticationConverter()`:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange((exchanges) -> exchanges
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer((oauth2) -> oauth2
- .jwt((jwt) -> jwt
- .jwtAuthenticationConverter(grantedAuthoritiesExtractor())
- )
- );
- return http.build();
- }
- Converter<Jwt, Mono<AbstractAuthenticationToken>> grantedAuthoritiesExtractor() {
- JwtAuthenticationConverter jwtAuthenticationConverter =
- new JwtAuthenticationConverter();
- jwtAuthenticationConverter.setJwtGrantedAuthoritiesConverter
- (new GrantedAuthoritiesExtractor());
- return new ReactiveJwtAuthenticationConverterAdapter(jwtAuthenticationConverter);
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize(anyExchange, authenticated)
- }
- oauth2ResourceServer {
- jwt {
- jwtAuthenticationConverter = grantedAuthoritiesExtractor()
- }
- }
- }
- }
- fun grantedAuthoritiesExtractor(): Converter<Jwt, Mono<AbstractAuthenticationToken>> {
- val jwtAuthenticationConverter = JwtAuthenticationConverter()
- jwtAuthenticationConverter.setJwtGrantedAuthoritiesConverter(GrantedAuthoritiesExtractor())
- return ReactiveJwtAuthenticationConverterAdapter(jwtAuthenticationConverter)
- }
- ----
- ======
- `jwtAuthenticationConverter()` is responsible for converting a `Jwt` into an `Authentication`.
- As part of its configuration, we can supply a subsidiary converter to go from `Jwt` to a `Collection` of granted authorities.
- That final converter might be something like the following `GrantedAuthoritiesExtractor`:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- static class GrantedAuthoritiesExtractor
- implements Converter<Jwt, Collection<GrantedAuthority>> {
- public Collection<GrantedAuthority> convert(Jwt jwt) {
- Collection<?> authorities = (Collection<?>)
- jwt.getClaims().getOrDefault("mycustomclaim", Collections.emptyList());
- return authorities.stream()
- .map(Object::toString)
- .map(SimpleGrantedAuthority::new)
- .collect(Collectors.toList());
- }
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- internal class GrantedAuthoritiesExtractor : Converter<Jwt, Collection<GrantedAuthority>> {
- override fun convert(jwt: Jwt): Collection<GrantedAuthority> {
- val authorities: List<Any> = jwt.claims
- .getOrDefault("mycustomclaim", emptyList<Any>()) as List<Any>
- return authorities
- .map { it.toString() }
- .map { SimpleGrantedAuthority(it) }
- }
- }
- ----
- ======
- For more flexibility, the DSL supports entirely replacing the converter with any class that implements `Converter<Jwt, Mono<AbstractAuthenticationToken>>`:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- static class CustomAuthenticationConverter implements Converter<Jwt, Mono<AbstractAuthenticationToken>> {
- public AbstractAuthenticationToken convert(Jwt jwt) {
- return Mono.just(jwt).map(this::doConversion);
- }
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- internal class CustomAuthenticationConverter : Converter<Jwt, Mono<AbstractAuthenticationToken>> {
- override fun convert(jwt: Jwt): Mono<AbstractAuthenticationToken> {
- return Mono.just(jwt).map(this::doConversion)
- }
- }
- ----
- ======
- [[webflux-oauth2resourceserver-jwt-validation]]
- === Configuring Validation
- Using <<webflux-oauth2resourceserver-jwt-minimalconfiguration,minimal Spring Boot configuration>>, indicating the authorization server's issuer URI, Resource Server defaults to verifying the `iss` claim as well as the `exp` and `nbf` timestamp claims.
- In circumstances where you need to customize validation needs, Resource Server ships with two standard validators and also accepts custom `OAuth2TokenValidator` instances.
- [[webflux-oauth2resourceserver-jwt-validation-clockskew]]
- ==== Customizing Timestamp Validation
- JWT instances typically have a window of validity, with the start of the window indicated in the `nbf` claim and the end indicated in the `exp` claim.
- However, every server can experience clock drift, which can cause tokens to appear to be expired to one server but not to another.
- This can cause some implementation heartburn, as the number of collaborating servers increases in a distributed system.
- Resource Server uses `JwtTimestampValidator` to verify a token's validity window, and you can configure it with a `clockSkew` to alleviate the clock drift problem:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- NimbusReactiveJwtDecoder jwtDecoder = (NimbusReactiveJwtDecoder)
- ReactiveJwtDecoders.fromIssuerLocation(issuerUri);
- OAuth2TokenValidator<Jwt> withClockSkew = new DelegatingOAuth2TokenValidator<>(
- new JwtTimestampValidator(Duration.ofSeconds(60)),
- new IssuerValidator(issuerUri));
- jwtDecoder.setJwtValidator(withClockSkew);
- return jwtDecoder;
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- val jwtDecoder = ReactiveJwtDecoders.fromIssuerLocation(issuerUri) as NimbusReactiveJwtDecoder
- val withClockSkew: OAuth2TokenValidator<Jwt> = DelegatingOAuth2TokenValidator(
- JwtTimestampValidator(Duration.ofSeconds(60)),
- JwtIssuerValidator(issuerUri))
- jwtDecoder.setJwtValidator(withClockSkew)
- return jwtDecoder
- }
- ----
- ======
- [NOTE]
- ====
- By default, Resource Server configures a clock skew of 60 seconds.
- ====
- [[webflux-oauth2resourceserver-validation-rfc9068]]
- === Configuring RFC 9068 Validation
- If you need to require tokens that meet https://datatracker.ietf.org/doc/rfc9068/[RFC 9068], you can configure validation in the following way:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- JwtDecoder jwtDecoder() {
- NimbusReactiveJwtDecoder jwtDecoder = NimbusReactiveJwtDecoder.withIssuerLocation(issuerUri)
- .validateTypes(false).build();
- jwtDecoder.setJwtValidator(JwtValidators.createAtJwtValidator()
- .audience("https://audience.example.org")
- .clientId("client-identifier")
- .issuer("https://issuer.example.org").build());
- return jwtDecoder;
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): JwtDecoder {
- val jwtDecoder = NimbusReactiveJwtDecoder.withIssuerLocation(issuerUri)
- .validateTypes(false).build()
- jwtDecoder.setJwtValidator(JwtValidators.createAtJwtValidator()
- .audience("https://audience.example.org")
- .clientId("client-identifier")
- .issuer("https://issuer.example.org").build())
- return jwtDecoder
- }
- ----
- ======
- [[webflux-oauth2resourceserver-validation-custom]]
- ==== Configuring a Custom Validator
- You can Add a check for the `aud` claim with the `OAuth2TokenValidator` API:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- public class AudienceValidator implements OAuth2TokenValidator<Jwt> {
- OAuth2Error error = new OAuth2Error("invalid_token", "The required audience is missing", null);
- public OAuth2TokenValidatorResult validate(Jwt jwt) {
- if (jwt.getAudience().contains("messaging")) {
- return OAuth2TokenValidatorResult.success();
- } else {
- return OAuth2TokenValidatorResult.failure(error);
- }
- }
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- class AudienceValidator : OAuth2TokenValidator<Jwt> {
- var error: OAuth2Error = OAuth2Error("invalid_token", "The required audience is missing", null)
- override fun validate(jwt: Jwt): OAuth2TokenValidatorResult {
- return if (jwt.audience.contains("messaging")) {
- OAuth2TokenValidatorResult.success()
- } else {
- OAuth2TokenValidatorResult.failure(error)
- }
- }
- }
- ----
- ======
- Then, to add into a resource server, you can specifying the `ReactiveJwtDecoder` instance:
- [tabs]
- ======
- Java::
- +
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- NimbusReactiveJwtDecoder jwtDecoder = (NimbusReactiveJwtDecoder)
- ReactiveJwtDecoders.fromIssuerLocation(issuerUri);
- OAuth2TokenValidator<Jwt> audienceValidator = new AudienceValidator();
- OAuth2TokenValidator<Jwt> withIssuer = JwtValidators.createDefaultWithIssuer(issuerUri);
- OAuth2TokenValidator<Jwt> withAudience = new DelegatingOAuth2TokenValidator<>(withIssuer, audienceValidator);
- jwtDecoder.setJwtValidator(withAudience);
- return jwtDecoder;
- }
- ----
- Kotlin::
- +
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- val jwtDecoder = ReactiveJwtDecoders.fromIssuerLocation(issuerUri) as NimbusReactiveJwtDecoder
- val audienceValidator: OAuth2TokenValidator<Jwt> = AudienceValidator()
- val withIssuer: OAuth2TokenValidator<Jwt> = JwtValidators.createDefaultWithIssuer(issuerUri)
- val withAudience: OAuth2TokenValidator<Jwt> = DelegatingOAuth2TokenValidator(withIssuer, audienceValidator)
- jwtDecoder.setJwtValidator(withAudience)
- return jwtDecoder
- }
- ----
- ======
|