gin_middlewares

README

gin-jwt-middleware

gin jwt 认证中间件

Documentation

Index

• Variables
• func GetSignKey() string
• func Jwt() gin.HandlerFunc
• func SetSignKey(key string) string
• type CustomClaims
• type JWT
  • func NewJWT() *JWT
  • func (j *JWT) CreateToken(claims CustomClaims) (string, error)
  • func (j *JWT) ParseToken(tokenString string) (*CustomClaims, error)
  • func (j *JWT) RefreshToken(tokenString string) (string, error)

Variables

var (
	// token错误信息的定义
	// 是否过期的token err
	TokenExpired error = errors.New("Token is expired")
	// 是否为激活的token
	TokenNotValidYet error = errors.New("Token not active yet")
	// 是否是正确格式的token
	TokenMalformed error = errors.New("That's not even a token")
	// 是否有效的token
	TokenInvalid error = errors.New("Couldn't handle this token:")
	// 签名信息
	SignKey string = "ynsluhanUUwebUUapi"
)

一些常量

Functions

func GetSignKey

func GetSignKey() string

获取signKey

func Jwt

func Jwt() gin.HandlerFunc

*

• @Author yNsLuHan
• @Description: gin jwt
• @return Config

func SetSignKey

func SetSignKey(key string) string

这是SignKey 修改全局变量的签名信息，用于token签名

Types

type CustomClaims

type CustomClaims struct {
	ID       int    `json:"userId"`
	Mobile   string `json:"mobile"`
	Avatar   string `json:"avatar"`
	NickName string `json:"nickname"`
	Openid   string `json:"openid"`
	jwt.StandardClaims
}

载荷，可以加一些自己需要的信息 用户token中科院提取用户信息之类

type JWT

type JWT struct {
	SigningKey []byte
}

JWT 签名结构

func NewJWT

func NewJWT() *JWT

新建一个jwt实例

func (*JWT) CreateToken

func (j *JWT) CreateToken(claims CustomClaims) (string, error)

CreateToken 生成一个token 参数为一个user对象 返回参数： token, err

func (*JWT) ParseToken

func (j *JWT) ParseToken(tokenString string) (*CustomClaims, error)

解析token 参数为：token 返回两个结果， 第一个为一个对象，第二个为err错误信息

func (*JWT) RefreshToken

func (j *JWT) RefreshToken(tokenString string) (string, error)

更新token 参数为token 返回结果： token, err