|
| 1 | +package user |
| 2 | + |
| 3 | +import ( |
| 4 | + "io" |
| 5 | + |
| 6 | + "github.com/moby/sys/user" |
| 7 | +) |
| 8 | + |
| 9 | +var ( |
| 10 | + // ErrNoPasswdEntries is returned if no matching entries were found in /etc/group. |
| 11 | + ErrNoPasswdEntries = user.ErrNoPasswdEntries |
| 12 | + // ErrNoGroupEntries is returned if no matching entries were found in /etc/passwd. |
| 13 | + ErrNoGroupEntries = user.ErrNoGroupEntries |
| 14 | + // ErrRange is returned if a UID or GID is outside of the valid range. |
| 15 | + ErrRange = user.ErrRange |
| 16 | +) |
| 17 | + |
| 18 | +type ( |
| 19 | + User = user.User |
| 20 | + |
| 21 | + Group = user.Group |
| 22 | + |
| 23 | + // SubID represents an entry in /etc/sub{u,g}id. |
| 24 | + SubID = user.SubID |
| 25 | + |
| 26 | + // IDMap represents an entry in /proc/PID/{u,g}id_map. |
| 27 | + IDMap = user.IDMap |
| 28 | + |
| 29 | + ExecUser = user.ExecUser |
| 30 | +) |
| 31 | + |
| 32 | +func ParsePasswdFile(path string) ([]user.User, error) { |
| 33 | + return user.ParsePasswdFile(path) |
| 34 | +} |
| 35 | + |
| 36 | +func ParsePasswd(passwd io.Reader) ([]user.User, error) { |
| 37 | + return user.ParsePasswd(passwd) |
| 38 | +} |
| 39 | + |
| 40 | +func ParsePasswdFileFilter(path string, filter func(user.User) bool) ([]user.User, error) { |
| 41 | + return user.ParsePasswdFileFilter(path, filter) |
| 42 | +} |
| 43 | + |
| 44 | +func ParsePasswdFilter(r io.Reader, filter func(user.User) bool) ([]user.User, error) { |
| 45 | + return user.ParsePasswdFilter(r, filter) |
| 46 | +} |
| 47 | + |
| 48 | +func ParseGroupFile(path string) ([]user.Group, error) { |
| 49 | + return user.ParseGroupFile(path) |
| 50 | +} |
| 51 | + |
| 52 | +func ParseGroup(group io.Reader) ([]user.Group, error) { |
| 53 | + return user.ParseGroup(group) |
| 54 | +} |
| 55 | + |
| 56 | +func ParseGroupFileFilter(path string, filter func(user.Group) bool) ([]user.Group, error) { |
| 57 | + return user.ParseGroupFileFilter(path, filter) |
| 58 | +} |
| 59 | + |
| 60 | +func ParseGroupFilter(r io.Reader, filter func(user.Group) bool) ([]user.Group, error) { |
| 61 | + return user.ParseGroupFilter(r, filter) |
| 62 | +} |
| 63 | + |
| 64 | +// GetExecUserPath is a wrapper for GetExecUser. It reads data from each of the |
| 65 | +// given file paths and uses that data as the arguments to GetExecUser. If the |
| 66 | +// files cannot be opened for any reason, the error is ignored and a nil |
| 67 | +// io.Reader is passed instead. |
| 68 | +func GetExecUserPath(userSpec string, defaults *user.ExecUser, passwdPath, groupPath string) (*user.ExecUser, error) { |
| 69 | + return user.GetExecUserPath(userSpec, defaults, passwdPath, groupPath) |
| 70 | +} |
| 71 | + |
| 72 | +// GetExecUser parses a user specification string (using the passwd and group |
| 73 | +// readers as sources for /etc/passwd and /etc/group data, respectively). In |
| 74 | +// the case of blank fields or missing data from the sources, the values in |
| 75 | +// defaults is used. |
| 76 | +// |
| 77 | +// GetExecUser will return an error if a user or group literal could not be |
| 78 | +// found in any entry in passwd and group respectively. |
| 79 | +// |
| 80 | +// Examples of valid user specifications are: |
| 81 | +// - "" |
| 82 | +// - "user" |
| 83 | +// - "uid" |
| 84 | +// - "user:group" |
| 85 | +// - "uid:gid |
| 86 | +// - "user:gid" |
| 87 | +// - "uid:group" |
| 88 | +// |
| 89 | +// It should be noted that if you specify a numeric user or group id, they will |
| 90 | +// not be evaluated as usernames (only the metadata will be filled). So attempting |
| 91 | +// to parse a user with user.Name = "1337" will produce the user with a UID of |
| 92 | +// 1337. |
| 93 | +func GetExecUser(userSpec string, defaults *user.ExecUser, passwd, group io.Reader) (*user.ExecUser, error) { |
| 94 | + return user.GetExecUser(userSpec, defaults, passwd, group) |
| 95 | +} |
| 96 | + |
| 97 | +// GetAdditionalGroups looks up a list of groups by name or group id |
| 98 | +// against the given /etc/group formatted data. If a group name cannot |
| 99 | +// be found, an error will be returned. If a group id cannot be found, |
| 100 | +// or the given group data is nil, the id will be returned as-is |
| 101 | +// provided it is in the legal range. |
| 102 | +func GetAdditionalGroups(additionalGroups []string, group io.Reader) ([]int, error) { |
| 103 | + return user.GetAdditionalGroups(additionalGroups, group) |
| 104 | +} |
| 105 | + |
| 106 | +// GetAdditionalGroupsPath is a wrapper around GetAdditionalGroups |
| 107 | +// that opens the groupPath given and gives it as an argument to |
| 108 | +// GetAdditionalGroups. |
| 109 | +func GetAdditionalGroupsPath(additionalGroups []string, groupPath string) ([]int, error) { |
| 110 | + return user.GetAdditionalGroupsPath(additionalGroups, groupPath) |
| 111 | +} |
| 112 | + |
| 113 | +func ParseSubIDFile(path string) ([]user.SubID, error) { |
| 114 | + return user.ParseSubIDFile(path) |
| 115 | +} |
| 116 | + |
| 117 | +func ParseSubID(subid io.Reader) ([]user.SubID, error) { |
| 118 | + return user.ParseSubID(subid) |
| 119 | +} |
| 120 | + |
| 121 | +func ParseSubIDFileFilter(path string, filter func(user.SubID) bool) ([]user.SubID, error) { |
| 122 | + return user.ParseSubIDFileFilter(path, filter) |
| 123 | +} |
| 124 | + |
| 125 | +func ParseSubIDFilter(r io.Reader, filter func(user.SubID) bool) ([]user.SubID, error) { |
| 126 | + return user.ParseSubIDFilter(r, filter) |
| 127 | +} |
| 128 | + |
| 129 | +func ParseIDMapFile(path string) ([]user.IDMap, error) { |
| 130 | + return user.ParseIDMapFile(path) |
| 131 | +} |
| 132 | + |
| 133 | +func ParseIDMap(r io.Reader) ([]user.IDMap, error) { |
| 134 | + return user.ParseIDMap(r) |
| 135 | +} |
| 136 | + |
| 137 | +func ParseIDMapFileFilter(path string, filter func(user.IDMap) bool) ([]user.IDMap, error) { |
| 138 | + return user.ParseIDMapFileFilter(path, filter) |
| 139 | +} |
| 140 | + |
| 141 | +func ParseIDMapFilter(r io.Reader, filter func(user.IDMap) bool) ([]user.IDMap, error) { |
| 142 | + return user.ParseIDMapFilter(r, filter) |
| 143 | +} |
0 commit comments