SpringBoot集成JWT實現token驗證

時間 2019-11-09

標籤 springboot 集成 jwt 實現 token 驗證欄目 Spring 简体版

原文原文鏈接

JWT官網： [jwt.io/][https_jwt.io]
JWT(Java版)的github地址:[github.com/jwtk/jjwt][https_github.com_jwtk_jjwt]java

什麼是JWT

Json web token (JWT), 是爲了在網絡應用環境間傳遞聲明而執行的一種基於JSON的開放標準（(RFC 7519).**定義了一種簡潔的，自包含的方法用於通訊雙方之間以JSON對象的形式安全的傳遞信息。**由於數字簽名的存在，這些信息是可信的，JWT可使用HMAC算法或者是RSA的公私祕鑰對進行簽名。git

JWT請求流程

1. 用戶使用帳號和麪發出post請求；
2. 服務器使用私鑰建立一個jwt；
3. 服務器返回這個jwt給瀏覽器；
4. 瀏覽器將該jwt串在請求頭中像服務器發送請求；
5. 服務器驗證該jwt；
6. 返回響應的資源給瀏覽器。github

JWT的主要應用場景

身份認證在這種場景下，一旦用戶完成了登錄，在接下來的每一個請求中包含JWT，**能夠用來驗證用戶身份以及對路由，服務和資源的訪問權限進行驗證。因爲它的開銷很是小，能夠輕鬆的在不一樣域名的系統中傳遞，全部目前在單點登陸（SSO）**中比較普遍的使用了該技術。信息交換在通訊的雙方之間使用JWT對數據進行編碼是一種很是安全的方式，因爲它的信息是通過簽名的，能夠確保發送者發送的信息是沒有通過僞造的。web

優勢

1.簡潔(Compact): 能夠經過URL，POST參數或者在HTTP header發送，由於數據量小，傳輸速度也很快
2.自包含(Self-contained)：負載中包含了全部用戶所須要的信息，避免了屢次查詢數據庫
3.由於Token是以JSON加密的形式保存在客戶端的，因此JWT是跨語言的，原則上任何web形式都支持。
4.不須要在服務端保存會話信息，特別適用於分佈式微服務。算法

