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 ** loginrec.c: platform-independent login recording and lastlog retrieval
33 * The new login code explained
34 * ============================
36 * This code attempts to provide a common interface to login recording
37 * (utmp and friends) and last login time retrieval.
39 * Its primary means of achieving this is to use 'struct logininfo', a
40 * union of all the useful fields in the various different types of
41 * system login record structures one finds on UNIX variants.
43 * We depend on autoconf to define which recording methods are to be
44 * used, and which fields are contained in the relevant data structures
45 * on the local system. Many C preprocessor symbols affect which code
48 * The code is designed to make it easy to modify a particular
49 * recording method, without affecting other methods nor requiring so
50 * many nested conditional compilation blocks as were commonplace in
53 * For login recording, we try to use the local system's libraries as
54 * these are clearly most likely to work correctly. For utmp systems
55 * this usually means login() and logout() or setutent() etc., probably
56 * in libutil, along with logwtmp() etc. On these systems, we fall back
57 * to writing the files directly if we have to, though this method
58 * requires very thorough testing so we do not corrupt local auditing
59 * information. These files and their access methods are very system
62 * For utmpx systems, the corresponding library functions are
63 * setutxent() etc. To the author's knowledge, all utmpx systems have
64 * these library functions and so no direct write is attempted. If such
65 * a system exists and needs support, direct analogues of the [uw]tmp
66 * code should suffice.
68 * Retrieving the time of last login ('lastlog') is in some ways even
69 * more problemmatic than login recording. Some systems provide a
70 * simple table of all users which we seek based on uid and retrieve a
71 * relatively standard structure. Others record the same information in
72 * a directory with a separate file, and others don't record the
73 * information separately at all. For systems in the latter category,
74 * we look backwards in the wtmp or wtmpx file for the last login entry
75 * for our user. Naturally this is slower and on busy systems could
76 * incur a significant performance penalty.
78 * Calling the new code
79 * --------------------
81 * In OpenSSH all login recording and retrieval is performed in
82 * login.c. Here you'll find working examples. Also, in the logintest.c
83 * program there are more examples.
85 * Internal handler calling method
86 * -------------------------------
88 * When a call is made to login_login() or login_logout(), both
89 * routines set a struct logininfo flag defining which action (log in,
90 * or log out) is to be taken. They both then call login_write(), which
91 * calls whichever of the many structure-specific handlers autoconf
92 * selects for the local system.
94 * The handlers themselves handle system data structure specifics. Both
95 * struct utmp and struct utmpx have utility functions (see
96 * construct_utmp*()) to try to make it simpler to add extra systems
97 * that introduce new features to either structure.
99 * While it may seem terribly wasteful to replicate so much similar
100 * code for each method, experience has shown that maintaining code to
101 * write both struct utmp and utmpx in one function, whilst maintaining
102 * support for all systems whether they have library support or not, is
103 * a difficult and time-consuming task.
105 * Lastlog support proceeds similarly. Functions login_get_lastlog()
106 * (and its OpenSSH-tuned friend login_get_lastlog_time()) call
107 * getlast_entry(), which tries one of three methods to find the last
108 * login time. It uses local system lastlog support if it can,
109 * otherwise it tries wtmp or wtmpx before giving up and returning 0,
115 * In many cases it's possible to tweak autoconf to select the correct
116 * methods for a particular platform, either by improving the detection
117 * code (best), or by presetting DISABLE_<method> or CONF_<method>_FILE
118 * symbols for the platform.
120 * Use logintest to check which symbols are defined before modifying
121 * configure.ac and loginrec.c. (You have to build logintest yourself
122 * with 'make logintest' as it's not built by default.)
124 * Otherwise, patches to the specific method(s) are very helpful!
127 #include "includes.h"
131 #include "loginrec.h"
133 #include "atomicio.h"
139 #ifdef HAVE_LIBUTIL_H
140 # include <libutil.h>
146 ** prototypes for helper functions in this file
150 void set_utmp_time(struct logininfo *li, struct utmp *ut);
151 void construct_utmp(struct logininfo *li, struct utmp *ut);
155 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
156 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
159 int utmp_write_entry(struct logininfo *li);
160 int utmpx_write_entry(struct logininfo *li);
161 int wtmp_write_entry(struct logininfo *li);
162 int wtmpx_write_entry(struct logininfo *li);
163 int lastlog_write_entry(struct logininfo *li);
164 int syslogin_write_entry(struct logininfo *li);
166 int getlast_entry(struct logininfo *li);
167 int lastlog_get_entry(struct logininfo *li);
168 int wtmp_get_entry(struct logininfo *li);
169 int wtmpx_get_entry(struct logininfo *li);
171 /* pick the shortest string */
172 #define MIN_SIZEOF(s1,s2) (sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2))
175 ** platform-independent login functions
179 * login_login(struct logininfo *) - Record a login
181 * Call with a pointer to a struct logininfo initialised with
182 * login_init_entry() or login_alloc_entry()
186 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
189 login_login(struct logininfo *li)
191 li->type = LTYPE_LOGIN;
192 return (login_write(li));
197 * login_logout(struct logininfo *) - Record a logout
199 * Call as with login_login()
203 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
206 login_logout(struct logininfo *li)
208 li->type = LTYPE_LOGOUT;
209 return (login_write(li));
213 * login_get_lastlog_time(int) - Retrieve the last login time
215 * Retrieve the last login time for the given uid. Will try to use the
216 * system lastlog facilities if they are available, but will fall back
217 * to looking in wtmp/wtmpx if necessary
220 * 0 on failure, or if user has never logged in
221 * Time in seconds from the epoch if successful
223 * Useful preprocessor symbols:
224 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
226 * USE_LASTLOG: If set, indicates the presence of system lastlog
227 * facilities. If this and DISABLE_LASTLOG are not set,
228 * try to retrieve lastlog information from wtmp/wtmpx.
231 login_get_lastlog_time(const int uid)
235 if (login_get_lastlog(&li, uid))
242 * login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
244 * Retrieve a logininfo structure populated (only partially) with
245 * information from the system lastlog data, or from wtmp/wtmpx if no
246 * system lastlog information exists.
248 * Note this routine must be given a pre-allocated logininfo.
251 * >0: A pointer to your struct logininfo if successful
252 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
255 login_get_lastlog(struct logininfo *li, const int uid)
259 memset(li, '\0', sizeof(*li));
263 * If we don't have a 'real' lastlog, we need the username to
264 * reliably search wtmp(x) for the last login (see
269 fatal("%s: Cannot find account for uid %i", __func__, uid);
271 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
272 * username (XXX - so check for trunc!) */
273 strlcpy(li->username, pw->pw_name, sizeof(li->username));
275 if (getlast_entry(li))
283 * login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
284 * a logininfo structure
286 * This function creates a new struct logininfo, a data structure
287 * meant to carry the information required to portably record login info.
289 * Returns a pointer to a newly created struct logininfo. If memory
290 * allocation fails, the program halts.
293 logininfo *login_alloc_entry(int pid, const char *username,
294 const char *hostname, const char *line)
296 struct logininfo *newli;
298 newli = xmalloc(sizeof(*newli));
299 login_init_entry(newli, pid, username, hostname, line);
304 /* login_free_entry(struct logininfo *) - free struct memory */
306 login_free_entry(struct logininfo *li)
312 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
313 * - initialise a struct logininfo
315 * Populates a new struct logininfo, a data structure meant to carry
316 * the information required to portably record login info.
321 login_init_entry(struct logininfo *li, int pid, const char *username,
322 const char *hostname, const char *line)
326 memset(li, 0, sizeof(*li));
330 /* set the line information */
332 line_fullname(li->line, line, sizeof(li->line));
335 strlcpy(li->username, username, sizeof(li->username));
336 pw = getpwnam(li->username);
338 fatal("%s: Cannot find user \"%s\"", __func__,
341 li->uid = pw->pw_uid;
345 strlcpy(li->hostname, hostname, sizeof(li->hostname));
351 * login_set_current_time(struct logininfo *) - set the current time
353 * Set the current time in a logininfo structure. This function is
354 * meant to eliminate the need to deal with system dependencies for
358 login_set_current_time(struct logininfo *li)
362 gettimeofday(&tv, NULL);
364 li->tv_sec = tv.tv_sec;
365 li->tv_usec = tv.tv_usec;
368 /* copy a sockaddr_* into our logininfo */
370 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
371 const unsigned int sa_size)
373 unsigned int bufsize = sa_size;
375 /* make sure we don't overrun our union */
376 if (sizeof(li->hostaddr) < sa_size)
377 bufsize = sizeof(li->hostaddr);
379 memcpy(&li->hostaddr.sa, sa, bufsize);
384 ** login_write: Call low-level recording functions based on autoconf
388 login_write(struct logininfo *li)
391 if (geteuid() != 0) {
392 logit("Attempt to write login records by non-root user (aborting)");
397 /* set the timestamp */
398 login_set_current_time(li);
400 syslogin_write_entry(li);
403 if (li->type == LTYPE_LOGIN)
404 lastlog_write_entry(li);
407 utmp_write_entry(li);
410 wtmp_write_entry(li);
413 utmpx_write_entry(li);
416 wtmpx_write_entry(li);
418 #ifdef CUSTOM_SYS_AUTH_RECORD_LOGIN
419 if (li->type == LTYPE_LOGIN &&
420 !sys_auth_record_login(li->username,li->hostname,li->line))
421 logit("Writing login record failed for %s", li->username);
426 #ifdef LOGIN_NEEDS_UTMPX
428 login_utmp_only(struct logininfo *li)
430 li->type = LTYPE_LOGIN;
431 login_set_current_time(li);
433 utmp_write_entry(li);
436 wtmp_write_entry(li);
439 utmpx_write_entry(li);
442 wtmpx_write_entry(li);
449 ** getlast_entry: Call low-level functions to retrieve the last login
453 /* take the uid in li and return the last login time */
455 getlast_entry(struct logininfo *li)
458 return(lastlog_get_entry(li));
459 #else /* !USE_LASTLOG */
461 #if defined(DISABLE_LASTLOG)
462 /* On some systems we shouldn't even try to obtain last login
465 # elif defined(USE_WTMP) && \
466 (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
467 /* retrieve last login time from utmp */
468 return (wtmp_get_entry(li));
469 # elif defined(USE_WTMPX) && \
470 (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
471 /* If wtmp isn't available, try wtmpx */
472 return (wtmpx_get_entry(li));
474 /* Give up: No means of retrieving last login time */
476 # endif /* DISABLE_LASTLOG */
477 #endif /* USE_LASTLOG */
483 * 'line' string utility functions
485 * These functions process the 'line' string into one of three forms:
487 * 1. The full filename (including '/dev')
488 * 2. The stripped name (excluding '/dev')
489 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
490 * /dev/pts/1 -> ts/1 )
492 * Form 3 is used on some systems to identify a .tmp.? entry when
493 * attempting to remove it. Typically both addition and removal is
494 * performed by one application - say, sshd - so as long as the choice
495 * uniquely identifies a terminal it's ok.
500 * line_fullname(): add the leading '/dev/' if it doesn't exist make
501 * sure dst has enough space, if not just copy src (ugh)
504 line_fullname(char *dst, const char *src, int dstsize)
506 memset(dst, '\0', dstsize);
507 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
508 strlcpy(dst, src, dstsize);
510 strlcpy(dst, "/dev/", dstsize);
511 strlcat(dst, src, dstsize);
516 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
518 line_stripname(char *dst, const char *src, int dstsize)
520 memset(dst, '\0', dstsize);
521 if (strncmp(src, "/dev/", 5) == 0)
522 strlcpy(dst, src + 5, dstsize);
524 strlcpy(dst, src, dstsize);
529 * line_abbrevname(): Return the abbreviated (usually four-character)
530 * form of the line (Just use the last <dstsize> characters of the
533 * NOTE: use strncpy because we do NOT necessarily want zero
537 line_abbrevname(char *dst, const char *src, int dstsize)
541 memset(dst, '\0', dstsize);
543 /* Always skip prefix if present */
544 if (strncmp(src, "/dev/", 5) == 0)
547 #ifdef WITH_ABBREV_NO_TTY
548 if (strncmp(src, "tty", 3) == 0)
555 if (((int)len - dstsize) > 0)
556 src += ((int)len - dstsize);
558 /* note: _don't_ change this to strlcpy */
559 strncpy(dst, src, (size_t)dstsize);
566 ** utmp utility functions
568 ** These functions manipulate struct utmp, taking system differences
572 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
574 /* build the utmp structure */
576 set_utmp_time(struct logininfo *li, struct utmp *ut)
578 # if defined(HAVE_TV_IN_UTMP)
579 ut->ut_tv.tv_sec = li->tv_sec;
580 ut->ut_tv.tv_usec = li->tv_usec;
581 # elif defined(HAVE_TIME_IN_UTMP)
582 ut->ut_time = li->tv_sec;
587 construct_utmp(struct logininfo *li,
590 # ifdef HAVE_ADDR_V6_IN_UTMP
591 struct sockaddr_in6 *sa6;
594 memset(ut, '\0', sizeof(*ut));
596 /* First fill out fields used for both logins and logouts */
598 # ifdef HAVE_ID_IN_UTMP
599 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
602 # ifdef HAVE_TYPE_IN_UTMP
603 /* This is done here to keep utmp constants out of struct logininfo */
606 ut->ut_type = USER_PROCESS;
612 ut->ut_type = DEAD_PROCESS;
614 cray_retain_utmp(ut, li->pid);
619 set_utmp_time(li, ut);
621 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
623 # ifdef HAVE_PID_IN_UTMP
624 ut->ut_pid = li->pid;
627 /* If we're logging out, leave all other fields blank */
628 if (li->type == LTYPE_LOGOUT)
632 * These fields are only used when logging in, and are blank
636 /* Use strncpy because we don't necessarily want null termination */
637 strncpy(ut->ut_name, li->username,
638 MIN_SIZEOF(ut->ut_name, li->username));
639 # ifdef HAVE_HOST_IN_UTMP
640 strncpy(ut->ut_host, li->hostname,
641 MIN_SIZEOF(ut->ut_host, li->hostname));
643 # ifdef HAVE_ADDR_IN_UTMP
644 /* this is just a 32-bit IP address */
645 if (li->hostaddr.sa.sa_family == AF_INET)
646 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
648 # ifdef HAVE_ADDR_V6_IN_UTMP
649 /* this is just a 128-bit IPv6 address */
650 if (li->hostaddr.sa.sa_family == AF_INET6) {
651 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
652 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
653 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
654 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
655 ut->ut_addr_v6[1] = 0;
656 ut->ut_addr_v6[2] = 0;
657 ut->ut_addr_v6[3] = 0;
662 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
665 ** utmpx utility functions
667 ** These functions manipulate struct utmpx, accounting for system
671 #if defined(USE_UTMPX) || defined (USE_WTMPX)
672 /* build the utmpx structure */
674 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
676 # if defined(HAVE_TV_IN_UTMPX)
677 utx->ut_tv.tv_sec = li->tv_sec;
678 utx->ut_tv.tv_usec = li->tv_usec;
679 # elif defined(HAVE_TIME_IN_UTMPX)
680 utx->ut_time = li->tv_sec;
685 construct_utmpx(struct logininfo *li, struct utmpx *utx)
687 # ifdef HAVE_ADDR_V6_IN_UTMP
688 struct sockaddr_in6 *sa6;
690 memset(utx, '\0', sizeof(*utx));
692 # ifdef HAVE_ID_IN_UTMPX
693 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
696 /* this is done here to keep utmp constants out of loginrec.h */
699 utx->ut_type = USER_PROCESS;
702 utx->ut_type = DEAD_PROCESS;
705 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
706 set_utmpx_time(li, utx);
707 utx->ut_pid = li->pid;
709 /* strncpy(): Don't necessarily want null termination */
710 strncpy(utx->ut_name, li->username,
711 MIN_SIZEOF(utx->ut_name, li->username));
713 if (li->type == LTYPE_LOGOUT)
717 * These fields are only used when logging in, and are blank
721 # ifdef HAVE_HOST_IN_UTMPX
722 strncpy(utx->ut_host, li->hostname,
723 MIN_SIZEOF(utx->ut_host, li->hostname));
725 # ifdef HAVE_ADDR_IN_UTMPX
726 /* this is just a 32-bit IP address */
727 if (li->hostaddr.sa.sa_family == AF_INET)
728 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
730 # ifdef HAVE_ADDR_V6_IN_UTMP
731 /* this is just a 128-bit IPv6 address */
732 if (li->hostaddr.sa.sa_family == AF_INET6) {
733 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
734 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
735 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
736 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
737 ut->ut_addr_v6[1] = 0;
738 ut->ut_addr_v6[2] = 0;
739 ut->ut_addr_v6[3] = 0;
743 # ifdef HAVE_SYSLEN_IN_UTMPX
744 /* ut_syslen is the length of the utx_host string */
745 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
748 #endif /* USE_UTMPX || USE_WTMPX */
751 ** Low-level utmp functions
754 /* FIXME: (ATL) utmp_write_direct needs testing */
757 /* if we can, use pututline() etc. */
758 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
759 defined(HAVE_PUTUTLINE)
760 # define UTMP_USE_LIBRARY
764 /* write a utmp entry with the system's help (pututline() and pals) */
765 # ifdef UTMP_USE_LIBRARY
767 utmp_write_library(struct logininfo *li, struct utmp *ut)
771 # ifdef HAVE_ENDUTENT
776 # else /* UTMP_USE_LIBRARY */
779 * Write a utmp entry direct to the file
780 * This is a slightly modification of code in OpenBSD's login.c
783 utmp_write_direct(struct logininfo *li, struct utmp *ut)
789 /* FIXME: (ATL) ttyslot() needs local implementation */
791 #if defined(HAVE_GETTTYENT)
796 while (NULL != (ty = getttyent())) {
798 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
804 logit("%s: tty not found", __func__);
809 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
811 #endif /* HAVE_GETTTYENT */
813 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
816 pos = (off_t)tty * sizeof(struct utmp);
817 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
818 logit("%s: lseek: %s", __func__, strerror(errno));
822 logit("%s: Couldn't seek to tty %d slot in %s",
823 __func__, tty, UTMP_FILE);
827 * Prevent luser from zero'ing out ut_host.
828 * If the new ut_line is empty but the old one is not
829 * and ut_line and ut_name match, preserve the old ut_line.
831 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
832 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
833 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
834 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0))
835 memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
837 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
838 logit("%s: lseek: %s", __func__, strerror(errno));
842 logit("%s: Couldn't seek to tty %d slot in %s",
843 __func__, tty, UTMP_FILE);
846 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
847 logit("%s: error writing %s: %s", __func__,
848 UTMP_FILE, strerror(errno));
857 # endif /* UTMP_USE_LIBRARY */
860 utmp_perform_login(struct logininfo *li)
864 construct_utmp(li, &ut);
865 # ifdef UTMP_USE_LIBRARY
866 if (!utmp_write_library(li, &ut)) {
867 logit("%s: utmp_write_library() failed", __func__);
871 if (!utmp_write_direct(li, &ut)) {
872 logit("%s: utmp_write_direct() failed", __func__);
881 utmp_perform_logout(struct logininfo *li)
885 construct_utmp(li, &ut);
886 # ifdef UTMP_USE_LIBRARY
887 if (!utmp_write_library(li, &ut)) {
888 logit("%s: utmp_write_library() failed", __func__);
892 if (!utmp_write_direct(li, &ut)) {
893 logit("%s: utmp_write_direct() failed", __func__);
902 utmp_write_entry(struct logininfo *li)
906 return (utmp_perform_login(li));
909 return (utmp_perform_logout(li));
912 logit("%s: invalid type field", __func__);
916 #endif /* USE_UTMP */
920 ** Low-level utmpx functions
923 /* not much point if we don't want utmpx entries */
926 /* if we have the wherewithall, use pututxline etc. */
927 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
928 defined(HAVE_PUTUTXLINE)
929 # define UTMPX_USE_LIBRARY
933 /* write a utmpx entry with the system's help (pututxline() and pals) */
934 # ifdef UTMPX_USE_LIBRARY
936 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
941 # ifdef HAVE_ENDUTXENT
947 # else /* UTMPX_USE_LIBRARY */
949 /* write a utmp entry direct to the file */
951 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
953 logit("%s: not implemented!", __func__);
956 # endif /* UTMPX_USE_LIBRARY */
959 utmpx_perform_login(struct logininfo *li)
963 construct_utmpx(li, &utx);
964 # ifdef UTMPX_USE_LIBRARY
965 if (!utmpx_write_library(li, &utx)) {
966 logit("%s: utmp_write_library() failed", __func__);
970 if (!utmpx_write_direct(li, &ut)) {
971 logit("%s: utmp_write_direct() failed", __func__);
980 utmpx_perform_logout(struct logininfo *li)
984 construct_utmpx(li, &utx);
985 # ifdef HAVE_ID_IN_UTMPX
986 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
988 # ifdef HAVE_TYPE_IN_UTMPX
989 utx.ut_type = DEAD_PROCESS;
992 # ifdef UTMPX_USE_LIBRARY
993 utmpx_write_library(li, &utx);
995 utmpx_write_direct(li, &utx);
1001 utmpx_write_entry(struct logininfo *li)
1005 return (utmpx_perform_login(li));
1007 return (utmpx_perform_logout(li));
1009 logit("%s: invalid type field", __func__);
1013 #endif /* USE_UTMPX */
1017 ** Low-level wtmp functions
1023 * Write a wtmp entry direct to the end of the file
1024 * This is a slight modification of code in OpenBSD's logwtmp.c
1027 wtmp_write(struct logininfo *li, struct utmp *ut)
1032 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1033 logit("%s: problem writing %s: %s", __func__,
1034 WTMP_FILE, strerror(errno));
1037 if (fstat(fd, &buf) == 0)
1038 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
1039 ftruncate(fd, buf.st_size);
1040 logit("%s: problem writing %s: %s", __func__,
1041 WTMP_FILE, strerror(errno));
1049 wtmp_perform_login(struct logininfo *li)
1053 construct_utmp(li, &ut);
1054 return (wtmp_write(li, &ut));
1059 wtmp_perform_logout(struct logininfo *li)
1063 construct_utmp(li, &ut);
1064 return (wtmp_write(li, &ut));
1069 wtmp_write_entry(struct logininfo *li)
1073 return (wtmp_perform_login(li));
1075 return (wtmp_perform_logout(li));
1077 logit("%s: invalid type field", __func__);
1084 * Notes on fetching login data from wtmp/wtmpx
1086 * Logouts are usually recorded with (amongst other things) a blank
1087 * username on a given tty line. However, some systems (HP-UX is one)
1088 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1090 * Since we're only looking for logins here, we know that the username
1091 * must be set correctly. On systems that leave it in, we check for
1092 * ut_type==USER_PROCESS (indicating a login.)
1094 * Portability: Some systems may set something other than USER_PROCESS
1095 * to indicate a login process. I don't know of any as I write. Also,
1096 * it's possible that some systems may both leave the username in
1097 * place and not have ut_type.
1100 /* return true if this wtmp entry indicates a login */
1102 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1104 if (strncmp(li->username, ut->ut_name,
1105 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1106 # ifdef HAVE_TYPE_IN_UTMP
1107 if (ut->ut_type & USER_PROCESS)
1117 wtmp_get_entry(struct logininfo *li)
1123 /* Clear the time entries in our logininfo */
1124 li->tv_sec = li->tv_usec = 0;
1126 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1127 logit("%s: problem opening %s: %s", __func__,
1128 WTMP_FILE, strerror(errno));
1131 if (fstat(fd, &st) != 0) {
1132 logit("%s: couldn't stat %s: %s", __func__,
1133 WTMP_FILE, strerror(errno));
1138 /* Seek to the start of the last struct utmp */
1139 if (lseek(fd, -(off_t)sizeof(struct utmp), SEEK_END) == -1) {
1140 /* Looks like we've got a fresh wtmp file */
1146 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1147 logit("%s: read of %s failed: %s", __func__,
1148 WTMP_FILE, strerror(errno));
1152 if ( wtmp_islogin(li, &ut) ) {
1155 * We've already checked for a time in struct
1156 * utmp, in login_getlast()
1158 # ifdef HAVE_TIME_IN_UTMP
1159 li->tv_sec = ut.ut_time;
1161 # if HAVE_TV_IN_UTMP
1162 li->tv_sec = ut.ut_tv.tv_sec;
1165 line_fullname(li->line, ut.ut_line,
1166 MIN_SIZEOF(li->line, ut.ut_line));
1167 # ifdef HAVE_HOST_IN_UTMP
1168 strlcpy(li->hostname, ut.ut_host,
1169 MIN_SIZEOF(li->hostname, ut.ut_host));
1173 /* Seek back 2 x struct utmp */
1174 if (lseek(fd, -(off_t)(2 * sizeof(struct utmp)), SEEK_CUR) == -1) {
1175 /* We've found the start of the file, so quit */
1181 /* We found an entry. Tidy up and return */
1185 # endif /* USE_WTMP */
1189 ** Low-level wtmpx functions
1194 * Write a wtmpx entry direct to the end of the file
1195 * This is a slight modification of code in OpenBSD's logwtmp.c
1198 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1200 #ifndef HAVE_UPDWTMPX
1204 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1205 logit("%s: problem opening %s: %s", __func__,
1206 WTMPX_FILE, strerror(errno));
1210 if (fstat(fd, &buf) == 0)
1211 if (atomicio(vwrite, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1212 ftruncate(fd, buf.st_size);
1213 logit("%s: problem writing %s: %s", __func__,
1214 WTMPX_FILE, strerror(errno));
1221 updwtmpx(WTMPX_FILE, utx);
1228 wtmpx_perform_login(struct logininfo *li)
1232 construct_utmpx(li, &utx);
1233 return (wtmpx_write(li, &utx));
1238 wtmpx_perform_logout(struct logininfo *li)
1242 construct_utmpx(li, &utx);
1243 return (wtmpx_write(li, &utx));
1248 wtmpx_write_entry(struct logininfo *li)
1252 return (wtmpx_perform_login(li));
1254 return (wtmpx_perform_logout(li));
1256 logit("%s: invalid type field", __func__);
1261 /* Please see the notes above wtmp_islogin() for information about the
1262 next two functions */
1264 /* Return true if this wtmpx entry indicates a login */
1266 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1268 if (strncmp(li->username, utx->ut_name,
1269 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1270 # ifdef HAVE_TYPE_IN_UTMPX
1271 if (utx->ut_type == USER_PROCESS)
1282 wtmpx_get_entry(struct logininfo *li)
1288 /* Clear the time entries */
1289 li->tv_sec = li->tv_usec = 0;
1291 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1292 logit("%s: problem opening %s: %s", __func__,
1293 WTMPX_FILE, strerror(errno));
1296 if (fstat(fd, &st) != 0) {
1297 logit("%s: couldn't stat %s: %s", __func__,
1298 WTMPX_FILE, strerror(errno));
1303 /* Seek to the start of the last struct utmpx */
1304 if (lseek(fd, -(off_t)sizeof(struct utmpx), SEEK_END) == -1 ) {
1305 /* probably a newly rotated wtmpx file */
1311 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1312 logit("%s: read of %s failed: %s", __func__,
1313 WTMPX_FILE, strerror(errno));
1318 * Logouts are recorded as a blank username on a particular
1319 * line. So, we just need to find the username in struct utmpx
1321 if (wtmpx_islogin(li, &utx)) {
1323 # if defined(HAVE_TV_IN_UTMPX)
1324 li->tv_sec = utx.ut_tv.tv_sec;
1325 # elif defined(HAVE_TIME_IN_UTMPX)
1326 li->tv_sec = utx.ut_time;
1328 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1329 # if defined(HAVE_HOST_IN_UTMPX)
1330 strlcpy(li->hostname, utx.ut_host,
1331 MIN_SIZEOF(li->hostname, utx.ut_host));
1335 if (lseek(fd, -(off_t)(2 * sizeof(struct utmpx)), SEEK_CUR) == -1) {
1344 #endif /* USE_WTMPX */
1347 ** Low-level libutil login() functions
1352 syslogin_perform_login(struct logininfo *li)
1356 ut = xmalloc(sizeof(*ut));
1357 construct_utmp(li, ut);
1365 syslogin_perform_logout(struct logininfo *li)
1368 char line[UT_LINESIZE];
1370 (void)line_stripname(line, li->line, sizeof(line));
1373 logit("%s: logout() returned an error", __func__);
1374 # ifdef HAVE_LOGWTMP
1376 logwtmp(line, "", "");
1378 /* FIXME: (ATL - if the need arises) What to do if we have
1379 * login, but no logout? what if logout but no logwtmp? All
1380 * routines are in libutil so they should all be there,
1387 syslogin_write_entry(struct logininfo *li)
1391 return (syslogin_perform_login(li));
1393 return (syslogin_perform_logout(li));
1395 logit("%s: Invalid type field", __func__);
1399 #endif /* USE_LOGIN */
1401 /* end of file log-syslogin.c */
1404 ** Low-level lastlog functions
1413 lastlog_construct(struct logininfo *li, struct lastlog *last)
1415 /* clear the structure */
1416 memset(last, '\0', sizeof(*last));
1418 line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1419 strlcpy(last->ll_host, li->hostname,
1420 MIN_SIZEOF(last->ll_host, li->hostname));
1421 last->ll_time = li->tv_sec;
1425 lastlog_filetype(char *filename)
1429 if (stat(LASTLOG_FILE, &st) != 0) {
1430 logit("%s: Couldn't stat %s: %s", __func__,
1431 LASTLOG_FILE, strerror(errno));
1434 if (S_ISDIR(st.st_mode))
1436 else if (S_ISREG(st.st_mode))
1443 /* open the file (using filemode) and seek to the login entry */
1445 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1449 char lastlog_file[1024];
1451 type = lastlog_filetype(LASTLOG_FILE);
1454 strlcpy(lastlog_file, LASTLOG_FILE,
1455 sizeof(lastlog_file));
1458 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1459 LASTLOG_FILE, li->username);
1462 logit("%s: %.100s is not a file or directory!", __func__,
1467 *fd = open(lastlog_file, filemode, 0600);
1469 debug("%s: Couldn't open %s: %s", __func__,
1470 lastlog_file, strerror(errno));
1474 if (type == LL_FILE) {
1475 /* find this uid's offset in the lastlog file */
1476 offset = (off_t) ((long)li->uid * sizeof(struct lastlog));
1478 if (lseek(*fd, offset, SEEK_SET) != offset) {
1479 logit("%s: %s->lseek(): %s", __func__,
1480 lastlog_file, strerror(errno));
1489 lastlog_perform_login(struct logininfo *li)
1491 struct lastlog last;
1494 /* create our struct lastlog */
1495 lastlog_construct(li, &last);
1497 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1500 /* write the entry */
1501 if (atomicio(vwrite, fd, &last, sizeof(last)) != sizeof(last)) {
1503 logit("%s: Error writing to %s: %s", __func__,
1504 LASTLOG_FILE, strerror(errno));
1513 lastlog_write_entry(struct logininfo *li)
1517 return (lastlog_perform_login(li));
1519 logit("%s: Invalid type field", __func__);
1525 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1527 line_fullname(li->line, last->ll_line, sizeof(li->line));
1528 strlcpy(li->hostname, last->ll_host,
1529 MIN_SIZEOF(li->hostname, last->ll_host));
1530 li->tv_sec = last->ll_time;
1534 lastlog_get_entry(struct logininfo *li)
1536 struct lastlog last;
1539 if (!lastlog_openseek(li, &fd, O_RDONLY))
1542 ret = atomicio(read, fd, &last, sizeof(last));
1547 memset(&last, '\0', sizeof(last));
1550 lastlog_populate_entry(li, &last);
1553 error("%s: Error reading from %s: %s", __func__,
1554 LASTLOG_FILE, strerror(errno));
1557 error("%s: Error reading from %s: Expecting %d, got %d",
1558 __func__, LASTLOG_FILE, sizeof(last), ret);
1565 #endif /* USE_LASTLOG */