twofactor

package module

v1.0.1 Latest Latest Go to latest Published: Aug 5, 2015 License: MIT Imports: 2 Imported by: 6

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

go-twofactor is a library for handling two-factor authentication in Go.
To use the library, you need to install one of the implementations below.

This implementation generates and verifies codes using the time-based one time password (TOTP) algorithm specified in RFC6238.

go get gopkg.in/zhevron/go-twofactor.v1/totp

go-twofactor is licensed under the MIT license.

Package twofactor contains support functions and types for two-factor authentication.

This package provides shared structs and functions for all implementations.

To generate a new secret for 2FA, use the NewSecret method:

import "gopkg.in/zhevron/go-twofactor.v1"
secret := twofactor.NewSecret(0)

This section is empty.

This section is empty.

func Int64ToBytes(n int64) []byte

Int64ToBytes converts a 64-bit integer to a 8-byte slice.

type Secret string

Secret wraps a string with functions to generate a cryptographically secure secret.

func NewSecret(length int) (Secret, error)

NewSecret generates a cryptograpically secure string of the given length. If the length provided is 0 or less, it will default to a length of 10.

func (s Secret) Bytes() ([]byte, error)

Bytes decodes the secret into a byte slice.

func (s Secret) String() string

String returns the secret as a string.

Path	Synopsis
totp Package totp contains an RFC6238 implementation of time-based one time passwords.	Package totp contains an RFC6238 implementation of time-based one time passwords.