validate

Documentation

Overview

Package validate defines an interface which must be implmented by credential validators.

Index

• type Validator

Types

type Validator

type Validator interface {
	// Init initializes the validator.
	Init(jsonconf string) error

	// PreCheck pre-validates the credential without sending an actual request for validation:
	// check uniqueness (if appropriate), format, etc
	PreCheck(cred string, params interface{}) error

	// Request sends a request for confirmation to the user.
	// 	user: UID of the user making the request.
	// 	cred: credential being validated, such as email or phone.
	//  lang: user's human language as repored in the session.
	//  resp: optional response if user already has it (i.e. captcha/recaptcha).
	Request(user t.Uid, cred, lang, resp string, tmpToken []byte) error

	// ResetSecret sends a message with instructions for resetting an authentication secret.
	//  cred: address to use for the message.
	//  scheme: authentication scheme being reset.
	//  lang: human language as reported in the session.
	//  tmpToken: temporary authentication token
	ResetSecret(cred, scheme, lang string, tmpToken []byte) error

	// Check checks validity of user's response.
	// Returns the value of validated credential on success.
	Check(user t.Uid, resp string) (string, error)

	// Delete deletes user's record.
	Delete(user t.Uid) error
}

Validator handles validation of user's credentials, like email or phone.