如何使用JJWT及JWT講解和工具類

Posted on by

1. 什麼是JWT

JSON Web Token（JWT）是一個輕量級的認證規范，這個規范允許我們使用JWT在用戶和服務器之間傳遞安全可靠的信息。其本質是一個token，是一種緊湊的URL安全方法，用於在網絡通信的雙方之間傳遞。

2. JWT的構成

一個JWT實際上就是一個字符串，它由三部分組成：頭部、載荷與簽名

2.1 頭部（Header）

頭部用於描述關於該JWT的最基本的信息，例如其類型以及簽名所用的算法等

頭部可以被表示成一個JSON對象

{"typ":"JWT","alg":"HS256"}

在頭部指明瞭簽名算法是HS256算法。 我們進行BASE64編碼，編碼後的字符串如下：

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9

Base64是一種基於64個可打印字符來表示二進制數據的表示方法。

由於2的6次方等於64，所以每6個比特為一個單元，對應某個可打印字符。

三個字節有24個比特，對應於4個Base64單元，即3個字節需要用4個可打印字符來表示。

JDK 中提供瞭非常方便的 BASE64Encoder 和 BASE64Decoder，用它們可以非常方便的完成基於 BASE64 的編碼和解碼

2.2 載荷（playload）

載荷是存放有效信息的地方，這些有效信息包含三個部分：

2.2.1 標準中註冊的聲明（建議但不強制使用）

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

2.2.2 公共的聲明

公共的聲明可以添加任何的信息，一般添加用戶的相關信息或其他業務需要的必要信息。但不建議添加敏感信息，因為該部分在客戶端可解密

2.2.3 私有的聲明

私有聲明是提供者和消費者所共同定義的聲明，一般不建議存放敏感信息，因為base64是對稱解密的，意味著該部分信息可以歸類為明文信息

比如下面舉例中的admin和name都屬於自定的claim。這些claim跟JWT標準規定的claim區別在於：JWT規定的claim，JWT的接收方在拿到JWT之後，都知道怎麼對這些標準的claim進行驗證；而private claims不會驗證，除非明確告訴接收方要對這些claim進行驗證以及驗證的規則

定義一個payload：

{"sub":"1234567890","name":"John Doe","admin":true}

然後將其進行base64加密，得到Jwt的第二部分：

eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9

2.3 簽證（signature）

JWT的第三部分是一個簽證信息，這個簽證信息由三部分組成：

header (base64後的)

payload (base64後的)

secret

這個部分需要base64加密後的header和base64加密後的payload使用.連接組成的字符串，然後通過header中聲明的加密方式進行加鹽secret組合加密，然後就構成瞭jwt的第三部分：

TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

將這三部分用.連接成一個完整的字符串,構成瞭最終的jwt：

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

註意：secret是保存在服務器端的，jwt的簽發生成也是在服務器端的，secret就是用來進行jwt的簽發和jwt的驗證，所以secret就是你服務端的私鑰，在任何場景都不應該流露出去。一旦客戶端得知這個secret, 那就意味著客戶端是可以自我簽發jwt瞭

3. JJWT的介紹

JJWT是一個提供端到端的JWT創建和驗證的Java庫

官方文檔：https://github.com/jwtk/jjwt

4. JJWT的使用

<!--鑒權-->
<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.9.0</version>
</dependency>

import com.sun.scenario.effect.impl.sw.sse.SSEBlend_SRC_OUTPeer;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtBuilder;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import java.util.Date;
import java.util.HashMap;
public class TestJWT {
    public static void main(String[] args) {
        testCreateJWT();
        testParseJWT();
    }
    public static void testCreateJWT() {
        JwtBuilder builder = Jwts.builder()
                .setId("404")                   // 設置唯一編號
                .setSubject("邢立豹")            // 設置主題 可以是JSON數據
                .setIssuedAt(new Date())        // 設置簽發日期
                // .setExpiration(new Date())      // 設置過期時間
                // 設置簽名 使用HS256算法 並設置SecretKey(字符串)
                .signWith(SignatureAlgorithm.HS256, "LICHUN");
        HashMap<String, Object> userInfo = new HashMap<>();
        userInfo.put("name","枯木何日可逢春");
        userInfo.put("age", "21");
        builder.addClaims(userInfo);
        System.out.println(builder.compact());
    }
    public static void testParseJWT() {
        String str = "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiI0MDQiLCJzdWIiOiLpgqLnq4vosbkiLCJpYXQiOjE2MzA2ODAzNTMsImV4cCI6MTYzMDY4MDM1MywibmFtZSI6Iuaer-acqOS9leaXpeWPr-mAouaYpSIsImFnZSI6IjIxIn0.59i5xfLz9A-wTOJI9KxkF7zqp4zsLEWRC5DYlcy_Akc";
        Claims claims = Jwts.parser()
                .setSigningKey("LICHUN")
                .parseClaimsJws(str)
                .getBody();
        System.out.println(claims);
    }
}

5. JWT工具類

package com.lichun.utils;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtBuilder;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
import java.util.Base64;
import java.util.Date;
public class JWTUtil {
    // 有效期
    public static final Long JWT_TTL = 3600000L;
    // JWT令牌信息
    public static final String JWT_KEY = "LICHUN";
    public static String createJWT(String id, String subject, Long ttlMillis) {
        SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
        long nowMillis = System.currentTimeMillis();
        Date now = new Date(nowMillis);
        if (ttlMillis == null) {
            ttlMillis = JWT_TTL;
        }
        long expMillis = nowMillis + ttlMillis;
        Date expDate = new Date(expMillis);
        SecretKey secretKey = generalKey();
        JwtBuilder builder = Jwts.builder()
                .setId(id)                      // 設置唯一編號
                .setSubject(subject)            // 設置主題 可以是JSON數據
                .setIssuer("admin")
                .setIssuedAt(now)               // 設置簽發日期
                .setExpiration(expDate)         // 設置過期時間
                // 設置簽名 使用HS256算法 並設置SecretKey(字符串)
                .signWith(SignatureAlgorithm.HS256, secretKey);
        return builder.compact();
    }
    /**
     * 生成加密secretKey
     * @return
     */
    public static SecretKey generalKey() {
        byte[] encodedKey = Base64.getEncoder().encode(JWT_KEY.getBytes());
        SecretKey key = new SecretKeySpec(encodedKey, 0, encodedKey.length, "AES");
        return key;
    }
    /**
     * 解析令牌數據
     */
    public static Claims parseJWT(String jwt) throws Exception {
        SecretKey secretKey = generalKey();
        return Jwts.parser()
                .setSigningKey(secretKey)
                .parseClaimsJws(jwt)
                .getBody();
    }
}

以上就是如何使用JJWT及JWT講解和工具類的詳細內容，更多關於JWT講解與JJWT使用的資料請關註WalkonNet其它相關文章！

推薦閱讀：