Spring Security做JWT認證和授權(quán)

上一篇博客講了如何使用Shiro和JWT做認證和授權(quán)(傳送門:http://www.reibang.com/p/0b1131be7ace),總的來說shiro是一個比較早期和簡單的框架,這個從最近已經(jīng)基本不做版本更新就可以看出來瞒御。這篇文章我們講一下如何使用更加流行和完整的spring security來實現(xiàn)同樣的需求。

Spring Security的架構(gòu)

按照慣例神郊,在使用之前我們先講一下簡單的架構(gòu)肴裙。不知道是因為spring-security后出來還是因為優(yōu)秀的設(shè)計殊途同歸,對于核心模塊涌乳,spring-security和shiro有80%以上的設(shè)計相似度蜻懦。所以下面介紹中會多跟shiro做對比,如果你對shiro不了解也沒關(guān)系夕晓,跟shiro對比的部分跳過就好宛乃。

spring-security中核心概念

  • AuthenticationManager, 用戶認證的管理類,所有的認證請求(比如login)都會通過提交一個token給AuthenticationManagerauthenticate()方法來實現(xiàn)蒸辆。當然事情肯定不是它來做征炼,具體校驗動作會由AuthenticationManager將請求轉(zhuǎn)發(fā)給具體的實現(xiàn)類來做。根據(jù)實現(xiàn)反饋的結(jié)果再調(diào)用具體的Handler來給用戶以反饋躬贡。這個類基本等同于shiro的SecurityManager谆奥。
  • AuthenticationProvider, 認證的具體實現(xiàn)類,一個provider是一種認證方式的實現(xiàn)拂玻,比如提交的用戶名密碼我是通過和DB中查出的user記錄做比對實現(xiàn)的酸些,那就有一個DaoProvider;如果我是通過CAS請求單點登錄系統(tǒng)實現(xiàn)檐蚜,那就有一個CASProvider魄懂。這個是不是和shiro的Realm的定義很像?基本上你可以幫他們當成同一個東西闯第。按照Spring一貫的作風逢渔,主流的認證方式它都已經(jīng)提供了默認實現(xiàn),比如DAO乡括、LDAP肃廓、CAS智厌、OAuth2等。
    前面講了AuthenticationManager只是一個代理接口盲赊,真正的認證就是由AuthenticationProvider來做的铣鹏。一個AuthenticationManager可以包含多個Provider,每個provider通過實現(xiàn)一個support方法來表示自己支持那種Token的認證哀蘑。AuthenticationManager默認的實現(xiàn)類是ProviderManager诚卸。
  • UserDetailService, 用戶認證通過Provider來做,所以Provider需要拿到系統(tǒng)已經(jīng)保存的認證信息绘迁,獲取用戶信息的接口spring-security抽象成UserDetailService合溺。雖然叫Service,但是我更愿意把它認為是我們系統(tǒng)里經(jīng)常有的UserDao
  • AuthenticationToken, 所有提交給AuthenticationManager的認證請求都會被封裝成一個Token的實現(xiàn)缀台,比如最容易理解的UsernamePasswordAuthenticationToken棠赛。這個就不多講了,連名字都跟Shiro中一樣膛腐。
  • SecurityContext睛约,當用戶通過認證之后,就會為這個用戶生成一個唯一的SecurityContext哲身,里面包含用戶的認證信息Authentication辩涝。通過SecurityContext我們可以獲取到用戶的標識Principle和授權(quán)信息GrantedAuthrity。在系統(tǒng)的任何地方只要通過SecurityHolder.getSecruityContext()就可以獲取到SecurityContext勘天。在Shiro中通過SecurityUtils.getSubject()到達同樣的目的怔揩。
    我們大概通過一個認證流程來認識下上面幾個關(guān)鍵的概念
    認證流程

對web系統(tǒng)的支持

毫無疑問,對于spring框架使用最多的還是web系統(tǒng)脯丝。對于web系統(tǒng)來說進入認證的最佳入口就是Filter了商膊。spring security不僅實現(xiàn)了認證的邏輯,還通過filter實現(xiàn)了常見的web攻擊的防護巾钉。
常用Filter
下面按照request進入的順序列舉一下常用的Filter:

  • SecurityContextPersistenceFilter翘狱,用于將SecurityContext放入Session的Filter
  • UsernamePasswordAuthenticationFilter, 登錄認證的Filter,類似的還有CasAuthenticationFilter,BasicAuthenticationFilter等等砰苍。在這些Filter中生成用于認證的token潦匈,提交到AuthenticationManager,如果認證失敗會直接返回赚导。
  • RememberMeAuthenticationFilter茬缩,通過cookie來實現(xiàn)remember me功能的Filter
  • AnonymousAuthenticationFilter,如果一個請求在到達這個filter之前SecurityContext沒有初始化吼旧,則這個filter會默認生成一個匿名SecurityContext凰锡。這在支持匿名用戶的系統(tǒng)中非常有用。
  • ExceptionTranslationFilter,捕獲所有Spring Security拋出的異常掂为,并決定處理方式
  • FilterSecurityInterceptor裕膀, 權(quán)限校驗的攔截器,訪問的url權(quán)限不足時會拋出異常
    Filter的順序
    既然用了上面那么多filter勇哗,它們在FilterChain中的先后順序就顯得非常重要了昼扛。對于每一個系統(tǒng)或者用戶自定義的filter,spring security都要求必須指定一個order欲诺,用來做排序抄谐。對于系統(tǒng)的filter的默認順序,是在一個FilterComparator類中定義的扰法,核心實現(xiàn)如下蛹含。
    FilterComparator() {
        int order = 100;
        put(ChannelProcessingFilter.class, order);
        order += STEP;
        put(ConcurrentSessionFilter.class, order);
        order += STEP;
        put(WebAsyncManagerIntegrationFilter.class, order);
        order += STEP;
        put(SecurityContextPersistenceFilter.class, order);
        order += STEP;
        put(HeaderWriterFilter.class, order);
        order += STEP;
        put(CorsFilter.class, order);
        order += STEP;
        put(CsrfFilter.class, order);
        order += STEP;
        put(LogoutFilter.class, order);
        order += STEP;
        filterToOrder.put(
            "org.springframework.security.oauth2.client.web.OAuth2AuthorizationRequestRedirectFilter",
            order);
        order += STEP;
        put(X509AuthenticationFilter.class, order);
        order += STEP;
        put(AbstractPreAuthenticatedProcessingFilter.class, order);
        order += STEP;
        filterToOrder.put("org.springframework.security.cas.web.CasAuthenticationFilter",
                order);
        order += STEP;
        filterToOrder.put(
            "org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter",
            order);
        order += STEP;
        put(UsernamePasswordAuthenticationFilter.class, order);
        order += STEP;
        put(ConcurrentSessionFilter.class, order);
        order += STEP;
        filterToOrder.put(
                "org.springframework.security.openid.OpenIDAuthenticationFilter", order);
        order += STEP;
        put(DefaultLoginPageGeneratingFilter.class, order);
        order += STEP;
        put(ConcurrentSessionFilter.class, order);
        order += STEP;
        put(DigestAuthenticationFilter.class, order);
        order += STEP;
        put(BasicAuthenticationFilter.class, order);
        order += STEP;
        put(RequestCacheAwareFilter.class, order);
        order += STEP;
        put(SecurityContextHolderAwareRequestFilter.class, order);
        order += STEP;
        put(JaasApiIntegrationFilter.class, order);
        order += STEP;
        put(RememberMeAuthenticationFilter.class, order);
        order += STEP;
        put(AnonymousAuthenticationFilter.class, order);
        order += STEP;
        put(SessionManagementFilter.class, order);
        order += STEP;
        put(ExceptionTranslationFilter.class, order);
        order += STEP;
        put(FilterSecurityInterceptor.class, order);
        order += STEP;
        put(SwitchUserFilter.class, order);
    }

對于用戶自定義的filter,如果要加入spring security 的FilterChain中塞颁,必須指定加到已有的那個filter之前或者之后浦箱,具體下面我們用到自定義filter的時候會說明。

JWT認證的實現(xiàn)

關(guān)于使用JWT認證的原因殴边,上一篇介紹Shiro的文章中已經(jīng)說過了憎茂,這里不再多說珍语。需求也還是那3個:

  • 支持用戶通過用戶名和密碼登錄
  • 登錄后通過http header返回token锤岸,每次請求,客戶端需通過header將token帶回板乙,用于權(quán)限校驗
  • 服務(wù)端負責token的定期刷新
    下面我們直接進入Spring Secuiry的項目搭建是偷。

項目搭建

gradle配置

最新的spring項目開始默認使用gradle來做依賴管理了,所以這個項目也嘗試下gradle的配置募逞。除了springmvc和security的starter之外蛋铆,還依賴了auth0的jwt工具包。JSON處理使用了fastjson放接。

buildscript {
    ext {
        springBootVersion = '2.0.4.RELEASE'
    }
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

group = 'com.github.springboot'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
    mavenCentral()
}


dependencies {
    compile('org.springframework.boot:spring-boot-starter-security')    
    compile('org.springframework.boot:spring-boot-starter-web')
    compile('org.apache.commons:commons-lang3:3.8')
    compile('com.auth0:java-jwt:3.4.0')
    compile('com.alibaba:fastjson:1.2.47')
    
    testCompile('org.springframework.boot:spring-boot-starter-test')
    testCompile('org.springframework.security:spring-security-test')
}

登錄認證流程

Filter
對于用戶登錄行為刺啦,security通過定義一個Filter來攔截/login來實現(xiàn)的。spring security默認支持form方式登錄纠脾,所以對于使用json發(fā)送登錄信息的情況玛瘸,我們自己定義一個Filter,這個Filter直接從AbstractAuthenticationProcessingFilter繼承苟蹈,只需要實現(xiàn)兩部分糊渊,一個是RequestMatcher,指名攔截的Request類型慧脱;另外就是從json body中提取出username和password提交給AuthenticationManager渺绒。

public class MyUsernamePasswordAuthenticationFilter extends AbstractAuthenticationProcessingFilter {
    
    public MyUsernamePasswordAuthenticationFilter() {
         //攔截url為 "/login" 的POST請求
        super(new AntPathRequestMatcher("/login", "POST"));
    }

    @Override
    public Authentication attemptAuthentication(HttpServletRequest request, HttpServletResponse response)
            throws AuthenticationException, IOException, ServletException {
        //從json中獲取username和password
        String body = StreamUtils.copyToString(request.getInputStream(), Charset.forName("UTF-8"));
        String username = null, password = null;
        if(StringUtils.hasText(body)) {
            JSONObject jsonObj = JSON.parseObject(body);
            username = jsonObj.getString("username");
            password = jsonObj.getString("password");
        }   
        
        if (username == null) 
            username = "";
        if (password == null)
            password = "";
        username = username.trim();
       //封裝到token中提交
        UsernamePasswordAuthenticationToken authRequest = new UsernamePasswordAuthenticationToken(
                username, password);
        
        return this.getAuthenticationManager().authenticate(authRequest);
    }

}

Provider
前面的流程圖中講到了,封裝后的token最終是交給provider來處理的。對于登錄的provider宗兼,spring security已經(jīng)提供了一個默認實現(xiàn)DaoAuthenticationProvider我們可以直接使用躏鱼,這個類繼承了AbstractUserDetailsAuthenticationProvider我們來看下關(guān)鍵部分的源代碼是怎么做的。

public abstract class AbstractUserDetailsAuthenticationProvider implements
        AuthenticationProvider, InitializingBean, MessageSourceAware {
...
    //這個方法返回true殷绍,說明支持該類型的token
    public boolean supports(Class<?> authentication) {
        return (UsernamePasswordAuthenticationToken.class
                .isAssignableFrom(authentication));
   }
    public Authentication authenticate(Authentication authentication)
            throws AuthenticationException {
             ...

            try {
            // 獲取系統(tǒng)中存儲的用戶信息
                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;
                }
            }

            
        }

        try {
           //檢查user是否已過期或者已鎖定
            preAuthenticationChecks.check(user);
           //將獲取到的用戶信息和登錄信息做比對
            additionalAuthenticationChecks(user,
                    (UsernamePasswordAuthenticationToken) authentication);
        }
        catch (AuthenticationException exception) {
            ...
            throw exception;            
        }
        ...
        //如果認證通過挠他,則封裝一個AuthenticationInfo, 放到SecurityContext中
        return createSuccessAuthentication(principalToReturn, authentication, user);
    }

