token

Documentation

Index

• Variables
• type JWTMaker
  • func (maker *JWTMaker) CreateToken(username string, duration time.Duration) (string, *Payload, error)
  • func (maker *JWTMaker) VerifyToken(token string) (*Payload, error)
• type Maker
  • func NewJWTMaker(secretKey string) (Maker, error)
  • func NewPasetoMaker(symmetricKey string) (Maker, error)
• type PasetoMaker
  • func (maker *PasetoMaker) CreateToken(username string, duration time.Duration) (string, *Payload, error)
  • func (maker *PasetoMaker) VerifyToken(token string) (*Payload, error)
• type Payload
  • func NewPayload(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 JSON Web Token maker which implements the Maker struct

func (*JWTMaker) CreateToken

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

implementing the CreateToken and Verify token of the Maker interface

func (*JWTMaker) VerifyToken

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

type Maker

type Maker interface {
	// this function creates a new token for a specfic username and duration
	// returns a signed token string or an error
	// this method would create and sign a token based on a specific username
	// and signed duration
	CreateToken(username string, duration time.Duration) (string, *Payload, error)

	// function to verify token is valid or not
	// if valid the method would return the input data stored within
	// the body of the payload
	VerifyToken(token string) (*Payload, error)
}

Maker is an interface for managing tokens

func NewJWTMaker

func NewJWTMaker(secretKey string) (Maker, error)

func NewPasetoMaker

func NewPasetoMaker(symmetricKey string) (Maker, error)

type PasetoMaker

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

func (*PasetoMaker) CreateToken

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

CreateToken creates a new token for a specific username and duration

func (*PasetoMaker) VerifyToken

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

VerifyToken checks if the token is valid or not

type Payload

type Payload struct {
	ID        uuid.UUID `json:"id"`
	Username  string    `json:"username"`
	Role      string    `json:"role"`
	IssuedAt  time.Time `json:"issued_at"`
	ExpiredAt time.Time `json:"expired_at"`
}

Payload contains the payload data of the token

func NewPayload

func NewPayload(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