addgroup: mention -S in the help text
[oweals/busybox.git] / loginutils / Config.src
1 #
2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
4 #
5
6 menu "Login/Password Management Utilities"
7
8 INSERT
9
10 config FEATURE_SHADOWPASSWDS
11         bool "Support for shadow passwords"
12         default y
13         help
14           Build support for shadow password in /etc/shadow. This file is only
15           readable by root and thus the encrypted passwords are no longer
16           publicly readable.
17
18 config USE_BB_PWD_GRP
19         bool "Use internal password and group functions rather than system functions"
20         default y
21         help
22           If you leave this disabled, busybox will use the system's password
23           and group functions. And if you are using the GNU C library
24           (glibc), you will then need to install the /etc/nsswitch.conf
25           configuration file and the required /lib/libnss_* libraries in
26           order for the password and group functions to work. This generally
27           makes your embedded system quite a bit larger.
28
29           Enabling this option will cause busybox to directly access the
30           system's /etc/password, /etc/group files (and your system will be
31           smaller, and I will get fewer emails asking about how glibc NSS
32           works). When this option is enabled, you will not be able to use
33           PAM to access remote LDAP password servers and whatnot. And if you
34           want hostname resolution to work with glibc, you still need the
35           /lib/libnss_* libraries.
36
37           If you need to use glibc's nsswitch.conf mechanism
38           (e.g. if user/group database is NOT stored in /etc/passwd etc),
39           you must NOT use this option.
40
41           If you enable this option, it will add about 1.5k.
42
43 config USE_BB_SHADOW
44         bool "Use internal shadow password functions"
45         default y
46         depends on USE_BB_PWD_GRP && FEATURE_SHADOWPASSWDS
47         help
48           If you leave this disabled, busybox will use the system's shadow
49           password handling functions. And if you are using the GNU C library
50           (glibc), you will then need to install the /etc/nsswitch.conf
51           configuration file and the required /lib/libnss_* libraries in
52           order for the shadow password functions to work. This generally
53           makes your embedded system quite a bit larger.
54
55           Enabling this option will cause busybox to directly access the
56           system's /etc/shadow file when handling shadow passwords. This
57           makes your system smaller (and I will get fewer emails asking about
58           how glibc NSS works). When this option is enabled, you will not be
59           able to use PAM to access shadow passwords from remote LDAP
60           password servers and whatnot.
61
62 config USE_BB_CRYPT
63         bool "Use internal crypt functions"
64         default y
65         help
66           Busybox has internal DES and MD5 crypt functions.
67           They produce results which are identical to corresponding
68           standard C library functions.
69
70           If you leave this disabled, busybox will use the system's
71           crypt functions. Most C libraries use large (~70k)
72           static buffers there, and also combine them with more general
73           DES encryption/decryption.
74
75           For busybox, having large static buffers is undesirable,
76           especially on NOMMU machines. Busybox also doesn't need
77           DES encryption/decryption and can do with smaller code.
78
79           If you enable this option, it will add about 4.8k of code
80           if you are building dynamically linked executable.
81           In static build, it makes code _smaller_ by about 1.2k,
82           and likely many kilobytes less of bss.
83
84 config USE_BB_CRYPT_SHA
85         bool "Enable SHA256/512 crypt functions"
86         default y
87         depends on USE_BB_CRYPT
88         help
89           Enable this if you have passwords starting with "$5$" or "$6$"
90           in your /etc/passwd or /etc/shadow files. These passwords
91           are hashed using SHA256 and SHA512 algorithms. Support for them
92           was added to glibc in 2008.
93           With this option off, login will fail password check for any
94           user which has password encrypted with these algorithms.
95
96 config ADDUSER
97         bool "adduser"
98         default y
99         help
100           Utility for creating a new user account.
101
102 config FEATURE_ADDUSER_LONG_OPTIONS
103         bool "Enable long options"
104         default y
105         depends on ADDUSER && LONG_OPTS
106         help
107           Support long options for the adduser applet.
108
109 config FEATURE_CHECK_NAMES
110         bool "Enable sanity check on user/group names in adduser and addgroup"
111         default n
112         depends on ADDUSER || ADDGROUP
113         help
114           Enable sanity check on user and group names in adduser and addgroup.
115           To avoid problems, the user or group name should consist only of
116           letters, digits, underscores, periods, at signs and dashes,
117           and not start with a dash (as defined by IEEE Std 1003.1-2001).
118           For compatibility with Samba machine accounts "$" is also supported
119           at the end of the user or group name.
120
121 config LAST_ID
122         int "Last valid uid or gid for adduser and addgroup"
123         depends on ADDUSER || ADDGROUP
124         default 60000
125         help
126           Last valid uid or gid for adduser and addgroup
127
128 config FIRST_SYSTEM_ID
129         int "First valid system uid or gid for adduser and addgroup"
130         depends on ADDUSER || ADDGROUP
131         range 0 LAST_ID
132         default 100
133         help
134           First valid system uid or gid for adduser and addgroup
135
136 config LAST_SYSTEM_ID
137         int "Last valid system uid or gid for adduser and addgroup"
138         depends on ADDUSER || ADDGROUP
139         range FIRST_SYSTEM_ID LAST_ID
140         default 999
141         help
142           Last valid system uid or gid for adduser and addgroup
143
144 config ADDGROUP
145         bool "addgroup"
146         default y
147         help
148           Utility for creating a new group account.
149
150 config FEATURE_ADDGROUP_LONG_OPTIONS
151         bool "Enable long options"
152         default y
153         depends on ADDGROUP && LONG_OPTS
154         help
155           Support long options for the addgroup applet.
156
157 config FEATURE_ADDUSER_TO_GROUP
158         bool "Support for adding users to groups"
159         default y
160         depends on ADDGROUP
161         help
162           If  called  with two non-option arguments,
163           addgroup will add an existing user to an
164           existing group.
165
166 config DELUSER
167         bool "deluser"
168         default y
169         help
170           Utility for deleting a user account.
171
172 config DELGROUP
173         bool "delgroup"
174         default y
175         help
176           Utility for deleting a group account.
177
178 config FEATURE_DEL_USER_FROM_GROUP
179         bool "Support for removing users from groups"
180         default y
181         depends on DELGROUP
182         help
183           If called with two non-option arguments, deluser
184           or delgroup will remove an user from a specified group.
185
186 config GETTY
187         bool "getty"
188         default y
189         select FEATURE_SYSLOG
190         help
191           getty lets you log in on a tty. It is normally invoked by init.
192
193           Note that you can save a few bytes by disabling it and
194           using login applet directly.
195           If you need to reset tty attributes before calling login,
196           this script approximates getty:
197
198           exec </dev/$1 >/dev/$1 2>&1 || exit 1
199           reset
200           stty sane; stty ispeed 38400; stty ospeed 38400
201           printf "%s login: " "`hostname`"
202           read -r login
203           exec /bin/login "$login"
204
205 config LOGIN
206         bool "login"
207         default y
208         select FEATURE_SYSLOG
209         help
210           login is used when signing onto a system.
211
212           Note that Busybox binary must be setuid root for this applet to
213           work properly.
214
215 config LOGIN_SESSION_AS_CHILD
216         bool "Run logged in session in a child process"
217         default y if PAM
218         depends on LOGIN
219         help
220           Run the logged in session in a child process.  This allows
221           login to clean up things such as utmp entries or PAM sessions
222           when the login session is complete.  If you use PAM, you
223           almost always would want this to be set to Y, else PAM session
224           will not be cleaned up.
225
226 config LOGIN_SCRIPTS
227         bool "Support for login scripts"
228         depends on LOGIN
229         default y
230         help
231           Enable this if you want login to execute $LOGIN_PRE_SUID_SCRIPT
232           just prior to switching from root to logged-in user.
233
234 config FEATURE_NOLOGIN
235         bool "Support for /etc/nologin"
236         default y
237         depends on LOGIN
238         help
239           The file /etc/nologin is used by (some versions of) login(1).
240           If it exists, non-root logins are prohibited.
241
242 config FEATURE_SECURETTY
243         bool "Support for /etc/securetty"
244         default y
245         depends on LOGIN
246         help
247           The file /etc/securetty is used by (some versions of) login(1).
248           The file contains the device names of tty lines (one per line,
249           without leading /dev/) on which root is allowed to login.
250
251 config PASSWD
252         bool "passwd"
253         default y
254         select FEATURE_SYSLOG
255         help
256           passwd changes passwords for user and group accounts. A normal user
257           may only change the password for his/her own account, the super user
258           may change the password for any account. The administrator of a group
259           may change the password for the group.
260
261           Note that Busybox binary must be setuid root for this applet to
262           work properly.
263
264 config FEATURE_PASSWD_WEAK_CHECK
265         bool "Check new passwords for weakness"
266         default y
267         depends on PASSWD
268         help
269           With this option passwd will refuse new passwords which are "weak".
270
271 config CRYPTPW
272         bool "cryptpw"
273         default y
274         help
275           Encrypts the given password with the crypt(3) libc function
276           using the given salt. Debian has this utility under mkpasswd
277           name. Busybox provides mkpasswd as an alias for cryptpw.
278
279 config CHPASSWD
280         bool "chpasswd"
281         default y
282         help
283           Reads a file of user name and password pairs from standard input
284           and uses this information to update a group of existing users.
285
286 config FEATURE_DEFAULT_PASSWD_ALGO
287         string "Default password encryption method (passwd -a, cryptpw -m parameter)"
288         default "des"
289         depends on PASSWD || CRYPTPW
290         help
291           Possible choices are "d[es]", "m[d5]", "s[ha256]" or "sha512".
292
293 config SU
294         bool "su"
295         default y
296         select FEATURE_SYSLOG
297         help
298           su is used to become another user during a login session.
299           Invoked without a username, su defaults to becoming the super user.
300
301           Note that Busybox binary must be setuid root for this applet to
302           work properly.
303
304 config FEATURE_SU_SYSLOG
305         bool "Enable su to write to syslog"
306         default y
307         depends on SU
308
309 config FEATURE_SU_CHECKS_SHELLS
310         bool "Enable su to check user's shell to be listed in /etc/shells"
311         depends on SU
312         default y
313
314 config SULOGIN
315         bool "sulogin"
316         default y
317         select FEATURE_SYSLOG
318         help
319           sulogin is invoked when the system goes into single user
320           mode (this is done through an entry in inittab).
321
322 config VLOCK
323         bool "vlock"
324         default y
325         help
326           Build the "vlock" applet which allows you to lock (virtual) terminals.
327
328           Note that Busybox binary must be setuid root for this applet to
329           work properly.
330
331 endmenu