user

Documentation

Overview

Package user contains the type definitions for user accounts and the user server interface.

Index

• Variables
• func ValidName(name string) (bool, i18n.Key)
• func ValidPassword(passwd string) (bool, i18n.Key)
• type Account
  • func NewAccount(r *NewAccountRequest) *Account
  • func (a *Account) Equals(b *Account) bool
• type Name
• type NewAccountRequest
• type Server

Variables

var AccountNotFound = errors.New("Account not found")

Functions

func ValidName

func ValidName(name string) (bool, i18n.Key)

ValidName checks whether a username is acceptable. If not, a message is returned (a non-empty i18n key).

func ValidPassword

func ValidPassword(passwd string) (bool, i18n.Key)

ValidPassword checks whether a password is strong enough. If not, a message is returned (a non-empty i18n key).

Types

type Account

type Account struct {
	Name         Name
	UILocale     string
	MainLanguage language.Code
	Email        string
	Active       bool
	PasswordHash []byte
}

func NewAccount

func NewAccount(r *NewAccountRequest) *Account

func (*Account) Equals

func (a *Account) Equals(b *Account) bool

type Name

type Name string

type NewAccountRequest

type NewAccountRequest struct {
	Name         Name
	UILocale     string
	Email        string
	PasswordHash []byte
}

type Server

type Server interface {
	NewAccount(r *NewAccountRequest) (*Account, error)
	GetAccount(n Name) (*Account, error)
	GetAccountByEmail(email string) (*Account, error)
	UpdateAccount(a *Account) error

	NewToken(n Name) (string, error)
	ValidToken(n Name, token string) (bool, error)
	DeleteToken(n Name, token string) error
}

Server is the interface a user server should comply to.