123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909 |
- = 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
- ====
- .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
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange(exchanges -> exchanges
- .pathMatchers("/message/**").hasAuthority("SCOPE_message:read")
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer(oauth2 -> oauth2
- .jwt(withDefaults())
- );
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize("/message/**", hasAuthority("SCOPE_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
- ====
- .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 `{security-api-url}org/springframework/security/oauth2/jwt/ReactiveJwtDecoders.html#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:
- ====
- .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`:
- ====
- .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()`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withJwkSetUri(jwkSetUri).build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return ReactiveJwtDecoders.fromIssuerLocation(issuerUri)
- }
- ----
- ====
- [[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-algorithm: 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`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withJwkSetUri(this.jwkSetUri)
- .jwsAlgorithm(RS512).build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withJwkSetUri(this.jwkSetUri)
- .jwsAlgorithm(RS512).build()
- }
- ----
- ====
- Calling `jwsAlgorithm` more than once configures `NimbusReactiveJwtDecoder` to trust more than one algorithm:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withJwkSetUri(this.jwkSetUri)
- .jwsAlgorithm(RS512).jwsAlgorithm(ES512).build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withJwkSetUri(this.jwkSetUri)
- .jwsAlgorithm(RS512).jwsAlgorithm(ES512).build()
- }
- ----
- ====
- Alternately, you can call `jwsAlgorithms`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- ReactiveJwtDecoder jwtDecoder() {
- return NimbusReactiveJwtDecoder.withJwkSetUri(this.jwkSetUri)
- .jwsAlgorithms(algorithms -> {
- algorithms.add(RS512);
- algorithms.add(ES512);
- }).build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun jwtDecoder(): ReactiveJwtDecoder {
- return NimbusReactiveJwtDecoder.withJwkSetUri(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
- ====
- .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:
- ====
- .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:
- ====
- .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:
- ====
- .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:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
- http
- .authorizeExchange(exchanges -> exchanges
- .mvcMatchers("/contacts/**").hasAuthority("SCOPE_contacts")
- .mvcMatchers("/messages/**").hasAuthority("SCOPE_messages")
- .anyExchange().authenticated()
- )
- .oauth2ResourceServer(OAuth2ResourceServerSpec::jwt);
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
- return http {
- authorizeExchange {
- authorize("/contacts/**", hasAuthority("SCOPE_contacts"))
- authorize("/messages/**", hasAuthority("SCOPE_messages"))
- authorize(anyExchange, authenticated)
- }
- oauth2ResourceServer {
- jwt { }
- }
- }
- }
- ----
- ====
- You can do something similar with method security:
- ====
- .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()`:
- ====
- .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`:
- ====
- .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>>`:
- ====
- .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:
- ====
- .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-custom]]
- ==== Configuring a Custom Validator
- You can Add a check for the `aud` claim with the `OAuth2TokenValidator` API:
- ====
- .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:
- ====
- .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
- }
- ----
- ====
|