auth

Documentation

Index

• type IAuth
  • func New(settings *models.Settings, prompts prompts.IPrompts) IAuth
• type SAuth
  • func (a *SAuth) Signin() (*models.User, error)
  • func (a *SAuth) Signout() error
  • func (a *SAuth) Verify() (*models.User, error)

Types

type IAuth

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

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

type SAuth

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

SAuth is a concrete implementation of IAuth

func (*SAuth) Signin

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 (*SAuth) Signout

func (a *SAuth) Signout() error

Signout signs out a user by their session token.

func (*SAuth) Verify

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.