Package org.springframework.security.oauth2.server.authorization.oidc.authentication

Class OidcLogoutAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.server.authorization.oidc.authentication.OidcLogoutAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public final class OidcLogoutAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation for OpenID Connect 1.0 RP-Initiated Logout Endpoint.

Since:

7.0

See Also:

• RegisteredClientRepository
• OAuth2AuthorizationService
• SessionRegistry
• 2. RP-Initiated Logout

Constructor Summary

Constructors

Constructor	Description
OidcLogoutAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService, SessionRegistry sessionRegistry)	Constructs an OidcLogoutAuthenticationProvider 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	setAuthenticationValidator(Consumer<OidcLogoutAuthenticationContext> authenticationValidator)	Sets the Consumer providing access to the OidcLogoutAuthenticationContext and is responsible for validating specific OpenID Connect RP-Initiated Logout Request parameters associated in the OidcLogoutAuthenticationToken.
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

OidcLogoutAuthenticationProvider

public OidcLogoutAuthenticationProvider(RegisteredClientRepository registeredClientRepository,
 OAuth2AuthorizationService authorizationService,
 SessionRegistry sessionRegistry)

Constructs an OidcLogoutAuthenticationProvider using the provided parameters.

Parameters:

registeredClientRepository - the repository of registered clients

authorizationService - the authorization service

sessionRegistry - the SessionRegistry used to track OpenID Connect sessions

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

setAuthenticationValidator

public void setAuthenticationValidator(Consumer<OidcLogoutAuthenticationContext> authenticationValidator)

Sets the Consumer providing access to the OidcLogoutAuthenticationContext and is responsible for validating specific OpenID Connect RP-Initiated Logout Request parameters associated in the OidcLogoutAuthenticationToken. The default authentication validator is OidcLogoutAuthenticationValidator.

NOTE: The authentication validator MUST throw OAuth2AuthenticationException if validation fails.

Parameters:

authenticationValidator - the Consumer providing access to the OidcLogoutAuthenticationContext and is responsible for validating specific OpenID Connect RP-Initiated Logout Request parameters