...
}

上面的代碼中,核心流程就是retrieveUser()獲取系統(tǒng)中存儲的用戶信息篡帕,再對用戶信息做了過期和鎖定等校驗后交給additionalAuthenticationChecks()和用戶提交的信息做比對殖侵。
這兩個方法我們看他的繼承類DaoAuthenticationProvider是怎么實現(xiàn)的。

public class DaoAuthenticationProvider extends AbstractUserDetailsAuthenticationProvider {
    /**
     * 加密密碼比對
     */
     protected void additionalAuthenticationChecks(UserDetails userDetails,
            UsernamePasswordAuthenticationToken authentication)
            throws AuthenticationException {
        if (authentication.getCredentials() == null) {
            logger.debug("Authentication failed: no credentials provided");

            throw new BadCredentialsException(messages.getMessage(
                    "AbstractUserDetailsAuthenticationProvider.badCredentials",
                    "Bad credentials"));
        }

        String presentedPassword = authentication.getCredentials().toString();

        if (!passwordEncoder.matches(presentedPassword, userDetails.getPassword())) {
            logger.debug("Authentication failed: password does not match stored value");

            throw new BadCredentialsException(messages.getMessage(
                    "AbstractUserDetailsAuthenticationProvider.badCredentials",
                    "Bad credentials"));
        }
    }
   /**
    * 系統(tǒng)用戶獲取
    */
    protected final UserDetails retrieveUser(String username,
            UsernamePasswordAuthenticationToken authentication)
            throws AuthenticationException {
        prepareTimingAttackProtection();
        try {
            UserDetails loadedUser = this.getUserDetailsService().loadUserByUsername(username);
            if (loadedUser == null) {
                throw new InternalAuthenticationServiceException(
                        "UserDetailsService returned null, which is an interface contract violation");
            }
            return loadedUser;
        }
        catch (UsernameNotFoundException ex) {
            mitigateAgainstTimingAttack(authentication);
            throw ex;
        }
        catch (InternalAuthenticationServiceException ex) {
            throw ex;
        }
        catch (Exception ex) {
            throw new InternalAuthenticationServiceException(ex.getMessage(), ex);
        }
    }
}

