token

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• type Config
• type Generator
• type Key
• type Tokenizer
  • func NewTokenizer(cfg *Config, algo argon2.Algo) Tokenizer
• type Verifier

Variables

var Module = fx.Options(
	fx.Provide(NewTokenizer),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled the config.

Types

type Config

type Config struct {
	Key  Key    `yaml:"key,omitempty" json:"key,omitempty" toml:"key,omitempty"`
	Hash string `yaml:"hash,omitempty" json:"hash,omitempty" toml:"hash,omitempty"`
}

Config for token.

type Generator

type Generator interface {
	// Generate a new token or error.
	Generate(ctx context.Context) (context.Context, []byte, error)
}

Generator allows the implementation of different types generators.

type Key

type Key string

Key for token.

type Tokenizer

type Tokenizer interface {
	Generator
	Verifier
}

Tokenizer will generate and verify.

func NewTokenizer

func NewTokenizer(cfg *Config, algo argon2.Algo) Tokenizer

NewTokenizer for token.

type Verifier

type Verifier interface {
	// Verify a token or error.
	Verify(ctx context.Context, token []byte) (context.Context, error)
}

Verifier allows the implementation of different types of verifiers.