Go開發Gin專案新增jwt功能範例詳解

{
     "user_id": "xxxxxx",
    "role": "xxxxxx",
    "refresh_token": "xxxxx"
}

{
  "alg": "HS256",
  "typ": "JWT"
}

go get -u github.com/dgrijalva/jwt-go
go get github.com/gin-gonic/gin

var Secret = []byte("whatasecret")
// jwt過期時間, 按照實際環境設定
const expiration = 2 * time.Minute
type Claims struct {
	// 自定義欄位, 可以存在使用者名稱, 使用者ID, 使用者角色等等
	Username string
	// jwt.StandardClaims包含了官方定義的欄位
	jwt.StandardClaims
}
func GenToken(username string) (string, error) {
	// 建立宣告
	a := &Claims{
		Username: username,
		StandardClaims: jwt.StandardClaims{
			ExpiresAt: time.Now().Add(expiration).Unix(), // 過期時間
			IssuedAt:  time.Now().Unix(),                 // 簽發時間
			Issuer:    "gin-jwt-demo",                    // 簽發者
			Id:        "",                                // 按需求選這個, 有些實現中, 會控制這個ID是不是在黑/白名單來判斷是否還有效
			NotBefore: 0,                                 // 生效起始時間
			Subject:   "",                                // 主題
		},
	}
	// 用指定的雜湊方法建立簽名物件
	tt := jwt.NewWithClaims(jwt.SigningMethodHS256, a)
	// 用上面的宣告和簽名物件簽名字串token
	// 1. 先對Header和PayLoad進行Base64URL轉換
	// 2. Header和PayLoadBase64URL轉換後的字串用.拼接在一起
	// 3. 用secret對拼接在一起之後的字串進行HASH加密
	// 4. 連在一起返回
	return tt.SignedString(Secret)
}
func ParseToken(tokenStr string) (*Claims, error) {
	// 第三個引數: 提供一個回撥函數用於提供要選擇的祕鑰, 回撥函數裡面的token引數,是已經解析但未驗證的,可以根據token裡面的值做一些邏輯, 如`kid`的判斷
	token, err := jwt.ParseWithClaims(tokenStr, &Claims{}, func(token *jwt.Token) (interface{}, error) {
		return Secret, nil
	})
	if err != nil {
		return nil, err
	}
	// 校驗token
	if claims, ok := token.Claims.(*Claims); ok && token.Valid {
		return claims, nil
	}
	return nil, errors.New("invalid token")
}

type Claims struct {
	// 自定義欄位, 可以存在使用者名稱, 使用者ID, 使用者角色等等
	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"`
}

func GenToken(username string) (string, error) {
	// 建立宣告
	a := &Claims{
		Username: username,
		StandardClaims: jwt.StandardClaims{
			ExpiresAt: time.Now().Add(expiration).Unix(), // 過期時間
			IssuedAt:  time.Now().Unix(),                 // 簽發時間
			Issuer:    "gin-jwt-demo",                    // 簽發者
			Id:        "",                                // 按需求選這個, 有些實現中, 會控制這個ID是不是在黑/白名單來判斷是否還有效
			NotBefore: 0,                                 // 生效起始時間
			Subject:   "",                                // 主題
		},
	}
	// 用指定的雜湊方法建立簽名物件
	tt := jwt.NewWithClaims(jwt.SigningMethodHS256, a)
	// 用上面的宣告和簽名物件簽名字串token
	// 1. 先對Header和PayLoad進行Base64URL轉換
	// 2. Header和PayLoadBase64URL轉換後的字串用.拼接在一起
	// 3. 用secret對拼接在一起之後的字串進行HASH加密
	// 4. 連在一起返回
	return tt.SignedString(Secret)
}

func ParseToken(tokenStr string) (*Claims, error) {
	// 第三個引數: 提供一個回撥函數用於提供要選擇的祕鑰, 回撥函數裡面的token引數,是已經解析但未驗證的,可以根據token裡面的值做一些邏輯, 如`kid`的判斷
	token, err := jwt.ParseWithClaims(tokenStr, &Claims{}, func(token *jwt.Token) (interface{}, error) {
		return Secret, nil
	})
	if err != nil {
		return nil, err
	}
	// 校驗token
	if claims, ok := token.Claims.(*Claims); ok && token.Valid {
		return claims, nil
	}
	return nil, errors.New("invalid token")
}

func JWTAuthMiddleware() func(ctx *gin.Context) {
	return func(ctx *gin.Context) {
		// 根據實際情況取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
		}
		// 此處已經通過了, 可以把Claims中的有效資訊拿出來放入上下文使用
		ctx.Set("username", claims.Username)
		ctx.Next()
	}
}

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")
}