googleauthenticator

README

googleauthenticator

Two- / Multi- Factor Authenication (2FA / MFA) for Golang

Installation

To get the package, execute:

go get github.com/dev-templates/googleauthenticator

Usage

package main

import (
    "fmt"

    "github.com/dev-templates/googleauthenticator"
)

func main {
    // generate key
    formattedKey := googleauthenticator.GenerateKey()
    authenticator := googleauthenticator.NewAuthenticator("issuer", "xxx@gmail.com", formattedKey)
    // generate uri for show
    uri := authenticator.GenerateTotpUri()
    fmt.Println(uri)
    // verify token
    passcode := "<from input>"
    if authenticator.VerifyToken(passcode) {
        // ok
    }
}

Documentation

Index

• func GenerateKey() (formattedKey string)
• type Authenticator
  • func NewAuthenticator(issuer string, accountName string, formattedKey string) *Authenticator
  • func (a *Authenticator) GenerateToken() (passcode string)
  • func (a *Authenticator) GenerateTotpUri() string
  • func (a *Authenticator) VerifyToken(passcode string) bool

Functions

func GenerateKey

func GenerateKey() (formattedKey string)

Types

type Authenticator

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

func NewAuthenticator

func NewAuthenticator(issuer string, accountName string, formattedKey string) *Authenticator

func (*Authenticator) GenerateToken

func (a *Authenticator) GenerateToken() (passcode string)

func (*Authenticator) GenerateTotpUri

func (a *Authenticator) GenerateTotpUri() string

func (*Authenticator) VerifyToken

func (a *Authenticator) VerifyToken(passcode string) bool