auth_sms

Documentation

Index

• Constants
• Variables
• type AuthSms
  • func New(smsManager sms.SmsManager) *AuthSms
  • func (a *AuthSms) Config() interface{}
  • func (a *AuthSms) ErrorDescriptions() map[string]string
  • func (a *AuthSms) ErrorProtocolCodes() map[string]int
  • func (a *AuthSms) Handle(ctx auth.AuthContext) (bool, error)
  • func (a *AuthSms) Init(cfg config.Config, log logger.Logger, vld validator.Validator, ...) error
  • func (a *AuthSms) SetAuthManager(manager auth.AuthManager)
  • func (a *AuthSms) SetSmsManager(smsManager sms.SmsManager)
• type AuthSmsConfig
• type SmsCacheToken
• type SmsDelay
• type SmsToken
• type UserWithPhone

Constants

const CodeName = "sms-code"

const DelayName = "sms-delay"

const ErrorCodeContentMismatch = "sms_content_mismatch"

const ErrorCodeInvalidPhone = "sms_invalid_phone"

const ErrorCodeInvalidSmsCode = "sms_code_invalid"

const ErrorCodeInvalidToken = "sms_token_invalid"

const ErrorCodeSmsConfirmationRequired = "sms_confirmation_required"

const ErrorCodeSmsTokenRequired = "sms_token_required"

const ErrorCodeTokenExpired = "sms_token_expired"

const ErrorCodeTooManyTries = "sms_too_many_tries"

const ErrorCodeWaitDelay = "sms_wait_delay"

const PhoneName = "sms-phone"

const SmsDelayCacheKey = "sms-delay"

const SmsProtocol = "sms"

const SmsTokenCacheKey = "sms-token"

const TokenName = "sms-token"

Variables

var LastSmsCode = ""

Types

type AuthSms

type AuthSms struct {
	auth.AuthHandlerBase
	AuthSmsConfig
	Encryption auth.AuthParameterEncryption
	// contains filtered or unexported fields
}

func New

func New(smsManager sms.SmsManager) *AuthSms

func (*AuthSms) Config

func (a *AuthSms) Config() interface{}

func (*AuthSms) ErrorDescriptions

func (a *AuthSms) ErrorDescriptions() map[string]string

func (*AuthSms) ErrorProtocolCodes

func (a *AuthSms) ErrorProtocolCodes() map[string]int

func (*AuthSms) Handle

func (a *AuthSms) Handle(ctx auth.AuthContext) (bool, error)

func (*AuthSms) Init

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

func (*AuthSms) SetAuthManager

func (a *AuthSms) SetAuthManager(manager auth.AuthManager)

func (*AuthSms) SetSmsManager

func (a *AuthSms) SetSmsManager(smsManager sms.SmsManager)

type AuthSmsConfig

type AuthSmsConfig struct {
	TOKEN_TTL_SECONDS int    `default:"300" validate:"gt=0"`
	SMS_DELAY_SECONDS int    `default:"30" validate:"gt=0"`
	SECRET            string `validate:"required" mask:"true"`
	MAX_TRIES         int    `default:"3" validate:"gt=1"`
	CODE_LENGTH       int    `default:"5" validate:"gte=4"`
	TESTING           bool
}

type SmsCacheToken

type SmsCacheToken struct {
	Try      int    `json:"try"`
	Code     string `json:"code"`
	Checksum string `json:"checksum"`
	SmsId    string `json:"sms_id"`
}

type SmsDelay

type SmsDelay struct {
	common.CreatedAtBase
}

type SmsToken

type SmsToken struct {
	auth.ExpireToken
	common.IDBase
}

type UserWithPhone

type UserWithPhone interface {
	Phone() string
}