/[gentoo-x86]/eclass/user.eclass
Gentoo

Contents of /eclass/user.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.12 - (show annotations) (download)
Sat Nov 26 06:45:38 2011 UTC (3 years ago) by vapier
Branch: MAIN
Changes since 1.11: +1 -8 lines
do not touch sandbox settings since we only run in pkg_* funcs (where sandbox is disabled)

1 # Copyright 1999-2011 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/user.eclass,v 1.11 2011/11/26 06:42:07 vapier Exp $
4
5 # @ECLASS: user.eclass
6 # @MAINTAINER:
7 # base-system@gentoo.org (Linux)
8 # Joe Jezak <josejx@gmail.com> (OS X)
9 # usata@gentoo.org (OS X)
10 # Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
11 # @BLURB: user management in ebuilds
12 # @DESCRIPTION:
13 # The user eclass contains a suite of functions that allow ebuilds
14 # to quickly make sure users in the installed system are sane.
15
16 # @FUNCTION: _assert_pkg_ebuild_phase
17 # @INTERNAL
18 # @USAGE: <calling func name>
19 _assert_pkg_ebuild_phase() {
20 case ${EBUILD_PHASE} in
21 setup|preinst|postinst) ;;
22 *)
23 eerror "'$1()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
24 eerror "Package fails at QA and at life. Please file a bug."
25 die "Bad package! $1 is only for use in pkg_* functions!"
26 esac
27 }
28
29 # @FUNCTION: egetent
30 # @USAGE: <database> <key>
31 # @DESCRIPTION:
32 # Small wrapper for getent (Linux), nidump (< Mac OS X 10.5),
33 # dscl (Mac OS X 10.5), and pw (FreeBSD) used in enewuser()/enewgroup().
34 #
35 # Supported databases: group passwd
36 egetent() {
37 local db=$1 key=$2
38
39 [[ $# -ge 3 ]] && die "usage: egetent <database> <key>"
40
41 case ${db} in
42 passwd|group) ;;
43 *) die "sorry, database '${db}' not yet supported; file a bug" ;;
44 esac
45
46 case ${CHOST} in
47 *-darwin[678])
48 case ${key} in
49 *[!0-9]*) # Non numeric
50 nidump ${db} . | awk -F: "(\$1 ~ /^${key}\$/) {print;exit;}"
51 ;;
52 *) # Numeric
53 nidump ${db} . | awk -F: "(\$3 == ${key}) {print;exit;}"
54 ;;
55 esac
56 ;;
57 *-darwin*)
58 local mykey
59 case ${db} in
60 passwd) db="Users" mykey="UniqueID" ;;
61 group) db="Groups" mykey="PrimaryGroupID" ;;
62 esac
63
64 case ${key} in
65 *[!0-9]*) # Non numeric
66 dscl . -read /${db}/${key} 2>/dev/null |grep RecordName
67 ;;
68 *) # Numeric
69 dscl . -search /${db} ${mykey} ${key} 2>/dev/null
70 ;;
71 esac
72 ;;
73 *-freebsd*|*-dragonfly*)
74 case ${db} in
75 passwd) db="user" ;;
76 *) ;;
77 esac
78
79 # lookup by uid/gid
80 local opts
81 if [[ ${key} == [[:digit:]]* ]] ; then
82 [[ ${db} == "user" ]] && opts="-u" || opts="-g"
83 fi
84
85 pw show ${db} ${opts} "${key}" -q
86 ;;
87 *-netbsd*|*-openbsd*)
88 grep "${key}:\*:" /etc/${db}
89 ;;
90 *)
91 # ignore output if nscd doesn't exist, or we're not running as root
92 nscd -i "${db}" 2>/dev/null
93 getent "${db}" "${key}"
94 ;;
95 esac
96 }
97
98 # @FUNCTION: enewuser
99 # @USAGE: <user> [uid] [shell] [homedir] [groups]
100 # @DESCRIPTION:
101 # Same as enewgroup, you are not required to understand how to properly add
102 # a user to the system. The only required parameter is the username.
103 # Default uid is (pass -1 for this) next available, default shell is
104 # /bin/false, default homedir is /dev/null, and there are no default groups.
105 enewuser() {
106 _assert_pkg_ebuild_phase enewuser
107
108 # get the username
109 local euser=$1; shift
110 if [[ -z ${euser} ]] ; then
111 eerror "No username specified !"
112 die "Cannot call enewuser without a username"
113 fi
114
115 # lets see if the username already exists
116 if [[ -n $(egetent passwd "${euser}") ]] ; then
117 return 0
118 fi
119 einfo "Adding user '${euser}' to your system ..."
120
121 # options to pass to useradd
122 local opts=
123
124 # handle uid
125 local euid=$1; shift
126 if [[ -n ${euid} && ${euid} != -1 ]] ; then
127 if [[ ${euid} -gt 0 ]] ; then
128 if [[ -n $(egetent passwd ${euid}) ]] ; then
129 euid="next"
130 fi
131 else
132 eerror "Userid given but is not greater than 0 !"
133 die "${euid} is not a valid UID"
134 fi
135 else
136 euid="next"
137 fi
138 if [[ ${euid} == "next" ]] ; then
139 for ((euid = 101; euid <= 999; euid++)); do
140 [[ -z $(egetent passwd ${euid}) ]] && break
141 done
142 fi
143 opts+=" -u ${euid}"
144 einfo " - Userid: ${euid}"
145
146 # handle shell
147 local eshell=$1; shift
148 if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
149 if [[ ! -e ${ROOT}${eshell} ]] ; then
150 eerror "A shell was specified but it does not exist !"
151 die "${eshell} does not exist in ${ROOT}"
152 fi
153 if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then
154 eerror "Do not specify ${eshell} yourself, use -1"
155 die "Pass '-1' as the shell parameter"
156 fi
157 else
158 for shell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
159 [[ -x ${ROOT}${shell} ]] && break
160 done
161
162 if [[ ${shell} == "/dev/null" ]] ; then
163 eerror "Unable to identify the shell to use, proceeding with userland default."
164 case ${USERLAND} in
165 GNU) shell="/bin/false" ;;
166 BSD) shell="/sbin/nologin" ;;
167 Darwin) shell="/usr/sbin/nologin" ;;
168 *) die "Unable to identify the default shell for userland ${USERLAND}"
169 esac
170 fi
171
172 eshell=${shell}
173 fi
174 einfo " - Shell: ${eshell}"
175 opts+=" -s ${eshell}"
176
177 # handle homedir
178 local ehome=$1; shift
179 if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then
180 ehome="/dev/null"
181 fi
182 einfo " - Home: ${ehome}"
183 opts+=" -d ${ehome}"
184
185 # handle groups
186 local egroups=$1; shift
187 if [[ ! -z ${egroups} ]] ; then
188 local oldifs=${IFS}
189 local defgroup="" exgroups=""
190
191 export IFS=","
192 for g in ${egroups} ; do
193 export IFS=${oldifs}
194 if [[ -z $(egetent group "${g}") ]] ; then
195 eerror "You must add group ${g} to the system first"
196 die "${g} is not a valid GID"
197 fi
198 if [[ -z ${defgroup} ]] ; then
199 defgroup=${g}
200 else
201 exgroups="${exgroups},${g}"
202 fi
203 export IFS=","
204 done
205 export IFS=${oldifs}
206
207 opts+=" -g ${defgroup}"
208 if [[ ! -z ${exgroups} ]] ; then
209 opts+=" -G ${exgroups:1}"
210 fi
211 else
212 egroups="(none)"
213 fi
214 einfo " - Groups: ${egroups}"
215
216 # handle extra args
217 if [[ $# -gt 0 ]] ; then
218 die "extra arguments no longer supported; please file a bug"
219 else
220 set -- -c "added by portage for ${PN}"
221 einfo " - Extra: $@"
222 fi
223
224 # add the user
225 case ${CHOST} in
226 *-darwin*)
227 ### Make the user
228 dscl . create /users/${euser} uid ${euid}
229 dscl . create /users/${euser} shell ${eshell}
230 dscl . create /users/${euser} home ${ehome}
231 dscl . create /users/${euser} realname "added by portage for ${PN}"
232 ### Add the user to the groups specified
233 local oldifs=${IFS}
234 export IFS=","
235 for g in ${egroups} ; do
236 dscl . merge /groups/${g} users ${euser}
237 done
238 export IFS=${oldifs}
239 ;;
240
241 *-freebsd*|*-dragonfly*)
242 pw useradd ${euser} ${opts} "$@" || die
243 ;;
244
245 *-netbsd*)
246 useradd ${opts} ${euser} "$@" || die
247 ;;
248
249 *-openbsd*)
250 # all ops the same, except the -g vs -g/-G ...
251 useradd -u ${euid} -s ${eshell} \
252 -d ${ehome} -g ${egroups} "$@" ${euser} || die
253 ;;
254
255 *)
256 useradd -r ${opts} "$@" ${euser} || die
257 ;;
258 esac
259
260 if [[ ! -e ${ROOT}/${ehome} ]] ; then
261 einfo " - Creating ${ehome} in ${ROOT}"
262 mkdir -p "${ROOT}/${ehome}"
263 chown ${euser} "${ROOT}/${ehome}"
264 chmod 755 "${ROOT}/${ehome}"
265 fi
266 }
267
268 # @FUNCTION: enewgroup
269 # @USAGE: <group> [gid]
270 # @DESCRIPTION:
271 # This function does not require you to understand how to properly add a
272 # group to the system. Just give it a group name to add and enewgroup will
273 # do the rest. You may specify the gid for the group or allow the group to
274 # allocate the next available one.
275 enewgroup() {
276 _assert_pkg_ebuild_phase enewgroup
277
278 # get the group
279 local egroup="$1"; shift
280 if [ -z "${egroup}" ]
281 then
282 eerror "No group specified !"
283 die "Cannot call enewgroup without a group"
284 fi
285
286 # see if group already exists
287 if [[ -n $(egetent group "${egroup}") ]]; then
288 return 0
289 fi
290 einfo "Adding group '${egroup}' to your system ..."
291
292 # options to pass to useradd
293 local opts=
294
295 # handle gid
296 local egid="$1"; shift
297 if [ ! -z "${egid}" ]
298 then
299 if [ "${egid}" -gt 0 ]
300 then
301 if [ -z "`egetent group ${egid}`" ]
302 then
303 if [[ "${CHOST}" == *-darwin* ]]; then
304 opts+=" ${egid}"
305 else
306 opts+=" -g ${egid}"
307 fi
308 else
309 egid="next available; requested gid taken"
310 fi
311 else
312 eerror "Groupid given but is not greater than 0 !"
313 die "${egid} is not a valid GID"
314 fi
315 else
316 egid="next available"
317 fi
318 einfo " - Groupid: ${egid}"
319
320 # handle extra
321 if [ $# -gt 0 ] ; then
322 die "extra arguments no longer supported; please file a bug"
323 fi
324
325 # add the group
326 case ${CHOST} in
327 *-darwin*)
328 # If we need the next available
329 case ${egid} in
330 *[!0-9]*) # Non numeric
331 for ((egid = 101; egid <= 999; egid++)); do
332 [[ -z $(egetent group ${egid}) ]] && break
333 done
334 esac
335 dscl . create /groups/${egroup} gid ${egid}
336 dscl . create /groups/${egroup} passwd '*'
337 ;;
338
339 *-freebsd*|*-dragonfly*)
340 case ${egid} in
341 *[!0-9]*) # Non numeric
342 for ((egid = 101; egid <= 999; egid++)); do
343 [[ -z $(egetent group ${egid}) ]] && break
344 done
345 esac
346 pw groupadd ${egroup} -g ${egid} || die
347 ;;
348
349 *-netbsd*)
350 case ${egid} in
351 *[!0-9]*) # Non numeric
352 for ((egid = 101; egid <= 999; egid++)); do
353 [[ -z $(egetent group ${egid}) ]] && break
354 done
355 esac
356 groupadd -g ${egid} ${egroup} || die
357 ;;
358
359 *)
360 # We specify -r so that we get a GID in the system range from login.defs
361 groupadd -r ${opts} ${egroup} || die
362 ;;
363 esac
364 }
365
366 # @FUNCTION: egethome
367 # @USAGE: <user>
368 # @DESCRIPTION:
369 # Gets the home directory for the specified user.
370 egethome() {
371 local pos
372
373 [[ $# -eq 1 ]] || die "usage: egethome <user>"
374
375 case ${CHOST} in
376 *-darwin*|*-freebsd*|*-dragonfly*)
377 pos=9
378 ;;
379 *) # Linux, NetBSD, OpenBSD, etc...
380 pos=6
381 ;;
382 esac
383
384 egetent passwd $1 | cut -d: -f${pos}
385 }
386
387 # @FUNCTION: egetshell
388 # @USAGE: <user>
389 # @DESCRIPTION:
390 # Gets the shell for the specified user.
391 egetshell() {
392 local pos
393
394 [[ $# -eq 1 ]] || die "usage: egetshell <user>"
395
396 case ${CHOST} in
397 *-darwin*|*-freebsd*|*-dragonfly*)
398 pos=10
399 ;;
400 *) # Linux, NetBSD, OpenBSD, etc...
401 pos=7
402 ;;
403 esac
404
405 egetent passwd "$1" | cut -d: -f${pos}
406 }

  ViewVC Help
Powered by ViewVC 1.1.20