X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mjo-overlay.git;a=blobdiff_plain;f=eclass%2Fsys-user.eclass;h=6fb8f7ab17c96e289d5762ab109c0b5eb0c0c287;hp=65b731f69ab294d3c3f880c0bf5411c440c3a422;hb=d2e688a09593fb99ba9c189a18494039fb9417f6;hpb=3074671554cc06fb25869991abca1b7e26adc45a diff --git a/eclass/sys-user.eclass b/eclass/sys-user.eclass index 65b731f..6fb8f7a 100644 --- a/eclass/sys-user.eclass +++ b/eclass/sys-user.eclass @@ -1,6 +1,5 @@ # Copyright 1999-2017 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 -# $Id$ # @ECLASS: sys-user.eclass # @MAINTAINER: @@ -10,24 +9,40 @@ # This eclass does most of the work for the sys-user/ packages that # supply system user accounts. +# Needed for egetshell and egethome. inherit user -EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_install src_test pkg_preinst pkg_postinst pkg_prerm +EXPORT_FUNCTIONS pkg_pretend src_unpack src_configure src_compile src_install src_test pkg_preinst pkg_prerm -# This is hard-coded to the package name. If you want a different -# username, use a different package name. This is a nice way to prevent -# different people from claiming the same username. +: ${HOMEPAGE:="https://wiki.gentoo.org/wiki/User:Mjo/GLEP:User_packages"} +: ${DESCRIPTION:="The ${PN} system user"} +: ${LICENSE="GPL-2"} + +# If you want a different username, use a different package name. This +# prevents different people from claiming the same username. SYS_USER_NAME="${PN}" # @ECLASS-VARIABLE: SYS_USER_GROUPS # @DESCRIPTION: -# etc. +# A space-separated list of groups that the user will belong to. +# Dependencies on the appropriate sys-group packages are generated +# automatically. : ${SYS_USER_GROUPS:=${PN}} # @ECLASS-VARIABLE: SYS_USER_UID +# @REQUIRED +# @DESCRIPTION: +# This should be set to the "fixed" UID that your user should have. +# We may have to fall back to an arbitrary UID, but you still need +# to specify a real, valid UID here. At the very least because our +# SLOT variable needs it. +[[ -z "${SYS_USER_UID}" ]] && die "SYS_USER_UID must be set" + +# @ECLASS-VARIABLE: SYS_USER_UID_IMPORTANT +# @REQUIRED # @DESCRIPTION: -# etc. (use -1 to get next available using user.eclass) -: ${SYS_USER_UID:=-1} +# Set to "true" if you want to die() if you don't get your desired UID. +: ${SYS_USER_UID_IMPORTANT:=false} # In many cases, if the UID of a user changes, packages depending on it # will want to rebuild. We always use SLOT=0, because you can't install @@ -37,13 +52,13 @@ SLOT="0/${SYS_USER_UID}" # @ECLASS-VARIABLE: SYS_USER_HOME # @DESCRIPTION: -# etc. (use -1 to get user.eclass default) -: ${SYS_USER_HOME:=-1} +# etc. +: ${SYS_USER_HOME:=/home/${SYS_USER_NAME}} # @ECLASS-VARIABLE: SYS_USER_SHELL # @DESCRIPTION: -# etc. (use -1 to get user.eclass default) -: ${SYS_USER_SHELL:=-1} +# etc. +: ${SYS_USER_SHELL:=/bin/false} case ${EAPI} in 6) ;; @@ -61,66 +76,119 @@ unset _group S="${WORKDIR}" sys-user_src_unpack() { :; } -sys-user_src_prepare() { :; } -sys-user_src_configure() { :; } sys-user_src_compile() { :; } sys-user_src_test() { :; } -sys-user_next_uid() { - local euid; - for (( euid = 101; euid <= 999; euid++ )); do - [[ -z $(egetent passwd "${euid}") ]] && break - done - if (( "${euid}" == 999 )); then - die "out of available UIDs!" - else - echo "${euid}" - fi +sys-user_getuid() { + # Output the real UID of the given user, or the empty string if the + # user does not exist on the system. + [[ $# -eq 1 ]] || die "usage: sys-user_getuid " + echo $(id --real --user "${1}") +} + +sys-user_getname() { + # Output the username associated with the given UID, or the empty string + # if the given UID is still available. + [[ $# -eq 1 ]] || die "usage: sys-user_getname " + echo $(egetent passwd "${1}" | cut -f1 -d':') +} + +sys-user_create() { + # Create the user whose information is contained in the following + # variables: + # + # * SYS_USER_NAME + # * SYS_USER_UID + # * SYS_USER_SHELL + # * SYS_USER_HOME + # * SYS_USER_GROUPS + # + # We don't create a group with the same name; that should be the + # job of the matching sys-group package. + useradd --no-user-group \ + ${SYS_USER_UID:+--uid }"${SYS_USER_UID}" \ + ${SYS_USER_GROUPS:+--groups }"${SYS_USER_GROUPS}" \ + --shell "${SYS_USER_SHELL}" \ + --home-dir "${SYS_USER_HOME}" \ + "${SYS_USER_NAME}" } -sys-user_src_prepare() { - eapply_user # whatever - if [[ -n $(egetent passwd "${SYS_USER_NAME}") ]]; then +sys-user_modify() { + # Modify the existing user named $SYS_USER_NAME to match the values + # contained in the following variables: + # + # * SYS_USER_UID + # * SYS_USER_SHELL + # * SYS_USER_HOME + # * SYS_USER_GROUPS + # + usermod ${SYS_USER_UID:+--uid }"${SYS_USER_UID}" \ + ${SYS_USER_GROUPS:+--append --groups }"${SYS_USER_GROUPS}" \ + --shell "${SYS_USER_SHELL}" \ + --home-dir "${SYS_USER_HOME}" \ + "${SYS_USER_NAME}" +} + +sys-user_pkg_pretend() { + # Sanity checks that would otherwise run code in global scope. + if [[ "${SYS_USER_UID_IMPORTANT}" == "true" ]]; then + + # The UID is important, so make sure nobody else has it. Or + # rather, nobody else *with a different username* has it. + local oldname=$(sys-user_getname "${SYS_USER_UID}") + if [[ -n "${oldname}" ]] && \ + [[ "${SYS_USER_NAME}" != "${oldname}" ]]; then + die "important UID ${SYS_USER_UID} already belongs to ${oldname}" + fi + + # Ensure that this username doesn't already exist with another + # UID if its UID is supposedly important. + local olduid=$(sys-user_getuid "${SYS_USER_NAME}") + if [[ -n "${olduid}" ]] && \ + [[ "${SYS_USER_UID}" != "${olduid}" ]]; then + # The UID is important and specified, but there is already a + # system user with this name and a different UID. Halp. + die "user ${SYS_USER_NAME} already exists with UID ${olduid}" + fi + fi +} + +sys-user_src_configure() { + local current_uid=$(sys-user_getuid "${SYS_USER_NAME}") + if [[ -n "${current_uid}" ]]; then # UPGRADE PATH: This user already exists, so if the eclass # consumer doesn't care about some settings, we can reuse the # pre-existing ones. # - # This is also useful for sys-user package upgrades, becaused it - # prevents us from incrementing the UID pointlessly on a - # reinstall. Usually that will prevent rebuilds of depending - # packages, and is crucial to our ability to use subslot deps to - # cause rebuilds when the UID changes. We don't want the UID to - # change if the subslot doesn't change, and the subslot for "I - # don't care about the UID" will always be "-1", so the UID - # shouldn't generally change either when SYS_USER_UID=-1. - if (( "${SYS_USER_UID}" == -1 )); then - SYS_USER_UID=$(id --real --user "${SYS_USER_NAME}") + # This is also useful for sys-user package upgrades, because it + # prevents us from incrementing the UID on a reinstall, and doing + # so would break most packages that need a system user to exist. + if [[ "${SYS_USER_UID_IMPORTANT}" != "true" ]]; then + SYS_USER_UID="${current_uid}" fi - if (( "${SYS_USER_HOME}" == -1 )); then + if [[ -z "${SYS_USER_HOME}" ]]; then SYS_USER_HOME=$(egethome "${SYS_USER_NAME}") fi - if (( "${SYS_USER_SHELL}" == -1 )); then + if [[ -z "${SYS_USER_SHELL}" ]]; then SYS_USER_SHELL=$(egetshell "${SYS_USER_NAME}") - - if [[ ${SYS_USER_SHELL} == */false ]] || \ - [[ ${SYS_USER_SHELL} == */nologin ]]; then - # WHYYYYY? enewuser complains if we try to set a default - # shell explicitly. - SYS_USER_SHELL="-1" - fi fi - elif (( "${SYS_USER_UID}" == -1 )); then - # There is no pre-existing user (i.e. this isn't along the - # upgrade path), and the consumer says he doesn't care about the - # UID, so pick the next one. - SYS_USER_UID=$(sys-user_next_uid) fi - # We do something with this in src_install. - touch "${T}/${SYS_USER_UID}" || die + local current_name=$(sys-user_getname "${SYS_USER_UID}") + if [[ "${current_name}" != "${SYS_USER_NAME}" ]]; then + # This UID is already taken by another user, but this + # specific UID was not important (we checked in + # pkg_pretend), so fall back to an arbitrary one. + unset SYS_USER_UID + fi + + # The "useradd" and "usermod" tools expect a comma-separated list, + # so change our spaces to commas. Having duplicates in the list is + # not a problem for those two tools. + SYS_USER_GROUPS="${SYS_USER_GROUPS// /,}" } sys-user_src_install() { @@ -131,106 +199,89 @@ sys-user_src_install() { # be possible. # # Beware, this only works if SYS_USER_UID is guaranteed to have a - # real UID and not, for example, -1. That is taken care of in - # src_prepare() for now. + # real UID and not be e.g. the empty string. + # + # Our sys-user_create() function makes sure to set SYS_USER_UID to + # something useful, and the only place that sys-user_create() is + # called from is sys-user_pkg_preinst(), which takes place before + # this sys-user_src_install(). + # + # The other way that SYS_USER_UID could be empty is during an + # upgrade; however, if you're doing an upgrade and the new UID isn't + # important, then you'll get the same old UID that exists on the + # system from the old package. That old UID is assigned to SYS_USER_UID + # in sys-user_src_configure(), so that case is handled too. + touch "${T}/${SYS_USER_UID}" || die insinto "/var/lib/sys-user" doins "${T}/${SYS_USER_UID}" - - # TODO: do we want to try to create the user's home directory within - # the package manager so that it can be cleaned up later? The - # obvious problem with that plan is that we need to be careful not - # to give the new user ownership of e.g. /dev/null. } sys-user_pkg_preinst() { - if [[ -z $(egetent passwd "${SYS_USER_NAME}") ]]; then + if [[ -z $(sys-user_getuid "${SYS_USER_NAME}") ]]; then # The user does not already exist. This is the nice and easy # case because no matter how we got here, we want to go ahead # and create the (new) user. - enewuser "${SYS_USER_NAME}" \ - "${SYS_USER_UID}" \ - "${SYS_USER_SHELL}" \ - "${SYS_USER_HOME}" \ - "${SYS_USER_GROUPS}" \ - || die "failed to add user ${SYS_USER_NAME}" + sys-user_create || die "failed to add user ${SYS_USER_NAME}" elif [[ -n "${REPLACING_VERSIONS}" ]]; then - # This is an upgrade from an existing sys-user package. This - # case is a little bit weird. If we do it in preinst(), then it - # will happen before the "old" user is removed in - # pkg_prerm(). Except the old user and the new user are the - # same, so if we overwrite the existing user here, then prerm - # for the version that created it will clobber our new entry. - # - # We also can't just LEAVE the old user there, because then no - # upgrade happens. - # - # Uh, let's do this case in pkg_postinst so that it happens - # after the old version's prerm. - : + # This is an upgrade from a previous version of a sys-user + # package. Modify the existing user (who will not be removed; see + # sys-user_pkg_prerm) rather than creating a new one. + sys-user_modify || die "failed to upgrade user ${SYS_USER_NAME}" else # UPGRADE PATH: Ok, the user exists but this isn't an upgrade of # a sys-user package. This is the upgrade path from the old - # style of user/group management to the new style. What can we - # do? We could make it policy that old users must be compatible - # with the new ones, but that entails hard-coding UIDs that - # don't need to be hard-coded. + # style of user/group management to the new style. Lets see if + # the new user is compatible with the old one; it usually will be. + # We only bail out if there's a homedir or shell conflict. + # + # We should make it policy that new sys-user packages have the + # same homedir and shell as the existing ones created by + # ebuilds, but it can't hurt to check again here. These checks + # are done here (and not in pkg_pretend, where they would be + # more consistent) because the PMS states that REPLACING_VERSIONS + # may not be defined there. # - # Instead lets see if the new user is compatible with the old - # (it usually will be), and then only bail out if there's a real - # problem. + # If a homedir/shell changes during a sys-user upgrade, we don't + # consider that a problem, because the change was knowingly made + # by a developer who just edited an ebuild to make that change. local oldhome=$(egethome "${SYS_USER_NAME}") local oldshell=$(egetshell "${SYS_USER_NAME}") - local olduid=$(id --real --user "${SYS_USER_NAME}") - if [[ "${oldhome}" -ne "${SYS_USER_HOME}" ]]; then - die "home directory conflict for new user ${SYS_USER_HOME}" + if [[ "${oldhome}" != "${SYS_USER_HOME}" ]]; then + die "home directory conflict for new user: ${SYS_USER_HOME}" fi - if [[ "${oldhshell}" -ne "${SYS_USER_SHELL}" ]]; then - die "shell conflict for new user ${SYS_USER_HOME}" - fi - - if [[ "${olduid}" -ne "${SYS_USER_UID}" ]]; then - die "UID conflict for new user ${SYS_USER_NAME}" + if [[ "${oldhshell}" != "${SYS_USER_SHELL}" ]]; then + die "shell conflict for new user: ${SYS_USER_SHELL}" fi # The user already exists, so all we have left to do is to try - # to append SYS_USER_GROUPS to the existing groups. The "usermod" - # tool expects a comma-separated list, so change our spaces to - # commas. This does succeed if you append duplicates. - usermod --append --groups "${SYS_USER_GROUPS// /,}" \ + # to append SYS_USER_GROUPS to the existing groups. The home + # dir, shell, and uid should all match already. + sys-user_modify \ || die "failed to append groups to existing user ${SYS_USER_NAME}" fi } -sys-user_pkg_postinst() { - if [[ -n "${REPLACING_VERSIONS}" ]]; then - # This is an upgrade from a previous version of a sys-user - # package. This case has to be handled carefully to make sure - # that the pkg_prerm() of the old version doesn't remove the user - # that this new version is going to add. At this point, in our - # pkg_postinst(), the old version's pkg_prerm() phase should have - # already happened. - if [[ -n $(egetent passwd "${SYS_USER_NAME}") ]]; then - die "User ${SYS_USER_NAME} already exists during an upgrade." - else - enewuser "${SYS_USER_NAME}" \ - "${SYS_USER_UID}" \ - "${SYS_USER_SHELL}" \ - "${SYS_USER_HOME}" \ - "${SYS_USER_GROUPS}" \ - || die "failed to add user ${SYS_USER_NAME}" - fi - fi -} sys-user_pkg_prerm() { - if [[ -z $(egetent passwd "${SYS_USER_NAME}") ]]; then + if [[ -z $(sys-user_getuid "${SYS_USER_NAME}") ]]; then # We have successfully done nothing. ewarn "Tried to remove nonexistent user ${SYS_USER_NAME}." - else - userdel "${SYS_USER_NAME}" || \ - die "failed to remove user ${SYS_USER_NAME}" - einfo "Removed user ${SYS_USER_NAME} from the system." + elif [[ -z "${REPLACING_VERSIONS}" ]]; then + # The user to remove exists, and this is not an upgrade. For + # Phase 1, we maintain the status quo and simply refuse to + # remove him (unless you know what you are doing). + if [[ "${I_KNOW_WHAT_I_AM_DOING}" == "yes" ]]; then + userdel "${SYS_USER_NAME}" || \ + die "failed to remove user ${SYS_USER_NAME}" + einfo "Removed user ${SYS_USER_NAME} from the system." + else + die "refusing to remove package for system user ${SYS_USER_NAME}" + fi + + # The missing case: if the user exists and this is an upgrade, + # we leave the user alone to be modified in + # sys-user_pkg_preinst(). fi }