2 * Copyright (c) 2000 Andre Lucas. All rights reserved.
3 * Portions copyright (c) 1998 Todd C. Miller
4 * Portions copyright (c) 1996 Jason Downs
5 * Portions copyright (c) 1996 Theo de Raadt
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * The btmp logging code is derived from login.c from util-linux and is under
30 * the the following license:
32 * Copyright (c) 1980, 1987, 1988 The Regents of the University of California.
33 * All rights reserved.
35 * Redistribution and use in source and binary forms are permitted
36 * provided that the above copyright notice and this paragraph are
37 * duplicated in all such forms and that any documentation,
38 * advertising materials, and other materials related to such
39 * distribution and use acknowledge that the software was developed
40 * by the University of California, Berkeley. The name of the
41 * University may not be used to endorse or promote products derived
42 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
44 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
45 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
50 ** loginrec.c: platform-independent login recording and lastlog retrieval
54 * The new login code explained
55 * ============================
57 * This code attempts to provide a common interface to login recording
58 * (utmp and friends) and last login time retrieval.
60 * Its primary means of achieving this is to use 'struct logininfo', a
61 * union of all the useful fields in the various different types of
62 * system login record structures one finds on UNIX variants.
64 * We depend on autoconf to define which recording methods are to be
65 * used, and which fields are contained in the relevant data structures
66 * on the local system. Many C preprocessor symbols affect which code
69 * The code is designed to make it easy to modify a particular
70 * recording method, without affecting other methods nor requiring so
71 * many nested conditional compilation blocks as were commonplace in
74 * For login recording, we try to use the local system's libraries as
75 * these are clearly most likely to work correctly. For utmp systems
76 * this usually means login() and logout() or setutent() etc., probably
77 * in libutil, along with logwtmp() etc. On these systems, we fall back
78 * to writing the files directly if we have to, though this method
79 * requires very thorough testing so we do not corrupt local auditing
80 * information. These files and their access methods are very system
83 * For utmpx systems, the corresponding library functions are
84 * setutxent() etc. To the author's knowledge, all utmpx systems have
85 * these library functions and so no direct write is attempted. If such
86 * a system exists and needs support, direct analogues of the [uw]tmp
87 * code should suffice.
89 * Retrieving the time of last login ('lastlog') is in some ways even
90 * more problemmatic than login recording. Some systems provide a
91 * simple table of all users which we seek based on uid and retrieve a
92 * relatively standard structure. Others record the same information in
93 * a directory with a separate file, and others don't record the
94 * information separately at all. For systems in the latter category,
95 * we look backwards in the wtmp or wtmpx file for the last login entry
96 * for our user. Naturally this is slower and on busy systems could
97 * incur a significant performance penalty.
99 * Calling the new code
100 * --------------------
102 * In OpenSSH all login recording and retrieval is performed in
103 * login.c. Here you'll find working examples. Also, in the logintest.c
104 * program there are more examples.
106 * Internal handler calling method
107 * -------------------------------
109 * When a call is made to login_login() or login_logout(), both
110 * routines set a struct logininfo flag defining which action (log in,
111 * or log out) is to be taken. They both then call login_write(), which
112 * calls whichever of the many structure-specific handlers autoconf
113 * selects for the local system.
115 * The handlers themselves handle system data structure specifics. Both
116 * struct utmp and struct utmpx have utility functions (see
117 * construct_utmp*()) to try to make it simpler to add extra systems
118 * that introduce new features to either structure.
120 * While it may seem terribly wasteful to replicate so much similar
121 * code for each method, experience has shown that maintaining code to
122 * write both struct utmp and utmpx in one function, whilst maintaining
123 * support for all systems whether they have library support or not, is
124 * a difficult and time-consuming task.
126 * Lastlog support proceeds similarly. Functions login_get_lastlog()
127 * (and its OpenSSH-tuned friend login_get_lastlog_time()) call
128 * getlast_entry(), which tries one of three methods to find the last
129 * login time. It uses local system lastlog support if it can,
130 * otherwise it tries wtmp or wtmpx before giving up and returning 0,
136 * In many cases it's possible to tweak autoconf to select the correct
137 * methods for a particular platform, either by improving the detection
138 * code (best), or by presetting DISABLE_<method> or CONF_<method>_FILE
139 * symbols for the platform.
141 * Use logintest to check which symbols are defined before modifying
142 * configure.ac and loginrec.c. (You have to build logintest yourself
143 * with 'make logintest' as it's not built by default.)
145 * Otherwise, patches to the specific method(s) are very helpful!
148 #include "includes.h"
152 #include "loginrec.h"
154 #include "atomicio.h"
156 #include "canohost.h"
162 #ifdef HAVE_LIBUTIL_H
163 # include <libutil.h>
169 ** prototypes for helper functions in this file
173 void set_utmp_time(struct logininfo *li, struct utmp *ut);
174 void construct_utmp(struct logininfo *li, struct utmp *ut);
178 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
179 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
182 int utmp_write_entry(struct logininfo *li);
183 int utmpx_write_entry(struct logininfo *li);
184 int wtmp_write_entry(struct logininfo *li);
185 int wtmpx_write_entry(struct logininfo *li);
186 int lastlog_write_entry(struct logininfo *li);
187 int syslogin_write_entry(struct logininfo *li);
189 int getlast_entry(struct logininfo *li);
190 int lastlog_get_entry(struct logininfo *li);
191 int wtmp_get_entry(struct logininfo *li);
192 int wtmpx_get_entry(struct logininfo *li);
194 /* pick the shortest string */
195 #define MIN_SIZEOF(s1,s2) (sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2))
198 ** platform-independent login functions
202 * login_login(struct logininfo *) - Record a login
204 * Call with a pointer to a struct logininfo initialised with
205 * login_init_entry() or login_alloc_entry()
209 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
212 login_login(struct logininfo *li)
214 li->type = LTYPE_LOGIN;
215 return (login_write(li));
220 * login_logout(struct logininfo *) - Record a logout
222 * Call as with login_login()
226 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
229 login_logout(struct logininfo *li)
231 li->type = LTYPE_LOGOUT;
232 return (login_write(li));
236 * login_get_lastlog_time(int) - Retrieve the last login time
238 * Retrieve the last login time for the given uid. Will try to use the
239 * system lastlog facilities if they are available, but will fall back
240 * to looking in wtmp/wtmpx if necessary
243 * 0 on failure, or if user has never logged in
244 * Time in seconds from the epoch if successful
246 * Useful preprocessor symbols:
247 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
249 * USE_LASTLOG: If set, indicates the presence of system lastlog
250 * facilities. If this and DISABLE_LASTLOG are not set,
251 * try to retrieve lastlog information from wtmp/wtmpx.
254 login_get_lastlog_time(const int uid)
258 if (login_get_lastlog(&li, uid))
265 * login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
267 * Retrieve a logininfo structure populated (only partially) with
268 * information from the system lastlog data, or from wtmp/wtmpx if no
269 * system lastlog information exists.
271 * Note this routine must be given a pre-allocated logininfo.
274 * >0: A pointer to your struct logininfo if successful
275 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
278 login_get_lastlog(struct logininfo *li, const int uid)
282 memset(li, '\0', sizeof(*li));
286 * If we don't have a 'real' lastlog, we need the username to
287 * reliably search wtmp(x) for the last login (see
292 fatal("%s: Cannot find account for uid %i", __func__, uid);
294 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
295 * username (XXX - so check for trunc!) */
296 strlcpy(li->username, pw->pw_name, sizeof(li->username));
298 if (getlast_entry(li))
306 * login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
307 * a logininfo structure
309 * This function creates a new struct logininfo, a data structure
310 * meant to carry the information required to portably record login info.
312 * Returns a pointer to a newly created struct logininfo. If memory
313 * allocation fails, the program halts.
316 logininfo *login_alloc_entry(int pid, const char *username,
317 const char *hostname, const char *line)
319 struct logininfo *newli;
321 newli = xmalloc(sizeof(*newli));
322 login_init_entry(newli, pid, username, hostname, line);
327 /* login_free_entry(struct logininfo *) - free struct memory */
329 login_free_entry(struct logininfo *li)
335 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
336 * - initialise a struct logininfo
338 * Populates a new struct logininfo, a data structure meant to carry
339 * the information required to portably record login info.
344 login_init_entry(struct logininfo *li, int pid, const char *username,
345 const char *hostname, const char *line)
349 memset(li, 0, sizeof(*li));
353 /* set the line information */
355 line_fullname(li->line, line, sizeof(li->line));
358 strlcpy(li->username, username, sizeof(li->username));
359 pw = getpwnam(li->username);
361 fatal("%s: Cannot find user \"%s\"", __func__,
364 li->uid = pw->pw_uid;
368 strlcpy(li->hostname, hostname, sizeof(li->hostname));
374 * login_set_current_time(struct logininfo *) - set the current time
376 * Set the current time in a logininfo structure. This function is
377 * meant to eliminate the need to deal with system dependencies for
381 login_set_current_time(struct logininfo *li)
385 gettimeofday(&tv, NULL);
387 li->tv_sec = tv.tv_sec;
388 li->tv_usec = tv.tv_usec;
391 /* copy a sockaddr_* into our logininfo */
393 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
394 const unsigned int sa_size)
396 unsigned int bufsize = sa_size;
398 /* make sure we don't overrun our union */
399 if (sizeof(li->hostaddr) < sa_size)
400 bufsize = sizeof(li->hostaddr);
402 memcpy(&li->hostaddr.sa, sa, bufsize);
407 ** login_write: Call low-level recording functions based on autoconf
411 login_write(struct logininfo *li)
414 if (geteuid() != 0) {
415 logit("Attempt to write login records by non-root user (aborting)");
420 /* set the timestamp */
421 login_set_current_time(li);
423 syslogin_write_entry(li);
426 if (li->type == LTYPE_LOGIN)
427 lastlog_write_entry(li);
430 utmp_write_entry(li);
433 wtmp_write_entry(li);
436 utmpx_write_entry(li);
439 wtmpx_write_entry(li);
441 #ifdef CUSTOM_SYS_AUTH_RECORD_LOGIN
442 if (li->type == LTYPE_LOGIN &&
443 !sys_auth_record_login(li->username,li->hostname,li->line))
444 logit("Writing login record failed for %s", li->username);
449 #ifdef LOGIN_NEEDS_UTMPX
451 login_utmp_only(struct logininfo *li)
453 li->type = LTYPE_LOGIN;
454 login_set_current_time(li);
456 utmp_write_entry(li);
459 wtmp_write_entry(li);
462 utmpx_write_entry(li);
465 wtmpx_write_entry(li);
472 ** getlast_entry: Call low-level functions to retrieve the last login
476 /* take the uid in li and return the last login time */
478 getlast_entry(struct logininfo *li)
481 return(lastlog_get_entry(li));
482 #else /* !USE_LASTLOG */
484 #if defined(DISABLE_LASTLOG)
485 /* On some systems we shouldn't even try to obtain last login
488 # elif defined(USE_WTMP) && \
489 (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
490 /* retrieve last login time from utmp */
491 return (wtmp_get_entry(li));
492 # elif defined(USE_WTMPX) && \
493 (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
494 /* If wtmp isn't available, try wtmpx */
495 return (wtmpx_get_entry(li));
497 /* Give up: No means of retrieving last login time */
499 # endif /* DISABLE_LASTLOG */
500 #endif /* USE_LASTLOG */
506 * 'line' string utility functions
508 * These functions process the 'line' string into one of three forms:
510 * 1. The full filename (including '/dev')
511 * 2. The stripped name (excluding '/dev')
512 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
513 * /dev/pts/1 -> ts/1 )
515 * Form 3 is used on some systems to identify a .tmp.? entry when
516 * attempting to remove it. Typically both addition and removal is
517 * performed by one application - say, sshd - so as long as the choice
518 * uniquely identifies a terminal it's ok.
523 * line_fullname(): add the leading '/dev/' if it doesn't exist make
524 * sure dst has enough space, if not just copy src (ugh)
527 line_fullname(char *dst, const char *src, int dstsize)
529 memset(dst, '\0', dstsize);
530 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
531 strlcpy(dst, src, dstsize);
533 strlcpy(dst, "/dev/", dstsize);
534 strlcat(dst, src, dstsize);
539 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
541 line_stripname(char *dst, const char *src, int dstsize)
543 memset(dst, '\0', dstsize);
544 if (strncmp(src, "/dev/", 5) == 0)
545 strlcpy(dst, src + 5, dstsize);
547 strlcpy(dst, src, dstsize);
552 * line_abbrevname(): Return the abbreviated (usually four-character)
553 * form of the line (Just use the last <dstsize> characters of the
556 * NOTE: use strncpy because we do NOT necessarily want zero
560 line_abbrevname(char *dst, const char *src, int dstsize)
564 memset(dst, '\0', dstsize);
566 /* Always skip prefix if present */
567 if (strncmp(src, "/dev/", 5) == 0)
570 #ifdef WITH_ABBREV_NO_TTY
571 if (strncmp(src, "tty", 3) == 0)
578 if (((int)len - dstsize) > 0)
579 src += ((int)len - dstsize);
581 /* note: _don't_ change this to strlcpy */
582 strncpy(dst, src, (size_t)dstsize);
589 ** utmp utility functions
591 ** These functions manipulate struct utmp, taking system differences
595 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
597 /* build the utmp structure */
599 set_utmp_time(struct logininfo *li, struct utmp *ut)
601 # if defined(HAVE_TV_IN_UTMP)
602 ut->ut_tv.tv_sec = li->tv_sec;
603 ut->ut_tv.tv_usec = li->tv_usec;
604 # elif defined(HAVE_TIME_IN_UTMP)
605 ut->ut_time = li->tv_sec;
610 construct_utmp(struct logininfo *li,
613 # ifdef HAVE_ADDR_V6_IN_UTMP
614 struct sockaddr_in6 *sa6;
617 memset(ut, '\0', sizeof(*ut));
619 /* First fill out fields used for both logins and logouts */
621 # ifdef HAVE_ID_IN_UTMP
622 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
625 # ifdef HAVE_TYPE_IN_UTMP
626 /* This is done here to keep utmp constants out of struct logininfo */
629 ut->ut_type = USER_PROCESS;
635 ut->ut_type = DEAD_PROCESS;
637 cray_retain_utmp(ut, li->pid);
642 set_utmp_time(li, ut);
644 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
646 # ifdef HAVE_PID_IN_UTMP
647 ut->ut_pid = li->pid;
650 /* If we're logging out, leave all other fields blank */
651 if (li->type == LTYPE_LOGOUT)
655 * These fields are only used when logging in, and are blank
659 /* Use strncpy because we don't necessarily want null termination */
660 strncpy(ut->ut_name, li->username,
661 MIN_SIZEOF(ut->ut_name, li->username));
662 # ifdef HAVE_HOST_IN_UTMP
663 strncpy(ut->ut_host, li->hostname,
664 MIN_SIZEOF(ut->ut_host, li->hostname));
666 # ifdef HAVE_ADDR_IN_UTMP
667 /* this is just a 32-bit IP address */
668 if (li->hostaddr.sa.sa_family == AF_INET)
669 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
671 # ifdef HAVE_ADDR_V6_IN_UTMP
672 /* this is just a 128-bit IPv6 address */
673 if (li->hostaddr.sa.sa_family == AF_INET6) {
674 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
675 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
676 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
677 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
678 ut->ut_addr_v6[1] = 0;
679 ut->ut_addr_v6[2] = 0;
680 ut->ut_addr_v6[3] = 0;
685 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
688 ** utmpx utility functions
690 ** These functions manipulate struct utmpx, accounting for system
694 #if defined(USE_UTMPX) || defined (USE_WTMPX)
695 /* build the utmpx structure */
697 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
699 # if defined(HAVE_TV_IN_UTMPX)
700 utx->ut_tv.tv_sec = li->tv_sec;
701 utx->ut_tv.tv_usec = li->tv_usec;
702 # elif defined(HAVE_TIME_IN_UTMPX)
703 utx->ut_time = li->tv_sec;
708 construct_utmpx(struct logininfo *li, struct utmpx *utx)
710 # ifdef HAVE_ADDR_V6_IN_UTMP
711 struct sockaddr_in6 *sa6;
713 memset(utx, '\0', sizeof(*utx));
715 # ifdef HAVE_ID_IN_UTMPX
716 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
719 /* this is done here to keep utmp constants out of loginrec.h */
722 utx->ut_type = USER_PROCESS;
725 utx->ut_type = DEAD_PROCESS;
728 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
729 set_utmpx_time(li, utx);
730 utx->ut_pid = li->pid;
732 /* strncpy(): Don't necessarily want null termination */
733 strncpy(utx->ut_name, li->username,
734 MIN_SIZEOF(utx->ut_name, li->username));
736 if (li->type == LTYPE_LOGOUT)
740 * These fields are only used when logging in, and are blank
744 # ifdef HAVE_HOST_IN_UTMPX
745 strncpy(utx->ut_host, li->hostname,
746 MIN_SIZEOF(utx->ut_host, li->hostname));
748 # ifdef HAVE_ADDR_IN_UTMPX
749 /* this is just a 32-bit IP address */
750 if (li->hostaddr.sa.sa_family == AF_INET)
751 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
753 # ifdef HAVE_ADDR_V6_IN_UTMP
754 /* this is just a 128-bit IPv6 address */
755 if (li->hostaddr.sa.sa_family == AF_INET6) {
756 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
757 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
758 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
759 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
760 ut->ut_addr_v6[1] = 0;
761 ut->ut_addr_v6[2] = 0;
762 ut->ut_addr_v6[3] = 0;
766 # ifdef HAVE_SYSLEN_IN_UTMPX
767 /* ut_syslen is the length of the utx_host string */
768 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
771 #endif /* USE_UTMPX || USE_WTMPX */
774 ** Low-level utmp functions
777 /* FIXME: (ATL) utmp_write_direct needs testing */
780 /* if we can, use pututline() etc. */
781 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
782 defined(HAVE_PUTUTLINE)
783 # define UTMP_USE_LIBRARY
787 /* write a utmp entry with the system's help (pututline() and pals) */
788 # ifdef UTMP_USE_LIBRARY
790 utmp_write_library(struct logininfo *li, struct utmp *ut)
794 # ifdef HAVE_ENDUTENT
799 # else /* UTMP_USE_LIBRARY */
802 * Write a utmp entry direct to the file
803 * This is a slightly modification of code in OpenBSD's login.c
806 utmp_write_direct(struct logininfo *li, struct utmp *ut)
812 /* FIXME: (ATL) ttyslot() needs local implementation */
814 #if defined(HAVE_GETTTYENT)
819 while (NULL != (ty = getttyent())) {
821 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
827 logit("%s: tty not found", __func__);
832 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
834 #endif /* HAVE_GETTTYENT */
836 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
839 pos = (off_t)tty * sizeof(struct utmp);
840 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
841 logit("%s: lseek: %s", __func__, strerror(errno));
845 logit("%s: Couldn't seek to tty %d slot in %s",
846 __func__, tty, UTMP_FILE);
850 * Prevent luser from zero'ing out ut_host.
851 * If the new ut_line is empty but the old one is not
852 * and ut_line and ut_name match, preserve the old ut_line.
854 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
855 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
856 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
857 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0))
858 memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
860 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
861 logit("%s: lseek: %s", __func__, strerror(errno));
865 logit("%s: Couldn't seek to tty %d slot in %s",
866 __func__, tty, UTMP_FILE);
869 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
870 logit("%s: error writing %s: %s", __func__,
871 UTMP_FILE, strerror(errno));
880 # endif /* UTMP_USE_LIBRARY */
883 utmp_perform_login(struct logininfo *li)
887 construct_utmp(li, &ut);
888 # ifdef UTMP_USE_LIBRARY
889 if (!utmp_write_library(li, &ut)) {
890 logit("%s: utmp_write_library() failed", __func__);
894 if (!utmp_write_direct(li, &ut)) {
895 logit("%s: utmp_write_direct() failed", __func__);
904 utmp_perform_logout(struct logininfo *li)
908 construct_utmp(li, &ut);
909 # ifdef UTMP_USE_LIBRARY
910 if (!utmp_write_library(li, &ut)) {
911 logit("%s: utmp_write_library() failed", __func__);
915 if (!utmp_write_direct(li, &ut)) {
916 logit("%s: utmp_write_direct() failed", __func__);
925 utmp_write_entry(struct logininfo *li)
929 return (utmp_perform_login(li));
932 return (utmp_perform_logout(li));
935 logit("%s: invalid type field", __func__);
939 #endif /* USE_UTMP */
943 ** Low-level utmpx functions
946 /* not much point if we don't want utmpx entries */
949 /* if we have the wherewithall, use pututxline etc. */
950 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
951 defined(HAVE_PUTUTXLINE)
952 # define UTMPX_USE_LIBRARY
956 /* write a utmpx entry with the system's help (pututxline() and pals) */
957 # ifdef UTMPX_USE_LIBRARY
959 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
964 # ifdef HAVE_ENDUTXENT
970 # else /* UTMPX_USE_LIBRARY */
972 /* write a utmp entry direct to the file */
974 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
976 logit("%s: not implemented!", __func__);
979 # endif /* UTMPX_USE_LIBRARY */
982 utmpx_perform_login(struct logininfo *li)
986 construct_utmpx(li, &utx);
987 # ifdef UTMPX_USE_LIBRARY
988 if (!utmpx_write_library(li, &utx)) {
989 logit("%s: utmp_write_library() failed", __func__);
993 if (!utmpx_write_direct(li, &ut)) {
994 logit("%s: utmp_write_direct() failed", __func__);
1003 utmpx_perform_logout(struct logininfo *li)
1007 construct_utmpx(li, &utx);
1008 # ifdef HAVE_ID_IN_UTMPX
1009 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
1011 # ifdef HAVE_TYPE_IN_UTMPX
1012 utx.ut_type = DEAD_PROCESS;
1015 # ifdef UTMPX_USE_LIBRARY
1016 utmpx_write_library(li, &utx);
1018 utmpx_write_direct(li, &utx);
1024 utmpx_write_entry(struct logininfo *li)
1028 return (utmpx_perform_login(li));
1030 return (utmpx_perform_logout(li));
1032 logit("%s: invalid type field", __func__);
1036 #endif /* USE_UTMPX */
1040 ** Low-level wtmp functions
1046 * Write a wtmp entry direct to the end of the file
1047 * This is a slight modification of code in OpenBSD's logwtmp.c
1050 wtmp_write(struct logininfo *li, struct utmp *ut)
1055 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1056 logit("%s: problem writing %s: %s", __func__,
1057 WTMP_FILE, strerror(errno));
1060 if (fstat(fd, &buf) == 0)
1061 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
1062 ftruncate(fd, buf.st_size);
1063 logit("%s: problem writing %s: %s", __func__,
1064 WTMP_FILE, strerror(errno));
1072 wtmp_perform_login(struct logininfo *li)
1076 construct_utmp(li, &ut);
1077 return (wtmp_write(li, &ut));
1082 wtmp_perform_logout(struct logininfo *li)
1086 construct_utmp(li, &ut);
1087 return (wtmp_write(li, &ut));
1092 wtmp_write_entry(struct logininfo *li)
1096 return (wtmp_perform_login(li));
1098 return (wtmp_perform_logout(li));
1100 logit("%s: invalid type field", __func__);
1107 * Notes on fetching login data from wtmp/wtmpx
1109 * Logouts are usually recorded with (amongst other things) a blank
1110 * username on a given tty line. However, some systems (HP-UX is one)
1111 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1113 * Since we're only looking for logins here, we know that the username
1114 * must be set correctly. On systems that leave it in, we check for
1115 * ut_type==USER_PROCESS (indicating a login.)
1117 * Portability: Some systems may set something other than USER_PROCESS
1118 * to indicate a login process. I don't know of any as I write. Also,
1119 * it's possible that some systems may both leave the username in
1120 * place and not have ut_type.
1123 /* return true if this wtmp entry indicates a login */
1125 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1127 if (strncmp(li->username, ut->ut_name,
1128 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1129 # ifdef HAVE_TYPE_IN_UTMP
1130 if (ut->ut_type & USER_PROCESS)
1140 wtmp_get_entry(struct logininfo *li)
1146 /* Clear the time entries in our logininfo */
1147 li->tv_sec = li->tv_usec = 0;
1149 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1150 logit("%s: problem opening %s: %s", __func__,
1151 WTMP_FILE, strerror(errno));
1154 if (fstat(fd, &st) != 0) {
1155 logit("%s: couldn't stat %s: %s", __func__,
1156 WTMP_FILE, strerror(errno));
1161 /* Seek to the start of the last struct utmp */
1162 if (lseek(fd, -(off_t)sizeof(struct utmp), SEEK_END) == -1) {
1163 /* Looks like we've got a fresh wtmp file */
1169 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1170 logit("%s: read of %s failed: %s", __func__,
1171 WTMP_FILE, strerror(errno));
1175 if ( wtmp_islogin(li, &ut) ) {
1178 * We've already checked for a time in struct
1179 * utmp, in login_getlast()
1181 # ifdef HAVE_TIME_IN_UTMP
1182 li->tv_sec = ut.ut_time;
1184 # if HAVE_TV_IN_UTMP
1185 li->tv_sec = ut.ut_tv.tv_sec;
1188 line_fullname(li->line, ut.ut_line,
1189 MIN_SIZEOF(li->line, ut.ut_line));
1190 # ifdef HAVE_HOST_IN_UTMP
1191 strlcpy(li->hostname, ut.ut_host,
1192 MIN_SIZEOF(li->hostname, ut.ut_host));
1196 /* Seek back 2 x struct utmp */
1197 if (lseek(fd, -(off_t)(2 * sizeof(struct utmp)), SEEK_CUR) == -1) {
1198 /* We've found the start of the file, so quit */
1204 /* We found an entry. Tidy up and return */
1208 # endif /* USE_WTMP */
1212 ** Low-level wtmpx functions
1217 * Write a wtmpx entry direct to the end of the file
1218 * This is a slight modification of code in OpenBSD's logwtmp.c
1221 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1223 #ifndef HAVE_UPDWTMPX
1227 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1228 logit("%s: problem opening %s: %s", __func__,
1229 WTMPX_FILE, strerror(errno));
1233 if (fstat(fd, &buf) == 0)
1234 if (atomicio(vwrite, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1235 ftruncate(fd, buf.st_size);
1236 logit("%s: problem writing %s: %s", __func__,
1237 WTMPX_FILE, strerror(errno));
1244 updwtmpx(WTMPX_FILE, utx);
1251 wtmpx_perform_login(struct logininfo *li)
1255 construct_utmpx(li, &utx);
1256 return (wtmpx_write(li, &utx));
1261 wtmpx_perform_logout(struct logininfo *li)
1265 construct_utmpx(li, &utx);
1266 return (wtmpx_write(li, &utx));
1271 wtmpx_write_entry(struct logininfo *li)
1275 return (wtmpx_perform_login(li));
1277 return (wtmpx_perform_logout(li));
1279 logit("%s: invalid type field", __func__);
1284 /* Please see the notes above wtmp_islogin() for information about the
1285 next two functions */
1287 /* Return true if this wtmpx entry indicates a login */
1289 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1291 if (strncmp(li->username, utx->ut_name,
1292 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1293 # ifdef HAVE_TYPE_IN_UTMPX
1294 if (utx->ut_type == USER_PROCESS)
1305 wtmpx_get_entry(struct logininfo *li)
1311 /* Clear the time entries */
1312 li->tv_sec = li->tv_usec = 0;
1314 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1315 logit("%s: problem opening %s: %s", __func__,
1316 WTMPX_FILE, strerror(errno));
1319 if (fstat(fd, &st) != 0) {
1320 logit("%s: couldn't stat %s: %s", __func__,
1321 WTMPX_FILE, strerror(errno));
1326 /* Seek to the start of the last struct utmpx */
1327 if (lseek(fd, -(off_t)sizeof(struct utmpx), SEEK_END) == -1 ) {
1328 /* probably a newly rotated wtmpx file */
1334 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1335 logit("%s: read of %s failed: %s", __func__,
1336 WTMPX_FILE, strerror(errno));
1341 * Logouts are recorded as a blank username on a particular
1342 * line. So, we just need to find the username in struct utmpx
1344 if (wtmpx_islogin(li, &utx)) {
1346 # if defined(HAVE_TV_IN_UTMPX)
1347 li->tv_sec = utx.ut_tv.tv_sec;
1348 # elif defined(HAVE_TIME_IN_UTMPX)
1349 li->tv_sec = utx.ut_time;
1351 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1352 # if defined(HAVE_HOST_IN_UTMPX)
1353 strlcpy(li->hostname, utx.ut_host,
1354 MIN_SIZEOF(li->hostname, utx.ut_host));
1358 if (lseek(fd, -(off_t)(2 * sizeof(struct utmpx)), SEEK_CUR) == -1) {
1367 #endif /* USE_WTMPX */
1370 ** Low-level libutil login() functions
1375 syslogin_perform_login(struct logininfo *li)
1379 ut = xmalloc(sizeof(*ut));
1380 construct_utmp(li, ut);
1388 syslogin_perform_logout(struct logininfo *li)
1391 char line[UT_LINESIZE];
1393 (void)line_stripname(line, li->line, sizeof(line));
1396 logit("%s: logout() returned an error", __func__);
1397 # ifdef HAVE_LOGWTMP
1399 logwtmp(line, "", "");
1401 /* FIXME: (ATL - if the need arises) What to do if we have
1402 * login, but no logout? what if logout but no logwtmp? All
1403 * routines are in libutil so they should all be there,
1410 syslogin_write_entry(struct logininfo *li)
1414 return (syslogin_perform_login(li));
1416 return (syslogin_perform_logout(li));
1418 logit("%s: Invalid type field", __func__);
1422 #endif /* USE_LOGIN */
1424 /* end of file log-syslogin.c */
1427 ** Low-level lastlog functions
1436 lastlog_construct(struct logininfo *li, struct lastlog *last)
1438 /* clear the structure */
1439 memset(last, '\0', sizeof(*last));
1441 line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1442 strlcpy(last->ll_host, li->hostname,
1443 MIN_SIZEOF(last->ll_host, li->hostname));
1444 last->ll_time = li->tv_sec;
1448 lastlog_filetype(char *filename)
1452 if (stat(LASTLOG_FILE, &st) != 0) {
1453 logit("%s: Couldn't stat %s: %s", __func__,
1454 LASTLOG_FILE, strerror(errno));
1457 if (S_ISDIR(st.st_mode))
1459 else if (S_ISREG(st.st_mode))
1466 /* open the file (using filemode) and seek to the login entry */
1468 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1472 char lastlog_file[1024];
1474 type = lastlog_filetype(LASTLOG_FILE);
1477 strlcpy(lastlog_file, LASTLOG_FILE,
1478 sizeof(lastlog_file));
1481 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1482 LASTLOG_FILE, li->username);
1485 logit("%s: %.100s is not a file or directory!", __func__,
1490 *fd = open(lastlog_file, filemode, 0600);
1492 debug("%s: Couldn't open %s: %s", __func__,
1493 lastlog_file, strerror(errno));
1497 if (type == LL_FILE) {
1498 /* find this uid's offset in the lastlog file */
1499 offset = (off_t) ((long)li->uid * sizeof(struct lastlog));
1501 if (lseek(*fd, offset, SEEK_SET) != offset) {
1502 logit("%s: %s->lseek(): %s", __func__,
1503 lastlog_file, strerror(errno));
1512 lastlog_perform_login(struct logininfo *li)
1514 struct lastlog last;
1517 /* create our struct lastlog */
1518 lastlog_construct(li, &last);
1520 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1523 /* write the entry */
1524 if (atomicio(vwrite, fd, &last, sizeof(last)) != sizeof(last)) {
1526 logit("%s: Error writing to %s: %s", __func__,
1527 LASTLOG_FILE, strerror(errno));
1536 lastlog_write_entry(struct logininfo *li)
1540 return (lastlog_perform_login(li));
1542 logit("%s: Invalid type field", __func__);
1548 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1550 line_fullname(li->line, last->ll_line, sizeof(li->line));
1551 strlcpy(li->hostname, last->ll_host,
1552 MIN_SIZEOF(li->hostname, last->ll_host));
1553 li->tv_sec = last->ll_time;
1557 lastlog_get_entry(struct logininfo *li)
1559 struct lastlog last;
1562 if (!lastlog_openseek(li, &fd, O_RDONLY))
1565 ret = atomicio(read, fd, &last, sizeof(last));
1570 memset(&last, '\0', sizeof(last));
1573 lastlog_populate_entry(li, &last);
1576 error("%s: Error reading from %s: %s", __func__,
1577 LASTLOG_FILE, strerror(errno));
1580 error("%s: Error reading from %s: Expecting %d, got %d",
1581 __func__, LASTLOG_FILE, sizeof(last), ret);
1588 #endif /* USE_LASTLOG */
1592 * Logs failed login attempts in _PATH_BTMP if that exists.
1593 * The most common login failure is to give password instead of username.
1594 * So the _PATH_BTMP file checked for the correct permission, so that
1595 * only root can read it.
1599 record_failed_login(const char *username, const char *hostname,
1604 struct sockaddr_storage from;
1605 size_t fromlen = sizeof(from);
1606 struct sockaddr_in *a4;
1607 struct sockaddr_in6 *a6;
1613 if ((fd = open(_PATH_BTMP, O_WRONLY | O_APPEND)) < 0) {
1614 debug("Unable to open the btmp file %s: %s", _PATH_BTMP,
1618 if (fstat(fd, &fst) < 0) {
1619 logit("%s: fstat of %s failed: %s", __func__, _PATH_BTMP,
1623 if((fst.st_mode & (S_IRWXG | S_IRWXO)) || (fst.st_uid != 0)){
1624 logit("Excess permission or bad ownership on file %s",
1629 memset(&ut, 0, sizeof(ut));
1630 /* strncpy because we don't necessarily want nul termination */
1631 strncpy(ut.ut_user, username, sizeof(ut.ut_user));
1632 strlcpy(ut.ut_line, "ssh:notty", sizeof(ut.ut_line));
1635 ut.ut_time = t; /* ut_time is not always a time_t */
1636 ut.ut_type = LOGIN_PROCESS;
1637 ut.ut_pid = getpid();
1639 /* strncpy because we don't necessarily want nul termination */
1640 strncpy(ut.ut_host, hostname, sizeof(ut.ut_host));
1642 if (packet_connection_is_on_socket() &&
1643 getpeername(packet_get_connection_in(),
1644 (struct sockaddr *)&from, &fromlen) == 0) {
1645 ipv64_normalise_mapped(&from, &fromlen);
1646 if (from.ss_family == AF_INET) {
1647 a4 = (struct sockaddr_in *)&from;
1648 memcpy(&ut.ut_addr, &(a4->sin_addr),
1649 MIN_SIZEOF(ut.ut_addr, a4->sin_addr));
1651 #ifdef HAVE_ADDR_V6_IN_UTMP
1652 if (from.ss_family == AF_INET6) {
1653 a6 = (struct sockaddr_in6 *)&from;
1654 memcpy(&ut.ut_addr_v6, &(a6->sin6_addr),
1655 MIN_SIZEOF(ut.ut_addr_v6, a6->sin6_addr));
1660 if (atomicio(vwrite, fd, &ut, sizeof(ut)) != sizeof(ut))
1661 error("Failed to write to %s: %s", _PATH_BTMP,
1667 #endif /* USE_BTMP */