jwt

Documentation

Index

• Variables
• type Claims
• type Jwt
  • func NewJwt(opts ...Option) *Jwt
  • func (j *Jwt) Generate(memberId, role string) (string, error)
  • func (j *Jwt) Parse(jwtToken string) (*Claims, error)
• type Option
  • func WithAudience(audience []string) Option
  • func WithExpiresTime(expiresTime int64) Option
  • func WithIssuer(issuer string) Option
  • func WithSigningKey(signingKey string) Option
  • func WithSigningMethod(signingMethod jwt.SigningMethod) Option
• type Options

Variables

var (
	ErrMissingJwtToken        = errors.New("JWT token is missing")
	ErrTokenInvalid           = errors.New("JWT token is invalid")
	ErrTokenExpired           = errors.New("JWT token is expired")
	ErrTokenParseFail         = errors.New("fail to parse JWT token")
	ErrUnSupportSigningMethod = errors.New("unsupported signing method")
)

Types

type Claims

type Claims struct {
	Role string `json:"role"`
	jwt.RegisteredClaims
}

type Jwt

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

func NewJwt

func NewJwt(opts ...Option) *Jwt

func (*Jwt) Generate

func (j *Jwt) Generate(memberId, role string) (string, error)

func (*Jwt) Parse

func (j *Jwt) Parse(jwtToken string) (*Claims, error)

type Option

type Option interface {
	Apply(*Options)
}

func WithAudience

func WithAudience(audience []string) Option

func WithExpiresTime

func WithExpiresTime(expiresTime int64) Option

func WithIssuer

func WithIssuer(issuer string) Option

func WithSigningKey

func WithSigningKey(signingKey string) Option

func WithSigningMethod

func WithSigningMethod(signingMethod jwt.SigningMethod) Option

type Options

type Options struct {
	SigningMethod jwt.SigningMethod
	SigningKey    []byte        // 秘钥
	ExpiresTime   time.Duration // token有效时长（s）
	Issuer        string        // 用于标识JWT的发行者，可以是一个URI或者服务器的名称。
	Audience      []string      // aud用于标识JWT的预期接收者，可以是一个或多个实体。
}