twofa

README

Two-FA

A two-factor authentication(2FA) based on HOTP & TOTP written in Go.

Features

• Based on HOTP/TOTP algorithm
• Get code by encoded key
• Encode/Decode key
• Encode key for iOS
• Encode key with hash
• Gen random key
• Print QR for Google Authenticator in terminal

Install

go get github.com/jovijovi/two-fa

Example Usage

• Samples

Roadmap

• Documents

License

This project is licensed under the BSD 3-Clause License.

Documentation

Index

• Constants
• func DecodeKey(key string) ([]byte, error)
• func EncodeKey(raw string, opt ...OptionFunc) string
• func EncodeKeyForIOS(raw string, opt ...OptionFunc) string
• func GenKey(opt ...OptionFunc) string
• func GenKeyForIOS(opt ...OptionFunc) string
• func GetCode(key string) (string, error)
• func GetCodeByRaw(key Key) (uint32, error)
• func PrintQR(content string) error
• type HashFunc
  • func (h *HashFunc) Hash(msg []byte) ([]byte, error)
• type HashProvider
• type IHashFunc
  • func DefaultHashFunc() IHashFunc
• type Key
• type OptionFunc
  • func WithDefaultHashFunc() OptionFunc
  • func WithHashFunc(hashFunc IHashFunc) OptionFunc
  • func WithQR(name string) OptionFunc
• type Options
  • func NewOptions(optionFunc ...OptionFunc) Options

Constants

const (
	CodeDigits6 = 6
	CodeDigits7 = 7
	CodeDigits8 = 8

	// TotpFormatter TOTP formatter
	// Example:
	// otpauth://totp/NAME?secret=KEY
	TotpFormatter = "otpauth://totp/%s?secret=%s"
)

const (
	BrightBlack = "\033[48;5;0m  \033[0m"
	BrightWhite = "\033[48;5;7m  \033[0m"
)

Functions

func DecodeKey

func DecodeKey(key string) ([]byte, error)

DecodeKey returns decoded key

func EncodeKey

func EncodeKey(raw string, opt ...OptionFunc) string

EncodeKey returns encoded key

func EncodeKeyForIOS

func EncodeKeyForIOS(raw string, opt ...OptionFunc) string

EncodeKeyForIOS returns encoded key for iOS

func GenKey

func GenKey(opt ...OptionFunc) string

GenKey returns random encoded key

func GenKeyForIOS

func GenKeyForIOS(opt ...OptionFunc) string

GenKeyForIOS returns random encoded key for iOS

func GetCode

func GetCode(key string) (string, error)

GetCode returns time based code by encode key

func GetCodeByRaw

func GetCodeByRaw(key Key) (uint32, error)

GetCodeByRaw returns time based code by raw key

func PrintQR

func PrintQR(content string) error

Types

type HashFunc

type HashFunc struct {
	Provider HashProvider
}

func (*HashFunc) Hash

func (h *HashFunc) Hash(msg []byte) ([]byte, error)

type HashProvider

type HashProvider func() hash.Hash

type IHashFunc

type IHashFunc interface {
	Hash(msg []byte) ([]byte, error)
}

func DefaultHashFunc

func DefaultHashFunc() IHashFunc

type Key

type Key struct {
	Raw    []byte
	Digits uint32
	Offset uint32 // counter offset
}

type OptionFunc

type OptionFunc func(opts *Options)

OptionFunc used to initialise

func WithDefaultHashFunc

func WithDefaultHashFunc() OptionFunc

WithDefaultHashFunc option to configure default hash function (sha1)

func WithHashFunc

func WithHashFunc(hashFunc IHashFunc) OptionFunc

WithHashFunc option to configure hash function

func WithQR

func WithQR(name string) OptionFunc

WithQR option to configure QR

type Options

type Options struct {
	// HashFunc interface
	HashFunc IHashFunc

	// With hash
	WithHash bool

	// Key name
	KeyName string

	// With QR
	WithQR bool

	// Options for implementations of the interface can be stored in a context
	Context context.Context
}

Options for func

func NewOptions

func NewOptions(optionFunc ...OptionFunc) Options

NewOptions new options