gauth

README

go-gauth

go-gauth is a simple library for integrating Google Authenticator based two factor authentication into your Go application. It should be pretty straight forward to use, but in the case that there is any confusion, you can refer to the godoc.

Documentation

Index

• Constants
• func GenerateSecret() (string, error)
• func GetOTP(secret string) (string, error)
• func ValidateOTP(otp, secret string) bool

Constants

const (
	RETURN_DIGITS int = 6
	SECRET_LENGTH int = 16
)

Functions

func GenerateSecret

func GenerateSecret() (string, error)

Generates a cryptographically secure base32 string that is the proper length for a secret to be used with Google Authenticator. This can be used for generating new secrets.

func GetOTP

func GetOTP(secret string) (string, error)

Returns a string containing the TOTP token associated with the provided secret at the current time. The secret should be base32 encoded.

func ValidateOTP

func ValidateOTP(otp, secret string) bool

Returns a boolean indicating if the provided otp string is valid for the provided secret at the current time. The secret should be base32 encoded.