1 /* vi: set sw=4 ts=4: */
2 /* agetty.c - another getty program for Linux. By W. Z. Venema 1989
3 * Ported to Linux by Peter Orbaek <poe@daimi.aau.dk>
4 * This program is freely distributable. The entire man-page used to
5 * be here. Now read the real man-page agetty.8 instead.
7 * option added by Eric Rasmussen <ear@usfirst.org> - 12/28/95
9 * 1999-02-22 Arkadiusz Mickiewicz <misiek@misiek.eu.org>
10 * - added Native Language Support
12 * 1999-05-05 Thorsten Kranzkowski <dl8bcu@gmx.net>
13 * - enable hardware flow control before displaying /etc/issue
15 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
21 #if ENABLE_FEATURE_UTMP
22 #include <utmp.h> /* updwtmp() */
30 * Some heuristics to find out what environment we are in: if it is not
31 * System V, assume it is SunOS 4.
33 #ifdef LOGIN_PROCESS /* defined in System V utmp.h */
34 #include <sys/utsname.h>
35 #else /* if !sysV style, wtmp/utmp code is off */
36 #undef ENABLE_FEATURE_UTMP
37 #undef ENABLE_FEATURE_WTMP
38 #define ENABLE_FEATURE_UTMP 0
39 #define ENABLE_FEATURE_WTMP 0
40 #endif /* LOGIN_PROCESS */
43 * Things you may want to modify.
45 * You may disagree with the default line-editing etc. characters defined
46 * below. Note, however, that DEL cannot be used for interrupt generation
47 * and for line editing at the same time.
50 /* I doubt there are systems which still need this */
52 #undef ANCIENT_BS_KILL_CHARS
54 #define _PATH_LOGIN "/bin/login"
56 /* If ISSUE is not defined, getty will never display the contents of the
57 * /etc/issue file. You will not want to spit out large "issue" files at the
60 #define ISSUE "/etc/issue" /* displayed before the login prompt */
62 /* Some shorthands for control characters. */
63 #define CTL(x) ((x) ^ 0100) /* Assumes ASCII dialect */
64 #define CR CTL('M') /* carriage return */
65 #define NL CTL('J') /* line feed */
66 #define BS CTL('H') /* back space */
67 #define DEL CTL('?') /* delete */
69 /* Defaults for line-editing etc. characters; you may want to change this. */
70 #define DEF_ERASE DEL /* default erase character */
71 #define DEF_INTR CTL('C') /* default interrupt character */
72 #define DEF_QUIT CTL('\\') /* default quit char */
73 #define DEF_KILL CTL('U') /* default kill char */
74 #define DEF_EOF CTL('D') /* default EOF char */
76 #define DEF_SWITCH 0 /* default switch char */
79 * When multiple baud rates are specified on the command line, the first one
80 * we will try is the first one specified.
82 #define MAX_SPEED 10 /* max. nr. of baud rates */
84 /* Storage for command-line options. */
86 int flags; /* toggle switches, see below */
87 unsigned timeout; /* time-out period */
88 const char *login; /* login program */
89 const char *tty; /* name of tty */
90 const char *initstring; /* modem init string */
91 const char *issue; /* alternative issue file */
92 int numspeed; /* number of baud rates to try */
93 int speeds[MAX_SPEED]; /* baud rates to be tried */
96 /* Storage for things detected while the login name was read. */
98 unsigned char erase; /* erase character */
99 unsigned char kill; /* kill character */
100 unsigned char eol; /* end-of-line character */
101 unsigned char parity; /* what parity did we see */
102 /* (parity & 1): saw odd parity char with 7th bit set */
103 /* (parity & 2): saw even parity char with 7th bit set */
104 /* parity == 0: probably 7-bit, space parity? */
105 /* parity == 1: probably 7-bit, odd parity? */
106 /* parity == 2: probably 7-bit, even parity? */
107 /* parity == 3: definitely 8 bit, no parity! */
108 /* Hmm... with any value of "parity" 8 bit, no parity is possible */
109 #ifdef HANDLE_ALLCAPS
110 unsigned char capslock; /* upper case without lower case */
115 /* Initial values for the above. */
116 static const struct chardata init_chardata = {
117 DEF_ERASE, /* default erase character */
118 DEF_KILL, /* default kill character */
119 13, /* default eol char */
120 0, /* space parity */
121 #ifdef HANDLE_ALLCAPS
126 static const char opt_string[] ALIGN1 = "I:LH:f:hil:mt:wn";
127 #define F_INITSTRING (1 << 0) /* -I initstring is set */
128 #define F_LOCAL (1 << 1) /* -L force local */
129 #define F_FAKEHOST (1 << 2) /* -H fake hostname */
130 #define F_CUSTISSUE (1 << 3) /* -f give alternative issue file */
131 #define F_RTSCTS (1 << 4) /* -h enable RTS/CTS flow control */
132 #define F_ISSUE (1 << 5) /* -i display /etc/issue */
133 #define F_LOGIN (1 << 6) /* -l non-default login program */
134 #define F_PARSE (1 << 7) /* -m process modem status messages */
135 #define F_TIMEOUT (1 << 8) /* -t time out */
136 #define F_WAITCRLF (1 << 9) /* -w wait for CR or LF */
137 #define F_NOPROMPT (1 << 10) /* -n don't ask for login name */
140 #define line_buf bb_common_bufsiz1
142 /* The following is used for understandable diagnostics. */
145 #define DEBUGTERM "/dev/ttyp0"
146 #define debug(...) do { fprintf(dbf, __VA_ARGS__); fflush(dbf); } while (0)
148 #define debug(...) ((void)0)
152 /* bcode - convert speed string to speed code; return <= 0 on failure */
153 static int bcode(const char *s)
155 int value = bb_strtou(s, NULL, 10); /* yes, int is intended! */
156 if (value < 0) /* bad terminating char, overflow, etc */
158 return tty_value_to_baud(value);
161 /* parse_speeds - parse alternate baud rates */
162 static void parse_speeds(struct options *op, char *arg)
166 /* NB: at least one iteration is always done */
167 debug("entered parse_speeds\n");
168 while ((cp = strsep(&arg, ",")) != NULL) {
169 op->speeds[op->numspeed] = bcode(cp);
170 if (op->speeds[op->numspeed] < 0)
171 bb_error_msg_and_die("bad speed: %s", cp);
172 /* note: arg "0" turns into speed B0 */
174 if (op->numspeed > MAX_SPEED)
175 bb_error_msg_and_die("too many alternate speeds");
177 debug("exiting parse_speeds\n");
180 /* parse_args - parse command-line arguments */
181 static void parse_args(char **argv, struct options *op, char **fakehost_p)
185 opt_complementary = "-2:t+"; /* at least 2 args; -t N */
186 op->flags = getopt32(argv, opt_string,
187 &(op->initstring), fakehost_p, &(op->issue),
188 &(op->login), &op->timeout);
190 if (op->flags & F_INITSTRING) {
191 const char *p = op->initstring;
194 op->initstring = q = xstrdup(p);
195 /* copy optarg into op->initstring decoding \ddd
196 octal codes into chars */
200 *q++ = bb_process_escape_sequence(&p);
207 op->flags ^= F_ISSUE; /* invert flag "show /etc/issue" */
208 debug("after getopt\n");
210 /* we loosen up a bit and accept both "baudrate tty" and "tty baudrate" */
211 op->tty = argv[0]; /* tty name */
212 ts = argv[1]; /* baud rate(s) */
213 if (isdigit(argv[0][0])) {
214 /* a number first, assume it's a speed (BSD style) */
215 op->tty = ts; /* tty name is in argv[1] */
216 ts = argv[0]; /* baud rate(s) */
218 parse_speeds(op, ts);
220 // TODO: if applet_name is set to "getty: TTY", bb_error_msg's get simpler!
224 xsetenv("TERM", argv[2]);
226 debug("exiting parse_args\n");
229 /* open_tty - set up tty as standard { input, output, error } */
230 static void open_tty(const char *tty)
232 /* Set up new standard input, unless we are given an already opened port. */
233 if (NOT_LONE_DASH(tty)) {
238 /* Sanity checks... */
239 // cur_dir_fd = xopen(".", O_DIRECTORY | O_NONBLOCK);
242 // if (!S_ISCHR(st.st_mode))
243 // bb_error_msg_and_die("%s: not a character device", tty);
246 tty = xasprintf("/dev/%s", tty); /* will leak it */
248 /* Open the tty as standard input. */
251 /*fd =*/ xopen(tty, O_RDWR | O_NONBLOCK); /* uses fd 0 */
253 // /* Restore current directory */
254 // fchdir(cur_dir_fd);
256 /* Open the tty as standard input, continued */
258 // /* fd is >= cur_dir_fd, and cur_dir_fd gets closed too here: */
262 /* Set proper protections and ownership. */
263 fchown(0, 0, 0); /* 0:0 */
264 fchmod(0, 0620); /* crw--w---- */
267 * Standard input should already be connected to an open port. Make
268 * sure it is open for read/write.
270 if ((fcntl(0, F_GETFL) & O_RDWR) != O_RDWR)
271 bb_error_msg_and_die("stdin is not open for read/write");
275 /* termios_init - initialize termios settings */
276 static void termios_init(struct termios *tp, int speed, struct options *op)
278 speed_t ispeed, ospeed;
280 * Initial termios settings: 8-bit characters, raw-mode, blocking i/o.
281 * Special characters are set after we have read the login name; all
282 * reads will be done in raw mode anyway. Errors will be dealt with
286 /* flush input and output queues, important for modems! */
287 ioctl(0, TCFLSH, TCIOFLUSH); /* tcflush(0, TCIOFLUSH)? - same */
289 ispeed = ospeed = speed;
291 /* Speed was specified as "0" on command line.
292 * Just leave it unchanged */
293 ispeed = cfgetispeed(tp);
294 ospeed = cfgetospeed(tp);
296 tp->c_cflag = CS8 | HUPCL | CREAD;
297 if (op->flags & F_LOCAL)
298 tp->c_cflag |= CLOCAL;
299 cfsetispeed(tp, ispeed);
300 cfsetospeed(tp, ospeed);
302 tp->c_iflag = tp->c_lflag = tp->c_line = 0;
303 tp->c_oflag = OPOST | ONLCR;
307 /* Optionally enable hardware flow control */
309 if (op->flags & F_RTSCTS)
310 tp->c_cflag |= CRTSCTS;
313 tcsetattr_stdin_TCSANOW(tp);
315 debug("term_io 2\n");
318 /* auto_baud - extract baud rate from modem status message */
319 static void auto_baud(char *buf, unsigned size_buf, struct termios *tp)
328 * This works only if the modem produces its status code AFTER raising
329 * the DCD line, and if the computer is fast enough to set the proper
330 * baud rate before the message has gone by. We expect a message of the
333 * <junk><number><junk>
335 * The number is interpreted as the baud rate of the incoming call. If the
336 * modem does not tell us the baud rate within one second, we will keep
337 * using the current baud rate. It is advisable to enable BREAK
338 * processing (comma-separated list of baud rates) if the processing of
339 * modem status messages is enabled.
343 * Use 7-bit characters, don't block if input queue is empty. Errors will
344 * be dealt with later on.
347 tp->c_iflag |= ISTRIP; /* enable 8th-bit stripping */
348 vmin = tp->c_cc[VMIN];
349 tp->c_cc[VMIN] = 0; /* don't block if queue empty */
350 tcsetattr_stdin_TCSANOW(tp);
353 * Wait for a while, then read everything the modem has said so far and
354 * try to extract the speed of the dial-in call.
357 nread = safe_read(STDIN_FILENO, buf, size_buf - 1);
360 for (bp = buf; bp < buf + nread; bp++) {
364 tp->c_cflag &= ~CBAUD;
365 tp->c_cflag |= speed;
372 /* Restore terminal settings. Errors will be dealt with later on. */
374 tp->c_cc[VMIN] = vmin;
375 tcsetattr_stdin_TCSANOW(tp);
378 /* do_prompt - show login prompt, optionally preceded by /etc/issue contents */
379 static void do_prompt(struct options *op)
382 print_login_issue(op->issue, op->tty);
384 print_login_prompt();
387 #ifdef HANDLE_ALLCAPS
388 /* all_is_upcase - string contains upper case without lower case */
389 /* returns 1 if true, 0 if false */
390 static int all_is_upcase(const char *s)
399 /* get_logname - get user name, establish parity, speed, erase, kill, eol;
400 * return NULL on BREAK, logname on success */
401 static char *get_logname(char *logname, unsigned size_logname,
402 struct options *op, struct chardata *cp)
405 char c; /* input character, full eight bits */
406 char ascval; /* low 7 bits of input character */
407 int bits; /* # of "1" bits per character */
408 int mask; /* mask with 1 bit up */
409 static const char erase[][3] = {/* backspace-space-backspace */
410 "\010\040\010", /* space parity */
411 "\010\040\010", /* odd parity */
412 "\210\240\210", /* even parity */
413 "\010\040\010", /* 8 bit no parity */
416 /* NB: *cp is pre-initialized with init_chardata */
418 /* Flush pending input (esp. after parsing or switching the baud rate). */
420 ioctl(0, TCFLSH, TCIFLUSH); /* tcflush(0, TCIOFLUSH)? - same */
422 /* Prompt for and read a login name. */
424 while (!logname[0]) {
425 /* Write issue file and prompt, with "parity" bit == 0. */
428 /* Read name, watch for break, parity, erase, kill, end-of-line. */
431 while (cp->eol == '\0') {
433 /* Do not report trivial EINTR/EIO errors. */
434 if (read(STDIN_FILENO, &c, 1) < 1) {
435 if (errno == EINTR || errno == EIO)
437 bb_perror_msg_and_die("%s: read", op->tty);
440 /* BREAK. If we have speeds to try,
441 * return NULL (will switch speeds and return here) */
442 if (c == '\0' && op->numspeed > 1)
445 /* Do parity bit handling. */
446 if (!(op->flags & F_LOCAL) && (c & 0x80)) { /* "parity" bit on? */
449 while (mask & 0x7f) {
451 bits++; /* count "1" bits */
454 /* ... |= 2 - even, 1 - odd */
455 cp->parity |= 2 - (bits & 1);
458 /* Do erase, kill and end-of-line processing. */
463 *bp = '\0'; /* terminate logname */
464 cp->eol = ascval; /* set end-of-line char */
468 #ifdef ANCIENT_BS_KILL_CHARS
471 cp->erase = ascval; /* set erase character */
473 full_write(STDOUT_FILENO, erase[cp->parity], 3);
478 #ifdef ANCIENT_BS_KILL_CHARS
481 cp->kill = ascval; /* set kill character */
482 while (bp > logname) {
483 full_write(STDOUT_FILENO, erase[cp->parity], 3);
490 if (!isprint(ascval)) {
491 /* ignore garbage characters */
492 } else if ((int)(bp - logname) >= size_logname - 1) {
493 bb_error_msg_and_die("%s: input overrun", op->tty);
495 full_write(STDOUT_FILENO, &c, 1); /* echo the character */
496 *bp++ = ascval; /* and store it */
502 /* Handle names with upper case and no lower case. */
504 #ifdef HANDLE_ALLCAPS
505 cp->capslock = all_is_upcase(logname);
507 for (bp = logname; *bp; bp++)
509 *bp = tolower(*bp); /* map name to lower case */
515 /* termios_final - set the final tty mode bits */
516 static void termios_final(struct options *op, struct termios *tp, struct chardata *cp)
518 /* General terminal-independent stuff. */
519 tp->c_iflag |= IXON | IXOFF; /* 2-way flow control */
520 tp->c_lflag |= ICANON | ISIG | ECHO | ECHOE | ECHOK | ECHOKE;
521 /* no longer| ECHOCTL | ECHOPRT */
522 tp->c_oflag |= OPOST;
523 /* tp->c_cflag = 0; */
524 tp->c_cc[VINTR] = DEF_INTR; /* default interrupt */
525 tp->c_cc[VQUIT] = DEF_QUIT; /* default quit */
526 tp->c_cc[VEOF] = DEF_EOF; /* default EOF character */
527 tp->c_cc[VEOL] = DEF_EOL;
528 tp->c_cc[VSWTC] = DEF_SWITCH; /* default switch character */
530 /* Account for special characters seen in input. */
532 tp->c_iflag |= ICRNL; /* map CR in input to NL */
533 tp->c_oflag |= ONLCR; /* map NL in output to CR-NL */
535 tp->c_cc[VERASE] = cp->erase; /* set erase character */
536 tp->c_cc[VKILL] = cp->kill; /* set kill character */
538 /* Account for the presence or absence of parity bits in input. */
539 switch (cp->parity) {
540 case 0: /* space (always 0) parity */
541 // I bet most people go here - they use only 7-bit chars in usernames....
543 case 1: /* odd parity */
544 tp->c_cflag |= PARODD;
546 case 2: /* even parity */
547 tp->c_cflag |= PARENB;
548 tp->c_iflag |= INPCK | ISTRIP;
550 case (1 | 2): /* no parity bit */
551 tp->c_cflag &= ~CSIZE;
553 // FIXME: wtf? case 3: we saw both even and odd 8-bit bytes -
554 // it's probably some umlauts etc, but definitely NOT 7-bit!!!
555 // Entire parity detection madness here just begs for deletion...
559 /* Account for upper case without lower case. */
560 #ifdef HANDLE_ALLCAPS
562 tp->c_iflag |= IUCLC;
563 tp->c_lflag |= XCASE;
564 tp->c_oflag |= OLCUC;
567 /* Optionally enable hardware flow control */
569 if (op->flags & F_RTSCTS)
570 tp->c_cflag |= CRTSCTS;
573 /* Finally, make the new settings effective */
574 /* It's tcsetattr_stdin_TCSANOW() + error check */
575 ioctl_or_perror_and_die(0, TCSETS, tp, "%s: TCSETS", op->tty);
578 #if ENABLE_FEATURE_UTMP
579 static void touch(const char *filename)
581 if (access(filename, R_OK | W_OK) == -1)
582 close(open(filename, O_WRONLY | O_CREAT, 0664));
585 /* update_utmp - update our utmp entry */
586 static void update_utmp(const char *line, char *fakehost)
590 int mypid = getpid();
592 /* In case we won't find an entry below... */
593 memset(&ut, 0, sizeof(ut));
594 safe_strncpy(ut.ut_id, line + 3, sizeof(ut.ut_id));
597 * The utmp file holds miscellaneous information about things started by
598 * /sbin/init and other system-related events. Our purpose is to update
599 * the utmp entry for the current process, in particular the process type
600 * and the tty line we are listening to. Return successfully only if the
601 * utmp file can be opened for update, and if we are able to find our
602 * entry in the utmp file.
606 utmpname(_PATH_UTMP);
608 while ((utp = getutent()) != NULL) {
609 if (utp->ut_type == INIT_PROCESS && utp->ut_pid == mypid) {
610 memcpy(&ut, utp, sizeof(ut));
615 strcpy(ut.ut_user, "LOGIN");
616 safe_strncpy(ut.ut_line, line, sizeof(ut.ut_line));
618 safe_strncpy(ut.ut_host, fakehost, sizeof(ut.ut_host));
619 ut.ut_tv.tv_sec = time(NULL);
620 ut.ut_type = LOGIN_PROCESS;
626 #if ENABLE_FEATURE_WTMP
627 touch(bb_path_wtmp_file);
628 updwtmp(bb_path_wtmp_file, &ut);
631 #endif /* CONFIG_FEATURE_UTMP */
633 int getty_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
634 int getty_main(int argc UNUSED_PARAM, char **argv)
637 char *fakehost = NULL; /* Fake hostname for ut_host */
638 char *logname; /* login name, given to /bin/login */
639 /* Merging these into "struct local" may _seem_ to reduce
640 * parameter passing, but today's gcc will inline
641 * statics which are called once anyway, so don't do that */
642 struct chardata chardata; /* set by get_logname() */
643 struct termios termios; /* terminal mode bits */
644 struct options options;
646 chardata = init_chardata;
648 memset(&options, 0, sizeof(options));
649 options.login = _PATH_LOGIN; /* default login program */
650 options.tty = "tty1"; /* default tty line */
651 options.initstring = ""; /* modem init string */
653 options.issue = ISSUE; /* default issue file */
656 /* Parse command-line arguments. */
657 parse_args(argv, &options, &fakehost);
659 logmode = LOGMODE_NONE;
661 /* Create new session, lose controlling tty, if any */
662 /* docs/ctty.htm says:
663 * "This is allowed only when the current process
664 * is not a process group leader" - is this a problem? */
666 /* close stdio, and stray descriptors, just in case */
667 n = xopen(bb_dev_null, O_RDWR);
668 /* dup2(n, 0); - no, we need to handle "getty - 9600" too */
674 /* Logging. We want special flavor of error_msg_and_die */
677 /* most likely will internally use fd #3 in CLOEXEC mode: */
678 openlog(applet_name, LOG_PID, LOG_AUTH);
679 logmode = LOGMODE_BOTH;
682 dbf = xfopen_for_write(DEBUGTERM);
683 for (n = 1; argv[n]; n++) {
689 /* Open the tty as standard input, if it is not "-" */
690 /* If it's not "-" and not taken yet, it will become our ctty */
691 debug("calling open_tty\n");
692 open_tty(options.tty);
699 * The following ioctl will fail if stdin is not a tty, but also when
700 * there is noise on the modem control lines. In the latter case, the
701 * common course of action is (1) fix your cables (2) give the modem more
702 * time to properly reset after hanging up. SunOS users can achieve (2)
703 * by patching the SunOS kernel variable "zsadtrlow" to a larger value;
704 * 5 seconds seems to be a good value.
706 /* tcgetattr() + error check */
707 ioctl_or_perror_and_die(0, TCGETS, &termios, "%s: TCGETS", options.tty);
710 // FIXME: do we need this? Otherwise "-" case seems to be broken...
711 // /* Forcibly make fd 0 our controlling tty, even if another session
712 // * has it as a ctty. (Another session loses ctty). */
713 // ioctl(0, TIOCSCTTY, (void*)1);
714 /* Make ourself a foreground process group within our session */
715 tcsetpgrp(0, getpid());
718 #if ENABLE_FEATURE_UTMP
719 /* Update the utmp file. This tty is ours now! */
720 update_utmp(options.tty, fakehost);
723 /* Initialize the termios settings (raw mode, eight-bit, blocking i/o). */
724 debug("calling termios_init\n");
725 termios_init(&termios, options.speeds[0], &options);
727 /* Write the modem init string and DON'T flush the buffers */
728 if (options.flags & F_INITSTRING) {
729 debug("writing init string\n");
730 /* todo: use xwrite_str? */
731 full_write(STDOUT_FILENO, options.initstring, strlen(options.initstring));
734 /* Optionally detect the baud rate from the modem status message */
735 debug("before autobaud\n");
736 if (options.flags & F_PARSE)
737 auto_baud(line_buf, sizeof(line_buf), &termios);
739 /* Set the optional timer */
740 alarm(options.timeout); /* if 0, alarm is not set */
742 /* Optionally wait for CR or LF before writing /etc/issue */
743 if (options.flags & F_WAITCRLF) {
746 debug("waiting for cr-lf\n");
747 while (safe_read(STDIN_FILENO, &ch, 1) == 1) {
748 debug("read %x\n", (unsigned char)ch);
749 ch &= 0x7f; /* strip "parity bit" */
750 if (ch == '\n' || ch == '\r')
756 if (!(options.flags & F_NOPROMPT)) {
757 /* NB:termios_init already set line speed
758 * to options.speeds[0] */
762 /* Read the login name. */
763 debug("reading login name\n");
764 logname = get_logname(line_buf, sizeof(line_buf),
765 &options, &chardata);
768 /* we are here only if options.numspeed > 1 */
769 baud_index = (baud_index + 1) % options.numspeed;
770 cfsetispeed(&termios, options.speeds[baud_index]);
771 cfsetospeed(&termios, options.speeds[baud_index]);
772 tcsetattr_stdin_TCSANOW(&termios);
779 /* Finalize the termios settings. */
780 termios_final(&options, &termios, &chardata);
782 /* Now the newline character should be properly written. */
783 full_write(STDOUT_FILENO, "\n", 1);
785 /* Let the login program take care of password validation. */
786 /* We use PATH because we trust that root doesn't set "bad" PATH,
787 * and getty is not suid-root applet. */
788 /* With -n, logname == NULL, and login will ask for username instead */
789 BB_EXECLP(options.login, options.login, "--", logname, NULL);
790 bb_error_msg_and_die("%s: can't exec %s", options.tty, options.login);