Go gin使用JWT进行身份校验

本文代码github: https://github.com/zboyco/go-test/tree/master/gin-jwt

---

1.前言

JWT是json web token缩写,一种网络令牌,可以非常简单的实现身份校验功能,具体的介绍网上很多,就不再重复了.

2.使用库

go语言的jwt库还是挺多的,我们选用star最多的,其他可以参考 https://jwt.io/
jwt-go:github.com/dgrijalva/jwt-go

3.gin中间件实现

package jwt

import (
	"errors"
	"log"
	"net/http"
	"time"

	jwt "github.com/dgrijalva/jwt-go"
	"github.com/gin-gonic/gin"
)

var (
	// 盐
	jwtSecret = []byte("baiyang")
	// 过期时间
	expireSecond = 1 * 60 * 60
	// 发行人
	issur = "baiyang"

	// ErrorExpired 过期
	ErrorExpired = errors.New("Token is expired")
	// ErrorNotValidYet 未生效
	ErrorNotValidYet = errors.New("Token not active yet")
	// ErrorMalformed 畸形Token
	ErrorMalformed = errors.New("That's not even a token")
	// ErrorInvalid 其他错误
	ErrorInvalid = errors.New("Couldn't handle this token")
)

// CustomClaims 定义一个Claims结构体,可以添加自定义属性
type CustomClaims struct {
	UserID int `json:"userID"`
	jwt.StandardClaims
}

// GenerateToken 生成Token
func GenerateToken(userID int) (string, error) {
	// 新建一个Claims
	claims := CustomClaims{
		userID,
		jwt.StandardClaims{
			ExpiresAt: time.Now().Add(time.Duration(expireSecond) * time.Second).Unix(), // 设置超时时间
			Issuer:    issur,                                                            // 设置发行人
		},
	}
	// 生成Token
	tokenClaims := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
	// 签署
	return tokenClaims.SignedString(jwtSecret)
}

// ParseToken 解析Token
func ParseToken(tokenString string) (*CustomClaims, error) {
	tokenClaims, err := jwt.ParseWithClaims(tokenString, &CustomClaims{}, func(token *jwt.Token) (interface{}, error) {
		return jwtSecret, nil
	})
	if err != nil {
		if ve, ok := err.(*jwt.ValidationError); ok {
			if ve.Errors&jwt.ValidationErrorMalformed != 0 {
				return nil, ErrorMalformed
			} else if ve.Errors&jwt.ValidationErrorExpired != 0 {
				return nil, ErrorExpired
			} else if ve.Errors&jwt.ValidationErrorNotValidYet != 0 {
				return nil, ErrorNotValidYet
			} else {
				return nil, ErrorInvalid
			}
		}
	}
	if claims, ok := tokenClaims.Claims.(*CustomClaims); ok && tokenClaims.Valid {
		return claims, nil
	}
	return nil, ErrorInvalid
}

// Auth 中间件，检查token
func Auth() gin.HandlerFunc {
	return func(c *gin.Context) {
		token := c.Request.Header.Get("token")
		if token == "" {
			c.JSON(http.StatusUnauthorized, gin.H{
				"code": -1,
				"msg":  "请求未携带token，无权限访问",
			})
			c.Abort()
			return
		}

		log.Print("get token: ", token)

		// parseToken 解析token包含的信息
		claims, err := ParseToken(token)
		if err != nil {
			if err == ErrorExpired {
				c.JSON(http.StatusUnauthorized, gin.H{
					"code": -1,
					"msg":  "授权已过期",
				})
				c.Abort()
				return
			}
			c.JSON(http.StatusUnauthorized, gin.H{
				"code": -1,
				"msg":  err.Error(),
			})
			c.Abort()
			return
		}
		// 继续交由下一个路由处理,并将解析出的信息传递下去
		c.Set("UserID", claims.UserID)
		// c.Next()
	}
}

• Auth 方法实现gin的中间件,其他方法实现jwt功能,可以将其他方法提取到utils中去

4.使用jwt验证

package main

import (
	"go-test/gin-jwt/middleware/jwt"
	"net/http"

	"github.com/gin-gonic/gin"
)

func main() {
	r := gin.Default()
	r.GET("/", func(ctx *gin.Context) {
		ctx.JSON(http.StatusOK, gin.H{
			"message": "this is index",
		})
	})
	r.POST("/Login", func(ctx *gin.Context) {
		token, err := jwt.GenerateToken(123)
		if err != nil {
			ctx.JSON(http.StatusOK, gin.H{
				"message": err.Error(),
			})
		}
		ctx.JSON(http.StatusOK, gin.H{
			"token": token,
		})
	})
	data := r.Group("/data")
	data.Use(jwt.Auth())
	{
		data.GET("/ok", func(ctx *gin.Context) {
			userID := ctx.MustGet("UserID").(int)
			ctx.JSON(http.StatusOK, gin.H{
				"UserID": userID,
			})
		})
	}
	r.Run()
}

• userID := ctx.MustGet("UserID").(int)获取中间件传递的数据

参考文章:
gin 基于JWT实现token令牌功能
2018-02-16-Gin实践-连载五-使用JWT进行身份校验