JWT

java 阅读量


JWT(JSON WEB TOKEN) 是一套开源的身份验证协议/解决方案。

在实际的开发中，我们经常需要认证用户的信息，并且需要保存相关的数据。常用的方式：

  1. 用户向服务器发送用户名和密码
  2. 服务器验证通过后，在 session 里保存相关的数据
  3. 服务器向客户端返回一个 session_id ，写入客户端 cookie
  4. 客户端在随后的每一次请求里，都会通过 cookie ，将 session_id 传回给服务器
  5. 服务器通过 session_id 判断用户身份。

这种模式的问题在于，扩展性（scaling）不好。单机当然没有问题，如果是服务器集群，或者是跨域的服务导向架构，就要求 session 数据共享，每台服务器都能够读取 session。

举例来说，A 网站和 B 网站是同一家公司的关联服务。现在要求，用户只要在其中一个网站登录，再访问另一个网站就会自动登录，请问怎么实现？

一种解决方案是 session 数据持久化，写入数据库或别的持久层。各种服务收到请求后，都向持久层请求数据。这种方案的优点是架构清晰，缺点是工程量比较大。另外，持久层万一挂了，就会单点失败。

另一种方案是服务器索性不保存 session 数据了，所有数据都保存在客户端，每次请求都发回服务器。JWT 就是这种方案的一个代表。

jwt 原理

JWT 的原理是，服务器认证以后，生成一个 JSON 对象，发回给用户，就像下面这样。

1
2
3
4
5
{
  "姓名": "张三",
  "角色": "管理员",
  "到期时间": "2018年7月1日0点0分"
}

以后，用户与服务端通信的时候，都要发回这个 JSON 对象。服务器完全只靠这个对象认定用户身份。为了防止用户篡改数据，服务器在生成这个对象的时候，会加上签名。

服务器就不保存任何 session 数据了，也就是说，服务器变成无状态了，从而比较容易实现扩展。

jwt 的数据结构

实际的 jwt 像下面这样

它是一个很长的字符串，中间用点（.）分隔成三个部分。注意，JWT 内部是没有换行的，这里只是为了便于展示，将它写成了几行。

JWT 的三个部分依次如下。

  • Header（头部）
  • Payload（负载）
  • Signature（签名）

写成一行，就是下面的样子。

1
Header.Payload.Signature

Header 部分是一个 JSON 对象，描述 JWT 的元数据，通常是下面的样子。

1
2
3
4
{
  "alg": "HS256",
  "typ": "JWT"
}

上面代码中，alg 属性表示签名的算法（algorithm），默认是 HMAC SHA256（写成 HS256）；typ 属性表示这个令牌（token）的类型（type），JWT 令牌统一写为JWT。

最后，将上面的 JSON 对象使用 Base64URL 算法转成字符串。

Payload

Payload 部分也是一个 JSON 对象，用来存放实际需要传递的数据。JWT 规定了7个官方字段，供选用。

1
2
3
4
5
6
7
iss (issuer)：签发人
exp (expiration time)：过期时间
sub (subject)：主题
aud (audience)：受众
nbf (Not Before)：生效时间
iat (Issued At)：签发时间
jti (JWT ID)：编号

除了官方字段，你还可以在这个部分定义私有字段，下面就是一个例子。

1
2
3
4
5
{
  "sub": "1234567890",
  "name": "John Doe",
  "admin": true
}

注意，JWT 默认是不加密的，任何人都可以读到，所以不要把秘密信息放在这个部分。

这个 JSON 对象也要使用 Base64URL 算法转成字符串。

Signature

Signature 部分是对前两部分的签名，防止数据篡改。

首先，需要指定一个密钥（secret）。这个密钥只有服务器才知道，不能泄露给用户。然后，使用 Header 里面指定的签名算法（默认是 HMAC SHA256），按照下面的公式产生签名。

1
2
3
4
HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),
  secret)

算出签名以后，把 Header、Payload、Signature 三个部分拼成一个字符串，每个部分之间用”点”（.）分隔，就可以返回给用户。

Base64URL

前面提到，Header 和 Payload 串型化的算法是 Base64URL。这个算法跟 Base64 算法基本类似，但有一些小的不同。

JWT 作为一个令牌（token），有些场合可能会放到 URL（比如 api.example.com/?token=xxx）。Base64 有三个字符+、/和=，在 URL 里面有特殊含义，所以要被替换掉：=被省略、+替换成-，/替换成_ 。这就是 Base64URL 算法。

jwt 的使用方式

