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

Class OidcUserInfoAuthenticationProvider

java.lang.Object

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

All Implemented Interfaces:

AuthenticationProvider

public final class OidcUserInfoAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation for OpenID Connect 1.0 UserInfo Endpoint.

Since:

7.0

See Also:

• OAuth2AuthorizationService
• 5.3. UserInfo Endpoint

Constructor Summary

Constructors

Constructor	Description
OidcUserInfoAuthenticationProvider(OAuth2AuthorizationService authorizationService)	Constructs an OidcUserInfoAuthenticationProvider 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	setUserInfoMapper(Function<OidcUserInfoAuthenticationContext,OidcUserInfo> userInfoMapper)	Sets the Function used to extract claims from OidcUserInfoAuthenticationContext to an instance of OidcUserInfo for the UserInfo response.
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

OidcUserInfoAuthenticationProvider

public OidcUserInfoAuthenticationProvider(OAuth2AuthorizationService authorizationService)

Constructs an OidcUserInfoAuthenticationProvider using the provided parameters.

Parameters:

authorizationService - the authorization 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

Returns:

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

setUserInfoMapper

public void setUserInfoMapper(Function<OidcUserInfoAuthenticationContext,OidcUserInfo> userInfoMapper)

Sets the Function used to extract claims from OidcUserInfoAuthenticationContext to an instance of OidcUserInfo for the UserInfo response.

The OidcUserInfoAuthenticationContext gives the mapper access to the OidcUserInfoAuthenticationToken, as well as, the following context attributes:

• OidcUserInfoAuthenticationContext.getAccessToken() containing the bearer token used to make the request.
• OidcUserInfoAuthenticationContext.getAuthorization() containing the OidcIdToken and OAuth2AccessToken associated with the bearer token used to make the request.

Parameters:

userInfoMapper - the Function used to extract claims from OidcUserInfoAuthenticationContext to an instance of OidcUserInfo