authentication

Documentation

Index

• Constants
• type AuthProviderEntity
• type AuthenticatableEntity
• type Authentication
  • func NewAuthenticationService(secret string, accessTokenTTL int, refreshTokenTTL int, otpTTL int, ...) *Authentication
  • func (t *Authentication) Authenticate(ormService *beeorm.Engine, uniqueValue string, password string, ...) (accessToken string, refreshToken string, err error)
  • func (t *Authentication) AuthenticateByID(ormService *beeorm.Engine, id uint64, entity AuthProviderEntity) (accessToken string, refreshToken string, err error)
  • func (t *Authentication) AuthenticateOTP(ormService *beeorm.Engine, phone string, entity OTPProviderEntity) (accessToken string, refreshToken string, err error)
  • func (t *Authentication) AuthenticateOTPEmail(ormService *beeorm.Engine, email string, entity OTPProviderEntity) (accessToken string, refreshToken string, err error)
  • func (t *Authentication) GenerateAndSendOTP(ormService *beeorm.Engine, mobile string, countryCodeAlpha2 string) (*GenerateOTP, error)
  • func (t *Authentication) GenerateAndSendOTPEmail(ormService *beeorm.Engine, email string, template string, from string, ...) (*GenerateOTPEmail, error)
  • func (t *Authentication) GenerateTokenPair(id uint64, accessKey string, ttl int) (string, error)
  • func (t *Authentication) LogoutAllSessions(ormService *beeorm.Engine, id uint64)
  • func (t *Authentication) LogoutCurrentSession(ormService *beeorm.Engine, accessKey string)
  • func (t *Authentication) RefreshToken(ormService *beeorm.Engine, refreshToken string) (newAccessToken string, newRefreshToken string, err error)
  • func (t *Authentication) SendVerifyAPIOTP(ormService *beeorm.Engine, mobile string, countryCodeAlpha2 string) error
  • func (t *Authentication) VerifyAPIOTP(ormService *beeorm.Engine, mobile string, code string, ...) error
  • func (t *Authentication) VerifyAccessToken(ormService *beeorm.Engine, accessToken string, entity beeorm.Entity) (map[string]string, error)
  • func (t *Authentication) VerifyOTP(code string, input *GenerateOTP) error
  • func (t *Authentication) VerifyOTPEmail(code string, input *GenerateOTPEmail) error
  • func (t *Authentication) VerifySocialLogin(source, token string) (*social.UserData, error)
• type GenerateOTP
• type GenerateOTPEmail
• type OTPProviderEntity

Constants

const (
	SocialLoginGoogle   = "google"
	SocialLoginFacebook = "facebook"
)

Types

type AuthProviderEntity

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

type AuthenticatableEntity

type AuthenticatableEntity interface {
	beeorm.Entity
	CanAuthenticate() bool
}

type Authentication

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

func NewAuthenticationService

func NewAuthenticationService(
	secret string,
	accessTokenTTL int,
	refreshTokenTTL int,
	otpTTL int,
	appService *app.App,
	smsService sms.ISender,
	generatorService generator.IGenerator,
	errorLoggerService errorlogger.ErrorLogger,
	clockService clock.IClock,
	passwordService password.IPassword,
	jwtService *jwt.JWT,
	mailService *mail.Sender,
	socialServiceMapping map[string]social.IUserData,
	uuidService uuid.IUUID,
) *Authentication

func (*Authentication) Authenticate

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

func (*Authentication) AuthenticateByID

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

func (*Authentication) AuthenticateOTP

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

func (*Authentication) AuthenticateOTPEmail

func (t *Authentication) AuthenticateOTPEmail(ormService *beeorm.Engine, email string, entity OTPProviderEntity) (accessToken string, refreshToken string, err error)

func (*Authentication) GenerateAndSendOTP

func (t *Authentication) GenerateAndSendOTP(ormService *beeorm.Engine, mobile string, countryCodeAlpha2 string) (*GenerateOTP, error)

func (*Authentication) GenerateAndSendOTPEmail

func (t *Authentication) GenerateAndSendOTPEmail(ormService *beeorm.Engine, email string, template string, from string, title string) (*GenerateOTPEmail, error)

func (*Authentication) GenerateTokenPair

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

func (*Authentication) LogoutAllSessions

func (t *Authentication) LogoutAllSessions(ormService *beeorm.Engine, id uint64)

func (*Authentication) LogoutCurrentSession

func (t *Authentication) LogoutCurrentSession(ormService *beeorm.Engine, accessKey string)

func (*Authentication) RefreshToken

func (t *Authentication) RefreshToken(ormService *beeorm.Engine, refreshToken string) (newAccessToken string, newRefreshToken string, err error)

func (*Authentication) SendVerifyAPIOTP

func (t *Authentication) SendVerifyAPIOTP(ormService *beeorm.Engine, mobile string, countryCodeAlpha2 string) error

func (*Authentication) VerifyAPIOTP

func (t *Authentication) VerifyAPIOTP(ormService *beeorm.Engine, mobile string, code string, countryCodeAlpha2 string) error

func (*Authentication) VerifyAccessToken

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

func (*Authentication) VerifyOTP

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

func (*Authentication) VerifyOTPEmail

func (t *Authentication) VerifyOTPEmail(code string, input *GenerateOTPEmail) error

func (*Authentication) VerifySocialLogin

func (t *Authentication) VerifySocialLogin(source, token string) (*social.UserData, error)

type GenerateOTP

type GenerateOTP struct {
	Mobile         string
	ExpirationTime string
	Token          string
}

type GenerateOTPEmail

type GenerateOTPEmail struct {
	Email          string
	ExpirationTime string
	Token          string
}

type OTPProviderEntity

type OTPProviderEntity interface {
	beeorm.Entity
	AuthenticatableEntity
	GetPhoneFieldName() string
	GetEmailFieldName() string
}