token

Documentation

Index

• Variables
• type JWTMaker
  • func (maker *JWTMaker) CreateToken(userID int64, 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(userID int64, username string, duration time.Duration) (string, *Payload, error)
  • func (maker *PasetoMaker) VerifyToken(token string) (*Payload, error)
• type Payload
  • func NewPayload(userID int64, username string, duration time.Duration, ...) (*Payload, error)
  • func (p *Payload) Valid() error

Variables

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

Different type 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(userID int64, 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 user id, username and duration
	CreateToken(userID int64, 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)

func NewPasetoMaker

func NewPasetoMaker(symmetricKey string) (Maker, error)

type PasetoMaker

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

PasetoMaker is a PASETO token maker.

func (*PasetoMaker) CreateToken

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

CreateToken creates a new token for a specific user id, 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"`
	UserID    int64                  `json:"user_id"`
	IssuedAt  time.Time              `json:"issued_at"`
	ExpiredAt time.Time              `json:"expired_at"`
	Others    map[string]interface{} `json:"-"`
}

Payload contains the payload data of token.

func NewPayload

func NewPayload(userID int64, username string, duration time.Duration, others ...map[string]interface{}) (*Payload, error)

NewPayload creates a new token payload with a specific user id, username and duration. And can add custom other data in payload if you need

func (*Payload) Valid

func (p *Payload) Valid() error