上面的方法實現(xiàn)中镰烧,用戶獲取是調(diào)用了UserDetailsService來完成的拢军。這個是一個只有一個方法的接口,所以我們自己要做的怔鳖,就是將自己的UserDetailsService實現(xiàn)類配置成一個Bean茉唉。下面是實例代碼,真正的實現(xiàn)需要從數(shù)據(jù)庫或者緩存中獲取结执。

public class JwtUserService implements UserDetailsService{
    //真實系統(tǒng)需要從數(shù)據(jù)庫或緩存中獲取度陆,這里對密碼做了加密
     return User.builder().username("Jack").password(passwordEncoder.encode("jack-password")).roles("USER").build();
}

我們再來看另外一個密碼比對的方法,也是委托給一個PasswordEncoder類來實現(xiàn)的献幔。一般來說懂傀,存在數(shù)據(jù)庫中的密碼都是要經(jīng)過加密處理的,這樣萬一數(shù)據(jù)庫數(shù)據(jù)被拖走蜡感,也不會泄露密碼蹬蚁。spring一如既往的提供了主流的加密方式,如MD5,SHA等郑兴。如果不顯示指定的話犀斋,Spring會默認使用BCryptPasswordEncoder,這個是目前相對比較安全的加密方式情连。具體介紹可參考spring-security 的官方文檔 - Password Endcoding
認證結(jié)果處理
filter將token交給provider做校驗叽粹,校驗的結(jié)果無非兩種,成功或者失敗却舀。對于這兩種結(jié)果虫几,我們只需要實現(xiàn)兩個Handler接口,set到Filter里面禁筏,F(xiàn)ilter在收到Provider的處理結(jié)果后會回調(diào)這兩個Handler的方法持钉。
先來看成功的情況,針對jwt認證的業(yè)務(wù)場景篱昔,登錄成功需要返回給客戶端一個token每强。所以成功的handler的實現(xiàn)類中需要包含這個邏輯始腾。

