top.dcenter.ums.security.core.oauth.filter.login

类 Auth2LoginAuthenticationFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

top.dcenter.ums.security.core.oauth.filter.login.Auth2LoginAuthenticationFilter

所有已实现的接口:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.EnvironmentAware, org.springframework.context.MessageSourceAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public class Auth2LoginAuthenticationFilter
extends org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

An implementation of an AbstractAuthenticationProcessingFilter for OAuth 2.0 Login.

This authentication Filter handles the processing of an OAuth 2.0 Authorization Response for the authorization code grant flow and delegates an OAuth2LoginAuthenticationToken to the AuthenticationManager to log in the End-User.

The OAuth 2.0 Authorization Response is processed as follows:

• Assuming the End-User (Resource Owner) has granted access to the Client, the Authorization Server will append the code and state parameters to the redirect_uri (provided in the Authorization Request) and redirect the End-User's user-agent back to this Filter (the Client).
• This Filter will then create an OAuth2LoginAuthenticationToken with the code received and delegate it to the AuthenticationManager to authenticate.
• Upon a successful authentication, an OAuth2AuthenticationToken is created (representing the End-User Principal) and associated to the Authorized Client using the OAuth2AuthorizedClientRepository.
• Finally, the OAuth2AuthenticationToken is returned and ultimately stored in the SecurityContextRepository to complete the authentication processing.

从以下版本开始:

5.0

作者:

Joe Grandja

另请参阅:

AbstractAuthenticationProcessingFilter, OAuth2LoginAuthenticationToken, OAuth2AuthenticationToken, OAuth2LoginAuthenticationProvider, OAuth2AuthorizationRequest, OAuth2AuthorizationResponse, AuthorizationRequestRepository, OAuth2AuthorizationRequestRedirectFilter, ClientRegistrationRepository, OAuth2AuthorizedClient, OAuth2AuthorizedClientRepository, Section 4.1 Authorization Code Grant, Section 4.1.2 Authorization Response

字段概要

字段

限定符和类型	字段和说明
static String	TEMPORARY_USER_CACHE_KEY_PREFIX
static String	TEMPORARY_USERNAME_PARAM_NAME

从类继承的字段 org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

authenticationDetailsSource, eventPublisher, messages

从类继承的字段 org.springframework.web.filter.GenericFilterBean

logger

构造器概要

构造器

构造器和说明
Auth2LoginAuthenticationFilter(String filterProcessesUrl, String signUpUrl, org.springframework.security.authentication.AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,?> authenticationDetailsSource, org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory) Constructs an Auth2LoginAuthenticationFilter using the provided parameters.

方法概要

限定符和类型	方法和说明
org.springframework.security.core.Authentication	attemptAuthentication(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	setDetails(javax.servlet.http.HttpServletRequest request, Auth2LoginAuthenticationToken authRequest) Provided so that subclasses may configure what is put into the auth request's details property.
void	setRedirectStrategy(org.springframework.security.web.RedirectStrategy redirectStrategy)
protected void	successfulAuthentication(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain, org.springframework.security.core.Authentication authResult)

从类继承的方法 org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

afterPropertiesSet, doFilter, getAllowSessionCreation, getAuthenticationManager, getFailureHandler, getRememberMeServices, getSuccessHandler, requiresAuthentication, setAllowSessionCreation, setApplicationEventPublisher, setAuthenticationDetailsSource, setAuthenticationFailureHandler, setAuthenticationManager, setAuthenticationSuccessHandler, setContinueChainBeforeSuccessfulAuthentication, setFilterProcessesUrl, setMessageSource, setRememberMeServices, setRequiresAuthenticationRequestMatcher, setSessionAuthenticationStrategy, unsuccessfulAuthentication

从类继承的方法 org.springframework.web.filter.GenericFilterBean

addRequiredProperty, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

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

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

字段详细资料

TEMPORARY_USER_CACHE_KEY_PREFIX

public static final String TEMPORARY_USER_CACHE_KEY_PREFIX

另请参阅:

常量字段值

TEMPORARY_USERNAME_PARAM_NAME

public static final String TEMPORARY_USERNAME_PARAM_NAME

另请参阅:

常量字段值

构造器详细资料

Auth2LoginAuthenticationFilter

public Auth2LoginAuthenticationFilter(@NonNull
                                      String filterProcessesUrl,
                                      @NonNull
                                      String signUpUrl,
                                      @Nullable
                                      org.springframework.security.authentication.AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,?> authenticationDetailsSource,
                                      @Autowired(required=false) @Nullable
                                      org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory)

Constructs an Auth2LoginAuthenticationFilter using the provided parameters.

参数:

filterProcessesUrl - the URI where this Filter will process the authentication requests, not null

signUpUrl - 第三方授权登录后如未注册用户不支持自动注册功能, 则跳转到此 url 进行注册逻辑, 此 url 必须开发者自己实现;

authenticationDetailsSource - AuthenticationDetailsSource

redisConnectionFactory - redis connection factory

从以下版本开始:

5.1

方法详细资料

attemptAuthentication

public org.springframework.security.core.Authentication attemptAuthentication(javax.servlet.http.HttpServletRequest request,
                                                                              javax.servlet.http.HttpServletResponse response)
                                                                       throws org.springframework.security.core.AuthenticationException

指定者:

attemptAuthentication 在类中 org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

抛出:

org.springframework.security.core.AuthenticationException

successfulAuthentication

protected void successfulAuthentication(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        javax.servlet.FilterChain chain,
                                        org.springframework.security.core.Authentication authResult)
                                 throws IOException,
                                        javax.servlet.ServletException

覆盖:

successfulAuthentication 在类中 org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

抛出:

IOException

javax.servlet.ServletException

setDetails

protected void setDetails(javax.servlet.http.HttpServletRequest request,
                          Auth2LoginAuthenticationToken authRequest)

Provided so that subclasses may configure what is put into the auth request's details property.

参数:

request - that an auth request is being created for

authRequest - the auth request object that should have its details set

setRedirectStrategy

public void setRedirectStrategy(org.springframework.security.web.RedirectStrategy redirectStrategy)