top.dcenter.ums.security.core.oauth.provider

类 Auth2LoginAuthenticationProvider

java.lang.Object

top.dcenter.ums.security.core.oauth.provider.Auth2LoginAuthenticationProvider

所有已实现的接口:

org.springframework.security.authentication.AuthenticationProvider

public class Auth2LoginAuthenticationProvider
extends Object
implements org.springframework.security.authentication.AuthenticationProvider

An implementation of an AuthenticationProvider for OAuth 2.0 Login, which leverages the OAuth 2.0 Authorization Code Grant Flow. This AuthenticationProvider is responsible for authenticating an Authorization Code credential with the Authorization Server's Token Endpoint and if valid, exchanging it for an Access Token credential.

It will also obtain the user attributes of the End-User (Resource Owner) from the UserInfo Endpoint using an Auth2UserService, which will create a Principal in the form of an AuthUser. The AuthUser is then associated to the Auth2LoginAuthenticationToken to complete the authentication.

从以下版本开始:

5.0

作者:

Joe Grandja, YongWu zheng

另请参阅:

UsersConnectionRepository, Auth2AuthenticationToken, Auth2UserService, Section 4.1 Authorization Code Grant Flow, Section 4.1.3 Access Token Request, Section 4.1.4 Access Token Response

字段概要

字段

限定符和类型	字段和说明
protected org.springframework.context.support.MessageSourceAccessor	messages

构造器概要

构造器

构造器和说明

Auth2LoginAuthenticationProvider(Auth2UserService userService, ConnectionService connectionService, top.dcenter.ums.security.core.api.service.UmsUserDetailsService umsUserDetailsService, ExecutorService updateConnectionTaskExecutor, Boolean autoSignUp, GenerateClaimsSetService generateClaimsSetService, String temporaryUserAuthorities, String temporaryUserPassword, top.dcenter.ums.security.common.api.userdetails.converter.AuthenticationToUserDetailsConverter authenticationToUserDetailsConverter) Constructs an Auth2LoginAuthenticationProvider using the provided parameters.

方法概要

限定符和类型	方法和说明
protected void	additionalAuthenticationChecks(org.springframework.security.core.userdetails.UserDetails userDetails, Auth2LoginAuthenticationToken authentication) Allows subclasses to perform any additional checks of a returned (or cached) UserDetails for a given authentication request.
org.springframework.security.core.Authentication	authenticate(org.springframework.security.core.Authentication authentication)
protected org.springframework.security.core.userdetails.UserDetailsChecker	getPostAuthenticationChecks()
protected org.springframework.security.core.userdetails.UserDetailsChecker	getPreAuthenticationChecks()
void	setPostAuthenticationChecks(org.springframework.security.core.userdetails.UserDetailsChecker postAuthenticationChecks)
void	setPreAuthenticationChecks(org.springframework.security.core.userdetails.UserDetailsChecker preAuthenticationChecks) Sets the policy will be used to verify the status of the loaded UserDetails before validation of the credentials takes place.
void	setUserCache(org.springframework.security.core.userdetails.UserCache userCache)
boolean	supports(Class<?> authentication)

从类继承的方法 java.lang.Object

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

字段详细资料

messages

protected org.springframework.context.support.MessageSourceAccessor messages

构造器详细资料

Auth2LoginAuthenticationProvider

public Auth2LoginAuthenticationProvider(Auth2UserService userService,
                                        ConnectionService connectionService,
                                        top.dcenter.ums.security.core.api.service.UmsUserDetailsService umsUserDetailsService,
                                        ExecutorService updateConnectionTaskExecutor,
                                        Boolean autoSignUp,
                                        @Nullable
                                        GenerateClaimsSetService generateClaimsSetService,
                                        String temporaryUserAuthorities,
                                        String temporaryUserPassword,
                                        @Autowired(required=false)
                                        top.dcenter.ums.security.common.api.userdetails.converter.AuthenticationToUserDetailsConverter authenticationToUserDetailsConverter)

Constructs an Auth2LoginAuthenticationProvider using the provided parameters.

参数:

userService - the service used for obtaining the user attributes of the End-User from the UserInfo Endpoint

connectionService - 第三方登录成功后自动注册服务

umsUserDetailsService - this service used for local user service

updateConnectionTaskExecutor - update connection task executor

autoSignUp - 第三方登录是否自动注册

generateClaimsSetService - GenerateClaimsSetService

temporaryUserAuthorities - 临时权限

temporaryUserPassword - 临时密码

authenticationToUserDetailsConverter - authentication to user details converter

方法详细资料

authenticate

public org.springframework.security.core.Authentication authenticate(org.springframework.security.core.Authentication authentication)
                                                              throws org.springframework.security.core.AuthenticationException

指定者:

authenticate 在接口中 org.springframework.security.authentication.AuthenticationProvider

抛出:

org.springframework.security.core.AuthenticationException

additionalAuthenticationChecks

protected void additionalAuthenticationChecks(org.springframework.security.core.userdetails.UserDetails userDetails,
                                              Auth2LoginAuthenticationToken authentication)
                                       throws org.springframework.security.core.AuthenticationException

Allows subclasses to perform any additional checks of a returned (or cached) UserDetails for a given authentication request. If custom logic is needed to compare additional properties of UserDetails and/or Auth2LoginAuthenticationToken, these should also appear in this method.

参数:

userDetails - as retrieved from the ConnectionService.signUp(AuthUser, String, String)} or UserCache or UmsUserDetailsService.loadUserByUserId(String)

authentication - the current request that needs to be authenticated

抛出:

org.springframework.security.core.AuthenticationException - AuthenticationException if the userDetails could not be validated (generally an AuthenticationServiceException)

setUserCache

public void setUserCache(org.springframework.security.core.userdetails.UserCache userCache)

getPreAuthenticationChecks

protected org.springframework.security.core.userdetails.UserDetailsChecker getPreAuthenticationChecks()

setPreAuthenticationChecks

public void setPreAuthenticationChecks(org.springframework.security.core.userdetails.UserDetailsChecker preAuthenticationChecks)

Sets the policy will be used to verify the status of the loaded UserDetails before validation of the credentials takes place.

参数:

preAuthenticationChecks - strategy to be invoked prior to authentication.

getPostAuthenticationChecks

protected org.springframework.security.core.userdetails.UserDetailsChecker getPostAuthenticationChecks()

setPostAuthenticationChecks

public void setPostAuthenticationChecks(org.springframework.security.core.userdetails.UserDetailsChecker postAuthenticationChecks)

supports

public boolean supports(Class<?> authentication)

指定者:

supports 在接口中 org.springframework.security.authentication.AuthenticationProvider