public class JsonLoginSuccessHandler implements AuthenticationSuccessHandler{
    
    private JwtUserService jwtUserService;
    
    public JsonLoginSuccessHandler(JwtUserService jwtUserService) {
        this.jwtUserService = jwtUserService;
    }

    @Override
    public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response,
            Authentication authentication) throws IOException, ServletException {
                //生成token,并把token加密相關(guān)信息緩存空执,具體請看實現(xiàn)類
        String token = jwtUserService.saveUserLoginInfo((UserDetails)authentication.getPrincipal());
        response.setHeader("Authorization", token);
    }
    
}

再來看失敗的情況浪箭,登錄失敗比較簡單,只需要回復一個401的Response即可辨绊。

public class HttpStatusLoginFailureHandler implements AuthenticationFailureHandler{
    @Override
    public void onAuthenticationFailure(HttpServletRequest request, HttpServletResponse response,
            AuthenticationException exception) throws IOException, ServletException {
        response.setStatus(HttpStatus.UNAUTHORIZED.value());    
    }   
}

JsonLoginConfigurer
以上整個登錄的流程的組件就完整了奶栖,我們只需要把它們組合到一起就可以了。這里繼承一個AbstractHttpConfigurer门坷,對Filter做配置宣鄙。

public class JsonLoginConfigurer<T extends JsonLoginConfigurer<T, B>, B extends HttpSecurityBuilder<B>> extends AbstractHttpConfigurer<T, B>  {

    private MyUsernamePasswordAuthenticationFilter authFilter;

    public JsonLoginConfigurer() {
        this.authFilter = new MyUsernamePasswordAuthenticationFilter();
    }
    
    @Override
    public void configure(B http) throws Exception {
        //設(shè)置Filter使用的AuthenticationManager,這里取公共的即可
        authFilter.setAuthenticationManager(http.getSharedObject(AuthenticationManager.class));
        //設(shè)置失敗的Handler
        authFilter.setAuthenticationFailureHandler(new HttpStatusLoginFailureHandler());
        //不將認證后的context放入session
        authFilter.setSessionAuthenticationStrategy(new NullAuthenticatedSessionStrategy());

        MyUsernamePasswordAuthenticationFilter filter = postProcess(authFilter);
        //指定Filter的位置
        http.addFilterAfter(filter, LogoutFilter.class);
    }
    //設(shè)置成功的Handler,這個handler定義成Bean默蚌,所以從外面set進來
    public JsonLoginConfigurer<T,B> loginSuccessHandler(AuthenticationSuccessHandler authSuccessHandler){
        authFilter.setAuthenticationSuccessHandler(authSuccessHandler);
        return this;
    }

}

