SpringSecurity-UsernamePasswordAuthenticationFilter的作用

　　UsernamePasswordAuthenticationFilter應該是我們最關注的Filter，因為它實現了我們最常用的基於用戶名和密碼的認證邏輯。

先看一下一個常用的form-login配置：

<form-login login-page="/login" 
        username-parameter="ssoId"  
        password-parameter="password"
        authentication-failure-url ="/loginfailure" 
        default-target-url="/loginsuccess"/>  
        <logout invalidate-session="true"/>

在這里可以自定義表單中對應的用戶名密碼的name，已經登錄登錄成功或失敗后跳轉的url地址以及登錄表單的action。

　　UsernamePasswordAuthenticationFilter繼承虛擬類AbstractAuthenticationProcessingFilter。

　　AbstractAuthenticationProcessingFilter要求設置一個authenticationManager，authenticationManager的實現類將實際處理請求的認證。AbstractAuthenticationProcessingFilter將攔截符合過濾規則的request，並試圖執行認證。子類必須實現 attemptAuthentication 方法，這個方法執行具體的認證。

　　認證處理：如果認證成功，將會把返回的Authentication對象存放在SecurityContext；然后setAuthenticationSuccessHandler(AuthenticationSuccessHandler)

方法將會調用；這里處理認證成功后跳轉url的邏輯；可以重新實現AuthenticationSuccessHandler的onAuthenticationSuccess方法，實現自己的邏輯，比如需要返回json格式數據時，就可以在這里重新相關邏輯。如果認證失敗，默認會返回401代碼給客戶端，當然也可以在<form-login>節點中配置失敗后跳轉的url，還可以重寫AuthenticationFailureHandler的onAuthenticationFailure方法實現自己的邏輯。

一個典型的自定義配置如下：

<beans:bean id="restfulUsernamePasswordAuthenticationFilter"  
        class="com.kingdee.core.config.RestfulUsernamePasswordAuthenticationFilter">  
        <beans:property name="authenticationManager" ref="authenticationManager" />  
        <beans:property name="authenticationSuccessHandler" ref="restfulAuthenticationSuccessHandler" />  
        <beans:property name="authenticationFailureHandler" ref="restfulAuthenticationFailureHandler" />  
        <beans:property name="loginUrl" value="/login/restful" />  
    </beans:bean>

 

下面先看一下authentication-manager的配置，這個配置實現自定義UserDetail，需要重新實現一個繼承UserDetailsService接口的類。

<authentication-manager alias="authenticationManager">  
        <authentication-provider user-service-ref="customUserDetailsService">  
            <password-encoder ref="bcryptEncoder"/> 
        </authentication-provider>  
    </authentication-manager>

我們看到authentication-manager節點有一個子節點authentication-provider，而authentication-provider有一個屬性user-service-ref，user-service-ref的值就是我們要實現的自定義類。

整個調用過程大致如下：

　　繼承虛擬類AbstractAuthenticationProcessingFilter的UsernamePasswordAuthenticationFilter實現了attemptAuthentication方法

public Authentication attemptAuthentication(HttpServletRequest request,
            HttpServletResponse response) throws AuthenticationException {
        if (postOnly && !request.getMethod().equals("POST")) {
            throw new AuthenticationServiceException(
                    "Authentication method not supported: " + request.getMethod());
        }

        String username = obtainUsername(request);
        String password = obtainPassword(request);

        if (username == null) {
            username = "";
        }

        if (password == null) {
            password = "";
        }

        username = username.trim();

        UsernamePasswordAuthenticationToken authRequest = new UsernamePasswordAuthenticationToken(
                username, password);

        // Allow subclasses to set the "details" property
        setDetails(request, authRequest);

        return this.getAuthenticationManager().authenticate(authRequest);
    }

這個方法的最后this.getAuthenticationManager().authenticate(authRequest)是實現自接口Authentication，而實現這個接口的類中有一個叫ProviderManager的，它有一個成員變量List<AuthenticationProvider>，對應於我們配置文件中的authentication-provider，這里也說明是可以配置多個authentication-provider的。我們只使用一個我們需要的。我們需要關注的是AbstractUserDetailsAuthenticationProvider這個虛擬類，它實現了我們所需要的authenticate方法：

