JWT鉴权如何来写一个token令牌认证登录?

Posted 狮子也疯狂

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了JWT鉴权如何来写一个token令牌认证登录?相关的知识,希望对你有一定的参考价值。

目录

一. 🦁 话题引入

在做项目过程中,我们一般都是最先编写登录注册功能,登录功能最重要的是登录成功后,系统还会保存该登录用户信息,这种保存用户信息的逻辑可以有两种:

  1. 最简单的一种就是使用Session来保存用户信息,然后使用filter来验证用户是否登录,但是这种方法只能是单体架构的项目适用,性能也不会很好。在分布式项目中,会有很多子模块并且部署在不同的服务器中,这样是无法使用session保存的,因为sessio不能共享。
  2. 使用单点登录技术就能很好地解决这个弊端。
  • 单点登录(Single Sign On)简称为 SSO。即在多个应用系统中,用户只需要登录一次就可以访问所有相互信任的应用系统。JWT是一种常用的单点登录解决方案。

1.2 什么是JWT?

JWTJson Web Token的简称,是一种令牌生成算法。使用JWT能够保证Token的安全性,且能够进行Token时效性的检验。使用JWT时,登录成功后将用户信息生成一串令牌字符串。将该字符串返回给客户端,客户端每次请求时都在请求头携带该令牌字符串。在其他模块验证令牌,通过则证明用户处于登录状态,并拿到解析后的用户信息,未通过证明用户处于未登录状态。

二. 🦁 技术体现

要实现JWT鉴权,就得实现如下步骤:

  • 引入JWT工具类,编写生成令牌和解析令牌的方法。
  • 用户登录成功后生成令牌字符串返回给前端。
  • 前端每次请求时都在请求头带入令牌字符串。
  • 在通用模块编写拦截器,解析请求头中的令牌字符串。
  • 在Api模块配置拦截器,配置拦截器拦截哪些接口,即这些接口需要登录才能访问。

现在来编写代码实现

2.1 引入依赖

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

2.2 编写JWT工具类

import com.auth0.jwt.JWT;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.Claim;
import com.itbaizhan.shopping_common.exception.BusException;
import com.itbaizhan.shopping_common.pojo.ShoppingUser;
import com.itbaizhan.shopping_common.result.CodeEnum;

import java.util.Date;

public class JWTUtil 
    //token过期时间,一天
    private static final Long EXPIRE_DATE = 1000*60*60*24L;
    // 秘钥
    private static final String SECRET = "jackie";
    // 签发者
    private static final String ISSUER = "JACKIE";

    /**
     * 签名生成
     * @param shoppingUser
     * @return
     */
    public static String sign(ShoppingUser shoppingUser)
        String token = JWT.create()
                .withIssuer(ISSUER) // 签发者
                .withIssuedAt(new Date()) // 签发时间
                .withExpiresAt(new Date(new Date().getTime() + EXPIRE_DATE)) // 过期时间
                .withSubject(shoppingUser.getUsername()) // 保存用户名
                .withClaim("userId",shoppingUser.getId()) // 保存用户id
                .sign(Algorithm.HMAC256(SECRET)); // 秘钥
        return token;
    

    /**
     * 签名解析
     * @param token 签名字符串
     * @return 解析得出的用户名
     */
    public static String verify(String token)
        try 
            String username = JWT
                    .require(Algorithm.HMAC256(SECRET))
                    .withIssuer(ISSUER)
                    .build()
                    .verify(token)
                    .getSubject();
            return username;
         catch (Exception e)
            throw new BusException(CodeEnum.VERIFY_TOKEN_ERROR);
        
    

    /**
     * 签名解析,获取用户id
     * @param token 签名字符串
     * @return 用户id
     */
    public static Long getId(String token)
        try 
            Long userId = JWT
                    .require(Algorithm.HMAC256(SECRET))
                    .withIssuer(ISSUER)
                    .build()
                    .verify(token)
                    .getClaim("userId")
                    .asLong();
            return userId;
         catch (Exception e)
            throw new BusException(CodeEnum.VERIFY_TOKEN_ERROR);
        
    

这个utils有三个方法,一个是生成token字符串,一个是解析该字符串获取登录的用户名,还要就是获取登录用户的id。

2.3 编写登录方法

