token

Documentation

Index

• Variables
• func Generate(name env.Name, gen *rand.Generator) (string, error)
• func IsEnabled(cfg *Config) bool
• func Verify(name env.Name, token string) error
• type Config
  • func (c *Config) IsJWT() bool
  • func (c *Config) IsKey() bool
  • func (c *Config) IsPaseto() bool
  • func (c *Config) IsToken() bool
• type Generator
• type JWT
  • func NewJWT(kid KID, ed ed25519.Signer, gen id.Generator) *JWT
  • func (j *JWT) Generate(sub, aud, iss string, exp time.Duration) (string, error)
  • func (j *JWT) Verify(token, aud, iss string) (string, error)
• type KID
  • func NewKID(gen *rand.Generator) (KID, error)
• type Paseto
  • func NewPaseto(ed ed25519.Signer, gen id.Generator) *Paseto
  • func (p *Paseto) Generate(sub, aud, iss string, exp time.Duration) (string, error)
  • func (p *Paseto) Verify(token, aud, iss string) (string, error)
• type Token
  • func NewToken(cfg *Config, name env.Name, jwt *JWT, pas *Paseto) *Token
  • func (t *Token) Generate(ctx context.Context) (context.Context, []byte, error)
  • func (t *Token) Verify(ctx context.Context, token []byte) (context.Context, error)
• type Verifier

Variables

var (
	// ErrInvalidMatch for token.
	ErrInvalidMatch = errors.New("token: invalid match")

	// ErrInvalidIssuer for service.
	ErrInvalidIssuer = errors.New("token: invalid issuer")

	// ErrInvalidAudience for service.
	ErrInvalidAudience = errors.New("token: invalid audience")

	// ErrInvalidTime for service.
	ErrInvalidTime = errors.New("token: invalid time")
)

var Module = fx.Options(
	fx.Provide(NewKID),
	fx.Provide(NewJWT),
	fx.Provide(NewPaseto),
	fx.Provide(NewToken),
)

Module for fx.

Functions

func Generate

func Generate(name env.Name, gen *rand.Generator) (string, error)

Generate a token. The format is name_rand(64)_crc32(id).

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for token.

func Verify

func Verify(name env.Name, token string) error

Verify if the token matches the segments.

Types

type Config

type Config struct {
	Kind       string `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
	Secret     string `yaml:"secret,omitempty" json:"secret,omitempty" toml:"secret,omitempty"`
	Subject    string `yaml:"sub,omitempty" json:"sub,omitempty" toml:"sub,omitempty"`
	Audience   string `yaml:"aud,omitempty" json:"aud,omitempty" toml:"aud,omitempty"`
	Issuer     string `yaml:"iss,omitempty" json:"iss,omitempty" toml:"iss,omitempty"`
	Expiration string `yaml:"exp,omitempty" json:"exp,omitempty" toml:"exp,omitempty"`
}

Config for token.

func (*Config) IsJWT

func (c *Config) IsJWT() bool

IsJWT for configuration.

func (*Config) IsKey

func (c *Config) IsKey() bool

IsKey for configuration.

func (*Config) IsPaseto

func (c *Config) IsPaseto() bool

IsPaseto for configuration.

func (*Config) IsToken

func (c *Config) IsToken() bool

IsToken for configuration.

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 JWT

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

JWT token.

func NewJWT

func NewJWT(kid KID, ed ed25519.Signer, gen id.Generator) *JWT

NewJWT token.

func (*JWT) Generate

func (j *JWT) Generate(sub, aud, iss string, exp time.Duration) (string, error)

Generate JWT token.

func (*JWT) Verify

func (j *JWT) Verify(token, aud, iss string) (string, error)

Verify JWT token.

type KID

type KID string

KID is a key ID.

func NewKID

func NewKID(gen *rand.Generator) (KID, error)

NewKID for JWKSets.

type Paseto

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

Paseto token.

func NewPaseto

func NewPaseto(ed ed25519.Signer, gen id.Generator) *Paseto

NewPaseto token.

func (*Paseto) Generate

func (p *Paseto) Generate(sub, aud, iss string, exp time.Duration) (string, error)

Generate Paseto token.

func (*Paseto) Verify

func (p *Paseto) Verify(token, aud, iss string) (string, error)

Verify Paseto token.

type Token

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

Token will generate and verify based on what is defined in the config.

func NewToken

func NewToken(cfg *Config, name env.Name, jwt *JWT, pas *Paseto) *Token

NewToken based on config.

func (*Token) Generate

func (t *Token) Generate(ctx context.Context) (context.Context, []byte, error)

func (*Token) Verify

func (t *Token) Verify(ctx context.Context, token []byte) (context.Context, error)

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.