Package org.springframework.security.oauth2.server.resource.authentication

Class DPoPAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.server.resource.authentication.DPoPAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public final class DPoPAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation that is responsible for authenticating a DPoP-bound access token for a protected resource request.

Since:

6.5

See Also:

• DPoPAuthenticationToken
• DPoPProofJwtDecoderFactory
• RFC 9449 OAuth 2.0 Demonstrating Proof of Possession (DPoP)

Constructor Summary

Constructors

Constructor	Description
DPoPAuthenticationProvider(AuthenticationManager tokenAuthenticationManager)	Constructs a DPoPAuthenticationProvider using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(Authentication authentication)	Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
void	setDPoPProofVerifierFactory(JwtDecoderFactory<DPoPProofContext> dPoPProofVerifierFactory)	Sets the JwtDecoderFactory that provides a JwtDecoder for the specified DPoPProofContext and is used for authenticating a DPoP Proof Jwt.
boolean	supports(Class<?> authentication)	Returns true if this AuthenticationProvider supports the indicated Authentication object.

Methods inherited from class java.lang.Object

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

Constructor Details

DPoPAuthenticationProvider

public DPoPAuthenticationProvider(AuthenticationManager tokenAuthenticationManager)

Constructs a DPoPAuthenticationProvider using the provided parameters.

Parameters:

tokenAuthenticationManager - the AuthenticationManager used to authenticate the DPoP-bound access token

Method Details

authenticate

public Authentication authenticate(Authentication authentication)
                            throws AuthenticationException

Description copied from interface: AuthenticationProvider

Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

authentication - the authentication request object.

Returns:

a fully authenticated object including credentials. May return null if the AuthenticationProvider is unable to support authentication of the passed Authentication object. In such a case, the next AuthenticationProvider that supports the presented Authentication class will be tried.

Throws:

AuthenticationException - if authentication fails.

supports

public boolean supports(Class<?> authentication)

Description copied from interface: AuthenticationProvider

Returns true if this AuthenticationProvider supports the indicated Authentication object.

Returning true does not guarantee an AuthenticationProvider will be able to authenticate the presented Authentication object. It simply indicates it can support closer evaluation of it. An AuthenticationProvider can still return null from the AuthenticationProvider.authenticate(Authentication) method to indicate another AuthenticationProvider should be tried.

Selection of an AuthenticationProvider capable of performing authentication is conducted at runtime the ProviderManager.

Specified by:

supports in interface AuthenticationProvider

Returns:

true if the implementation can more closely evaluate the Authentication class presented

setDPoPProofVerifierFactory

public void setDPoPProofVerifierFactory(JwtDecoderFactory<DPoPProofContext> dPoPProofVerifierFactory)

Sets the JwtDecoderFactory that provides a JwtDecoder for the specified DPoPProofContext and is used for authenticating a DPoP Proof Jwt. The default factory is DPoPProofJwtDecoderFactory.

Parameters:

dPoPProofVerifierFactory - the JwtDecoderFactory that provides a JwtDecoder for the specified DPoPProofContext