JWT 基本使用
JWT 基本使用
在上一节中 session 共享功能使用 redis 进行存储,用户量激增时会导致 redis 崩溃,而 JWT 不依赖服务器,能够避免这个问题。
1、传统 session
1.1.认证方式
http协议本身是一种无状态的协议,如果用户向服务器提供了用户名和密码来进行用户认证,下次请求时,用户还要再一次进行用户认证才行。因为根据http协议,服务器并不能知道是哪个用户发出的请求,所以为了让我们的应用能识别是哪个用户发出的请求,我们只能在服务器存储─份用户登录的信息,这份登录信息会在响应时传递给浏览器,告诉其保存为cookie,以便下次请求时发送给我们的应用,这样应用就能识别请求来自哪个用户。
1.2.暴露的问题
- 用户经过应用认证后,应用都要在服务端做一次记录,以方便用户下次请求的鉴别,通常而言session都是保存在内存中,而随着认证用户的增多,服务端的开销会明显增大;
- 用户认证后,服务端做认证记录,如果认证的记录被保存在内存中的话,用户下次请求还必须要请求在这台服务器上,这样才能拿到授权的资源。在分布式的应用上,限制了负载均衡器的能力。以此限制了应用的扩展能力;
- session是基于cookie来进行用户识别,cookie如果被截获,用户很容易受到CSRF(跨站伪造请求攻击)攻击;
- 在前后端分离系统中应用解耦后增加了部署的复杂性。通常用户一次请求就要转发多次。如果用session每次携带sessionid到服务
器,服务器还要查询用户信息。同时如果用户很多。这些信息存储在服务器内存中,给服务器增加负担。还有就是sessionid就是一个特征值,表达的信息不够丰富。不容易扩展。而且如果你后端应用是多节点部署。那么就需要实现session共享机制。不方便集群应用。
2、概念
Json web token (JWT) ,是一种基于 JSON的开放标准(RFC 7519),定义了一种简洁的、自包含的方法用于通信双方之间以 JSON 对象的形式安全的传递信息。 因为数字签名的存在,这些信息是可信的,JWT 可以使用 HMAC 算法或者 RSA 的公钥私钥进行签名。
3、作用
- 授权:一旦用户登录,每个后续请求将包括JWT,从而允许用户访问该令牌允许的路由,服务和资源。它的开销很小并且可以在不同的域中使用。如:单点登录。
- 信息交换:在各方之间安全地传输信息。JWT可进行签名(如使用公钥/私钥对),因此可确保发件人。由于签名是使用标头和有效负载计算的,因此还可验证内容是否被篡改。
4、认证流程
- 前端通过Web表单将自己的用户名和密码发送到后端的接口。该过程一般是HTTP的POST请求。建议的方式是通过SSL加密的传输(https协议),从而避免敏感信息被嗅探。
- 后端核对用户名和密码成功后,将用户的id等其他信息作为JWT Payload(负载),将其与头部分别进行Base64编码拼接后签名,形成一个JWT(Token)。
- 后端将JWT字符串作为登录成功的返回结果返回给前端。前端可以将返回的结果保存在localStorage(浏览器本地缓存)或sessionStorage(session缓存)上,退出登录时前端删除保存的JWT即可。
- 前端在每次请求时将JWT放入HTTP的Header中的Authorization位。(解决XSS和XSRF问题)HEADER
后端检查是否存在,如存在验证JWT的有效性。例如,检查签名是否正确﹔检查Token是否过期;检查Token的接收方是否是自己(可选) - 验证通过后后端使用JWT中包含的用户信息进行其他逻辑操作,返回相应结果。
5、优点及结构
5.1、优点
- 简洁(Compact):可以通过URL,POST参数或者在HTTP header发送,数据量小,传输速度也很快;
- 自包含(Self-contained):负载中包含了所有用户所需要的信息,避免了多次查询数据库;
- Token是以JSON加密的形式保存在客户端,所以JWT是跨语言的,原则上任何web形式都支持。
- 不需要在服务端保存会话信息,特别适用于分布式微服务。
5.2、结构
就是令牌token,是一个String字符串,由3部分组成,中间用点隔开,令牌组成:
- 标头(Header)
- 有效载荷(Payload)
- 签名(Signature)
token格式:head.payload.singurater 如:xxxxx.yyyy.zzzz
- Header:有令牌的类型和所使用的签名算法,如HMAC、SHA256、RSA;使用Base64编码组成;(Base64是一种编码,不是一种加密过程,可以被翻译成原来的样子)
{
"alg" : "HS256",
"type" : "JWT"
}
- Payload :有效负载,包含声明;声明是有关实体(通常是用户)和其他数据的声明,不放用户敏感的信息,如密码。同样使用Base64编码
{
"sub" : "123",
"name" : "John Do",
"admin" : true
}
- Signature :前面两部分都使用Base64进行编码,前端可以解开知道里面的信息。Signature需要使用编码后的header和payload
加上我们提供的一个密钥,使用header中指定的签名算法(HS256)进行签名。签名的作用是保证JWT没有被篡改过
HMACSHA256(base64UrlEncode(header) + "." + base64UrlEncode(payload), secret);
6、使用
6.1、引入依赖
<!--引入JWT-->
<dependency>
<groupId>com.auth0</groupId>
<artifactId>java-jwt</artifactId>
<version>3.10.0</version>
</dependency>
6.2、创建配置类
public class JWTUtils {
//自定义密钥
private static final String SECRET_KEY = "@Tes*RI#s&";
/**
* 生成token
*
* @param map
* @return token
*/
public static String createToken(Map<String, String> map) {
JWTCreator.Builder builder = JWT.create();
//保存用户信息
map.forEach((k,v)-> {
builder.withClaim(k,v);
});
Calendar instance = Calendar.getInstance();
instance.add(Calendar.MINUTE,200);
//设置过期时间
builder.withExpiresAt(instance.getTime());
//设置签名
return builder.sign(Algorithm.HMAC256(SECRET_KEY));
}
/**
* 验证token
* @param token
* @return 验证信息
*/
public static Map verify(String token){
Map<String, Object> map = new HashMap<>();
try {
JWT.require(Algorithm.HMAC256(SECRET_KEY)).build().verify(token);
map.put("status", true);
return map;
}catch (TokenExpiredException e){
e.printStackTrace();
map.put("msg","token过期");
}catch (SignatureVerificationException e) {
e.printStackTrace();
map.put("msg", "无效签名");
}catch (AlgorithmMismatchException e) {
e.printStackTrace();
map.put("msg","算法不一致");
}catch (Exception e) {
e.printStackTrace();
map.put("msg","token无效");
}
map.put("status", false);
return map;
}
}
常见异常信息如下:
SignatureVerificationException //签名不一致异常
TokenExpiredException //令牌过期异常
AlgorithmMismatchException //算法不匹配异常
InvalidClaimException //失效的payload异常(传给客户端后,token被改动,验证不一致)
6.3、过滤器获取token
public class AccessFilter implements Filter {
Logger logger = LoggerFactory.getLogger(AccessFilter.class);
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
//登录接口不用验证token
if (request.getRequestURI().contains("/login")){
filterChain.doFilter(request, servletResponse);
return;
}
//验证token
String token = request.getHeader("token");
Map<String, Object> map = JWTUtils.verify(token);
//验证成功
if ((Boolean)map.get("status")) {
DecodedJWT decodedJWT = JWTUtils.getToken(token);
logger.info("=========" + decodedJWT.getClaim("userName").asString());
//验证失败
} else {
String json = new ObjectMapper().writeValueAsString(map);
response.setContentType("application/json; charset=UTF-8");
response.getWriter().println(json);
return;
}
filterChain.doFilter(request, servletResponse);
}
@Override
public void destroy() {
}
}
6.4、模拟登录接口
@GetMapping(value = "/login")
@ResponseBody
public Result login(HttpSession session) {
Map<String, String> map = new HashMap<>();
map.put("userId", "1");
map.put("userName", "123456");
//生成token
String token = JWTUtils.createToken(map);
return ResultUtil.success(token);
}
返回 token 给客户端,客户端每次请求携带token,过滤器对 token 有效性进行校验,验证成功返回数据,验证失败返回登录页面。
参考资料:JWT详细教程及使用
自我控制是最强者的本能-萧伯纳