浅谈 Json Web Token

目录

• 浅谈 Json Web Token
• • • 1.1 什么是 JWT
    • 1.2 JWT的构成
    • 1.3 JJWT的介绍和使用
    • • 1.3.1 创建TOKEN
      • 1.3.2 TOKEN解析
      • 1.3.3 设置过期时间
      • • 1.3.3.1 token过期设置
        • 1.3.3.2 解析TOKEN
      • 1.3.4 自定义claims

1.1 什么是 JWT

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

1.2 JWT的构成

一个 JWT 实际上就是一个字符串，它由三部分组成，头部、载荷与签名。

头部（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 的编码和解码，不是安全的。

载荷（Payload）

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

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

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

2. 公共的声明

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

3. 私有的声明

私有声明是提供者和消费者所共同定义的声明，一般不建议存放敏感信息，因为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

签证（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，那就意味着客户端是可以自我签发 JWT 了。

1.3 JJWT的介绍和使用

JJWT 是一个提供端到端的 JWT 创建和验证的 Java 库。永远免费和开源（Apache License，版本2.0），JJWT很容易使用和理解。它被设计成一个以建筑为中心的流畅界面，隐藏了它的大部分复杂性。

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

1.3.1 创建TOKEN

1. 依赖引入

在mall-gateway项目中的pom.xml中添加依赖：

<!-- 鉴权 -->
<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.9.0</version>
</dependency>

2. 创建测试

在mall-gateway的/test/java下创建测试类，并设置测试方法

/**
 * 创建JWT令牌
 */
@Test
public void TestJwt() {
    JwtBuilder builder = Jwts.builder()
            // 设置唯一编号
            .setId("123456")
            // 设置主题，可以是JSON数据
            .setSubject("JWT使用的声明")
            // 设置签发时间
            .setIssuedAt(new Date())
            // 设置签名 - 使用HS256算法，并设置SecretKey(字符串) - 密钥不小于6位
            .signWith(SignatureAlgorithm.HS256,"murphy");
    // 构建并返回一个字符串
    System.out.println(builder.compact());
}

运行打印结果：

eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMjM0NTYiLCJzdWIiOiJKV1Tkvb_nlKjnmoTlo7DmmI4iLCJpYXQiOjE2MzI1NjkyMjZ9.dOKrAhOTUQBAjaDY4vRiGeNdLe-sJ3XXwfK2i76MuKY

再次运行，会发现每次运行的结果是不一样的，因为我们的载荷中包含了时间。

1.3.2 TOKEN解析

我们刚才已经创建了token ，在web应用中这个操作是由服务端进行然后发给客户端，客户端在下次向服务端发送请求时需要携带这个token（这就好像是拿着一张门票一样），那服务端接到这个token 应该解析出token中的信息（例如用户id），根据这些信息查询数据库返回相应的结果。

/***
* 解析Jwt令牌数据 
*/
@Test
public void TestParseJwt() {
    String jwt = "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMjM0NTYiLCJzdWIiOiJKV1Tkvb_nlKjnmoTlo7DmmI4iLCJpYXQiOjE2MzI1Njk0NTl9.mFMNwG9x4pQgbNFV2XPY3kn8J8GYtShx-0sO3Jjlzq0";
    Claims claims = Jwts.parser()
            .setSigningKey("murphy")
            .parseClaimsJws(jwt)
            .getBody();
    System.out.println(claims);
}

运行打印效果：

{jti=123456, sub=JWT使用的声明, iat=1632569459}

试着将token或签名秘钥篡改一下，会发现运行时就会报错，所以解析token也就是验证token。

1.3.3 设置过期时间

有很多时候，我们并不希望签发的token是永久生效的，所以我们可以为token添加一个过期时间。

1.3.3.1 token过期设置

// 当前时间戳
long l1 = System.currentTimeMillis();
// 过期时间
long l2 = l1 + 20000;

/**
 * 创建JWT令牌
 */
@Test
public void TestJwt() {
    JwtBuilder builder = Jwts.builder()
            // 设置唯一编号
            .setId("123456")
            // 设置主题，可以是JSON数据
            .setSubject("JWT使用的声明")
            // 设置签发时间
            .setIssuedAt(new Date())
            // 设置过期时间
            .setExpiration(new Date(l2))
            // 设置签名 - 使用HS256算法，并设置SecretKey(字符串)
            .signWith(SignatureAlgorithm.HS256,"murphy");
    // 构建并返回一个字符串
    System.out.println(builder.compact());
}

解释：

.setExpiration(date)//用于设置过期时间 ，参数为Date类型数据

1.3.3.2 解析TOKEN

打印效果：

io.jsonwebtoken.ExpiredJwtException: JWT expired at 2021-09-25T19:34:48Z. Current time: 2021-09-25T19:35:04Z, a difference of 16062 milliseconds.  Allowed clock skew: 0 milliseconds.

当前时间超过过期时间，则会报错。

1.3.4 自定义claims

我们刚才的例子只是存储了id和subject两个信息，如果你想存储更多的信息（例如角色）可以定义自定义claims。

创建测试类，并设置测试方法：

创建token：

/**
 * 创建JWT令牌
 */
@Test
public void TestJwt() {
    JwtBuilder builder = Jwts.builder()
            // 设置唯一编号
            .setId("123456")
            // 设置主题，可以是JSON数据
            .setSubject("JWT使用的声明")
            // 设置签发时间
            .setIssuedAt(new Date())
            // 自定义载荷
            .claim("role","ADMIN")
            // 设置签名 - 使用HS256算法，并设置SecretKey(字符串)
            .signWith(SignatureAlgorithm.HS256,"murphy");
    // 自定义载荷
    Map<String, Object> map = new HashMap<>();
    map.put("myAddress", "cn");
    map.put("myCity", "Wuxi");
    builder.addClaims(map);
    // 构建并返回一个字符串
    System.out.println(builder.compact());
}

运行打印效果：

eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMjM0NTYiLCJzdWIiOiJKV1Tkvb_nlKjnmoTlo7DmmI4iLCJpYXQiOjE2MzI1Njk5NDksImV4cCI6MTYzMjU2OTk2OSwicm9sZSI6IkFETUlOIiwibXlBZGRyZXNzIjoiY24iLCJteUNpdHkiOiJXdXhpIn0.U2Q81XECN9Qdplwk9s4vtP7DNgFdGi_2TQRR4DDTYDk

解析TOKEN：

@Test
public void TestParseJwt() {
    String jwt = "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxMjM0NTYiLCJzdWIiOiJKV1Tkvb_nlKjnmoTlo7DmmI4iLCJpYXQiOjE2MzI1Njk5NDksImV4cCI6MTYzMjU2OTk2OSwicm9sZSI6IkFETUlOIiwibXlBZGRyZXNzIjoiY24iLCJteUNpdHkiOiJXdXhpIn0.U2Q81XECN9Qdplwk9s4vtP7DNgFdGi_2TQRR4DDTYDk";
    Claims claims = Jwts.parser()
            .setSigningKey("murphy")
            .parseClaimsJws(jwt)
            .getBody();
    System.out.println(claims.get("role"));
    System.out.println(claims);
    System.out.println(claims.getSubject());
}

运行效果：

ADMIN
{jti=123456, sub=JWT使用的声明, iat=1632569949, exp=1632569969, role=ADMIN, myAddress=cn, myCity=Wuxi}
JWT使用的声明