Spring Security之AuthenticationManager、ProviderManager、AuthenticationProvider用户认证源码分析

快来打我* 2021-11-05 00:00 375阅读 0赞

### Spring Security之AuthenticationManager、ProviderManager、AuthenticationProvider用户认证源码分析 ###

AuthenticationManager类源码解析

public interface AuthenticationManager {
    	Authentication authenticate(Authentication authentication)
    			throws AuthenticationException;
    }

AuthenticationManager是一个顶级接口，用来处理身份验证请求，并返回一个Authentication对象，如果发生异常将会抛出AuthenticationException；  
AuthenticationManager的实现有很多，通常使用ProviderManager对认证请求链进行管理；

ProviderManager主要是对AuthenticationProvider链进项管理，看下注解描述：

* <tt>AuthenticationProvider</tt>s are usually tried in order until one provides a
     * non-null response. A non-null response indicates the provider had authority to decide
     * on the authentication request and no further providers are tried. If a subsequent
     * provider successfully authenticates the request, the earlier authentication exception
     * is disregarded and the successful authentication will be used. If no subsequent
     * provider provides a non-null response, or a new <code>AuthenticationException</code>,
     * the last <code>AuthenticationException</code> received will be used. If no provider
     * returns a non-null response, or indicates it can even process an
     * <code>Authentication</code>, the <code>ProviderManager</code> will throw a
     * <code>ProviderNotFoundException</code>. A parent {@code AuthenticationManager} can also
     * be set, and this will also be tried if none of the configured providers can perform the
     * authentication. This is intended to support namespace configuration options though and
     * is not a feature that should normally be required.

> TIPS:AuthenticationProvider通常按照认证请求链顺序去执行，一个返回非null响应表示程序验证通过，不再尝试验证其它的provider;如果后续提供的身份验证程序  
> 成功地对请求进行身份认证，则忽略先前的身份验证异常及null响应，并将使用成功的身份验证。如果没有provider提供一个非null响应，或者有一个新的抛出AuthenticationException，  
> 那么最后的AuthenticationException将会抛出。

ProviderManager中有一个List用来存储定义的AuthenticationProvider认证实现类，也可以认为是一个认证处理器链来支持同一个应用中的多个不同身份认证机制，ProviderManager将会根据顺序来进行验证

private List<AuthenticationProvider> providers = Collections.emptyList();

ProviderManager类继承AuthenticationManager接口，实现了authenticate方法

public Authentication authenticate(Authentication authentication)
    			throws AuthenticationException {
    		Class<? extends Authentication> toTest = authentication.getClass();
    		AuthenticationException lastException = null;
    		AuthenticationException parentException = null;
    		Authentication result = null;
    		Authentication parentResult = null;
    		boolean debug = logger.isDebugEnabled();
           //获取AuthenticationProvider对象，循环遍历
    		for (AuthenticationProvider provider : getProviders()) {
    		    //如果支持认证实现类就继续处理
    			if (!provider.supports(toTest)) {
    				continue;
    			}
    
    			if (debug) {
    				logger.debug("Authentication attempt using "
    						+ provider.getClass().getName());
    			}
    
    			try {
    			    //重点，调用实现类的authenticate方法进行真实业务逻辑认证处理
    				result = provider.authenticate(authentication);
    
    				if (result != null) {
    					copyDetails(authentication, result);
    					break;
    				}
    			}
    			catch (AccountStatusException e) {
    				prepareException(e, authentication);
    				// SEC-546: Avoid polling additional providers if auth failure is due to
    				// invalid account status
    				throw e;
    			}
    			catch (InternalAuthenticationServiceException e) {
    				prepareException(e, authentication);
    				throw e;
    			}
    			catch (AuthenticationException e) {
    				lastException = e;
    			}
    		}
    
    		if (result == null && parent != null) {
    			// Allow the parent to try.
    			try {
    				result = parentResult = parent.authenticate(authentication);
    			}
    			catch (ProviderNotFoundException e) {
    				// ignore as we will throw below if no other exception occurred prior to
    				// calling parent and the parent
    				// may throw ProviderNotFound even though a provider in the child already
    				// handled the request
    			}
    			catch (AuthenticationException e) {
    				lastException = parentException = e;
    			}
    		}
    
    		if (result != null) {
    			if (eraseCredentialsAfterAuthentication
    					&& (result instanceof CredentialsContainer)) {
    				// Authentication is complete. Remove credentials and other secret data
    				// from authentication
    				((CredentialsContainer) result).eraseCredentials();
    			}
    
    			// If the parent AuthenticationManager was attempted and successful than it will publish an AuthenticationSuccessEvent
    			// This check prevents a duplicate AuthenticationSuccessEvent if the parent AuthenticationManager already published it
    			if (parentResult == null) {
    			    //发送认证成功事件
    				eventPublisher.publishAuthenticationSuccess(result);
    			}
    			return result;
    		}
    
    		// Parent was null, or didn't authenticate (or throw an exception).
    
    		if (lastException == null) {
    			lastException = new ProviderNotFoundException(messages.getMessage(
    					"ProviderManager.providerNotFound",
    					new Object[] { toTest.getName() },
    					"No AuthenticationProvider found for {0}"));
    		}
    
    		// If the parent AuthenticationManager was attempted and failed than it will publish an AbstractAuthenticationFailureEvent
    		// This check prevents a duplicate AbstractAuthenticationFailureEvent if the parent AuthenticationManager already published it
    		if (parentException == null) {
    			prepareException(lastException, authentication);
    		}
    
    		throw lastException;
    	}

