middlewares

Documentation

Index

• Constants
• Variables
• func Context() gin.HandlerFunc
• func Cors() gin.HandlerFunc
• func JWTAuth(signKey string) gin.HandlerFunc
• func TracingHandler(service string) gin.HandlerFunc
• type AuthOperator
  • func (ao *AuthOperator) AuthFunc() gin.HandlerFunc
  • func (ao *AuthOperator) SetStrategy(s AuthStrategy)
• type AuthStrategy
• type CustomClaims
• type JWT
  • func NewJWT(sign string) *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)

Constants

const (
	UsernameKey = "username"
	KeyUserID   = "userID"
	UserIP      = "ip"
)

Variables

var (
	TokenExpired     = errors.New("token is expired")
	TokenNotValidYet = errors.New("token not active yet")
	TokenMalformed   = errors.New("that's not even a token")
	TokenInvalid     = errors.New("couldn't handle this token")
)

var Middlewares = defaultMiddlewares()

Functions

func Context

func Context() gin.HandlerFunc

Context 请求上下文中间件，用于将一些常用的信息放入到gin.Context中

func Cors

func Cors() gin.HandlerFunc

func JWTAuth

func JWTAuth(signKey string) gin.HandlerFunc

TODO 弃用，使用了通用中间件，实现验证

func TracingHandler

func TracingHandler(service string) gin.HandlerFunc

Types

type AuthOperator

type AuthOperator struct {
	// contains filtered or unexported fields
}

AuthOperator 认证实体工厂类

func (*AuthOperator) AuthFunc

func (ao *AuthOperator) AuthFunc() gin.HandlerFunc

AuthFunc 返回一个 gin.HandlerFunc 中间件接口函数

func (*AuthOperator) SetStrategy

func (ao *AuthOperator) SetStrategy(s AuthStrategy)

type AuthStrategy

type AuthStrategy interface {
	// AuthFunc 相当于是实现了一个名为 AuthFunc 的中间件
	AuthFunc() gin.HandlerFunc
}

AuthStrategy 认证策略

type CustomClaims

type CustomClaims struct {
	ID          uint `json:"userid"`
	NickName    string
	AuthorityId uint
	jwt.StandardClaims
}

type JWT

type JWT struct {
	SigningKey []byte
}

func NewJWT

func NewJWT(sign string) *JWT

func (*JWT) CreateToken

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

创建一个token

func (*JWT) ParseToken

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

解析 token

func (*JWT) RefreshToken

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

更新token