twofactor

package

v0.0.0-...-a5fc328 Latest Latest Go to latest Published: Jun 16, 2020 License: MIT Imports: 9 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/NavPool/navpool-hq-api

Documentation ¶

Index ¶

Variables
func Disable(verification Verification, user account.User) (err error)
func Enable(verification Verification, user account.User) (err error)
func Verify(secret *string, code string, lastUsed *int) (bool, int, error)
type Controller
type Otp
- func GetSecret(accountName string, user account.User) (otp Otp, err error)
type Verification

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrTwoFactorAlreadyActive = errors.New("2FA already active on account")
	ErrTwoFactorNotActive     = errors.New("2FA is not active on account")
	ErrTwoFactorUnableToSetup = errors.New("Unable to generate new 2FA secret")
	ErrTwoFactorInvalidCode   = errors.New("Authentication code is invalid")
)

Functions ¶

func Disable ¶

func Disable(verification Verification, user account.User) (err error)

func Enable ¶

func Enable(verification Verification, user account.User) (err error)

func Verify ¶

func Verify(secret *string, code string, lastUsed *int) (bool, int, error)

Types ¶

type Controller ¶

type Controller struct{}

func (*Controller) DisableTwoFactor ¶

func (controller *Controller) DisableTwoFactor(c *gin.Context)

func (*Controller) EnableTwoFactor ¶

func (controller *Controller) EnableTwoFactor(c *gin.Context)

func (*Controller) GetTwoFactorSecret ¶

func (controller *Controller) GetTwoFactorSecret(c *gin.Context)

type Otp ¶

type Otp struct {
	Secret  string `json:"secret"`
	OtpAuth string `json:"otpauth"`
}

func GetSecret ¶

func GetSecret(accountName string, user account.User) (otp Otp, err error)

type Verification ¶

type Verification struct {
	Code     string  `json:"code"`
	Secret   *string `json:"secret"`
	LastUsed *int    `json:"-"`
}

Source Files ¶

View all Source files

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