otp

README

go-otp

OTP - One time password - implementation based on RFC-4226 and RFC-6238 HMAC-Based One Time Password and Time-Based One time password

Documentation

Index

• Constants
• type AuthURL
  • func (o *AuthURL) String() string
• type Counter
• type HOTP
  • func (h *HOTP) Counter() Counter
  • func (h *HOTP) GenerateCode(key string, count int64, tokenLen int) (string, error)
  • func (h *HOTP) Hash() crypto.Hash
  • func (h *HOTP) VerifyCode(code, key string, skew, tokenLen int) bool
• type OTP
  • func DefaultTOTP() OTP
  • func NewTOTP(hash crypto.Hash, interval, step int) OTP
• type TimeCounter
  • func (t *TimeCounter) Count() int64

Constants

const (
	// 30 second interval
	DefaultInterval = 30

	OtpAuthScheme = "otpauth"
)

Types

type AuthURL

type AuthURL struct {
	Type      string
	Label     string
	Secret    string
	Issuer    string
	Algorithm string
	Counter   int
	Digits    int
	Period    int
}

func (*AuthURL) String

func (o *AuthURL) String() string

type Counter

type Counter interface {
	Count() int64
}

type HOTP

type HOTP struct {
	// contains filtered or unexported fields
}

func (*HOTP) Counter

func (h *HOTP) Counter() Counter

func (*HOTP) GenerateCode

func (h *HOTP) GenerateCode(key string, count int64, tokenLen int) (string, error)

func (*HOTP) Hash

func (h *HOTP) Hash() crypto.Hash

func (*HOTP) VerifyCode

func (h *HOTP) VerifyCode(code, key string, skew, tokenLen int) bool

type OTP

type OTP interface {
	Counter() Counter
	Hash() crypto.Hash
	GenerateCode(key string, count int64, tokenLen int) (string, error)
	VerifyCode(code, key string, skew, tokenLen int) bool
}

func DefaultTOTP

func DefaultTOTP() OTP

func NewTOTP

func NewTOTP(hash crypto.Hash, interval, step int) OTP

type TimeCounter

type TimeCounter struct {
	Interval, Step int
}

func (*TimeCounter) Count

func (t *TimeCounter) Count() int64