JWT之自定义注解完成Token验证

最新推荐文章于 2024-08-25 21:28:18 发布

koala0018

最新推荐文章于 2024-08-25 21:28:18 发布

阅读量884

点赞数

分类专栏： Spring 文章标签： java 后端 spring spring boot web

本文链接：https://blog.csdn.net/koala0018/article/details/124172644

版权

Spring 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

文章目录

一、什么是JWT
二、JWT的标准结构
三、代码实战
五、为什么使用的是JWT
- 基于传统的Session认证
- 基于JWT认证
总结

一、什么是JWT

一句话：JSON Web Token

# 1.翻译
-  官网地址: https://jwt.io/introduction/
-  翻译: jsonwebtoken（JWT）是一个开放标准（rfc7519），它定义了一种紧凑的、自包含的方式，用于在各方之间以JSON对象安全地传输信息。此信息可以验证和信任，因为它是数字签名的。jwt可以使用秘密（使用HMAC算法）或使用RSA或ECDSA的公钥/私钥对进行签名

# 2.通俗解释
 - JWT简称JSON Web Token,也就是通过JSON形式作为Web应用中的令牌,用于在各方之间安全地将信息作为JSON对象传输。在数据传输过程中还可以完成数据加密、签名等相关处理。

二、JWT的标准结构

header.payload.singnature

# 1.令牌组成
- 1.标头(Header)
- 2.有效载荷(Payload)
- 3.签名(Signature)
- 因此，JWT通常如下所示:xxxxx.yyyyy.zzzzz   Header.Payload.Signature

# 2.Header
- 标头通常由两部分组成：令牌的类型（即JWT）和所使用的签名算法，例如HMAC SHA256或RSA。

数据会使用 Base64 编码组成 JWT 结构的第一部分。

- 注意:Base64是一种编码，也就是说，它是可以被翻译回原来的样子来的。它并不是一种加密过程。

{
  "alg": "HS256",	//签名算法
  "typ": "JWT"	//令牌类型
}

# 3.Payload
- 令牌的第二部分是有效负载，其中包含声明。声明是有关实体（通常是用户）和其他数据的声明。同样的，它会使用 Base64 编码组成 JWT 结构的第二部分

{
  "sub": "1234567890",	//用户id
  "name": "John Doe",
  "admin": true
}

# 4.Signature
- 前面两部分都是使用 Base64 进行编码的，即前端可以解开知道里面的信息。Signature 需要使用编码后的 header 和 payload 以及我们提供的一个密钥，然后使用 header 中指定的签名算法（HS256）进行签名。签名的作用是保证 JWT 没有被篡改过
- 如:
	HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(payload),secret);
	
# 验签过程
- Header和Payload两部分的Base64编码加在一起，根据我们提供的一个密钥，用HS256算法加密，生成的结果就是第三部分Signature。三个在一起形成token。
- 验签的时候，就是把收到的token里的Header和Payload两部分再加密看看是否等于Signature。

# 签名目的
- 最后一步签名的过程，实际上是对头部以及负载内容进行签名，防止内容被窜改。如果有人对头部以及负载的内容解码之后进行修改，再进行编码，最后加上之前的签名组合形成新的JWT的话，那么服务器端会判断出新的头部和负载形成的签名和JWT附带上的签名是不一样的。如果要对新的头部和负载进行签名，在不知道服务器加密时用的密钥的话，得出来的签名也是不一样的。

# 信息安全问题
 - 在这里大家一定会问一个问题：Base64是一种编码，是可逆的，那么我的信息不就被暴露了吗？

 - 是的。所以，在JWT中，不应该在负载里面加入任何敏感的数据。在上面的例子中，我们传输的是用户的User ID。这个值实际上不是什么敏	感内容，一般情况下被知道也是安全的。但是像密码这样的内容就不能被放在JWT中了。如果将用户的密码放在了JWT中，那么怀有恶意的第	三方通过Base64解码就能很快地知道你的密码了。因此JWT适合用于向Web应用传递一些非敏感信息。JWT还经常用于设计用户认证和授权系	统，甚至实现Web应用的单点登录。

三、代码实战

JWT基本知识就到这里，已经足够我们开始开发代码了。

总体步骤：

1.添加依赖，创建jwt工具类和拦截器，以及拦截器配置
2.编写自定义注解，添加isRequired属性方便判断，给个默认值true
3.拦截器preHandle从 http 请求头中取出 token，判断是否映射到方法
4.检查有没有自定义的的注解，有则需要取出并验证,否则抛出错误信息

1.引入依赖

<!--引入jwt-->
<dependency>
  <groupId>com.auth0</groupId>
  <artifactId>java-jwt</artifactId>
  <version>3.4.0</version>
</dependency>

2.创建JWT工具类

此类是开发时，可直接生成根据传入payload生成对应token，可直接调用验证token有效性。

