lockout

Documentation

Overview

Package lockout locks accounts after consecutive login failures.

Index

• type Lockout
  • func New(failures int) *Lockout
  • func (l *Lockout) Failure(userName string) bool
  • func (l *Lockout) Locked(userName string) bool
  • func (l *Lockout) Success(userName string)

Types

type Lockout

type Lockout struct {
	// contains filtered or unexported fields
}

Lockout locks out accounts after consecutive login failures. A nil Lockout pointer means no account lock out.

func New

func New(failures int) *Lockout

New creates a New lockout instance. failures is the number of consecutive failures causing lockout. New panics if failures is less than 1. To disable lockout, use a nil pointer instead of calling New.

func (*Lockout) Failure

func (l *Lockout) Failure(userName string) bool

Failure indicates a login failure for given account. Failure returns true if that account is being locked because failure limit has just been reached.

func (*Lockout) Locked

func (l *Lockout) Locked(userName string) bool

Locked returns true if given account is locked.

func (*Lockout) Success

func (l *Lockout) Success(userName string)

Success indicates login success for given account and clears the number of consecutive failures for that account if account is not already locked.