mfa

Documentation

Index

• Variables
• type Client
  • func NewClient(cfg ClientConfig) (*Client, error)
  • func (c *Client) ConsumePendingSetup(ctx context.Context, userID, token string) (string, error)
  • func (c *Client) ConsumeRecoveryCode(ctx context.Context, userID, code string) (bool, error)
  • func (c *Client) CreateRecoveryCodes(ctx context.Context, userID string) ([]string, error)
  • func (c *Client) GenerateTOTPSetup(accountLabel string) (*otp.Key, error)
  • func (c *Client) HasTwoFactorEnabled(ctx context.Context, userID string) (bool, error)
  • func (c *Client) LoadPendingSetupSecret(ctx context.Context, userID, token string) (string, error)
  • func (c *Client) LoadUserTOTPSecret(ctx context.Context, userID string) (string, error)
  • func (c *Client) StartPendingSetup(ctx context.Context, userID, secret string) (string, error)
  • func (c *Client) UpsertUserTOTPSecret(ctx context.Context, userID, secret string) error
  • func (c *Client) VerifyTOTPCode(secret, code string, now time.Time) bool
• type ClientConfig

Variables

var ErrInvalidTwoFactorCode = errors.New("invalid two-factor code")

Types

type Client

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

func NewClient

func NewClient(cfg ClientConfig) (*Client, error)

func (*Client) ConsumePendingSetup

func (c *Client) ConsumePendingSetup(ctx context.Context, userID, token string) (string, error)

func (*Client) ConsumeRecoveryCode

func (c *Client) ConsumeRecoveryCode(ctx context.Context, userID, code string) (bool, error)

func (*Client) CreateRecoveryCodes

func (c *Client) CreateRecoveryCodes(ctx context.Context, userID string) ([]string, error)

func (*Client) GenerateTOTPSetup

func (c *Client) GenerateTOTPSetup(accountLabel string) (*otp.Key, error)

func (*Client) HasTwoFactorEnabled

func (c *Client) HasTwoFactorEnabled(ctx context.Context, userID string) (bool, error)

func (*Client) LoadPendingSetupSecret

func (c *Client) LoadPendingSetupSecret(ctx context.Context, userID, token string) (string, error)

func (*Client) LoadUserTOTPSecret

func (c *Client) LoadUserTOTPSecret(ctx context.Context, userID string) (string, error)

func (*Client) StartPendingSetup

func (c *Client) StartPendingSetup(ctx context.Context, userID, secret string) (string, error)

func (*Client) UpsertUserTOTPSecret

func (c *Client) UpsertUserTOTPSecret(ctx context.Context, userID, secret string) error

func (*Client) VerifyTOTPCode

func (c *Client) VerifyTOTPCode(secret, code string, now time.Time) bool

type ClientConfig

type ClientConfig struct {
	DB                *sql.DB
	EncryptionKey     []byte
	Issuer            string
	PendingSetupTTL   time.Duration
	RecoveryCodeCount int
}