`數據庫

JWT的結構

JWT是由三段信息構成的，將這三段信息文本用.鏈接一塊兒就構成了JWT字符串。
就像這樣:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ後端

JWT包含了三部分：
Header 頭部(標題包含了令牌的元數據，而且包含簽名和/或加密算法的類型)
Payload 負載 (相似於飛機上承載的物品)
Signature 簽名/簽證瀏覽器

Header

JWT的頭部承載兩部分信息：token類型和採用的加密算法。安全

{ 
  "alg": "HS256",
   "typ": "JWT"
}
複製代碼

聲明類型:這裏是jwt
聲明加密的算法:一般直接使用 HMAC SHA256bash

加密算法是單向函數散列算法，常見的有MD五、SHA、HAMC。
MD5(message-digest algorithm 5) （信息-摘要算法）縮寫，普遍用於加密和解密技術，經常使用於文件校驗。校驗？無論文件多大，通過MD5後都能生成惟一的MD5值
SHA (Secure Hash Algorithm，安全散列算法），數字簽名等密碼學應用中重要的工具，安全性高於MD5
HMAC (Hash Message Authentication Code)，散列消息鑑別碼，基於密鑰的Hash算法的認證協議。用公開函數和密鑰產生一個固定長度的值做爲認證標識，用這個標識鑑別消息的完整性。經常使用於接口簽名驗證

Payload

載荷就是存放有效信息的地方。
有效信息包含三個部分
1.標準中註冊的聲明
2.公共的聲明
3.私有的聲明

標準中註冊的聲明 (建議但不強制使用) ：

iss: jwt簽發者
sub: 面向的用戶(jwt所面向的用戶)
aud: 接收jwt的一方
exp: 過時時間戳(jwt的過時時間，這個過時時間必需要大於簽發時間)
nbf: 定義在什麼時間以前，該jwt都是不可用的.
iat: jwt的簽發時間
jti: jwt的惟一身份標識，主要用來做爲一次性token,從而回避重放攻擊。

公共的聲明：

公共的聲明能夠添加任何的信息，通常添加用戶的相關信息或其餘業務須要的必要信息.但不建議添加敏感信息，由於該部分在客戶端可解密.

私有的聲明：

私有聲明是提供者和消費者所共同定義的聲明，通常不建議存放敏感信息，由於base64是對稱解密的，意味着該部分信息能夠歸類爲明文信息。

Signature

jwt的第三部分是一個簽證信息，這個簽證信息由三部分組成：
header (base64後的)
payload (base64後的)
secret
這個部分須要base64加密後的header和base64加密後的payload使用.鏈接組成的字符串，而後經過header中聲明的加密方式進行加鹽secret組合加密，而後就構成了jwt的第三部分。
密鑰secret是保存在服務端的，服務端會根據這個密鑰進行生成token和進行驗證，因此須要保護好。

下面來進行SpringBoot和JWT的集成

引入JWT依賴,因爲是基於Java，因此須要的是java-jwt

<dependency>
      <groupId>com.auth0</groupId>
      <artifactId>java-jwt</artifactId>
      <version>3.4.0</version>
</dependency>
複製代碼

須要自定義一個註解

須要登陸而且具備角色才能才能進行操做的註解LoginRequired

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginRequired {

    // 是否進行校驗
    boolean required() default true;

    // 默認管理員
    RoleEnum role() default RoleEnum.ADMIN;  
}
複製代碼

`@Target`:註解的做用目標

@Target(ElementType.TYPE)——接口、類、枚舉、註解
@Target(ElementType.FIELD)——字段、枚舉的常量
@Target(ElementType.METHOD)——方法
@Target(ElementType.PARAMETER)——方法參數
@Target(ElementType.CONSTRUCTOR) ——構造函數
@Target(ElementType.LOCAL_VARIABLE)——局部變量
@Target(ElementType.ANNOTATION_TYPE)——註解
@Target(ElementType.PACKAGE)——包

`@Retention`：註解的保留位置

RetentionPolicy.SOURCE:這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略,在class字節碼文件中不包含。
RetentionPolicy.CLASS:這種類型的Annotations編譯時被保留,默認的保留策略,在class文件中存在,但JVM將會忽略,運行時沒法得到。
RetentionPolicy.RUNTIME:這種類型的Annotations將被JVM保留,因此他們能在運行時被JVM或其餘使用反射機制的代碼所讀取和使用。
@Document：說明該註解將被包含在javadoc中
@Inherited：說明子類能夠繼承父類中的該註解

簡單自定義一個實體類User,使用lombok簡化實體類的編寫

@Data @Accessors(chain = true) public class AuthUserVO extends BaseVO {

/**
 * 主鍵
 */
private Long id;

/**
 * 社交帳戶ID
 */
private String socialId;

/**
 * 用戶名
 */
private String name;

/**
 * 密碼
 */
private String password;

/**
 * 角色主鍵 1 普通用戶 2 admin
 */
private Long roleId;

/**
 * 頭像
 */
private String avatar;

private String token;
複製代碼

}

須要寫token的生成方法

/**
 * 生成Token
 * @param authUserVO
 * @return
 */
public static String getToken(AuthUserVO authUserVO) {
    String sign = authUserVO.getPassword();
    return JWT.create().withExpiresAt(new Date(System.currentTimeMillis()+ Constants.EXPIRE_TIME)).withAudience(JsonUtil.toJsonString(authUserVO.setPassword(null)))
            .sign(Algorithm.HMAC256(sign));
}
複製代碼

Algorithm.HMAC256():使用HS256生成token,密鑰則是用戶的密碼，惟一密鑰的話能夠保存在服務端。
withAudience()存入須要保存在token的信息，這裏我把用戶ID存入token中

接下來須要寫一個攔截器去獲取`token`並驗證`token`

複製代碼

實現一個攔截器就須要實現HandlerInterceptor接口

HandlerInterceptor接口主要定義了三個方法
1.boolean preHandle ()：
預處理回調方法,實現處理器的預處理，第三個參數爲響應的處理器,自定義Controller,返回值爲true表示繼續流程（如調用下一個攔截器或處理器）或者接着執行
postHandle()和afterCompletion()；false表示流程中斷，不會繼續調用其餘的攔截器或處理器，中斷執行。

2.void postHandle()：
後處理回調方法，實現處理器的後處理（DispatcherServlet進行視圖返回渲染以前進行調用），此時咱們能夠經過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能爲null。

3.void afterCompletion():
整個請求處理完畢回調方法,該方法也是須要當前對應的Interceptor的preHandle()的返回值爲true時纔會執行，也就是在DispatcherServlet渲染了對應的視圖以後執行。用於進行資源清理。整個請求處理完畢回調方法。如性能監控中咱們能夠在此記錄結束時間並輸出消耗時間，還能夠進行一些資源清理，相似於try-catch-finally中的finally，但僅調用處理器執行鏈中

主要流程:

1.從 http 請求頭中取出 token，
2.判斷是否映射到方法
3.檢查是否有passtoken註釋，有則跳過認證
4.檢查有沒有須要用戶登陸的註解，有則須要取出並驗證
5.認證經過則能夠訪問，不經過會報相關錯誤信息

配置攔截器

在配置類上添加了註解@Configuration，標明瞭該類是一個配置類而且會將該類做爲一個SpringBean添加到IOC容器內

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authenticationInterceptor())
                .addPathPatterns("/**");    // 攔截全部請求，經過判斷是否有 @LoginRequired 註解 決定是否須要登陸
    }
    @Bean
    public AuthenticationInterceptor authenticationInterceptor() {
        return new AuthenticationInterceptor();
    }
}
複製代碼

WebMvcConfigurerAdapter該抽象類其實裏面沒有任何的方法實現，只是空實現了接口
WebMvcConfigurer內的所有方法，並無給出任何的業務邏輯處理，這一點設計恰到好處的讓咱們沒必要去實現那些咱們不用的方法，都交由WebMvcConfigurerAdapter抽象類空實現,若是咱們須要針對具體的某一個方法作出邏輯處理,僅僅須要在
WebMvcConfigurerAdapter子類中@Override對應方法就能夠了。

注：
在SpringBoot2.0及Spring 5.0中WebMvcConfigurerAdapter已被廢棄
網上有說改成繼承WebMvcConfigurationSupport，不過試了下，仍是過時的

解決方法:

直接實現WebMvcConfigurer （官方推薦）

@Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 可添加多個
        registry.addInterceptor(authenticationInterceptor).addPathPatterns("/**");
    }
複製代碼

InterceptorRegistry內的addInterceptor須要一個實現HandlerInterceptor接口的攔截器實例，addPathPatterns方法用於設置攔截器的過濾路徑規則。
這裏我攔截全部請求，經過判斷是否有@LoginRequired註解決定是否須要登陸

在數據訪問接口中加入登陸操做註解

@LoginRequired
   @PutMapping("/admin/v1/update")
   public Result updateUser(@RequestBody AuthUserVO authUserVO) {
       return authUserService.updateUser(authUserVO);
   }
複製代碼

註銷登陸

網上不少案例都不多說怎麼退出登陸的，有點人說直接生成新的token，我以爲仍是後端控制比較好。這裏我存儲了每次生成的token，用了一個定時器去掃描這裏的過時token，每次校驗的時候都去數據庫中看有沒有，若是沒有就報token驗證失敗。

/** * 獲取用戶Session信息 * @return */
    public static UserSessionVO getUserSessionInfo() {

        // 獲取請求對象
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

        // 獲取請求頭Token值
        String token = Optional.ofNullable(request.getHeader(Constants.AUTHENTICATION)).orElse(null);

        if (StringUtils.isBlank(token)) {
            return null;
        }

        // 獲取 token 中的 user id
        AuthUser authUser = null;
        try {
            authUser = JsonUtil.parseObject(JWT.decode(token).getAudience().get(0), AuthUser.class);
        } catch (JWTDecodeException j) {
            ExceptionUtil.rollback("token解析失敗", ErrorConstants.INVALID_TOKEN);
        }

        AuthUserDao userDao = BeanTool.getBean(AuthUserDao.class);
        AuthUser user = userDao.selectById(authUser.getId());
        if (user == null) {
            ExceptionUtil.rollback("用戶不存在，請從新登陸", ErrorConstants.LOGIN_ERROR);
        }

        // 驗證 token
        JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(user.getPassword())).build();
        try {
            jwtVerifier.verify(token);
        } catch (JWTVerificationException e) {
            ExceptionUtil.rollback("token驗證失敗", ErrorConstants.LOGIN_ERROR);
        }

        AuthTokenDao authTokenDao = BeanTool.getBean(AuthTokenDao.class);
        Integer count = authTokenDao.selectCount(new LambdaQueryWrapper<AuthToken>().eq(AuthToken::getToken, token).eq(AuthToken::getUserId, user.getId()).ge(AuthToken::getExpireTime, LocalDateTime.now()));
        if (count.equals(Constants.ZERO)) {
            ExceptionUtil.rollback("token驗證失敗", ErrorConstants.LOGIN_ERROR);
        }

        UserSessionVO userSessionVO = new UserSessionVO();
        userSessionVO.setName(user.getName()).setSocialId(user.getSocialId()).setRoleId(user.getRoleId()).setId(user.getId());
        return userSessionVO;
    }
複製代碼

定時器

@Override
    public Result logout() {
        UserSessionVO userSessionInfo = SessionUtil.getUserSessionInfo();
        this.authTokenDao.delete(new LambdaQueryWrapper<AuthToken>().eq(AuthToken::getUserId, userSessionInfo.getId()));
        return Result.createWithSuccessMessage();
    }
複製代碼

定時器

@Scheduled(cron = "0 0/1 * * * ?")
    private void scanToken() {
        log.debug(" {} 掃描過時Token", LocalDateTime.now());
        authTokenDao.delete(new LambdaQueryWrapper<AuthToken>().le(AuthToken::getExpireTime, LocalDateTime.now()));
    }
複製代碼

不加註解的話默認不驗證，登陸接口通常是不驗證的。在getMessage()中我加上了登陸註解，說明該接口必須登陸獲取token後，在請求頭中加上token並經過驗證才能夠訪問

注意:這裏的key必定不能錯，由於在攔截器中是取關鍵字token的值
String token = httpServletRequest.getHeader(Constants.AUTHENTICATION);
加上token以後就能夠順利經過驗證和進行接口訪問了