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

Class OAuth2AuthorizationConsentAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

AuthenticationProvider

public final class OAuth2AuthorizationConsentAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation for the OAuth 2.0 Authorization Consent used in the Authorization Code Grant.

Since:

7.0

See Also:

• OAuth2AuthorizationConsentAuthenticationToken
• OAuth2AuthorizationConsent
• OAuth2AuthorizationCodeRequestAuthenticationProvider
• RegisteredClientRepository
• OAuth2AuthorizationService
• OAuth2AuthorizationConsentService

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthorizationConsentAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService, OAuth2AuthorizationConsentService authorizationConsentService)	Constructs an OAuth2AuthorizationConsentAuthenticationProvider 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	setAuthorizationCodeGenerator(OAuth2TokenGenerator<OAuth2AuthorizationCode> authorizationCodeGenerator)	Sets the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode.
void	setAuthorizationConsentCustomizer(Consumer<OAuth2AuthorizationConsentAuthenticationContext> authorizationConsentCustomizer)	Sets the Consumer providing access to the OAuth2AuthorizationConsentAuthenticationContext containing an OAuth2AuthorizationConsent.Builder and additional context information.
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

OAuth2AuthorizationConsentAuthenticationProvider

public OAuth2AuthorizationConsentAuthenticationProvider(RegisteredClientRepository registeredClientRepository,
 OAuth2AuthorizationService authorizationService,
 OAuth2AuthorizationConsentService authorizationConsentService)

Constructs an OAuth2AuthorizationConsentAuthenticationProvider using the provided parameters.

Parameters:

registeredClientRepository - the repository of registered clients

authorizationService - the authorization service

authorizationConsentService - the authorization consent service

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

setAuthorizationCodeGenerator

public void setAuthorizationCodeGenerator(OAuth2TokenGenerator<OAuth2AuthorizationCode> authorizationCodeGenerator)

Sets the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode.

Parameters:

authorizationCodeGenerator - the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode

setAuthorizationConsentCustomizer

public void setAuthorizationConsentCustomizer(Consumer<OAuth2AuthorizationConsentAuthenticationContext> authorizationConsentCustomizer)

Sets the Consumer providing access to the OAuth2AuthorizationConsentAuthenticationContext containing an OAuth2AuthorizationConsent.Builder and additional context information.

The following context attributes are available:

• The OAuth2AuthorizationConsent.Builder used to build the authorization consent prior to OAuth2AuthorizationConsentService.save(OAuth2AuthorizationConsent).
• The Authentication of type OAuth2AuthorizationConsentAuthenticationToken.
• The RegisteredClient associated with the authorization request.
• The OAuth2Authorization associated with the state token presented in the authorization consent request.
• The OAuth2AuthorizationRequest associated with the authorization consent request.

Parameters:

authorizationConsentCustomizer - the Consumer providing access to the OAuth2AuthorizationConsentAuthenticationContext containing an OAuth2AuthorizationConsent.Builder