genotp

package module

Go to main page

Versions in this module

v1

v1.2.2

Jun 7, 2026

Changes in this version

+ var ErrInvalidMigration = errors.New("invalid otpauth-migration payload")

+ var ErrInvalidURI = errors.New("invalid otpauth URI")

+ func BuildOtpAuthMigrationURI(accounts []OtpAuthMigrationAccount, opts *OtpAuthMigrationOptions) (string, error)

+ type OtpAuthMigrationAccount struct

+ Algorithm Algorithm

+ Counter uint64

+ Digits uint32

+ Issuer string

+ Label string

+ Period uint64

+ SecretB32 string

+ Type OtpType

+ type OtpAuthMigrationOptions struct

+ BatchID int32

+ BatchIndex int32

+ BatchSize int32

+ Version int32

+ type OtpAuthMigrationPayload struct

+ Accounts []OtpAuthMigrationAccount

+ BatchID int32

+ BatchIndex int32

+ BatchSize int32

+ Version int32

+ func ParseOtpAuthMigrationURI(raw string) (*OtpAuthMigrationPayload, error)

v1.1.2

Jun 6, 2026

Changes in this version

+ const DistanceClassFar

+ const DistanceClassNearby

+ const DistanceClassSameArea

+ var ErrHMACProvider = errors.New("HMAC provider failure")

+ var ErrSecretProvider = errors.New("secret provider failure")

+ type HMACProvider interface

+ HMAC func(algorithm Algorithm, message []byte) ([]byte, error)

+ type HMACProviderFunc func(algorithm Algorithm, message []byte) ([]byte, error)

+ func (f HMACProviderFunc) HMAC(algorithm Algorithm, message []byte) ([]byte, error)

type HOTP

+ func NewHOTPFromHMACProvider(provider HMACProvider, algorithm Algorithm, digits uint32) (*HOTP, error)

+ func NewHOTPFromSecretProvider(provider SecretProvider, algorithm Algorithm, digits uint32) (*HOTP, error)

+ func (h *HOTP) VerifyBatch(reqs []HOTPVerifyRequest) []VerifyResult

+ func (h *HOTP) VerifyBoundBatch(reqs []HOTPVerifyBoundRequest) []VerifyResult

+ type HOTPVerifyBoundRequest struct

+ Code string

+ Context *OtpContext

+ Counter uint64

+ type HOTPVerifyRequest struct

+ Code string

+ Counter uint64

type OtpContextBuilder

+ func (b *OtpContextBuilder) DistanceClass(class string) *OtpContextBuilder

+ func (b *OtpContextBuilder) GeoBucket(bucket string) *OtpContextBuilder

+ func (b *OtpContextBuilder) Region(region string) *OtpContextBuilder

+ type SecretProvider interface

+ Secret func() ([]byte, error)

+ type SecretProviderFunc func() ([]byte, error)

+ func (f SecretProviderFunc) Secret() ([]byte, error)

type TOTP

+ func NewTOTPFromHMACProvider(provider HMACProvider, algorithm Algorithm, digits uint32, period uint64) (*TOTP, error)

+ func NewTOTPFromSecretProvider(provider SecretProvider, algorithm Algorithm, digits uint32, period uint64) (*TOTP, error)

+ func (t *TOTP) VerifyBatch(reqs []TOTPVerifyRequest) []VerifyResult

+ func (t *TOTP) VerifyBoundBatch(reqs []TOTPVerifyBoundRequest) []VerifyResult

+ type TOTPVerifyBoundRequest struct

+ Code string

+ Context *OtpContext

+ Time *uint64

+ Window uint64

+ type TOTPVerifyRequest struct

+ Code string

+ Time *uint64

+ Window uint64

+ type VerifyResult struct

+ Err error

+ OK bool

v1.0.2

Jun 3, 2026

v1.0.1

Jun 3, 2026

v1.0.0

Jun 1, 2026

Changes in this version

+ const DefaultSecretBytes

+ const MinSecretBytes

+ var ErrDstTooSmall = errors.New("destination buffer too small")

+ var ErrInvalidAlgorithm = errors.New("invalid algorithm")

+ var ErrInvalidCode = errors.New("invalid OTP code")

+ var ErrInvalidCounter = errors.New("invalid counter value")

+ var ErrInvalidDigits = errors.New("invalid number of digits")

+ var ErrInvalidSecret = errors.New("invalid secret key")

+ var ErrInvalidTime = errors.New("invalid time value")

+ var ErrRateLimited = errors.New("rate limited")

