regulation

Documentation

Index

• Variables
• type Regulator
  • func NewRegulator(configuration *schema.RegulationConfiguration, provider storage.Provider, ...) *Regulator
  • func (r *Regulator) Mark(username string, successful bool) error
  • func (r *Regulator) Regulate(username string) (time.Time, error)

Variables

var ErrUserIsBanned = fmt.Errorf("user is banned")

ErrUserIsBanned user is banned error message.

Types

type Regulator

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

Regulator an authentication regulator preventing attackers to brute force the service.

func NewRegulator

func NewRegulator(configuration *schema.RegulationConfiguration, provider storage.Provider, clock utils.Clock) *Regulator

NewRegulator create a regulator instance.

func (*Regulator) Mark

func (r *Regulator) Mark(username string, successful bool) error

Mark mark an authentication attempt. We split Mark and Regulate in order to avoid timing attacks.

func (*Regulator) Regulate

func (r *Regulator) Regulate(username string) (time.Time, error)

Regulate regulate the authentication attempts for a given user. This method returns ErrUserIsBanned if the user is banned along with the time until when the user is banned.