otpauth

Documentation

Overview

Package otpauth implements encoding and decoding functionality for the otpauth URI scheme, defined by google (https://github.com/google/google-authenticator/wiki/Key-Uri-Format).

Index

• Constants
• Variables
• func ToURI(algorithm otp.Algorithm, accountName string, opts ...EncoderOption) string
• type AlgorithmParameters
  • func FromURI(value string) (*AlgorithmParameters, error)
  • func (d *AlgorithmParameters) AccountName() string
  • func (d *AlgorithmParameters) Algorithm() otp.Algorithm
  • func (d *AlgorithmParameters) Counter() int64
  • func (d *AlgorithmParameters) Issuer() string
  • func (d *AlgorithmParameters) Key() []byte
  • func (d *AlgorithmParameters) Type() Type
• type Encoder
  • func NewEncoder(alg otp.Algorithm, accountName string, opts ...EncoderOption) *Encoder
  • func (e *Encoder) Encode() string
• type EncoderOption
  • func WithCounter(counter int64) EncoderOption
  • func WithIssuer(issuer string) EncoderOption
• type Type

Constants

const (
	TOTP = "totp"
	HOTP = "hotp"
)

Variables

var (
	ErrUnsupportedURIScheme     = errors.New("unsupported uri scheme")
	ErrUnsupportedOTPAlgorithm  = errors.New("unsupported otp algorithm")
	ErrInvalidSecretEncoding    = errors.New("invalid secret encoding")
	ErrUnsupportedHashAlgorithm = errors.New("unsupported hash algorithm")
	ErrNoCounterPresent         = errors.New("no counter present")
)

Functions

func ToURI

func ToURI(algorithm otp.Algorithm, accountName string, opts ...EncoderOption) string

Types

type AlgorithmParameters

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

func FromURI

func FromURI(value string) (*AlgorithmParameters, error)

func (*AlgorithmParameters) AccountName

func (d *AlgorithmParameters) AccountName() string

func (*AlgorithmParameters) Algorithm

func (d *AlgorithmParameters) Algorithm() otp.Algorithm

func (*AlgorithmParameters) Counter

func (d *AlgorithmParameters) Counter() int64

func (*AlgorithmParameters) Issuer

func (d *AlgorithmParameters) Issuer() string

func (*AlgorithmParameters) Key

func (d *AlgorithmParameters) Key() []byte

func (*AlgorithmParameters) Type

func (d *AlgorithmParameters) Type() Type

type Encoder

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

func NewEncoder

func NewEncoder(alg otp.Algorithm, accountName string, opts ...EncoderOption) *Encoder

func (*Encoder) Encode

func (e *Encoder) Encode() string

type EncoderOption

type EncoderOption func(enc *exporter)

func WithCounter

func WithCounter(counter int64) EncoderOption

func WithIssuer

func WithIssuer(issuer string) EncoderOption

type Type

type Type string