tokenpkg

package
v0.0.0-...-e6e2e8d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2023 License: GPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package tokenpkg implements common token makers.

Package tokenpkg is a generated GoMock package.

Index

Constants

This section is empty.

Variables

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

Different types of error returned by the VerifyToken function.

Functions

This section is empty.

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(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(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.

func NewPasetoMaker

func NewPasetoMaker(symmetricKey string) (Maker, error)

NewPasetoMaker creates a new PasetoMaker.

type MockMaker

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

MockMaker is a mock of Maker interface.

func NewMockMaker

func NewMockMaker(ctrl *gomock.Controller) *MockMaker

NewMockMaker creates a new mock instance.

func (*MockMaker) CreateToken

func (m *MockMaker) CreateToken(username string, duration time.Duration) (string, *Payload, error)

CreateToken mocks base method.

func (*MockMaker) EXPECT

func (m *MockMaker) EXPECT() *MockMakerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockMaker) VerifyToken

func (m *MockMaker) VerifyToken(token string) (*Payload, error)

VerifyToken mocks base method.

type MockMakerMockRecorder

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

MockMakerMockRecorder is the mock recorder for MockMaker.

func (*MockMakerMockRecorder) CreateToken

func (mr *MockMakerMockRecorder) CreateToken(username, duration interface{}) *gomock.Call

CreateToken indicates an expected call of CreateToken.

func (*MockMakerMockRecorder) VerifyToken

func (mr *MockMakerMockRecorder) VerifyToken(token interface{}) *gomock.Call

VerifyToken indicates an expected call of VerifyToken.

type PasetoMaker

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

PasetoMaker is a PASETO token maker.

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"`
	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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL