jgjwt

README

go-jwt

跟jwt相关的便捷函数

Documentation

Index

• Constants
• type Claims
• type Config
• type JWT
  • func NewJWT(cfg *Config) (*JWT, error)
  • func (j *JWT) DecodeHS256Token(token string) (*Claims, error)
  • func (j *JWT) DecodeRS256Token(token string) (*Claims, error)
  • func (j *JWT) DecodeTokenUnverified(token string) (*Claims, error)
  • func (j *JWT) GenHS256Token(payload string, kvs map[string]interface{}) (string, error)
  • func (j *JWT) GenRS256Token(payload string, kvs map[string]interface{}) (string, error)

Constants

const (
	KeyIat     = "iat"
	KeyExp     = "exp"
	KeyPayload = "payload"
	KeyKVs     = "kvs"
)

Types

type Claims

type Claims struct {
	Iat     int64                  `json:"iat"`     // issued at, 签发时间
	Exp     int64                  `json:"exp"`     // expiration time, 过期时间
	Payload string                 `json:"payload"` // payload, 有效载荷
	KVs     map[string]interface{} `json:"kvs"`     // 其他自定义字段
}

type Config

type Config struct {
	MaxAge time.Duration `mapstructure:"max_age"` // 会话有效时长，如：20s

	// HS256相关
	HS256SecretIsBase64 bool   `mapstructure:"hs256_secret_is_base64"` // 密钥是否为base64编码
	HS256Secret         string `mapstructure:"hs256_secret"`           // 密钥

	// RS256相关
	PrivateKeyPath string `mapstructure:"private_key_path"` // 私钥路径
	PublicKeyPath  string `mapstructure:"public_key_path"`  // 公钥路径
}

type JWT

type JWT struct {
	Cfg         Config
	HS256Secret []byte
	PublicKey   *rsa.PublicKey
	PrivateKey  *rsa.PrivateKey
}

func NewJWT

func NewJWT(cfg *Config) (*JWT, error)

func (*JWT) DecodeHS256Token

func (j *JWT) DecodeHS256Token(token string) (*Claims, error)

func (*JWT) DecodeRS256Token

func (j *JWT) DecodeRS256Token(token string) (*Claims, error)

func (*JWT) DecodeTokenUnverified

func (j *JWT) DecodeTokenUnverified(token string) (*Claims, error)

func (*JWT) GenHS256Token

func (j *JWT) GenHS256Token(payload string, kvs map[string]interface{}) (string, error)

func (*JWT) GenRS256Token

func (j *JWT) GenRS256Token(payload string, kvs map[string]interface{}) (string, error)