lock

Documentation

Overview

Package lock implements user locking after N bad sign-in attempts.

Index

• Constants
• type Lock
  • func (l *Lock) Initialize(ab *authboss.Authboss) error
  • func (l *Lock) Lock(key string) error
  • func (l *Lock) Routes() authboss.RouteTable
  • func (l *Lock) Storage() authboss.StorageOptions
  • func (l *Lock) Unlock(key string) error

Constants

const (
	StoreAttemptNumber = "attempt_number"
	StoreAttemptTime   = "attempt_time"
	StoreLocked        = "locked"
)

Storage key constants

Types

type Lock

type Lock struct {
	*authboss.Authboss
}

Lock module

func (*Lock) Initialize

func (l *Lock) Initialize(ab *authboss.Authboss) error

Initialize the module

func (*Lock) Lock

func (l *Lock) Lock(key string) error

Lock a user manually.

func (*Lock) Routes

func (l *Lock) Routes() authboss.RouteTable

Routes for the module

func (*Lock) Storage

func (l *Lock) Storage() authboss.StorageOptions

Storage requirements

func (*Lock) Unlock

func (l *Lock) Unlock(key string) error

Unlock a user that was locked by this module.