public class JWTUtils {
    private static String TOKEN = "token!Q@W3e4r";
    /**
     * 生成token
     * @param map  //传入payload
     * @return 返回token
     */
    public static String getToken(Map<String,String> map){
        JWTCreator.Builder builder = JWT.create();
        map.forEach((k,v)->{
            builder.withClaim(k,v);
        });
        Calendar instance = Calendar.getInstance();
        instance.add(Calendar.SECOND,7);
        builder.withExpiresAt(instance.getTime());
        return builder.sign(Algorithm.HMAC256(TOKEN)).toString();
    }
    /**
     * 验证token
     * @param token
     * @return
     */
    public static void verify(String token){
        JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token);
    }
    /**
     * 获取token中payload
     * @param token
     * @return
     */
    public static DecodedJWT getToken(String token){
        return JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token);
    }
}

3.创建自定义注解

这里添加isRequired属性方便取出的时候判断，给个默认值true

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Token {
    boolean required() default true;
}

3.编写创建的拦截器

先是preHandle从 http 请求头中取出 token，判断是否映射到方法
再就是检查有没有自定义的的注解，有则需要取出并验证,否则抛出错误信息

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

    String token = request.getHeader("token");// 从 http 请求头中取出 token
    // 如果不是映射到方法直接通过
    if(!(handler instanceof HandlerMethod)){
        return true;
    }
    HandlerMethod handlerMethod=(HandlerMethod)handler;
    Method method=handlerMethod.getMethod();
    //检查有没有需要认证的注解
    if (method.isAnnotationPresent(Token.class)) {
        Token userLoginToken = method.getAnnotation(Token.class);
        if (userLoginToken.required()) {
            // 执行认证
            if (token == null) {
                throw new Exception("无token，请获取token");
            }
            // 验证 token
            try {
                JWTUtil.verify(token);
            }  catch (TokenExpiredException e) {
                throw new Exception("Token已经过期");
            } catch (SignatureVerificationException e){
                throw new Exception("签名错误");
            } catch (Exception e) {
                throw new Exception("无效token");
            }
            return true;
        }
    }
    return true;
}

别忘了创建的拦截器要写配置类,配置要拦截的路径。这里是所有路径

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authenticationInterceptor())
                .addPathPatterns("/**");
    }
    @Bean
    public JwtInterceptor authenticationInterceptor() {
        return new JwtInterceptor();
    }
}

4.在controller需要验证的接口加上注解即可

    @Token
    @PostMapping("/jwt")
    public ResultDTO jwtTest(@RequestBody Result result) {
      //业务逻辑
        return null;
    }

五、为什么使用的是JWT

提示：最后再说说为什么使用JWT，估计很多铁子都是冲着代码来的，估计没有耐心看这个，就放在到最后了。这里主要是理论讲解，综合了很多网上大佬们的总结。有兴趣可以了解一下

基于传统的Session认证

1.认证流程:
JWT 实战教程.assets/image-20200726103959013.png

2.暴露问题：

1.每个用户经过我们的应用认证之后，我们的应用都要在服务端做一次记录，以方便用户下次请求的鉴别，通常而言session都是保存在内存中，而随着认证用户的增多，服务端的开销会明显增大
2.用户认证之后，服务端做认证记录，如果认证的记录被保存在内存中的话，这意味着用户下次请求还必须要请求在这台服务器上,这样才能拿到授权的资源，这样在分布式的应用上，相应的限制了负载均衡器的能力。这也意味着限制了应用的扩展能力。
3.因为是基于cookie来进行用户识别的, cookie如果被截获，用户就会很容易受到跨站请求伪造的攻击。
4.在前后端分离系统中就更加痛苦:如下图所示
也就是说前后端分离在应用解耦后增加了部署的复杂性。通常用户一次请求就要转发多次。如果用session 每次携带sessionid 到服务器，服务器还要查询用户信息。同时如果用户很多。这些信息存储在服务器内存中，给服务器增加负担。还有就是CSRF（跨站伪造请求攻击）攻击，session是基于cookie进行用户识别的, cookie如果被截获，用户就会很容易受到跨站请求伪造的攻击。还有就是 sessionid就是一个特征值，表达的信息不够丰富。不容易扩展。而且如果你后端应用是多节点部署。那么就需要实现session共享机制。不方便集群应用。

基于JWT认证

图
1.认证流程:

首先，前端通过Web表单将自己的用户名和密码发送到后端的接口。这一过程一般是一个HTTP POST请求。建议的方式是通过SSL加密的传输（https协议），从而避免敏感信息被嗅探。
后端核对用户名和密码成功后，将用户的id等其他信息作为JWT Payload（负载），将其与头部分别进行Base64编码拼接后签名，形成一个JWT(Token)。形成的JWT就是一个形同lll.zzz.xxx的字符串。 token head.payload.singurater
后端将JWT字符串作为登录成功的返回结果返回给前端。前端可以将返回的结果保存在localStorage或sessionStorage上，退出登录时前端删除保存的JWT即可。
前端在每次请求时将JWT放入HTTP Header中的Authorization位。(解决XSS和XSRF问题) HEADER
后端检查是否存在，如存在验证JWT的有效性。例如，检查签名是否正确；检查Token是否过期；检查Token的接收方是否是自己（可选）。
验证通过后后端使用JWT中包含的用户信息进行其他逻辑操作，返回相应结果。

2.jwt优势: