otp

Documentation

Overview

Package otp provides functionality for generating and reading One-Time Passwords.

Index

• type HOTP
  • func (hotp HOTP) Code() any
  • func (hotp HOTP) Digits() int
  • func (hotp HOTP) String() string
• type MOTP
  • func GenerateMOTP(secret []byte, algo string, digits int, period int64, pin string) (MOTP, error)
  • func GenerateMOTPAt(secret []byte, algo string, digits int, period int64, pin string, sec int64) (MOTP, error)
  • func (motp MOTP) Code() any
  • func (motp MOTP) Digits() int
  • func (motp MOTP) String() string
• type OTP
• type SteamOTP
  • func GenerateSteamOTP(secret []byte, algo string, digits int, period int64) (SteamOTP, error)
  • func GenerateSteamOTPAt(secret []byte, algo string, digits int, period int64, seconds int64) (SteamOTP, error)
  • func (sotp SteamOTP) Code() any
  • func (sotp SteamOTP) Digits() int
  • func (sotp SteamOTP) String() string
• type TOTP
  • func GenerateTOTP(secret []byte, algo string, digits int, period int64) (TOTP, error)
  • func GenerateTOTPAt(secret []byte, algo string, digits int, period int64, seconds int64) (TOTP, error)
  • func (totp TOTP) Code() any
  • func (totp TOTP) Digits() int
  • func (totp TOTP) String() string

Types

type HOTP

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

HOTP is not implemented due to syncing concerns.

This is a placeholder that doesn't contain real data.

func (HOTP) Code

func (hotp HOTP) Code() any

Code returns the raw code used for calculating the OTP.

func (HOTP) Digits

func (hotp HOTP) Digits() int

Digits returns the character/digit length of the OTP.

func (HOTP) String

func (hotp HOTP) String() string

String returns the calculated OTP used to authenticate with a service.

type MOTP

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

func GenerateMOTP

func GenerateMOTP(secret []byte, algo string, digits int, period int64, pin string) (MOTP, error)

Generates an MOTP for the current time

func GenerateMOTPAt

func GenerateMOTPAt(secret []byte, algo string, digits int, period int64, pin string, sec int64) (MOTP, error)

Generates an MOTP at the specified time in seconds

func (MOTP) Code

func (motp MOTP) Code() any

Code returns the raw code used for calculating the OTP.

func (MOTP) Digits

func (motp MOTP) Digits() int

Digits returns the character/digit length of the OTP.

func (MOTP) String

func (motp MOTP) String() string

String returns the calculated OTP used to authenticate with a service.

type OTP

type OTP interface {
	Code() any
	Digits() int
	String() string
}

type SteamOTP

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

func GenerateSteamOTP

func GenerateSteamOTP(secret []byte, algo string, digits int, period int64) (SteamOTP, error)

Generates a Steam OTP for the current time

func GenerateSteamOTPAt

func GenerateSteamOTPAt(secret []byte, algo string, digits int, period int64, seconds int64) (SteamOTP, error)

Generates a Steam OTP at the specified time in seconds

func (SteamOTP) Code

func (sotp SteamOTP) Code() any

Code returns the raw code used for calculating the OTP.

func (SteamOTP) Digits

func (sotp SteamOTP) Digits() int

Digits returns the character/digit length of the OTP.

func (SteamOTP) String

func (sotp SteamOTP) String() string

String returns the calculated OTP used to authenticate with a service.

type TOTP

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

func GenerateTOTP

func GenerateTOTP(secret []byte, algo string, digits int, period int64) (TOTP, error)

Generates a TOTP for the current time

func GenerateTOTPAt

func GenerateTOTPAt(secret []byte, algo string, digits int, period int64, seconds int64) (TOTP, error)

Generates a TOTP at the specified time in seconds

func (TOTP) Code

func (totp TOTP) Code() any

Code returns the raw code used for calculating the OTP.

func (TOTP) Digits

func (totp TOTP) Digits() int

Digits returns the character/digit length of the OTP.

func (TOTP) String

func (totp TOTP) String() string

String returns the calculated OTP used to authenticate with a service.