lockout

Documentation

Index

• Variables
• func NewErrLocked(until time.Time) error
• type LockoutSpec
  • func NewAccountAuthenticationSpecForAttempt(cfg *config.AuthenticationLockoutConfig, userID string, ...) LockoutSpec
  • func NewAccountAuthenticationSpecForCheck(cfg *config.AuthenticationLockoutConfig, userID string) LockoutSpec
  • func (s LockoutSpec) Key() string
• type Logger
  • func NewLogger(lf *log.Factory) Logger
• type MakeAttemptResult
  • func (m *MakeAttemptResult) ErrorIfLocked() error
• type Service
  • func (s *Service) ClearAttempts(ctx context.Context, spec LockoutSpec, contributor string) error
  • func (s *Service) MakeAttempts(ctx context.Context, spec LockoutSpec, contributor string, attempts int) (result *MakeAttemptResult, err error)
• type Storage
• type StorageRedis
  • func (s StorageRedis) Clear(ctx context.Context, spec LockoutSpec, contributor string) (err error)
  • func (s StorageRedis) Update(ctx context.Context, spec LockoutSpec, contributor string, delta int) (isSuccess bool, lockedUntil *time.Time, err error)

Variables

var DependencySet = wire.NewSet(
	NewLogger,
	wire.Struct(new(StorageRedis), "*"),
	wire.Struct(new(Service), "*"),
	wire.Bind(new(Storage), new(*StorageRedis)),
)

var ErrLocked = apierrors.TooManyRequest.WithReason("AccountLockout")

Functions

func NewErrLocked

func NewErrLocked(until time.Time) error

Types

type LockoutSpec

type LockoutSpec struct {
	Name      string
	Arguments []string

	Enabled         bool
	MaxAttempts     int
	HistoryDuration time.Duration
	MinimumDuration time.Duration
	MaximumDuration time.Duration
	BackoffFactor   float64
	IsGlobal        bool
}

func NewAccountAuthenticationSpecForAttempt

func NewAccountAuthenticationSpecForAttempt(cfg *config.AuthenticationLockoutConfig, userID string, methods []config.AuthenticationLockoutMethod) LockoutSpec

func NewAccountAuthenticationSpecForCheck

func NewAccountAuthenticationSpecForCheck(cfg *config.AuthenticationLockoutConfig, userID string) LockoutSpec

func (LockoutSpec) Key

func (s LockoutSpec) Key() string

type Logger

type Logger struct{ *log.Logger }

func NewLogger

func NewLogger(lf *log.Factory) Logger

type MakeAttemptResult

type MakeAttemptResult struct {
	LockedUntil *time.Time
	// contains filtered or unexported fields
}

func (*MakeAttemptResult) ErrorIfLocked

func (m *MakeAttemptResult) ErrorIfLocked() error

type Service

type Service struct {
	Logger  Logger
	Storage Storage
}

func (*Service) ClearAttempts

func (s *Service) ClearAttempts(ctx context.Context, spec LockoutSpec, contributor string) error

func (*Service) MakeAttempts

func (s *Service) MakeAttempts(ctx context.Context, spec LockoutSpec, contributor string, attempts int) (result *MakeAttemptResult, err error)

type Storage

type Storage interface {
	Update(ctx context.Context, spec LockoutSpec, contributor string, delta int) (isSuccess bool, lockedUntil *time.Time, err error)
	Clear(ctx context.Context, spec LockoutSpec, contributor string) error
}

type StorageRedis

type StorageRedis struct {
	AppID config.AppID
	Redis *appredis.Handle
}

func (StorageRedis) Clear

func (s StorageRedis) Clear(ctx context.Context, spec LockoutSpec, contributor string) (err error)

func (StorageRedis) Update

func (s StorageRedis) Update(ctx context.Context, spec LockoutSpec, contributor string, delta int) (isSuccess bool, lockedUntil *time.Time, err error)