客户端收到服务器返回的 JWT，可以储存在 Cookie 里面，也可以储存在 localStorage。

此后，客户端每次与服务器通信，都要带上这个 JWT。你可以把它放在 Cookie 里面自动发送，但是这样不能跨域，所以更好的做法是放在 HTTP 请求的头信息 Authorization 字段里面。

1
Authorization: Bearer <token>

另一种做法是，跨域的时候，JWT 就放在 POST 请求的数据体里面。

jwt 的特点

  1. JWT 默认是不加密，但也是可以加密的。生成原始 Token 以后，可以用密钥再加密一次。
  2. JWT 不加密的情况下，不能将秘密数据写入 JWT。
  3. JWT 不仅可以用于认证，也可以用于交换信息。有效使用 JWT，可以降低服务器查询数据库的次数。
  4. JWT 的最大缺点是，由于服务器不保存 session 状态，因此无法在使用过程中废止某个 token，或者更改 token 的权限。也就是说，一旦 JWT 签发了，在到期之前就会始终有效，除非服务器部署额外的逻辑。
  5. JWT 本身包含了认证信息，一旦泄露，任何人都可以获得该令牌的所有权限。为了减少盗用，JWT 的有效期应该设置得比较短。对于一些比较重要的权限，使用时应该再次对用户进行认证。
  6. 为了减少盗用，JWT 不应该使用 HTTP 协议明码传输，要使用 HTTPS 协议传输。

原文看这里
官网介绍看这里

jwt 用法

maven 依赖

1
2
3
4
5
6
<!-- https://mvnrepository.com/artifact/com.auth0/java-jwt -->
		<dependency>
			<groupId>com.auth0</groupId>
			<artifactId>java-jwt</artifactId>
			<version>3.7.0</version>
		</dependency>

demo：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
package jwt.jwt;

import java.util.Base64;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTCreator.Builder;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.DecodedJWT;
import com.auth0.jwt.interfaces.JWTVerifier;

public class JwtDemo {
	//JWT验证token的密钥
	private static final String JWT_SECRET = "your secret can't be exposed";
	
	public static void main(String[] args) {
		//签名算法，根据密钥，生成Algorithm实例，通常应用生命周期内都可以使用这个对象
		Algorithm algorithm = Algorithm.HMAC256(JWT_SECRET);
		
		//根据Algorithm生成token
		Builder tokenBuilder = JWT.create();
		
		//配置token的Header自定义部分
		Map<String, Object> headers = new HashMap<>();
		headers.put("myheader", "myheader");
		tokenBuilder.withHeader(headers);
		
		//配置token的PayLoad部分预定义字段
		tokenBuilder.withIssuer("iss")
			.withSubject("sub")
			.withAudience("viewer1", "viewer2")
			.withExpiresAt(new Date(System.currentTimeMillis() + 5000));
		
		//配置PayLoad部分自定义字段
		tokenBuilder.withClaim("name", "jack")
			.withArrayClaim("pets", new String[] {"cat", "dog", "bird"});
		
		//根据Alogrithm，签名后生成token
		String token = tokenBuilder.sign(algorithm);
		System.out.println("token : " + token);
		
		//解密token看下内容
		DecodedJWT decodedJWT = JWT.decode(token);
		System.out.println("header : " + decodeBase64Url(decodedJWT.getHeader()));
		System.out.println("payload : " + decodeBase64Url(decodedJWT.getPayload()));
		
		//构造JWTVerifier，用于验证token，这里说明，
		//签名及payload用来验证token，header的自定义字段则不用于验证
		JWTVerifier jwtVerifier = JWT.require(algorithm)
			.withIssuer("iss")
			.withAudience("viewer1", "viewer2")
			.acceptExpiresAt(System.currentTimeMillis() + 5000)
			.withSubject("sub")
			.withClaim("name", "jack") //可以尝试修改verifier，则下面的验证会抛异常
			.withArrayClaim("pets", new String[] {"cat", "dog", "bird"})
			.build();
		
		//使用Verifier执行验证
		DecodedJWT decodedJWT2 = jwtVerifier.verify(token);
		System.out.println("payload again: " + decodeBase64Url(decodedJWT2.getPayload()));
	}
	
	private static String decodeBase64Url(String base64Url) {
		return new String(Base64.getUrlDecoder().decode(base64Url));
	}
}

Powered by Hexo and Hexo-theme-hiker

Copyright © 2013 - 2020 KNOWLEDGE IS POWER All Rights Reserved.

访客数 : | 访问量 :