token

Documentation

Index

• func Assemble(header, payload, sign string) string
• func Decode(str string) string
• func Disassemble(token string) []string
• func Encode[T []byte | string](json T) string
• func Generator(header, payload string) string
• func Jwt(opts ...OptionsFunc) gin.HandlerFunc
• type JWT
  • func Default(c *gin.Context) (*JWT, bool)
  • func (jwt *JWT) Get(key string) any
  • func (jwt *JWT) Parse(verifySign bool) (err error)
• type OptionsFunc
  • func OptAuthFunc(value func(*JWT) error) OptionsFunc
  • func OptMustFetchToken(value bool) OptionsFunc
  • func OptVerifySign(value bool) OptionsFunc

Functions

func Assemble

func Assemble(header, payload, sign string) string

Assemble 组合

func Decode

func Decode(str string) string

Decode URL字符串转JSON

func Disassemble

func Disassemble(token string) []string

Disassemble 结构

func Encode

func Encode[T []byte | string](json T) string

Encode JSON转URL字符串

func Generator

func Generator(header, payload string) string

Generator 构造完整Token

func Jwt

func Jwt(opts ...OptionsFunc) gin.HandlerFunc

Jwt 获取Json web token

Types

type JWT

type JWT struct {
	Data   map[string]any
	Signed bool
	// contains filtered or unexported fields
}

func Default

func Default(c *gin.Context) (*JWT, bool)

Default 从gin context中获取JWT数据

func (*JWT) Get

func (jwt *JWT) Get(key string) any

Get 获取jwt中的数据

func (*JWT) Parse

func (jwt *JWT) Parse(verifySign bool) (err error)

Parse 解析Token中的数据 @params verifySign: 是否验证签名，只有验证签名才可以解析并读取payload中的数据

type OptionsFunc

type OptionsFunc func(option *options)

func OptAuthFunc

func OptAuthFunc(value func(*JWT) error) OptionsFunc

OptAuthFunc 验证数据方法

func OptMustFetchToken

func OptMustFetchToken(value bool) OptionsFunc

OptMustFetchToken 是否必须携带Token数据

func OptVerifySign

func OptVerifySign(value bool) OptionsFunc

OptVerifySign 是否需要验证登录签名