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

Class OAuth2DeviceVerificationAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

public final class OAuth2DeviceVerificationAuthenticationProvider
extends Object
implements org.springframework.security.authentication.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
org.springframework.security.core.Authentication	authenticate(org.springframework.security.core.Authentication authentication)
void	setAuthorizationConsentRequired(Predicate<OAuth2DeviceVerificationAuthenticationContext> authorizationConsentRequired)	Sets the Predicate used to determine if authorization consent is required.
boolean	supports(Class<?> authentication)

Methods inherited from class java.lang.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 org.springframework.security.core.Authentication authenticate(org.springframework.security.core.Authentication authentication)
                                                              throws org.springframework.security.core.AuthenticationException

Specified by:

authenticate in interface org.springframework.security.authentication.AuthenticationProvider

Throws:

org.springframework.security.core.AuthenticationException

supports

public boolean supports(Class<?> authentication)

Specified by:

supports in interface org.springframework.security.authentication.AuthenticationProvider

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