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.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Markus Friedl.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 ** loginrec.c: platform-independent login recording and lastlog retrieval
38 The new login code explained
39 ============================
41 This code attempts to provide a common interface to login recording
42 (utmp and friends) and last login time retrieval.
44 Its primary means of achieving this is to use 'struct logininfo', a
45 union of all the useful fields in the various different types of
46 system login record structures one finds on UNIX variants.
48 We depend on autoconf to define which recording methods are to be
49 used, and which fields are contained in the relevant data structures
50 on the local system. Many C preprocessor symbols affect which code
53 The code is designed to make it easy to modify a particular
54 recording method, without affecting other methods nor requiring so
55 many nested conditional compilation blocks as were commonplace in
58 For login recording, we try to use the local system's libraries as
59 these are clearly most likely to work correctly. For utmp systems
60 this usually means login() and logout() or setutent() etc., probably
61 in libutil, along with logwtmp() etc. On these systems, we fall back
62 to writing the files directly if we have to, though this method
63 requires very thorough testing so we do not corrupt local auditing
64 information. These files and their access methods are very system
67 For utmpx systems, the corresponding library functions are
68 setutxent() etc. To the author's knowledge, all utmpx systems have
69 these library functions and so no direct write is attempted. If such
70 a system exists and needs support, direct analogues of the [uw]tmp
73 Retrieving the time of last login ('lastlog') is in some ways even
74 more problemmatic than login recording. Some systems provide a
75 simple table of all users which we seek based on uid and retrieve a
76 relatively standard structure. Others record the same information in
77 a directory with a separate file, and others don't record the
78 information separately at all. For systems in the latter category,
79 we look backwards in the wtmp or wtmpx file for the last login entry
80 for our user. Naturally this is slower and on busy systems could
81 incur a significant performance penalty.
86 In OpenSSH all login recording and retrieval is performed in
87 login.c. Here you'll find working examples. Also, in the logintest.c
88 program there are more examples.
90 Internal handler calling method
91 -------------------------------
93 When a call is made to login_login() or login_logout(), both
94 routines set a struct logininfo flag defining which action (log in,
95 or log out) is to be taken. They both then call login_write(), which
96 calls whichever of the many structure-specific handlers autoconf
97 selects for the local system.
99 The handlers themselves handle system data structure specifics. Both
100 struct utmp and struct utmpx have utility functions (see
101 construct_utmp*()) to try to make it simpler to add extra systems
102 that introduce new features to either structure.
104 While it may seem terribly wasteful to replicate so much similar
105 code for each method, experience has shown that maintaining code to
106 write both struct utmp and utmpx in one function, whilst maintaining
107 support for all systems whether they have library support or not, is
108 a difficult and time-consuming task.
110 Lastlog support proceeds similarly. Functions login_get_lastlog()
111 (and its OpenSSH-tuned friend login_get_lastlog_time()) call
112 getlast_entry(), which tries one of three methods to find the last
113 login time. It uses local system lastlog support if it can,
114 otherwise it tries wtmp or wtmpx before giving up and returning 0,
120 In many cases it's possible to tweak autoconf to select the correct
121 methods for a particular platform, either by improving the detection
122 code (best), or by presetting DISABLE_<method> or CONF_<method>_FILE
123 symbols for the platform.
125 Use logintest to check which symbols are defined before modifying
126 configure.in and loginrec.c. (You have to build logintest yourself
127 with 'make logintest' as it's not built by default.)
129 Otherwise, patches to the specific method(s) are very helpful!
135 ** homegrown ttyslot()q
142 ** Linux (Redhat 6.2, need more variants)
143 ** HP-UX 10.20 (gcc only)
146 ** Testing required: Please send reports!
152 ** Platforms with known problems:
157 #include "includes.h"
161 #include "loginrec.h"
166 ** prototypes for helper functions in this file
170 void set_utmp_time(struct logininfo *li, struct utmp *ut);
171 void construct_utmp(struct logininfo *li, struct utmp *ut);
175 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
176 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
179 int utmp_write_entry(struct logininfo *li);
180 int utmpx_write_entry(struct logininfo *li);
181 int wtmp_write_entry(struct logininfo *li);
182 int wtmpx_write_entry(struct logininfo *li);
183 int lastlog_write_entry(struct logininfo *li);
184 int syslogin_write_entry(struct logininfo *li);
186 int getlast_entry(struct logininfo *li);
187 int lastlog_get_entry(struct logininfo *li);
188 int wtmp_get_entry(struct logininfo *li);
189 int wtmpx_get_entry(struct logininfo *li);
191 /* pick the shortest string */
192 #define MIN_SIZEOF(s1,s2) ( sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2) )
195 ** platform-independent login functions
198 /* login_login(struct logininfo *) -Record a login
200 * Call with a pointer to a struct logininfo initialised with
201 * login_init_entry() or login_alloc_entry()
205 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
208 login_login (struct logininfo *li)
210 li->type = LTYPE_LOGIN;
211 return login_write(li);
215 /* login_logout(struct logininfo *) - Record a logout
217 * Call as with login_login()
221 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
224 login_logout(struct logininfo *li)
226 li->type = LTYPE_LOGOUT;
227 return login_write(li);
230 /* login_get_lastlog_time(int) - Retrieve the last login time
232 * Retrieve the last login time for the given uid. Will try to use the
233 * system lastlog facilities if they are available, but will fall back
234 * to looking in wtmp/wtmpx if necessary
237 * 0 on failure, or if user has never logged in
238 * Time in seconds from the epoch if successful
240 * Useful preprocessor symbols:
241 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
243 * USE_LASTLOG: If set, indicates the presence of system lastlog
244 * facilities. If this and DISABLE_LASTLOG are not set,
245 * try to retrieve lastlog information from wtmp/wtmpx.
248 login_get_lastlog_time(const int uid)
252 if (login_get_lastlog(&li, uid))
258 /* login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
260 * Retrieve a logininfo structure populated (only partially) with
261 * information from the system lastlog data, or from wtmp/wtmpx if no
262 * system lastlog information exists.
264 * Note this routine must be given a pre-allocated logininfo.
267 * >0: A pointer to your struct logininfo if successful
268 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
272 login_get_lastlog(struct logininfo *li, const int uid)
276 memset(li, '\0', sizeof(struct logininfo));
280 * If we don't have a 'real' lastlog, we need the username to
281 * reliably search wtmp(x) for the last login (see
286 fatal("login_get_lastlog: Cannot find account for uid %i", uid);
288 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
290 strlcpy(li->username, pw->pw_name, sizeof(li->username));
292 if (getlast_entry(li))
299 /* login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
300 * a logininfo structure
302 * This function creates a new struct logininfo, a data structure
303 * meant to carry the information required to portably record login info.
305 * Returns a pointer to a newly created struct logininfo. If memory
306 * allocation fails, the program halts.
309 logininfo *login_alloc_entry(int pid, const char *username,
310 const char *hostname, const char *line)
312 struct logininfo *newli;
314 newli = (struct logininfo *) xmalloc (sizeof(struct logininfo));
315 (void)login_init_entry(newli, pid, username, hostname, line);
320 /* login_free_entry(struct logininfo *) - free struct memory */
322 login_free_entry(struct logininfo *li)
328 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
329 * - initialise a struct logininfo
331 * Populates a new struct logininfo, a data structure meant to carry
332 * the information required to portably record login info.
337 login_init_entry(struct logininfo *li, int pid, const char *username,
338 const char *hostname, const char *line)
342 memset(li, 0, sizeof(struct logininfo));
346 /* set the line information */
348 line_fullname(li->line, line, sizeof(li->line));
351 strlcpy(li->username, username, sizeof(li->username));
352 pw = getpwnam(li->username);
354 fatal("login_init_entry: Cannot find user \"%s\"", li->username);
355 li->uid = pw->pw_uid;
359 strlcpy(li->hostname, hostname, sizeof(li->hostname));
364 /* login_set_current_time(struct logininfo *) - set the current time
366 * Set the current time in a logininfo structure. This function is
367 * meant to eliminate the need to deal with system dependencies for
371 login_set_current_time(struct logininfo *li)
375 gettimeofday(&tv, NULL);
377 li->tv_sec = tv.tv_sec;
378 li->tv_usec = tv.tv_usec;
381 /* copy a sockaddr_* into our logininfo */
383 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
384 const unsigned int sa_size)
386 unsigned int bufsize = sa_size;
388 /* make sure we don't overrun our union */
389 if (sizeof(li->hostaddr) < sa_size)
390 bufsize = sizeof(li->hostaddr);
392 memcpy((void *)&(li->hostaddr.sa), (const void *)sa, bufsize);
397 ** login_write: Call low-level recording functions based on autoconf
401 login_write (struct logininfo *li)
403 if ((int)geteuid() != 0) {
404 log("Attempt to write login records by non-root user (aborting)");
408 /* set the timestamp */
409 login_set_current_time(li);
411 syslogin_write_entry(li);
414 if (li->type == LTYPE_LOGIN) {
415 lastlog_write_entry(li);
419 utmp_write_entry(li);
422 wtmp_write_entry(li);
425 utmpx_write_entry(li);
428 wtmpx_write_entry(li);
434 ** getlast_entry: Call low-level functions to retrieve the last login
438 /* take the uid in li and return the last login time */
440 getlast_entry(struct logininfo *li)
443 return(lastlog_get_entry(li));
444 #else /* !USE_LASTLOG */
446 #ifdef DISABLE_LASTLOG
447 /* On some systems we shouldn't even try to obtain last login
450 # else /* DISABLE_LASTLOG */
451 /* Try to retrieve the last login time from wtmp */
452 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
453 /* retrieve last login time from utmp */
454 return (wtmp_get_entry(li));
455 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
456 /* If wtmp isn't available, try wtmpx */
457 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
458 /* retrieve last login time from utmpx */
459 return (wtmpx_get_entry(li));
461 /* Give up: No means of retrieving last login time */
463 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
464 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
465 # endif /* DISABLE_LASTLOG */
466 #endif /* USE_LASTLOG */
472 * 'line' string utility functions
474 * These functions process the 'line' string into one of three forms:
476 * 1. The full filename (including '/dev')
477 * 2. The stripped name (excluding '/dev')
478 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
479 * /dev/pts/1 -> ts/1 )
481 * Form 3 is used on some systems to identify a .tmp.? entry when
482 * attempting to remove it. Typically both addition and removal is
483 * performed by one application - say, sshd - so as long as the choice
484 * uniquely identifies a terminal it's ok.
488 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
489 * sure dst has enough space, if not just copy src (ugh) */
491 line_fullname(char *dst, const char *src, int dstsize)
493 memset(dst, '\0', dstsize);
494 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
495 strlcpy(dst, src, dstsize);
497 strlcpy(dst, "/dev/", dstsize);
498 strlcat(dst, src, dstsize);
503 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
505 line_stripname(char *dst, const char *src, int dstsize)
507 memset(dst, '\0', dstsize);
508 if (strncmp(src, "/dev/", 5) == 0)
509 strlcpy(dst, &src[5], dstsize);
511 strlcpy(dst, src, dstsize);
515 /* line_abbrevname(): Return the abbreviated (usually four-character)
516 * form of the line (Just use the last <dstsize> characters of the
519 * NOTE: use strncpy because we do NOT necessarily want zero
522 line_abbrevname(char *dst, const char *src, int dstsize)
526 memset(dst, '\0', dstsize);
528 /* Always skip prefix if present */
529 if (strncmp(src, "/dev/", 5) == 0)
535 if (((int)len - dstsize) > 0)
536 src += ((int)len - dstsize);
538 /* note: _don't_ change this to strlcpy */
539 strncpy(dst, src, (size_t)dstsize);
546 ** utmp utility functions
548 ** These functions manipulate struct utmp, taking system differences
552 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
554 /* build the utmp structure */
556 set_utmp_time(struct logininfo *li, struct utmp *ut)
558 # ifdef HAVE_TV_IN_UTMP
559 ut->ut_tv.tv_sec = li->tv_sec;
560 ut->ut_tv.tv_usec = li->tv_usec;
562 # ifdef HAVE_TIME_IN_UTMP
563 ut->ut_time = li->tv_sec;
569 construct_utmp(struct logininfo *li,
572 memset(ut, '\0', sizeof(struct utmp));
574 /* First fill out fields used for both logins and logouts */
576 # ifdef HAVE_ID_IN_UTMP
577 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
580 # ifdef HAVE_TYPE_IN_UTMP
581 /* This is done here to keep utmp constants out of struct logininfo */
584 ut->ut_type = USER_PROCESS;
587 ut->ut_type = DEAD_PROCESS;
591 set_utmp_time(li, ut);
593 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
595 # ifdef HAVE_PID_IN_UTMP
596 ut->ut_pid = li->pid;
599 /* If we're logging out, leave all other fields blank */
600 if (li->type == LTYPE_LOGOUT)
604 * These fields are only used when logging in, and are blank
608 /* Use strncpy because we don't necessarily want null termination */
609 strncpy(ut->ut_name, li->username, MIN_SIZEOF(ut->ut_name, li->username));
610 # ifdef HAVE_HOST_IN_UTMP
611 strncpy(ut->ut_host, li->hostname, MIN_SIZEOF(ut->ut_host, li->hostname));
613 # ifdef HAVE_ADDR_IN_UTMP
614 /* this is just a 32-bit IP address */
615 if (li->hostaddr.sa.sa_family == AF_INET)
616 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
619 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
622 ** utmpx utility functions
624 ** These functions manipulate struct utmpx, accounting for system
628 #if defined(USE_UTMPX) || defined (USE_WTMPX)
629 /* build the utmpx structure */
631 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
633 # ifdef HAVE_TV_IN_UTMPX
634 utx->ut_tv.tv_sec = li->tv_sec;
635 utx->ut_tv.tv_usec = li->tv_usec;
636 # else /* HAVE_TV_IN_UTMPX */
637 # ifdef HAVE_TIME_IN_UTMPX
638 utx->ut_time = li->tv_sec;
639 # endif /* HAVE_TIME_IN_UTMPX */
640 # endif /* HAVE_TV_IN_UTMPX */
644 construct_utmpx(struct logininfo *li, struct utmpx *utx)
646 memset(utx, '\0', sizeof(struct utmpx));
647 # ifdef HAVE_ID_IN_UTMPX
648 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
651 /* this is done here to keep utmp constants out of loginrec.h */
654 utx->ut_type = USER_PROCESS;
657 utx->ut_type = DEAD_PROCESS;
660 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
661 set_utmpx_time(li, utx);
662 utx->ut_pid = li->pid;
664 if (li->type == LTYPE_LOGOUT)
668 * These fields are only used when logging in, and are blank
672 /* strncpy(): Don't necessarily want null termination */
673 strncpy(utx->ut_name, li->username, MIN_SIZEOF(utx->ut_name, li->username));
674 # ifdef HAVE_HOST_IN_UTMPX
675 strncpy(utx->ut_host, li->hostname, MIN_SIZEOF(utx->ut_host, li->hostname));
677 # ifdef HAVE_ADDR_IN_UTMPX
678 /* FIXME: (ATL) not supported yet */
680 # ifdef HAVE_SYSLEN_IN_UTMPX
681 /* ut_syslen is the length of the utx_host string */
682 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
685 #endif /* USE_UTMPX || USE_WTMPX */
688 ** Low-level utmp functions
691 /* FIXME: (ATL) utmp_write_direct needs testing */
694 /* if we can, use pututline() etc. */
695 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
696 defined(HAVE_PUTUTLINE)
697 # define UTMP_USE_LIBRARY
701 /* write a utmp entry with the system's help (pututline() and pals) */
702 # ifdef UTMP_USE_LIBRARY
704 utmp_write_library(struct logininfo *li, struct utmp *ut)
709 # ifdef HAVE_ENDUTENT
714 # else /* UTMP_USE_LIBRARY */
716 /* write a utmp entry direct to the file */
717 /* This is a slightly modification of code in OpenBSD's login.c */
719 utmp_write_direct(struct logininfo *li, struct utmp *ut)
725 /* FIXME: (ATL) ttyslot() needs local implementation */
726 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
728 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
729 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
731 * Prevent luser from zero'ing out ut_host.
732 * If the new ut_line is empty but the old one is not
733 * and ut_line and ut_name match, preserve the old ut_line.
735 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
736 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
737 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
738 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0)) {
739 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
742 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
743 if (atomicio(write, fd, ut, sizeof(ut)) != sizeof(ut))
744 log("utmp_write_direct: error writing %s: %s",
745 UTMP_FILE, strerror(errno));
753 # endif /* UTMP_USE_LIBRARY */
756 utmp_perform_login(struct logininfo *li)
760 construct_utmp(li, &ut);
761 # ifdef UTMP_USE_LIBRARY
762 if (!utmp_write_library(li, &ut)) {
763 log("utmp_perform_login: utmp_write_library() failed");
767 if (!utmp_write_direct(li, &ut)) {
768 log("utmp_perform_login: utmp_write_direct() failed");
777 utmp_perform_logout(struct logininfo *li)
781 construct_utmp(li, &ut);
782 # ifdef UTMP_USE_LIBRARY
783 if (!utmp_write_library(li, &ut)) {
784 log("utmp_perform_logout: utmp_write_library() failed");
788 if (!utmp_write_direct(li, &ut)) {
789 log("utmp_perform_logout: utmp_write_direct() failed");
798 utmp_write_entry(struct logininfo *li)
802 return utmp_perform_login(li);
805 return utmp_perform_logout(li);
808 log("utmp_write_entry: invalid type field");
812 #endif /* USE_UTMP */
816 ** Low-level utmpx functions
819 /* not much point if we don't want utmpx entries */
822 /* if we have the wherewithall, use pututxline etc. */
823 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
824 defined(HAVE_PUTUTXLINE)
825 # define UTMPX_USE_LIBRARY
829 /* write a utmpx entry with the system's help (pututxline() and pals) */
830 # ifdef UTMPX_USE_LIBRARY
832 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
837 # ifdef HAVE_ENDUTXENT
843 # else /* UTMPX_USE_LIBRARY */
845 /* write a utmp entry direct to the file */
847 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
849 log("utmpx_write_direct: not implemented!");
852 # endif /* UTMPX_USE_LIBRARY */
855 utmpx_perform_login(struct logininfo *li)
859 construct_utmpx(li, &utx);
860 # ifdef UTMPX_USE_LIBRARY
861 if (!utmpx_write_library(li, &utx)) {
862 log("utmpx_perform_login: utmp_write_library() failed");
866 if (!utmpx_write_direct(li, &ut)) {
867 log("utmpx_perform_login: utmp_write_direct() failed");
876 utmpx_perform_logout(struct logininfo *li)
880 memset(&utx, '\0', sizeof(utx));
881 set_utmpx_time(li, &utx);
882 line_stripname(utx.ut_line, li->line, sizeof(utx.ut_line));
883 # ifdef HAVE_ID_IN_UTMPX
884 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
886 # ifdef HAVE_TYPE_IN_UTMPX
887 utx.ut_type = DEAD_PROCESS;
890 # ifdef UTMPX_USE_LIBRARY
891 utmpx_write_library(li, &utx);
893 utmpx_write_direct(li, &utx);
899 utmpx_write_entry(struct logininfo *li)
903 return utmpx_perform_login(li);
905 return utmpx_perform_logout(li);
907 log("utmpx_write_entry: invalid type field");
911 #endif /* USE_UTMPX */
915 ** Low-level wtmp functions
920 /* write a wtmp entry direct to the end of the file */
921 /* This is a slight modification of code in OpenBSD's logwtmp.c */
923 wtmp_write(struct logininfo *li, struct utmp *ut)
928 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
929 log("wtmp_write: problem writing %s: %s",
930 WTMP_FILE, strerror(errno));
933 if (fstat(fd, &buf) == 0)
934 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
935 ftruncate(fd, buf.st_size);
936 log("wtmp_write: problem writing %s: %s",
937 WTMP_FILE, strerror(errno));
945 wtmp_perform_login(struct logininfo *li)
949 construct_utmp(li, &ut);
950 return wtmp_write(li, &ut);
955 wtmp_perform_logout(struct logininfo *li)
959 construct_utmp(li, &ut);
960 return wtmp_write(li, &ut);
965 wtmp_write_entry(struct logininfo *li)
969 return wtmp_perform_login(li);
971 return wtmp_perform_logout(li);
973 log("wtmp_write_entry: invalid type field");
979 /* Notes on fetching login data from wtmp/wtmpx
981 * Logouts are usually recorded with (amongst other things) a blank
982 * username on a given tty line. However, some systems (HP-UX is one)
983 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
985 * Since we're only looking for logins here, we know that the username
986 * must be set correctly. On systems that leave it in, we check for
987 * ut_type==USER_PROCESS (indicating a login.)
989 * Portability: Some systems may set something other than USER_PROCESS
990 * to indicate a login process. I don't know of any as I write. Also,
991 * it's possible that some systems may both leave the username in
992 * place and not have ut_type.
995 /* return true if this wtmp entry indicates a login */
997 wtmp_islogin(struct logininfo *li, struct utmp *ut)
999 if (strncmp(li->username, ut->ut_name,
1000 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1001 # ifdef HAVE_TYPE_IN_UTMP
1002 if (ut->ut_type & USER_PROCESS)
1012 wtmp_get_entry(struct logininfo *li)
1018 /* Clear the time entries in our logininfo */
1019 li->tv_sec = li->tv_usec = 0;
1021 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1022 log("wtmp_get_entry: problem opening %s: %s",
1023 WTMP_FILE, strerror(errno));
1026 if (fstat(fd, &st) != 0) {
1027 log("wtmp_get_entry: couldn't stat %s: %s",
1028 WTMP_FILE, strerror(errno));
1033 /* Seek to the start of the last struct utmp */
1034 if (lseek(fd, (off_t)(0-sizeof(struct utmp)), SEEK_END) == -1) {
1035 /* Looks like we've got a fresh wtmp file */
1041 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1042 log("wtmp_get_entry: read of %s failed: %s",
1043 WTMP_FILE, strerror(errno));
1047 if ( wtmp_islogin(li, &ut) ) {
1049 /* We've already checked for a time in struct
1050 * utmp, in login_getlast(). */
1051 # ifdef HAVE_TIME_IN_UTMP
1052 li->tv_sec = ut.ut_time;
1054 # if HAVE_TV_IN_UTMP
1055 li->tv_sec = ut.ut_tv.tv_sec;
1058 line_fullname(li->line, ut.ut_line,
1059 MIN_SIZEOF(li->line, ut.ut_line));
1060 # ifdef HAVE_HOST_IN_UTMP
1061 strlcpy(li->hostname, ut.ut_host,
1062 MIN_SIZEOF(li->hostname, ut.ut_host));
1066 /* Seek back 2 x struct utmp */
1067 if (lseek(fd, (off_t)(0-2*sizeof(struct utmp)), SEEK_CUR) == -1) {
1068 /* We've found the start of the file, so quit */
1074 /* We found an entry. Tidy up and return */
1078 # endif /* USE_WTMP */
1082 ** Low-level wtmpx functions
1086 /* write a wtmpx entry direct to the end of the file */
1087 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1089 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1094 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1095 log("wtmpx_write: problem opening %s: %s",
1096 WTMPX_FILE, strerror(errno));
1100 if (fstat(fd, &buf) == 0)
1101 if (atomicio(write, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1102 ftruncate(fd, buf.st_size);
1103 log("wtmpx_write: problem writing %s: %s",
1104 WTMPX_FILE, strerror(errno));
1114 wtmpx_perform_login(struct logininfo *li)
1118 construct_utmpx(li, &utx);
1119 return wtmpx_write(li, &utx);
1124 wtmpx_perform_logout(struct logininfo *li)
1128 construct_utmpx(li, &utx);
1129 return wtmpx_write(li, &utx);
1134 wtmpx_write_entry(struct logininfo *li)
1138 return wtmpx_perform_login(li);
1140 return wtmpx_perform_logout(li);
1142 log("wtmpx_write_entry: invalid type field");
1147 /* Please see the notes above wtmp_islogin() for information about the
1148 next two functions */
1150 /* Return true if this wtmpx entry indicates a login */
1152 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1154 if ( strncmp(li->username, utx->ut_name,
1155 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1156 # ifdef HAVE_TYPE_IN_UTMPX
1157 if (utx->ut_type == USER_PROCESS)
1168 wtmpx_get_entry(struct logininfo *li)
1174 /* Clear the time entries */
1175 li->tv_sec = li->tv_usec = 0;
1177 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1178 log("wtmpx_get_entry: problem opening %s: %s",
1179 WTMPX_FILE, strerror(errno));
1182 if (fstat(fd, &st) != 0) {
1183 log("wtmpx_get_entry: couldn't stat %s: %s",
1184 WTMP_FILE, strerror(errno));
1189 /* Seek to the start of the last struct utmpx */
1190 if (lseek(fd, (off_t)(0-sizeof(struct utmpx)), SEEK_END) == -1 ) {
1191 /* probably a newly rotated wtmpx file */
1197 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1198 log("wtmpx_get_entry: read of %s failed: %s",
1199 WTMPX_FILE, strerror(errno));
1203 /* Logouts are recorded as a blank username on a particular line.
1204 * So, we just need to find the username in struct utmpx */
1205 if ( wtmpx_islogin(li, &utx) ) {
1206 # ifdef HAVE_TV_IN_UTMPX
1207 li->tv_sec = utx.ut_tv.tv_sec;
1209 # ifdef HAVE_TIME_IN_UTMPX
1210 li->tv_sec = utx.ut_time;
1213 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1214 # ifdef HAVE_HOST_IN_UTMPX
1215 strlcpy(li->hostname, utx.ut_host,
1216 MIN_SIZEOF(li->hostname, utx.ut_host));
1220 if (lseek(fd, (off_t)(0-2*sizeof(struct utmpx)), SEEK_CUR) == -1) {
1229 #endif /* USE_WTMPX */
1232 ** Low-level libutil login() functions
1237 syslogin_perform_login(struct logininfo *li)
1241 if (! (ut = (struct utmp *)malloc(sizeof(struct utmp)))) {
1242 log("syslogin_perform_login: couldn't malloc()");
1245 construct_utmp(li, ut);
1252 syslogin_perform_logout(struct logininfo *li)
1257 (void)line_stripname(line, li->line, sizeof(line));
1259 if (!logout(line)) {
1260 log("syslogin_perform_logout: logout() returned an error");
1261 # ifdef HAVE_LOGWTMP
1263 logwtmp(line, "", "");
1266 /* FIXME: (ATL - if the need arises) What to do if we have
1267 * login, but no logout? what if logout but no logwtmp? All
1268 * routines are in libutil so they should all be there,
1275 syslogin_write_entry(struct logininfo *li)
1279 return syslogin_perform_login(li);
1281 return syslogin_perform_logout(li);
1283 log("syslogin_write_entry: Invalid type field");
1287 #endif /* USE_LOGIN */
1289 /* end of file log-syslogin.c */
1292 ** Low-level lastlog functions
1301 lastlog_construct(struct logininfo *li, struct lastlog *last)
1303 /* clear the structure */
1304 memset(last, '\0', sizeof(struct lastlog));
1306 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1307 strlcpy(last->ll_host, li->hostname,
1308 MIN_SIZEOF(last->ll_host, li->hostname));
1309 last->ll_time = li->tv_sec;
1313 lastlog_filetype(char *filename)
1317 if (stat(LASTLOG_FILE, &st) != 0) {
1318 log("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1322 if (S_ISDIR(st.st_mode))
1324 else if (S_ISREG(st.st_mode))
1331 /* open the file (using filemode) and seek to the login entry */
1333 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1337 char lastlog_file[1024];
1339 type = lastlog_filetype(LASTLOG_FILE);
1342 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1345 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1346 LASTLOG_FILE, li->username);
1349 log("lastlog_openseek: %.100s is not a file or directory!",
1354 *fd = open(lastlog_file, filemode);
1356 debug("lastlog_openseek: Couldn't open %s: %s",
1357 lastlog_file, strerror(errno));
1361 /* find this uid's offset in the lastlog file */
1362 offset = (off_t) ( (long)li->uid * sizeof(struct lastlog));
1364 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1365 log("lastlog_openseek: %s->lseek(): %s",
1366 lastlog_file, strerror(errno));
1373 lastlog_perform_login(struct logininfo *li)
1375 struct lastlog last;
1378 /* create our struct lastlog */
1379 lastlog_construct(li, &last);
1381 /* write the entry */
1382 if (lastlog_openseek(li, &fd, O_RDWR|O_CREAT)) {
1383 if (atomicio(write, fd, &last, sizeof(last)) != sizeof(last)) {
1384 log("lastlog_write_filemode: Error writing to %s: %s",
1385 LASTLOG_FILE, strerror(errno));
1395 lastlog_write_entry(struct logininfo *li)
1399 return lastlog_perform_login(li);
1401 log("lastlog_write_entry: Invalid type field");
1407 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1409 line_fullname(li->line, last->ll_line, sizeof(li->line));
1410 strlcpy(li->hostname, last->ll_host,
1411 MIN_SIZEOF(li->hostname, last->ll_host));
1412 li->tv_sec = last->ll_time;
1416 lastlog_get_entry(struct logininfo *li)
1418 struct lastlog last;
1421 if (lastlog_openseek(li, &fd, O_RDONLY)) {
1422 if (atomicio(read, fd, &last, sizeof(last)) != sizeof(last)) {
1423 log("lastlog_get_entry: Error reading from %s: %s",
1424 LASTLOG_FILE, strerror(errno));
1427 lastlog_populate_entry(li, &last);
1434 #endif /* USE_LASTLOG */