auth

Documentation

Index

• func Login(m models.AuthModel) (*models.User, error)
• func OnBoardUser(user *models.User) error
• func PostAuthenticate(u *models.User) error
• func Register(name string, h AuthenticateHelper)
• func SearchUser(username string) (*models.User, error)
• type AuthenticateHelper
• type DefaultAuthenticateHelper
  • func (d *DefaultAuthenticateHelper) Authenticate(m models.AuthModel) (*models.User, error)
  • func (d *DefaultAuthenticateHelper) OnBoardUser(u *models.User) error
  • func (d *DefaultAuthenticateHelper) PostAuthenticate(u *models.User) error
  • func (d *DefaultAuthenticateHelper) SearchUser(username string) (*models.User, error)
• type UserLock
  • func NewUserLock(freeze time.Duration) *UserLock
  • func (ul *UserLock) IsLocked(username string) bool
  • func (ul *UserLock) Lock(username string)

Functions

func Login

func Login(m models.AuthModel) (*models.User, error)

Login authenticates user credentials based on setting.

func OnBoardUser

func OnBoardUser(user *models.User) error

OnBoardUser will check if a user exists in user table, if not insert the user and put the id in the pointer of user model, if it does exist, return the user's profile.

func PostAuthenticate

func PostAuthenticate(u *models.User) error

PostAuthenticate -

func Register

func Register(name string, h AuthenticateHelper)

Register add different authenticators to registry map.

func SearchUser

func SearchUser(username string) (*models.User, error)

SearchUser --

Types

type AuthenticateHelper

type AuthenticateHelper interface {

	// Authenticate ...
	Authenticate(m models.AuthModel) (*models.User, error)
	// OnBoardUser will check if a user exists in user table, if not insert the user and
	// put the id in the pointer of user model, if it does exist, fill in the user model based
	// on the data record of the user
	OnBoardUser(u *models.User) error
	// Get user information from account repository
	SearchUser(username string) (*models.User, error)
	// Update user information after authenticate, such as Onboard or sync info etc
	PostAuthenticate(u *models.User) error
}

AuthenticateHelper provides interface for user management in different auth modes.

type DefaultAuthenticateHelper

type DefaultAuthenticateHelper struct {
}

DefaultAuthenticateHelper - default AuthenticateHelper implementation

func (*DefaultAuthenticateHelper) Authenticate

func (d *DefaultAuthenticateHelper) Authenticate(m models.AuthModel) (*models.User, error)

Authenticate ...

func (*DefaultAuthenticateHelper) OnBoardUser

func (d *DefaultAuthenticateHelper) OnBoardUser(u *models.User) error

OnBoardUser will check if a user exists in user table, if not insert the user and put the id in the pointer of user model, if it does exist, fill in the user model based on the data record of the user

func (*DefaultAuthenticateHelper) PostAuthenticate

func (d *DefaultAuthenticateHelper) PostAuthenticate(u *models.User) error

PostAuthenticate - Update user information after authenticate, such as Onboard or sync info etc

func (*DefaultAuthenticateHelper) SearchUser

func (d *DefaultAuthenticateHelper) SearchUser(username string) (*models.User, error)

SearchUser - Get user information from account repository

type UserLock

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

UserLock maintains a lock to block user from logging in within a short period of time.

func NewUserLock

func NewUserLock(freeze time.Duration) *UserLock

NewUserLock ...

func (*UserLock) IsLocked

func (ul *UserLock) IsLocked(username string) bool

IsLocked checks whether a login request is happened within a period of time or not if it is, the authenticator should ignore the login request and return a failure immediately

func (*UserLock) Lock

func (ul *UserLock) Lock(username string)

Lock marks a new login failure with the time it happens