token

Documentation

Index

• Variables
• func WithMetadata(md map[string]string) func(o *GenerateOptions)
• func WithNamespace(n string) func(o *GenerateOptions)
• func WithRoles(rs ...string) func(o *GenerateOptions)
• type GenerateOption
  • func WithExpiry(d time.Duration) GenerateOption
• type GenerateOptions
  • func NewGenerateOptions(opts ...GenerateOption) GenerateOptions
• type Option
  • func WithPrivateKey(key string) Option
  • func WithPublicKey(key string) Option
  • func WithStore(s store.Store) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Provider

Variables

var (
	// ErrNotFound is returned when a token cannot be found
	ErrNotFound = errors.New("token not found")
	// ErrEncodingToken is returned when the service encounters an error during encoding
	ErrEncodingToken = errors.New("error encoding the token")
	// ErrInvalidToken is returned when the token provided is not valid
	ErrInvalidToken = errors.New("invalid token provided")
)

Functions

func WithMetadata

func WithMetadata(md map[string]string) func(o *GenerateOptions)

WithMetadata for the token

func WithNamespace

func WithNamespace(n string) func(o *GenerateOptions)

WithNamespace for the token

func WithRoles

func WithRoles(rs ...string) func(o *GenerateOptions)

WithRoles for the token

Types

type GenerateOption

type GenerateOption func(o *GenerateOptions)

func WithExpiry

func WithExpiry(d time.Duration) GenerateOption

WithExpiry for the generated account's token expires

type GenerateOptions

type GenerateOptions struct {
	// Expiry for the token
	Expiry time.Duration
	// Metadata associated with the account
	Metadata map[string]string
	// Roles/scopes associated with the account
	Roles []string
	// Namespace the account belongs too
	Namespace string
}

func NewGenerateOptions

func NewGenerateOptions(opts ...GenerateOption) GenerateOptions

NewGenerateOptions from a slice of options

type Option

type Option func(o *Options)

func WithPrivateKey

func WithPrivateKey(key string) Option

WithPrivateKey sets the JWT private key

func WithPublicKey

func WithPublicKey(key string) Option

WithPublicKey sets the JWT public key

func WithStore

func WithStore(s store.Store) Option

WithStore sets the token providers store

type Options

type Options struct {
	// Store to persist the tokens
	Store store.Store
	// PublicKey base64 encoded, used by JWT
	PublicKey string
	// PrivateKey base64 encoded, used by JWT
	PrivateKey string
}

func NewOptions

func NewOptions(opts ...Option) Options

type Provider

type Provider interface {
	Generate(subject string, opts ...GenerateOption) (*auth.Token, error)
	Inspect(token string) (*auth.Token, error)
	String() string
}

Provider generates and inspects tokens