+ var ErrReplayAttack = errors.New("replay attack detected")

+ var ErrVerificationFailed = errors.New("OTP verification failed")

+ func CreateSecret() ([]byte, error)

+ func DecodeBase32(dst []byte, src string) (int, error)

+ func EncodeBase32(data []byte) string

+ func GenHotpDefault(secret []byte, counter uint64) (string, error)

+ func GenTotpDefault(secret []byte) (string, error)

+ func VerifyHotpDefault(secret []byte, code string, counter uint64) (bool, error)

+ func VerifyTotpDefault(secret []byte, code string) (bool, error)

+ type Algorithm int

+ const SHA1

+ const SHA256

+ const SHA512

+ func (a Algorithm) String() string

+ type ClockSkewDetector struct

+ func NewClockSkewDetector(capacity int) *ClockSkewDetector

+ func (d *ClockSkewDetector) CurrentOffset() int64

+ func (d *ClockSkewDetector) DisableAutoAdjust()

+ func (d *ClockSkewDetector) EnableAutoAdjust()

+ func (d *ClockSkewDetector) IsAutoAdjust() bool

+ func (d *ClockSkewDetector) Record(matchedOffset int64, windowUsed uint64)

+ func (d *ClockSkewDetector) Report() SkewReport

+ func (d *ClockSkewDetector) Reset()

+ type GenOtpError struct

+ Message string

+ func NewGenOtpError(msg string) *GenOtpError

+ func (e *GenOtpError) Error() string

+ type HOTP struct

+ func NewHOTP(secret []byte, algorithm Algorithm, digits uint32) (*HOTP, error)

+ func NewHotpFromConfig(secret []byte, c HotpConfig) (*HOTP, error)

+ func (h *HOTP) ClearSecret()

+ func (h *HOTP) GenBound(counter uint64, context *OtpContext) (string, error)

+ func (h *HOTP) Generate(counter uint64) (string, error)

+ func (h *HOTP) Verify(code string, counter uint64) (bool, error)

+ func (h *HOTP) VerifyBound(code string, counter uint64, context *OtpContext) (bool, error)

+ func (h *HOTP) VerifyWithResync(code string, counter uint64, lookAhead uint64) (uint64, bool, error)

+ type HotpBuilder struct

+ func NewHotpBuilder() *HotpBuilder

+ func (b *HotpBuilder) Algorithm(algorithm Algorithm) *HotpBuilder

+ func (b *HotpBuilder) Build() (*HOTP, error)

+ func (b *HotpBuilder) Digits(digits uint32) *HotpBuilder

+ func (b *HotpBuilder) Secret(secret []byte) *HotpBuilder

+ type HotpConfig struct

+ Algorithm Algorithm

+ Digits uint32

+ func NewHotpConfig() HotpConfig

+ func (c HotpConfig) WithAlgorithm(algorithm Algorithm) HotpConfig

+ func (c HotpConfig) WithDigits(digits uint32) HotpConfig

+ type InMemoryReplayStore struct

+ func NewInMemoryReplayStore(maxSize int) *InMemoryReplayStore

+ func (s *InMemoryReplayStore) CheckAndRecord(key []byte, ttl time.Duration) (bool, error)

+ func (s *InMemoryReplayStore) Reset() error

+ func (s *InMemoryReplayStore) Size() int

+ type KeyGen struct

+ func (k *KeyGen) FillSecret(buf []byte) error

+ func (k *KeyGen) GenerateDefaultSecret() ([]byte, error)

+ func (k *KeyGen) GenerateSecret(bitLength int) ([]byte, error)

+ type Metrics struct

+ Errors atomic.Uint64

+ HotpGenerations atomic.Uint64

+ HotpVerifications atomic.Uint64

+ TotpGenerations atomic.Uint64

+ TotpVerifications atomic.Uint64

+ func NewMetrics() *Metrics

+ func (m *Metrics) GetErrors() uint64

+ func (m *Metrics) GetHotpGenerations() uint64

+ func (m *Metrics) GetHotpVerifications() uint64

+ func (m *Metrics) GetTotpGenerations() uint64

+ func (m *Metrics) GetTotpVerifications() uint64

+ func (m *Metrics) IncrementError()

+ func (m *Metrics) IncrementHotpGeneration()

+ func (m *Metrics) IncrementHotpVerification()

+ func (m *Metrics) IncrementTotpGeneration()

+ func (m *Metrics) IncrementTotpVerification()

+ func (m *Metrics) Reset()

+ type OtpAuthUri struct

