当前位置 : 主页 > 编程语言 > java >

JWT全面解读、详细使用步骤

来源:互联网 收集:自由互联 发布时间:2023-02-04
前言 现在,JSON Web Tokens (JWT) 是非常流行的。尤其是 Web 开发领域。 流行 安全 稳定 易用 支持 JSON 所有这些因素,令 JWT 名声大振。 JSON Web Token(JWT)是目前最流行的跨域身份验证解决

前言

现在,JSON Web Tokens (JWT) 是非常流行的。尤其是 Web 开发领域。

  • 流行
  • 安全
  • 稳定
  • 易用
  • 支持 JSON

所有这些因素,令 JWT 名声大振。

image

JSON Web Token(JWT)是目前最流行的跨域身份验证解决方案。今天给大家介绍JWT的原理和用法。

1.跨域身份验证

Internet服务无法与用户身份验证分开。一般过程如下。

  • 1.用户向服务器发送用户名和密码。

  • 2.验证服务器后,相关数据(如用户角色,登录时间等)将保存在当前会话中。

  • 3.服务器向用户返回session_id,session信息都会写入到用户的Cookie。

  • 4.用户的每个后续请求都将通过在Cookie中取出session_id传给服务器。

  • 5.服务器收到session_id并对比之前保存的数据,确认用户的身份。

image

这种模式最大的问题是,没有分布式架构,无法支持横向扩展。如果使用一个服务器,该模式完全没有问题。但是,如果它是服务器群集或面向服务的跨域体系结构的话,则需要一个统一的session数据库库来保存会话数据实现共享,这样负载均衡下的每个服务器才可以正确的验证用户身份。

 

例如,举一个实际中常见的单点登陆的需求:站点A和站点B提供同一公司的相关服务。现在要求用户只需要登录其中一个网站,然后它就会自动登录到另一个网站。怎么做?  

一种解决方案是听过持久化session数据,写入数据库或文件持久层等。收到请求后,验证服务从持久层请求数据。该解决方案的优点在于架构清晰,而缺点是架构修改比较费劲,整个服务的验证逻辑层都需要重写,工作量相对较大。而且由于依赖于持久层的数据库或者问题系统,会有单点风险,如果持久层失败,整个认证体系都会挂掉。

image

本文给大家介绍另外一种灵活的解决方案,通过客户端保存数据,而服务器根本不保存会话数据,每个请求都被发送回服务器。 JWT是这种解决方案的代表。

image

JWT官网有一张图描述了JWT的认证过程: jwt-diagram.png

2. JWT的原则

JWT的原则是在服务器身份验证之后,将生成一个JSON对象并将其发送回用户,如下所示。

{ "UserName":"Chongchong", "Role":"Admin", "Expire":"2018-08-08 20:15:56" }

之后,当用户与服务器通信时,客户在请求中发回JSON对象。服务器仅依赖于这个JSON对象来标识用户。为了防止用户篡改数据,服务器将在生成对象时添加签名(有关详细信息,请参阅下文)。

服务器不保存任何会话数据,即服务器变为无状态,使其更容易扩展。

3. JWT的数据结构

典型的,一个JWT看起来如下图。

改对象为一个很长的字符串,字符之间通过"."分隔符分为三个子串。注意JWT对象为一个长字串,各字串之间也没有换行符,此处为了演示需要,我们特意分行并用不同颜色表示了。每一个子串表示了一个功能块,总共有以下三个部分:

JWT的三个部分如下。JWT头、有效载荷和签名,将它们写成一行如下。

image

我们将在下面介绍这三个部分。

3.1 JWT头

JWT头部分是一个描述JWT元数据的JSON对象,通常如下所示。

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

在上面的代码中,alg属性表示签名使用的算法,默认为HMAC SHA256(写为HS256);typ属性表示令牌的类型,JWT令牌统一写为JWT。

最后,使用Base64 URL算法将上述JSON对象转换为字符串保存。

3.2 有效载荷