如果使用Session存储用户信息,在验证完名字和密码后,直接将该登录对象setAttribute(“users”,users)里面。

而使用单点登录,则是直接调用JWTUtil.sign(user),生成JWT令牌,返回该令牌给前端用户。
标准代码:

服务层:

 @Override
    public String loginPassword(String username, String password) 
        // 1.验证用户名
        QueryWrapper<ShoppingUser> queryWrapper = new QueryWrapper();
        queryWrapper.eq("username",username);
        ShoppingUser shoppingUser = shoppingUserMapper.selectOne(queryWrapper);
        if (shoppingUser == null)
            throw new BusException(CodeEnum.LOGIN_NAME_PASSWORD_ERROR);
        
        // 2.验证密码
        boolean verify = Md5Util.verify(password, shoppingUser.getPassword());
        if (!verify)
            throw new BusException(CodeEnum.LOGIN_NAME_PASSWORD_ERROR);
        
        // 3.生成JWT令牌,返回令牌
        String sign = JWTUtil.sign(shoppingUser);
        return sign;
    

控制层

 /**
     * 用户名密码登录
     * @param shoppingUser 用户对象
     * @return 登录结果
     */
    @PostMapping("/loginPassword")
    public BaseResult loginPassword(@RequestBody ShoppingUser shoppingUser)
        String sign = shoppingUserService.loginPassword(shoppingUser.getUsername(), shoppingUser.getPassword());
        return BaseResult.ok(sign);
    

2.4 编写JWT拦截器验证令牌

这里验证令牌的方式是拦截所有的请求,如果 JWTUtil.verify(token)不抛异常则通过这个请求。

// 拦截器,验证令牌
public class JWTInterceptor implements HandlerInterceptor 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        // 获取请求头中的token
        String token = request.getHeader("token");
        // 验证令牌
        JWTUtil.verify(token);
        return true;
    

2.5 编写要配置拦截的接口

我们在用户模块配置该模块要拦截的接口(如果是单体架构,拦截器和该部分可以写在一起)。

除了这种方式,还有一种编写方式,你想知道吗?

