maker

package

v0.0.0-...-ac0e98d Latest Latest Go to latest Published: Feb 23, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dudakovict/gotify

Links

Open Source Insights

Documentation ¶

Overview ¶

Package maker provides an interface and related functionality for token creation and verification.

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

View Source

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

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(userID uuid.UUID, roles []string, duration time.Duration) (string, *Payload, error)

CreateToken creates a new token for specific userID 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(id uuid.UUID, roles []string, duration time.Duration) (string, *Payload, error)
	VerifyToken(token string) (*Payload, error)
}

Maker is the interface that defines methods for creating and verifying 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 PasetoMaker ¶

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

PasetoMaker is a PASETO token maker

func (*PasetoMaker) CreateToken ¶

func (maker *PasetoMaker) CreateToken(userID uuid.UUID, roles []string, duration time.Duration) (string, *Payload, error)

CreateToken creates a new token for specific userID 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
	UserID    uuid.UUID
	Roles     []string
	IssuedAt  time.Time
	ExpiresAt time.Time
}

Payload represents the information stored within a token.

func NewPayload ¶

func NewPayload(userID uuid.UUID, roles []string, duration time.Duration) (*Payload, error)

NewPayload creates a new Payload.

func (*Payload) Valid ¶

func (p *Payload) Valid() error

Valid checks if the token is still valid.

Source Files ¶

View all Source files

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