mfa

Documentation

Index

• Variables
• type MFA
  • func New(store Store) *MFA
  • func (m *MFA) Activate(userMfaSecret, userID string, token string) error
  • func (m *MFA) Deactivate(userId string) error
  • func (m *MFA) GenerateSecret(siteURL, userEmail, userID string) (string, []byte, error)
  • func (m *MFA) ValidateToken(secret, token string) (bool, error)
• type Store

Variables

var InvalidToken = errors.New("invalid mfa token")

InvalidToken indicates the case where the token validation has failed.

Types

type MFA

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

func New

func New(store Store) *MFA

func (*MFA) Activate

func (m *MFA) Activate(userMfaSecret, userID string, token string) error

Activate set the mfa as active and store it with the StoreActive function provided

func (*MFA) Deactivate

func (m *MFA) Deactivate(userId string) error

Deactivate set the mfa as deactive, remove the mfa secret, store it with the StoreActive and StoreSecret functions provided

func (*MFA) GenerateSecret

func (m *MFA) GenerateSecret(siteURL, userEmail, userID string) (string, []byte, error)

GenerateSecret generates a new user mfa secret and store it with the StoreSecret function provided

func (*MFA) ValidateToken

func (m *MFA) ValidateToken(secret, token string) (bool, error)

Validate the provide token using the secret provided

type Store

type Store interface {
	UpdateMfaActive(userId string, active bool) error
	UpdateMfaSecret(userId, secret string) error
}