hotp

package

v0.0.0-...-bcc872a Latest Latest Go to latest Published: Oct 17, 2020 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/istsh/one-time-password

Documentation ¶

Index ¶

Variables
func GeneratePasscode(secret string, counter uint64) (string, error)
func GeneratePasscodeWithOption(secret string, counter uint64, opt *Option) (string, error)
func Validate(passcode string, secret string, counter uint64) (bool, error)
func ValidateWithOption(passcode string, secret string, counter uint64, opt *Option) (bool, error)
type Option
- func NewOption() *Option
- func (opt *Option) SetAlgorithm(a otpauth.Algorithm) error
- func (opt *Option) SetDigits(d otpauth.Digits) error

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrHOTPOptionIsNil = errors.New("hotp option is nil")

ErrHOTPOptionIsNil is an error when the hotp option is nil

Functions ¶

func GeneratePasscode ¶

func GeneratePasscode(secret string, counter uint64) (string, error)

GeneratePasscode generates a passcode with using default value of option

func GeneratePasscodeWithOption ¶

func GeneratePasscodeWithOption(secret string, counter uint64, opt *Option) (string, error)

GeneratePasscodeWithOption generates a passcode This function can pass custom value of option When this executes, it returns a HMAC-based One Time Password See: https://tools.ietf.org/html/rfc4226#section-5.2

func Validate ¶

func Validate(passcode string, secret string, counter uint64) (bool, error)

Validate validates a HMAC-based One Time Password with using default value of option

func ValidateWithOption ¶

func ValidateWithOption(passcode string, secret string, counter uint64, opt *Option) (bool, error)

ValidateWithOption validates a HMAC-based One Time Password This function can pass custom value of option

Types ¶

type Option ¶

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

Option is used when operates the HMAC-based One Time Password

func NewOption ¶

func NewOption() *Option

NewOption generates an option with default values

func (*Option) SetAlgorithm ¶

func (opt *Option) SetAlgorithm(a otpauth.Algorithm) error

SetAlgorithm sets the hash algorithm

func (*Option) SetDigits ¶

func (opt *Option) SetDigits(d otpauth.Digits) error

SetDigits sets the number of digits

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL