lockout

package

v0.0.0-...-1fb332c Latest Latest Go to latest Published: Mar 24, 2026 License: Apache-2.0 Imports: 12 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/authgear/authgear-server

Links

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 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)

Constants ¶

This section is empty.

Variables ¶

View Source

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

View Source

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

View Source

var ServiceLogger = slogutil.NewLogger("lockout")

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 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 {
	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)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL