如何在SpringBoot中集成JWT(JSON Web Token)鉴权

SH的全栈笔记

发布于 2019-10-20 18:15:30

1.5K1

发布于 2019-10-20 18:15:30

文章被收录于专栏：SH的全栈笔记SH的全栈笔记

关于JWT

什么是JWT

老生常谈的开头，我们要用这样一种工具，首先得知道以下几个问题。

这个工具是什么，这个工具解决了什么问题
是否适用于当前我们所处得业务场景
用了之后是否会带来任何其他问题
怎么用才是最佳实践

那什么是JWT呢？以下是我对jwt官网上对JWT介绍的翻译。

JSON Web Token （JWT）是一种定义了一种紧凑并且独立的，用于在各方之间使用JSON对象安全的传输信息的一个开放标准（RFC 7519）。

现在我们知道，JWT其实是一种开放标准，用于在多点之间安全地传输用JSON表示的数据。在传输的过程中，JWT以字符串的形式出现在我们的视野中。该字符串中的信息可以通过数字签名进行验证和信任。

应用场景

JWT在实际的开发中，有哪些应用场景呢？

授权

这应该算是JWT最常见的使用场景。在前端界面中，一旦用户登录成功，会接收到后端返回的JWT。后续的请求都会包含后端返回的JWT，作为对后端路由、服务以及资源的访问的凭证。

信息交换

利用JWT在多方之间相互传递信息具有一定的安全性，例如JWT可以用HMAC、RSA非对称加密算法以及ECDSA数字签名算法对JWT进行签名，可以确保消息的发送者是真的发送者，而且使用header和payload进行的签名计算，我们还可以验证发送的消息是否被篡改了。

JWT的结构

通俗来讲JWT由header.payload.signature三部分组成的字符串，网上有太多帖子介绍这一块了，所以在这里就简单介绍一下就好了。

header

header由使用的签名算法和令牌的类型的组成，例如令牌的类型就是JWT这种开放标准，而使用的签名算法就是HS256，也就是HmacSHA256算法。其他的加密算法还有HmacSHA512、SHA512withECDSA等等。

然后将这个包含两个属性的JSON对象转化为字符串然后使用Base64编码，最终形成了JWT的header。

payload

payload说直白一些就类似你的requestBody中的数据。只不过是分了三种类型，预先申明好的、自定义的以及私有的。像iss发件人，exp过期时间都是预先注册好的申明。

预先申明在载荷中的数据不是强制性的使用，但是官方建议使用。然后这串类似于requestBody的JSON经过Base64编码形成了JWT的第二部分。

signature

如果要生成signature，就需要使用jwt自定义配置项中的secret，也就是Hmac算法加密所需要的密钥。将之前经过Base64编码的header和payload用.相连，再使用自定义的密钥，对该消息进行签名，最终生成了签名。

生成的签名用于验证消息在传输的过程中没有被更改。在使用非对称加密算法进行签名的时候，还可以用于验证JWT的发件人是否与payload中申明的发件人是同一个人。

JWT在Spring项目中的应用场景

生成JWT

代码如下。

public String createJwt(String userId, String projectId) throws IllegalArgumentException, UnsupportedEncodingException {    Algorithm al = Algorithm.HMAC256(secret);    Instant instant = LocalDateTime.now().plusHours(outHours).atZone(ZoneId.systemDefault()).toInstant();    Date expire = Date.from(instant);    String token = JWT.create()            .withIssuer(issuer)            .withSubject("userInfo")            .withClaim("user_id", userId)            .withClaim("project_id", projectId)            .withExpiresAt(expire)            .sign(al);    return token;}

传入的两个Claim是项目里自定义的payload，al是选择的算法，而secret就是对信息签名的密钥，subject则是该token的主题，withExpiresAt标识了该token的过期时间。

返回JWT

在用户登录系统成功之后，将token作为返回参数，返回给前端。

验证token

在token返回给前端之后，后端要做的就是验证这个token是否是合法的，是否可以访问服务器的资源。主要可以通过以下几种方式去验证。

解析token

使用JWTVerifier解析token，这是验证token是否合法的第一步，例如前端传过来的token是一串没有任何意义的字符串，在这一步就可以抛出错误。示例代码如下。

try {    Algorithm algorithm = Algorithm.HMAC256(secret);    JWTVerifier verifier = JWT.require(algorithm).build();    DecodedJWT jwt = verifier.verify(token);} catch (JWTVerificationException e) {    e.printStackTrace();}

JWTVerifier可以使用用制定secret签名的算法，指定的claim来验证token的合法性。

判断token时效性

判断了token是有效的之后，再对token的时效性进行验证。

try {    Algorithm algorithm = Algorithm.HMAC256(secret);    JWTVerifier verifier = JWT.require(algorithm).build();    DecodedJWT jwt = verifier.verify(token);    if (jwt.getExpiresAt().before(new Date())) {        System.out.println("token已过期");        return null;    }} catch (JWTVerificationException e) {    e.printStackTrace();    return null;}

如果该token过期了，则不允许访问服务器资源。具体的流程如下。