otp

Documentation

Index

• Variables
• func NewTOTP(key string, opts ...TOption) *totp
• type OTP
• type TOption
  • func TOTPWithAlgorithm(algo string) TOption
  • func TOTPWithDelay(n int) TOption
  • func TOTPWithDigits(n int) TOption
  • func TOTPWithPeriod(ts int64) TOption
  • func TOTPWithUinx(ts int64) TOption

Variables

var (
	ErrNotSecret        error = errors.New("no secret key provided")
	ErrBadSecret        error = errors.New("bad secret key")
	ErrInvalidAlgorithm error = errors.New("invalid algorithm. Please use any one of SHA1/SHA256/SHA512")
	ErrUnableCompute    error = errors.New("unable to compute HMAC")
)

Functions

func NewTOTP

func NewTOTP(key string, opts ...TOption) *totp

Types

type OTP

type OTP interface {
	Generate() (string, error)
	URL() string
	Validate(token string) (ok bool, e error)
}

type TOption

type TOption func(*totp)

func TOTPWithAlgorithm

func TOTPWithAlgorithm(algo string) TOption

func TOTPWithDelay

func TOTPWithDelay(n int) TOption

func TOTPWithDigits

func TOTPWithDigits(n int) TOption

func TOTPWithPeriod

func TOTPWithPeriod(ts int64) TOption

func TOTPWithUinx

func TOTPWithUinx(ts int64) TOption