Go開(kāi)發(fā)Gin項(xiàng)目添加jwt功能實(shí)例詳解
啥是JWT
JWT全稱(chēng)JSON Web Token是一種跨域認(rèn)證解決方案,屬于一個(gè)開(kāi)放的標(biāo)準(zhǔn),它規(guī)定了一種Token實(shí)現(xiàn)方式,目前多用于前后端分離項(xiàng)目和OAuth2.0業(yè)務(wù)場(chǎng)景下。
為什么要用在你的Gin中使用JWT
傳統(tǒng)的Cookie-Sesson模式占用服務(wù)器內(nèi)存, 拓展性不好,遇到集群或者跨服務(wù)驗(yàn)證的場(chǎng)景的話(huà), 要支持Sesson復(fù)制或者sesson持久化
JWT的基本原理
在服務(wù)器驗(yàn)證之后, 得到用戶(hù)信息JSON
{ "user_id": "xxxxxx", "role": "xxxxxx", "refresh_token": "xxxxx" }
JWT TOKEN怎么組成
JWT是一個(gè)很長(zhǎng)的字符串
eyJhbGciOiJI123afasrwrqqewrcCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
它由三部分組成, 每部分用點(diǎn)(.)分隔, 三個(gè)部分依次如下
- Header(頭部)
- Payload(負(fù)載)
- Signature(簽名)
Header
Header是一個(gè)經(jīng)過(guò)BASE64URL算法加密過(guò)的JSON對(duì)象, 解密后如下
{ "alg": "HS256", "typ": "JWT" }
其中, alg屬性表示簽名所用的算法,默認(rèn)是HS256;
typ則表示當(dāng)前token的類(lèi)型, 而JWT的類(lèi)型則為jwt
Base64URL
與BASE64類(lèi)似, 由于+、/、=這幾個(gè)符號(hào)在URL中有特殊含義, 因此BASE64RUL算法, 把這幾個(gè)符號(hào)進(jìn)行了替換
+ -> -
= -> 被忽略
/ -> _
Payload
Payload部分也是JSON對(duì)象經(jīng)過(guò)BASE64URL算法轉(zhuǎn)成字符串的, Payload部分包含7個(gè)基本字段
- iss (issuer):簽發(fā)人
- exp (expiration time):過(guò)期時(shí)間
- sub (subject):主題
- aud (audience):受眾
- nbf (Not Before):生效時(shí)間
- iat (Issued At):簽發(fā)時(shí)間
- jti (JWT ID):編號(hào)
也可以往里面塞入自定義的業(yè)務(wù)字段, 如下
user_id
role
Signature
Signature 部分是對(duì)前兩部分的簽名,防止數(shù)據(jù)篡改。
首先,需要指定一個(gè)密鑰(secret)。這個(gè)密鑰只有服務(wù)器才知道,不能泄露給用戶(hù)。然后,使用 Header 里面指定的簽名算法(默認(rèn)是 HMAC SHA256),按照下面的公式產(chǎn)生簽名。
HMACSHA256(
base64UrlEncode(header) + "." +
base64UrlEncode(payload),
secret)
解密過(guò)程
當(dāng)系統(tǒng)接收到TOKEN時(shí), 拿出Header和Payload的字符串用.拼接在一起之后, 用Header里面指定的哈希方法通過(guò)公式
HMACSHA256(
base64UrlEncode(header) + "." +
base64UrlEncode(payload),
secret)
進(jìn)行加密得出密文
然后用剛剛得出的密文與TOKEN傳過(guò)來(lái)的密文對(duì)比, 如果相等則表明密文沒(méi)有更改.
一些特點(diǎn)(優(yōu)點(diǎn)和缺點(diǎn))
- JWT 默認(rèn)是不加密,但也是可以加密的。生成原始 Token 以后,可以用密鑰再加密一次。
- JWT 不加密的情況下,不能將秘密數(shù)據(jù)寫(xiě)入 JWT。
- JWT 不僅可以用于認(rèn)證,也可以用于交換信息。有效使用 JWT,可以降低服務(wù)器查詢(xún)數(shù)據(jù)庫(kù)的次數(shù)。
- JWT 的最大缺點(diǎn)是,由于服務(wù)器不保存 session 狀態(tài),因此無(wú)法在使用過(guò)程中廢止某個(gè) token,或者更改 token 的權(quán)限。也就是說(shuō),一旦 JWT 簽發(fā)了,在到期之前就會(huì)始終有效,除非服務(wù)器部署額外的邏輯。
- JWT 本身包含了認(rèn)證信息,一旦泄露,任何人都可以獲得該令牌的所有權(quán)限。為了減少盜用,JWT 的有效期應(yīng)該設(shè)置得比較短。對(duì)于一些比較重要的權(quán)限,使用時(shí)應(yīng)該再次對(duì)用戶(hù)進(jìn)行認(rèn)證。
- 為了減少盜用,JWT 不應(yīng)該使用 HTTP 協(xié)議明碼傳輸,要使用 HTTPS 協(xié)議傳輸。
GIN整合JWT
go get -u github.com/dgrijalva/jwt-go go get github.com/gin-gonic/gin
編寫(xiě)jwtutil
var Secret = []byte("whatasecret") // jwt過(guò)期時(shí)間, 按照實(shí)際環(huán)境設(shè)置 const expiration = 2 * time.Minute type Claims struct { // 自定義字段, 可以存在用戶(hù)名, 用戶(hù)ID, 用戶(hù)角色等等 Username string // jwt.StandardClaims包含了官方定義的字段 jwt.StandardClaims } func GenToken(username string) (string, error) { // 創(chuàng)建聲明 a := &Claims{ Username: username, StandardClaims: jwt.StandardClaims{ ExpiresAt: time.Now().Add(expiration).Unix(), // 過(guò)期時(shí)間 IssuedAt: time.Now().Unix(), // 簽發(fā)時(shí)間 Issuer: "gin-jwt-demo", // 簽發(fā)者 Id: "", // 按需求選這個(gè), 有些實(shí)現(xiàn)中, 會(huì)控制這個(gè)ID是不是在黑/白名單來(lái)判斷是否還有效 NotBefore: 0, // 生效起始時(shí)間 Subject: "", // 主題 }, } // 用指定的哈希方法創(chuàng)建簽名對(duì)象 tt := jwt.NewWithClaims(jwt.SigningMethodHS256, a) // 用上面的聲明和簽名對(duì)象簽名字符串token // 1. 先對(duì)Header和PayLoad進(jìn)行Base64URL轉(zhuǎn)換 // 2. Header和PayLoadBase64URL轉(zhuǎn)換后的字符串用.拼接在一起 // 3. 用secret對(duì)拼接在一起之后的字符串進(jìn)行HASH加密 // 4. 連在一起返回 return tt.SignedString(Secret) } func ParseToken(tokenStr string) (*Claims, error) { // 第三個(gè)參數(shù): 提供一個(gè)回調(diào)函數(shù)用于提供要選擇的秘鑰, 回調(diào)函數(shù)里面的token參數(shù),是已經(jīng)解析但未驗(yàn)證的,可以根據(jù)token里面的值做一些邏輯, 如`kid`的判斷 token, err := jwt.ParseWithClaims(tokenStr, &Claims{}, func(token *jwt.Token) (interface{}, error) { return Secret, nil }) if err != nil { return nil, err } // 校驗(yàn)token if claims, ok := token.Claims.(*Claims); ok && token.Valid { return claims, nil } return nil, errors.New("invalid token") }
- Secret是秘鑰, 用于加密簽名
- expiration是TOKEN過(guò)期時(shí)間
- Claims是簽名聲明對(duì)象, 包含自定義的字段和JWT規(guī)定的字段
type Claims struct { // 自定義字段, 可以存在用戶(hù)名, 用戶(hù)ID, 用戶(hù)角色等等 Username string // jwt.StandardClaims包含了官方定義的字段 jwt.StandardClaims } type StandardClaims struct { Audience string `json:"aud,omitempty"` ExpiresAt int64 `json:"exp,omitempty"` Id string `json:"jti,omitempty"` IssuedAt int64 `json:"iat,omitempty"` Issuer string `json:"iss,omitempty"` NotBefore int64 `json:"nbf,omitempty"` Subject string `json:"sub,omitempty"` }
GenToken方法
GenToken方法為某個(gè)username生成一個(gè)token, 每次生成都不一樣
jwt.NewWithClaims(jwt.SigningMethodHS256, a)聲明了一個(gè)簽名對(duì)象, 并且指定了HS256的哈希算法
token.SignedString(Secret)表明用剛剛的聲明對(duì)象和SECRET利用指定的哈希算法去加密,包含下面流程
- 先對(duì)Header和PayLoad進(jìn)行Base64URL轉(zhuǎn)換
- Header和PayLoadBase64URL轉(zhuǎn)換后的字符串用.拼接在一起
- 用secret對(duì)拼接在一起之后的字符串進(jìn)行HASH加密
- BASE64URL(Header).BASE64URL(Payload).signature連在一起的字符串返回
func GenToken(username string) (string, error) { // 創(chuàng)建聲明 a := &Claims{ Username: username, StandardClaims: jwt.StandardClaims{ ExpiresAt: time.Now().Add(expiration).Unix(), // 過(guò)期時(shí)間 IssuedAt: time.Now().Unix(), // 簽發(fā)時(shí)間 Issuer: "gin-jwt-demo", // 簽發(fā)者 Id: "", // 按需求選這個(gè), 有些實(shí)現(xiàn)中, 會(huì)控制這個(gè)ID是不是在黑/白名單來(lái)判斷是否還有效 NotBefore: 0, // 生效起始時(shí)間 Subject: "", // 主題 }, } // 用指定的哈希方法創(chuàng)建簽名對(duì)象 tt := jwt.NewWithClaims(jwt.SigningMethodHS256, a) // 用上面的聲明和簽名對(duì)象簽名字符串token // 1. 先對(duì)Header和PayLoad進(jìn)行Base64URL轉(zhuǎn)換 // 2. Header和PayLoadBase64URL轉(zhuǎn)換后的字符串用.拼接在一起 // 3. 用secret對(duì)拼接在一起之后的字符串進(jìn)行HASH加密 // 4. 連在一起返回 return tt.SignedString(Secret) }
ParseToken方法
ParseToken方法解析一個(gè)Token, 并驗(yàn)證Token是否生效
jwt.ParseWithClaims方法, 用于解析Token, 其第三個(gè)參數(shù):
提供一個(gè)回調(diào)函數(shù)用于提供要選擇的秘鑰, 回調(diào)函數(shù)里面的token參數(shù),是已經(jīng)解析但未驗(yàn)證的,可以根據(jù)token里面的值做一些邏輯, 如判斷kid來(lái)選用不同的secret
KID(可選): 代表秘鑰序號(hào)。開(kāi)發(fā)人員可以用它標(biāo)識(shí)認(rèn)證token的某一秘鑰
func ParseToken(tokenStr string) (*Claims, error) { // 第三個(gè)參數(shù): 提供一個(gè)回調(diào)函數(shù)用于提供要選擇的秘鑰, 回調(diào)函數(shù)里面的token參數(shù),是已經(jīng)解析但未驗(yàn)證的,可以根據(jù)token里面的值做一些邏輯, 如`kid`的判斷 token, err := jwt.ParseWithClaims(tokenStr, &Claims{}, func(token *jwt.Token) (interface{}, error) { return Secret, nil }) if err != nil { return nil, err } // 校驗(yàn)token if claims, ok := token.Claims.(*Claims); ok && token.Valid { return claims, nil } return nil, errors.New("invalid token") }
編寫(xiě)中間件
從Header中取出Authorization并拿去解析jwt.ParseToken,
驗(yàn)證token是否被串改, 是否過(guò)期
從token取出有效信息并設(shè)置到上下文
func JWTAuthMiddleware() func(ctx *gin.Context) { return func(ctx *gin.Context) { // 根據(jù)實(shí)際情況取TOKEN, 這里從request header取 tokenStr := ctx.Request.Header.Get("Authorization") if tokenStr == "" { ctx.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{ "code": code.ERR_AUTH_NULL, "msg": code.GetMsg(code.ERR_AUTH_NULL), }) return } claims, err := jwt.ParseToken(tokenStr) if err != nil { ctx.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{ "code": code.ERR_AUTH_INVALID, "msg": code.GetMsg(code.ERR_AUTH_INVALID), }) return } else if time.Now().Unix() > claims.ExpiresAt { ctx.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{ "code": code.ERR_AUTH_EXPIRED, "msg": code.GetMsg(code.ERR_AUTH_EXPIRED), }) return } // 此處已經(jīng)通過(guò)了, 可以把Claims中的有效信息拿出來(lái)放入上下文使用 ctx.Set("username", claims.Username) ctx.Next() } }
使用中間件
/login不用中間件
中間件指定在authorizedrouter, 因此authorized下的所有路由都會(huì)使用此中間件
func main() { r := gin.Default() r.POST("/login", router.Login) authorized := r.Group("/auth") authorized.Use(jwt.JWTAuthMiddleware()) { authorized.GET("/getUserInfo", router.GetUserInfo) } r.Run(":8082") }
測(cè)試
login請(qǐng)求獲取token
POST http://localhost:8082/login
把token放入getUserInfo請(qǐng)求
GET http://localhost:8082/auth/getUserInfo
其他
完整的JWT登錄還應(yīng)該包括
- 使TOKEN失效(過(guò)期或者黑名單等功能)
- refresh token
- …
通過(guò)上述流程你就能快速的在你的Go Gin項(xiàng)目中應(yīng)用JWT能力
以上就是Go開(kāi)發(fā)Gin項(xiàng)目添加jwt功能實(shí)例詳解的詳細(xì)內(nèi)容,更多關(guān)于Go Gin項(xiàng)目添加jwt的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
一文教你如何快速學(xué)會(huì)Go的struct數(shù)據(jù)類(lèi)型
結(jié)構(gòu)是表示字段集合的用戶(hù)定義類(lèi)型。它可以用于將數(shù)據(jù)分組為單個(gè)單元而不是將每個(gè)數(shù)據(jù)作為單獨(dú)的值的地方。本文就來(lái)和大家聊聊Go中struct數(shù)據(jù)類(lèi)型的使用,需要的可以參考一下2023-03-03golang通過(guò)http訪(fǎng)問(wèn)外部網(wǎng)址的操作方法
這篇文章主要介紹了golang通過(guò)http訪(fǎng)問(wèn)外部網(wǎng)址的操作方法,分為?get方式訪(fǎng)問(wèn)外部的接口,Post方式請(qǐng)求外部接口,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),需要的朋友可以參考下2024-02-02源碼剖析Golang中map擴(kuò)容底層的實(shí)現(xiàn)
之前的文章詳細(xì)介紹過(guò)Go切片和map的基本使用,以及切片的擴(kuò)容機(jī)制。本文針對(duì)map的擴(kuò)容,會(huì)從源碼的角度全面的剖析一下map擴(kuò)容的底層實(shí)現(xiàn),需要的可以參考一下2023-03-03GoFrame框架數(shù)據(jù)校驗(yàn)之校驗(yàn)對(duì)象校驗(yàn)結(jié)構(gòu)體
這篇文章主要為大家介紹了GoFrame框架數(shù)據(jù)校驗(yàn)之校驗(yàn)對(duì)象校驗(yàn)結(jié)構(gòu)體示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-06-06使用client-go工具調(diào)用kubernetes API接口的教程詳解(v1.17版本)
這篇文章主要介紹了使用client-go工具調(diào)kubernetes API接口(v1.17版本),本文通過(guò)圖文實(shí)例相結(jié)合給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-08-08Golang 字符串轉(zhuǎn)time類(lèi)型實(shí)現(xiàn)
本文主要介紹了Golang 字符串轉(zhuǎn)time類(lèi)型實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-03-03