JWT 笔记

一、概述

1.1 什么是JWT

JSON Web Token（JWT）是一个非常轻巧的规范。这个规范允许我们使用JWT在用户和服务器之间传递安全可靠的信息。

JWT的说明：JWT是用于微服务之间传递用户信息的一段加密字符串，该字符串是JSON格式。各个微服务可以通过该字符串识别用户信息，也就是说，该字符串封装了用户的身份信息。该字符串必须能自我校验。

1.2 构成

一个JWT实际上就是一个字符串，它由三部分组成：头部、载荷与签证。通过.来分隔

1. 头部（Header）

头部用于描述关于该JWT的最基本的信息，例如其类型以及签名所用的算法等。这也可以被表示成一个JSON对象。

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

在头部指明了签名算法是HS256算法。对头部所有的数据进行BASE64编码http://base64.xpcha.com/，编码后的字符串如下：

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9

小知识：Base64是一种基于64个可打印字符来表示二进制数据的表示方法。由于2的6次方等于64，所以每6个比特为一个单元，对应某个可打印字符。三个字节有24个比特，对应于4个Base64单元，即3个字节需要用4个可打印字符来表示。JDK 中提供了非常方便的 BASE64Encoder 和 BASE64Decoder，用它们可以非常方便的完成基于 BASE64 的编码和解码

加密：

	byte[] encode = Base64.getEncoder().encode("abcdef".getBytes());
	String str = new String(encode);
	System.out.println(str);

解密：

	byte[] decode = Base64.getDecoder().decode("YWJjZGVm");
	System.out.println(new String(decode));

2. 载荷playload

载荷就是存放有效信息的地方。这个名字像是特指飞机上承载的货品，这些有效信息包含三个部分。

①：标准中注册的声明（建议但不强制使用）

iss: jwt签发者
sub: jwt所面向的用户,可以用来存储数据(json类型)
aud: 接收jwt的一方
exp: jwt的过期时间，这个过期时间必须要大于签发时间
nbf: 定义在什么时间之前，该jwt都是不可用的
iat: jwt的签发时间
jti: jwt的唯一身份标识，主要用来作为一次性token,从而回避重放攻击。

在Claims接口中的定义：

②：公共的声明
公共的声明可以添加任何的信息，一般添加用户的相关信息或其他业务需要的必要信息。但不建议添加敏感信息，因为该部分在客户端可解密.

③：私有的声明

私有声明是提供者和消费者所共同定义的声明，一般不建议存放敏感信息，因为base64是对称解密的，意味着该部分信息可以归类为明文信息。

这个指的就是自定义的claim。比如下面面结构举例中的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

3. 签证（signature）

（也可以称为签名）

jwt的第三部分是一个签证信息，这个签证信息由三部分组成：

header (base64后的) 头部
payload (base64后的) 载荷
secret 私钥

这个部分需要base64加密后的header和base64加密后的payload使用，连接组成的字符串。
然后通过header中声明的加密方式进行加盐secret组合加密，然后就构成了jwt的第三部分（这里的secret为dong）。

XtgVVPD9a-W9HD3tCWpI7QipDueDrIeDgTlB-p9ATVM

将这三部分用。连接成一个完整的字符串，构成了最终的jwt。

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.XtgVVPD9a-W9HD3tCWpI7QipDueDrIeDgTlB-p9ATVM

注意：secret是保存在服务器端的，jwt的签证发生成也是在服务器端的，secret就是用来进行jwt的签发和jwt的验证，所以，它就是你服务端的私钥，在任何场景都不应该流露出去。一旦客户端得知这个secret,那就意味着客户端是可以自我签发jwt了。

签证 = Base64（头）+ Base64（载荷）+ （秘钥【盐】 → 加密：采用头中指定的算法进行加密→密文）
签名的作用：用于验证令牌是否被串改

二、测试

测试案例：

/**
 * @author dong
 * @since 2022-09-05 10:58
 */

public class JwtTest {

