totp

Documentation

Index

• func GenerateTOTP(opts Opts) (code string)
• func GenerateTOTPFromOTPAuth(otpAuth string, timestamp string) (label string, code string, err error)
• type Algo
• type Opts
  • func (o Opts) Algo() func() hash.Hash

Functions

func GenerateTOTP

func GenerateTOTP(opts Opts) (code string)

Generate a TOTP

func GenerateTOTPFromOTPAuth

func GenerateTOTPFromOTPAuth(otpAuth string, timestamp string) (label string, code string, err error)

Types

type Algo

type Algo int

const (
	Invalid Algo = iota
	SHA1
	SHA256
	SHA512
)

type Opts

type Opts struct {
	// the number of seconds between generating TOTPs. A default timestep of 30 seconds is recommended
	Timestep uint
	// The shared secret
	Secret []byte
	// Number of Digits required
	Digits uint
	// the algorithm to use
	Algorithm Algo
	// For testing purposes, the current Unix time
	CurrentUnixTime uint64
}

func (Opts) Algo

func (o Opts) Algo() func() hash.Hash