totp

Documentation

Overview

Package totp implements the TOTP algorithm according to RFC 6238

Index

• func WithSkew(skew int) otp.ValidationOption
• type Algorithm
  • func New(key []byte, opts ...Option) *Algorithm
  • func (a *Algorithm) Export(exporter otp.Exporter)
  • func (a *Algorithm) Generate(reference int64) string
  • func (a *Algorithm) Step() time.Duration
  • func (a *Algorithm) T0() int64
  • func (a *Algorithm) Validate(value string, reference int64, opts ...otp.ValidationOption) (int64, error)
• type Option
  • func WithDigits(digits otp.Digits) Option
  • func WithHashAlgorithm(algorithm otp.HashAlgorithm) Option
  • func WithT0(t0 int64) Option
  • func WithTimeStep(step time.Duration) Option

Functions

func WithSkew

func WithSkew(skew int) otp.ValidationOption

Types

type Algorithm

type Algorithm struct {
	hotp.Algorithm
	// contains filtered or unexported fields
}

func New

func New(key []byte, opts ...Option) *Algorithm

func (*Algorithm) Export

func (a *Algorithm) Export(exporter otp.Exporter)

func (*Algorithm) Generate

func (a *Algorithm) Generate(reference int64) string

func (*Algorithm) Step

func (a *Algorithm) Step() time.Duration

func (*Algorithm) T0

func (a *Algorithm) T0() int64

func (*Algorithm) Validate

func (a *Algorithm) Validate(value string, reference int64, opts ...otp.ValidationOption) (int64, error)

type Option

type Option func(alg *Algorithm)

func WithDigits

func WithDigits(digits otp.Digits) Option

func WithHashAlgorithm

func WithHashAlgorithm(algorithm otp.HashAlgorithm) Option

func WithT0

func WithT0(t0 int64) Option

func WithTimeStep

func WithTimeStep(step time.Duration) Option