auth

package

v1.6.0 Latest Latest Go to latest Published: Oct 11, 2019 License: MIT Imports: 6 Imported by: 1

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

This section is empty.

This section is empty.

This section is empty.

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

An Authenticator contains a list of authenticated web UI sessions and exposes a few functions for authenticating users and generating tokens.

func New(config *Config) *Authenticator

New returns a new Authenticator instance and spins up a goroutine that handles expiring sessions

func (a *Authenticator) Authenticate(w http.ResponseWriter, r *http.Request) (bool, error)

Authenticate logs in the client if the request contains a token and checks whether the current request is authenticated.

func (a *Authenticator) ExpireClients()

ExpireClients expires all sessions that have been logged in for 48+ hours.

func (a *Authenticator) GetToken() (string, error)

GetToken generates a TOTP token that is valid for 30 seconds.

type Client struct {
	UUID  string
	Added time.Time
}

A Client is an authenticated web UI session

type Config struct {
	Token string
	Log   *log.Log
}

Config contains the config options for the TOTP authentication serivce that is used for the web UI.