lusers

Documentation

Index

• Constants
• type ErrUserAlreadyExists
  • func (u ErrUserAlreadyExists) Error() string
• type Group
  • func (g *Group) AddUser(u *User) error
  • func (g *Group) HasUser(u *User) bool
• type User
  • func (u *User) CheckPassword(password string) error
  • func (u *User) In(group string) bool
  • func (u *User) OneRequired(groups []string) bool
  • func (u *User) SetPassword(password string) error
• type UserStore
  • func NewUserStore(f store.Factory) (*UserStore, error)
  • func (us *UserStore) Create(name, password string) (*User, error)
  • func (us *UserStore) GetByID(id []byte) (*User, error)
  • func (us *UserStore) GetByName(name string) (*User, error)
  • func (us *UserStore) Group(name string) (*Group, error)
  • func (us *UserStore) Groups() []string
  • func (us *UserStore) HasGroup(name string) *Group
  • func (us *UserStore) List() []string
  • func (us *UserStore) Login(name, password string) (*User, error)
  • func (us *UserStore) Update(u *User) error

Constants

const (
	UserIDLen       = 10
	ErrUserNotFound = lerr.Str("User not found")
)

Types

type ErrUserAlreadyExists

type ErrUserAlreadyExists string

func (ErrUserAlreadyExists) Error

func (u ErrUserAlreadyExists) Error() string

type Group

type Group struct {
	Name string
	store.Store
}

func (*Group) AddUser

func (g *Group) AddUser(u *User) error

func (*Group) HasUser

func (g *Group) HasUser(u *User) bool

type User

type User struct {
	ID             []byte `json:"-"`
	Name           string
	HashedPassword []byte
	Groups         slice.Slice[string]
}

func (*User) CheckPassword

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

func (*User) In

func (u *User) In(group string) bool

func (*User) OneRequired

func (u *User) OneRequired(groups []string) bool

OneRequired requires that a user be in one of the listed groups. If no groups are listed, the result is true.

func (*User) SetPassword

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

type UserStore

type UserStore struct {
	// contains filtered or unexported fields
}

func NewUserStore

func NewUserStore(f store.Factory) (*UserStore, error)

func (*UserStore) Create

func (us *UserStore) Create(name, password string) (*User, error)

func (*UserStore) GetByID

func (us *UserStore) GetByID(id []byte) (*User, error)

func (*UserStore) GetByName

func (us *UserStore) GetByName(name string) (*User, error)

func (*UserStore) Group

func (us *UserStore) Group(name string) (*Group, error)

Group will return a group with the provided name. If one does not already exist, it will be created.

func (*UserStore) Groups

func (us *UserStore) Groups() []string

func (*UserStore) HasGroup

func (us *UserStore) HasGroup(name string) *Group

HasGroup will return a group with the given name only if one already exists.

func (*UserStore) List

func (us *UserStore) List() []string

func (*UserStore) Login

func (us *UserStore) Login(name, password string) (*User, error)

func (*UserStore) Update

func (us *UserStore) Update(u *User) error