recover

Documentation

Overview

Package recover implements password reset via e-mail.

Index

• Constants
• type Recover
  • func (r *Recover) Initialize(ab *authboss.Authboss) (err error)
  • func (r *Recover) Routes() authboss.RouteTable
  • func (r *Recover) Storage() authboss.StorageOptions
• type RecoverStorer

Constants

const (
	StoreRecoverToken       = "recover_token"
	StoreRecoverTokenExpiry = "recover_token_expiry"
)

Storage constants

Types

type Recover

type Recover struct {
	*authboss.Authboss
	// contains filtered or unexported fields
}

Recover module

func (*Recover) Initialize

func (r *Recover) Initialize(ab *authboss.Authboss) (err error)

Initialize module

func (*Recover) Routes

func (r *Recover) Routes() authboss.RouteTable

Routes for module

func (*Recover) Storage

func (r *Recover) Storage() authboss.StorageOptions

Storage requirements

type RecoverStorer

type RecoverStorer interface {
	authboss.Storer
	// RecoverUser looks a user up by a recover token. See recover module for
	// attribute names. If the key is not found in the data store,
	// simply return nil, ErrUserNotFound.
	RecoverUser(recoverToken string) (interface{}, error)
}

RecoverStorer must be implemented in order to satisfy the recover module's storage requirements.