users

Documentation

Index

• Variables
• func Create(u *User) error
• func Normalize(username string) string
• func UsernameExists(username string) bool
• type ByName
• type User
  • func CheckAuth(username, password string) (*User, error)
  • func DeletedUser() *User
  • func Load(id int) (*User, error)
  • func LoadReadonly(id int) (*User, error)
  • func LoadUsername(username string) (*User, error)
  • func (u *User) Save() error
  • func (u *User) SetPassword(password string) error

Variables

var DB *jsondb.DB

DB is a reference to the parent app's JsonDB object.

var HashCost = 14

HashCost is the cost value given to bcrypt to hash passwords. TODO: make configurable from main package

Functions

func Create

func Create(u *User) error

Create a new user.

func Normalize

func Normalize(username string) string

Normalize lowercases and safens a username.

func UsernameExists

func UsernameExists(username string) bool

UsernameExists checks if a username is taken.

Types

type ByName

type ByName struct {
	ID int `json:"id"`
}

ByName model maps usernames to their IDs.

type User

type User struct {
	ID       int    `json:"id"`
	Username string `json:"username"`
	Password string `json:"password"`
	Admin    bool   `json:"admin"`
	Name     string `json:"name"`
	Email    string `json:"email"`

	IsAuthenticated bool `json:"-"`
	// contains filtered or unexported fields
}

User holds information about a user account.

func CheckAuth

func CheckAuth(username, password string) (*User, error)

CheckAuth tests a login with a username and password.

func DeletedUser

func DeletedUser() *User

DeletedUser returns a User object to represent a deleted (non-existing) user.

func Load

func Load(id int) (*User, error)

Load a user by their ID number.

func LoadReadonly

func LoadReadonly(id int) (*User, error)

LoadReadonly loads a user for read-only use, so the Password is masked.

func LoadUsername

func LoadUsername(username string) (*User, error)

LoadUsername loads a user by username.

func (*User) Save

func (u *User) Save() error

Save the user.

func (*User) SetPassword

func (u *User) SetPassword(password string) error

SetPassword sets a user's password by bcrypt hashing it. After this function, u.Password will contain the bcrypt hash.