auth

Documentation

Overview

Package auth provides authentication and authorization capability

Index

• func Metadata(md map[string]string) func(o *GenerateOptions)
• func Roles(rs []*Role) func(o *GenerateOptions)
• type Account
• type Auth
• type GenerateOption
• type GenerateOptions
  • func NewGenerateOptions(opts ...GenerateOption) GenerateOptions
• type Option
  • func Excludes(excludes ...string) Option
  • func PrivateKey(key string) Option
  • func PublicKey(key string) Option
• type Options
• type Resource
• type Role

Functions

func Metadata

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

Metadata for the generated account

func Roles

func Roles(rs []*Role) func(o *GenerateOptions)

Roles for the generated account

Types

type Account

type Account struct {
	// ID of the account (UUID or email)
	Id string `json: "id"`
	// Token used to authenticate
	Token string `json: "token"`
	// Time of Account creation
	Created time.Time `json:"created"`
	// Time of Account expiry
	Expiry time.Time `json:"expiry"`
	// Roles associated with the Account
	Roles []*Role `json:"roles"`
	// Any other associated metadata
	Metadata map[string]string `json:"metadata"`
}

Account provided by an auth provider

type Auth

type Auth interface {
	// String to identify the package
	String() string
	// Init the auth package
	Init(opts ...Option) error
	// Options returns the options set
	Options() Options
	// Generate a new auth Account
	Generate(id string, opts ...GenerateOption) (*Account, error)
	// Revoke an authorization Account
	Revoke(token string) error
	// Validate an account token
	Validate(token string) (*Account, error)
}

Auth providers authentication and authorization

var (
	DefaultAuth Auth = new(noop)
)

type GenerateOption

type GenerateOption func(o *GenerateOptions)

type GenerateOptions

type GenerateOptions struct {
	Metadata map[string]string
	Roles    []*Role
}

func NewGenerateOptions

func NewGenerateOptions(opts ...GenerateOption) GenerateOptions

NewGenerateOptions from a slice of options

type Option

type Option func(o *Options)

func Excludes

func Excludes(excludes ...string) Option

Excludes endpoints from auth

func PrivateKey

func PrivateKey(key string) Option

PrivateKey is the JWT private key

func PublicKey

func PublicKey(key string) Option

PublicKey is the JWT public key

type Options

type Options struct {
	PublicKey  []byte
	PrivateKey []byte
	Excludes   []string
}

type Resource

type Resource struct {
	// Name of the resource
	Name string
	// Type of resource, e.g.
	Type string
}

Resource is an entity such as a user or

type Role

type Role struct {
	Name     string
	Resource *Resource
}

Role an account has