token

Documentation

Index

• Constants
• Variables
• func IsEnabled(cfg *Config) bool
• type Config
  • func (c *Config) IsJWT() bool
  • func (c *Config) IsOpaque() bool
  • func (c *Config) IsPaseto() bool
• type Generator
• type JWT
  • func NewJWT(kid KID, signer *ed25519.Signer, generator 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(cfg *Config) KID
• type Opaque
  • func NewOpaque(name env.Name, generator *rand.Generator) *Opaque
  • func (o *Opaque) Generate() string
  • func (o *Opaque) Verify(token string) error
• type Params
• type Paseto
  • func NewPaseto(signer *ed25519.Signer, generator 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(params Params) *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

Constants

const (
	// EmptyKID is the kid used when no kid is provided.
	EmptyKID = KID("")
)

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(NewOpaque),
	fx.Provide(NewToken),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for token.

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"`
	KeyID      string `yaml:"kid,omitempty" json:"kid,omitempty" toml:"kid,omitempty"`
}

Config for token.

func (*Config) IsJWT

func (c *Config) IsJWT() bool

IsJWT for configuration.

func (*Config) IsOpaque

func (c *Config) IsOpaque() bool

IsOpaque for configuration.

func (*Config) IsPaseto

func (c *Config) IsPaseto() bool

IsPaseto 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, signer *ed25519.Signer, generator 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(cfg *Config) KID

NewKID for JWKSets.

type Opaque

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

Opaque represents an opaque token.

func NewOpaque

func NewOpaque(name env.Name, generator *rand.Generator) *Opaque

NewOpaque creates a new opaque token.

func (*Opaque) Generate

func (o *Opaque) Generate() string

Generate generates a new opaque token.

func (*Opaque) Verify

func (o *Opaque) Verify(token string) error

Verify verifies an opaque token.

type Params

type Params struct {
	fx.In

	Config *Config
	JWT    *JWT
	Paseto *Paseto
	Opaque *Opaque
	Name   env.Name
}

Params for token.

type Paseto

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

Paseto token.

func NewPaseto

func NewPaseto(signer *ed25519.Signer, generator 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(params Params) *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.