users

Documentation

Index

• Variables
• func DerivePasswordKey(password string, passwordSaltHex ...string) ([]byte, []byte, error)
• type User
  • func NewUser(username, passwordHashHex, passwordSaltHex string, ...) (*User, error)
  • func (u *User) Clone() onchangemap.Item[string, util.ComparableString]
  • func (u *User) ID() util.ComparableString
  • func (u *User) PermissionsSlice() []string
• type UserManager
  • func NewUserManager(storeCallback func([]*User) error) *UserManager
  • func (m *UserManager) AddUser(user *User) error
  • func (m *UserManager) ChangeUserPassword(name string, passwordHash, passwordSalt []byte) error
  • func (m *UserManager) ChangeUserPermissions(name string, permissions map[string]struct{}) error
  • func (m *UserManager) EnableStoreOnChange()
  • func (m *UserManager) ModifyUser(user *User) error
  • func (m *UserManager) RemoveUser(name string) error
  • func (m *UserManager) SanitizePermissions(permissions map[string]struct{}) map[string]struct{}
  • func (m *UserManager) User(name string) (*User, error)
  • func (m *UserManager) Users() map[string]*User

Variables

var AllowedPermissions = []string{"read", "write"}

Functions

func DerivePasswordKey

func DerivePasswordKey(password string, passwordSaltHex ...string) ([]byte, []byte, error)

DerivePasswordKey derives a password key by hashing the given password with a salt.

Types

type User

type User struct {
	Name         string
	PasswordHash []byte
	PasswordSalt []byte
	Permissions  map[string]struct{}
}

func NewUser

func NewUser(username, passwordHashHex, passwordSaltHex string, permissions map[string]struct{}) (*User, error)

func (*User) Clone

func (u *User) Clone() onchangemap.Item[string, util.ComparableString]

Clone returns a copy of a user.

func (*User) ID

func (u *User) ID() util.ComparableString

func (*User) PermissionsSlice

func (u *User) PermissionsSlice() []string

PermissionsSlice returns the permissions of the user as a slice.

type UserManager

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

UserManager handles the list of users that are stored in the user config. It calls a function if the list changed.

func NewUserManager

func NewUserManager(storeCallback func([]*User) error) *UserManager

NewUserManager creates a new user manager.

func (*UserManager) AddUser

func (m *UserManager) AddUser(user *User) error

AddUser adds a user to the user manager.

func (*UserManager) ChangeUserPassword

func (m *UserManager) ChangeUserPassword(name string, passwordHash, passwordSalt []byte) error

ChangeUserPassword changes the password of a user.

func (*UserManager) ChangeUserPermissions

func (m *UserManager) ChangeUserPermissions(name string, permissions map[string]struct{}) error

ChangeUserPermissions changes the permissions of a user.

func (*UserManager) EnableStoreOnChange

func (m *UserManager) EnableStoreOnChange()

func (*UserManager) ModifyUser

func (m *UserManager) ModifyUser(user *User) error

ModifyUser modifies a user in the user manager.

func (*UserManager) RemoveUser

func (m *UserManager) RemoveUser(name string) error

RemoveUser removes a user from the user manager.

func (*UserManager) SanitizePermissions

func (m *UserManager) SanitizePermissions(permissions map[string]struct{}) map[string]struct{}

func (*UserManager) User

func (m *UserManager) User(name string) (*User, error)

User returns a copy of a user.

func (*UserManager) Users

func (m *UserManager) Users() map[string]*User

Users returns a copy of all known users.