golang之JWT實現

什麼是JSON Web Token？

JSON Web Token（JWT）是一個開放標準（RFC 7519），它定義了一種緊湊且自包含的方式，用於在各方之間以JSON方式安全地傳輸信息。由於此信息是經過數字簽名的，因此可以被驗證和信任。可以使用祕密（使用HMAC算法）或使用RSA或ECDSA的公鑰/私鑰對對JWT進行簽名。

直白的講jwt就是一種用戶認證（區別於session、cookie）的解決方案。

出現的背景

衆所周知，在jwt出現之前，我們已經有session、cookie來解決用戶登錄等認證問題，爲什麼還要jwt呢？

這裏我們先了解一下session，cookie。

session

熟悉session運行機制的同學都知道，用戶的session數據以file或緩存（redis、memcached）等方式存儲在服務器端，客戶端瀏覽器cookie中只保存sessionid。服務器端session屬於集中存儲，數量不大的情況下，沒什麼問題，當用戶數據逐漸增多到一程度，就會給服務端管理和維護帶來大的負擔。

session有兩個弊端：

1、無法實現跨域。

2、由於session數據屬於集中管理裏，量大的時候服務器性能是個問題。

優點：

1、session存在服務端，數據相對比較安全。

2、session集中管理也有好處，就是用戶登錄、註銷服務端可控。

cookie

cookie也是一種解決網站用戶認證的實現方式，用戶登錄時，服務器會發送包含登錄憑據的Cookie到用戶瀏覽器客戶端，瀏覽器會將Cookie的key/value保存用戶本地（內存或硬盤），用戶再訪問網站，瀏覽器會發送cookie信息到服務器端，服務器端接收cookie並解析來維護用戶的登錄狀態。

cookie避免session集中管理的問題，但也存在弊端：

1、跨域問題。

2、數據存儲在瀏覽器端，數據容易被竊取及被csrf攻擊，安全性差。

優點：

1、相對於session簡單，不用服務端維護用戶認證信息。

2、數據持久性。

jwt

jwt通過json傳輸，php、java、golang等很多語言支持，通用性比較好，不存在跨域問題。傳輸數據通過數據簽名相對比較安全。客戶端與服務端通過jwt交互，服務端通過解密token信息，來實現用戶認證。不需要服務端集中維護token信息，便於擴展。當然jwt也有其缺點。

缺點：

1、用戶無法主動登出，只要token在有效期內就有效。這裏可以考慮redis設置同token有效期一直的黑名單解決此問題。

2、token過了有效期，無法續簽問題。可以考慮通過判斷舊的token什麼時候到期，過期的時候刷新token續簽接口產生新token代替舊token。

jwt設置有效期

可以設置有效期，加入有效期是爲了增加安全性，即token被黑客截獲，也只能攻擊較短時間。設置有效期就會面臨token續簽問題，解決方案如下

通常服務端設置兩個token

• Access Token：添加到 HTTP 請求的 header 中，進行用戶認證，請求接口資源。
• refresh token：用於當 Access Token過期後，客戶端傳遞refresh token刷新 Access Token續期接口，獲取新的Access Token和refresh token。其有效期比 Access Token有效期長。

jwt構成：

• Header：TOKEN 的類型，就是JWT，簽名的算法，如 HMAC SHA256、HS384

• Payload：載荷又稱爲Claim，攜帶的信息，比如用戶名、過期時間等，一般叫做 Claim

• Signature：簽名，是由header、payload 和你自己維護的一個 secret 經過加密得來的

jwt使用

這裏推薦個使用比較多的開源項目github.com/dgrijalva/jwt-go，更多文檔。

示例：

package main

