投稿
  1. 极客之音首页
  2. 技术随笔

一文详解jwt token以及sprig boot如何整合实现 jwt token操作

小半 • • 技术随笔 • 阅读 657

导读：本篇文章讲解 一文详解jwt token以及sprig boot如何整合实现 jwt token操作，希望对大家有帮助，欢迎收藏，转发！站点地址：www.bmabk.com

文章目录

1. jwt是什么

Json web token (JWT)，是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准(RFC 7519)。

该token被设计为紧凑且安全的，特别适用于分布式站点的单点登录（SSO）场景。

JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源，也可以增加一些额外的其它业务逻辑所必须的声明信息，该token也可直接被用于认证，也可被加密。

2. jwt的来源

说起JWT的来源，我们应该来谈一谈基于token的认证和传统的session认证的区别。

2.1 传统的session认证

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

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

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

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

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

2.2 基于token的鉴权机制

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

流程如下：

  1. 用户使用用户名密码来请求服务器

  2. 服务器进行验证用户的信息

  3. 服务器通过验证发送给用户一个token

  4. 客户端存储token，并在每次请求时附送上这个token值

  5. 服务端验证token值，并返回数据

这个token必须要在每次请求时传递给服务端，它应该保存在请求头里。

另外，服务端要支持CORS(跨来源资源共享)策略，一般我们在服务端这么做就可以了Access-Control-Allow-Origin: *。

那么我们现在回到JWT的主题上。

3. JWT的构成

JWT是由三段信息构成的，将这三段信息文本用.链接一起就构成了Jwt字符串，如下所示：

Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ7XCJ1c2VySWRcIjoxLFwidXNlcm5hbWVcIjpcImFkbWluXCJ9IiwiZXhwIjoxNjY0MTY1MzM3fQ.yh_csNBLZHsqXEAhY90sKO49o02TXYkduCgIeV7W0zEOyY9MMY_bMYTa0OHeKvEKdNB5TAO_WgGKRF5LC5TBMA

三段信息中的第一部分为头部（header)，第二部分我们称其为载荷（payload，类似于飞机上承载的物品)，第三部分是签证（signature)。

3.1 header

jwt的头部承载两部分信息：

  • 声明类型，这里是jwt
  • 声明加密的算法 通常直接使用HMAC SHA256

完整的头部如下JSON：

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

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

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9

3.2 playload

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

  • 标准中注册的声明

  • 公共的声明

  • 私有的声明

  1. 标准中注册的声明 (建议但不强制使用) ：
  • iss: jwt签发者
  • sub: jwt所面向的用户
  • aud: 接收jwt的一方
  • exp: jwt的过期时间，这个过期时间必须要大于签发时间
  • nbf: 定义在什么时间之前，该jwt都是不可用的.
  • iat: jwt的签发时间
  • jti: jwt的唯一身份标识，主要用来作为一次性token，从而回避重放攻击。
  1. 公共的声明

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

  1. 私有的声明

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

定义一个payload:

{
  "sub": "1234567890",
  "name": "John Doe",
  "admin": true
}

然后将其进行base64加密，得到Jwt的第二部分。

eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9

3.3 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了。

4. 如何应用

一般是在请求头里加Authorization，并加上Bearer标注：

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

服务端会验证token，如果验证通过就会返回相应的资源，整个流程如下:

在这里插入图片描述

5. spring boot 集成jwt

  1. 引入jwt的maven jar包

<properties>
   <java.version>1.8</java.version>
   <jwtApi.version>0.10.6</jwtApi.version>
</properties>
    
<!-- jwt配饰开始-->
<dependency>
   <groupId>io.jsonwebtoken</groupId>
   <artifactId>jjwt-api</artifactId>
   <version>${jwtApi.version}</version>
</dependency>
<dependency>
   <groupId>io.jsonwebtoken</groupId>
   <artifactId>jjwt-impl</artifactId>
   <version>${jwtApi.version}</version>
</dependency>
<dependency>
   <groupId>io.jsonwebtoken</groupId>
   <artifactId>jjwt-jackson</artifactId>
   <version>${jwtApi.version}</version>
</dependency>
  1. 在application.yml配置jwt信息
# jwt配置
jwt:
  tokenHeader: Authorization # JWT存储的请求头
  # 令牌前缀: JWT负载中拿到开头
  tokenStartWith: Bearer
  secret: ZmQ0ZGI5NjQ0MDQwY2I4MjMNTE0MzI= #JWT加解密使用的密钥的base64编码
  expiration: 7200000 #JWT的超期限时间-2小时候超时
  typ: JWT
  alg: HS256
  subject: superJson-user
  1. 实例化application.yml的jwt配置属性

/**
 * @author 念兮为美
 * @datetime 2022/8/19 12:05
 * @desc jwt实体类，从yml配置文件中获取配置的属性
 */
@Getter
@Setter
@Configuration
@ConfigurationProperties(prefix = "jwt")
public class JwtProperties {

  @Value("${jwt.secret}")
  private String appSecret;

  @Value("${jwt.expiration}")
  private long expiration;

  @Value("${jwt.typ}")
  private String typ;

  @Value("${jwt.alg}")
  private String alg;

  @Value("${jwt.subject}")
  private String subject;

  @Value("${jwt.tokenStartWith}")
  private String tokenStartWith;

  @Value("${jwt.tokenHeader}")
  private String tokenHeader;

  public String getTokenStartWith() {
    return tokenStartWith + " ";
  }
  1. 创建生成jwt token类JwtTokenProvider
/**
 * @author 念兮为美
 * @create 2020-01-12 20:50 JWT-TOKEN 提供类
 */
@Slf4j
@Component
public class JwtTokenProvider implements InitializingBean {

