authguard

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

type BindType int

type LogHandlerFunc func(message string, lvl LogLevelType)

type LogLevelType int

type Options struct {
	// Attempts - the number of password attempts.
	Attempts int

	// LockoutDuration - lock duration after the end of password attempts.
	// Seconds.
	LockoutDuration int

	// MaxLockouts - the maximum amount of lockouts, before ban.
	MaxLockouts int

	// BanDuration - duration of ban.
	// Seconds.
	BanDuration int

	// AttemptsResetDuration - time after which to reset the number of attempts.
	// Seconds.
	AttemptsResetDuration int

	// LockoutsResetDuration - time after which to reset the number of lockouts.
	LockoutsResetDuration int

	// BindMethod - visitor binding type. Only IP or IP + username.
	BindMethod BindType

	// SyncAfter - sync data with the Store file after X updates.
	SyncAfter int

	// Store - place for store user data.
	// Filepath.
	//
	// If Store == "::memory::", then Gelada does not place the data in the file
	// and store everything in memory.
	Store string

	// Exceptions - Hosts(IP) whitelist.
	Exceptions []string

	// LogLevel provides the opportunity to choose the level of
	// information messages.
	// Each level includes the messages from the previous level,
	// except LogLevelErrorOnly.
	// LogLevelNone       - no messages // 0
	// LogLevelInfo       - info        // 1
	// LogLevelError      - error       // 2
	// LogLevelErrorOnly  - only errors // 3
	//
	// Default: LogLevelNone.
	LogLevel LogLevelType

	// LogDestination provides the opportunity to choose the own
	// destination for log messages (errors, info, etc).
	//
	// Default: 'os.Stdout'.
	LogDestination io.Writer

	// LogHandler takes log messages to bypass the internal
	// mechanism of the message processing
	//
	// If LogHandler is selected - all log settings will be ignored.
	LogHandler LogHandlerFunc

	// ProxyIPHeaderName - http header name for handle user IP behind proxy
	ProxyIPHeaderName string
}

type Visitor struct {
	Username  string
	Host      string
	UserAgent string

	Attempts int
	Lockouts int

	Ban bool

	ResetAttemptsAfter time.Time
	ResetLockoutsAfter time.Time
	LockUntil          time.Time
	// contains filtered or unexported fields
}