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

Class OAuth2AuthorizationCodeRequestAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

org.springframework.security.authentication.AuthenticationProvider

public final class OAuth2AuthorizationCodeRequestAuthenticationProvider
extends java.lang.Object
implements org.springframework.security.authentication.AuthenticationProvider

An AuthenticationProvider implementation for the OAuth 2.0 Authorization Request (and Consent) used in the Authorization Code Grant.

Since:

0.1.2

See Also:

OAuth2AuthorizationCodeRequestAuthenticationToken, OAuth2AuthorizationCodeAuthenticationProvider, RegisteredClientRepository, OAuth2AuthorizationService, OAuth2AuthorizationConsentService, Section 4.1.1 Authorization Request

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthorizationCodeRequestAuthenticationProvider(RegisteredClientRepository registeredClientRepository, OAuth2AuthorizationService authorizationService, OAuth2AuthorizationConsentService authorizationConsentService) Constructs an OAuth2AuthorizationCodeRequestAuthenticationProvider using the provided parameters.

Method Summary

Modifier and Type	Method and Description
org.springframework.security.core.Authentication	authenticate(org.springframework.security.core.Authentication authentication)
void	setAuthenticationValidatorResolver(java.util.function.Function<java.lang.String,OAuth2AuthenticationValidator> authenticationValidatorResolver) Sets the resolver that resolves an OAuth2AuthenticationValidator from the provided OAuth 2.0 Authorization Request parameter.
void	setAuthorizationCodeGenerator(OAuth2TokenGenerator<OAuth2AuthorizationCode> authorizationCodeGenerator) Sets the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode.
void	setAuthorizationConsentCustomizer(java.util.function.Consumer<OAuth2AuthorizationConsentAuthenticationContext> authorizationConsentCustomizer) Sets the Consumer providing access to the OAuth2AuthorizationConsentAuthenticationContext containing an OAuth2AuthorizationConsent.Builder and additional context information.
boolean	supports(java.lang.Class<?> authentication)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2AuthorizationCodeRequestAuthenticationProvider

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

Constructs an OAuth2AuthorizationCodeRequestAuthenticationProvider using the provided parameters.

Parameters:

registeredClientRepository - the repository of registered clients

authorizationService - the authorization service

authorizationConsentService - the authorization consent service

Method Detail

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(java.lang.Class<?> authentication)

Specified by:

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

setAuthorizationCodeGenerator

public void setAuthorizationCodeGenerator(OAuth2TokenGenerator<OAuth2AuthorizationCode> authorizationCodeGenerator)

Sets the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode.

Parameters:

authorizationCodeGenerator - the OAuth2TokenGenerator that generates the OAuth2AuthorizationCode

Since:

0.2.3

setAuthenticationValidatorResolver

public void setAuthenticationValidatorResolver(java.util.function.Function<java.lang.String,OAuth2AuthenticationValidator> authenticationValidatorResolver)

Sets the resolver that resolves an OAuth2AuthenticationValidator from the provided OAuth 2.0 Authorization Request parameter.

The following OAuth 2.0 Authorization Request parameters are supported:

1. OAuth2ParameterNames.REDIRECT_URI
2. OAuth2ParameterNames.SCOPE

NOTE: The resolved OAuth2AuthenticationValidator MUST throw OAuth2AuthorizationCodeRequestAuthenticationException if validation fails.

Parameters:

authenticationValidatorResolver - the resolver that resolves an OAuth2AuthenticationValidator from the provided OAuth 2.0 Authorization Request parameter

setAuthorizationConsentCustomizer

public void setAuthorizationConsentCustomizer(java.util.function.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 OAuth2AuthorizationCodeRequestAuthenticationToken.
• 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