authentication

Documentation

Index

• type AuthProviderEntity
• type Authentication
  • func NewAuthenticationService(secret string, accessTokenTTL int, refreshTokenTTL int, otpTTL int, ...) *Authentication
  • func (t *Authentication) Authenticate(uniqueValue string, password string, entity AuthProviderEntity) (accessToken string, refreshToken string, err error)
  • func (t *Authentication) AuthenticateByID(id uint64, entity AuthProviderEntity) (accessToken string, refreshToken string, err error)
  • func (t *Authentication) AuthenticateOTP(phone string, entity OTPProviderEntity) (accessToken string, refreshToken string, err error)
  • func (t *Authentication) GenerateAndSendOTP(mobile string, country string) (*GenerateOTP, error)
  • func (t *Authentication) GenerateTokenPair(id uint64, accessKey string, ttl int) (string, error)
  • func (t *Authentication) LogoutAllSessions(id uint64)
  • func (t *Authentication) LogoutCurrentSession(accessKey string)
  • func (t *Authentication) RefreshToken(refreshToken string) (newAccessToken string, newRefreshToken string, err error)
  • func (t *Authentication) VerifyAccessToken(accessToken string, entity orm.Entity) (map[string]string, error)
  • func (t *Authentication) VerifyOTP(code string, input *GenerateOTP) error
• type GenerateOTP
• type OTPProviderEntity

Types

type AuthProviderEntity

type AuthProviderEntity interface {
	orm.Entity
	GetUniqueFieldName() string
	GetPassword() string
}

type Authentication

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

func NewAuthenticationService

func NewAuthenticationService(
	secret string,
	accessTokenTTL int,
	refreshTokenTTL int,
	otpTTL int,
	ormService *orm.Engine,
	smsService sms.ISender,
	generatorService generator.Generator,
	clockService clock.Clock,
	cacheService *orm.RedisCache,
	passwordService *password.Password,
	jwtService *jwt.JWT,
) *Authentication

func (*Authentication) Authenticate

func (t *Authentication) Authenticate(uniqueValue string, password string, entity AuthProviderEntity) (accessToken string, refreshToken string, err error)

func (*Authentication) AuthenticateByID

func (t *Authentication) AuthenticateByID(id uint64, entity AuthProviderEntity) (accessToken string, refreshToken string, err error)

func (*Authentication) AuthenticateOTP

func (t *Authentication) AuthenticateOTP(phone string, entity OTPProviderEntity) (accessToken string, refreshToken string, err error)

func (*Authentication) GenerateAndSendOTP

func (t *Authentication) GenerateAndSendOTP(mobile string, country string) (*GenerateOTP, error)

func (*Authentication) GenerateTokenPair

func (t *Authentication) GenerateTokenPair(id uint64, accessKey string, ttl int) (string, error)

func (*Authentication) LogoutAllSessions

func (t *Authentication) LogoutAllSessions(id uint64)

func (*Authentication) LogoutCurrentSession

func (t *Authentication) LogoutCurrentSession(accessKey string)

func (*Authentication) RefreshToken

func (t *Authentication) RefreshToken(refreshToken string) (newAccessToken string, newRefreshToken string, err error)

func (*Authentication) VerifyAccessToken

func (t *Authentication) VerifyAccessToken(accessToken string, entity orm.Entity) (map[string]string, error)

func (*Authentication) VerifyOTP

func (t *Authentication) VerifyOTP(code string, input *GenerateOTP) error

type GenerateOTP

type GenerateOTP struct {
	Mobile         string
	ExpirationTime time.Time
	Token          string
}

type OTPProviderEntity

type OTPProviderEntity interface {
	orm.Entity
	GetPhoneFieldName() string
}