simple_otp

Documentation

Index

• type TOTP
  • func (t *TOTP) Generate() (string, error)
• type TotpAlgo

Types

type TOTP

type TOTP struct {
	Secret    string   // Secret key (required)
	Digits    int      // OTP digit count (default: 6)
	Algorithm TotpAlgo // OTP Algorithm ("SHA1" or "SHA256" or "SHA512") (default: SHA1)
	Period    int64    // Period for which OTP is valid (seconds) (default: 30)
	UnixTime  int64    // (Optional) Unix Timestamp (default: Current unix timestamp)
}

Time-based One-Time Password from RFC - https://datatracker.ietf.org/doc/html/rfc6238

func (*TOTP) Generate

func (t *TOTP) Generate() (string, error)

Generate TOTP code and returns OTP as string and any error encountered.

type TotpAlgo

type TotpAlgo int

const (
	TotpNotSpecified TotpAlgo = 0
	TotpSha1         TotpAlgo = 1
	TotpSha256       TotpAlgo = 2
	TotpSha512       TotpAlgo = 3
)