token

Documentation

Index

• Variables
• type Authenticator
  • func NewJWTAuthenticator(secretKey string) (Authenticator, error)
  • func NewPasetoAuthenticator(symmetricKey string) (Authenticator, error)
• type JWTAuthenticator
  • func (j *JWTAuthenticator) CreateToken(username string, duration time.Duration) (string, *Payload, error)
  • func (j *JWTAuthenticator) VerifyToken(token string) (*Payload, error)
• type PasetoAuthenticator
  • func (p PasetoAuthenticator) CreateToken(username string, duration time.Duration) (string, *Payload, error)
  • func (p PasetoAuthenticator) 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 funciton

Types

type Authenticator

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

	VerifyToken(token string) (*Payload, error)
}

func NewJWTAuthenticator

func NewJWTAuthenticator(secretKey string) (Authenticator, error)

func NewPasetoAuthenticator

func NewPasetoAuthenticator(symmetricKey string) (Authenticator, error)

type JWTAuthenticator

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

JWTAuthenticator is a JSON web token authenticator

func (*JWTAuthenticator) CreateToken

func (j *JWTAuthenticator) CreateToken(username string, duration time.Duration) (string, *Payload, error)

CreateToken implements Authenticator.

func (*JWTAuthenticator) VerifyToken

func (j *JWTAuthenticator) VerifyToken(token string) (*Payload, error)

VerifyToken implements Authenticator.

type PasetoAuthenticator

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

PasetoAuthenticator is a PASETO token

func (PasetoAuthenticator) CreateToken

func (p PasetoAuthenticator) CreateToken(username string, duration time.Duration) (string, *Payload, error)

CreateToken creates a new token for a specific username and duration

func (PasetoAuthenticator) VerifyToken

func (p PasetoAuthenticator) 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"`
	IssuedAt  time.Time `json:"issued_at"`
	ExpiredAt time.Time `json:"expired_at"`
}

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