modules

Documentation

Index

• func RegisterModule(mt string, constructor func(BaseAuthModule) AuthModule)
• type AuthModule
  • func GetAuthModule(mi state.FlowStateModuleInfo, req *http.Request, w http.ResponseWriter) (AuthModule, error)
• type BaseAuthModule
  • func (b BaseAuthModule) ValidateCallbacks(cbs []callbacks.Callback) error
• type Credentials
  • func (cm *Credentials) PostProcess(fs *state.FlowState) error
  • func (cm *Credentials) Process(s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (cm *Credentials) ProcessCallbacks(inCbs []callbacks.Callback, s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (cm *Credentials) ValidateCallbacks(cbs []callbacks.Callback) error
• type Field
• type Hydra
  • func (h *Hydra) PostProcess(fs *state.FlowState) error
  • func (h *Hydra) Process(_ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (h *Hydra) ProcessCallbacks(_ []callbacks.Callback, s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (h *Hydra) ValidateCallbacks(cbs []callbacks.Callback) error
• type Kerberos
  • func (k *Kerberos) PostProcess(_ *state.FlowState) error
  • func (k *Kerberos) Process(fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (k *Kerberos) ProcessCallbacks(_ []callbacks.Callback, _ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (k *Kerberos) ValidateCallbacks(cbs []callbacks.Callback) error
• type LoginPassword
  • func (lm *LoginPassword) PostProcess(_ *state.FlowState) error
  • func (lm *LoginPassword) Process(_ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (lm *LoginPassword) ProcessCallbacks(inCbs []callbacks.Callback, fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (lm *LoginPassword) ValidateCallbacks(cbs []callbacks.Callback) error
• type OTP
  • func (lm *OTP) PostProcess(_ *state.FlowState) error
  • func (lm *OTP) Process(fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (lm *OTP) ProcessCallbacks(inCbs []callbacks.Callback, fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (lm *OTP) ValidateCallbacks(cbs []callbacks.Callback) error
• type QR
  • func (q *QR) PostProcess(_ *state.FlowState) error
  • func (q *QR) Process(lss *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (q *QR) ProcessCallbacks(_ []callbacks.Callback, lss *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (q *QR) ValidateCallbacks(_ []callbacks.Callback) error
• type Registration
  • func (rm *Registration) PostProcess(_ *state.FlowState) error
  • func (rm *Registration) Process(_ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (rm *Registration) ProcessCallbacks(inCbs []callbacks.Callback, fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
  • func (rm *Registration) ValidateCallbacks(cbs []callbacks.Callback) error

Functions

func RegisterModule

func RegisterModule(mt string, constructor func(BaseAuthModule) AuthModule)

Types

type AuthModule

type AuthModule interface {
	Process(s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
	ProcessCallbacks(inCbs []callbacks.Callback, s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)
	ValidateCallbacks(cbs []callbacks.Callback) error
	PostProcess(fs *state.FlowState) error
}

func GetAuthModule

func GetAuthModule(mi state.FlowStateModuleInfo, req *http.Request, w http.ResponseWriter) (AuthModule, error)

type BaseAuthModule

type BaseAuthModule struct {
	Properties map[string]interface{}
	Callbacks  []callbacks.Callback
	State      map[string]interface{}
	// contains filtered or unexported fields
}

func (BaseAuthModule) ValidateCallbacks

func (b BaseAuthModule) ValidateCallbacks(cbs []callbacks.Callback) error

type Credentials

type Credentials struct {
	BaseAuthModule
	PrimaryField     Field
	AdditionalFields []Field
	// contains filtered or unexported fields
}

func (*Credentials) PostProcess

func (cm *Credentials) PostProcess(fs *state.FlowState) error

func (*Credentials) Process

func (cm *Credentials) Process(s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Credentials) ProcessCallbacks

func (cm *Credentials) ProcessCallbacks(inCbs []callbacks.Callback, s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Credentials) ValidateCallbacks

func (cm *Credentials) ValidateCallbacks(cbs []callbacks.Callback) error

type Field

type Field struct {
	Name       string
	Prompt     string
	Required   bool
	Validation string
}

type Hydra

type Hydra struct {
	BaseAuthModule
	URI string // hydra URI
	// contains filtered or unexported fields
}

Hydra ORY Hydra authentication module

func (*Hydra) PostProcess

func (h *Hydra) PostProcess(fs *state.FlowState) error

func (*Hydra) Process

func (h *Hydra) Process(_ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Hydra) ProcessCallbacks

func (h *Hydra) ProcessCallbacks(_ []callbacks.Callback, s *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Hydra) ValidateCallbacks

func (h *Hydra) ValidateCallbacks(cbs []callbacks.Callback) error

type Kerberos

type Kerberos struct {
	BaseAuthModule
	// contains filtered or unexported fields
}

func (*Kerberos) PostProcess

func (k *Kerberos) PostProcess(_ *state.FlowState) error

func (*Kerberos) Process

func (k *Kerberos) Process(fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Kerberos) ProcessCallbacks

func (k *Kerberos) ProcessCallbacks(_ []callbacks.Callback, _ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Kerberos) ValidateCallbacks

func (k *Kerberos) ValidateCallbacks(cbs []callbacks.Callback) error

type LoginPassword

type LoginPassword struct {
	BaseAuthModule
}

func (*LoginPassword) PostProcess

func (lm *LoginPassword) PostProcess(_ *state.FlowState) error

func (*LoginPassword) Process

func (lm *LoginPassword) Process(_ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*LoginPassword) ProcessCallbacks

func (lm *LoginPassword) ProcessCallbacks(inCbs []callbacks.Callback, fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*LoginPassword) ValidateCallbacks

func (lm *LoginPassword) ValidateCallbacks(cbs []callbacks.Callback) error

type OTP

type OTP struct {
	BaseAuthModule
	OtpLength          int
	UseLetters         bool
	UseDigits          bool
	OtpTimeoutSec      int
	OtpResendSec       int
	OtpRetryCount      int
	OtpMessageTemplate string
	OtpCheckMagicLink  bool
	// contains filtered or unexported fields
}

func (*OTP) PostProcess

func (lm *OTP) PostProcess(_ *state.FlowState) error

func (*OTP) Process

func (lm *OTP) Process(fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*OTP) ProcessCallbacks

func (lm *OTP) ProcessCallbacks(inCbs []callbacks.Callback, fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*OTP) ValidateCallbacks

func (lm *OTP) ValidateCallbacks(cbs []callbacks.Callback) error

type QR

type QR struct {
	BaseAuthModule
	// contains filtered or unexported fields
}

func (*QR) PostProcess

func (q *QR) PostProcess(_ *state.FlowState) error

func (*QR) Process

func (q *QR) Process(lss *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*QR) ProcessCallbacks

func (q *QR) ProcessCallbacks(_ []callbacks.Callback, lss *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*QR) ValidateCallbacks

func (q *QR) ValidateCallbacks(_ []callbacks.Callback) error

type Registration

type Registration struct {
	BaseAuthModule
	PrimaryField      Field
	UsePassword       bool
	UseRepeatPassword bool
	AdditionalFields  []Field
}

TODO add password format TODO add confirmation password callback

func (*Registration) PostProcess

func (rm *Registration) PostProcess(_ *state.FlowState) error

func (*Registration) Process

func (rm *Registration) Process(_ *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Registration) ProcessCallbacks

func (rm *Registration) ProcessCallbacks(inCbs []callbacks.Callback, fs *state.FlowState) (ms state.ModuleStatus, cbs []callbacks.Callback, err error)

func (*Registration) ValidateCallbacks

func (rm *Registration) ValidateCallbacks(cbs []callbacks.Callback) error