+ func NewOtpAuthUri(typ OtpType, label, secret string) *OtpAuthUri

+ func (u *OtpAuthUri) Algorithm(algorithm Algorithm) *OtpAuthUri

+ func (u *OtpAuthUri) Build() string

+ func (u *OtpAuthUri) Counter(counter uint64) *OtpAuthUri

+ func (u *OtpAuthUri) Digits(digits uint32) *OtpAuthUri

+ func (u *OtpAuthUri) Issuer(issuer string) *OtpAuthUri

+ func (u *OtpAuthUri) Period(period uint64) *OtpAuthUri

+ func (u *OtpAuthUri) String() string

+ type OtpContext struct

+ func NewOtpContext() *OtpContext

+ func OtpContextFromBytes(b []byte) *OtpContext

+ func (c *OtpContext) Bytes() []byte

+ func (c *OtpContext) IsEmpty() bool

+ type OtpContextBuilder struct

+ func NewOtpContextBuilder() *OtpContextBuilder

+ func (b *OtpContextBuilder) Build() *OtpContext

+ func (b *OtpContextBuilder) Custom(key, value string) *OtpContextBuilder

+ func (b *OtpContextBuilder) Device(deviceID string) *OtpContextBuilder

+ func (b *OtpContextBuilder) IP(ip string) *OtpContextBuilder

+ func (b *OtpContextBuilder) Origin(origin string) *OtpContextBuilder

+ func (b *OtpContextBuilder) Session(session string) *OtpContextBuilder

+ type OtpType int

+ const HotpType

+ const TotpType

+ type ReplayStore interface

+ CheckAndRecord func(key []byte, ttl time.Duration) (firstSeen bool, err error)

+ Reset func() error

+ type SkewRecommend int

+ const ConsistentDrift

+ const InsufficientData

+ const NoActionNeeded

+ const WidenWindowOrCheckNtp

+ func (r SkewRecommend) String() string

+ type SkewReport struct

+ EdgeHitRatio float64

+ MeanOffset float64

+ NonZeroCount int

+ Recommend SkewRecommend

+ SampleCount int

+ type TOTP struct

+ func NewTOTP(secret []byte, algorithm Algorithm, digits uint32, period uint64) (*TOTP, error)

+ func NewTotpFromConfig(secret []byte, c TotpConfig) (*TOTP, error)

+ func (t *TOTP) ClearSecret()

+ func (t *TOTP) GenBound(context *OtpContext, timeVal *uint64) (string, error)

+ func (t *TOTP) Generate(timeVal *uint64) (string, error)

+ func (t *TOTP) Verify(code string, timeVal *uint64, window uint64) (bool, error)

+ func (t *TOTP) VerifyBound(code string, context *OtpContext, timeVal *uint64, window uint64) (bool, error)

+ func (t *TOTP) VerifyTracking(code string, timeVal *uint64, window uint64, detector *ClockSkewDetector) (bool, error)

+ type TotpBuilder struct

+ func NewTotpBuilder() *TotpBuilder

+ func (b *TotpBuilder) Algorithm(algorithm Algorithm) *TotpBuilder

+ func (b *TotpBuilder) Build() (*TOTP, error)

+ func (b *TotpBuilder) Digits(digits uint32) *TotpBuilder

+ func (b *TotpBuilder) Period(period uint64) *TotpBuilder

+ func (b *TotpBuilder) Secret(secret []byte) *TotpBuilder

+ type TotpConfig struct

+ Algorithm Algorithm

+ Digits uint32

+ Period uint64

+ func NewTotpConfig() TotpConfig

+ func (c TotpConfig) WithAlgorithm(algorithm Algorithm) TotpConfig

+ func (c TotpConfig) WithDigits(digits uint32) TotpConfig

+ func (c TotpConfig) WithPeriod(period uint64) TotpConfig

+ type Verifier struct

+ func NewVerifier(maxAttempts uint32) *Verifier

+ func NewVerifierWithCapacity(maxAttempts uint32, maxUsedCodes int) *Verifier

+ func NewVerifierWithStore(maxAttempts uint32, store ReplayStore, ttl time.Duration) *Verifier

+ func (v *Verifier) ClearUsedCodes()

+ func (v *Verifier) IsRateLimited() bool

+ func (v *Verifier) ResetAttempts()

+ func (v *Verifier) VerifyWithContext(code, expected string, issuedContext, requestContext *OtpContext) bool

+ func (v *Verifier) VerifyWithReplayProtection(code, expected string) bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL