totp

Documentation

Index

• func NewTOTPOptionsFromSchema(config schema.TOTP) *model.TOTPOptions
• type Context
  • func NewContext(ctx context.Context, clock clock.Provider, random random.Provider) Context
• type Provider
• type SimpleContext
  • func (c *SimpleContext) GetClock() clock.Provider
  • func (c *SimpleContext) GetRandom() random.Provider
• type TimeBased
  • func NewTimeBasedProvider(config schema.TOTP) (provider *TimeBased)
  • func (p TimeBased) Generate(ctx Context, username string) (config *model.TOTPConfiguration, err error)
  • func (p TimeBased) GenerateCustom(ctx Context, username, algorithm, secret string, ...) (config *model.TOTPConfiguration, err error)
  • func (p TimeBased) Options() model.TOTPOptions
  • func (p TimeBased) Validate(ctx Context, token string, config *model.TOTPConfiguration) (valid bool, step uint64, err error)

Functions

func NewTOTPOptionsFromSchema

func NewTOTPOptionsFromSchema(config schema.TOTP) *model.TOTPOptions

Types

type Context

type Context interface {
	context.Context

	GetClock() clock.Provider
	GetRandom() random.Provider
}

func NewContext

func NewContext(ctx context.Context, clock clock.Provider, random random.Provider) Context

type Provider

type Provider interface {
	Generate(ctx Context, username string) (config *model.TOTPConfiguration, err error)
	GenerateCustom(ctx Context, username string, algorithm, secret string, digits, period, secretSize uint) (config *model.TOTPConfiguration, err error)
	Validate(ctx Context, token string, config *model.TOTPConfiguration) (valid bool, step uint64, err error)
	Options() model.TOTPOptions
}

Provider for TOTP functionality.

type SimpleContext

type SimpleContext struct {
	context.Context
	// contains filtered or unexported fields
}

func (*SimpleContext) GetClock

func (c *SimpleContext) GetClock() clock.Provider

func (*SimpleContext) GetRandom

func (c *SimpleContext) GetRandom() random.Provider

type TimeBased

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

TimeBased totp.Provider for production use.

func NewTimeBasedProvider

func NewTimeBasedProvider(config schema.TOTP) (provider *TimeBased)

NewTimeBasedProvider creates a new totp.TimeBased which implements the totp.Provider.

func (TimeBased) Generate

func (p TimeBased) Generate(ctx Context, username string) (config *model.TOTPConfiguration, err error)

Generate generates a TOTP with default options.

func (TimeBased) GenerateCustom

func (p TimeBased) GenerateCustom(ctx Context, username, algorithm, secret string, digits, period, secretSize uint) (config *model.TOTPConfiguration, err error)

GenerateCustom generates a TOTP with custom options.

func (TimeBased) Options

func (p TimeBased) Options() model.TOTPOptions

Options returns the configured options for this provider.

func (TimeBased) Validate

func (p TimeBased) Validate(ctx Context, token string, config *model.TOTPConfiguration) (valid bool, step uint64, err error)

Validate the token against the given configuration.