gotp

README

🔒 gotp

gotp is a library for generating and verifying One-Time Passwords (OTP).

It supports both the TOTP (Time-based One-Time Password) algorithm as defined in RFC 6238, and the HOTP (HMAC-Based One-Time Password) algorithm as defined in RFC 4226.

Each package has been tesed against the test vectors provided in their respective RFC specifications.

Installation

go get -u github.com/Jaytpa01/gotp

Features

• TOTP:
  • Generate OTPs based off of the current time, or a specified time.
• HOTP:
  • Generate OTPs based off of a counter value.
• High-Level OTP Handling:
  • Unified interface for both TOTP and HOTP generation.
  • Easy to use API with flexible configuration and sensible defaults.

Usage

TODO: provide usage examples for the high-level otp handling, as well as examples for direct use of the hotp and totp packages.

Options

TODO: provide a reference for all options when creating a new otp instance. (functional options pattern)

Documentation

Index

• Constants
• Variables
• func Base32Decode(s string) ([]byte, error)
• func Base32Encode(data []byte) string
• func RandomSecret(length int) ([]byte, error)
• func WithBase32Secret(s string) option
• func WithCount(count int64) option
• func WithDigits(digits int) option
• func WithHOTP() option
• func WithHashingAlgorithm(ha HashingAlgorithm) option
• func WithIssuer(issuer string) option
• func WithPeriod(period int) option
• func WithSecret(secret []byte) option
• type Algorithm
• type HashingAlgorithm
• type OTP
  • func New(accountName string, options ...option) (*OTP, error)
  • func (o *OTP) At(time time.Time) *OTP
  • func (o *OTP) Base32Secret() string
  • func (o *OTP) Generate() (string, error)
  • func (o *OTP) Secret() []byte

Constants

const (
	DefaultWindow = 0
	DefaultDigits = 6
	DefaultPeriod = 30
)

Variables

var DefaultHashingAlgorithm = sha1.New

Functions

func Base32Decode

func Base32Decode(s string) ([]byte, error)

func Base32Encode

func Base32Encode(data []byte) string

func RandomSecret

func RandomSecret(length int) ([]byte, error)

func WithBase32Secret

func WithBase32Secret(s string) option

func WithCount

func WithCount(count int64) option

func WithDigits

func WithDigits(digits int) option

func WithHOTP

func WithHOTP() option

func WithHashingAlgorithm

func WithHashingAlgorithm(ha HashingAlgorithm) option

func WithIssuer

func WithIssuer(issuer string) option

func WithPeriod

func WithPeriod(period int) option

func WithSecret

func WithSecret(secret []byte) option

Types

type Algorithm

type Algorithm int

const (
	TOTP Algorithm = iota
	HOTP
)

type HashingAlgorithm

type HashingAlgorithm int

const (
	SHA1 HashingAlgorithm = iota
	SHA256
	SHA512
)

type OTP

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

func New

func New(accountName string, options ...option) (*OTP, error)

func (*OTP) At

func (o *OTP) At(time time.Time) *OTP

func (*OTP) Base32Secret

func (o *OTP) Base32Secret() string

func (*OTP) Generate

func (o *OTP) Generate() (string, error)

func (*OTP) Secret

func (o *OTP) Secret() []byte