totp

Documentation

Index

• func GenerateCode(secret string, t time.Time) (passcode string, err error)
• func GenerateCodeCustom(secret string, t time.Time, opts ValidateOpts) (passcode string, err error)
• func GenerateTotpKey(opts GenerateOpts) (key *gotp.Key, err error)
• func ValidateCode(passcode string, secret string) bool
• func ValidateCodeCustom(passcode string, secret string, t time.Time, opts ValidateOpts) (result bool, err error)
• type GenerateOpts
• type ValidateOpts

Functions

func GenerateCode

func GenerateCode(secret string, t time.Time) (passcode string, err error)

GenerateCode generates and returns passcode.

func GenerateCodeCustom

func GenerateCodeCustom(secret string, t time.Time, opts ValidateOpts) (passcode string, err error)

func GenerateTotpKey

func GenerateTotpKey(opts GenerateOpts) (key *gotp.Key, err error)

func ValidateCode

func ValidateCode(passcode string, secret string) bool

func ValidateCodeCustom

func ValidateCodeCustom(passcode string, secret string, t time.Time, opts ValidateOpts) (result bool, err error)

Types

type GenerateOpts

type GenerateOpts struct {
	Issuer      string
	AccountName string
	Period      uint
	SecretSize  uint
	Secret      []byte
	Digits      gotp.Digits
	Algorithm   gotp.Algorithm
	Rand        io.Reader
}

type ValidateOpts

type ValidateOpts struct {
	Period    uint
	Window    uint
	Digits    gotp.Digits
	Algorithm gotp.Algorithm
}

ValidateOpts is the type used to handling options of TOTP validate.