JWT介绍及使用

JWT 介绍及使用

简介

JSON WEB Token（JWT），是一种基于JSON的、用于在网络上声明某种主张的令牌（token）。JWT通常由三部分组成: 头信息（header）, 消息体（payload）和签名（signature）。

原理： 经过服务器认证之后，生成一个JSON对象，发回给用户，以后，用户域服务器之间通讯时，都要发回这个 JSON 对象。

JWT 的特点

（1）JWT 默认是不加密，但也是可以加密的。生成原始 Token 以后，可以用密钥再加密一次。

（2）JWT 不加密的情况下，不能将秘密数据写入 JWT。

（3）JWT 不仅可以用于认证，也可以用于交换信息。有效使用 JWT，可以降低服务器查询数据库的次数。

（4）JWT 的最大缺点是，由于服务器不保存 session 状态，因此无法在使用过程中废止某个 token，或者更改 token 的权限。也就是说，一旦 JWT 签发了，在到期之前就会始终有效，除非服务器部署额外的逻辑。

（5）JWT 本身包含了认证信息，一旦泄露，任何人都可以获得该令牌的所有权限。为了减少盗用，JWT 的有效期应该设置得比较短。对于一些比较重要的权限，使用时应该再次对用户进行认证。

（6）为了减少盗用，JWT 不应该使用 HTTP 协议明码传输，要使用 HTTPS 协议传输

JWT 数据结构

由 header（头部）、Payload（负载）、SIgnature（签名）组成，三部分由 . 进行分隔

Header

由 令牌类型（JWT）和所使用的签名算法(例如MHAC,SHA256或RSA)，会使用Base64编码组成JWT结构的第一部分。

header 部分是一个 JSON 对象，描述JWT的元数据

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

上面代码中， alg 属性表示签名的算法（algorithm），默认是 HMAC SHA256（写成 HS256）； typ 属性表示这个令牌（token）的类型（type），JWT 令牌统一写为 JWT

Payload

包含需要传输的数据，同样会使用Base64编码（不建议存放用户的密码）

也是一个 JSON 对象，用来存放时间需要传输的数据。官方给定的是7个字段，如下所示：

iss (issuer)：签发人
exp (expiration time)：过期时间
sub (subject)：主题
aud (audience)：受众
nbf (Not Before)：生效时间
iat (Issued At)：签发时间
jti (JWT ID)：编号

Tips: 除了官方的字段之外，还可以存放自定义的字段

Signature

为了防止前面两部分的数据篡改，特别设置此签名

首先需要指定一个密钥。这个密钥只有服务器才知道，不能够泄露给用户。然后使用 Header 里面指定的签名算法，按照公式（如下所示）产生签名。

HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret)

签名计算完成后将 Header、Payload、Signature 三部分进行拼接，各部分用 . 进行分割，最后返回给用户。

使用方式

方式一(常用)：

放在 HTTP 请求的头信息 Authorization 字段里面

方式二：

跨域的时候，JWT 就放在 POST 请求的数据体里面。

认证流程

• 首先通过web表单将自己的用户名和密码发送到后端的接口（POST请求，建议使用https加密）
• 后端对数据（用户名和密码）进行校验，随后将用户id等其他信息作为JWT Payload（负载），将其头部进行 Base64 编码进行拼接后签名，形成一个 JWT 字符串
• 后端将JWT字符串返回给前端，前端将其存储在localStorage 或者 SessionStorage上，退出登录时将JWT删除即可
• 前端在每次的请求中 将 JWT 放入 HTTP Header 的 Authorization 的位置上（可以避免XSS和XSRF问题）
• 后端检查 JWT 是否存在，是否有效
• 验证通过后再进行后续的逻辑操作，并返回相应的结果

附上本人使用的代码

使用 JWT（这里采用方式一）

1、引入JWT 依赖

<!--jwt-->
<dependency>
    <groupId>com.auth0</groupId>
    <artifactId>java-jwt</artifactId>
    <version>3.12.0</version>
</dependency>

2、生成和验证token

import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTCreator;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.DecodedJWT;

import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

public class JWTUtils {

    //设置签名
    private static final String SIGN = "jerry";

    /**
     * 生成token
     * */

    public static String generateToken(Map<String,String> map){
        //设置有效时间,30分钟
        Calendar instance = Calendar.getInstance();
        instance.add(Calendar.MINUTE,30);
        //创建 jwt builder
        JWTCreator.Builder builder = JWT.create();
        //payload
        map.forEach((k,v)->{
            builder.withClaim(k,v);
        });
        String token = builder.withExpiresAt(instance.getTime())
                .sign(Algorithm.HMAC256(SIGN));
        return token;
    }


    /**
     * 验证token
     * */
    public static void verifyToken(String token){
        JWT.require(Algorithm.HMAC256(SIGN)).build().verify(token);
    }

2、为了提高代码的复用，将验证过程统一放入拦截器中

import com.auth0.jwt.exceptions.AlgorithmMismatchException;
import com.auth0.jwt.exceptions.SignatureGenerationException;
import com.auth0.jwt.exceptions.TokenExpiredException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jerry.jwt.utils.JWTUtils;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;

public class JWTInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        Map<String, Object> map = new HashMap<>();

        String token = request.getHeader("token");  //获取请求头中的token

        try {
            JWTUtils.verifyToken(token);
            return true;
        } catch (SignatureGenerationException e) {
            e.printStackTrace();
            map.put("msg","签名无效");
        } catch (TokenExpiredException e){
            e.printStackTrace();
            map.put("msg","token已过期");
        } catch (AlgorithmMismatchException e){
            e.printStackTrace();
            map.put("msg","token算法不一致");
        } catch (Exception e){
            e.printStackTrace();
            map.put("msg","token无效");
        }
        map.put("code",1);  //返回错误代码
        //将map转换为json的格式返回
        String json = new ObjectMapper().writeValueAsString(map);
        response.setContentType("application/json");
        response.getWriter().println(json);
        return false;
    }
}

3、为了让拦截器顺利工作，需要将拦截器注入

import com.jerry.jwt.interceptors.JWTInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new JWTInterceptor())
                .addPathPatterns("/**")             //拦截所有请求
                .excludePathPatterns("/login");     //除了生成token的请求
    }
}

• tips: 欢迎大佬们一起学习、一起探讨以及指导