auth

package

v0.0.0-...-493bf59 Latest Latest Go to latest Published: Jun 1, 2021 License: Apache-2.0 Imports: 13 Imported by: 32

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 IAuth interface {
	Signin() (*models.User, error)
	Signout() error
	Verify() (*models.User, error)
}

IAuth represents the contract that concrete implementations should follow when implementing authentication.

func New(settings *models.Settings, prompts prompts.IPrompts) IAuth

type SAuth struct {
	Settings *models.Settings
	Prompts  prompts.IPrompts
}

SAuth is a concrete implementation of IAuth

func (a *SAuth) Signin() (*models.User, error)

Signin signs in a user and returns the representative user model. If an error occurs, nil is returned for the user and the error field is populated.

func (a *SAuth) Signout() error

Signout signs out a user by their session token.

func (a *SAuth) Verify() (*models.User, error)

Verify verifies if a given session token is still valid or not. If it is valid, the returned error will be nil.