auth_login_phash

Documentation

Index

• Constants
• Variables
• func IsLoginError(err generic_error.Error) bool
• func Phash(password string, salt string) string
• type LoginDelay
• type LoginHandler
  • func New(users auth_session.WithAuthUserManager) *LoginHandler
  • func (l *LoginHandler) Config() interface{}
  • func (l *LoginHandler) ErrorDescriptions() map[string]string
  • func (l *LoginHandler) ErrorProtocolCodes() map[string]int
  • func (l *LoginHandler) Handle(ctx auth.AuthContext) (bool, error)
  • func (l *LoginHandler) Init(cfg config.Config, log logger.Logger, vld validator.Validator, ...) error
• type LoginHandlerConfig
• type User
• type UserBase
  • func (u *UserBase) CheckPasswordHash(phash string) bool
  • func (u *UserBase) PasswordHash() string
  • func (u *UserBase) PasswordSalt() string
  • func (u *UserBase) SetPassword(password string)

Constants

const DelayCacheKey = "login-delay"

const ErrorCodeCredentialsRequired = "login_credentials_required"

const ErrorCodeLoginFailed = "login_failed"

const ErrorCodeWaitRetry = "wait_retry"

const LoginName = "login"

const LoginProtocol = "login_phash"

const PasswordHashName = "login-phash"

const SaltName = "login-salt"

Variables

var ErrorDescriptions = map[string]string{
	ErrorCodeLoginFailed:         "Invalid login or password",
	ErrorCodeCredentialsRequired: "Credentials hash must be provided in request",
	ErrorCodeWaitRetry:           "Retry later",
}

var ErrorProtocolCodes = map[string]int{
	ErrorCodeLoginFailed:         http.StatusUnauthorized,
	ErrorCodeCredentialsRequired: http.StatusUnauthorized,
	ErrorCodeWaitRetry:           http.StatusTooManyRequests,
}

Functions

func IsLoginError

func IsLoginError(err generic_error.Error) bool

func Phash

func Phash(password string, salt string) string

Types

type LoginDelay

type LoginDelay struct {
	common.CreatedAtBase
}

type LoginHandler

type LoginHandler struct {
	LoginHandlerConfig
	auth.AuthHandlerBase
	// contains filtered or unexported fields
}

Auth handler for login processing. The AuthTokenHandler MUST ALWAYS follow this handler in session scheme with AND conjunction.

func New

func New(users auth_session.WithAuthUserManager) *LoginHandler

func (*LoginHandler) Config

func (l *LoginHandler) Config() interface{}

func (*LoginHandler) ErrorDescriptions

func (l *LoginHandler) ErrorDescriptions() map[string]string

func (*LoginHandler) ErrorProtocolCodes

func (l *LoginHandler) ErrorProtocolCodes() map[string]int

func (*LoginHandler) Handle

func (l *LoginHandler) Handle(ctx auth.AuthContext) (bool, error)

func (*LoginHandler) Init

func (l *LoginHandler) Init(cfg config.Config, log logger.Logger, vld validator.Validator, configPath ...string) error

type LoginHandlerConfig

type LoginHandlerConfig struct {
	THROTTLE_DELAY_SECONDS int `default:"2" validate:"gt=0"`
}

type User

type User interface {
	PasswordHash() string
	PasswordSalt() string
	SetPassword(password string)
	CheckPasswordHash(phash string) bool
}

type UserBase

type UserBase struct {
	PASSWORD_HASH string `json:"-"`
	PASSWORD_SALT string `json:"-"`
}

func (*UserBase) CheckPasswordHash

func (u *UserBase) CheckPasswordHash(phash string) bool

func (*UserBase) PasswordHash

func (u *UserBase) PasswordHash() string

func (*UserBase) PasswordSalt

func (u *UserBase) PasswordSalt() string

func (*UserBase) SetPassword

func (u *UserBase) SetPassword(password string)