gin框架使用JWT鉴定权限

目前主流的 gin 的鉴权框架有 github 上的 dgrijalva/jwt-go 和 golang-jwt/jwt&＃xff0c;但是 dgrijalva/jwt-go 以前用的特别多&＃xff0c;但是有一些漏洞&＃xff0c;现在更推荐的是 golang-jwt/jwt 官方社区版

github&＃xff1a;https://github.com/golang-jwt/jwt

官网&＃xff1a;https://pkg.go.dev/github.com/golang-jwt/jwt/v4

JWT&＃xff08;JSON Web Tokens&＃xff09;&＃xff0c;

go get -u github.com/golang-jwt/jwt

import "github.com/golang-jwt/jwt"

源码

// A JWT Token. Different fields will be used depending on whether you&＃39;re
// creating or parsing/verifying a token.
type Token struct {Raw string // The raw token. Populated when you Parse a tokenMethod SigningMethod // The signing method used or to be usedHeader map[string]interface{} // The first segment of the tokenClaims Claims // The second segment of the tokenSignature string // The third segment of the token. Populated when you Parse a tokenValid bool // Is the token valid? Populated when you Parse/Verify a token
}


JWT 中的 token如上图&＃xff0c;完整的 token 分为 3 部分

• The first segment of the token&＃xff1a;Header
• The second segment of the token&＃xff1a;Claims
• The third segment of the token. Populated when you Parse a token&＃xff1a;Signature

• 登录的 HandlerFunc 中&＃xff0c;需要生成 token&＃xff0c;并设置响应头带上这个 token
• 中间件可以处理分组的请求&＃xff0c;检测 Authorization 中数据做解析判定数据是否有效&＃xff0c;如果无效直接返回无权限&＃xff0c;不会进入到具体 HandlerFunc 中操作&＃xff0c;如果有效则把 claims 中的用户信息保存到 gin.context 中&＃xff0c;然后放行进入 HandlerFunc 中

r :&＃61; gin.Default()authGroup :&＃61; r.Group("/auth")// 分组使用 JWT 鉴权中间件
authGroup.Use(middleware.JWTAuth())

middlerware 中写法

中间件中做到解析 token&＃xff0c;然后把 token 中的用户信息存放在 gin.Context 中&＃xff0c;方便后面 HandlerFunc 中取用

// JWTAuth 鉴权中间件
func JWTAuth() gin.HandlerFunc {return func(c *gin.Context) {// 获取请求头中 token&＃xff0c;实际是一个完整被签名过的 token&＃xff1b;a complete, signed tokentokenStr :&＃61; c.GetHeader("Authorization")if tokenStr &＃61;&＃61; "" {c.JSON(http.StatusForbidden, "No token. You don&＃39;t have permission!")c.Abort()return}// 解析拿到完整有效的 token&＃xff0c;里头包含解析后的 3 segmenttoken, err :&＃61; ParseToken(tokenStr)if err !&＃61; nil {c.JSON(http.StatusForbidden, "Invalid token! You don&＃39;t have permission!")c.Abort()return}// 获取 token 中的 claimsclaims, ok :&＃61; token.Claims.(*AuthClaims)if !ok {c.JSON(http.StatusForbidden, "Invalid token!")c.Abort()return}// 将 claims 中的用户信息存储在 context 中c.Set("userId", claims.UserId)// 这里执行路由 HandlerFuncc.Next()}
}

ParseToken 解析 token string &＃61;> *jwt.Token

// ParseToken 解析请求头中的 token string&＃xff0c;转换成被解析后的 jwt.Token
func ParseToken(tokenStr string) (*jwt.Token, error) {// 解析 token string 拿到 token jwt.Tokenreturn jwt.ParseWithClaims(tokenStr, &AuthClaims{}, func(tk *jwt.Token) (interface{}, error) {return secretKey, nil})
}

secretKey 密钥

建议不要存放在项目代码中&＃xff0c;要单独私有存放

var secretKey &＃61; []byte("some string")

AuthClaims 结构体

// AuthClaims 是 claims struct
type AuthClaims struct {UserId uint64 &＃96;json:"userId"&＃96;jwt.StandardClaims
}

GenerateToken 生成 *jwt.Token

一般在 login 后来生成 *jwt.Token 存放在响应头中给浏览器

// GenerateToken 一般在登录之后使用来生成 token 能够返回给前端
func GenerateToken(userId uint64, expireTime time.Time) (string, error) {// 创建一个 claimclaim :&＃61; AuthClaims{UserId: userId,StandardClaims: jwt.StandardClaims{// 过期时间ExpiresAt: expireTime.Unix(),// 签名时间IssuedAt: time.Now().Unix(),// 签名颁发者Issuer: "abcnull",// 签名主题Subject: "gindemo",},}// 使用指定的签名加密方式创建 token&＃xff0c;有 1&＃xff0c;2 段内容&＃xff0c;第 3 段内容没有加上noSignedToken :&＃61; jwt.NewWithClaims(jwt.SigningMethodHS256, claim)// 使用 secretKey 密钥进行加密处理后拿到最终 token stringreturn noSignedToken.SignedString(secretKey)
}

login 登录后响应头设置 COOKIE

login 登录之后需要把 token string 带到响应头中返回给前端浏览器来保存信息

// 查询数据库&＃xff0c;通过用户密码拿到 userId
userId :&＃61; 1// token 过期时间 60 天&＃xff0c;Time 类型
var expireTime &＃61; time.Now().Add(60 * 24 * time.Hour)// 生成 token string
tokenStr, tokenErr :&＃61; middleware.GenerateToken(userId, expireTime)
if tokenErr !&＃61; nil {// todo: 做一些出错处理
}// 设置响应头信息的 token
c.SetCOOKIE("Authorization", tokenStr, 60, "/", "127.0.0.1", false, true)

常规 HandlerFunc 使用用户信息

// 登录之后可以接入 Get 拿到用户信息&＃xff0c;返回是 (interface{}, bool)
userId, flag :&＃61; c.Get("userId")// todo: 通过 userId 可以查询数据库获取想要的用户信息