這樣Filter就完整的配置好了冻晤,當調(diào)用configure方法時,這個filter就會加入security FilterChain的指定位置绸吸。這個是在全局定義的地方鼻弧,我們放在最后說。在全局配置的地方锦茁,也會將DaoAuthenticationProvider放到ProviderManager中攘轩,這樣filter中提交的token就可以被處理了。

帶Token請求校驗流程

用戶除登錄之外的請求码俩,都要求必須攜帶JWT Token度帮。所以我們需要另外一個Filter對這些請求做一個攔截。這個攔截器主要是提取header中的token握玛,跟登錄一樣够傍,提交給AuthenticationManager做檢查甫菠。
Filter

public class JwtAuthenticationFilter extends OncePerRequestFilter{
    ...
    public JwtAuthenticationFilter() {
        //攔截header中帶Authorization的請求
        this.requiresAuthenticationRequestMatcher = new RequestHeaderRequestMatcher("Authorization");
    }
    
    protected String getJwtToken(HttpServletRequest request) {
        String authInfo = request.getHeader("Authorization");
        return StringUtils.removeStart(authInfo, "Bearer ");
    }

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
       //header沒帶token的挠铲,直接放過,因為部分url匿名用戶也可以訪問
       //如果需要不支持匿名用戶的請求沒帶token寂诱,這里放過也沒問題拂苹,因為SecurityContext中沒有認證信息,后面會被權(quán)限控制模塊攔截
        if (!requiresAuthentication(request, response)) {
            filterChain.doFilter(request, response);
            return;
        }
        Authentication authResult = null;
        AuthenticationException failed = null;
        try {
            //從頭中獲取token并封裝后提交給AuthenticationManager
            String token = getJwtToken(request);
            if(StringUtils.isNotBlank(token)) {
                JwtAuthenticationToken authToken = new JwtAuthenticationToken(JWT.decode(token));               
                authResult = this.getAuthenticationManager().authenticate(authToken);
            } else {  //如果token長度為0
                failed = new InsufficientAuthenticationException("JWT is Empty");
            }
        } catch(JWTDecodeException e) {
            logger.error("JWT format error", e);
            failed = new InsufficientAuthenticationException("JWT format error", failed);
        }catch (InternalAuthenticationServiceException e) {
            logger.error(
                    "An internal error occurred while trying to authenticate the user.",
                    failed);
            failed = e;
        }catch (AuthenticationException e) {
            // Authentication failed            
            failed = e;
        }
        if(authResult != null) {   //token認證成功
            successfulAuthentication(request, response, filterChain, authResult);
        } else if(!permissiveRequest(request)){   
            //token認證失敗痰洒,并且這個request不在例外列表里瓢棒,才會返回錯誤
            unsuccessfulAuthentication(request, response, failed);
            return;
        }
        filterChain.doFilter(request, response);
    }
    
    ...

    protected boolean requiresAuthentication(HttpServletRequest request,
            HttpServletResponse response) {
        return requiresAuthenticationRequestMatcher.matches(request);
    }
    
    protected boolean permissiveRequest(HttpServletRequest request) {
        if(permissiveRequestMatchers == null)
            return false;
        for(RequestMatcher permissiveMatcher : permissiveRequestMatchers) {
            if(permissiveMatcher.matches(request))
                return true;
        }       
        return false;
    }
}

這個Filter的實現(xiàn)跟登錄的Filter有幾點區(qū)別:

  • 經(jīng)過這個Filter的請求,會繼續(xù)過FilterChain中的其它Filter丘喻。因為跟登錄請求不一樣脯宿,token只是為了識別用戶。
  • 如果header中沒有認證信息或者認證失敗泉粉,還會判斷請求的url是否強制認證的(通過permissiveRequest方法判斷)连霉。如果請求不是強制認證榴芳,也會放過,這種情況比如博客類應(yīng)用匿名用戶訪問查看頁面跺撼;比如登出操作,如果未登錄用戶點擊登出歉井,我們一般是不會報錯的柿祈。
    其它邏輯跟登錄一樣躏嚎,組裝一個token提交給AuthenticationManager菜谣。

JwtAuthenticationProvider
同樣我們需要一個provider來接收jwt的token抓谴,在收到token請求后暮蹂,會從數(shù)據(jù)庫或者緩存中取出salt,對token做驗證癌压,代碼如下:

public class JwtAuthenticationProvider implements AuthenticationProvider{
    
    private JwtUserService userService;
    
    public JwtAuthenticationProvider(JwtUserService userService) {
        this.userService = userService;
    }

