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

Diff of /eclass/user.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.11 Revision 1.21
1# Copyright 1999-2011 Gentoo Foundation 1# Copyright 1999-2012 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 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 $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/user.eclass,v 1.21 2012/06/22 18:57:33 axs Exp $
4 4
5# @ECLASS: user.eclass 5# @ECLASS: user.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# base-system@gentoo.org (Linux) 7# base-system@gentoo.org (Linux)
8# Joe Jezak <josejx@gmail.com> (OS X) 8# Joe Jezak <josejx@gmail.com> (OS X)
11# @BLURB: user management in ebuilds 11# @BLURB: user management in ebuilds
12# @DESCRIPTION: 12# @DESCRIPTION:
13# The user eclass contains a suite of functions that allow ebuilds 13# The user eclass contains a suite of functions that allow ebuilds
14# to quickly make sure users in the installed system are sane. 14# to quickly make sure users in the installed system are sane.
15 15
16if [[ ${___ECLASS_ONCE_USER} != "recur -_+^+_- spank" ]] ; then
17___ECLASS_ONCE_USER="recur -_+^+_- spank"
18
16# @FUNCTION: _assert_pkg_ebuild_phase 19# @FUNCTION: _assert_pkg_ebuild_phase
17# @INTERNAL 20# @INTERNAL
18# @USAGE: <calling func name> 21# @USAGE: <calling func name>
19_assert_pkg_ebuild_phase() { 22_assert_pkg_ebuild_phase() {
20 case ${EBUILD_PHASE} in 23 case ${EBUILD_PHASE} in
21 setup|preinst|postinst) ;; 24 setup|preinst|postinst) ;;
22 *) 25 *)
23 eerror "'$1()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 26 eerror "'$1()' called from '${EBUILD_PHASE}' phase which is not OK:"
27 eerror "You may only call from pkg_{setup,preinst,postinst} functions."
24 eerror "Package fails at QA and at life. Please file a bug." 28 eerror "Package fails at QA and at life. Please file a bug."
25 die "Bad package! $1 is only for use in pkg_* functions!" 29 die "Bad package! $1 is only for use in some pkg_* functions!"
26 esac 30 esac
27} 31}
28 32
29# @FUNCTION: egetent 33# @FUNCTION: egetent
30# @USAGE: <database> <key> 34# @USAGE: <database> <key>
101# Same as enewgroup, you are not required to understand how to properly add 105# 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. 106# 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 107# 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. 108# /bin/false, default homedir is /dev/null, and there are no default groups.
105enewuser() { 109enewuser() {
106 _assert_pkg_ebuild_phase enewuser 110 _assert_pkg_ebuild_phase ${FUNCNAME}
107 111
108 # get the username 112 # get the username
109 local euser=$1; shift 113 local euser=$1; shift
110 if [[ -z ${euser} ]] ; then 114 if [[ -z ${euser} ]] ; then
111 eerror "No username specified !" 115 eerror "No username specified !"
117 return 0 121 return 0
118 fi 122 fi
119 einfo "Adding user '${euser}' to your system ..." 123 einfo "Adding user '${euser}' to your system ..."
120 124
121 # options to pass to useradd 125 # options to pass to useradd
122 local opts= 126 local opts=()
123 127
124 # handle uid 128 # handle uid
125 local euid=$1; shift 129 local euid=$1; shift
126 if [[ -n ${euid} && ${euid} != -1 ]] ; then 130 if [[ -n ${euid} && ${euid} != -1 ]] ; then
127 if [[ ${euid} -gt 0 ]] ; then 131 if [[ ${euid} -gt 0 ]] ; then
138 if [[ ${euid} == "next" ]] ; then 142 if [[ ${euid} == "next" ]] ; then
139 for ((euid = 101; euid <= 999; euid++)); do 143 for ((euid = 101; euid <= 999; euid++)); do
140 [[ -z $(egetent passwd ${euid}) ]] && break 144 [[ -z $(egetent passwd ${euid}) ]] && break
141 done 145 done
142 fi 146 fi
143 opts+=" -u ${euid}" 147 opts+=( -u ${euid} )
144 einfo " - Userid: ${euid}" 148 einfo " - Userid: ${euid}"
145 149
146 # handle shell 150 # handle shell
147 local eshell=$1; shift 151 local eshell=$1; shift
148 if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then 152 if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
153 if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then 157 if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then
154 eerror "Do not specify ${eshell} yourself, use -1" 158 eerror "Do not specify ${eshell} yourself, use -1"
155 die "Pass '-1' as the shell parameter" 159 die "Pass '-1' as the shell parameter"
156 fi 160 fi
157 else 161 else
158 for shell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do 162 for eshell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
159 [[ -x ${ROOT}${shell} ]] && break 163 [[ -x ${ROOT}${eshell} ]] && break
160 done 164 done
161 165
162 if [[ ${shell} == "/dev/null" ]] ; then 166 if [[ ${eshell} == "/dev/null" ]] ; then
163 eerror "Unable to identify the shell to use, proceeding with userland default." 167 eerror "Unable to identify the shell to use, proceeding with userland default."
164 case ${USERLAND} in 168 case ${USERLAND} in
165 GNU) shell="/bin/false" ;; 169 GNU) eshell="/bin/false" ;;
166 BSD) shell="/sbin/nologin" ;; 170 BSD) eshell="/sbin/nologin" ;;
167 Darwin) shell="/usr/sbin/nologin" ;; 171 Darwin) eshell="/usr/sbin/nologin" ;;
168 *) die "Unable to identify the default shell for userland ${USERLAND}" 172 *) die "Unable to identify the default shell for userland ${USERLAND}"
169 esac 173 esac
170 fi 174 fi
171
172 eshell=${shell}
173 fi 175 fi
174 einfo " - Shell: ${eshell}" 176 einfo " - Shell: ${eshell}"
175 opts+=" -s ${eshell}" 177 opts+=( -s "${eshell}" )
176 178
177 # handle homedir 179 # handle homedir
178 local ehome=$1; shift 180 local ehome=$1; shift
179 if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then 181 if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then
180 ehome="/dev/null" 182 ehome="/dev/null"
181 fi 183 fi
182 einfo " - Home: ${ehome}" 184 einfo " - Home: ${ehome}"
183 opts+=" -d ${ehome}" 185 opts+=( -d "${ehome}" )
184 186
185 # handle groups 187 # handle groups
186 local egroups=$1; shift 188 local egroups=$1; shift
187 if [[ ! -z ${egroups} ]] ; then 189 local g egroups_arr
188 local oldifs=${IFS} 190 IFS="," read -r -a egroups_arr <<<"${egroups}"
191 shift
192 if [[ ${#egroups_arr[@]} -gt 0 ]] ; then
189 local defgroup="" exgroups="" 193 local defgroup exgroups
190
191 export IFS=","
192 for g in ${egroups} ; do 194 for g in "${egroups_arr[@]}" ; do
193 export IFS=${oldifs}
194 if [[ -z $(egetent group "${g}") ]] ; then 195 if [[ -z $(egetent group "${g}") ]] ; then
195 eerror "You must add group ${g} to the system first" 196 eerror "You must add group ${g} to the system first"
196 die "${g} is not a valid GID" 197 die "${g} is not a valid GID"
197 fi 198 fi
198 if [[ -z ${defgroup} ]] ; then 199 if [[ -z ${defgroup} ]] ; then
199 defgroup=${g} 200 defgroup=${g}
200 else 201 else
201 exgroups="${exgroups},${g}" 202 exgroups+=",${g}"
202 fi 203 fi
203 export IFS=","
204 done 204 done
205 export IFS=${oldifs}
206
207 opts+=" -g ${defgroup}" 205 opts+=( -g "${defgroup}" )
208 if [[ ! -z ${exgroups} ]] ; then 206 if [[ ! -z ${exgroups} ]] ; then
209 opts+=" -G ${exgroups:1}" 207 opts+=( -G "${exgroups:1}" )
210 fi
211 else
212 egroups="(none)"
213 fi 208 fi
209 fi
214 einfo " - Groups: ${egroups}" 210 einfo " - Groups: ${egroups:-(none)}"
215 211
216 # handle extra args 212 # handle extra args
217 if [[ $# -gt 0 ]] ; then 213 if [[ $# -gt 0 ]] ; then
218 die "extra arguments no longer supported; please file a bug" 214 die "extra arguments no longer supported; please file a bug"
219 else 215 else
220 set -- -c "added by portage for ${PN}" 216 local comment="added by portage for ${PN}"
221 einfo " - Extra: $@" 217 opts+=( -c "${comment}" )
218 einfo " - GECOS: ${comment}"
222 fi 219 fi
223 220
224 # add the user 221 # add the user
225 local oldsandbox=${SANDBOX_ON}
226 export SANDBOX_ON="0"
227 case ${CHOST} in 222 case ${CHOST} in
228 *-darwin*) 223 *-darwin*)
229 ### Make the user 224 ### Make the user
230 dscl . create /users/${euser} uid ${euid} 225 dscl . create "/users/${euser}" uid ${euid}
231 dscl . create /users/${euser} shell ${eshell} 226 dscl . create "/users/${euser}" shell "${eshell}"
232 dscl . create /users/${euser} home ${ehome} 227 dscl . create "/users/${euser}" home "${ehome}"
233 dscl . create /users/${euser} realname "added by portage for ${PN}" 228 dscl . create "/users/${euser}" realname "added by portage for ${PN}"
234 ### Add the user to the groups specified 229 ### Add the user to the groups specified
235 local oldifs=${IFS}
236 export IFS=","
237 for g in ${egroups} ; do 230 for g in "${egroups_arr[@]}" ; do
238 dscl . merge /groups/${g} users ${euser} 231 dscl . merge "/groups/${g}" users "${euser}"
239 done 232 done
240 export IFS=${oldifs}
241 ;; 233 ;;
242 234
243 *-freebsd*|*-dragonfly*) 235 *-freebsd*|*-dragonfly*)
244 pw useradd ${euser} ${opts} "$@" || die 236 pw useradd "${euser}" "${opts[@]}" || die
245 ;; 237 ;;
246 238
247 *-netbsd*) 239 *-netbsd*)
248 useradd ${opts} ${euser} "$@" || die 240 useradd "${opts[@]}" "${euser}" || die
249 ;; 241 ;;
250 242
251 *-openbsd*) 243 *-openbsd*)
252 # all ops the same, except the -g vs -g/-G ... 244 # all ops the same, except the -g vs -g/-G ...
253 useradd -u ${euid} -s ${eshell} \ 245 useradd -u ${euid} -s "${eshell}" \
254 -d ${ehome} -g ${egroups} "$@" ${euser} || die 246 -d "${ehome}" -g "${egroups}" "${euser}" || die
255 ;; 247 ;;
256 248
257 *) 249 *)
258 useradd -r ${opts} "$@" ${euser} || die 250 useradd -r "${opts[@]}" "${euser}" || die
259 ;; 251 ;;
260 esac 252 esac
261 253
262 if [[ ! -e ${ROOT}/${ehome} ]] ; then 254 if [[ ! -e ${ROOT}/${ehome} ]] ; then
263 einfo " - Creating ${ehome} in ${ROOT}" 255 einfo " - Creating ${ehome} in ${ROOT}"
264 mkdir -p "${ROOT}/${ehome}" 256 mkdir -p "${ROOT}/${ehome}"
265 chown ${euser} "${ROOT}/${ehome}" 257 chown "${euser}" "${ROOT}/${ehome}"
266 chmod 755 "${ROOT}/${ehome}" 258 chmod 755 "${ROOT}/${ehome}"
267 fi 259 fi
268
269 export SANDBOX_ON=${oldsandbox}
270} 260}
271 261
272# @FUNCTION: enewgroup 262# @FUNCTION: enewgroup
273# @USAGE: <group> [gid] 263# @USAGE: <group> [gid]
274# @DESCRIPTION: 264# @DESCRIPTION:
275# This function does not require you to understand how to properly add a 265# This function does not require you to understand how to properly add a
276# group to the system. Just give it a group name to add and enewgroup will 266# group to the system. Just give it a group name to add and enewgroup will
277# do the rest. You may specify the gid for the group or allow the group to 267# do the rest. You may specify the gid for the group or allow the group to
278# allocate the next available one. 268# allocate the next available one.
279enewgroup() { 269enewgroup() {
280 _assert_pkg_ebuild_phase enewgroup 270 _assert_pkg_ebuild_phase ${FUNCNAME}
281 271
282 # get the group 272 # get the group
283 local egroup="$1"; shift 273 local egroup=$1; shift
284 if [ -z "${egroup}" ] 274 if [[ -z ${egroup} ]] ; then
285 then
286 eerror "No group specified !" 275 eerror "No group specified !"
287 die "Cannot call enewgroup without a group" 276 die "Cannot call enewgroup without a group"
288 fi 277 fi
289 278
290 # see if group already exists 279 # see if group already exists
291 if [[ -n $(egetent group "${egroup}") ]]; then 280 if [[ -n $(egetent group "${egroup}") ]] ; then
292 return 0 281 return 0
293 fi 282 fi
294 einfo "Adding group '${egroup}' to your system ..." 283 einfo "Adding group '${egroup}' to your system ..."
295 284
296 # options to pass to useradd
297 local opts=
298
299 # handle gid 285 # handle gid
300 local egid="$1"; shift 286 local egid=$1; shift
301 if [ ! -z "${egid}" ] 287 if [[ ! -z ${egid} ]] ; then
302 then
303 if [ "${egid}" -gt 0 ] 288 if [[ ${egid} -gt 0 ]] ; then
304 then
305 if [ -z "`egetent group ${egid}`" ] 289 if [[ -n $(egetent group ${egid}) ]] ; then
306 then
307 if [[ "${CHOST}" == *-darwin* ]]; then
308 opts+=" ${egid}"
309 else
310 opts+=" -g ${egid}"
311 fi
312 else
313 egid="next available; requested gid taken" 290 egid="next available; requested gid taken"
314 fi 291 fi
315 else 292 else
316 eerror "Groupid given but is not greater than 0 !" 293 eerror "Groupid given but is not greater than 0 !"
317 die "${egid} is not a valid GID" 294 die "${egid} is not a valid GID"
320 egid="next available" 297 egid="next available"
321 fi 298 fi
322 einfo " - Groupid: ${egid}" 299 einfo " - Groupid: ${egid}"
323 300
324 # handle extra 301 # handle extra
325 if [ $# -gt 0 ] ; then 302 if [[ $# -gt 0 ]] ; then
326 die "extra arguments no longer supported; please file a bug" 303 die "extra arguments no longer supported; please file a bug"
327 fi 304 fi
328 305
329 # add the group 306 # Some targets need to find the next available GID manually
330 local oldsandbox="${SANDBOX_ON}" 307 _enewgroup_next_gid() {
331 export SANDBOX_ON="0" 308 if [[ ${egid} == *[!0-9]* ]] ; then
332 case ${CHOST} in 309 # Non numeric
333 *-darwin*)
334 # If we need the next available
335 case ${egid} in
336 *[!0-9]*) # Non numeric
337 for ((egid = 101; egid <= 999; egid++)); do 310 for ((egid = 101; egid <= 999; egid++)) ; do
338 [[ -z $(egetent group ${egid}) ]] && break 311 [[ -z $(egetent group ${egid}) ]] && break
339 done 312 done
340 esac 313 fi
314 }
315
316 # add the group
317 case ${CHOST} in
318 *-darwin*)
319 _enewgroup_next_gid
341 dscl . create /groups/${egroup} gid ${egid} 320 dscl . create "/groups/${egroup}" gid ${egid}
342 dscl . create /groups/${egroup} passwd '*' 321 dscl . create "/groups/${egroup}" passwd '*'
343 ;; 322 ;;
344 323
345 *-freebsd*|*-dragonfly*) 324 *-freebsd*|*-dragonfly*)
346 case ${egid} in 325 _enewgroup_next_gid
347 *[!0-9]*) # Non numeric
348 for ((egid = 101; egid <= 999; egid++)); do
349 [[ -z $(egetent group ${egid}) ]] && break
350 done
351 esac
352 pw groupadd ${egroup} -g ${egid} || die 326 pw groupadd "${egroup}" -g ${egid} || die
353 ;; 327 ;;
354 328
355 *-netbsd*) 329 *-netbsd*)
356 case ${egid} in 330 _enewgroup_next_gid
357 *[!0-9]*) # Non numeric
358 for ((egid = 101; egid <= 999; egid++)); do
359 [[ -z $(egetent group ${egid}) ]] && break
360 done
361 esac
362 groupadd -g ${egid} ${egroup} || die 331 groupadd -g ${egid} "${egroup}" || die
363 ;; 332 ;;
364 333
365 *) 334 *)
335 local opts
336 if [[ ${egid} == *[!0-9]* ]] ; then
337 # Non numeric; let groupadd figure out a GID for us
338 opts=""
339 else
340 opts="-g ${egid}"
341 fi
366 # We specify -r so that we get a GID in the system range from login.defs 342 # We specify -r so that we get a GID in the system range from login.defs
367 groupadd -r ${opts} ${egroup} || die 343 groupadd -r ${opts} "${egroup}" || die
368 ;; 344 ;;
369 esac 345 esac
370 export SANDBOX_ON="${oldsandbox}"
371} 346}
372 347
373# @FUNCTION: egethome 348# @FUNCTION: egethome
374# @USAGE: <user> 349# @USAGE: <user>
375# @DESCRIPTION: 350# @DESCRIPTION:
386 *) # Linux, NetBSD, OpenBSD, etc... 361 *) # Linux, NetBSD, OpenBSD, etc...
387 pos=6 362 pos=6
388 ;; 363 ;;
389 esac 364 esac
390 365
391 egetent passwd $1 | cut -d: -f${pos} 366 egetent passwd "$1" | cut -d: -f${pos}
392} 367}
393 368
394# @FUNCTION: egetshell 369# @FUNCTION: egetshell
395# @USAGE: <user> 370# @USAGE: <user>
396# @DESCRIPTION: 371# @DESCRIPTION:
409 ;; 384 ;;
410 esac 385 esac
411 386
412 egetent passwd "$1" | cut -d: -f${pos} 387 egetent passwd "$1" | cut -d: -f${pos}
413} 388}
389
390# @FUNCTION: esethome
391# @USAGE: <user> <homedir>
392# @DESCRIPTION:
393# Update the home directory in a platform-agnostic way.
394# Required parameters is the username and the new home directory.
395# Specify -1 if you want to set home to the enewuser default
396# of /dev/null.
397# If the new home directory does not exist, it is created.
398# Any previously existing home directory is NOT moved.
399esethome() {
400 _assert_pkg_ebuild_phase ${FUNCNAME}
401
402 # get the username
403 local euser=$1; shift
404 if [[ -z ${euser} ]] ; then
405 eerror "No username specified !"
406 die "Cannot call esethome without a username"
407 fi
408
409 # lets see if the username already exists
410 if [[ -z $(egetent passwd "${euser}") ]] ; then
411 ewarn "User does not exist, cannot set home dir -- skipping."
412 return 1
413 fi
414
415 # handle homedir
416 local ehome=$1; shift
417 if [[ -z ${ehome} ]] ; then
418 eerror "No home directory specified !"
419 die "Cannot call esethome without a home directory or '-1'"
420 fi
421
422 if [[ ${ehome} == "-1" ]] ; then
423 ehome="/dev/null"
424 fi
425 einfo " - Home: ${ehome}"
426
427 # ensure home directory exists, otherwise update will fail
428 if [[ ! -e ${ROOT}/${ehome} ]] ; then
429 einfo " - Creating ${ehome} in ${ROOT}"
430 mkdir -p "${ROOT}/${ehome}"
431 chown "${euser}" "${ROOT}/${ehome}"
432 chmod 755 "${ROOT}/${ehome}"
433 fi
434
435 # update the home directory
436 case ${CHOST} in
437 *-darwin*)
438 dscl . change "/users/${euser}" home "${ehome}"
439 ;;
440
441 *-freebsd*|*-dragonfly*)
442 pw usermod "${euser}" -d "${ehome}" && return 0
443 [[ $? == 8 ]] && eerror "${euser} is in use, cannot update home"
444 eerror "There was an error when attempting to update the home directory for ${euser}"
445 eerror "Please update it manually on your system:"
446 eerror "\t pw usermod \"${euser}\" -d \"${ehome}\""
447 ;;
448
449 *)
450 usermod -d "${ehome}" "${euser}" && return 0
451 [[ $? == 8 ]] && eerror "${euser} is in use, cannot update home"
452 eerror "There was an error when attempting to update the home directory for ${euser}"
453 eerror "Please update it manually on your system (as root):"
454 eerror "\t usermod -d \"${ehome}\" \"${euser}\""
455 ;;
456 esac
457}
458
459fi

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.21

  ViewVC Help
Powered by ViewVC 1.1.20