jave web token實現登錄驗證
JWT
JWT官網: https://jwt.io/
JWT(Java版)的github地址:https://github.com/jwtk/jjwt
什麼是JWT
Json web token (JWT), 是爲了在網絡應用環境間傳遞聲明而執行的一種基於JSON
的開放標準((RFC 7519).**定義了一種簡潔的,自包含的方法用於通信雙方之間以JSON
對象的形式安全的傳遞信息。**因爲數字簽名的存在,這些信息是可信的,JWT可以使用HMAC
算法或者是RSA
的公私祕鑰對進行簽名。
JWT請求流程
image.png
1. 用戶使用賬號和麪發出post請求;
2. 服務器使用私鑰創建一個jwt;
3. 服務器返回這個jwt給瀏覽器;
4. 瀏覽器將該jwt串在請求頭中像服務器發送請求;
5. 服務器驗證該jwt;
6. 返回響應的資源給瀏覽器。
JWT的主要應用場景
身份認證在這種場景下,一旦用戶完成了登陸,在接下來的每個請求中包含JWT,**可以用來驗證用戶身份以及對路由,服務和資源的訪問權限進行驗證。由於它的開銷非常小,可以輕鬆的在不同域名的系統中傳遞,所有目前在單點登錄(SSO)**中比較廣泛的使用了該技術。 信息交換在通信的雙方之間使用JWT對數據進行編碼是一種非常安全的方式,由於它的信息是經過簽名的,可以確保發送者發送的信息是沒有經過僞造的。
優點
1.簡潔(Compact): 可以通過URL
,POST
參數或者在HTTP header
發送,因爲數據量小,傳輸速度也很快
2.自包含(Self-contained):負載中包含了所有用戶所需要的信息,避免了多次查詢數據庫
3.因爲Token
是以JSON
加密的形式保存在客戶端的,所以JWT
是跨語言的,原則上任何web形式都支持。
4.不需要在服務端保存會話信息,特別適用於分佈式微服務。
`
JWT的結構
JWT是由三段信息構成的,將這三段信息文本用.
連接一起就構成了JWT字符串。
就像這樣:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
JWT包含了三部分:
Header 頭部(標題包含了令牌的元數據,並且包含簽名和/或加密算法的類型)
Payload 負載 (類似於飛機上承載的物品)
Signature 簽名/簽證
Header
JWT的頭部承載兩部分信息:token類型和採用的加密算法。
{
"alg": "HS256",
"type": "JWT"
}
聲明類型:這裏是jwt
聲明加密的算法:通常直接使用 HMAC SHA256
加密算法是單向函數散列算法,常見的有MD5、SHA、HAMC。
MD5(message-digest algorithm 5) (信息-摘要算法)縮寫,廣泛用於加密和解密技術,常用於文件校驗。校驗?不管文件多大,經過MD5後都能生成唯一的MD5值
SHA (Secure Hash Algorithm,安全散列算法),數字簽名等密碼學應用中重要的工具,安全性高於MD5
HMAC (Hash Message Authentication Code),散列消息鑑別碼,基於密鑰的Hash算法的認證協議。用公開函數和密鑰產生一個固定長度的值作爲認證標識,用這個標識鑑別消息的完整性。常用於接口簽名驗證
Payload
載荷就是存放有效信息的地方。
有效信息包含三個部分
1.標準中註冊的聲明
2.公共的聲明
3.私有的聲明
標準中註冊的聲明 (建議但不強制使用) :
iss
: jwt簽發者
sub
: 面向的用戶(jwt所面向的用戶)
aud
: 接收jwt的一方
exp
: 過期時間戳(jwt的過期時間,這個過期時間必須要大於簽發時間)
nbf
: 定義在什麼時間之前,該jwt都是不可用的.
iat
: jwt的簽發時間
jti
: jwt的唯一身份標識,主要用來作爲一次性token
,從而回避重放攻擊。
公共的聲明 :
公共的聲明可以添加任何的信息,一般添加用戶的相關信息或其他業務需要的必要信息.但不建議添加敏感信息,因爲該部分在客戶端可解密.
私有的聲明 :
私有聲明是提供者和消費者所共同定義的聲明,一般不建議存放敏感信息,因爲base64
是對稱解密的,意味着該部分信息可以歸類爲明文信息。
Signature
jwt的第三部分是一個簽證信息
這個部分需要base64
加密後的header
和base64
加密後的payload
使用.
連接組成的字符串,然後通過header
中聲明的加密方式進行加鹽secret
組合加密,然後就構成了jwt
的第三部分。
密鑰secret
是保存在服務端的,服務端會根據這個密鑰進行生成token
和進行驗證,所以需要保護好。
作者:意識流丶
鏈接:https://www.jianshu.com/p/e88d3f8151db
來源:簡書
著作權歸作者所有。商業轉載請聯繫作者獲得授權,非商業轉載請註明出處。
Springboot集成JWT
pom文件
添加JWT依賴
<dependency>
<groupId>com.auth0</groupId>
<artifactId>java-jwt</artifactId>
<version>3.4.0</version>
</dependency>
自定義註解
/**當使用@PassToken註解在接口/方法時調用,或者用於當做一個註解標識,可以通過調用接口時檢查是否有該標識
@Target:註解的作用目標
@Target(ElementType.TYPE)——接口、類、枚舉、註解
@Target(ElementType.FIELD)——字段、枚舉的常量
@Target(ElementType.METHOD)——方法
@Target(ElementType.PARAMETER)——方法參數
@Target(ElementType.CONSTRUCTOR) ——構造函數
@Target(ElementType.LOCAL_VARIABLE)——局部變量
@Target(ElementType.ANNOTATION_TYPE)——註解
@Target(ElementType.PACKAGE)——包
@Retention:註解的保留位置
RetentionPolicy.SOURCE:這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略,在class字節碼文件中不包含。
RetentionPolicy.CLASS:這種類型的Annotations編譯時被保留,默認的保留策略,在class文件中存在,但JVM將會忽略,運行時無法獲得。
RetentionPolicy.RUNTIME:這種類型的Annotations將被JVM保留,所以他們能在運行時被JVM或其他使用反射機制的代碼所讀取和使用。
@Document:說明該註解將被包含在javadoc中
@Inherited:說明子類可以繼承父類中的該註解
**/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PassToken {
boolean required() default true;
}
Token工具類
定義一個token工具類,用於生成token或者驗證token等方法
@Component
public class TokenHelp {
@Autowired
private UserService userService;
public boolean tokenValidate(String token,boolean isAdmin){
// 執行認證
if (token == null) {
throw new RRException("無token,請重新登錄");
}
// 獲取 token 中的 user id
String userId;
try {
userId = JWT.decode(token).getAudience().get(0);
} catch (JWTDecodeException j) {
throw new RRException("401");
}
UserEntity user = userService.getById(userId);
//驗證是否是管理員賬號
if(isAdmin){
if(!user.getUserName().equals(Constant.SUPER_ADMIN_NAME)){
throw new RRException("該操作需要有管理員權限");
}
}
if (user == null) {
throw new RRException("用戶不存在,請重新登錄");
}
// 驗證 token
JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(user.getPassword())).build();
try {
jwtVerifier.verify(token);
} catch (JWTVerificationException e) {
throw new RRException("401");
}
return true;
}
public String getToken(UserEntity user) {
String token="";
//Algorithm.HMAC256():使用HS256生成token,密鑰則是用戶的密碼,唯一密鑰的話可以保存在服務端。
//withAudience()存入需要保存在token的信息,這裏把用戶ID存入token中
token= JWT.create().withAudience(user.getId().toString())
.sign(Algorithm.HMAC256(user.getPassword()));
return token;
}
}
攔截器
定義一個攔截器,攔截所有請求,如果有接口聲明需要登錄才訪問,則攔截該請求進行token驗證
該類實現WebMvcConfigurer接口,重寫攔截方法
WebMvcConfigurer詳解鏈接:https://blog.csdn.net/zhangpower1993/article/details/89016503
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 攔截所有請求,通過判斷是否有 登錄驗證相關注解 決定是否需要登錄
registry.addInterceptor(authenticationInterceptor())
.addPathPatterns("/**");
}
@Bean
public AuthenticationInterceptor authenticationInterceptor() {
//這個是自定義的攔截類,實現攔截後的操作
return new AuthenticationInterceptor();
}
}
自定義的攔截類
實現HandlerInterceptor接口,該接口用於攔截後的操作
public class AuthenticationInterceptor implements HandlerInterceptor {
@Autowired
UserService userService;
@Autowired
private TokenHelp tokenHelp;
//預處理回調方法,實現處理器的預處理
@Override
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {
// 從 http 請求頭中取出 token
String token = httpServletRequest.getHeader("token");
// 如果不是映射到方法直接通過
if (!(object instanceof HandlerMethod)) {
return true;
}
HandlerMethod handlerMethod = (HandlerMethod) object;
Method method = handlerMethod.getMethod();
//檢查是否有passtoken註釋,有則跳過認證
if (method.isAnnotationPresent(PassToken.class)) {
PassToken passToken = method.getAnnotation(PassToken.class);
if (passToken.required()) {
return true;
}
}
//檢查有沒有需要管理員權限的註解
if (method.isAnnotationPresent(UserAdminToken.class)) {
UserAdminToken userAdminToken = method.getAnnotation(UserAdminToken.class);
//對有這個請求驗證的方法進行驗證token
if (userAdminToken.required()) {
// 驗證 token
return tokenHelp.tokenValidate(token,true);
}
}
//檢查有沒有需要用戶權限的註解
if (method.isAnnotationPresent(UserLoginToken.class)) {
UserLoginToken userLoginToken = method.getAnnotation(UserLoginToken.class);
//對有這個請求驗證的方法進行驗證token
if (userLoginToken.required()) {
// 驗證 token
return tokenHelp.tokenValidate(token,false);
}
}
return true;
}
//後處理回調方法,實現處理器的後處理(DispatcherServlet進行視圖返回渲染之前進行調用)
@Override
public void postHandle(HttpServletRequest httpServletRequest,
HttpServletResponse httpServletResponse,
Object o, ModelAndView modelAndView) throws Exception {
}
//整個請求處理完畢回調方法,該方法也是需要當前對應的Interceptor的preHandle()的返回值爲true時纔會執行,一般用於資源清理
@Override
public void afterCompletion(HttpServletRequest httpServletRequest,
HttpServletResponse httpServletResponse,
Object o, Exception e) throws Exception {
}
登錄接口
當用於登錄驗證成功時,返回token
//驗證賬號和密碼是否正確
if(userEntity.getUserName().equals(user.getUserName()) &&
userEntity.getPassword().equals(user.getPassword())){
String token = tokenHelp.getToken(userEntity);
Result result = new Result<>();
Map<String,Object> map = new HashMap<String,Object>();
map.put("token",token);
map.put("user",userEntity);
return result.ok(map);
}
前端配置
前端登錄請求成功時,拿到服務器返回的token,存入全局變量,以layui爲例
//請求登入接口
admin.req({
url: //實際使用請改成服務端真實接口
,data: JSON.stringify(data)//用戶名和密碼
,type: 'post'
,dataType:"json"
,headers: { 'Content-Type': 'application/json;charset=utf8' }
,done: function(res){
//請求成功後,寫入 access_token
layui.sessionData(setter.tableName, {
key: "token"
,value: res.data.token
});
//登入成功的提示與跳轉
layer.msg('登錄成功', {
offset: '15px'
,icon: 1
,time: 1000
}, function(){
location.href = 'index.html'; //後臺主頁
});
}
}
);
在前端中的每次ajax請求的全局配置
//給每次ajax請求默認加上token
//全局配置
$.ajaxSetup({
beforeSend: function(jqXHR, settings) {
jqXHR.setRequestHeader("token",layui.sessionData(layui.setter.tableName)['token']);
}
,complete: function (req, status) {
if(req.status != 200){
layer.msg(req.status+":"+req.responseJSON.message);
}
}
});
以後請求需要登錄的接口都需要加上token,否則報錯
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-4y1VUpAQ-1594134501559)(D:\hstc\自學記錄\movie\img\image-20200529222615740.png)]