    /**
     * 创建JTW令牌
     */
    @Test
    public void testJWT01() {
        JwtBuilder jwtBuilder = Jwts.builder()
//                .setId("888")  // 设置唯一编号，签发者
                .setSubject("1234567890")  // 设置主题，所面向的用户，可以是Json数据
//                .setIssuedAt(new Date())  // 设置签发时间
//                .setExpiration(new Date(System.currentTimeMillis() + 30000))  // 设置过期时间
//                .setAudience("John Doe")
//                .setPayload("负载？") // 这个与claims，只能二选一
                .signWith(SignatureAlgorithm.HS256, "dong");  // 设置签名使用HS256算法，并设置secretKey为ujiuye
        Map map = new HashMap();
        map.put("name", "John Doe");
        map.put("admin", true);
        // 添加自定义信息
        jwtBuilder.addClaims(map);
        System.out.println(jwtBuilder.compact());
    }

    /**
     * 解析JTW令牌
     */
    @Test
    public void testJWT02() {
        String token= "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.XtgVVPD9a-W9HD3tCWpI7QipDueDrIeDgTlB-p9ATVM";
        // 创建Jwt解析器
        JwtParser jwtParser = Jwts.parser();
        Jws<Claims> key = jwtParser.setSigningKey("dong")
                .parseClaimsJws(token);

        System.out.println(key.getHeader());
        System.out.println(key.getBody());
        System.out.println(key.getSignature());

    }

    @Test
    public void test1() {
        byte[] encode = Base64.getEncoder().encode("{\"typ\":\"JWT\",\"alg\":\"HS256\"}".getBytes());
        String str = new String(encode);
        System.out.println(str);

        byte[] decode = Base64.getDecoder().decode("YWJjZGVm");
        System.out.println(new String(decode));
        // eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9
        // eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9
    }

2. 封装工具类

/**
 * @author dong
 * @since 2022-09-05 13:51
 */
public class JwtUtil {

    // 设置过期时间
    public static final Long JWT_TTL = 3600 * 1000L;

    // Jwt私钥
    public static final String JWT_SECRET_KEY = "dong";

    /**
     * 生成token令牌方法
     *
     * @param id id
     * @param subject 主题
     * @param ttlMillis 过期时间
     * @return
     */
    public static String createJWT(String id, String subject, Long ttlMillis) {
        // 指定算法名称
        SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;

        // 当前系统时间
        long nowMillis = System.currentTimeMillis();
        // 令牌签发时间
        Date nowDate = new Date(nowMillis);

        //如果令牌有效期为null，则默认设置有效期1小时
        if (ttlMillis == null) {
            ttlMillis = JwtUtil.JWT_TTL;
        }
        //令牌过期时间设置
        long expMillis = nowMillis + ttlMillis;
        Date expDate = new Date(expMillis);

        // 生成私钥
        SecretKey secretKey = generalKey();

        JwtBuilder jwtBuilder = Jwts.builder()
                .setId("888")  // 设置唯一编号，签发者
                .setSubject(subject)  // 设置主题，所面向的用户，可以是Json数据
                .setAudience("dong")
                .setIssuedAt(nowDate)  // 设置签发时间
                .setExpiration(expDate)  // 设置过期时间
                .signWith(SignatureAlgorithm.HS256, secretKey);  // 设置签名使用HS256算法，并设置secretKey为处理后的dong


        Map map = new HashMap();
        map.put("test", "自定义信息");
        // 添加自定义信息
        jwtBuilder.addClaims(map);
        return jwtBuilder.compact();
    }

    /**
     * 生成秘钥 secretKey
     *
     * @return
     */
    public static SecretKey generalKey() {
        // 使用base64加密，处理格式，解决乱码问题
        byte[] encode = Base64.getEncoder().encode(JwtUtil.JWT_SECRET_KEY.getBytes());
        // 使用AES算法生成秘钥
        SecretKey key = new SecretKeySpec(encode, 0, encode.length, "AES");
        return key;
    }

    /**
     * 解析令牌数据
     *
     * @param jwt token令牌
     * @return
     * @throws Exception
     */
    public static Claims parseJWT(String jwt) throws Exception {
        SecretKey key = generalKey();
        return Jwts.parser()
                .setSigningKey(key)
                .parseClaimsJws(jwt)
                .getBody();
    }
}