Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mfa

package

Go to main page

Versions in this module

v0

v0.1.27

Apr 17, 2025

v0.1.26

Apr 14, 2025

v0.1.25

Apr 11, 2025

v0.1.24

Apr 10, 2025

Changes in this version

+ const AlgorithmSHA1

+ const AlgorithmSHA256

+ const AlgorithmSHA512

+ const DefaultBackupCodeCount

+ const DefaultBackupCodeLength

+ const DefaultWindowSize

+ var ErrAllBackupCodesUsed = errors.New("所有备份码都已使用")

+ var ErrBackupCodeInvalid = errors.New("提供的备份码无效")

+ var ErrInvalidAlgorithm = errors.New("提供的哈希算法无效")

+ type BackupCode struct

+ Code string

+ Used bool

+ func GenerateBackupCodes(count, length int) ([]BackupCode, error)

type TOTP

+ BackupCodes []BackupCode

+ UsedTokens *UsedTokenTracker

+ func (t *TOTP) GetUnusedBackupCodes() []string

+ func (t *TOTP) RegenerateBackupCodes() error

+ func (t *TOTP) UseBackupCode(code string) error

+ func (t *TOTP) ValidateBackupCode(code string) bool

type TOTPConfig

+ SkipValidUsedTokens bool

+ WindowSize int

+ type UsedTokenTracker struct

+ func NewUsedTokenTracker(expiry time.Duration) *UsedTokenTracker

+ func (t *UsedTokenTracker) IsTokenUsed(tokenKey string) bool

+ func (t *UsedTokenTracker) MarkTokenAsUsed(tokenKey string)

v0.1.23

Apr 10, 2025

v0.1.22

Apr 10, 2025

v0.1.21

Apr 10, 2025

v0.1.20

Apr 9, 2025

Changes in this version

+ const DefaultAlgorithm

+ const DefaultDigits

+ const DefaultIssuer

+ const DefaultPeriod

+ const DefaultValidationDuration

+ const MFACookieName

+ const MFASessionKey

+ var ErrInvalidInput = errors.New("提供的输入参数无效")

+ var ErrInvalidMFACode = errors.New("无效的多因素验证码")

+ var ErrInvalidOTP = errors.New("提供的OTP代码无效")

+ var ErrInvalidSecret = errors.New("提供的密钥格式无效")

+ var ErrMFARequired = errors.New("需要多因素验证")

+ func ClearValidation(userID string, store ValidationStore) error

+ func GenerateProvisioningURI(secret, accountName string, config TOTPConfig) string

+ func GenerateSecret(size int) (string, error)

+ func GenerateTOTPCode(secret string, config TOTPConfig) (string, error)

+ func NewMiddleware(options ...func(*MiddlewareConfig)) mist.Middleware

+ func Validate(ctx *mist.Context, userID, code string, totp *TOTP, store ValidationStore, ...) error

+ func ValidateTOTPCode(secret, code string, config TOTPConfig) bool

+ func WithGetUserID(fn func(*mist.Context) (string, error)) func(*MiddlewareConfig)

+ func WithRedirectURL(url string) func(*MiddlewareConfig)

+ func WithStore(store ValidationStore) func(*MiddlewareConfig)

+ func WithUnauthorizedHandler(handler func(*mist.Context)) func(*MiddlewareConfig)

+ func WithValidationDuration(duration time.Duration) func(*MiddlewareConfig)

+ type MemoryStore struct

+ func NewMemoryStore() *MemoryStore

+ func (s *MemoryStore) Clear(userID string) error

+ func (s *MemoryStore) Set(userID string, expiry time.Duration) error

+ func (s *MemoryStore) Validate(userID string) (bool, error)

+ type MiddlewareConfig struct

+ GetUserID func(*mist.Context) (string, error)

+ OnUnauthorized func(*mist.Context)

+ RedirectURL string

+ Store ValidationStore

+ ValidationDuration time.Duration

+ type TOTP struct

+ Config TOTPConfig

+ Secret string

+ func NewTOTP(config ...TOTPConfig) (*TOTP, error)

+ func NewTOTPWithSecret(secret string, config ...TOTPConfig) *TOTP

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

+ func (t *TOTP) ProvisioningURI(accountName string) string

+ func (t *TOTP) Validate(code string) bool

+ type TOTPConfig struct

+ Algorithm string

+ Digits int

+ Issuer string

+ Period int

+ SecretSize int

+ func DefaultTOTPConfig() TOTPConfig

+ type ValidationStore interface

+ Clear func(userID string) error

+ Set func(userID string, expiry time.Duration) error

+ Validate func(userID string) (bool, error)