SpringBoot集成JWT实现token验证

时间 2019-12-14

标签 springboot 集成 jwt 实现 token 验证栏目 Spring 繁體版

原文原文链接

JWT官网： https://jwt.io/
JWT(Java版)的github地址:https://github.com/jwtk/jjwtjava

什么是JWT

Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准（(RFC 7519).定义了一种简洁的，自包含的方法用于通讯双方之间以JSON对象的形式安全的传递信息。由于数字签名的存在，这些信息是可信的，JWT可使用HMAC算法或者是RSA的公私秘钥对进行签名。git

JWT请求流程

image.png

1. 用户使用帐号和面发出post请求；
2. 服务器使用私钥建立一个jwt；
3. 服务器返回这个jwt给浏览器；
4. 浏览器将该jwt串在请求头中像服务器发送请求；
5. 服务器验证该jwt；
6. 返回响应的资源给浏览器。github

JWT的主要应用场景

身份认证在这种场景下，一旦用户完成了登录，在接下来的每一个请求中包含JWT，能够用来验证用户身份以及对路由，服务和资源的访问权限进行验证。因为它的开销很是小，能够轻松的在不一样域名的系统中传递，全部目前在单点登陆（SSO）中比较普遍的使用了该技术。信息交换在通讯的双方之间使用JWT对数据进行编码是一种很是安全的方式，因为它的信息是通过签名的，能够确保发送者发送的信息是没有通过伪造的。web

优势

1.简洁(Compact): 能够经过URL，POST参数或者在HTTP header发送，由于数据量小，传输速度也很快
2.自包含(Self-contained)：负载中包含了全部用户所须要的信息，避免了屡次查询数据库
3.由于Token是以JSON加密的形式保存在客户端的，因此JWT是跨语言的，原则上任何web形式都支持。
4.不须要在服务端保存会话信息，特别适用于分布式微服务。算法

