su: document -l in --help text. Closes bug 2761
[platform/upstream/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 FIRST_SYSTEM_ID
122         int "First valid system uid or gid for adduser and addgroup"
123         depends on ADDUSER || ADDGROUP
124         range 0 64900
125         default 100
126         help
127           First valid system uid or gid for adduser and addgroup
128
129 config LAST_SYSTEM_ID
130         int "Last valid system uid or gid for adduser and addgroup"
131         depends on ADDUSER || ADDGROUP
132         range 0 64900
133         default 999
134         help
135           Last valid system uid or gid for adduser and addgroup
136
137 config ADDGROUP
138         bool "addgroup"
139         default y
140         help
141           Utility for creating a new group account.
142
143 config FEATURE_ADDGROUP_LONG_OPTIONS
144         bool "Enable long options"
145         default y
146         depends on ADDGROUP && LONG_OPTS
147         help
148           Support long options for the addgroup applet.
149
150 config FEATURE_ADDUSER_TO_GROUP
151         bool "Support for adding users to groups"
152         default y
153         depends on ADDGROUP
154         help
155           If  called  with two non-option arguments,
156           addgroup will add an existing user to an
157           existing group.
158
159 config DELUSER
160         bool "deluser"
161         default y
162         help
163           Utility for deleting a user account.
164
165 config DELGROUP
166         bool "delgroup"
167         default y
168         help
169           Utility for deleting a group account.
170
171 config FEATURE_DEL_USER_FROM_GROUP
172         bool "Support for removing users from groups"
173         default y
174         depends on DELGROUP
175         help
176           If called with two non-option arguments, deluser
177           or delgroup will remove an user from a specified group.
178
179 config GETTY
180         bool "getty"
181         default y
182         select FEATURE_SYSLOG
183         help
184           getty lets you log in on a tty, it is normally invoked by init.
185
186 config LOGIN
187         bool "login"
188         default y
189         select FEATURE_SUID
190         select FEATURE_SYSLOG
191         help
192           login is used when signing onto a system.
193
194           Note that Busybox binary must be setuid root for this applet to
195           work properly.
196
197 config PAM
198         bool "Support for PAM (Pluggable Authentication Modules)"
199         default n
200         depends on LOGIN
201         help
202           Use PAM in login(1) instead of direct access to password database.
203
204 config LOGIN_SCRIPTS
205         bool "Support for login scripts"
206         depends on LOGIN
207         default y
208         help
209           Enable this if you want login to execute $LOGIN_PRE_SUID_SCRIPT
210           just prior to switching from root to logged-in user.
211
212 config FEATURE_NOLOGIN
213         bool "Support for /etc/nologin"
214         default y
215         depends on LOGIN
216         help
217           The file /etc/nologin is used by (some versions of) login(1).
218           If it exists, non-root logins are prohibited.
219
220 config FEATURE_SECURETTY
221         bool "Support for /etc/securetty"
222         default y
223         depends on LOGIN
224         help
225           The file /etc/securetty is used by (some versions of) login(1).
226           The file contains the device names of tty lines (one per line,
227           without leading /dev/) on which root is allowed to login.
228
229 config PASSWD
230         bool "passwd"
231         default y
232         select FEATURE_SUID
233         select FEATURE_SYSLOG
234         help
235           passwd changes passwords for user and group accounts. A normal user
236           may only change the password for his/her own account, the super user
237           may change the password for any account. The administrator of a group
238           may change the password for the group.
239
240           Note that Busybox binary must be setuid root for this applet to
241           work properly.
242
243 config FEATURE_PASSWD_WEAK_CHECK
244         bool "Check new passwords for weakness"
245         default y
246         depends on PASSWD
247         help
248           With this option passwd will refuse new passwords which are "weak".
249
250 config CRYPTPW
251         bool "cryptpw"
252         default y
253         help
254           Encrypts the given password with the crypt(3) libc function
255           using the given salt. Debian has this utility under mkpasswd
256           name. Busybox provides mkpasswd as an alias for cryptpw.
257
258 config CHPASSWD
259         bool "chpasswd"
260         default y
261         help
262           Reads a file of user name and password pairs from standard input
263           and uses this information to update a group of existing users.
264
265 config SU
266         bool "su"
267         default y
268         select FEATURE_SUID
269         select FEATURE_SYSLOG
270         help
271           su is used to become another user during a login session.
272           Invoked without a username, su defaults to becoming the super user.
273
274           Note that Busybox binary must be setuid root for this applet to
275           work properly.
276
277 config FEATURE_SU_SYSLOG
278         bool "Enable su to write to syslog"
279         default y
280         depends on SU
281
282 config FEATURE_SU_CHECKS_SHELLS
283         bool "Enable su to check user's shell to be listed in /etc/shells"
284         depends on SU
285         default y
286
287 config SULOGIN
288         bool "sulogin"
289         default y
290         select FEATURE_SYSLOG
291         help
292           sulogin is invoked when the system goes into single user
293           mode (this is done through an entry in inittab).
294
295 config VLOCK
296         bool "vlock"
297         default y
298         select FEATURE_SUID
299         help
300           Build the "vlock" applet which allows you to lock (virtual) terminals.
301
302           Note that Busybox binary must be setuid root for this applet to
303           work properly.
304
305 endmenu