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

Class OAuth2ClientCredentialsAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

AuthenticationProvider

public final class OAuth2ClientCredentialsAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation for the OAuth 2.0 Client Credentials Grant.

Since:

7.0

See Also:

• OAuth2ClientCredentialsAuthenticationToken
• OAuth2AccessTokenAuthenticationToken
• OAuth2AuthorizationService
• OAuth2TokenGenerator
• Section 4.4 Client Credentials Grant
• Section 4.4.2 Access Token Request

Constructor Summary

Constructors

Constructor	Description
OAuth2ClientCredentialsAuthenticationProvider(OAuth2AuthorizationService authorizationService, OAuth2TokenGenerator<? extends OAuth2Token> tokenGenerator)	Constructs an OAuth2ClientCredentialsAuthenticationProvider 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<OAuth2ClientCredentialsAuthenticationContext> authenticationValidator)	Sets the Consumer providing access to the OAuth2ClientCredentialsAuthenticationContext and is responsible for validating specific OAuth 2.0 Client Credentials Grant Request parameters associated in the OAuth2ClientCredentialsAuthenticationToken.
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

OAuth2ClientCredentialsAuthenticationProvider

public OAuth2ClientCredentialsAuthenticationProvider(OAuth2AuthorizationService authorizationService,
 OAuth2TokenGenerator<? extends OAuth2Token> tokenGenerator)

Constructs an OAuth2ClientCredentialsAuthenticationProvider using the provided parameters.

Parameters:

authorizationService - the authorization service

tokenGenerator - the token generator

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 by 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<OAuth2ClientCredentialsAuthenticationContext> authenticationValidator)

Sets the Consumer providing access to the OAuth2ClientCredentialsAuthenticationContext and is responsible for validating specific OAuth 2.0 Client Credentials Grant Request parameters associated in the OAuth2ClientCredentialsAuthenticationToken. The default authentication validator is OAuth2ClientCredentialsAuthenticationValidator.

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

Parameters:

authenticationValidator - the Consumer providing access to the OAuth2ClientCredentialsAuthenticationContext and is responsible for validating specific OAuth 2.0 Client Credentials Grant Request parameters