有效载荷部分,是JWT的主体内容部分,也是一个JSON对象,包含需要传递的数据。 JWT指定七个默认字段供选择。

  • iss:发行人

  • exp:到期时间

  • sub:主题

  • aud:用户

  • nbf:在此之前不可用

  • iat:发布时间

  • jti:JWT ID用于标识该JWT

除以上默认字段外,我们还可以自定义私有字段,如下例:

{ "sub":"1234567890", "name":"wanglihong", "admin":true }

请注意,默认情况下JWT是未加密的,任何人都可以解读其内容,因此不要构建隐私信息字段,存放保密信息,以防止信息泄露。

JSON对象也使用Base64 URL算法转换为字符串保存。

3.3签名哈希

签名哈希部分是对上面两部分数据签名,通过指定的算法生成哈希,以确保数据不会被篡改。

首先,需要指定一个密码(secret)。该密码仅仅为保存在服务器中,并且不能向用户公开。然后,使用标头中指定的签名算法(默认情况下为HMAC SHA256)根据以下公式生成签名。

HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(payload),

secret)

在计算出签名哈希后,JWT头,有效载荷和签名哈希的三个部分组合成一个字符串,每个部分用"."分隔,就构成整个JWT对象。

3.4 Base64URL算法

如前所述,JWT头和有效载荷序列化的算法都用到了Base64URL。该算法和常见Base64算法类似,稍有差别。

作为令牌的JWT可以放在URL中(例如api.example/?token=xxx)。 Base64中用的三个字符是"+","/"和"=",由于在URL中有特殊含义,因此Base64URL中对他们做了替换:"="去掉,"+"用"-"替换,"/"用"_"替换,这就是Base64URL算法,很简单把。

4. JWT的用法

客户端接收服务器返回的JWT,将其存储在Cookie或localStorage中。

此后,客户端将在与服务器交互中都会带JWT。如果将它存储在Cookie中,就可以自动发送,但是不会跨域,因此一般是将它放入HTTP请求的Header Authorization字段中。

Authorization: Bearer

当跨域时,也可以将JWT被放置于POST请求的数据主体中。

5. JWT问题和趋势

  • 1、JWT默认不加密,但可以加密。生成原始令牌后,可以使用改令牌再次对其进行加密。

  • 2、当JWT未加密方法是,一些私密数据无法通过JWT传输。

  • 3、JWT不仅可用于认证,还可用于信息交换。善用JWT有助于减少服务器请求数据库的次数。

  • 4、JWT的最大缺点是服务器不保存会话状态,所以在使用期间不可能取消令牌或更改令牌的权限。也就是说,一旦JWT签发,在有效期内将会一直有效。

  • 5、JWT本身包含认证信息,因此一旦信息泄露,任何人都可以获得令牌的所有权限。为了减少盗用,JWT的有效期不宜设置太长。对于某些重要操作,用户在使用时应该每次都进行进行身份验证。

  • 6、为了减少盗用和窃取,JWT不建议使用HTTP协议来传输代码,而是使用加密的HTTPS协议进行传输。

JWT基本使用

在pom.xml引入java-jwt

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

Gradle下依赖

compile 'com.auth0:java-jwt:3.4.0'

示例如下:

