原文:https://www.jianshu.com/p/e88d3f8151dbjava
JSON
的開放標準((RFC 7519).
定義了一種簡潔的,自包含的方法用於通訊雙方之間以JSON
對象的形式安全的傳遞信息。由於數字簽名的存在,這些信息是可信的,
JWT可使用HMAC
算法或者是RSA
的公私祕鑰對進行簽名。
身份認證在這種場景下,一旦用戶完成了登錄,在接下來的每一個請求中包含JWT,能夠用來驗證用戶身份以及對路由,服務和資源的訪問權限進行驗證。因爲它的開銷很是小,能夠輕鬆的在不一樣域名的系統中傳遞,全部目前在單點登陸(SSO)中比較普遍的使用了該技術。 信息交換在通訊的雙方之間使用JWT對數據進行編碼是一種很是安全的方式,因爲它的信息是通過簽名的,能夠確保發送者發送的信息是沒有通過僞造的。web
1.簡潔(Compact): 能夠經過URL
,POST
參數或者在HTTP header
發送,由於數據量小,傳輸速度也很快
2.自包含(Self-contained):負載中包含了全部用戶所須要的信息,避免了屢次查詢數據庫
3.由於Token
是以JSON
加密的形式保存在客戶端的,因此JWT
是跨語言的,原則上任何web形式都支持。
4.不須要在服務端保存會話信息,特別適用於分佈式微服務。算法
JWT是由三段信息構成的,將這三段信息文本用.
鏈接一塊兒就構成了JWT字符串。
就像這樣:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
數據庫
JWT包含了三部分:
Header 頭部(標題包含了令牌的元數據,而且包含簽名和/或加密算法的類型)
Payload 負載 (相似於飛機上承載的物品)
Signature 簽名/簽證api
JWT的頭部承載兩部分信息:token類型和採用的加密算法。瀏覽器
{ "alg": "HS256", "typ": "JWT" }
聲明類型:這裏是jwt
聲明加密的算法:一般直接使用 HMAC SHA256安全
加密算法是單向函數散列算法,常見的有MD五、SHA、HAMC。
MD5(message-digest algorithm 5) (信息-摘要算法)縮寫,普遍用於加密和解密技術,經常使用於文件校驗。校驗?無論文件多大,通過MD5後都能生成惟一的MD5值
SHA (Secure Hash Algorithm,安全散列算法),數字簽名等密碼學應用中重要的工具,安全性高於MD5
HMAC (Hash Message Authentication Code),散列消息鑑別碼,基於密鑰的Hash算法的認證協議。用公開函數和密鑰產生一個固定長度的值做爲認證標識,用這個標識鑑別消息的完整性。經常使用於接口簽名驗證服務器
==================================================================================================================================網絡
載荷就是存放有效信息的地方。
有效信息包含三個部分
1.標準中註冊的聲明
2.公共的聲明
3.私有的聲明分佈式
iss
: jwt簽發者
sub
: 面向的用戶(jwt所面向的用戶)
aud
: 接收jwt的一方
exp
: 過時時間戳(jwt的過時時間,這個過時時間必需要大於簽發時間)
nbf
: 定義在什麼時間以前,該jwt都是不可用的.
iat
: jwt的簽發時間
jti
: jwt的惟一身份標識,主要用來做爲一次性token
,從而回避重放攻擊。
公共的聲明能夠添加任何的信息,通常添加用戶的相關信息或其餘業務須要的必要信息.但不建議添加敏感信息,由於該部分在客戶端可解密.
私有聲明是提供者和消費者所共同定義的聲明,通常不建議存放敏感信息,由於base64
是對稱解密的,意味着該部分信息能夠歸類爲明文信息。
jwt的第三部分是一個簽證信息,這個簽證信息由三部分組成:
header (base64後的)
payload (base64後的)
secret
這個部分須要base64
加密後的header
和base64
加密後的payload
使用.
鏈接組成的字符串,而後經過header
中聲明的加密方式進行加鹽secret
組合加密,而後就構成了jwt
的第三部分。
密鑰secret
是保存在服務端的,服務端會根據這個密鑰進行生成token
和進行驗證,因此須要保護好。
引入JWT
依賴,因爲是基於Java
,因此須要的是java-jwt
<dependency> <groupId>com.auth0</groupId> <artifactId>java-jwt</artifactId> <version>3.4.0</version> </dependency>
用來跳過驗證的PassToken
@Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface PassToken { boolean required() default true; }
須要登陸才能進行操做的註解UserLoginToken
@Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface UserLoginToken { boolean required() default true; }
@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
:說明子類能夠繼承父類中的該註解
User
,使用lombok
簡化實體類的編寫
須要寫token
的生成方法
public String getToken(User user) { String token=""; token= JWT.create().withAudience(user.getId()) .sign(Algorithm.HMAC256(user.getPassword())); return token; }
Algorithm.HMAC256()
:使用HS256
生成token
,密鑰則是用戶的密碼,惟一密鑰的話能夠保存在服務端。
withAudience()
存入須要保存在token
的信息,這裏我把用戶ID
存入token
中
token
並驗證token
public class AuthenticationInterceptor implements HandlerInterceptor { @Autowired UserService userService; @Override public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception { String token = httpServletRequest.getHeader("token");// 從 http 請求頭中取出 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(UserLoginToken.class)) { UserLoginToken userLoginToken = method.getAnnotation(UserLoginToken.class); if (userLoginToken.required()) { // 執行認證 if (token == null) { throw new RuntimeException("無token,請從新登陸"); } // 獲取 token 中的 user id String userId; try { userId = JWT.decode(token).getAudience().get(0); } catch (JWTDecodeException j) { throw new RuntimeException("401"); } User user = userService.findUserById(userId); if (user == null) { throw new RuntimeException("用戶不存在,請從新登陸"); } // 驗證 token JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(user.getPassword())).build(); try { jwtVerifier.verify(token); } catch (JWTVerificationException e) { throw new RuntimeException("401"); } return true; } } return true; } @Override public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception { } @Override public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception { } }
實現一個攔截器就須要實現HandlerInterceptor
接口
HandlerInterceptor
接口主要定義了三個方法
1.boolean preHandle ()
:
預處理回調方法,實現處理器的預處理,第三個參數爲響應的處理器,自定義Controller
,返回值爲true
表示繼續流程(如調用下一個攔截器或處理器)或者接着執行
postHandle()
和afterCompletion()
;false
表示流程中斷,不會繼續調用其餘的攔截器或處理器,中斷執行。
2.void postHandle()
:
後處理回調方法,實現處理器的後處理(DispatcherServlet
進行視圖返回渲染以前進行調用),此時咱們能夠經過modelAndView
(模型和視圖對象)對模型數據進行處理或對視圖進行處理,modelAndView
也可能爲null
。
3.void afterCompletion()
:
整個請求處理完畢回調方法,該方法也是須要當前對應的Interceptor
的preHandle()
的返回值爲true時纔會執行,也就是在DispatcherServlet
渲染了對應的視圖以後執行。用於進行資源清理。整個請求處理完畢回調方法。如性能監控中咱們能夠在此記錄結束時間並輸出消耗時間,還能夠進行一些資源清理,相似於try-catch-finally
中的finally
,但僅調用處理器執行鏈中
1.從 http
請求頭中取出 token
,
2.判斷是否映射到方法
3.檢查是否有passtoken
註釋,有則跳過認證
4.檢查有沒有須要用戶登陸的註解,有則須要取出並驗證
5.認證經過則能夠訪問,不經過會報相關錯誤信息
在配置類上添加了註解@Configuration
,標明瞭該類是一個配置類而且會將該類做爲一個SpringBean
添加到IOC
容器內
@Configuration public class InterceptorConfig extends WebMvcConfigurerAdapter { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(authenticationInterceptor()) .addPathPatterns("/**"); // 攔截全部請求,經過判斷是否有 @LoginRequired 註解 決定是否須要登陸 } @Bean public AuthenticationInterceptor authenticationInterceptor() { return new AuthenticationInterceptor(); } }
WebMvcConfigurerAdapter
該抽象類其實裏面沒有任何的方法實現,只是空實現了接口
WebMvcConfigurer
內的所有方法,並無給出任何的業務邏輯處理,這一點設計恰到好處的讓咱們沒必要去實現那些咱們不用的方法,都交由WebMvcConfigurerAdapter
抽象類空實現,若是咱們須要針對具體的某一個方法作出邏輯處理,僅僅須要在
WebMvcConfigurerAdapter
子類中@Override
對應方法就能夠了。
注:
在SpringBoot2.0
及Spring 5.0
中WebMvcConfigurerAdapter
已被廢棄
網上有說改成繼承WebMvcConfigurationSupport
,不過試了下,仍是過時的
直接實現WebMvcConfigurer
(官方推薦)
@Configuration public class InterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(authenticationInterceptor()) .addPathPatterns("/**"); // 攔截全部請求,經過判斷是否有 @LoginRequired 註解 決定是否須要登陸 } @Bean public AuthenticationInterceptor authenticationInterceptor(){ return new AuthenticationInterceptor(); } }
InterceptorRegistry
內的addInterceptor
須要一個實現HandlerInterceptor
接口的攔截器實例,addPathPatterns
方法用於設置攔截器的過濾路徑規則。
這裏我攔截全部請求,經過判斷是否有@LoginRequired
註解 決定是否須要登陸
不加註解的話默認不驗證,登陸接口通常是不驗證的。在getMessage()
中我加上了登陸註解,說明該接口必須登陸獲取token
後,在請求頭中加上token
並經過驗證才能夠訪問
在沒token
的狀況下訪問api/getMessage
接口
我這裏使用了統一異常處理,因此只看到錯誤message
下面進行登陸,從而獲取token
登陸操做我沒加驗證註解,因此能夠直接訪問
把token
加在請求頭中,再次訪問api/getMessage
接口
key
必定不能錯,由於在攔截器中是取關鍵字
token
的值
String token = httpServletRequest.getHeader("token");
token
以後就能夠順利經過驗證和進行接口訪問了