    @Autowired
    private JwtProperties properties;
    private Key key;

    /**
     * 实例化对前会调用此方法,需要Spring的环境
     *
     * @throws Exception
     */
    @Override
    public void afterPropertiesSet() {
        byte[] decode = Decoders.BASE64.decode(properties.getAppSecret());
        this.key = Keys.hmacShaKeyFor(decode);
    }

    /**
     * 创建token
     *
     * @return
     */
    public String createToken(String username, int userId) {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put(USERNAME, username);
        jsonObject.put(USER_ID, userId);
        return Jwts.builder()
                .setSubject(JSONUtil.toJsonStr(jsonObject))
                .setExpiration(new Date(System.currentTimeMillis() + properties.getExpiration()))
                .signWith(key, SignatureAlgorithm.HS512)
                .compact();
    }

    /**
     * 验证token
     *
     * @return
     */
    public boolean checkToken(String token) {
        try {
            log.info("token= {}", token);
            Jwts.parser().setSigningKey(key).parseClaimsJwt(token);
            return true;
        } catch (io.jsonwebtoken.security.SecurityException | MalformedJwtException e) {
            log.info("Invalid JWT signature.");
            e.printStackTrace();
        } catch (ExpiredJwtException e) {
            log.info("Expired JWT token.");
            e.printStackTrace();
        } catch (UnsupportedJwtException e) {
            log.info("Unsupported JWT token.");
            e.printStackTrace();
        } catch (IllegalArgumentException e) {
            log.info("JWT token compact of handler are invalid.");
            e.printStackTrace();
        }
        return false;
    }

    /**
     * 根据token 解析出username
     *
     * @param token
     * @return
     */
    public JSONObject parseToken(String token) {
        Claims body = Jwts.parser().setSigningKey(key).parseClaimsJws(token).getBody();
        String userJson = body.getSubject();
        return JSON.parseObject(userJson);
    }

    /**
     * 从request中获取token
     *
     * @param request
     * @param tokenHeader 请求头信息，比如Authorization
     * @return
     */
    public String getToken(ServletRequest request, String tokenHeader) {
        if (isNull(request)) {
            throw new FrameException(SIGNATURE_NOT_MATCH);
        }
        String headerToken = null;
        if (request instanceof HttpServletRequest) {
            HttpServletRequest httpServletRequest = (HttpServletRequest) request;
            headerToken = httpServletRequest.getHeader(tokenHeader);
        } else if (request instanceof ServerHttpRequest) {
            ServerHttpRequest serverHttpRequest = (ServerHttpRequest) request;
            HttpHeaders headers = serverHttpRequest.getHeaders();
            headerToken = headers.getFirst(tokenHeader);
        }
        if (headerToken != null && headerToken.startsWith(properties.getTokenStartWith())) {
            headerToken = headerToken.substring(properties.getTokenStartWith().length());
        }
        return headerToken;
    }
}
  1. 测试生成 jwt token
// 指定需要加载的配置文件，比如application-local.yml
@ActiveProfiles("local")
// 修改启动环境
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class SuperJsonManagerApplicationTests {

  @Test
  void contextLoads() {}

  @Autowired private JwtTokenProvider jwtConfig;
  @Autowired private JwtProperties jwtProperties;

  /**
   * 测试token
   *
   * @author 念兮为美
   * @datetime 2022/8/24:15:45
   * @return
   */
  @Test
  public void tokenGener() {
    System.out.println(UUID.randomUUID().toString());
    String username = "念兮为美";
    int uid = 120001;
    String token = jwtConfig.createToken(username, uid);
    System.out.println("jwt token 输出信息：" + jwtProperties.getTokenStartWith() + token);
  }
}

输出结果如下图所示：

在这里插入图片描述

  1. 测试解析5中生成的token，获取username和uid
// 指定需要加载的配置文件，比如application-local.yml
@ActiveProfiles("local")
// 修改启动环境
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class SuperJsonManagerApplicationTests {

  @Test
  void contextLoads() {}

  @Autowired private JwtTokenProvider jwtConfig;
  @Autowired private JwtProperties jwtProperties;

  /**
   * 测试token
   *
   * @author 念兮为美
   * @datetime 2022/8/24:15:45
   * @return
   */
  @Test
  public void tokenGener() {
  	String token =
        "Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ7XCJ1c2VySWRcIjoxMjAwMDEsXCJ1c2VybmFtZVwiOlwi5b-15YWu5Li6576OXCJ9IiwiZXhwIjoxNjY0MTcwNTIzfQ.RRSvdTVQt6QRj66ghsLPWnBuK8xJxghENfsmbDhl7aYMOmpR3edS_xrm823-bv_SxHA5ToYEfnUYI-uO5ce8gg";
    token = token.replaceAll(jwtProperties.getTokenStartWith(), "");
    JSONObject jsonObject = jwtConfig.parseToken(token);
    System.out.println(jsonObject);
  }
}

输出结果如下图所示：

在这里插入图片描述

6. 总结

6.1 优点

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

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

  3. 便于传输，jwt的构成非常简单，字节占用很小，所以它是非常便于传输的

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

6.2 安全相关

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

  2. 保护好secret私钥，该私钥非常重要

  3. 如果可以，请使用https协议

7. 参看文档

  1. https://www.jianshu.com/p/576dbf44b2ae

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。

文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/99133.html

赞 (0)
小半的头像小半
0 0

相关推荐

极客之音——专业性很强的中文编程技术网站，欢迎收藏到浏览器，订阅我们！