users

Documentation

Overview

Package users support all common action on the system for user handling.

Index

• Variables
• type Config
• type Manager
  • func NewManager(config Config, cacheDir string, args ...Option) (m *Manager, err error)
  • func (m *Manager) AllGroups() ([]types.GroupEntry, error)
  • func (m *Manager) AllShadows() ([]types.ShadowEntry, error)
  • func (m *Manager) AllUsers() ([]types.UserEntry, error)
  • func (m *Manager) BrokerForUser(username string) (string, error)
  • func (m *Manager) GroupByID(gid uint32) (types.GroupEntry, error)
  • func (m *Manager) GroupByName(groupname string) (types.GroupEntry, error)
  • func (m *Manager) RegisterUserPreAuth(name string) (uint32, error)
  • func (m *Manager) ShadowByName(username string) (types.ShadowEntry, error)
  • func (m *Manager) Stop() error
  • func (m *Manager) UpdateBrokerForUser(username, brokerID string) error
  • func (m *Manager) UpdateUser(u types.UserInfo) (err error)
  • func (m *Manager) UserByID(uid uint32) (types.UserEntry, error)
  • func (m *Manager) UserByName(username string) (types.UserEntry, error)
• type NoDataFoundError
• type Option
  • func WithIDGenerator(g tempentries.IDGenerator) Option

Variables

var DefaultConfig = Config{
	UIDMin: 1000000000,
	UIDMax: 1999999999,
	GIDMin: 1000000000,
	GIDMax: 1999999999,
}

DefaultConfig is the default configuration for the user manager.

Types

type Config

type Config struct {
	UIDMin uint32 `mapstructure:"uid_min"`
	UIDMax uint32 `mapstructure:"uid_max"`
	GIDMin uint32 `mapstructure:"gid_min"`
	GIDMax uint32 `mapstructure:"gid_max"`
}

Config is the configuration for the user manager.

type Manager

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

Manager is the manager for any user related operation.

func NewManager

func NewManager(config Config, cacheDir string, args ...Option) (m *Manager, err error)

NewManager creates a new user manager.

func (*Manager) AllGroups

func (m *Manager) AllGroups() ([]types.GroupEntry, error)

AllGroups returns all groups.

func (*Manager) AllShadows

func (m *Manager) AllShadows() ([]types.ShadowEntry, error)

AllShadows returns all shadow entries.

func (*Manager) AllUsers

func (m *Manager) AllUsers() ([]types.UserEntry, error)

AllUsers returns all users.

func (*Manager) BrokerForUser

func (m *Manager) BrokerForUser(username string) (string, error)

BrokerForUser returns the broker ID for the given user.

func (*Manager) GroupByID

func (m *Manager) GroupByID(gid uint32) (types.GroupEntry, error)

GroupByID returns the group information for the given group ID.

func (*Manager) GroupByName

func (m *Manager) GroupByName(groupname string) (types.GroupEntry, error)

GroupByName returns the group information for the given group name.

func (*Manager) RegisterUserPreAuth

func (m *Manager) RegisterUserPreAuth(name string) (uint32, error)

RegisterUserPreAuth registers a temporary user with a unique UID in our NSS handler (in memory, not in the database).

The temporary user record is removed when UpdateUser is called with the same username.

func (*Manager) ShadowByName

func (m *Manager) ShadowByName(username string) (types.ShadowEntry, error)

ShadowByName returns the shadow information for the given user name.

func (*Manager) Stop

func (m *Manager) Stop() error

Stop closes the underlying cache.

func (*Manager) UpdateBrokerForUser

func (m *Manager) UpdateBrokerForUser(username, brokerID string) error

UpdateBrokerForUser updates the broker ID for the given user.

func (*Manager) UpdateUser

func (m *Manager) UpdateUser(u types.UserInfo) (err error)

UpdateUser updates the user information in the cache.

func (*Manager) UserByID

func (m *Manager) UserByID(uid uint32) (types.UserEntry, error)

UserByID returns the user information for the given user ID.

func (*Manager) UserByName

func (m *Manager) UserByName(username string) (types.UserEntry, error)

UserByName returns the user information for the given user name.

type NoDataFoundError

type NoDataFoundError = cache.NoDataFoundError

NoDataFoundError is the error returned when no entry is found in the cache.

type Option

type Option func(*options)

Option is a function that allows changing some of the default behaviors of the manager.

func WithIDGenerator

func WithIDGenerator(g tempentries.IDGenerator) Option

WithIDGenerator makes the manager use a specific ID generator. This option is only useful in tests.