regulation

Documentation

Index

• Constants
• Variables
• func FormatExpiresLong(expires *time.Time) string
• func FormatExpiresShort(expires sql.NullTime) string
• type Ban
  • func NewBan(ban BanType, value string, expires *time.Time) *Ban
  • func (b *Ban) Expires() *time.Time
  • func (b *Ban) FormatExpires() string
  • func (b *Ban) IsBanned() bool
  • func (b *Ban) Type() BanType
  • func (b *Ban) Value() string
• type BanType
• type Context
• type MetricsRecorder
• type Regulator
  • func NewRegulator(config schema.Regulation, store storage.RegulatorProvider, ...) *Regulator
  • func (r *Regulator) BanCheck(ctx Context, username string) (ban BanType, value string, expires *time.Time, err error)
  • func (r *Regulator) HandleAttempt(ctx Context, successful, banned bool, ...)

Constants

const (
	// AuthType1FA is the string representing an auth log for first-factor authentication.
	AuthType1FA = "1FA"

	// AuthTypePasskey is the string representing an auth log for first-factor passkey authentication.
	AuthTypePasskey = "Passkey"

	// AuthTypeTOTP is the string representing an auth log for second-factor authentication via TOTP.
	AuthTypeTOTP = "TOTP"

	// AuthTypeWebAuthn is the string representing an auth log for second-factor authentication via FIDO2/CTAP2/WebAuthn.
	AuthTypeWebAuthn = "WebAuthn"

	// AuthTypeDuo is the string representing an auth log for second-factor authentication via DUO.
	AuthTypeDuo = "Duo"

	// AuthTypePassword is the string representing an auth log for second-factor authentication via a Password.
	AuthTypePassword = "Password"
)

Variables

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

ErrUserIsBanned user is banned error message.

Functions

func FormatExpiresLong

func FormatExpiresLong(expires *time.Time) string

func FormatExpiresShort

func FormatExpiresShort(expires sql.NullTime) string

Types

type Ban

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

func NewBan

func NewBan(ban BanType, value string, expires *time.Time) *Ban

NewBan constructs a friendly version of ban information for easy formatting.

func (*Ban) Expires

func (b *Ban) Expires() *time.Time

func (*Ban) FormatExpires

func (b *Ban) FormatExpires() string

func (*Ban) IsBanned

func (b *Ban) IsBanned() bool

func (*Ban) Type

func (b *Ban) Type() BanType

func (*Ban) Value

func (b *Ban) Value() string

type BanType

type BanType int

const (
	BanTypeNone BanType = iota
	BanTypeIP
	BanTypeUser
)

type Context

type Context interface {
	context.Context
	MetricsRecorder

	GetLogger() *logrus.Entry
	RemoteIP() (ip net.IP)
}

Context represents a regulator context.

type MetricsRecorder

type MetricsRecorder interface {
	RecordAuthn(success, banned bool, authType string)
}

MetricsRecorder represents the methods used to record regulation.

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(config schema.Regulation, store storage.RegulatorProvider, clock clock.Provider) *Regulator

NewRegulator create a regulator instance.

func (*Regulator) BanCheck

func (r *Regulator) BanCheck(ctx Context, username string) (ban BanType, value string, expires *time.Time, err error)

func (*Regulator) HandleAttempt

func (r *Regulator) HandleAttempt(ctx Context, successful, banned bool, username, requestURI, requestMethod, authType string)