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()
142 ** Linux (Redhat 6.2, Debian)
144 ** HP-UX 10.20 (gcc only)
146 ** NeXT - M68k/HPPA (4.2/3.3)
148 ** Testing required: Please send reports!
153 ** Platforms with known problems:
154 ** Some variants of Slackware Linux
158 #include "includes.h"
162 #include "loginrec.h"
167 ** prototypes for helper functions in this file
171 void set_utmp_time(struct logininfo *li, struct utmp *ut);
172 void construct_utmp(struct logininfo *li, struct utmp *ut);
176 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
177 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
180 int utmp_write_entry(struct logininfo *li);
181 int utmpx_write_entry(struct logininfo *li);
182 int wtmp_write_entry(struct logininfo *li);
183 int wtmpx_write_entry(struct logininfo *li);
184 int lastlog_write_entry(struct logininfo *li);
185 int syslogin_write_entry(struct logininfo *li);
187 int getlast_entry(struct logininfo *li);
188 int lastlog_get_entry(struct logininfo *li);
189 int wtmp_get_entry(struct logininfo *li);
190 int wtmpx_get_entry(struct logininfo *li);
192 /* pick the shortest string */
193 #define MIN_SIZEOF(s1,s2) ( sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2) )
196 ** platform-independent login functions
199 /* login_login(struct logininfo *) -Record a login
201 * Call with a pointer to a struct logininfo initialised with
202 * login_init_entry() or login_alloc_entry()
206 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
209 login_login (struct logininfo *li)
211 li->type = LTYPE_LOGIN;
212 return login_write(li);
216 /* login_logout(struct logininfo *) - Record a logout
218 * Call as with login_login()
222 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
225 login_logout(struct logininfo *li)
227 li->type = LTYPE_LOGOUT;
228 return login_write(li);
231 /* login_get_lastlog_time(int) - Retrieve the last login time
233 * Retrieve the last login time for the given uid. Will try to use the
234 * system lastlog facilities if they are available, but will fall back
235 * to looking in wtmp/wtmpx if necessary
238 * 0 on failure, or if user has never logged in
239 * Time in seconds from the epoch if successful
241 * Useful preprocessor symbols:
242 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
244 * USE_LASTLOG: If set, indicates the presence of system lastlog
245 * facilities. If this and DISABLE_LASTLOG are not set,
246 * try to retrieve lastlog information from wtmp/wtmpx.
249 login_get_lastlog_time(const int uid)
253 if (login_get_lastlog(&li, uid))
259 /* login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
261 * Retrieve a logininfo structure populated (only partially) with
262 * information from the system lastlog data, or from wtmp/wtmpx if no
263 * system lastlog information exists.
265 * Note this routine must be given a pre-allocated logininfo.
268 * >0: A pointer to your struct logininfo if successful
269 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
273 login_get_lastlog(struct logininfo *li, const int uid)
277 memset(li, '\0', sizeof(*li));
281 * If we don't have a 'real' lastlog, we need the username to
282 * reliably search wtmp(x) for the last login (see
287 fatal("login_get_lastlog: Cannot find account for uid %i", uid);
289 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
291 strlcpy(li->username, pw->pw_name, sizeof(li->username));
293 if (getlast_entry(li))
300 /* login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
301 * a logininfo structure
303 * This function creates a new struct logininfo, a data structure
304 * meant to carry the information required to portably record login info.
306 * Returns a pointer to a newly created struct logininfo. If memory
307 * allocation fails, the program halts.
310 logininfo *login_alloc_entry(int pid, const char *username,
311 const char *hostname, const char *line)
313 struct logininfo *newli;
315 newli = (struct logininfo *) xmalloc (sizeof(*newli));
316 (void)login_init_entry(newli, pid, username, hostname, line);
321 /* login_free_entry(struct logininfo *) - free struct memory */
323 login_free_entry(struct logininfo *li)
329 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
330 * - initialise a struct logininfo
332 * Populates a new struct logininfo, a data structure meant to carry
333 * the information required to portably record login info.
338 login_init_entry(struct logininfo *li, int pid, const char *username,
339 const char *hostname, const char *line)
343 memset(li, 0, sizeof(*li));
347 /* set the line information */
349 line_fullname(li->line, line, sizeof(li->line));
352 strlcpy(li->username, username, sizeof(li->username));
353 pw = getpwnam(li->username);
355 fatal("login_init_entry: Cannot find user \"%s\"", li->username);
356 li->uid = pw->pw_uid;
360 strlcpy(li->hostname, hostname, sizeof(li->hostname));
365 /* login_set_current_time(struct logininfo *) - set the current time
367 * Set the current time in a logininfo structure. This function is
368 * meant to eliminate the need to deal with system dependencies for
372 login_set_current_time(struct logininfo *li)
376 gettimeofday(&tv, NULL);
378 li->tv_sec = tv.tv_sec;
379 li->tv_usec = tv.tv_usec;
382 /* copy a sockaddr_* into our logininfo */
384 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
385 const unsigned int sa_size)
387 unsigned int bufsize = sa_size;
389 /* make sure we don't overrun our union */
390 if (sizeof(li->hostaddr) < sa_size)
391 bufsize = sizeof(li->hostaddr);
393 memcpy((void *)&(li->hostaddr.sa), (const void *)sa, bufsize);
398 ** login_write: Call low-level recording functions based on autoconf
402 login_write (struct logininfo *li)
405 if ((int)geteuid() != 0) {
406 log("Attempt to write login records by non-root user (aborting)");
411 /* set the timestamp */
412 login_set_current_time(li);
414 syslogin_write_entry(li);
417 if (li->type == LTYPE_LOGIN) {
418 lastlog_write_entry(li);
422 utmp_write_entry(li);
425 wtmp_write_entry(li);
428 utmpx_write_entry(li);
431 wtmpx_write_entry(li);
437 ** getlast_entry: Call low-level functions to retrieve the last login
441 /* take the uid in li and return the last login time */
443 getlast_entry(struct logininfo *li)
446 return(lastlog_get_entry(li));
447 #else /* !USE_LASTLOG */
449 #ifdef DISABLE_LASTLOG
450 /* On some systems we shouldn't even try to obtain last login
453 # else /* DISABLE_LASTLOG */
454 /* Try to retrieve the last login time from wtmp */
455 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
456 /* retrieve last login time from utmp */
457 return (wtmp_get_entry(li));
458 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
459 /* If wtmp isn't available, try wtmpx */
460 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
461 /* retrieve last login time from utmpx */
462 return (wtmpx_get_entry(li));
464 /* Give up: No means of retrieving last login time */
466 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
467 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
468 # endif /* DISABLE_LASTLOG */
469 #endif /* USE_LASTLOG */
475 * 'line' string utility functions
477 * These functions process the 'line' string into one of three forms:
479 * 1. The full filename (including '/dev')
480 * 2. The stripped name (excluding '/dev')
481 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
482 * /dev/pts/1 -> ts/1 )
484 * Form 3 is used on some systems to identify a .tmp.? entry when
485 * attempting to remove it. Typically both addition and removal is
486 * performed by one application - say, sshd - so as long as the choice
487 * uniquely identifies a terminal it's ok.
491 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
492 * sure dst has enough space, if not just copy src (ugh) */
494 line_fullname(char *dst, const char *src, int dstsize)
496 memset(dst, '\0', dstsize);
497 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
498 strlcpy(dst, src, dstsize);
500 strlcpy(dst, "/dev/", dstsize);
501 strlcat(dst, src, dstsize);
506 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
508 line_stripname(char *dst, const char *src, int dstsize)
510 memset(dst, '\0', dstsize);
511 if (strncmp(src, "/dev/", 5) == 0)
512 strlcpy(dst, &src[5], dstsize);
514 strlcpy(dst, src, dstsize);
518 /* line_abbrevname(): Return the abbreviated (usually four-character)
519 * form of the line (Just use the last <dstsize> characters of the
522 * NOTE: use strncpy because we do NOT necessarily want zero
525 line_abbrevname(char *dst, const char *src, int dstsize)
529 memset(dst, '\0', dstsize);
531 /* Always skip prefix if present */
532 if (strncmp(src, "/dev/", 5) == 0)
538 if (((int)len - dstsize) > 0)
539 src += ((int)len - dstsize);
541 /* note: _don't_ change this to strlcpy */
542 strncpy(dst, src, (size_t)dstsize);
549 ** utmp utility functions
551 ** These functions manipulate struct utmp, taking system differences
555 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
557 /* build the utmp structure */
559 set_utmp_time(struct logininfo *li, struct utmp *ut)
561 # ifdef HAVE_TV_IN_UTMP
562 ut->ut_tv.tv_sec = li->tv_sec;
563 ut->ut_tv.tv_usec = li->tv_usec;
565 # ifdef HAVE_TIME_IN_UTMP
566 ut->ut_time = li->tv_sec;
572 construct_utmp(struct logininfo *li,
575 memset(ut, '\0', sizeof(*ut));
577 /* First fill out fields used for both logins and logouts */
579 # ifdef HAVE_ID_IN_UTMP
580 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
583 # ifdef HAVE_TYPE_IN_UTMP
584 /* This is done here to keep utmp constants out of struct logininfo */
587 ut->ut_type = USER_PROCESS;
590 ut->ut_type = DEAD_PROCESS;
594 set_utmp_time(li, ut);
596 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
598 # ifdef HAVE_PID_IN_UTMP
599 ut->ut_pid = li->pid;
602 /* If we're logging out, leave all other fields blank */
603 if (li->type == LTYPE_LOGOUT)
607 * These fields are only used when logging in, and are blank
611 /* Use strncpy because we don't necessarily want null termination */
612 strncpy(ut->ut_name, li->username, MIN_SIZEOF(ut->ut_name, li->username));
613 # ifdef HAVE_HOST_IN_UTMP
614 strncpy(ut->ut_host, li->hostname, MIN_SIZEOF(ut->ut_host, li->hostname));
616 # ifdef HAVE_ADDR_IN_UTMP
617 /* this is just a 32-bit IP address */
618 if (li->hostaddr.sa.sa_family == AF_INET)
619 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
622 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
625 ** utmpx utility functions
627 ** These functions manipulate struct utmpx, accounting for system
631 #if defined(USE_UTMPX) || defined (USE_WTMPX)
632 /* build the utmpx structure */
634 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
636 # ifdef HAVE_TV_IN_UTMPX
637 utx->ut_tv.tv_sec = li->tv_sec;
638 utx->ut_tv.tv_usec = li->tv_usec;
639 # else /* HAVE_TV_IN_UTMPX */
640 # ifdef HAVE_TIME_IN_UTMPX
641 utx->ut_time = li->tv_sec;
642 # endif /* HAVE_TIME_IN_UTMPX */
643 # endif /* HAVE_TV_IN_UTMPX */
647 construct_utmpx(struct logininfo *li, struct utmpx *utx)
649 memset(utx, '\0', sizeof(*utx));
650 # ifdef HAVE_ID_IN_UTMPX
651 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
654 /* this is done here to keep utmp constants out of loginrec.h */
657 utx->ut_type = USER_PROCESS;
660 utx->ut_type = DEAD_PROCESS;
663 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
664 set_utmpx_time(li, utx);
665 utx->ut_pid = li->pid;
667 if (li->type == LTYPE_LOGOUT)
671 * These fields are only used when logging in, and are blank
675 /* strncpy(): Don't necessarily want null termination */
676 strncpy(utx->ut_name, li->username, MIN_SIZEOF(utx->ut_name, li->username));
677 # ifdef HAVE_HOST_IN_UTMPX
678 strncpy(utx->ut_host, li->hostname, MIN_SIZEOF(utx->ut_host, li->hostname));
680 # ifdef HAVE_ADDR_IN_UTMPX
681 /* this is just a 32-bit IP address */
682 if (li->hostaddr.sa.sa_family == AF_INET)
683 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
685 # ifdef HAVE_SYSLEN_IN_UTMPX
686 /* ut_syslen is the length of the utx_host string */
687 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
690 #endif /* USE_UTMPX || USE_WTMPX */
693 ** Low-level utmp functions
696 /* FIXME: (ATL) utmp_write_direct needs testing */
699 /* if we can, use pututline() etc. */
700 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
701 defined(HAVE_PUTUTLINE)
702 # define UTMP_USE_LIBRARY
706 /* write a utmp entry with the system's help (pututline() and pals) */
707 # ifdef UTMP_USE_LIBRARY
709 utmp_write_library(struct logininfo *li, struct utmp *ut)
714 # ifdef HAVE_ENDUTENT
719 # else /* UTMP_USE_LIBRARY */
721 /* write a utmp entry direct to the file */
722 /* This is a slightly modification of code in OpenBSD's login.c */
724 utmp_write_direct(struct logininfo *li, struct utmp *ut)
730 /* FIXME: (ATL) ttyslot() needs local implementation */
732 #if defined(HAVE_GETTTYENT)
733 register struct ttyent *ty;
738 while ((struct ttyent *)0 != (ty = getttyent())) {
740 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
745 if((struct ttyent *)0 == ty) {
746 log("utmp_write_entry: tty not found");
751 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
753 #endif /* HAVE_GETTTYENT */
755 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
756 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
758 * Prevent luser from zero'ing out ut_host.
759 * If the new ut_line is empty but the old one is not
760 * and ut_line and ut_name match, preserve the old ut_line.
762 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
763 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
764 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
765 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0)) {
766 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
769 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
770 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut))
771 log("utmp_write_direct: error writing %s: %s",
772 UTMP_FILE, strerror(errno));
780 # endif /* UTMP_USE_LIBRARY */
783 utmp_perform_login(struct logininfo *li)
787 construct_utmp(li, &ut);
788 # ifdef UTMP_USE_LIBRARY
789 if (!utmp_write_library(li, &ut)) {
790 log("utmp_perform_login: utmp_write_library() failed");
794 if (!utmp_write_direct(li, &ut)) {
795 log("utmp_perform_login: utmp_write_direct() failed");
804 utmp_perform_logout(struct logininfo *li)
808 construct_utmp(li, &ut);
809 # ifdef UTMP_USE_LIBRARY
810 if (!utmp_write_library(li, &ut)) {
811 log("utmp_perform_logout: utmp_write_library() failed");
815 if (!utmp_write_direct(li, &ut)) {
816 log("utmp_perform_logout: utmp_write_direct() failed");
825 utmp_write_entry(struct logininfo *li)
829 return utmp_perform_login(li);
832 return utmp_perform_logout(li);
835 log("utmp_write_entry: invalid type field");
839 #endif /* USE_UTMP */
843 ** Low-level utmpx functions
846 /* not much point if we don't want utmpx entries */
849 /* if we have the wherewithall, use pututxline etc. */
850 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
851 defined(HAVE_PUTUTXLINE)
852 # define UTMPX_USE_LIBRARY
856 /* write a utmpx entry with the system's help (pututxline() and pals) */
857 # ifdef UTMPX_USE_LIBRARY
859 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
864 # ifdef HAVE_ENDUTXENT
870 # else /* UTMPX_USE_LIBRARY */
872 /* write a utmp entry direct to the file */
874 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
876 log("utmpx_write_direct: not implemented!");
879 # endif /* UTMPX_USE_LIBRARY */
882 utmpx_perform_login(struct logininfo *li)
886 construct_utmpx(li, &utx);
887 # ifdef UTMPX_USE_LIBRARY
888 if (!utmpx_write_library(li, &utx)) {
889 log("utmpx_perform_login: utmp_write_library() failed");
893 if (!utmpx_write_direct(li, &ut)) {
894 log("utmpx_perform_login: utmp_write_direct() failed");
903 utmpx_perform_logout(struct logininfo *li)
907 memset(&utx, '\0', sizeof(utx));
908 set_utmpx_time(li, &utx);
909 line_stripname(utx.ut_line, li->line, sizeof(utx.ut_line));
910 # ifdef HAVE_ID_IN_UTMPX
911 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
913 # ifdef HAVE_TYPE_IN_UTMPX
914 utx.ut_type = DEAD_PROCESS;
917 # ifdef UTMPX_USE_LIBRARY
918 utmpx_write_library(li, &utx);
920 utmpx_write_direct(li, &utx);
926 utmpx_write_entry(struct logininfo *li)
930 return utmpx_perform_login(li);
932 return utmpx_perform_logout(li);
934 log("utmpx_write_entry: invalid type field");
938 #endif /* USE_UTMPX */
942 ** Low-level wtmp functions
947 /* write a wtmp entry direct to the end of the file */
948 /* This is a slight modification of code in OpenBSD's logwtmp.c */
950 wtmp_write(struct logininfo *li, struct utmp *ut)
955 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
956 log("wtmp_write: problem writing %s: %s",
957 WTMP_FILE, strerror(errno));
960 if (fstat(fd, &buf) == 0)
961 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
962 ftruncate(fd, buf.st_size);
963 log("wtmp_write: problem writing %s: %s",
964 WTMP_FILE, strerror(errno));
972 wtmp_perform_login(struct logininfo *li)
976 construct_utmp(li, &ut);
977 return wtmp_write(li, &ut);
982 wtmp_perform_logout(struct logininfo *li)
986 construct_utmp(li, &ut);
987 return wtmp_write(li, &ut);
992 wtmp_write_entry(struct logininfo *li)
996 return wtmp_perform_login(li);
998 return wtmp_perform_logout(li);
1000 log("wtmp_write_entry: invalid type field");
1006 /* Notes on fetching login data from wtmp/wtmpx
1008 * Logouts are usually recorded with (amongst other things) a blank
1009 * username on a given tty line. However, some systems (HP-UX is one)
1010 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1012 * Since we're only looking for logins here, we know that the username
1013 * must be set correctly. On systems that leave it in, we check for
1014 * ut_type==USER_PROCESS (indicating a login.)
1016 * Portability: Some systems may set something other than USER_PROCESS
1017 * to indicate a login process. I don't know of any as I write. Also,
1018 * it's possible that some systems may both leave the username in
1019 * place and not have ut_type.
1022 /* return true if this wtmp entry indicates a login */
1024 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1026 if (strncmp(li->username, ut->ut_name,
1027 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1028 # ifdef HAVE_TYPE_IN_UTMP
1029 if (ut->ut_type & USER_PROCESS)
1039 wtmp_get_entry(struct logininfo *li)
1045 /* Clear the time entries in our logininfo */
1046 li->tv_sec = li->tv_usec = 0;
1048 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1049 log("wtmp_get_entry: problem opening %s: %s",
1050 WTMP_FILE, strerror(errno));
1053 if (fstat(fd, &st) != 0) {
1054 log("wtmp_get_entry: couldn't stat %s: %s",
1055 WTMP_FILE, strerror(errno));
1060 /* Seek to the start of the last struct utmp */
1061 if (lseek(fd, (off_t)(0 - sizeof(struct utmp)), SEEK_END) == -1) {
1062 /* Looks like we've got a fresh wtmp file */
1068 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1069 log("wtmp_get_entry: read of %s failed: %s",
1070 WTMP_FILE, strerror(errno));
1074 if ( wtmp_islogin(li, &ut) ) {
1076 /* We've already checked for a time in struct
1077 * utmp, in login_getlast(). */
1078 # ifdef HAVE_TIME_IN_UTMP
1079 li->tv_sec = ut.ut_time;
1081 # if HAVE_TV_IN_UTMP
1082 li->tv_sec = ut.ut_tv.tv_sec;
1085 line_fullname(li->line, ut.ut_line,
1086 MIN_SIZEOF(li->line, ut.ut_line));
1087 # ifdef HAVE_HOST_IN_UTMP
1088 strlcpy(li->hostname, ut.ut_host,
1089 MIN_SIZEOF(li->hostname, ut.ut_host));
1093 /* Seek back 2 x struct utmp */
1094 if (lseek(fd, (off_t)(0-2*sizeof(struct utmp)), SEEK_CUR) == -1) {
1095 /* We've found the start of the file, so quit */
1101 /* We found an entry. Tidy up and return */
1105 # endif /* USE_WTMP */
1109 ** Low-level wtmpx functions
1113 /* write a wtmpx entry direct to the end of the file */
1114 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1116 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1121 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1122 log("wtmpx_write: problem opening %s: %s",
1123 WTMPX_FILE, strerror(errno));
1127 if (fstat(fd, &buf) == 0)
1128 if (atomicio(write, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1129 ftruncate(fd, buf.st_size);
1130 log("wtmpx_write: problem writing %s: %s",
1131 WTMPX_FILE, strerror(errno));
1141 wtmpx_perform_login(struct logininfo *li)
1145 construct_utmpx(li, &utx);
1146 return wtmpx_write(li, &utx);
1151 wtmpx_perform_logout(struct logininfo *li)
1155 construct_utmpx(li, &utx);
1156 return wtmpx_write(li, &utx);
1161 wtmpx_write_entry(struct logininfo *li)
1165 return wtmpx_perform_login(li);
1167 return wtmpx_perform_logout(li);
1169 log("wtmpx_write_entry: invalid type field");
1174 /* Please see the notes above wtmp_islogin() for information about the
1175 next two functions */
1177 /* Return true if this wtmpx entry indicates a login */
1179 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1181 if ( strncmp(li->username, utx->ut_name,
1182 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1183 # ifdef HAVE_TYPE_IN_UTMPX
1184 if (utx->ut_type == USER_PROCESS)
1195 wtmpx_get_entry(struct logininfo *li)
1201 /* Clear the time entries */
1202 li->tv_sec = li->tv_usec = 0;
1204 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1205 log("wtmpx_get_entry: problem opening %s: %s",
1206 WTMPX_FILE, strerror(errno));
1209 if (fstat(fd, &st) != 0) {
1210 log("wtmpx_get_entry: couldn't stat %s: %s",
1211 WTMP_FILE, strerror(errno));
1216 /* Seek to the start of the last struct utmpx */
1217 if (lseek(fd, (off_t)(0-sizeof(struct utmpx)), SEEK_END) == -1 ) {
1218 /* probably a newly rotated wtmpx file */
1224 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1225 log("wtmpx_get_entry: read of %s failed: %s",
1226 WTMPX_FILE, strerror(errno));
1230 /* Logouts are recorded as a blank username on a particular line.
1231 * So, we just need to find the username in struct utmpx */
1232 if ( wtmpx_islogin(li, &utx) ) {
1233 # ifdef HAVE_TV_IN_UTMPX
1234 li->tv_sec = utx.ut_tv.tv_sec;
1236 # ifdef HAVE_TIME_IN_UTMPX
1237 li->tv_sec = utx.ut_time;
1240 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1241 # ifdef HAVE_HOST_IN_UTMPX
1242 strlcpy(li->hostname, utx.ut_host,
1243 MIN_SIZEOF(li->hostname, utx.ut_host));
1247 if (lseek(fd, (off_t)(0-2*sizeof(struct utmpx)), SEEK_CUR) == -1) {
1256 #endif /* USE_WTMPX */
1259 ** Low-level libutil login() functions
1264 syslogin_perform_login(struct logininfo *li)
1268 if (! (ut = (struct utmp *)malloc(sizeof(*ut)))) {
1269 log("syslogin_perform_login: couldn't malloc()");
1272 construct_utmp(li, ut);
1279 syslogin_perform_logout(struct logininfo *li)
1284 (void)line_stripname(line, li->line, sizeof(line));
1286 if (!logout(line)) {
1287 log("syslogin_perform_logout: logout() returned an error");
1288 # ifdef HAVE_LOGWTMP
1290 logwtmp(line, "", "");
1293 /* FIXME: (ATL - if the need arises) What to do if we have
1294 * login, but no logout? what if logout but no logwtmp? All
1295 * routines are in libutil so they should all be there,
1302 syslogin_write_entry(struct logininfo *li)
1306 return syslogin_perform_login(li);
1308 return syslogin_perform_logout(li);
1310 log("syslogin_write_entry: Invalid type field");
1314 #endif /* USE_LOGIN */
1316 /* end of file log-syslogin.c */
1319 ** Low-level lastlog functions
1328 lastlog_construct(struct logininfo *li, struct lastlog *last)
1330 /* clear the structure */
1331 memset(last, '\0', sizeof(*last));
1333 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1334 strlcpy(last->ll_host, li->hostname,
1335 MIN_SIZEOF(last->ll_host, li->hostname));
1336 last->ll_time = li->tv_sec;
1340 lastlog_filetype(char *filename)
1344 if (stat(LASTLOG_FILE, &st) != 0) {
1345 log("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1349 if (S_ISDIR(st.st_mode))
1351 else if (S_ISREG(st.st_mode))
1358 /* open the file (using filemode) and seek to the login entry */
1360 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1364 char lastlog_file[1024];
1366 type = lastlog_filetype(LASTLOG_FILE);
1369 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1372 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1373 LASTLOG_FILE, li->username);
1376 log("lastlog_openseek: %.100s is not a file or directory!",
1381 *fd = open(lastlog_file, filemode);
1383 debug("lastlog_openseek: Couldn't open %s: %s",
1384 lastlog_file, strerror(errno));
1388 if (type == LL_FILE) {
1389 /* find this uid's offset in the lastlog file */
1390 offset = (off_t) ( (long)li->uid * sizeof(struct lastlog));
1392 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1393 log("lastlog_openseek: %s->lseek(): %s",
1394 lastlog_file, strerror(errno));
1403 lastlog_perform_login(struct logininfo *li)
1405 struct lastlog last;
1408 /* create our struct lastlog */
1409 lastlog_construct(li, &last);
1411 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1414 /* write the entry */
1415 if (atomicio(write, fd, &last, sizeof(last)) != sizeof(last)) {
1417 log("lastlog_write_filemode: Error writing to %s: %s",
1418 LASTLOG_FILE, strerror(errno));
1427 lastlog_write_entry(struct logininfo *li)
1431 return lastlog_perform_login(li);
1433 log("lastlog_write_entry: Invalid type field");
1439 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1441 line_fullname(li->line, last->ll_line, sizeof(li->line));
1442 strlcpy(li->hostname, last->ll_host,
1443 MIN_SIZEOF(li->hostname, last->ll_host));
1444 li->tv_sec = last->ll_time;
1448 lastlog_get_entry(struct logininfo *li)
1450 struct lastlog last;
1453 if (lastlog_openseek(li, &fd, O_RDONLY)) {
1454 if (atomicio(read, fd, &last, sizeof(last)) != sizeof(last)) {
1455 log("lastlog_get_entry: Error reading from %s: %s",
1456 LASTLOG_FILE, strerror(errno));
1459 lastlog_populate_entry(li, &last);
1466 #endif /* USE_LASTLOG */