前言
說說JWT,先說下互聯網服務常見的兩種用戶認證方式:
session認證與Token認證
session認證
傳統的Session認證的大體流程可以表示為用戶提供用戶名和密碼登錄后由服務器存儲一份用戶登錄信息並傳遞給瀏覽器保存為Cookie,並在下次請求中根據Cookie來識別用戶,但這種方式缺陷明顯:
- Session都是保存在內存中,隨着認證用戶的增多,服務端的開銷明顯增大
- 保存在內存中的Session限制了分布式的應用
- Cookie容易被截獲偽造
Token認證
Token 泛指身份驗證時使用的令牌,Token鑒權機制從某些角度而言與Cookie是一個作用,其目的是讓后台知道請求是來自於受信的客戶端,其通過實現了某種算法加密的Token字符串來完成鑒權工作,其優點在於:
- 服務器不需要保存 Session 數據(無狀態),容易實現擴展
- 有效避免Cookie被截獲引發的CSRF攻擊
- 可以存儲一些業務邏輯所必要的非敏感信息
- 便於傳輸,其構成非常簡單,字節占用小
JWT簡介
JWT定義
- JWT全稱為Json web token,也就是 Json 格式的 web token,可以這么理解:
Token // 個人證件
JWT // 個人身份證
JWT數據結構
- JWT由三段字符串組成,中間用.分隔,如下:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOjEsInNjb3BlIjo4LCJleHAiOjE3MTU3NDAyMjIsImlhdCI6MTYyOTM0MDIyMn0.wuRsF5wvLHbDF_21Pocas8SeXQ315rgBl6wm1LRL2bQ
- JWT 的三個部分依次如下:
Header(頭部)// Header 部分是一個 JSON 對象,描述 JWT 的元數據,通常是下面的樣子。
Payload(負載)// Payload 部分是一個 JSON 對象,用來存放實際需要傳遞的數據
Signature(簽名)// Signature 部分是對前兩部分的簽名,防止數據篡改
- 第一段字符串Header:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9
將其 Base64 解碼后得到:
{
"typ": "JWT", // TOKEN TYPE ,token類型
"alg": "HS256" //ALGORITHM,算法 哈希256
}
- 第二段字符串Payload:
eyJ1aWQiOjEsInNjb3BlIjo4LCJleHAiOjE3MTU3NDAyMjIsImlhdCI6MTYyOTM0MDIyMn0
PAYLOAD是數據載體,可以有自定義數據
{
"uid": "1234567890" // 自定義數據
}
- 第三段字符串Signature:
wuRsF5wvLHbDF_21Pocas8SeXQ315rgBl6wm1LRL2bQ
Signature 部分是對前兩部分的簽名,防止數據篡改。
JWT的類庫
- Java 中的 JWT 有很多類庫,關於其優缺點可以在官網查看:https://jwt.io/,這里我們介紹Auth0的JWT的集成使用方式
Auth0 實現的 com.auth0 / java-jwt / 3.3.0
Brian Campbell 實現的 org.bitbucket.b_c / jose4j / 0.6.3
connect2id 實現的 com.nimbusds / nimbus-jose-jwt / 5.7
Les Hazlewood 實現的 io.jsonwebtoken / jjwt / 0.9.0
FusionAuth 實現的 io.fusionauth / fusionauth-jwt / 3.1.0
Vert.x 實現的 io.vertx / vertx-auth-jwt / 3.5.1
具體實現
JWT配置
- pom.xml
<!-- jwt -->
<dependency>
<groupId>com.auth0</groupId>
<artifactId>java-jwt</artifactId>
<version>3.8.1</version>
</dependency>
- application.yml
coisini:
security:
jwt-key: coisini
# 過期時間
token-expired-in: 86400000
JWT工具類
- JwtUtil.java
import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.exceptions.JWTVerificationException;
import com.auth0.jwt.interfaces.Claim;
import com.auth0.jwt.interfaces.DecodedJWT;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.util.*;
/**
* @Description JWT工具類
* @author coisini
* @date Aug 18, 2021
* @Version 1.0
*/
@Component
public class JwtUtil {
/**
* key
*/
private static String jwtKey;
/**
* 過期時間
*/
private static Integer expiredTimeIn;
/**
* JWT KEY
* @param jwtKey
*/
@Value("${coisini.security.jwt-key}")
public void setJwtKey(String jwtKey) {
JwtUtil.jwtKey = jwtKey;
}
/**
* 過期時間
* @param expiredTimeIn
*/
@Value("${coisini.security.token-expired-in}")
public void setExpiredTimeIn(Integer expiredTimeIn) {
JwtUtil.expiredTimeIn = expiredTimeIn;
}
/**
* 生成令牌
* @param uid 用戶id
* @return
*/
public static String makeToken(Long uid) {
return JwtUtil.getToken(uid);
}
/**
* 獲取令牌
* @param uid 用戶id
* @param scope 權限分級數字
* @return
*/
private static String getToken(Long uid) {
// 指定算法
Algorithm algorithm = Algorithm.HMAC256(JwtUtil.jwtKey);
Map<String, Date> dateMap = JwtUtil.calculateExpiredIssues();
/**
* withClaim() 寫入自定義數據
* withExpiresAt() 設置過期時間
* withIssuedAt() 設置當前時間
* sign() 簽名算法
*/
return JWT.create()
.withClaim("uid", uid)
.withExpiresAt(dateMap.get("expiredTime"))
.withIssuedAt(dateMap.get("now"))
.sign(algorithm);
}
/**
* 獲取自定義數據
* @param token
* @return
*/
public static Optional<Map<String, Claim>> getClaims(String token) {
DecodedJWT decodedJWT;
// 指定算法
Algorithm algorithm = Algorithm.HMAC256(JwtUtil.jwtKey);
JWTVerifier jwtVerifier = JWT.require(algorithm).build();
try {
decodedJWT = jwtVerifier.verify(token);
} catch (JWTVerificationException e) {
return Optional.empty();
}
return Optional.of(decodedJWT.getClaims());
}
/**
* 驗證Token
* @param token
* @return
*/
public static boolean verifyToken(String token) {
try {
Algorithm algorithm = Algorithm.HMAC256(JwtUtil.jwtKey);
JWTVerifier jwtVerifier = JWT.require(algorithm).build();
jwtVerifier.verify(token);
} catch (JWTVerificationException e) {
return false;
}
return true;
}
/**
* 計算過期時間
* @return
*/
private static Map<String, Date> calculateExpiredIssues() {
Map<String, Date> map = new HashMap<>();
Calendar calendar = Calendar.getInstance();
Date now = calendar.getTime();
calendar.add(Calendar.SECOND, JwtUtil.expiredTimeIn);
// 當前時間
map.put("now", now);
// 過期時間
map.put("expiredTime", calendar.getTime());
return map;
}
}
測試接口
- JwtController.java
@RestController
@RequestMapping("/jwt")
public class JwtController {
/**
* 獲取Token
* @param id
* @return
*/
@GetMapping(value = "/get")
public String getToken(@RequestParam Long id) {
return JwtUtil.makeToken(id);
}
/**
* 驗證Token
* @param token
* @return
*/
@PostMapping("/verify")
public Map<String, Boolean> verify(@RequestParam String token) {
Map<String, Boolean> map = new HashMap<>();
Boolean valid = JwtUtil.verifyToken(token);
map.put("is_valid", valid);
return map;
}
}
- 測試結果
- JWT生成的Token應該放在請求頭內來傳輸,后端統一攔截驗證,這里留在下篇文章吧。。。
