user – github.com/moby/sys/user Index | Files

package user

import "github.com/moby/sys/user"

Index

Variables 

var (
	// ErrNoPasswdEntries is returned if no matching entries were found in /etc/group.
	ErrNoPasswdEntries = errors.New("no matching entries in passwd file")
	// ErrNoGroupEntries is returned if no matching entries were found in /etc/passwd.
	ErrNoGroupEntries = errors.New("no matching entries in group file")
	// ErrRange is returned if a UID or GID is outside of the valid range.
	ErrRange = fmt.Errorf("uids and gids must be in range %d-%d", minID, maxID)
)

Functions

func GetAdditionalGroups 

func GetAdditionalGroups(additionalGroups []string, group io.Reader) ([]int, error)

GetAdditionalGroups looks up a list of groups by name or group id against the given /etc/group formatted data. If a group name cannot be found, an error will be returned. If a group id cannot be found, or the given group data is nil, the id will be returned as-is provided it is in the legal range.

func GetAdditionalGroupsPath 

func GetAdditionalGroupsPath(additionalGroups []string, groupPath string) ([]int, error)

GetAdditionalGroupsPath is a wrapper around GetAdditionalGroups that opens the groupPath given and gives it as an argument to GetAdditionalGroups.

func MkdirAllAndChown 

func MkdirAllAndChown(path string, mode os.FileMode, uid, gid int, opts ...MkdirOpt) error

MkdirAllAndChown creates a directory (include any along the path) and then modifies ownership to the requested uid/gid. By default, if the directory already exists, this function will still change ownership and permissions. If WithOnlyNew is passed as an option, then only the newly created directories will have ownership and permissions changed.

func MkdirAndChown 

func MkdirAndChown(path string, mode os.FileMode, uid, gid int, opts ...MkdirOpt) error

MkdirAndChown creates a directory and then modifies ownership to the requested uid/gid. By default, if the directory already exists, this function still changes ownership and permissions. If WithOnlyNew is passed as an option, then only the newly created directory will have ownership and permissions changed. Note that unlike os.Mkdir(), this function does not return IsExist error in case path already exists.

func WithOnlyNew 

func WithOnlyNew(o *mkdirOptions)

WithOnlyNew is an option for MkdirAllAndChown that will only change ownership and permissions on newly created directories. If the directory already exists, it will not be modified

Types

type ExecUser 

type ExecUser struct {
	Uid   int
	Gid   int
	Sgids []int
	Home  string
}

func GetExecUser 

func GetExecUser(userSpec string, defaults *ExecUser, passwd, group io.Reader) (*ExecUser, error)

GetExecUser parses a user specification string (using the passwd and group readers as sources for /etc/passwd and /etc/group data, respectively). In the case of blank fields or missing data from the sources, the values in defaults is used.

GetExecUser will return an error if a user or group literal could not be found in any entry in passwd and group respectively.

Examples of valid user specifications are:

It should be noted that if you specify a numeric user or group id, they will not be evaluated as usernames (only the metadata will be filled). So attempting to parse a user with user.Name = "1337" will produce the user with a UID of 1337.

func GetExecUserPath 

func GetExecUserPath(userSpec string, defaults *ExecUser, passwdPath, groupPath string) (*ExecUser, error)

GetExecUserPath is a wrapper for GetExecUser. It reads data from each of the given file paths and uses that data as the arguments to GetExecUser. If the files cannot be opened for any reason, the error is ignored and a nil io.Reader is passed instead.

type Group 

type Group struct {
	Name string
	Pass string
	Gid  int
	List []string
}

func ParseGroup 

func ParseGroup(group io.Reader) ([]Group, error)

func ParseGroupFile 

func ParseGroupFile(path string) ([]Group, error)

func ParseGroupFileFilter 

func ParseGroupFileFilter(path string, filter func(Group) bool) ([]Group, error)

func ParseGroupFilter 

func ParseGroupFilter(r io.Reader, filter func(Group) bool) ([]Group, error)

type IDMap 

type IDMap struct {
	ID       int64
	ParentID int64
	Count    int64
}

IDMap represents an entry in /proc/PID/{u,g}id_map

func ParseIDMap 

func ParseIDMap(r io.Reader) ([]IDMap, error)

func ParseIDMapFile 

func ParseIDMapFile(path string) ([]IDMap, error)

func ParseIDMapFileFilter 

func ParseIDMapFileFilter(path string, filter func(IDMap) bool) ([]IDMap, error)

func ParseIDMapFilter 

func ParseIDMapFilter(r io.Reader, filter func(IDMap) bool) ([]IDMap, error)

type IdentityMapping 

type IdentityMapping struct {
	UIDMaps []IDMap `json:"UIDMaps"`
	GIDMaps []IDMap `json:"GIDMaps"`
}

IdentityMapping contains a mappings of UIDs and GIDs. The zero value represents an empty mapping.

func (IdentityMapping) Empty 

func (i IdentityMapping) Empty() bool

Empty returns true if there are no id mappings

func (IdentityMapping) RootPair 

func (i IdentityMapping) RootPair() (int, int)

RootPair returns a uid and gid pair for the root user. The error is ignored because a root user always exists, and the defaults are correct when the uid and gid maps are empty.

func (IdentityMapping) ToContainer 

func (i IdentityMapping) ToContainer(uid, gid int) (int, int, error)

ToContainer returns the container UID and GID for the host uid and gid

func (IdentityMapping) ToHost 

func (i IdentityMapping) ToHost(uid, gid int) (int, int, error)

ToHost returns the host UID and GID for the container uid, gid. Remapping is only performed if the ids aren't already the remapped root ids

type MkdirOpt 

type MkdirOpt func(*mkdirOptions)

MkdirOpt is a type for options to pass to Mkdir calls

type SubID 

type SubID struct {
	Name  string
	SubID int64
	Count int64
}

SubID represents an entry in /etc/sub{u,g}id

func ParseSubID 

func ParseSubID(subid io.Reader) ([]SubID, error)

func ParseSubIDFile 

func ParseSubIDFile(path string) ([]SubID, error)

func ParseSubIDFileFilter 

func ParseSubIDFileFilter(path string, filter func(SubID) bool) ([]SubID, error)

func ParseSubIDFilter 

func ParseSubIDFilter(r io.Reader, filter func(SubID) bool) ([]SubID, error)

type User 

type User struct {
	Name  string
	Pass  string
	Uid   int
	Gid   int
	Gecos string
	Home  string
	Shell string
}

func ParsePasswd 

func ParsePasswd(passwd io.Reader) ([]User, error)

func ParsePasswdFile 

func ParsePasswdFile(path string) ([]User, error)

func ParsePasswdFileFilter 

func ParsePasswdFileFilter(path string, filter func(User) bool) ([]User, error)

func ParsePasswdFilter 

func ParsePasswdFilter(r io.Reader, filter func(User) bool) ([]User, error)

Source Files

idtools.go idtools_windows.go user.go

Version
v0.4.0 (latest)
Published
Feb 27, 2025
Platform
windows/amd64
Imports
8 packages
Last checked
now –

Tools for package owners.