mfa

Documentation

Index

• Variables
• func RegisterProviderFactory(factory ProviderFactory)
• func SetupWithOptions(p cache.Interface, opts *Options) error
• type Options
  • func NewOptions() *Options
  • func (a *Options) AddFlags(fs *pflag.FlagSet)
  • func (a *Options) Validate() []error
• type Provider
  • func GetProvider(providerType string) (Provider, error)
• type ProviderFactory
• type ProviderOptions
• type UserMFAProvider

Variables

var (
	ErrProviderNotFound = fmt.Errorf("provider not found")
)

Functions

func RegisterProviderFactory

func RegisterProviderFactory(factory ProviderFactory)

func SetupWithOptions

func SetupWithOptions(p cache.Interface, opts *Options) error

Types

type Options

type Options struct {
	Enabled      bool              `json:"enabled" yaml:"enabled"`
	MFAProviders []ProviderOptions `json:"mfaProviders" yaml:"mfaProviders"`
}

func NewOptions

func NewOptions() *Options

func (*Options) AddFlags

func (a *Options) AddFlags(fs *pflag.FlagSet)

func (*Options) Validate

func (a *Options) Validate() []error

type Provider

type Provider interface {
	Verify(req url.Values, info user.Info) error
	Request(info user.Info) error
	UserProviderConfig(info user.Info, token string) UserMFAProvider
}

func GetProvider

func GetProvider(providerType string) (Provider, error)

type ProviderFactory

type ProviderFactory interface {
	Type() string
	Create(cache cache.Interface, options oauth.DynamicOptions) (Provider, error)
}

type ProviderOptions

type ProviderOptions struct {
	Type    string               `json:"type" yaml:"type"`
	Options oauth.DynamicOptions `json:"options" yaml:"options"`
}

type UserMFAProvider

type UserMFAProvider struct {
	Type  string `json:"type,omitempty"`
	Token string `json:"token,omitempty"`
	Value string `json:"value,omitempty"`
}