Class OAuth2DeviceVerificationAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

AuthenticationProvider

public final class OAuth2DeviceVerificationAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation for the Device Verification Request (submission of the user code) used in the OAuth 2.0 Device Authorization Grant.

Since:

7.0

See Also:

• OAuth2DeviceVerificationAuthenticationToken
• OAuth2DeviceAuthorizationRequestAuthenticationProvider
• OAuth2DeviceAuthorizationConsentAuthenticationProvider
• OAuth2DeviceCodeAuthenticationProvider
• RegisteredClientRepository
• OAuth2AuthorizationService
• OAuth2AuthorizationConsentService
• OAuth 2.0 Device Authorization Grant
• Section 3.3 User Interaction

Constructor Summary

Constructors

Constructor	Description
OAuth2DeviceVerificationAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService, OAuth2AuthorizationConsentService authorizationConsentService)	Constructs an OAuth2DeviceVerificationAuthenticationProvider 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	setAuthorizationConsentRequired(Predicate<OAuth2DeviceVerificationAuthenticationContext> authorizationConsentRequired)	Sets the Predicate used to determine if authorization consent is required.
boolean	supports(Class<?> authentication)	Returns true if this AuthenticationProvider supports the indicated Authentication object.

Methods inherited from class Object

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

Constructor Details

OAuth2DeviceVerificationAuthenticationProvider

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

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

Specified by:

supports in interface AuthenticationProvider

Parameters:

authentication -

Returns:

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

setAuthorizationConsentRequired

public void setAuthorizationConsentRequired(Predicate<OAuth2DeviceVerificationAuthenticationContext> authorizationConsentRequired)

Sets the Predicate used to determine if authorization consent is required.

The OAuth2DeviceVerificationAuthenticationContext gives the predicate access to the OAuth2DeviceVerificationAuthenticationToken, as well as, the following context attributes:

• The RegisteredClient associated with the device authorization request.
• The OAuth2Authorization containing the device authorization request parameters.
• The OAuth2AuthorizationConsent previously granted to the RegisteredClient, or null if not available.

Parameters:

authorizationConsentRequired - the Predicate used to determine if authorization consent is required