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

Class ClientSecretAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.server.authorization.authentication.ClientSecretAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public final class ClientSecretAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation used for OAuth 2.0 Client Authentication, which authenticates the client_secret parameter.

Since:

7.0

See Also:

• AuthenticationProvider
• OAuth2ClientAuthenticationToken
• RegisteredClientRepository
• OAuth2AuthorizationService
• PasswordEncoder

Constructor Summary

Constructors

Constructor	Description
ClientSecretAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService)	Constructs a ClientSecretAuthenticationProvider 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	setPasswordEncoder(PasswordEncoder passwordEncoder)	Sets the PasswordEncoder used to validate the client secret.
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

ClientSecretAuthenticationProvider

public ClientSecretAuthenticationProvider(RegisteredClientRepository registeredClientRepository,
 OAuth2AuthorizationService authorizationService)

Constructs a ClientSecretAuthenticationProvider using the provided parameters.

Parameters:

registeredClientRepository - the repository of registered clients

authorizationService - the authorization service

Method Details

setPasswordEncoder

public void setPasswordEncoder(PasswordEncoder passwordEncoder)

Sets the PasswordEncoder used to validate the client secret. If not set, the client secret will be compared using PasswordEncoderFactories.createDelegatingPasswordEncoder().

Parameters:

passwordEncoder - the PasswordEncoder used to validate the client secret

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 by the ProviderManager.

Specified by:

supports in interface AuthenticationProvider

Returns:

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