`spring

JWT的结构

JWT是由三段信息构成的，将这三段信息文本用.连接一块儿就构成了JWT字符串。
就像这样:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ数据库

JWT包含了三部分：
Header 头部(标题包含了令牌的元数据，而且包含签名和/或加密算法的类型)
Payload 负载 (相似于飞机上承载的物品)
Signature 签名/签证json

Header

JWT的头部承载两部分信息：token类型和采用的加密算法。api

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

声明类型:这里是jwt
声明加密的算法:一般直接使用 HMAC SHA256浏览器

加密算法是单向函数散列算法，常见的有MD五、SHA、HAMC。
MD5(message-digest algorithm 5) （信息-摘要算法）缩写，普遍用于加密和解密技术，经常使用于文件校验。校验？无论文件多大，通过MD5后都能生成惟一的MD5值
SHA (Secure Hash Algorithm，安全散列算法），数字签名等密码学应用中重要的工具，安全性高于MD5
HMAC (Hash Message Authentication Code)，散列消息鉴别码，基于密钥的Hash算法的认证协议。用公开函数和密钥产生一个固定长度的值做为认证标识，用这个标识鉴别消息的完整性。经常使用于接口签名验证

Payload

载荷就是存放有效信息的地方。
有效信息包含三个部分
1.标准中注册的声明
2.公共的声明
3.私有的声明

标准中注册的声明 (建议但不强制使用) ：

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

公共的声明：

公共的声明能够添加任何的信息，通常添加用户的相关信息或其余业务须要的必要信息.但不建议添加敏感信息，由于该部分在客户端可解密.

私有的声明：

私有声明是提供者和消费者所共同定义的声明，通常不建议存放敏感信息，由于base64是对称解密的，意味着该部分信息能够归类为明文信息。

Signature

jwt的第三部分是一个签证信息，这个签证信息由三部分组成：
header (base64后的)
payload (base64后的)
secret
这个部分须要base64加密后的header和base64加密后的payload使用.链接组成的字符串，而后经过header中声明的加密方式进行加盐secret组合加密，而后就构成了jwt的第三部分。
密钥secret是保存在服务端的，服务端会根据这个密钥进行生成token和进行验证，因此须要保护好。

下面来进行SpringBoot和JWT的集成

引入JWT依赖,因为是基于Java，因此须要的是java-jwt

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

须要自定义两个注解

用来跳过验证的PassToken

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

须要登陆才能进行操做的注解UserLoginToken

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

`@Target`:注解的做用目标

@Target(ElementType.TYPE)——接口、类、枚举、注解
@Target(ElementType.FIELD)——字段、枚举的常量
@Target(ElementType.METHOD)——方法
@Target(ElementType.PARAMETER)——方法参数
@Target(ElementType.CONSTRUCTOR) ——构造函数
@Target(ElementType.LOCAL_VARIABLE)——局部变量
@Target(ElementType.ANNOTATION_TYPE)——注解
@Target(ElementType.PACKAGE)——包

`@Retention`：注解的保留位置

RetentionPolicy.SOURCE:这种类型的Annotations只在源代码级别保留,编译时就会被忽略,在class字节码文件中不包含。
RetentionPolicy.CLASS:这种类型的Annotations编译时被保留,默认的保留策略,在class文件中存在,但JVM将会忽略,运行时没法得到。
RetentionPolicy.RUNTIME:这种类型的Annotations将被JVM保留,因此他们能在运行时被JVM或其余使用反射机制的代码所读取和使用。
@Document：说明该注解将被包含在javadoc中
@Inherited：说明子类能够继承父类中的该注解

简单自定义一个实体类User,使用lombok简化实体类的编写

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    String Id;
    String username;
    String password;
}

须要写token的生成方法

public String getToken(User user) {
        String token="";
        token= JWT.create().withAudience(user.getId())
                .sign(Algorithm.HMAC256(user.getPassword()));
        return token;
}

Algorithm.HMAC256():使用HS256生成token,密钥则是用户的密码，惟一密钥的话能够保存在服务端。
withAudience()存入须要保存在token的信息，这里我把用户ID存入token中

接下来须要写一个拦截器去获取`token`并验证`token`

public class AuthenticationInterceptor implements HandlerInterceptor {
    @Autowired
    UserService userService;
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {
        String token = httpServletRequest.getHeader("token");// 从 http 请求头中取出 token
        // 若是不是映射到方法直接经过
        if(!(object instanceof HandlerMethod)){
            return true;
        }
        HandlerMethod handlerMethod=(HandlerMethod)object;
        Method method=handlerMethod.getMethod();
        //检查是否有passtoken注释，有则跳过认证
        if (method.isAnnotationPresent(PassToken.class)) {
            PassToken passToken = method.getAnnotation(PassToken.class);
            if (passToken.required()) {
                return true;
            }
        }
        //检查有没有须要用户权限的注解
        if (method.isAnnotationPresent(UserLoginToken.class)) {
            UserLoginToken userLoginToken = method.getAnnotation(UserLoginToken.class);
            if (userLoginToken.required()) {
                // 执行认证
                if (token == null) {
                    throw new RuntimeException("无token，请从新登陆");
                }
                // 获取 token 中的 user id
                String userId;
                try {
                    userId = JWT.decode(token).getAudience().get(0);
                } catch (JWTDecodeException j) {
                    throw new RuntimeException("401");
                }
                User user = userService.findUserById(userId);
                if (user == null) {
                    throw new RuntimeException("用户不存在，请从新登陆");
                }
                // 验证 token
                JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(user.getPassword())).build();
                try {
                    jwtVerifier.verify(token);
                } catch (JWTVerificationException e) {
                    throw new RuntimeException("401");
                }
                return true;
            }
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, 
                                  HttpServletResponse httpServletResponse, 
                            Object o, ModelAndView modelAndView) throws Exception {

    }
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, 
                                          HttpServletResponse httpServletResponse, 
                                          Object o, Exception e) throws Exception {
    }

实现一个拦截器就须要实现HandlerInterceptor接口

HandlerInterceptor接口主要定义了三个方法
1.boolean preHandle ()：
预处理回调方法,实现处理器的预处理，第三个参数为响应的处理器,自定义Controller,返回值为true表示继续流程（如调用下一个拦截器或处理器）或者接着执行postHandle()和afterCompletion()；false表示流程中断，不会继续调用其余的拦截器或处理器，中断执行。

2.void postHandle()：
后处理回调方法，实现处理器的后处理（DispatcherServlet进行视图返回渲染以前进行调用），此时咱们能够经过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

3.void afterCompletion():
整个请求处理完毕回调方法,该方法也是须要当前对应的Interceptor的preHandle()的返回值为true时才会执行，也就是在DispatcherServlet渲染了对应的视图以后执行。用于进行资源清理。整个请求处理完毕回调方法。如性能监控中咱们能够在此记录结束时间并输出消耗时间，还能够进行一些资源清理，相似于try-catch-finally中的finally，但仅调用处理器执行链中

主要流程:

1.从 http 请求头中取出 token，
2.判断是否映射到方法
3.检查是否有passtoken注释，有则跳过认证
4.检查有没有须要用户登陆的注解，有则须要取出并验证
5.认证经过则能够访问，不经过会报相关错误信息

配置拦截器

在配置类上添加了注解@Configuration，标明了该类是一个配置类而且会将该类做为一个SpringBean添加到IOC容器内

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authenticationInterceptor())
                .addPathPatterns("/**");    // 拦截全部请求，经过判断是否有 @LoginRequired 注解 决定是否须要登陆
    }
    @Bean
    public AuthenticationInterceptor authenticationInterceptor() {
        return new AuthenticationInterceptor();
    }
}

WebMvcConfigurerAdapter该抽象类其实里面没有任何的方法实现，只是空实现了接口
WebMvcConfigurer内的所有方法，并无给出任何的业务逻辑处理，这一点设计恰到好处的让咱们没必要去实现那些咱们不用的方法，都交由WebMvcConfigurerAdapter抽象类空实现,若是咱们须要针对具体的某一个方法作出逻辑处理,仅仅须要在WebMvcConfigurerAdapter子类中@Override对应方法就能够了。

注：
在SpringBoot2.0及Spring 5.0中WebMvcConfigurerAdapter已被废弃
网上有说改成继承WebMvcConfigurationSupport()，不过试了下，仍是过时的

解决方法:

直接实现WebMvcConfigurer （官方推荐）

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

InterceptorRegistry内的addInterceptor须要一个实现HandlerInterceptor接口的拦截器实例，addPathPatterns方法用于设置拦截器的过滤路径规则。
这里我拦截全部请求，经过判断是否有@LoginRequired注解决定是否须要登陆

在数据访问接口中加入登陆操做注解

@RestController
@RequestMapping("api")
public class UserApi {
    @Autowired
    UserService userService;
    @Autowired
    TokenService tokenService;
    //登陆
    @PostMapping("/login")
    public Object login(@RequestBody User user){
        JSONObject jsonObject=new JSONObject();
        User userForBase=userService.findByUsername(user);
        if(userForBase==null){
            jsonObject.put("message","登陆失败,用户不存在");
            return jsonObject;
        }else {
            if (!userForBase.getPassword().equals(user.getPassword())){
                jsonObject.put("message","登陆失败,密码错误");
                return jsonObject;
            }else {
                String token = tokenService.getToken(userForBase);
                jsonObject.put("token", token);
                jsonObject.put("user", userForBase);
                return jsonObject;
            }
        }
    }
    @UserLoginToken
    @GetMapping("/getMessage")
    public String getMessage(){
        return "你已经过验证";
    }
}

不加注解的话默认不验证，登陆接口通常是不验证的。在getMessage()中我加上了登陆注解，说明该接口必须登陆获取token后，在请求头中加上token并经过验证才能够访问

下面进行测试，启动项目，使用postman测试接口

在没token的状况下访问api/getMessage接口

我这里使用了统一异常处理，因此只看到错误message

下面进行登陆，从而获取token

登陆操做我没加验证注解，因此能够直接访问

把token加在请求头中，再次访问api/getMessage接口

注意:这里的key必定不能错，由于在拦截器中是取关键字token的值
String token = httpServletRequest.getHeader("token");
加上token以后就能够顺利经过验证和进行接口访问了

github项目源码地址：https://github.com/JinBinPeng/springboot-jwt

原文摘自：https://www.jianshu.com/p/e88d3f8151db