import (
	"fmt"
	"github.com/dgrijalva/jwt-go"
	"time"
)
const (
	SECRETKEY = "243223ffslsfsldfl412fdsfsdf"//私鑰
)
//自定義Claims
type CustomClaims struct {
	UserId int64
	jwt.StandardClaims
}
func main() {
	//生成token
	maxAge:=60*60*24
	customClaims :=&CustomClaims{
		UserId: 11,//用戶id
		StandardClaims: jwt.StandardClaims{
			ExpiresAt: time.Now().Add(time.Duration(maxAge)*time.Second).Unix(), // 過期時間，必須設置
			Issuer:"jerry",   // 非必須，也可以填充用戶名，
		},
	}
	//採用HMAC SHA256加密算法
	token:=jwt.NewWithClaims(jwt.SigningMethodHS256, customClaims)
	tokenString,err:= token.SignedString([]byte(SECRETKEY))
	if err!=nil {
		fmt.Println(err)
	}
	fmt.Printf("token: %v\n", tokenString)

	//解析token
	ret,err :=ParseToken(tokenString)
	if err!=nil {
		fmt.Println(err)
	}
	fmt.Printf("userinfo: %v\n", ret)
}

//解析token
func ParseToken(tokenString string)(*CustomClaims,error)  {
	token, err := jwt.ParseWithClaims(tokenString, &CustomClaims{}, func(token *jwt.Token) (interface{}, error) {
		if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
			return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"])
		}
		return []byte(SECRETKEY), nil
	})
	if claims, ok := token.Claims.(*CustomClaims); ok && token.Valid {
		return claims,nil
	} else {
		return nil,err
	}
}

運行結果：

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVc2VySWQiOjExLCJleHAiOjE1OTA5MTk1NDAsImlzcyI6ImplcnJ5In0.FppmbbHRrS4wd5wen73vYPOvtzycOrn2JZlK6JRjEGk
userinfo: &{11 { 1590919540 0 jerry 0 }}

以上用到了CustomClaims，也可以用簡單的方法

示例

package main

import (
	"fmt"
	"github.com/dgrijalva/jwt-go"
	"time"
)
const (
	SECRETKEY = "243223ffslsfsldfl412fdsfsdf"//私鑰
)
//自定義Claims
type CustomClaims struct {
	UserId int64
	jwt.StandardClaims
}
func main() {
	//生成token
	maxAge:=60*60*24
	// Create the Claims
	//claims := &jwt.StandardClaims{
	//	//	ExpiresAt: time.Now().Add(time.Duration(maxAge)*time.Second).Unix(), // 過期時間，必須設置,
	//	//	Issuer:    "jerry",// 非必須，也可以填充用戶名，
	//	//}

	//或者用下面自定義claim
	claims := jwt.MapClaims{
		"id":       11,
		"name":       "jerry",
		"exp": time.Now().Add(time.Duration(maxAge)*time.Second).Unix(), // 過期時間，必須設置,
	}

	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
	tokenString, err := token.SignedString([]byte(SECRETKEY))
	if err!=nil {
		fmt.Println(err)
	}
	fmt.Printf("token: %v\n", tokenString)

	//解析token
	ret,err :=ParseToken(tokenString)
	if err!=nil {
		fmt.Println(err)
	}
	fmt.Printf("userinfo: %v\n", ret)
}

//解析token
func ParseToken(tokenString string)(jwt.MapClaims,error)  {
	token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
		// Don't forget to validate the alg is what you expect:
		if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
			return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"])
		}

		// hmacSampleSecret is a []byte containing your secret, e.g. []byte("my_secret_key")
		return []byte(SECRETKEY), nil
	})
	if claims, ok := token.Claims.(jwt.MapClaims); ok && token.Valid {
		return claims,nil
	} else {
		return nil,err
	}
}

運行結果類似

token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTA5MzUzMDUsImlkIjoxMSwibmFtZSI6ImplcnJ5In0.fapE0IiOEe_TqoMCThbNTHUvgWiHPEk0rm-9uPIcvPU
userinfo: map[exp:1.590935305e+09 id:11 name:jerry]

小結：

• 服務端生成的jwt返回客戶端可以存到cookie也可以存到localStorage中（相比cookie容量大），存在cookie中需加上 HttpOnly 的標記，可以防止 XSS 攻擊。
• 儘量用https帶證書網址訪問。
• session和jwt沒有絕對好與不好，各有其擅長的應用環境，請根據實際情況選擇。

參考資料

https://github.com/guyan0319/golang_development_notes

https://godoc.org/github.com/dgrijalva/jwt-go

https://blog.csdn.net/weixin_43613053/article/details/84642140

https://www.cnblogs.com/flipped/p/12973557.html

links

• 目錄