    @Override
    public Authentication authenticate(Authentication authentication) throws AuthenticationException {
        DecodedJWT jwt = ((JwtAuthenticationToken)authentication).getToken();
        if(jwt.getExpiresAt().before(Calendar.getInstance().getTime()))
            throw new NonceExpiredException("Token expires");
        String username = jwt.getSubject();
        UserDetails user = userService.getUserLoginInfo(username);
        if(user == null || user.getPassword()==null)
            throw new NonceExpiredException("Token expires");
        String encryptSalt = user.getPassword();
        try {
            Algorithm algorithm = Algorithm.HMAC256(encryptSalt);
            JWTVerifier verifier = JWT.require(algorithm)
                    .withSubject(username)
                    .build();
            verifier.verify(jwt.getToken());
        } catch (Exception e) {
            throw new BadCredentialsException("JWT token verify fail", e);
        }
        //成功后返回認證信息怎顾,filter會將認證信息放入SecurityContext
        JwtAuthenticationToken token = new JwtAuthenticationToken(user, jwt, user.getAuthorities());
        return token;
    }

    @Override
    public boolean supports(Class<?> authentication) {
        return authentication.isAssignableFrom(JwtAuthenticationToken.class);
    }

}

認證結(jié)果Handler
如果token認證失敗焕参,并且不在permissive列表中話,就會調(diào)用FailHandler,這個Handler和登錄行為一致慌烧,所以都使用HttpStatusLoginFailureHandler 返回401錯誤盟迟。
token認證成功端姚,在繼續(xù)FilterChain中的其它Filter之前设褐,我們先檢查一下token是否需要刷新,刷新成功后會將新token放入header中泡挺。所以辈讶,新增一個JwtRefreshSuccessHandler來處理token認證成功的情況。

public class JwtRefreshSuccessHandler implements AuthenticationSuccessHandler{
    
    private static final int tokenRefreshInterval = 300;  //刷新間隔5分鐘
    
    private JwtUserService jwtUserService;
    
    public JwtRefreshSuccessHandler(JwtUserService jwtUserService) {
        this.jwtUserService = jwtUserService;
    }

    @Override
    public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response,
            Authentication authentication) throws IOException, ServletException {
        DecodedJWT jwt = ((JwtAuthenticationToken)authentication).getToken();
        boolean shouldRefresh = shouldTokenRefresh(jwt.getIssuedAt());
        if(shouldRefresh) {
            String newToken = jwtUserService.saveUserLoginInfo((UserDetails)authentication.getPrincipal());
            response.setHeader("Authorization", newToken);
        }   
    }
    
    protected boolean shouldTokenRefresh(Date issueAt){
        LocalDateTime issueTime = LocalDateTime.ofInstant(issueAt.toInstant(), ZoneId.systemDefault());
        return LocalDateTime.now().minusSeconds(tokenRefreshInterval).isAfter(issueTime);
    }

}

JwtLoginConfigurer
跟登錄邏輯一樣娄猫,我們定義一個configurer贱除,用來初始化和配置JWTFilter咳促。

public class JwtLoginConfigurer<T extends JwtLoginConfigurer<T, B>, B extends HttpSecurityBuilder<B>> extends AbstractHttpConfigurer<T, B> {
    
    private JwtAuthenticationFilter authFilter;
    
    public JwtLoginConfigurer() {
        this.authFilter = new JwtAuthenticationFilter();
    }
    
    @Override
    public void configure(B http) throws Exception {
        authFilter.setAuthenticationManager(http.getSharedObject(AuthenticationManager.class));
        authFilter.setAuthenticationFailureHandler(new HttpStatusLoginFailureHandler());
        //將filter放到logoutFilter之前
        JwtAuthenticationFilter filter = postProcess(authFilter);
        http.addFilterBefore(filter, LogoutFilter.class);
    }
    //設(shè)置匿名用戶可訪問url
    public JwtLoginConfigurer<T, B> permissiveRequestUrls(String ... urls){
        authFilter.setPermissiveUrl(urls);
        return this;
    }
    
    public JwtLoginConfigurer<T, B> tokenValidSuccessHandler(AuthenticationSuccessHandler successHandler){
        authFilter.setAuthenticationSuccessHandler(successHandler);
        return this;
    }
    
}

配置集成

整個登錄和無狀態(tài)用戶認證的流程都已經(jīng)講完了,現(xiàn)在我們需要吧spring security集成到我們的web項目中去勘伺。spring security和spring mvc做了很好的集成跪腹,一共只需要做兩件事,給web配置類加上@EanbleWebSecurity飞醉,繼承WebSecurityConfigurerAdapter定義個性化配置冲茸。
配置類WebSecurityConfig

