totp2fa

Documentation

Overview

Package totp2fa implements two factor auth using time-based one time passwords.

Index

• Constants
• type TOTP
  • func (t *TOTP) BeforeAuth(w http.ResponseWriter, r *http.Request, handled bool) (bool, error)
  • func (t *TOTP) GetConfirm(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) GetQRCode(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) GetRemove(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) GetSetup(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) GetValidate(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) PostConfirm(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) PostRemove(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) PostSetup(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) PostValidate(w http.ResponseWriter, r *http.Request) error
  • func (t *TOTP) Setup() error
• type TOTPCodeValuer
  • func MustHaveTOTPCodeValues(v authboss.Validator) TOTPCodeValuer
• type User

Constants

const (
	SessionTOTPSecret     = "totp_secret"
	SessionTOTPPendingPID = "totp_pending"
)

Session keys

const (
	PageTOTPConfirm        = "totp2fa_confirm"
	PageTOTPConfirmSuccess = "totp2fa_confirm_success"
	PageTOTPRemove         = "totp2fa_remove"
	PageTOTPRemoveSuccess  = "totp2fa_remove_success"
	PageTOTPSetup          = "totp2fa_setup"
	PageTOTPValidate       = "totp2fa_validate"
)

Pages

const (
	DataTOTPSecret = SessionTOTPSecret
)

Data constants

const (
	FormValueCode = "code"
)

Form value constants

Types

type TOTP

type TOTP struct {
	*authboss.Authboss
}

TOTP implements time based one time passwords

func (*TOTP) BeforeAuth

func (t *TOTP) BeforeAuth(w http.ResponseWriter, r *http.Request, handled bool) (bool, error)

BeforeAuth stores the user's pid in a special temporary session variable and redirects them to the validation endpoint.

func (*TOTP) GetConfirm

func (t *TOTP) GetConfirm(w http.ResponseWriter, r *http.Request) error

GetConfirm requests a user to enter their totp code

func (*TOTP) GetQRCode

func (t *TOTP) GetQRCode(w http.ResponseWriter, r *http.Request) error

GetQRCode responds with a QR code image

func (*TOTP) GetRemove

func (t *TOTP) GetRemove(w http.ResponseWriter, r *http.Request) error

GetRemove starts removal

func (*TOTP) GetSetup

func (t *TOTP) GetSetup(w http.ResponseWriter, r *http.Request) error

GetSetup shows a screen allows a user to opt in to setting up totp 2fa

func (*TOTP) GetValidate

func (t *TOTP) GetValidate(w http.ResponseWriter, r *http.Request) error

GetValidate shows a page to enter a code into

func (*TOTP) PostConfirm

func (t *TOTP) PostConfirm(w http.ResponseWriter, r *http.Request) error

PostConfirm finally activates totp if the code matches

func (*TOTP) PostRemove

func (t *TOTP) PostRemove(w http.ResponseWriter, r *http.Request) error

PostRemove removes totp

func (*TOTP) PostSetup

func (t *TOTP) PostSetup(w http.ResponseWriter, r *http.Request) error

PostSetup prepares adds a key to the user's session

func (*TOTP) PostValidate

func (t *TOTP) PostValidate(w http.ResponseWriter, r *http.Request) error

PostValidate redirects on success

func (*TOTP) Setup

func (t *TOTP) Setup() error

Setup the module

type TOTPCodeValuer

type TOTPCodeValuer interface {
	authboss.Validator

	GetCode() string
	GetRecoveryCode() string
}

TOTPCodeValuer returns a code from the body

func MustHaveTOTPCodeValues

func MustHaveTOTPCodeValues(v authboss.Validator) TOTPCodeValuer

MustHaveTOTPCodeValues upgrades a validatable set of values to ones specific to a user that needs to be recovered.

type User

type User interface {
	twofactor.User

	GetTOTPSecretKey() string
	PutTOTPSecretKey(string)
}

User for TOTP