JWT的认证原理和与SpringBoot整合
JWT
- JWT
-
- 代码
- 1 什么是JWT
-
- 1.翻译
- 2.通俗解释
- 2 JWT能做什么
-
- 1.授权
- 2.信息交换
- 3 为什么是JWT
-
- 3.1 基于传统的Session认证
-
- 1.认证方式
- 2.认证流程
- 3.暴露问题
- 3.2 基于JWT认证
-
- 1.认证流程
- 2.jwt优势
- 4 JWT的结构是什么
-
- 1.令牌组成
- 2.Header
- 3.Payload
- 4.Signature
-
- 签名目的
- 信息安全问题
- 5.放在一起
- 5 使用JWT
-
- 1.引入依赖
- 2.生成token
- 3.根据令牌和签名解析数据
- 4.常见异常信息
- 6 封装工具类
- 7 整合springboot
-
- 1.搭建环境
- 2.开发数据库
- 3.开发entity
- 4. 开发DAO接口和mapper.xml
- 5.开发Service 接口以及实现类
- 6.开发controller
- 7.用拦截器进行优化
-
- **构造拦截器**
- 配置拦截器
JWT
代码
项目源代码地址
包含这篇文章的md文件
1 什么是JWT
JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. This information can be verified and trusted because it is digitally signed. JWTs can be signed using a secret (with the HMAC algorithm) or a public/private key pair using RSA or ECDSA.—[摘自官网]
1.翻译
JSON Web令牌(JWT)是一种开放标准(RFC 7519)，它定义了一种紧凑且自包含的方式，以JSON对象的形式在各方之间安全地传输信息。由于该信息是数字签名的，因此可以对其进行验证和信任。jwt可以使用秘密(使用HMAC算法)签名，也可以使用RSA或ECDSA公钥/私钥对签名
2.通俗解释
JWT简称JSON Web Token,也就是通过JSON形式作为Web应
用中的令牌,用于在各方之间安全地将信息作为JSON对象传输。
在数据传输过程中还可以完成数据加密、签名等相关处理。
2 JWT能做什么
1.授权
这是使用JWT的最常见方案。一旦用户登录，每个后续请求将
包括JWT，从而允允许的路由，服务和资源。单点登录是当今
广泛使用JWT的一项功能，因为它的开销很小并且可以在不同
的域中轻松使用。
2.信息交换
JSON Web Token是在各方之间安全地传输信息的好方法。因为
可以对JWT进行签名（例如，使用公钥/私钥对），所以您可
以确保发件人是他们所说的人。此外，由于签名是使用标头和有
效负载计算的，因此您还可以验证内容是否遭到篡改。
注意：jwt跟session不一样，jwt存储在客户端，session
存储在服务器端，服务器断电后session就没了，而jwt因
为存储在客户端，所以就不会被影响，只要jwt不过期，
就可以继续使用。
3 为什么是JWT
3.1 基于传统的Session认证
1.认证方式
我们知道，http协议本身是一种无状态的协议，而这
就意味着如果用户向我们的应用提供了用户名和密码来进行用
户认证，那么下一次请求时，用户还要再一次进行用户认证
才行，因为根据http协议，我们并不能知道是哪个用户发出
的请求，所以为了让我们的应用能识别是哪个用户发出的请求，我
们只能在服务器存储一份用户登录的信息，这份登录信息会在响
应时传递给浏览器，告诉其保存为cookie,以便下次请求时发送
给我们的应用，这样我们的应用就能识别请求来自哪个用
户了,这就是传统的基于session认证。
t
2.认证流程
3.暴露问题
-
每个用户经过我们的应用认证之后，我们的应用都要在服务端做
一次记录，以方便用户下次请求的鉴别，通常而言session都是保存在内存中，而随着认证用户的增多，服务端的开销会明显增大 -
用户认证之后，服务端做认证记录，如果认证的记录被保存在
内存中的话，这意味着用户下次请求还必须要 请求在这台服务
器上,这样才能拿到授权的资源，这样在分布式的应用上，相应
的限制了负载均衡器的能力。这也意味着限制了应用的扩展能力。 -
因为是基于cookie来进行用户识别的, cookie如果被截获，用户
就会很容易受到跨站请求伪造的攻击。 -
在前后端分离系统中就更加痛苦:如下图所示
也就是说前后端分离在应用解耦后增加了部署的复杂性。通常用户
一次请求就要转发多次。如果用session 每次携带sessionid 到服务
器，服务器还要查询用户信息。同时如果用户很多。这些信息存储
在服务器内存中，给服务器增加负担。还有就是CSRF（跨站伪造请求攻击）攻击，session是基于cookie进行用户识别的, cookie如
果被截获，用户就会很容易受到跨站请求伪造的攻击。还有就是
sessionid就是一个特征值，表达的信息不够丰富。不容易扩展。
而且如果你后端应用是多节点部署。那么就需要实现session共享机制。不方便集群应用。
3.2 基于JWT认证
1.认证流程
-
首先，前端通过Web表单将自己的用户名和密码发送到后端的接口。
这一过程一般是一个HTTP POST请求。建议的方式是通过SSL加
密的传输（https协议），从而避免敏感信息被嗅探。 -
后端核对用户名和密码成功后，将用户的id等其他信息作为
JWT Payload（负载），将其与头部分别进行Base64编码拼接后
签名，形成一个JWT(Token)。形成的JWT就是一个形同lll.zzz.xxx
的字符串。 token head.payload.singurater -
后端将JWT字符串作为登录成功的返回结果返回给前端。前端可
以将返回的结果保存在localStorage或sessionStorage上，退出登录
时前端删除保存的JWT即可。 -
前端在每次请求时将JWT放入HTTP Header中的Authorization位。
(解决XSS和XSRF问题) HEADER -
后端检查是否存在，如存在验证JWT的有效性。例如，检查签名
是否正确；检查Token是否过期；检查Token的接收方是否是自己（可选）。 -
验证通过后后端使用JWT中包含的用户信息进行其他逻辑操作，
返回相应结果。
2.jwt优势
-
简洁(Compact): 可以通过URL，POST参数或者在HTTP header发送，
因为数据量小，传输速度也很快 -
自包含(Self-contained)：负载中包含了所有用户所需要的信息，
避免了多次查询数据库因为Token是以JSON加密的形式保存在客户端的，所以JWT是跨语
言的，原则上任何web形式都支持。不需要在服务端保存会话信息，特别适用于分布式微服务。
4 JWT的结构是什么
token string ====> header.payload.singnature token
1.令牌组成
- 1.标头(Header)
- 2.有效载荷(Payload)
- 3.签名(Signature)
- 因此，JWT通常如下所示:xxxxx.yyyyy.zzzzz Header.Payload.Signature
2.Header
-
标头通常由两部分组成：令牌的类型（即JWT）和所使用的签名算法，例如HMAC SHA256或RSA。它会使用 Base64 编码组成 JWT 结构的第一部分。
-
注意:Base64是一种编码，也就是说，它是可以被翻译回原来的样子来的。它并不是一种加密过程。
{
"alg": "HS256",
"typ": "JWT"
}
3.Payload
- 令牌的第二部分是有效负载，其中包含声明。声明是有关实体
- （通常是用户）和其他数据的声明。同样的，它会使用
Base64 编码组成 JWT 结构的第二部分
{
"sub": "1234567890",
"name": "John Doe",
"admin": true
}
4.Signature
- 前面两部分都是使用 Base64 进行编码的，即前端可以解开知道里面的信息。Signature 需要使用编码后的 header 和 payload
以及我们提供的一个密钥，然后使用 header 中指定的签名算法
（HS256）进行签名。签名的作用是保证 JWT 没有被篡改过 - 如:
HMACSHA256(base64UrlEncode(header) + “.” + base64UrlEncode(payload),secret);
签名目的
- 最后一步签名的过程，实际上是对头部以及负载内容进行签名，
防止内容被窜改。如果有人对头部以及负载的内容解码之后进行修
改，再进行编码，最后加上之前的签名组合形成新的JWT的话，
那么服务器端会判断出新的头部和负载形成的签名和JWT附带上
的签名是不一样的。如果要对新的头部和负载进行签名，在不知
道服务器加密时用的密钥的话，得出来的签名也是不一样的。
信息安全问题
-
在这里大家一定会问一个问题：Base64是一种编码，
是可逆的，那么我的信息不就被暴露了吗？ -
是的。所以，在JWT中，不应该在负载里面加入任何敏感的
数据。在上面的例子中，我们传输的是用户的User ID。这个值
实际上不是什么敏 感内容，一般情况下被知道也是安全的。但
是像密码这样的内容就不能被放在JWT中了。如果将用户的密
码放在了JWT中，那么怀有恶意的第 三方通过Base64解码就能
很快地知道你的密码了。因此JWT适合用于向Web应用传递一些
非敏感信息。JWT还经常用于设计用户认证和授权系 统，甚至
实现Web应用的单点登录。
5.放在一起
- 输出是三个由点分隔的Base64-URL字符串，可以在HTML和
HTTP环境中轻松传递这些字符串，与基于XML的标准（例如SAML）
相比，它更紧凑。 - 简洁(Compact)
可以通过URL, POST 参数或者在 HTTP header 发送，因为
数据量小，传输速度快 - 自包含(Self-contained)
负载中包含了所有用户所需要的信息，避免了多次查询数据库
5 使用JWT
1.引入依赖
<dependency>
<groupId>com.auth0groupId>
<artifactId>java-jwtartifactId>
<version>3.4.0version>
dependency>
2.生成token
HashMap<String, Object> map = new HashMap<>();
Calendar instance = Calendar.getInstance();
instance.add(Calendar.SECOND,300);
String token = JWT.create()
//.withHeader(map)//header
.withClaim("userId", 21)//payload
.withClaim("username", "xiaokaixin")
.withExpiresAt(instance.getTime())//知道令牌过期时间
.sign(Algorithm.HMAC256("as%has"));// 签名
System.out.println(token);
生成结果
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MzM3NTczMzEsInVzZXJJZCI6MjEsInVzZXJuYW1lIjoieGlhb2thaXhpbiJ9.PVj08ZtccE1vxNJLhbwcuE1YBFBbEGUIlvqR0eBTcvU
3.根据令牌和签名解析数据
//创建验证对象
JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256("as%has")).build();
DecodedJWT verify = jwtVerifier.verify("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MzM3NTczMzEsInVzZXJJZCI6MjEsInVzZXJuYW1lIjoieGlhb2thaXhpbiJ9.PVj08ZtccE1vxNJLhbwcuE1YBFBbEGUIlvqR0eBTcvU");
//获取荷载中的信息
System.out.println(verify.getClaim("userId").asInt());
System.out.println(verify.getClaim("username").asString());
//获取过期时间
System.out.println(verify.getExpiresAt());
4.常见异常信息
- SignatureVerificationException: 签名不一致异常
- TokenExpiredException: 令牌过期异常
- AlgorithmMismatchException: 算法不匹配异常
- InvalidClaimException: 失效的payload异常
6 封装工具类
package com.tang.utils;
import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTCreator;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.DecodedJWT;
import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;
/**
* @program: springbootjwt
* @description:
* @author: xiaokaixin
* @create: 2021-10-09 21:26
**/
public class JWTUtils {
private static final String SIGN = "as%has";
/**
* 生成token header.payload.sign
*/
public static String getToken(Map<String,String> map){
Calendar instance = Calendar.getInstance();
instance.add(Calendar.DATE,7);//默认7天过期
//创建jwt builder
JWTCreator.Builder builder = JWT.create();
//payload
map.forEach((k,v)->{
builder.withClaim(k,v);
});
//sign
String token = builder.withExpiresAt(instance.getTime())//指定令牌过期时间
.sign(Algorithm.HMAC256(SIGN));
return token;
}
/**
* 验证token合法性
*/
public static void verify(String token){
JWT.require(Algorithm.HMAC256(SIGN)).build().verify(token);
}
/**
* 获取token信息方法
*/
public static DecodedJWT getTokenInfo(String token){
DecodedJWT verify = JWT.require(Algorithm.HMAC256(SIGN)).build().verify(token);
return verify;
}
}
7 整合springboot
1.搭建环境
-
搭建springboot+mybatis+jwt环境
-
引入依赖
-
编写配置
<dependency>
<groupId>com.auth0groupId>
<artifactId>java-jwtartifactId>
<version>3.4.0version>
dependency>
<dependency>
<groupId>org.mybatis.spring.bootgroupId>
<artifactId>mybatis-spring-boot-starterartifactId>
<version>2.1.3version>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<version>1.18.12version>
dependency>
<dependency>
<groupId>com.alibabagroupId>
<artifactId>druidartifactId>
<version>1.1.19version>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>5.1.38version>
dependency>
server.port=8989
spring.application.name=jwt
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/jwt?characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=root
mybatis.type-aliases-package=com.baizhi.entity
mybatis.mapper-locations=classpath:com/baizhi/mapper/*.xml
logging.level.com.baizhi.dao=debug
2.开发数据库
- 这里采用最简单的表结构验证JWT使用
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键',
`name` varchar(80) DEFAULT NULL COMMENT '用户名',
`password` varchar(40) DEFAULT NULL COMMENT '用户密码',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;
3.开发entity
@Data
@Accessors(chain=true)
public class User {
private String id;
private String name;
private String password;
}
4. 开发DAO接口和mapper.xml
@Mapper
public interface UserDAO {
User login(User user);
}
<mapper namespace="com.tang.dao.UserDAO">
<!--这里就写的简单点了毕竟不是重点-->
<select id="login" resultType="com.tang.entity.User">
select * from user where name=#{name} and password = #{password}
</select>
</mapper>
5.开发Service 接口以及实现类
public interface UserService {
User login(User user);//登录接口
}
@Service
@Transactional
public class UserServiceImpl implements UserService {
@Autowired
private UserDAO userDAO;
@Override
@Transactional(propagation = Propagation.SUPPORTS)
public User login(User user) {
User userDB = userDAO.login(user);
if(userDB!=null){
return userDB;
}
throw new RuntimeException("登录失败~~");
}
}
6.开发controller
@RestController
@Slf4j
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/user/login")
public Map<String ,Object> login(User user){
log.info("用户名：{}",user.getName());
log.info("密码：{}",user.getPassword());
Map<String ,Object> map = new HashMap<>();
try {
User userDB = userService.login(user);
Map<String,String> payload = new HashMap<>();
payload.put("id",userDB.getId());
payload.put("name",userDB.getName());
//生成JWT令牌
String token = JWTUtils.getToken(payload);
map.put("state",true);
map.put("msg","认证成功");
map.put("token",token);
}catch (Exception e){
map.put("state",false);
map.put("msg",e.getMessage());
}
return map;
}
7.用拦截器进行优化
构造拦截器
package com.tang.interceptor;
import com.auth0.jwt.exceptions.AlgorithmMismatchException;
import com.auth0.jwt.exceptions.SignatureVerificationException;
import com.auth0.jwt.exceptions.TokenExpiredException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.tang.utils.JWTUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;
/**
* @program: springbootjwt
* @description:
* @author: xiaokaixin
* @create: 2021-10-11 12:45
**/
public class jWTInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
Map<String ,Object> map = new HashMap<>();
//获取请求头令牌
String token = request.getHeader("token");
try {
JWTUtils.verify(token);//验证令牌
return true; //放行请求
} catch (TokenExpiredException e) {
map.put("state", false);
map.put("msg", "Token已经过期!!!");
} catch (SignatureVerificationException e){
map.put("state", false);
map.put("msg", "签名错误!!!");
} catch (AlgorithmMismatchException e){
map.put("state", false);
map.put("msg", "加密算法不匹配!!!");
} catch (Exception e) {
e.printStackTrace();
map.put("state", false);
map.put("msg", "无效token~~");
}
map.put("state",false);
//将map转为JSON jackjson
String json = new ObjectMapper().writeValueAsString(map);
response.setContentType("application/json;charset=UTF-8");
response.getWriter().println(json);
return false;
}
}
配置拦截器
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new jWTInterceptor())
.addPathPatterns("/user/test") //其他接口token验证
.excludePathPatterns("/user/login"); //所有用户都放行
}
}