@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter{

    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/image/**").permitAll() //靜態(tài)資源訪問無需認證
                .antMatchers("/admin/**").hasAnyRole("ADMIN") //admin開頭的請求,需要admin權(quán)限
                .antMatchers("/article/**").hasRole("USER") //需登陸才能訪問的url
                .anyRequest().authenticated()  //默認其它的請求都需要認證缅帘,這里一定要添加
                .and()
            .csrf().disable()  //CRSF禁用轴术,因為不使用session
            .sessionManagement().disable()  //禁用session
            .formLogin().disable() //禁用form登錄
            .cors()  //支持跨域
            .and()   //添加header設(shè)置,支持跨域和ajax請求
            .headers().addHeaderWriter(new StaticHeadersWriter(Arrays.asList(
                    new Header("Access-control-Allow-Origin","*"),
                    new Header("Access-Control-Expose-Headers","Authorization"))))
            .and() //攔截OPTIONS請求钦无,直接返回header
            .addFilterAfter(new OptionRequestFilter(), CorsFilter.class)
            //添加登錄filter
            .apply(new JsonLoginConfigurer<>()).loginSuccessHandler(jsonLoginSuccessHandler())
            .and()
           //添加token的filter
            .apply(new JwtLoginConfigurer<>()).tokenValidSuccessHandler(jwtRefreshSuccessHandler()).permissiveRequestUrls("/logout")
            .and()
            //使用默認的logoutFilter
            .logout()
//              .logoutUrl("/logout")   //默認就是"/logout"
                .addLogoutHandler(tokenClearLogoutHandler())  //logout時清除token
                .logoutSuccessHandler(new HttpStatusReturningLogoutSuccessHandler()) //logout成功后返回200
            .and()
            .sessionManagement().disable();
    }
    //配置provider
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.authenticationProvider(daoAuthenticationProvider()).authenticationProvider(jwtAuthenticationProvider());
    }
    
    @Bean
    public AuthenticationManager authenticationManagerBean() throws Exception {
        return super.authenticationManagerBean();
    }
    
    @Bean("jwtAuthenticationProvider")
    protected AuthenticationProvider jwtAuthenticationProvider() {
        return new JwtAuthenticationProvider(jwtUserService());
    }
    
    @Bean("daoAuthenticationProvider")
    protected AuthenticationProvider daoAuthenticationProvider() throws Exception{
        //這里會默認使用BCryptPasswordEncoder比對加密后的密碼逗栽,注意要跟createUser時保持一致
        DaoAuthenticationProvider daoProvider = new DaoAuthenticationProvider();
        daoProvider.setUserDetailsService(userDetailsService());
        return daoProvider;
    }
    ...
}

以上的配置類主要關(guān)注一下幾個點:

  • 訪問權(quán)限配置,使用url匹配是放過還是需要角色和認證
  • 跨域支持失暂,這個我們下面再講
  • 禁用csrf彼宠,csrf攻擊是針對使用session的情況,這里是不需要的弟塞,關(guān)于CSRF可參考 Cross Site Request Forgery
  • 禁用默認的form登錄支持
  • logout支持凭峡,spring security已經(jīng)默認支持logout filter,會攔截/logout請求决记,交給logoutHandler處理摧冀,同時在logout成功后調(diào)用LogoutSuccessHandler。對于logout系宫,我們需要清除保存的token salt信息索昂,這樣再拿logout之前的token訪問就會失敗。請參考TokenClearLogoutHandler:
public class TokenClearLogoutHandler implements LogoutHandler {
    
    private JwtUserService jwtUserService;
    
    public TokenClearLogoutHandler(JwtUserService jwtUserService) {
        this.jwtUserService = jwtUserService;
    }

    @Override
    public void logout(HttpServletRequest request, HttpServletResponse response, Authentication authentication) {
        clearToken(authentication);
    }
    
    protected void clearToken(Authentication authentication) {
        if(authentication == null)
            return;
        UserDetails user = (UserDetails)authentication.getPrincipal();
        if(user!=null && user.getUsername()!=null)
            jwtUserService.deleteUserLoginInfo(user.getUsername());
    }

}

角色配置

Spring Security對于訪問權(quán)限的檢查主要是通過AbstractSecurityIntercepter來實現(xiàn)扩借,進入這個攔截器的基礎(chǔ)一定是在context有有效的Authentication椒惨。
回顧下上面實現(xiàn)的UserDetailsService,在登錄或token認證時返回的Authentication包含了GrantedAuthority的列表往枷。

@Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        //調(diào)用roles("USER")會將USER角色加入GrantedAuthority
        return User.builder().username("Jack").password(passwordEncoder.encode("jack-password")).roles("USER").build();  
    }

然后我們上面的配置類中有對url的role做了配置框产。比如下面的配置表示/admin開頭的url支持有admin和manager權(quán)限的用戶訪問:

.antMatchers("/admin/**").hasAnyRole("ADMIN,MANAGER") 

對于Intecepter來說只需要吧配置中的信息和GrantedAuthority的信息一起提交給AccessDecisionManager來做比對。

跨域支持

前后端分離的項目需要支持跨域請求错洁,需要做下面的配置。
CORS配置
首先需要在HttpSecurity配置中啟用cors支持

http.cors()

這樣spring security就會從CorsConfigurationSource中取跨域配置戒突,所以我們需要定義一個Bean:

@Bean
    protected CorsConfigurationSource corsConfigurationSource() {
        CorsConfiguration configuration = new CorsConfiguration();
        configuration.setAllowedOrigins(Arrays.asList("*"));
        configuration.setAllowedMethods(Arrays.asList("GET","POST","HEAD", "OPTION"));
        configuration.setAllowedHeaders(Arrays.asList("*"));
        configuration.addExposedHeader("Authorization");
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", configuration);
        return source;
    }

Header配置
對于返回給瀏覽器的Response的Header也需要添加跨域配置:

http..headers().addHeaderWriter(new StaticHeadersWriter(Arrays.asList(
         //支持所有源的訪問
        new Header("Access-control-Allow-Origin","*"),
         //使ajax請求能夠取到header中的jwt token信息
        new Header("Access-Control-Expose-Headers","Authorization"))))

OPTIONS請求配置
對于ajax的跨域請求屯碴,瀏覽器在發(fā)送真實請求之前,會向服務(wù)端發(fā)送OPTIONS請求膊存,看服務(wù)端是否支持导而。對于options請求我們只需要返回header忱叭,不需要再進其它的filter,所以我們加了一個OptionsRequestFilter今艺,填充header后就直接返回:

public class OptionsRequestFilter extends OncePerRequestFilter{

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        if(request.getMethod().equals("OPTIONS")) {
            response.setHeader("Access-Control-Allow-Methods", "GET,POST,OPTIONS,HEAD");
            response.setHeader("Access-Control-Allow-Headers", response.getHeader("Access-Control-Request-Headers"));
            return;
        }
        filterChain.doFilter(request, response);
    }

}

總結(jié)

Spring Security在和shiro使用了類似的認證核心設(shè)計的情況下韵丑,提供了更多的和web的整合,以及更豐富的第三方認證支持虚缎。同時在安全性方面撵彻,也提供了足夠多的默認支持,對得上security這個名字实牡。
所以這兩個框架的選擇問題就相對簡單了:
1)如果系統(tǒng)中本來使用了spring陌僵,那優(yōu)先選擇spring security;
2)如果是web系統(tǒng)创坞,spring security提供了更多的安全性支持
3)除次之外可以選擇shiro

文章內(nèi)使用的源碼已經(jīng)放在git上:Spring Security and JWT demo

[參考資料]
Spring Security Reference

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末碗短,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子题涨,更是在濱河造成了極大的恐慌偎谁,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,126評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件纲堵,死亡現(xiàn)場離奇詭異搭盾,居然都是意外死亡,警方通過查閱死者的電腦和手機婉支,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評論 2 382
  • 文/潘曉璐 我一進店門鸯隅,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人向挖,你說我怎么就攤上這事蝌以。” “怎么了何之?”我有些...
    開封第一講書人閱讀 152,445評論 0 341
  • 文/不壞的土叔 我叫張陵跟畅,是天一觀的道長。 經(jīng)常有香客問我溶推,道長徊件,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,185評論 1 278
  • 正文 為了忘掉前任蒜危,我火速辦了婚禮虱痕,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘辐赞。我一直安慰自己部翘,他們只是感情好,可當我...
    茶點故事閱讀 64,178評論 5 371
  • 文/花漫 我一把揭開白布响委。 她就那樣靜靜地躺著新思,像睡著了一般窖梁。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上夹囚,一...
    開封第一講書人閱讀 48,970評論 1 284
  • 那天纵刘,我揣著相機與錄音,去河邊找鬼荸哟。 笑死假哎,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的敲茄。 我是一名探鬼主播位谋,決...
    沈念sama閱讀 38,276評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼堰燎!你這毒婦竟也來了掏父?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,927評論 0 259
  • 序言:老撾萬榮一對情侶失蹤秆剪,失蹤者是張志新(化名)和其女友劉穎赊淑,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體仅讽,經(jīng)...
    沈念sama閱讀 43,400評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡陶缺,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,883評論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了洁灵。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片饱岸。...
    茶點故事閱讀 37,997評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖徽千,靈堂內(nèi)的尸體忽然破棺而出苫费,到底是詐尸還是另有隱情,我是刑警寧澤双抽,帶...
    沈念sama閱讀 33,646評論 4 322
  • 正文 年R本政府宣布百框,位于F島的核電站,受9級特大地震影響牍汹,放射性物質(zhì)發(fā)生泄漏铐维。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,213評論 3 307
  • 文/蒙蒙 一慎菲、第九天 我趴在偏房一處隱蔽的房頂上張望嫁蛇。 院中可真熱鬧,春花似錦钧嘶、人聲如沸棠众。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽闸拿。三九已至,卻和暖如春书幕,著一層夾襖步出監(jiān)牢的瞬間新荤,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評論 1 260
  • 我被黑心中介騙來泰國打工台汇, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留苛骨,地道東北人。 一個月前我還...
    沈念sama閱讀 45,423評論 2 352
  • 正文 我出身青樓苟呐,卻偏偏與公主長得像痒芝,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子牵素,可洞房花燭夜當晚...
    茶點故事閱讀 42,722評論 2 345

推薦閱讀更多精彩內(nèi)容