auth

Documentation

Index

• type Claims
• type Verifier
  • func New() *Verifier
  • func (v *Verifier) Claims(token string) (c Claims, err error)
  • func (v *Verifier) CreateToken(userID, tokenID xid.ID, isAdmin bool, isAPIToken bool, isWriteToken bool) (token string, err error)

Types

type Claims

type Claims struct {
	UserID      xid.ID `json:"sub"`
	TokenID     xid.ID `json:"jti"`
	UserIsAdmin bool   `json:"adm"`

	// APIToken specifies whether this token was generated for the API or for the website.
	// API tokens cannot perform some destructive actions, such as DELETE /users/@me.
	APIToken bool `json:"atn"`
	// TokenWrite specifies whether this token can be used for write actions.
	// If set to false, this token can only be used for read actions.
	TokenWrite bool `json:"twr"`

	jwt.RegisteredClaims
}

Claims are the claims used in a token.

type Verifier

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

func New

func New() *Verifier

func (*Verifier) Claims

func (v *Verifier) Claims(token string) (c Claims, err error)

Claims parses the given token and returns its Claims. If the token is invalid, returns an error.

func (*Verifier) CreateToken

func (v *Verifier) CreateToken(userID, tokenID xid.ID, isAdmin bool, isAPIToken bool, isWriteToken bool) (token string, err error)

CreateToken creates a token for the given user ID. It expires after three months.