package yui.ui.web.sys.controller; import java.util.Calendar; import java.util.Date; import java.util.HashMap; import java.util.Map; import com.alibaba.druid.util.StringUtils; import com.auth0.jwt.JWT; import com.auth0.jwt.JWTVerifier; import com.auth0.jwt.algorithms.Algorithm; import com.auth0.jwt.interfaces.Claim; import com.auth0.jwt.interfaces.DecodedJWT; public class Test { /** * APP登录Token的生成和解析 * */ /** token秘钥,请勿泄露,请勿随便修改 backups:JKKLJOoasdlfj */ public static final String SECRET = "JKKLJOoasdlfj"; /** token 过期时间: 10天 */ public static final int calendarField = Calendar.DATE; public static final int calendarInterval = 10; /** * JWT生成Token.<br/> * * JWT构成: header, payload, signature * * @param user_id * 登录成功后用户user_id, 参数user_id不可传空 */ public static String createToken(Long user_id) throws Exception { Date iatDate = new Date(); // expire time Calendar nowTime = Calendar.getInstance(); nowTime.add(calendarField, calendarInterval); Date expiresDate = nowTime.getTime(); // header Map Map<String, Object> map = new HashMap<>(); map.put("alg", "HS256"); map.put("typ", "JWT"); // build token // param backups {iss:Service, aud:APP} String token = JWT.create().withHeader(map) // header .withClaim("iss", "Service") // payload .withClaim("aud", "APP").withClaim("user_id", null == user_id ? null : user_id.toString()) .withIssuedAt(iatDate) // sign time .withExpiresAt(expiresDate) // expire time .sign(Algorithm.HMAC256(SECRET)); // signature return token; } /** * 解密Token * * @param token * @return * @throws Exception */ public static Map<String, Claim> verifyToken(String token) { DecodedJWT jwt = null; try { JWTVerifier verifier = JWT.require(Algorithm.HMAC256(SECRET)).build(); jwt = verifier.verify(token); } catch (Exception e) { // e.printStackTrace(); // token 校验失败, 抛出Token验证非法异常 } return jwt.getClaims(); } /** * 根据Token获取user_id * * @param token * @return user_id */ public static Long getAppUID(String token) { Map<String, Claim> claims = verifyToken(token); Claim user_id_claim = claims.get("user_id"); if (null == user_id_claim || StringUtils.isEmpty(user_id_claim.asString())) { // token 校验失败, 抛出Token验证非法异常 } return Long.valueOf(user_id_claim.asString()); } }

最终存放的数据在JWT内部的实体claims里。它是存放数据的地方

概念介绍

JWT消息构成

一个token分3部分,按顺序为

  • 头部(header)
  • 其为载荷(payload)
  • 签证(signature) 由三部分生成token 3部分之间用“.”号做分隔。例如eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c 验证koten地址

头部

Jwt的头部承载两部分信息:

  • 声明类型,这里是jwt
  • 声明加密的算法 通常直接使用 HMAC SHA256 JWT里验证和签名使用的算法,可选择下面的。
JWS 算法名称 描述 HS256 HMAC256 HMAC with SHA-256 HS384 HMAC384 HMAC with SHA-384 HS512 HMAC512 HMAC with SHA-512 RS256 RSA256 RSASSA-PKCS1-v1_5 with SHA-256 RS384 RSA384 RSASSA-PKCS1-v1_5 with SHA-384 RS512 RSA512 RSASSA-PKCS1-v1_5 with SHA-512 ES256 ECDSA256 ECDSA with curve P-256 and SHA-256 ES384 ECDSA384 ECDSA with curve P-384 and SHA-384 ES512 ECDSA512 ECDSA with curve P-521 and SHA-512

使用代码如下

// header Map Map<String, Object> map = new HashMap<>(); map.put("alg", "HS256"); map.put("typ", "JWT");

playload

载荷就是存放有效信息的地方。基本上填2种类型数据

-标准中注册的声明的数据 -自定义数据 由这2部分内部做base64加密。最张数据进入JWT的chaims里存放。

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

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

使用方法

JWT.create().withHeader(map) // header .withClaim("iss", "Service") // payload .withClaim("aud", "APP") .withIssuedAt(iatDate) // sign time .withExpiresAt(expiresDate) // expire time

自定义数据

这个就比较简单,存放我们想放在token中存放的key-value值 使用方法

JWT.create().withHeader(map) // header .withClaim("name", "cy") // payload .withClaim("user_id", "11222");

签名signature

jwt的第三部分是一个签证信息,这个签证信息算法如下: base64UrlEncode(header) + "." + base64UrlEncode(payload)+your-256-bit-secret 这个部分需要base64加密后的header和base64加密后的payload使用.连接组成的字符串,然后通过header中声明的加密方式进行加盐secret组合加密,然后就构成了jwt的第三部分。

基本上至此,JWT的API相关知识已经学完了,但是API不够有好,不停的用withClaim放数据。不够友好。下面推荐一款框架JJWT,相当于对JWT的实现框架

JJWT

它是为了更友好在JVM上使用JWT,是基于JWT, JWS, JWE, JWK框架的java实现。 参考git地址

引入Maven依赖

<dependency> <groupId>io.jsonwebtoken</groupId> <artifactId>jjwt</artifactId> <version>0.7.0</version> </dependency>

Gradle:

dependencies { compile 'io.jsonwebtoken:jjwt:0.9.0' }

新建JwtConstants 类,用于token的chaims保存有效信息字段名

public class JwtConstants { public static final String JWT_KEY_USER_ID = "uid"; }

新建JwtInfo 类,用于token的chaims保存有效信息

public class JwtInfo { private String uid; public JwtInfo(String uid) { this.uid = uid; } public String getUid() { return uid; } public void setUid(String uid) { this.uid = uid; } }

新建JwtTokenUtils 工具类,用于token的生成和解析

package com.yibo.user.utils; import io.jsonwebtoken.Claims; import io.jsonwebtoken.Jws; import io.jsonwebtoken.Jwts; import io.jsonwebtoken.SignatureAlgorithm; import org.joda.time.DateTime; import javax.crypto.spec.SecretKeySpec; import javax.xml.bind.DatatypeConverter; import java.security.Key; /** * @author: huangyibo * @Date: 2019/1/13 22:37 * @Description: 生成token的工具类 */ public class JwtTokenUtils { private static Key getKeyInstance(){ SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256; byte[] bytes = DatatypeConverter.parseBase64Binary("mall-user"); return new SecretKeySpec(bytes,signatureAlgorithm.getJcaName()); } /** * 生成token的方法 * @param jwtInfo * @param expire * @return */ public static String generatorToken(JwtInfo jwtInfo,int expire){ return Jwts.builder().claim(JwtConstants.JWT_KEY_USER_ID,jwtInfo.getUid()) .setExpiration(DateTime.now().plusSeconds(expire).toDate()) .signWith(SignatureAlgorithm.HS256,getKeyInstance()).compact(); } /** * 根据token获取token中的信息 * @param token * @return */ public static JwtInfo getTokenInfo(String token){ Jws<Claims> claimsJws = Jwts.parser().setSigningKey(getKeyInstance()).parseClaimsJws(token); Claims claims = claimsJws.getBody(); return new JwtInfo(claims.get(JwtConstants.JWT_KEY_USER_ID).toString()); } }

新建JwtTokenService服务类,调用其方法即可进行认证和授权使用。

@Component public class JwtTokenService { /** * token过期时间 */ private int expire = 6000; public String generatorToken(JwtInfo jwtInfo){ return JwtTokenUtils.generatorToken(jwtInfo,expire); } public JwtInfo stringInfoFromToken(String token){ return JwtTokenUtils.getTokenInfo(token); } }

至此JWT的具体使用详细介绍完毕,在项目中建议使用JJWT,因为其API友好。

上面将token中的载荷放在chaims中,其实chaims是JWT内部维持的一个存放有效信息的地方,不论使用任何API,最终都使用chaims保存信息。 setClaims有2个重载

  • JwtBuilder setClaims(Claims claims);
  • JwtBuilder setClaims(Map<String, Object> claims); 不能就是说,我们也可以直接传入map值对象。

扩展阅读 : 签发的用户认证token超时刷新策略:https://blog.csdn.net/sinat_25235033/article/details/80324006

讲真,别再使用JWT了:https://www.jianshu.com/p/af8360b83a9f

 

参考: https://blog.csdn.net/achenyuan/article/details/80829401

https://www.cnblogs.com/zaixiuxing/p/6005968.html

上一篇:在spring boot3中使用native image
下一篇:没有了
网友评论