org.springframework.security.oauth2.jwt

Class NimbusReactiveJwtDecoder

java.lang.Object

org.springframework.security.oauth2.jwt.NimbusReactiveJwtDecoder

All Implemented Interfaces:

ReactiveJwtDecoder

public final class NimbusReactiveJwtDecoder
extends java.lang.Object
implements ReactiveJwtDecoder

An implementation of a ReactiveJwtDecoder that "decodes" a JSON Web Token (JWT) and additionally verifies it's digital signature if the JWT is a JSON Web Signature (JWS). The public key used for verification is obtained from the JSON Web Key (JWK) Set URL supplied via the constructor.

NOTE: This implementation uses the Nimbus JOSE + JWT SDK internally.

Since:

5.1

See Also:

ReactiveJwtDecoder, JSON Web Token (JWT), JSON Web Signature (JWS), JSON Web Key (JWK), Nimbus JOSE + JWT SDK

Constructor Summary

Constructors

Constructor and Description
NimbusReactiveJwtDecoder(java.security.interfaces.RSAPublicKey publicKey)
NimbusReactiveJwtDecoder(java.lang.String jwkSetUrl) Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Jwt>	decode(java.lang.String token) Decodes the JWT from it's compact claims representation format and returns a Jwt.
void	setJwtValidator(OAuth2TokenValidator<Jwt> jwtValidator) Use the provided OAuth2TokenValidator to validate incoming Jwts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NimbusReactiveJwtDecoder

public NimbusReactiveJwtDecoder(java.security.interfaces.RSAPublicKey publicKey)

NimbusReactiveJwtDecoder

public NimbusReactiveJwtDecoder(java.lang.String jwkSetUrl)

Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.

Parameters:

jwkSetUrl - the JSON Web Key (JWK) Set URL

Method Detail

setJwtValidator

public void setJwtValidator(OAuth2TokenValidator<Jwt> jwtValidator)

Use the provided OAuth2TokenValidator to validate incoming Jwts.

Parameters:

jwtValidator - the OAuth2TokenValidator to use

decode

public reactor.core.publisher.Mono<Jwt> decode(java.lang.String token)
                                        throws JwtException

Description copied from interface: ReactiveJwtDecoder

Decodes the JWT from it's compact claims representation format and returns a Jwt.

Specified by:

decode in interface ReactiveJwtDecoder

Parameters:

token - the JWT value

Returns:

a Jwt

Throws:

JwtException - if an error occurs while attempting to decode the JWT