在User模块先实例化一个InterceptorConfig配置类,实现WebMvcConfigurer接口,将上面写的拦截器在addInterceptor(new JWTInterceptor())方法里面实例化,然后拦截所有的接口( .addPathPatterns(“/**”)),再放行不需要认证的接口。

// 拦截器配置
@Configuration
public class InterceptorConfig implements WebMvcConfigurer 
    @Override
    public void addInterceptors(InterceptorRegistry registry) 
        registry.addInterceptor(new JWTInterceptor())
                .addPathPatterns("/**") // 拦截的接口
                .excludePathPatterns(
                       "填写需要放行的接口url"
                ); //放行的接口
    

至此,一个令牌认证就完成啦。

三. 🦁 话题终结

又一篇业务逻辑类的文章表述,希望路过的您看到了觉得还行,给个三连哦 🌹。

基于token的鉴权机制 — JWT介绍

  前言:在实际开发项目中,由于Http是一种无状态的协议,我们想要记录用户的登录状态,或者为用户创建身份认证的凭证,可以使用Session认证机制或者JWT认证机制。

什么是JWT?

  Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准((RFC 7519).该token被设计为紧凑且安全的,特别适用于分布式站点的单点登录(SSO)场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息,以便于从资源服务器获取资源,也可以增加一些额外的其它业务逻辑所必须的声明信息,该token也可直接被用于认证,也可被加密。

JWT与Session的区别

Session  

  传统的session认证:我们知道,http协议本身是一种无状态的协议,而这就意味着如果用户向我们的应用提供了用户名和密码来进行用户认证,那么下一次请求时,用户还要再一次进行用户认证才行,因为根据http协议,我们并不能知道是哪个用户发出的请求,所以为了让我们的应用能识别是哪个用户发出的请求,我们只能在服务器存储一份用户登录的信息,这份登录信息会在响应时传递给浏览器,告诉其保存为cookie,以便下次请求时发送给我们的应用,这样我们的应用就能识别请求来自哪个用户了,这就是传统的基于session认证。

但是这种基于session的认证使应用本身很难得到扩展,随着不同客户端用户的增加,独立的服务器已无法承载更多的用户,而这时候基于session认证应用的问题就会暴露出来。

  基于session认证所显露的问题:

   占资源: 每个用户经过我们的应用认证之后,我们的应用都要在服务端做一次记录,以方便用户下次请求的鉴别,通常而言session都是保存在内存中,而随着认证用户的增多,服务端的开销会明显增大。

  ② 扩展性弱:用户认证之后,服务端做认证记录,如果认证的记录被保存在内存中的话,这意味着用户下次请求还必须要请求在这台服务器上,这样才能拿到授权的资源,这样在分布式的应用上,相应的限制了负载均衡器的能力。这也意味着限制了应用的扩展能力。

  ③ CSRF攻击:因为是基于cookie来进行用户识别的, cookie如果被截获,用户就会很容易受到跨站请求伪造的攻击。

Json Web Token

  基于token的鉴权机制:基于token的鉴权机制类似于http协议也是无状态的,它不需要在服务端去保留用户的认证信息或者会话信息。这就意味着基于token认证机制的应用不需要去考虑用户在哪一台服务器登录了,这就为应用的扩展提供了便利。

流程上是这样的:

  • 用户使用用户名密码来请求服务器
  • 服务器进行验证用户的信息
  • 服务器通过验证发送给用户一个token
  • 客户端存储token,并在每次请求时附送上这个token值
  • 服务端验证token值,并返回数据

  这个token必须要在每次请求时传递给服务端,它应该保存在请求头里, 另外,服务端要支持CORS(跨来源资源共享)策略,一般我们在服务端这么做就可以了Access-Control-Allow-Origin: *

JWT长什么样?

  JWT是由三段信息构成的,将这三段信息文本用.链接一起就构成了Jwt字符串。就像这样:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
# 头部(header). 载荷(payload). 签证(signature)

  第一部分我们称它为头部(header),第二部分我们称其为载荷(payload, 类似于飞机上承载的物品),第三部分是签证(signature).

JWT的构成

① header :jwt的头部承载两部分信息

  --> 声明类型,这里是jwt

  --> 声明加密的算法 通常直接使用 HMAC SHA256

  -->完整的头部就像下面这样的JSON:

  -->然后将头部进行base64加密(该加密是可以对称解密的),构成了第一部分.

# 完整的头部示例
{
  typ: JWT,
  alg: HS256
}
# 加密后的头部 eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9

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

  --> 标准中的注册的声明

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

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

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

# 一个完整的payload
{
  "sub": "1234567890",
  "name": "John Doe",
  "admin": true
}

# base64加密后
eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9

 

③ signature:JWT的第三部分是一个签证信息,这个签证信息由三部分组成

  --> header (base64后的)

  --> payload (base64后的)

    --> secret

 

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

// javascript
var encodedString = base64UrlEncode(header) + . + base64UrlEncode(payload);

var signature = HMACSHA256(encodedString, secret); // TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

 

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

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

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

 

如何应用

一般是在请求头里加入Authorization,并加上Bearer标注:

fetch(api/user/1, {
  headers: {
    Authorization: Bearer  + token
  }
})

服务端会验证token,如果验证通过就会返回相应的资源。整个流程就是这样的:

 技术分享图片

优点

 ①  因为json的通用性,所以JWT是可以进行跨语言支持的,像JAVA,JavaScript,NodeJS,PHP等很多语言都可以使用。

   ②  因为有了payload部分,所以JWT可以在自身存储一些其他业务逻辑所必要的非敏感信息。

   ③  便于传输,jwt的构成非常简单,字节占用很小,所以它是非常便于传输的。

   ④  它不需要在服务端保存会话信息, 所以它易于应用的扩展

安全相关

  ① 不应该在jwt的payload部分存放敏感信息,因为该部分是客户端可解密的部分。

  ② 保护好secret私钥,该私钥非常重要。

  ③ 如果可以,请使用https协议

 


以上是关于JWT鉴权如何来写一个token令牌认证登录?的主要内容,如果未能解决你的问题,请参考以下文章

.NET Core5.0 JWT鉴权SSO单点登录

基于token的鉴权机制 — JWT介绍

JWT【分布式鉴权方案】

Bearer Token 认证和 JWT

SpringSecurity注解鉴权(整合springboot,jwt,redis)

鉴权必须了解的 5 个兄弟:cookie、session、token、jwt、单点登录