Package org.springframework.security.oauth2.client.oidc.authentication

Class ReactiveOidcIdTokenDecoderFactory

java.lang.Object

org.springframework.security.oauth2.client.oidc.authentication.ReactiveOidcIdTokenDecoderFactory

All Implemented Interfaces:

ReactiveJwtDecoderFactory<ClientRegistration>

public final class ReactiveOidcIdTokenDecoderFactory
extends Object
implements ReactiveJwtDecoderFactory<ClientRegistration>

A factory that provides a ReactiveJwtDecoder used for OidcIdToken signature verification. The provided ReactiveJwtDecoder is associated to a specific ClientRegistration.

Since:

5.2

See Also:

• ReactiveJwtDecoderFactory
• ClientRegistration
• OidcIdToken

Constructor Summary

Constructors

Constructor	Description
ReactiveOidcIdTokenDecoderFactory()

Method Summary

Modifier and Type	Method	Description
ReactiveJwtDecoder	createDecoder(ClientRegistration clientRegistration)	Creates a ReactiveJwtDecoder using the supplied "contextual" type.
static Map<String,org.springframework.core.convert.converter.Converter<Object,?>>	createDefaultClaimTypeConverters()	Returns the default Converter's used for type conversion of claim values for an OidcIdToken.
void	setClaimTypeConverterFactory(Function<ClientRegistration,org.springframework.core.convert.converter.Converter<Map<String,Object>,Map<String,Object>>> claimTypeConverterFactory)	Sets the factory that provides a Converter used for type conversion of claim values for an OidcIdToken.
void	setJwsAlgorithmResolver(Function<ClientRegistration,JwsAlgorithm> jwsAlgorithmResolver)	Sets the resolver that provides the expected JWS algorithm used for the signature or MAC on the ID Token.
void	setJwtValidatorFactory(Function<ClientRegistration,OAuth2TokenValidator<Jwt>> jwtValidatorFactory)	Sets the factory that provides an OAuth2TokenValidator, which is used by the ReactiveJwtDecoder.

Methods inherited from class java.lang.Object

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

Constructor Details

ReactiveOidcIdTokenDecoderFactory

public ReactiveOidcIdTokenDecoderFactory()

Method Details

createDefaultClaimTypeConverters

public static Map<String,org.springframework.core.convert.converter.Converter<Object,?>> createDefaultClaimTypeConverters()

Returns the default Converter's used for type conversion of claim values for an OidcIdToken.

Returns:

a Map of Converter's keyed by claim name

createDecoder

public ReactiveJwtDecoder createDecoder(ClientRegistration clientRegistration)

Description copied from interface: ReactiveJwtDecoderFactory

Creates a ReactiveJwtDecoder using the supplied "contextual" type.

Specified by:

createDecoder in interface ReactiveJwtDecoderFactory<ClientRegistration>

Parameters:

clientRegistration - the type that provides contextual information

Returns:

a ReactiveJwtDecoder

setJwtValidatorFactory

public void setJwtValidatorFactory(Function<ClientRegistration,OAuth2TokenValidator<Jwt>> jwtValidatorFactory)

Sets the factory that provides an OAuth2TokenValidator, which is used by the ReactiveJwtDecoder. The default composes JwtTimestampValidator and OidcIdTokenValidator.

Parameters:

jwtValidatorFactory - the factory that provides an OAuth2TokenValidator

setJwsAlgorithmResolver

public void setJwsAlgorithmResolver(Function<ClientRegistration,JwsAlgorithm> jwsAlgorithmResolver)

Sets the resolver that provides the expected JWS algorithm used for the signature or MAC on the ID Token. The default resolves to RS256 for all clients.

Parameters:

jwsAlgorithmResolver - the resolver that provides the expected JWS algorithm for a specific client

setClaimTypeConverterFactory

public void setClaimTypeConverterFactory(Function<ClientRegistration,org.springframework.core.convert.converter.Converter<Map<String,Object>,Map<String,Object>>> claimTypeConverterFactory)

Sets the factory that provides a Converter used for type conversion of claim values for an OidcIdToken. The default is ClaimTypeConverter for all clients.

Parameters:

claimTypeConverterFactory - the factory that provides a Converter used for type conversion of claim values for a specific client