1 /* vi: set sw=4 ts=4: */
3 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
8 //config: select FEATURE_SYSLOG
10 //config: login is used when signing onto a system.
12 //config: Note that Busybox binary must be setuid root for this applet to
13 //config: work properly.
15 //config:config LOGIN_SESSION_AS_CHILD
16 //config: bool "Run logged in session in a child process"
17 //config: default y if PAM
18 //config: depends on LOGIN
20 //config: Run the logged in session in a child process. This allows
21 //config: login to clean up things such as utmp entries or PAM sessions
22 //config: when the login session is complete. If you use PAM, you
23 //config: almost always would want this to be set to Y, else PAM session
24 //config: will not be cleaned up.
26 //config:config LOGIN_SCRIPTS
27 //config: bool "Support login scripts"
28 //config: depends on LOGIN
31 //config: Enable this if you want login to execute $LOGIN_PRE_SUID_SCRIPT
32 //config: just prior to switching from root to logged-in user.
34 //config:config FEATURE_NOLOGIN
35 //config: bool "Support /etc/nologin"
37 //config: depends on LOGIN
39 //config: The file /etc/nologin is used by (some versions of) login(1).
40 //config: If it exists, non-root logins are prohibited.
42 //config:config FEATURE_SECURETTY
43 //config: bool "Support /etc/securetty"
45 //config: depends on LOGIN
47 //config: The file /etc/securetty is used by (some versions of) login(1).
48 //config: The file contains the device names of tty lines (one per line,
49 //config: without leading /dev/) on which root is allowed to login.
51 //applet:/* Needs to be run by root or be suid root - needs to change uid and gid: */
52 //applet:IF_LOGIN(APPLET(login, BB_DIR_BIN, BB_SUID_REQUIRE))
54 //kbuild:lib-$(CONFIG_LOGIN) += login.o
56 //usage:#define login_trivial_usage
57 //usage: "[-p] [-h HOST] [[-f] USER]"
58 //usage:#define login_full_usage "\n\n"
59 //usage: "Begin a new session on the system\n"
60 //usage: "\n -f Don't authenticate (user already authenticated)"
61 //usage: "\n -h HOST Host user came from (for network logins)"
62 //usage: "\n -p Preserve environment"
65 #include "common_bufsiz.h"
67 #include <sys/resource.h>
70 # include <selinux/selinux.h> /* for is_selinux_enabled() */
71 # include <selinux/get_context_list.h> /* for get_default_context() */
72 # /* from deprecated <selinux/flask.h>: */
73 # undef SECCLASS_CHR_FILE
74 # define SECCLASS_CHR_FILE 10
78 /* PAM may include <locale.h>. We may need to undefine bbox's stub define: */
80 /* For some obscure reason, PAM is not in pam/xxx, but in security/xxx.
81 * Apparently they like to confuse people. */
82 # include <security/pam_appl.h>
83 # include <security/pam_misc.h>
86 /* This supposedly can be used to avoid double password prompt,
87 * if used instead of standard misc_conv():
89 * "When we want to authenticate first with local method and then with tacacs for example,
90 * the password is asked for local method and if not good is asked a second time for tacacs.
91 * So if we want to authenticate a user with tacacs, and the user exists localy, the password is
92 * asked two times before authentication is accepted."
94 * However, code looks shaky. For example, why misc_conv() return value is ignored?
95 * Are msg[i] and resp[i] indexes handled correctly?
97 static char *passwd = NULL;
98 static int my_conv(int num_msg, const struct pam_message **msg,
99 struct pam_response **resp, void *data)
102 for (i = 0; i < num_msg; i++) {
103 switch (msg[i]->msg_style) {
104 case PAM_PROMPT_ECHO_OFF:
105 if (passwd == NULL) {
106 misc_conv(num_msg, msg, resp, data);
107 passwd = xstrdup(resp[i]->resp);
111 resp[0] = xzalloc(sizeof(struct pam_response));
112 resp[0]->resp = passwd;
114 resp[0]->resp_retcode = PAM_SUCCESS;
127 static const struct pam_conv conv = {
135 EMPTY_USERNAME_COUNT = 10,
136 /* Some users found 32 chars limit to be too low: */
142 struct termios tty_attrs;
144 #define G (*(struct globals*)bb_common_bufsiz1)
145 #define INIT_G() do { setup_common_bufsiz(); } while (0)
148 #if ENABLE_FEATURE_NOLOGIN
149 static void die_if_nologin(void)
155 fp = fopen_for_read("/etc/nologin");
156 if (!fp) /* assuming it does not exist */
159 while ((c = getc(fp)) != EOF) {
166 puts("\r\nSystem closed for routine maintenance\r");
170 /* Users say that they do need this prior to exit: */
171 tcdrain(STDOUT_FILENO);
175 # define die_if_nologin() ((void)0)
178 #if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
179 static int check_securetty(const char *short_tty)
181 char *buf = (char*)"/etc/securetty"; /* any non-NULL is ok */
182 parser_t *parser = config_open2("/etc/securetty", fopen_for_read);
183 while (config_read(parser, &buf, 1, 1, "# \t", PARSE_NORMAL)) {
184 if (strcmp(buf, short_tty) == 0)
188 config_close(parser);
189 /* buf != NULL here if config file was not found, empty
190 * or line was found which equals short_tty */
194 static ALWAYS_INLINE int check_securetty(const char *short_tty UNUSED_PARAM) { return 1; }
198 static void initselinux(char *username, char *full_tty,
199 security_context_t *user_sid)
201 security_context_t old_tty_sid, new_tty_sid;
203 if (!is_selinux_enabled())
206 if (get_default_context(username, NULL, user_sid)) {
207 bb_error_msg_and_die("can't get SID for %s", username);
209 if (getfilecon(full_tty, &old_tty_sid) < 0) {
210 bb_perror_msg_and_die("getfilecon(%s) failed", full_tty);
212 if (security_compute_relabel(*user_sid, old_tty_sid,
213 SECCLASS_CHR_FILE, &new_tty_sid) != 0) {
214 bb_perror_msg_and_die("security_change_sid(%s) failed", full_tty);
216 if (setfilecon(full_tty, new_tty_sid) != 0) {
217 bb_perror_msg_and_die("chsid(%s, %s) failed", full_tty, new_tty_sid);
222 #if ENABLE_LOGIN_SCRIPTS
223 static void run_login_script(struct passwd *pw, char *full_tty)
227 t_argv[0] = getenv("LOGIN_PRE_SUID_SCRIPT");
230 xsetenv("LOGIN_TTY", full_tty);
231 xsetenv("LOGIN_USER", pw->pw_name);
232 xsetenv("LOGIN_UID", utoa(pw->pw_uid));
233 xsetenv("LOGIN_GID", utoa(pw->pw_gid));
234 xsetenv("LOGIN_SHELL", pw->pw_shell);
235 spawn_and_wait(t_argv); /* NOMMU-friendly */
236 unsetenv("LOGIN_TTY");
237 unsetenv("LOGIN_USER");
238 unsetenv("LOGIN_UID");
239 unsetenv("LOGIN_GID");
240 unsetenv("LOGIN_SHELL");
244 void run_login_script(struct passwd *pw, char *full_tty);
247 #if ENABLE_LOGIN_SESSION_AS_CHILD && ENABLE_PAM
248 static void login_pam_end(pam_handle_t *pamh)
252 pamret = pam_setcred(pamh, PAM_DELETE_CRED);
253 if (pamret != PAM_SUCCESS) {
254 bb_error_msg("pam_%s failed: %s (%d)", "setcred",
255 pam_strerror(pamh, pamret), pamret);
257 pamret = pam_close_session(pamh, 0);
258 if (pamret != PAM_SUCCESS) {
259 bb_error_msg("pam_%s failed: %s (%d)", "close_session",
260 pam_strerror(pamh, pamret), pamret);
262 pamret = pam_end(pamh, pamret);
263 if (pamret != PAM_SUCCESS) {
264 bb_error_msg("pam_%s failed: %s (%d)", "end",
265 pam_strerror(pamh, pamret), pamret);
268 #endif /* ENABLE_PAM */
270 static void get_username_or_die(char *buf, int size_buf)
274 cntdown = EMPTY_USERNAME_COUNT;
276 print_login_prompt();
277 /* skip whitespace */
287 } while (isspace(c)); /* maybe isblank? */
290 if (!fgets(buf, size_buf-2, stdin))
292 if (!strchr(buf, '\n'))
294 while ((unsigned char)*buf > ' ')
299 static void motd(void)
303 fd = open(bb_path_motd_file, O_RDONLY);
306 bb_copyfd_eof(fd, STDOUT_FILENO);
311 static void alarm_handler(int sig UNUSED_PARAM)
313 /* This is the escape hatch! Poor serial line users and the like
314 * arrive here when their connection is broken.
315 * We don't want to block here */
316 ndelay_on(STDOUT_FILENO);
317 /* Test for correct attr restoring:
318 * run "getty 0 -" from a shell, enter bogus username, stop at
319 * password prompt, let it time out. Without the tcsetattr below,
320 * when you are back at shell prompt, echo will be still off.
322 tcsetattr_stdin_TCSANOW(&G.tty_attrs);
323 printf("\r\nLogin timed out after %u seconds\r\n", TIMEOUT);
325 /* unix API is brain damaged regarding O_NONBLOCK,
326 * we should undo it, or else we can affect other processes */
327 ndelay_off(STDOUT_FILENO);
331 int login_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
332 int login_main(int argc UNUSED_PARAM, char **argv)
335 LOGIN_OPT_f = (1<<0),
336 LOGIN_OPT_h = (1<<1),
337 LOGIN_OPT_p = (1<<2),
340 char username[USERNAME_SIZE];
345 char *opt_host = NULL;
346 char *opt_user = opt_user; /* for compiler */
349 IF_SELINUX(security_context_t user_sid = NULL;)
354 const char *failed_msg;
355 struct passwd pwdstruct;
359 #if ENABLE_LOGIN_SESSION_AS_CHILD
365 /* More of suid paranoia if called by non-root: */
366 /* Clear dangerous stuff, set PATH */
367 run_by_root = !sanitize_env_if_suid();
369 /* Mandatory paranoia for suid applet:
370 * ensure that fd# 0,1,2 are opened (at least to /dev/null)
371 * and any extra open fd's are closed.
372 * (The name of the function is misleading. Not daemonizing here.) */
373 bb_daemonize_or_rexec(DAEMON_ONLY_SANITIZE | DAEMON_CLOSE_EXTRA_FDS, NULL);
376 opt = getopt32(argv, "f:h:p", &opt_user, &opt_host);
377 if (opt & LOGIN_OPT_f) {
379 bb_error_msg_and_die("-f is for root only");
380 safe_strncpy(username, opt_user, sizeof(username));
383 if (argv[0]) /* user from command line (getty) */
384 safe_strncpy(username, argv[0], sizeof(username));
386 /* Save tty attributes - and by doing it, check that it's indeed a tty */
387 if (tcgetattr(STDIN_FILENO, &G.tty_attrs) < 0
388 || !isatty(STDOUT_FILENO)
389 /*|| !isatty(STDERR_FILENO) - no, guess some people might want to redirect this */
391 return EXIT_FAILURE; /* Must be a terminal */
394 /* We install timeout handler only _after_ we saved G.tty_attrs */
395 signal(SIGALRM, alarm_handler);
398 /* Find out and memorize our tty name */
399 full_tty = xmalloc_ttyname(STDIN_FILENO);
401 full_tty = xstrdup("UNKNOWN");
402 short_tty = skip_dev_pfx(full_tty);
405 fromhost = xasprintf(" on '%s' from '%s'", short_tty, opt_host);
407 fromhost = xasprintf(" on '%s'", short_tty);
410 /* Was breaking "login <username>" from shell command line: */
413 openlog(applet_name, LOG_PID | LOG_CONS, LOG_AUTH);
416 /* flush away any type-ahead (as getty does) */
417 tcflush(0, TCIFLUSH);
420 get_username_or_die(username, sizeof(username));
423 pamret = pam_start("login", username, &conv, &pamh);
424 if (pamret != PAM_SUCCESS) {
425 failed_msg = "start";
426 goto pam_auth_failed;
428 /* set TTY (so things like securetty work) */
429 pamret = pam_set_item(pamh, PAM_TTY, short_tty);
430 if (pamret != PAM_SUCCESS) {
431 failed_msg = "set_item(TTY)";
432 goto pam_auth_failed;
436 pamret = pam_set_item(pamh, PAM_RHOST, opt_host);
437 if (pamret != PAM_SUCCESS) {
438 failed_msg = "set_item(RHOST)";
439 goto pam_auth_failed;
442 if (!(opt & LOGIN_OPT_f)) {
443 pamret = pam_authenticate(pamh, 0);
444 if (pamret != PAM_SUCCESS) {
445 failed_msg = "authenticate";
446 goto pam_auth_failed;
447 /* TODO: or just "goto auth_failed"
448 * since user seems to enter wrong password
449 * (in this case pamret == 7)
453 /* check that the account is healthy */
454 pamret = pam_acct_mgmt(pamh, 0);
455 if (pamret != PAM_SUCCESS) {
456 failed_msg = "acct_mgmt";
457 goto pam_auth_failed;
461 /* gcc: "dereferencing type-punned pointer breaks aliasing rules..."
462 * thus we cast to (void*) */
463 if (pam_get_item(pamh, PAM_USER, (void*)&pamuser) != PAM_SUCCESS) {
464 failed_msg = "get_item(USER)";
465 goto pam_auth_failed;
467 if (!pamuser || !pamuser[0])
469 safe_strncpy(username, pamuser, sizeof(username));
470 /* Don't use "pw = getpwnam(username);",
471 * PAM is said to be capable of destroying static storage
472 * used by getpwnam(). We are using safe(r) function */
474 getpwnam_r(username, &pwdstruct, pwdbuf, sizeof(pwdbuf), &pw);
477 pamret = pam_open_session(pamh, 0);
478 if (pamret != PAM_SUCCESS) {
479 failed_msg = "open_session";
480 goto pam_auth_failed;
482 pamret = pam_setcred(pamh, PAM_ESTABLISH_CRED);
483 if (pamret != PAM_SUCCESS) {
484 failed_msg = "setcred";
485 goto pam_auth_failed;
487 break; /* success, continue login process */
490 /* syslog, because we don't want potential attacker
491 * to know _why_ login failed */
492 syslog(LOG_WARNING, "pam_%s call failed: %s (%d)", failed_msg,
493 pam_strerror(pamh, pamret), pamret);
494 safe_strncpy(username, "UNKNOWN", sizeof(username));
496 pw = getpwnam(username);
498 strcpy(username, "UNKNOWN");
502 if (pw->pw_passwd[0] == '!' || pw->pw_passwd[0] == '*')
505 if (opt & LOGIN_OPT_f)
506 break; /* -f USER: success without asking passwd */
508 if (pw->pw_uid == 0 && !check_securetty(short_tty))
511 /* Don't check the password if password entry is empty (!) */
512 if (!pw->pw_passwd[0])
515 /* Password reading and authorization takes place here.
516 * Note that reads (in no-echo mode) trash tty attributes.
517 * If we get interrupted by SIGALRM, we need to restore attrs.
519 if (ask_and_check_password(pw) > 0)
521 #endif /* ENABLE_PAM */
524 bb_do_delay(LOGIN_FAIL_DELAY);
525 /* TODO: doesn't sound like correct English phrase to me */
526 puts("Login incorrect");
528 syslog(LOG_WARNING, "invalid password for '%s'%s",
531 if (ENABLE_FEATURE_CLEAN_UP)
540 /* We can ignore /etc/nologin if we are logging in as root,
541 * it doesn't matter whether we are run by root or not */
545 #if ENABLE_LOGIN_SESSION_AS_CHILD
547 if (child_pid != 0) {
549 bb_perror_msg("vfork");
551 if (safe_waitpid(child_pid, NULL, 0) == -1)
552 bb_perror_msg("waitpid");
553 update_utmp_DEAD_PROCESS(child_pid);
555 IF_PAM(login_pam_end(pamh);)
560 IF_SELINUX(initselinux(username, full_tty, &user_sid);)
562 /* Try these, but don't complain if they fail.
563 * _f_chown is safe wrt race t=ttyname(0);...;chown(t); */
564 fchown(0, pw->pw_uid, pw->pw_gid);
567 update_utmp(getpid(), USER_PROCESS, short_tty, username, run_by_root ? opt_host : NULL);
569 /* We trust environment only if we run by root */
570 if (ENABLE_LOGIN_SCRIPTS && run_by_root)
571 run_login_script(pw, full_tty);
574 setup_environment(pw->pw_shell,
575 (!(opt & LOGIN_OPT_p) * SETUP_ENV_CLEARENV) + SETUP_ENV_CHANGEENV,
579 /* Modules such as pam_env will setup the PAM environment,
580 * which should be copied into the new environment. */
581 pamenv = pam_getenvlist(pamh);
582 if (pamenv) while (*pamenv) {
588 if (access(".hushlogin", F_OK) != 0)
592 syslog(LOG_INFO, "root login%s", fromhost);
594 if (ENABLE_FEATURE_CLEAN_UP)
597 /* well, a simple setexeccon() here would do the job as well,
598 * but let's play the game for now */
599 IF_SELINUX(set_current_security_context(user_sid);)
601 // util-linux login also does:
602 // /* start new session */
604 // /* TIOCSCTTY: steal tty from other process group */
605 // if (ioctl(0, TIOCSCTTY, 1)) error_msg...
606 // BBox login used to do this (see above):
608 // If this stuff is really needed, add it and explain why!
610 /* Set signals to defaults */
611 /* Non-ignored signals revert to SIG_DFL on exec anyway */
612 /*signal(SIGALRM, SIG_DFL);*/
614 /* Is this correct? This way user can ctrl-c out of /etc/profile,
615 * potentially creating security breach (tested with bash 3.0).
616 * But without this, bash 3.0 will not enable ctrl-c either.
617 * Maybe bash is buggy?
618 * Need to find out what standards say about /bin/login -
619 * should we leave SIGINT etc enabled or disabled? */
620 signal(SIGINT, SIG_DFL);
622 /* Exec login shell with no additional parameters */
623 run_shell(pw->pw_shell, 1, NULL);
625 /* return EXIT_FAILURE; - not reached */