blob: 20771a0ce598f7c35d8474cdf4785b3f0c496a70 [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001inherit useradd_base
2
3# base-passwd-cross provides the default passwd and group files in the
4# target sysroot, and shadow -native and -sysroot provide the utilities
5# and support files needed to add and modify user and group accounts
Patrick Williams213cb262021-08-07 19:21:33 -05006DEPENDS:append:class-target = " base-files shadow-native shadow-sysroot shadow base-passwd"
Brad Bishop6e60e8b2018-02-01 10:27:11 -05007PACKAGE_WRITE_DEPS += "shadow-native"
Patrick Williamsc124f4f2015-09-15 14:41:29 -05008
9# This preinstall function can be run in four different contexts:
10#
11# a) Before do_install
12# b) At do_populate_sysroot_setscene when installing from sstate packages
13# c) As the preinst script in the target package at do_rootfs time
14# d) As the preinst script in the target package on device as a package upgrade
15#
16useradd_preinst () {
17OPT=""
18SYSROOT=""
19
20if test "x$D" != "x"; then
21 # Installing into a sysroot
22 SYSROOT="$D"
23 OPT="--root $D"
24
25 # Make sure login.defs is there, this is to make debian package backend work
26 # correctly while doing rootfs.
27 # The problem here is that if /etc/login.defs is treated as a config file for
28 # shadow package, then while performing preinsts for packages that depend on
29 # shadow, there might only be /etc/login.def.dpkg-new there in root filesystem.
30 if [ ! -e $D${sysconfdir}/login.defs -a -e $D${sysconfdir}/login.defs.dpkg-new ]; then
31 cp $D${sysconfdir}/login.defs.dpkg-new $D${sysconfdir}/login.defs
32 fi
33
34 # user/group lookups should match useradd/groupadd --root
Brad Bishop6e60e8b2018-02-01 10:27:11 -050035 export PSEUDO_PASSWD="$SYSROOT"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050036fi
37
38# If we're not doing a special SSTATE/SYSROOT install
39# then set the values, otherwise use the environment
40if test "x$UA_SYSROOT" = "x"; then
41 # Installing onto a target
42 # Add groups and users defined only for this package
43 GROUPADD_PARAM="${GROUPADD_PARAM}"
44 USERADD_PARAM="${USERADD_PARAM}"
45 GROUPMEMS_PARAM="${GROUPMEMS_PARAM}"
46fi
47
48# Perform group additions first, since user additions may depend
49# on these groups existing
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050050if test "x`echo $GROUPADD_PARAM | tr -d '[:space:]'`" != "x"; then
Patrick Williamsc124f4f2015-09-15 14:41:29 -050051 echo "Running groupadd commands..."
52 # Invoke multiple instances of groupadd for parameter lists
53 # separated by ';'
Patrick Williamsc0f7c042017-02-23 20:41:17 -060054 opts=`echo "$GROUPADD_PARAM" | cut -d ';' -f 1 | sed -e 's#[ \t]*$##'`
55 remaining=`echo "$GROUPADD_PARAM" | cut -d ';' -f 2- | sed -e 's#[ \t]*$##'`
Patrick Williamsc124f4f2015-09-15 14:41:29 -050056 while test "x$opts" != "x"; do
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050057 perform_groupadd "$SYSROOT" "$OPT $opts"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050058 if test "x$opts" = "x$remaining"; then
59 break
60 fi
Patrick Williamsc0f7c042017-02-23 20:41:17 -060061 opts=`echo "$remaining" | cut -d ';' -f 1 | sed -e 's#[ \t]*$##'`
62 remaining=`echo "$remaining" | cut -d ';' -f 2- | sed -e 's#[ \t]*$##'`
Patrick Williamsc124f4f2015-09-15 14:41:29 -050063 done
64fi
65
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050066if test "x`echo $USERADD_PARAM | tr -d '[:space:]'`" != "x"; then
Patrick Williamsc124f4f2015-09-15 14:41:29 -050067 echo "Running useradd commands..."
68 # Invoke multiple instances of useradd for parameter lists
69 # separated by ';'
Patrick Williamsc0f7c042017-02-23 20:41:17 -060070 opts=`echo "$USERADD_PARAM" | cut -d ';' -f 1 | sed -e 's#[ \t]*$##'`
71 remaining=`echo "$USERADD_PARAM" | cut -d ';' -f 2- | sed -e 's#[ \t]*$##'`
Patrick Williamsc124f4f2015-09-15 14:41:29 -050072 while test "x$opts" != "x"; do
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050073 perform_useradd "$SYSROOT" "$OPT $opts"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050074 if test "x$opts" = "x$remaining"; then
75 break
76 fi
Patrick Williamsc0f7c042017-02-23 20:41:17 -060077 opts=`echo "$remaining" | cut -d ';' -f 1 | sed -e 's#[ \t]*$##'`
78 remaining=`echo "$remaining" | cut -d ';' -f 2- | sed -e 's#[ \t]*$##'`
Patrick Williamsc124f4f2015-09-15 14:41:29 -050079 done
80fi
81
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050082if test "x`echo $GROUPMEMS_PARAM | tr -d '[:space:]'`" != "x"; then
Patrick Williamsc124f4f2015-09-15 14:41:29 -050083 echo "Running groupmems commands..."
84 # Invoke multiple instances of groupmems for parameter lists
85 # separated by ';'
Patrick Williamsc0f7c042017-02-23 20:41:17 -060086 opts=`echo "$GROUPMEMS_PARAM" | cut -d ';' -f 1 | sed -e 's#[ \t]*$##'`
87 remaining=`echo "$GROUPMEMS_PARAM" | cut -d ';' -f 2- | sed -e 's#[ \t]*$##'`
Patrick Williamsc124f4f2015-09-15 14:41:29 -050088 while test "x$opts" != "x"; do
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050089 perform_groupmems "$SYSROOT" "$OPT $opts"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050090 if test "x$opts" = "x$remaining"; then
91 break
92 fi
Patrick Williamsc0f7c042017-02-23 20:41:17 -060093 opts=`echo "$remaining" | cut -d ';' -f 1 | sed -e 's#[ \t]*$##'`
94 remaining=`echo "$remaining" | cut -d ';' -f 2- | sed -e 's#[ \t]*$##'`
Patrick Williamsc124f4f2015-09-15 14:41:29 -050095 done
96fi
97}
98
99useradd_sysroot () {
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500100 # Pseudo may (do_prepare_recipe_sysroot) or may not (do_populate_sysroot_setscene) be running
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500101 # at this point so we're explicit about the environment so pseudo can load if
102 # not already present.
Brad Bishop15ae2502019-06-18 21:44:24 -0400103 # PSEUDO_SYSROOT can contain references to the build architecture and COMPONENT_DIR
104 # so needs the STAGING_FIXME below
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500105 export PSEUDO="${FAKEROOTENV} ${PSEUDO_SYSROOT}${bindir_native}/pseudo"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500106
107 # Explicitly set $D since it isn't set to anything
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500108 # before do_prepare_recipe_sysroot
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500109 D=${STAGING_DIR_TARGET}
110
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500111 # base-passwd's postinst may not have run yet in which case we'll get called later, just exit.
112 # Beware that in some cases we might see the fake pseudo passwd here, in which case we also must
113 # exit.
114 if [ ! -f $D${sysconfdir}/passwd ] ||
115 grep -q this-is-the-pseudo-passwd $D${sysconfdir}/passwd; then
116 exit 0
117 fi
118
119 # It is also possible we may be in a recipe which doesn't have useradd dependencies and hence the
120 # useradd/groupadd tools are unavailable. If there is no dependency, we assume we don't want to
121 # create users in the sysroot
122 if ! command -v useradd; then
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500123 bbwarn "command useradd not found!"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500124 exit 0
125 fi
126
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500127 # Add groups and users defined for all recipe packages
128 GROUPADD_PARAM="${@get_all_cmd_params(d, 'groupadd')}"
129 USERADD_PARAM="${@get_all_cmd_params(d, 'useradd')}"
130 GROUPMEMS_PARAM="${@get_all_cmd_params(d, 'groupmems')}"
131
132 # Tell the system to use the environment vars
133 UA_SYSROOT=1
134
135 useradd_preinst
136}
137
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500138# The export of PSEUDO in useradd_sysroot() above contains references to
Brad Bishop15ae2502019-06-18 21:44:24 -0400139# ${PSEUDO_SYSROOT} and ${PSEUDO_LOCALSTATEDIR}. Additionally, the logging
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500140# shell functions use ${LOGFIFO}. These need to be handled when restoring
141# postinst-useradd-${PN} from the sstate cache.
Brad Bishop15ae2502019-06-18 21:44:24 -0400142EXTRA_STAGING_FIXMES += "PSEUDO_SYSROOT PSEUDO_LOCALSTATEDIR LOGFIFO"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500143
144python useradd_sysroot_sstate () {
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500145 scriptfile = None
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500146 task = d.getVar("BB_CURRENTTASK")
147 if task == "package_setscene":
148 bb.build.exec_func("useradd_sysroot", d)
149 elif task == "prepare_recipe_sysroot":
150 # Used to update this recipe's own sysroot so the user/groups are available to do_install
151 scriptfile = d.expand("${RECIPE_SYSROOT}${bindir}/postinst-useradd-${PN}")
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500152 bb.build.exec_func("useradd_sysroot", d)
153 elif task == "populate_sysroot":
154 # Used when installed in dependent task sysroots
155 scriptfile = d.expand("${SYSROOT_DESTDIR}${bindir}/postinst-useradd-${PN}")
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500156
157 if scriptfile:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500158 bb.utils.mkdirhier(os.path.dirname(scriptfile))
159 with open(scriptfile, 'w') as script:
160 script.write("#!/bin/sh\n")
161 bb.data.emit_func("useradd_sysroot", script, d)
162 script.write("useradd_sysroot\n")
163 os.chmod(scriptfile, 0o755)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500164}
165
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500166do_prepare_recipe_sysroot[postfuncs] += "${SYSROOTFUNC}"
Patrick Williams213cb262021-08-07 19:21:33 -0500167SYSROOTFUNC:class-target = "useradd_sysroot_sstate"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600168SYSROOTFUNC = ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500169
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500170SYSROOT_PREPROCESS_FUNCS += "${SYSROOTFUNC}"
171
Patrick Williams213cb262021-08-07 19:21:33 -0500172SSTATEPREINSTFUNCS:append:class-target = " useradd_sysroot_sstate"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600173
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500174do_package_setscene[depends] += "${USERADDSETSCENEDEPS}"
175do_populate_sysroot_setscene[depends] += "${USERADDSETSCENEDEPS}"
Patrick Williams213cb262021-08-07 19:21:33 -0500176USERADDSETSCENEDEPS:class-target = "${MLPREFIX}base-passwd:do_populate_sysroot_setscene pseudo-native:do_populate_sysroot_setscene shadow-native:do_populate_sysroot_setscene ${MLPREFIX}shadow-sysroot:do_populate_sysroot_setscene"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600177USERADDSETSCENEDEPS = ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500178
179# Recipe parse-time sanity checks
180def update_useradd_after_parse(d):
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500181 useradd_packages = d.getVar('USERADD_PACKAGES')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500182
183 if not useradd_packages:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600184 bb.fatal("%s inherits useradd but doesn't set USERADD_PACKAGES" % d.getVar('FILE', False))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500185
186 for pkg in useradd_packages.split():
Patrick Williams213cb262021-08-07 19:21:33 -0500187 d.appendVarFlag("do_populate_sysroot", "vardeps", "USERADD_PARAM:%s GROUPADD_PARAM:%s GROUPMEMS_PARAM:%s" % (pkg, pkg, pkg))
188 if not d.getVar('USERADD_PARAM:%s' % pkg) and not d.getVar('GROUPADD_PARAM:%s' % pkg) and not d.getVar('GROUPMEMS_PARAM:%s' % pkg):
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500189 bb.fatal("%s inherits useradd but doesn't set USERADD_PARAM, GROUPADD_PARAM or GROUPMEMS_PARAM for package %s" % (d.getVar('FILE', False), pkg))
190
191python __anonymous() {
192 if not bb.data.inherits_class('nativesdk', d) \
193 and not bb.data.inherits_class('native', d):
194 update_useradd_after_parse(d)
195}
196
197# Return a single [GROUP|USER]ADD_PARAM formatted string which includes the
198# [group|user]add parameters for all USERADD_PACKAGES in this recipe
199def get_all_cmd_params(d, cmd_type):
200 import string
201
Patrick Williams213cb262021-08-07 19:21:33 -0500202 param_type = cmd_type.upper() + "_PARAM:%s"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500203 params = []
204
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500205 useradd_packages = d.getVar('USERADD_PACKAGES') or ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500206 for pkg in useradd_packages.split():
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500207 param = d.getVar(param_type % pkg)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500208 if param:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600209 params.append(param.rstrip(" ;"))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500210
211 return "; ".join(params)
212
213# Adds the preinst script into generated packages
Patrick Williams213cb262021-08-07 19:21:33 -0500214fakeroot python populate_packages:prepend () {
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500215 def update_useradd_package(pkg):
216 bb.debug(1, 'adding user/group calls to preinst for %s' % pkg)
217
218 """
219 useradd preinst is appended here because pkg_preinst may be
220 required to execute on the target. Not doing so may cause
221 useradd preinst to be invoked twice, causing unwanted warnings.
222 """
Patrick Williams213cb262021-08-07 19:21:33 -0500223 preinst = d.getVar('pkg_preinst:%s' % pkg) or d.getVar('pkg_preinst')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500224 if not preinst:
225 preinst = '#!/bin/sh\n'
226 preinst += 'bbnote () {\n\techo "NOTE: $*"\n}\n'
227 preinst += 'bbwarn () {\n\techo "WARNING: $*"\n}\n'
228 preinst += 'bbfatal () {\n\techo "ERROR: $*"\n\texit 1\n}\n'
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500229 preinst += 'perform_groupadd () {\n%s}\n' % d.getVar('perform_groupadd')
230 preinst += 'perform_useradd () {\n%s}\n' % d.getVar('perform_useradd')
231 preinst += 'perform_groupmems () {\n%s}\n' % d.getVar('perform_groupmems')
232 preinst += d.getVar('useradd_preinst')
Andrew Geissler5199d832021-09-24 16:47:35 -0500233 # Expand out the *_PARAM variables to the package specific versions
234 for rep in ["GROUPADD_PARAM", "USERADD_PARAM", "GROUPMEMS_PARAM"]:
235 val = d.getVar(rep + ":" + pkg) or ""
236 preinst = preinst.replace("${" + rep + "}", val)
Patrick Williams213cb262021-08-07 19:21:33 -0500237 d.setVar('pkg_preinst:%s' % pkg, preinst)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500238
239 # RDEPENDS setup
Patrick Williams213cb262021-08-07 19:21:33 -0500240 rdepends = d.getVar("RDEPENDS:%s" % pkg) or ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500241 rdepends += ' ' + d.getVar('MLPREFIX', False) + 'base-passwd'
242 rdepends += ' ' + d.getVar('MLPREFIX', False) + 'shadow'
243 # base-files is where the default /etc/skel is packaged
244 rdepends += ' ' + d.getVar('MLPREFIX', False) + 'base-files'
Patrick Williams213cb262021-08-07 19:21:33 -0500245 d.setVar("RDEPENDS:%s" % pkg, rdepends)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500246
247 # Add the user/group preinstall scripts and RDEPENDS requirements
248 # to packages specified by USERADD_PACKAGES
249 if not bb.data.inherits_class('nativesdk', d) \
250 and not bb.data.inherits_class('native', d):
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500251 useradd_packages = d.getVar('USERADD_PACKAGES') or ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500252 for pkg in useradd_packages.split():
253 update_useradd_package(pkg)
254}
255
256# Use the following to extend the useradd with custom functions
257USERADDEXTENSION ?= ""
258
259inherit ${USERADDEXTENSION}