public Authentication authenticate(Authentication authentication)
            throws AuthenticationException {
        Assert.isInstanceOf(UsernamePasswordAuthenticationToken.class, authentication,
                messages.getMessage(
                        "AbstractUserDetailsAuthenticationProvider.onlySupports",
                        "Only UsernamePasswordAuthenticationToken is supported"));

        // Determine username
        String username = (authentication.getPrincipal() == null) ? "NONE_PROVIDED"
                : authentication.getName();

        boolean cacheWasUsed = true;
        UserDetails user = this.userCache.getUserFromCache(username);

        if (user == null) {
            cacheWasUsed = false;

            try {
                user = retrieveUser(username,
                        (UsernamePasswordAuthenticationToken) authentication);
            }
            catch (UsernameNotFoundException notFound) {
                logger.debug("User '" + username + "' not found");

                if (hideUserNotFoundExceptions) {
                    throw new BadCredentialsException(messages.getMessage(
                            "AbstractUserDetailsAuthenticationProvider.badCredentials",
                            "Bad credentials"));
                }
                else {
                    throw notFound;
                }
            }

            Assert.notNull(user,
                    "retrieveUser returned null - a violation of the interface contract");
        }

        try {
            preAuthenticationChecks.check(user);
            additionalAuthenticationChecks(user,
                    (UsernamePasswordAuthenticationToken) authentication);
        }
        catch (AuthenticationException exception) {
            if (cacheWasUsed) {
                // There was a problem, so try again after checking
                // we're using latest data (i.e. not from the cache)
                cacheWasUsed = false;
                user = retrieveUser(username,
                        (UsernamePasswordAuthenticationToken) authentication);
                preAuthenticationChecks.check(user);
                additionalAuthenticationChecks(user,
                        (UsernamePasswordAuthenticationToken) authentication);
            }
            else {
                throw exception;
            }
        }

        postAuthenticationChecks.check(user);

        if (!cacheWasUsed) {
            this.userCache.putUserInCache(user);
        }

        Object principalToReturn = user;

        if (forcePrincipalAsString) {
            principalToReturn = user.getUsername();
        }

        return createSuccessAuthentication(principalToReturn, authentication, user);
    }

從代碼中可以看到，它會先從cache中取user（這與配置有關，這里我們不涉及），如果沒有，在執行retrieveUser方法。代碼中還可以看到，UsernameNotFoundException默認是被轉換成BadCredentialsException的。

它的子類DaoAuthenticationProvider重寫了retrieveUser方法：

protected final UserDetails retrieveUser(String username,
            UsernamePasswordAuthenticationToken authentication)
            throws AuthenticationException {
        UserDetails loadedUser;

        try {
            loadedUser = this.getUserDetailsService().loadUserByUsername(username);
        }
        catch (UsernameNotFoundException notFound) {
            if (authentication.getCredentials() != null) {
                String presentedPassword = authentication.getCredentials().toString();
                passwordEncoder.isPasswordValid(userNotFoundEncodedPassword,
                        presentedPassword, null);
            }
            throw notFound;
        }
        catch (Exception repositoryProblem) {
            throw new InternalAuthenticationServiceException(
                    repositoryProblem.getMessage(), repositoryProblem);
        }

        if (loadedUser == null) {
            throw new InternalAuthenticationServiceException(
                    "UserDetailsService returned null, which is an interface contract violation");
        }
        return loadedUser;
    }

在代碼第7行可以看到，UserDetails從UserDetailsService().loadUserByUsername(username)中獲得的。我們已經配置了userService方法，所以只要在配置類中重寫loadUserByUsername(username)方法就可以了。這里需要注意的是我們重寫的方法需要返回一個實現了UserDetails接口的對象，而org.springframework.security.core.userdetails.User就是我們經常實際返回的對象。

它的一個構造方法如下：

public User(String username, String password, boolean enabled,
            boolean accountNonExpired, boolean credentialsNonExpired,
            boolean accountNonLocked, Collection<? extends GrantedAuthority> authorities) {

        if (((username == null) || "".equals(username)) || (password == null)) {
            throw new IllegalArgumentException(
                    "Cannot pass null or empty values to constructor");
        }

        this.username = username;
        this.password = password;
        this.enabled = enabled;
        this.accountNonExpired = accountNonExpired;
        this.credentialsNonExpired = credentialsNonExpired;
        this.accountNonLocked = accountNonLocked;
        this.authorities = Collections.unmodifiableSet(sortAuthorities(authorities));
    }

我們根據自己的需要，從數據庫中取得user和user對應的權限，構造一個org.springframework.security.core.userdetails.User返回即可。

這里只是重新實現了User的認證方法，如果想在SecurityContext中添加用戶的其他信息，如email,address等，可以新指定一個authentication-provider的實現類，可以實現復用DaoAuthenticationProvider的大部分代碼，只需要添加authentication.setDetails的相關代碼即可。雖然UsernamePasswordAuthenticationFilter的注釋是在setDetails(request, authRequest);方法中實現添加自定義的details，但也可以根據實際情況修改。甚至可以不用在這里修改，直接把需要的信息放在httpSession中。

 

這些博客都是重在理解SpringSecurity的工作過程，有助於重寫一些自己的邏輯，但不涉及重寫的具體實現（這些實現很多是可以在網上找到的）。