otp

Documentation

Index

• Constants
• type IOTP
• type IOTPSMSGateway
• type Mada
  • func NewMadaSMSOTPProvider(username string, password string, url string, sourceName string, otpLength int, ...) *Mada
  • func (m *Mada) Call(_ *Phone, _ string, _ string) (string, string, error)
  • func (m *Mada) GetCode() string
  • func (m *Mada) GetName() string
  • func (m *Mada) GetPhonePrefixes() []string
  • func (m *Mada) SendOTP(phone *Phone, code string) (string, string, error)
  • func (m *Mada) VerifyOTP(_ *Phone, code, generatedCode string) (string, string, bool, bool, error)
• type OTP
  • func NewOTP(retryOTP bool, gateways ...IOTPSMSGateway) *OTP
  • func (o *OTP) Call(ormService *beeorm.Engine, phone *Phone, customMessage string) (string, error)
  • func (o *OTP) GetGatewayRegistry() map[string]IOTPSMSGateway
  • func (o *OTP) SendSMS(ormService *beeorm.Engine, phone *Phone) (string, error)
  • func (o *OTP) VerifyOTP(ormService *beeorm.Engine, phone *Phone, code string) (bool, bool, error)
• type Phone
• type RetryDTO
• type Sinch
  • func NewSinchSMSOTPProvider(appID, appSecret, verificationURL string) *Sinch
  • func (s *Sinch) Call(_ *Phone, _ string, _ string) (string, string, error)
  • func (s *Sinch) GetCode() string
  • func (s *Sinch) GetName() string
  • func (s *Sinch) GetPhonePrefixes() []string
  • func (s *Sinch) SendOTP(phone *Phone, _ string) (string, string, error)
  • func (s *Sinch) VerifyOTP(phone *Phone, code, _ string) (string, string, bool, bool, error)
• type Twilio
  • func NewTwilioSMSOTPProvider(accountSid, authToken, verificationSid string) *Twilio
  • func (t *Twilio) Call(phone *Phone, _ string, customMessage string) (string, string, error)
  • func (t *Twilio) GetCode() string
  • func (t *Twilio) GetName() string
  • func (t *Twilio) GetPhonePrefixes() []string
  • func (t *Twilio) SendOTP(phone *Phone, _ string) (string, string, error)
  • func (t *Twilio) VerifyOTP(phone *Phone, code, _ string) (string, string, bool, bool, error)

Constants

const SMSOTPProviderMada = "Mada"

const SMSOTPProviderSinch = "Sinch"

const SMSOTPProviderTwilio = "Twilio"

Types

type IOTP

type IOTP interface {
	SendSMS(ormService *beeorm.Engine, phone *Phone) (string, error)
	VerifyOTP(ormService *beeorm.Engine, phone *Phone, code string) (bool, bool, error)
	Call(ormService *beeorm.Engine, phone *Phone, customMessage string) (string, error)
	GetGatewayRegistry() map[string]IOTPSMSGateway
}

type IOTPSMSGateway

type IOTPSMSGateway interface {
	GetName() string
	GetCode() string
	GetPhonePrefixes() []string
	SendOTP(phone *Phone, code string) (string, string, error)
	Call(phone *Phone, code string, customMessage string) (string, string, error)
	VerifyOTP(phone *Phone, code, generatedCode string) (string, string, bool, bool, error)
}

type Mada

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

func NewMadaSMSOTPProvider

func NewMadaSMSOTPProvider(
	username string,
	password string,
	url string,
	sourceName string,
	otpLength int,
	phonePrefixes []string,
	generatorService generator.IGenerator,
) *Mada

func (*Mada) Call

func (m *Mada) Call(_ *Phone, _ string, _ string) (string, string, error)

func (*Mada) GetCode

func (m *Mada) GetCode() string

func (*Mada) GetName

func (m *Mada) GetName() string

func (*Mada) GetPhonePrefixes

func (m *Mada) GetPhonePrefixes() []string

func (*Mada) SendOTP

func (m *Mada) SendOTP(phone *Phone, code string) (string, string, error)

func (*Mada) VerifyOTP

func (m *Mada) VerifyOTP(_ *Phone, code, generatedCode string) (string, string, bool, bool, error)

type OTP

type OTP struct {
	GatewayPriority         []IOTPSMSGateway
	GatewayName             map[string]IOTPSMSGateway
	GatewayPhonePrefixRegex map[*regexp.Regexp]IOTPSMSGateway
	RetryOTP                bool
}

func NewOTP

func NewOTP(retryOTP bool, gateways ...IOTPSMSGateway) *OTP

func (*OTP) Call

func (o *OTP) Call(ormService *beeorm.Engine, phone *Phone, customMessage string) (string, error)

func (*OTP) GetGatewayRegistry

func (o *OTP) GetGatewayRegistry() map[string]IOTPSMSGateway

func (*OTP) SendSMS

func (o *OTP) SendSMS(ormService *beeorm.Engine, phone *Phone) (string, error)

func (*OTP) VerifyOTP

func (o *OTP) VerifyOTP(ormService *beeorm.Engine, phone *Phone, code string) (bool, bool, error)

type Phone

type Phone struct {
	Number  string
	ISO3166 phonenumber.ISO3166
}

type RetryDTO

type RetryDTO struct {
	Code               string
	Phone              *Phone
	OTPTrackerEntityID uint64
	Gateway            string
}

type Sinch

type Sinch struct {
	AppID           string
	AppSecret       string
	VerificationURL string
}

func NewSinchSMSOTPProvider

func NewSinchSMSOTPProvider(appID, appSecret, verificationURL string) *Sinch

func (*Sinch) Call

func (s *Sinch) Call(_ *Phone, _ string, _ string) (string, string, error)

func (*Sinch) GetCode

func (s *Sinch) GetCode() string

func (*Sinch) GetName

func (s *Sinch) GetName() string

func (*Sinch) GetPhonePrefixes

func (s *Sinch) GetPhonePrefixes() []string

func (*Sinch) SendOTP

func (s *Sinch) SendOTP(phone *Phone, _ string) (string, string, error)

func (*Sinch) VerifyOTP

func (s *Sinch) VerifyOTP(phone *Phone, code, _ string) (string, string, bool, bool, error)

type Twilio

type Twilio struct {
	Client          *twilio.RestClient
	VerificationSID string
}

func NewTwilioSMSOTPProvider

func NewTwilioSMSOTPProvider(accountSid, authToken, verificationSid string) *Twilio

func (*Twilio) Call

func (t *Twilio) Call(phone *Phone, _ string, customMessage string) (string, string, error)

func (*Twilio) GetCode

func (t *Twilio) GetCode() string

func (*Twilio) GetName

func (t *Twilio) GetName() string

func (*Twilio) GetPhonePrefixes

func (t *Twilio) GetPhonePrefixes() []string

func (*Twilio) SendOTP

func (t *Twilio) SendOTP(phone *Phone, _ string) (string, string, error)

func (*Twilio) VerifyOTP

func (t *Twilio) VerifyOTP(phone *Phone, code, _ string) (string, string, bool, bool, error)