AuthenticationProvider是一个顶级的接口，里面只提供了两个方法

public interface AuthenticationProvider {
    	Authentication authenticate(Authentication authentication) throws AuthenticationException;
    	boolean supports(Class<?> authentication);
    }

> TIPS:AuthenticationProvider接口和AuthenticationManager接口很相似，只多了一个supports方法，它是用来验证是否支持某种身份验证方式；该接口通常是提供给开发人员  
> 实现，按照自己系统的特点来进行扩展验证

到这里你可能会有一个疑问，AuthenticationProvider对象是如何加入进AuthenticationProviders请求认证链的，上述的authenticate方法中getProviders()获取到的providers  
是通过构造函数来进行赋值的：

public ProviderManager(List<AuthenticationProvider> providers,
    			AuthenticationManager parent) {
    		Assert.notNull(providers, "providers list cannot be null");
    		this.providers = providers;
    		this.parent = parent;
    		checkState();
    	}

构造函数又是哪里调用呢？神秘面纱马上揭晓，WebSecurityConfigurerAdapter适配器类中有一个config方法

@Override
        protected void configure(AuthenticationManagerBuilder auth) throws Exception {
            // 加入自定义的安全认证
            auth.userDetailsService(this.authUserDetailsService)
                    .passwordEncoder(this.passwordEncoder())
                 .and()
                    .authenticationProvider(smsAuthenticationProvider())
                    .authenticationProvider(authenticationProvider());
        }

可以通过AuthenticationManagerBuilder对象的authenticationProvider方法添加AuthenticationProvider认证对象，看下authenticationProvider方法：

private List<AuthenticationProvider> authenticationProviders = new ArrayList<>();
    	public AuthenticationManagerBuilder authenticationProvider(
    			AuthenticationProvider authenticationProvider) {
    		this.authenticationProviders.add(authenticationProvider);
    		return this;
    	}

上面的是将AuthenticationProvider对象加入认证链中，下面的代码就是创建ProviderManager对象并初始化认证连：

@Override
    	protected ProviderManager performBuild() throws Exception {
    		if (!isConfigured()) {
    			logger.debug("No authenticationProviders and no parentAuthenticationManager defined. Returning null.");
    			return null;
    		}
    		//创建ProviderManager对象，并初始化请求认证链
    		ProviderManager providerManager = new ProviderManager(authenticationProviders,
    				parentAuthenticationManager);
    		if (eraseCredentials != null) {
    			providerManager.setEraseCredentialsAfterAuthentication(eraseCredentials);
    		}
    		if (eventPublisher != null) {
    			providerManager.setAuthenticationEventPublisher(eventPublisher);
    		}
    		providerManager = postProcess(providerManager);
    		return providerManager;
    	}

AuthenticationManagerBuilder类实现了ProviderManagerBuilder接口，接口如下：

public interface ProviderManagerBuilder<B extends ProviderManagerBuilder<B>> extends
    		SecurityBuilder<AuthenticationManager> {
    
    	/**
    	 * Add authentication based upon the custom {@link AuthenticationProvider} that is
    	 * passed in. Since the {@link AuthenticationProvider} implementation is unknown, all
    	 * customizations must be done externally and the {@link ProviderManagerBuilder} is
    	 * returned immediately.
    	 *
    	 * Note that an Exception is thrown if an error occurs when adding the {@link AuthenticationProvider}.
    	 *
    	 * @return a {@link ProviderManagerBuilder} to allow further authentication to be
    	 * provided to the {@link ProviderManagerBuilder}
    	 */
    	B authenticationProvider(AuthenticationProvider authenticationProvider);
    }

ProviderManagerBuilder接口中定义了一个方法authenticationProvider，这个方法就是就是用来新增自定义实现的AuthenticationProvider;

到这里用户认证从配置到AuthenticationManager、ProviderManager、AuthenticationPrivoder源码一步一步的分析完了，希望对学习Spring Security的你有所帮助。

GitHub源码：[https://github.com/mingyang66/spring-parent/blob/master/spring-security-oauth2-server-redis-service/providermanager.md][https_github.com_mingyang66_spring-parent_blob_master_spring-security-oauth2-server-redis-service_providermanager.md]

[https_github.com_mingyang66_spring-parent_blob_master_spring-security-oauth2-server-redis-service_providermanager.md]: https://github.com/mingyang66/spring-parent/blob/master/spring-security-oauth2-server-redis-service/providermanager.md