jwt

Documentation

Index

• type Claims
  • func (c Claims) Valid() error
• type Payload
  • func (p *Payload) AddScopes(scopes ...string)
  • func (p Payload) HasScope(scope string) bool
• type Signer
  • func NewSigner(filename, keyId string) (*Signer, error)
  • func (s *Signer) Sign(claims *Claims) (string, error)
• type Verifier
  • func NewVerifier(filename, keyId string) (*Verifier, error)
  • func (v *Verifier) Verify(issuer, token string) (*Claims, error)

Types

type Claims

type Claims struct {
	jwt.StandardClaims
	Payload
}

Claims represents all the fields of jwt

func (Claims) Valid

func (c Claims) Valid() error

Valid checks whether the claims is valid

type Payload

type Payload struct {
	Salt   string   `json:"salt,omitempty"`
	Ver    string   `json:"ver,omitempty"`
	Uid    int64    `json:"uid,omitempty"`
	IP     string   `json:"ip,omitempty"`
	Loc    string   `json:"loc,omitempty"`
	Chan   int      `json:"chan,omitempty"`
	Os     string   `json:"os,omitempty"`
	Flags  int64    `json:"flags,omitempty"`
	Scopes []string `json:"scopes,omitempty"`

	Name   string `json:"name,omitempty"`
	Avatar string `json:"avatar,omitempty"`
	Gender int    `json:"gender,omitempty"`

	Accounts map[string]string `json:"accounts"`
}

Payload holds the custom fields of jwt

func (*Payload) AddScopes

func (p *Payload) AddScopes(scopes ...string)

AddScopes appends a score

func (Payload) HasScope

func (p Payload) HasScope(scope string) bool

HasScope checks whether the payload has specified scope

type Signer

type Signer struct {
	Verifier
	// contains filtered or unexported fields
}

Signer

func NewSigner

func NewSigner(filename, keyId string) (*Signer, error)

func (*Signer) Sign

func (s *Signer) Sign(claims *Claims) (string, error)

Sign signs the claims as a token string

type Verifier

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

Verifier ...

func NewVerifier

func NewVerifier(filename, keyId string) (*Verifier, error)

func (*Verifier) Verify

func (v *Verifier) Verify(issuer, token string) (*Claims, error)