Class OAuth2ResourceServerConfigurer.DPoPConfigurer

java.lang.Object

org.springframework.security.config.annotation.web.configurers.oauth2.server.resource.OAuth2ResourceServerConfigurer.DPoPConfigurer

Enclosing class:

OAuth2ResourceServerConfigurer<H extends HttpSecurityBuilder<H>>

public final class OAuth2ResourceServerConfigurer.DPoPConfigurer
extends Object

A configurer for OAuth 2.0 Demonstrating Proof of Possession (DPoP) support.

Since:

7.1

See Also:

• AuthenticationFilter
• DPoPAuthenticationConverter
• DPoPAuthenticationEntryPoint
• DPoPAuthenticationProvider
• RFC 9449 OAuth 2.0 Demonstrating Proof of Possession (DPoP)

Constructor Summary

Constructors

Constructor	Description
DPoPConfigurer()

Method Summary

Modifier and Type	Method	Description
OAuth2ResourceServerConfigurer<H>.DPoPConfigurer	authenticationConverter(AuthenticationConverter authenticationConverter)	Sets the AuthenticationConverter used when attempting to extract a DPoP-bound access token from HttpServletRequest to an instance of DPoPAuthenticationToken used for authenticating the DPoP-protected resource request.
OAuth2ResourceServerConfigurer<H>.DPoPConfigurer	authenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)	Sets the AuthenticationFailureHandler used for handling a failed DPoP-protected resource request.
OAuth2ResourceServerConfigurer<H>.DPoPConfigurer	authenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)	Sets the AuthenticationSuccessHandler used for handling an authenticated DPoP-protected resource request.
OAuth2ResourceServerConfigurer<H>.DPoPConfigurer	dPoPProofVerifierFactory(JwtDecoderFactory<DPoPProofContext> dPoPProofVerifierFactory)	Sets the JwtDecoderFactory that provides a JwtDecoder for the specified DPoPProofContext and is used for authenticating a DPoP Proof Jwt.
OAuth2ResourceServerConfigurer<H>.DPoPConfigurer	requestMatcher(RequestMatcher requestMatcher)	Sets the RequestMatcher used when matching the HttpServletRequest to a DPoP-protected resource request.

Methods inherited from class Object

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

Constructor Details

DPoPConfigurer

public DPoPConfigurer()

Method Details

requestMatcher

public OAuth2ResourceServerConfigurer<H>.DPoPConfigurer requestMatcher(RequestMatcher requestMatcher)

Sets the RequestMatcher used when matching the HttpServletRequest to a DPoP-protected resource request.

Parameters:

requestMatcher - the RequestMatcher used when matching the HttpServletRequest to a DPoP-protected resource request

Returns:

the OAuth2ResourceServerConfigurer<H extends HttpSecurityBuilder<H>>.DPoPConfigurer for further configuration

authenticationConverter

public OAuth2ResourceServerConfigurer<H>.DPoPConfigurer authenticationConverter(AuthenticationConverter authenticationConverter)

Sets the AuthenticationConverter used when attempting to extract a DPoP-bound access token from HttpServletRequest to an instance of DPoPAuthenticationToken used for authenticating the DPoP-protected resource request. The default is DPoPAuthenticationConverter.

Parameters:

authenticationConverter - the AuthenticationConverter used when attempting to extract a DPoP-bound access token from HttpServletRequest

Returns:

the OAuth2ResourceServerConfigurer<H extends HttpSecurityBuilder<H>>.DPoPConfigurer for further configuration

authenticationSuccessHandler

public OAuth2ResourceServerConfigurer<H>.DPoPConfigurer authenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)

Sets the AuthenticationSuccessHandler used for handling an authenticated DPoP-protected resource request.

Parameters:

authenticationSuccessHandler - the AuthenticationSuccessHandler used for handling an authenticated DPoP-protected resource request

Returns:

the OAuth2ResourceServerConfigurer<H extends HttpSecurityBuilder<H>>.DPoPConfigurer for further configuration

authenticationFailureHandler

public OAuth2ResourceServerConfigurer<H>.DPoPConfigurer authenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)

Sets the AuthenticationFailureHandler used for handling a failed DPoP-protected resource request. The default is AuthenticationEntryPointFailureHandler with DPoPAuthenticationEntryPoint.

Parameters:

authenticationFailureHandler - the AuthenticationFailureHandler used for handling a failed DPoP-protected resource request

Returns:

the OAuth2ResourceServerConfigurer<H extends HttpSecurityBuilder<H>>.DPoPConfigurer for further configuration

dPoPProofVerifierFactory

public OAuth2ResourceServerConfigurer<H>.DPoPConfigurer dPoPProofVerifierFactory(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

Returns:

the OAuth2ResourceServerConfigurer<H extends HttpSecurityBuilder<H>>.DPoPConfigurer for further configuration

Since:

7.2