token

Documentation

Index

• Variables
• type JWTMaker
  • func (maker *JWTMaker) CreateToken(uid, username string, duration time.Duration) (string, *Payload, error)
  • func (maker *JWTMaker) VerifyToken(token string) (*Payload, error)
• type Maker
  • func NewJWTMaker(secretKey string) (Maker, error)
• type Payload
  • func NewPayload(uid, username string, duration time.Duration) (*Payload, error)
  • func (payload *Payload) Valid() error

Variables

var (
	ErrInvalidToken = errors.New("token is invalid")
	ErrExpiredToken = errors.New("token has expired")
)

Different types of error returned by the VerifyToken function

Types

type JWTMaker

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

JWTMaker is a JSON Web Token maker

func (*JWTMaker) CreateToken

func (maker *JWTMaker) CreateToken(uid, username string, duration time.Duration) (string, *Payload, error)

CreateToken creates a new token for a specific username and duration

func (*JWTMaker) VerifyToken

func (maker *JWTMaker) VerifyToken(token string) (*Payload, error)

VerifyToken checks if the token is valid or not

type Maker

type Maker interface {
	// CreateToken creates a new token for a specific username and duration
	CreateToken(uid, username string, duration time.Duration) (string, *Payload, error)

	// VerifyToken checks if the token is valid or not
	VerifyToken(token string) (*Payload, error)
}

Maker is an interface for managing tokens

func NewJWTMaker

func NewJWTMaker(secretKey string) (Maker, error)

NewJWTMaker creates a new JWTMaker

type Payload

type Payload struct {
	ID        uuid.UUID `json:"id"`
	UserID    string    `json:"uid"`
	Issuer    string    `json:"issuer"`
	Subject   string    `json:"username"`
	IssuedAt  time.Time `json:"issued_at"`
	ExpiredAt time.Time `json:"expired_at"`
}

Payload contains the payload data of the token

func NewPayload

func NewPayload(uid, username string, duration time.Duration) (*Payload, error)

NewPayload creates a new token payload with a specific username and duration

func (*Payload) Valid

func (payload *Payload) Valid() error

Valid checks if the token payload is valid or not