xref: /openbmc/openbmc/poky/meta/lib/oe/useradd.py (revision 393846f1) 
1#
2# SPDX-License-Identifier: GPL-2.0-only
3#
4import argparse
5import re
6
7class myArgumentParser(argparse.ArgumentParser):
8    def _print_message(self, message, file=None):
9        bb.warn("%s - %s: %s" % (d.getVar('PN'), pkg, message))
10
11    # This should never be called...
12    def exit(self, status=0, message=None):
13        message = message or ("%s - %s: useradd.bbclass: Argument parsing exited" % (d.getVar('PN'), pkg))
14        error(message)
15
16    def error(self, message):
17        raise bb.build.FuncFailed(message)
18
19def split_commands(params):
20    params = re.split('''[ \t]*;[ \t]*(?=(?:[^'"]|'[^']*'|"[^"]*")*$)''', params.strip())
21    # Remove any empty items
22    return [x for x in params if x]
23
24def split_args(params):
25    params = re.split('''[ \t]+(?=(?:[^'"]|'[^']*'|"[^"]*")*$)''', params.strip())
26    # Remove any empty items
27    return [x for x in params if x]
28
29def build_useradd_parser():
30    # The following comes from --help on useradd from shadow
31    parser = myArgumentParser(prog='useradd')
32    parser.add_argument("-b", "--base-dir", metavar="BASE_DIR", help="base directory for the home directory of the new account")
33    parser.add_argument("-c", "--comment", metavar="COMMENT", help="GECOS field of the new account")
34    parser.add_argument("-d", "--home-dir", metavar="HOME_DIR", help="home directory of the new account")
35    parser.add_argument("-D", "--defaults", help="print or change default useradd configuration", action="store_true")
36    parser.add_argument("-e", "--expiredate", metavar="EXPIRE_DATE", help="expiration date of the new account")
37    parser.add_argument("-f", "--inactive", metavar="INACTIVE", help="password inactivity period of the new account")
38    parser.add_argument("-g", "--gid", metavar="GROUP", help="name or ID of the primary group of the new account")
39    parser.add_argument("-G", "--groups", metavar="GROUPS", help="list of supplementary groups of the new account")
40    parser.add_argument("-k", "--skel", metavar="SKEL_DIR", help="use this alternative skeleton directory")
41    parser.add_argument("-K", "--key", metavar="KEY=VALUE", help="override /etc/login.defs defaults")
42    parser.add_argument("-l", "--no-log-init", help="do not add the user to the lastlog and faillog databases", action="store_true")
43    parser.add_argument("-m", "--create-home", help="create the user's home directory", action="store_const", const=True)
44    parser.add_argument("-M", "--no-create-home", dest="create_home", help="do not create the user's home directory", action="store_const", const=False)
45    parser.add_argument("-N", "--no-user-group", dest="user_group", help="do not create a group with the same name as the user", action="store_const", const=False)
46    parser.add_argument("-o", "--non-unique", help="allow to create users with duplicate (non-unique UID)", action="store_true")
47    parser.add_argument("-p", "--password", metavar="PASSWORD", help="encrypted password of the new account")
48    parser.add_argument("-P", "--clear-password", metavar="CLEAR_PASSWORD", help="use this clear password for the new account")
49    parser.add_argument("-R", "--root", metavar="CHROOT_DIR", help="directory to chroot into")
50    parser.add_argument("-r", "--system", help="create a system account", action="store_true")
51    parser.add_argument("-s", "--shell", metavar="SHELL", help="login shell of the new account")
52    parser.add_argument("-u", "--uid", metavar="UID", help="user ID of the new account")
53    parser.add_argument("-U", "--user-group", help="create a group with the same name as the user", action="store_const", const=True)
54    parser.add_argument("LOGIN", help="Login name of the new user")
55
56    return parser
57
58def build_groupadd_parser():
59    # The following comes from --help on groupadd from shadow
60    parser = myArgumentParser(prog='groupadd')
61    parser.add_argument("-f", "--force", help="exit successfully if the group already exists, and cancel -g if the GID is already used", action="store_true")
62    parser.add_argument("-g", "--gid", metavar="GID", help="use GID for the new group")
63    parser.add_argument("-K", "--key", metavar="KEY=VALUE", help="override /etc/login.defs defaults")
64    parser.add_argument("-o", "--non-unique", help="allow to create groups with duplicate (non-unique) GID", action="store_true")
65    parser.add_argument("-p", "--password", metavar="PASSWORD", help="use this encrypted password for the new group")
66    parser.add_argument("-P", "--clear-password", metavar="CLEAR_PASSWORD", help="use this clear password for the new group")
67    parser.add_argument("-R", "--root", metavar="CHROOT_DIR", help="directory to chroot into")
68    parser.add_argument("-r", "--system", help="create a system account", action="store_true")
69    parser.add_argument("GROUP", help="Group name of the new group")
70
71    return parser
72