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.ac 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/Sparc (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"
164 #include "atomicio.h"
166 RCSID("$Id: loginrec.c,v 1.44 2002/09/26 00:38:49 tim Exp $");
167 RCSID("$FreeBSD: src/crypto/openssh/loginrec.c,v 1.1.1.1.2.3 2003/02/03 17:31:07 des Exp $");
168 RCSID("$DragonFly: src/crypto/openssh/Attic/loginrec.c,v 1.2 2003/06/17 04:24:36 dillon Exp $");
174 #ifdef HAVE_LIBUTIL_H
175 # include <libutil.h>
179 ** prototypes for helper functions in this file
183 void set_utmp_time(struct logininfo *li, struct utmp *ut);
184 void construct_utmp(struct logininfo *li, struct utmp *ut);
188 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
189 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
192 int utmp_write_entry(struct logininfo *li);
193 int utmpx_write_entry(struct logininfo *li);
194 int wtmp_write_entry(struct logininfo *li);
195 int wtmpx_write_entry(struct logininfo *li);
196 int lastlog_write_entry(struct logininfo *li);
197 int syslogin_write_entry(struct logininfo *li);
199 int getlast_entry(struct logininfo *li);
200 int lastlog_get_entry(struct logininfo *li);
201 int wtmp_get_entry(struct logininfo *li);
202 int wtmpx_get_entry(struct logininfo *li);
204 /* pick the shortest string */
205 #define MIN_SIZEOF(s1,s2) ( sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2) )
208 ** platform-independent login functions
211 /* login_login(struct logininfo *) -Record a login
213 * Call with a pointer to a struct logininfo initialised with
214 * login_init_entry() or login_alloc_entry()
218 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
221 login_login (struct logininfo *li)
223 li->type = LTYPE_LOGIN;
224 return login_write(li);
228 /* login_logout(struct logininfo *) - Record a logout
230 * Call as with login_login()
234 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
237 login_logout(struct logininfo *li)
239 li->type = LTYPE_LOGOUT;
240 return login_write(li);
243 /* login_get_lastlog_time(int) - Retrieve the last login time
245 * Retrieve the last login time for the given uid. Will try to use the
246 * system lastlog facilities if they are available, but will fall back
247 * to looking in wtmp/wtmpx if necessary
250 * 0 on failure, or if user has never logged in
251 * Time in seconds from the epoch if successful
253 * Useful preprocessor symbols:
254 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
256 * USE_LASTLOG: If set, indicates the presence of system lastlog
257 * facilities. If this and DISABLE_LASTLOG are not set,
258 * try to retrieve lastlog information from wtmp/wtmpx.
261 login_get_lastlog_time(const int uid)
265 if (login_get_lastlog(&li, uid))
271 /* login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
273 * Retrieve a logininfo structure populated (only partially) with
274 * information from the system lastlog data, or from wtmp/wtmpx if no
275 * system lastlog information exists.
277 * Note this routine must be given a pre-allocated logininfo.
280 * >0: A pointer to your struct logininfo if successful
281 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
285 login_get_lastlog(struct logininfo *li, const int uid)
289 memset(li, '\0', sizeof(*li));
293 * If we don't have a 'real' lastlog, we need the username to
294 * reliably search wtmp(x) for the last login (see
299 fatal("login_get_lastlog: Cannot find account for uid %i", uid);
301 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
303 strlcpy(li->username, pw->pw_name, sizeof(li->username));
305 if (getlast_entry(li))
312 /* login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
313 * a logininfo structure
315 * This function creates a new struct logininfo, a data structure
316 * meant to carry the information required to portably record login info.
318 * Returns a pointer to a newly created struct logininfo. If memory
319 * allocation fails, the program halts.
322 logininfo *login_alloc_entry(int pid, const char *username,
323 const char *hostname, const char *line)
325 struct logininfo *newli;
327 newli = (struct logininfo *) xmalloc (sizeof(*newli));
328 (void)login_init_entry(newli, pid, username, hostname, line);
333 /* login_free_entry(struct logininfo *) - free struct memory */
335 login_free_entry(struct logininfo *li)
341 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
342 * - initialise a struct logininfo
344 * Populates a new struct logininfo, a data structure meant to carry
345 * the information required to portably record login info.
350 login_init_entry(struct logininfo *li, int pid, const char *username,
351 const char *hostname, const char *line)
355 memset(li, 0, sizeof(*li));
359 /* set the line information */
361 line_fullname(li->line, line, sizeof(li->line));
364 strlcpy(li->username, username, sizeof(li->username));
365 pw = getpwnam(li->username);
367 fatal("login_init_entry: Cannot find user \"%s\"", li->username);
368 li->uid = pw->pw_uid;
372 strlcpy(li->hostname, hostname, sizeof(li->hostname));
377 /* login_set_current_time(struct logininfo *) - set the current time
379 * Set the current time in a logininfo structure. This function is
380 * meant to eliminate the need to deal with system dependencies for
384 login_set_current_time(struct logininfo *li)
388 gettimeofday(&tv, NULL);
390 li->tv_sec = tv.tv_sec;
391 li->tv_usec = tv.tv_usec;
394 /* copy a sockaddr_* into our logininfo */
396 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
397 const unsigned int sa_size)
399 unsigned int bufsize = sa_size;
401 /* make sure we don't overrun our union */
402 if (sizeof(li->hostaddr) < sa_size)
403 bufsize = sizeof(li->hostaddr);
405 memcpy((void *)&(li->hostaddr.sa), (const void *)sa, bufsize);
410 ** login_write: Call low-level recording functions based on autoconf
414 login_write (struct logininfo *li)
417 if ((int)geteuid() != 0) {
418 log("Attempt to write login records by non-root user (aborting)");
423 /* set the timestamp */
424 login_set_current_time(li);
426 syslogin_write_entry(li);
429 if (li->type == LTYPE_LOGIN) {
430 lastlog_write_entry(li);
434 utmp_write_entry(li);
437 wtmp_write_entry(li);
440 utmpx_write_entry(li);
443 wtmpx_write_entry(li);
448 #ifdef LOGIN_NEEDS_UTMPX
450 login_utmp_only(struct logininfo *li)
452 li->type = LTYPE_LOGIN;
453 login_set_current_time(li);
455 utmp_write_entry(li);
458 wtmp_write_entry(li);
461 utmpx_write_entry(li);
464 wtmpx_write_entry(li);
471 ** getlast_entry: Call low-level functions to retrieve the last login
475 /* take the uid in li and return the last login time */
477 getlast_entry(struct logininfo *li)
480 return(lastlog_get_entry(li));
481 #else /* !USE_LASTLOG */
483 #ifdef DISABLE_LASTLOG
484 /* On some systems we shouldn't even try to obtain last login
487 # else /* DISABLE_LASTLOG */
488 /* Try to retrieve the last login time from wtmp */
489 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
490 /* retrieve last login time from utmp */
491 return (wtmp_get_entry(li));
492 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
493 /* If wtmp isn't available, try wtmpx */
494 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
495 /* retrieve last login time from utmpx */
496 return (wtmpx_get_entry(li));
498 /* Give up: No means of retrieving last login time */
500 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
501 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
502 # endif /* DISABLE_LASTLOG */
503 #endif /* USE_LASTLOG */
509 * 'line' string utility functions
511 * These functions process the 'line' string into one of three forms:
513 * 1. The full filename (including '/dev')
514 * 2. The stripped name (excluding '/dev')
515 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
516 * /dev/pts/1 -> ts/1 )
518 * Form 3 is used on some systems to identify a .tmp.? entry when
519 * attempting to remove it. Typically both addition and removal is
520 * performed by one application - say, sshd - so as long as the choice
521 * uniquely identifies a terminal it's ok.
525 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
526 * sure dst has enough space, if not just copy src (ugh) */
528 line_fullname(char *dst, const char *src, int dstsize)
530 memset(dst, '\0', dstsize);
531 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5))) {
532 strlcpy(dst, src, dstsize);
534 strlcpy(dst, "/dev/", dstsize);
535 strlcat(dst, src, dstsize);
540 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
542 line_stripname(char *dst, const char *src, int dstsize)
544 memset(dst, '\0', dstsize);
545 if (strncmp(src, "/dev/", 5) == 0)
546 strlcpy(dst, src + 5, dstsize);
548 strlcpy(dst, src, dstsize);
552 /* line_abbrevname(): Return the abbreviated (usually four-character)
553 * form of the line (Just use the last <dstsize> characters of the
556 * NOTE: use strncpy because we do NOT necessarily want zero
559 line_abbrevname(char *dst, const char *src, int dstsize)
563 memset(dst, '\0', dstsize);
565 /* Always skip prefix if present */
566 if (strncmp(src, "/dev/", 5) == 0)
569 #ifdef WITH_ABBREV_NO_TTY
570 if (strncmp(src, "tty", 3) == 0)
577 if (((int)len - dstsize) > 0)
578 src += ((int)len - dstsize);
580 /* note: _don't_ change this to strlcpy */
581 strncpy(dst, src, (size_t)dstsize);
588 ** utmp utility functions
590 ** These functions manipulate struct utmp, taking system differences
594 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
596 /* build the utmp structure */
598 set_utmp_time(struct logininfo *li, struct utmp *ut)
600 # ifdef HAVE_TV_IN_UTMP
601 ut->ut_tv.tv_sec = li->tv_sec;
602 ut->ut_tv.tv_usec = li->tv_usec;
604 # ifdef HAVE_TIME_IN_UTMP
605 ut->ut_time = li->tv_sec;
611 construct_utmp(struct logininfo *li,
614 memset(ut, '\0', sizeof(*ut));
616 /* First fill out fields used for both logins and logouts */
618 # ifdef HAVE_ID_IN_UTMP
619 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
622 # ifdef HAVE_TYPE_IN_UTMP
623 /* This is done here to keep utmp constants out of struct logininfo */
626 ut->ut_type = USER_PROCESS;
632 ut->ut_type = DEAD_PROCESS;
634 cray_retain_utmp(ut, li->pid);
639 set_utmp_time(li, ut);
641 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
643 # ifdef HAVE_PID_IN_UTMP
644 ut->ut_pid = li->pid;
647 /* If we're logging out, leave all other fields blank */
648 if (li->type == LTYPE_LOGOUT)
652 * These fields are only used when logging in, and are blank
656 /* Use strncpy because we don't necessarily want null termination */
657 strncpy(ut->ut_name, li->username, MIN_SIZEOF(ut->ut_name, li->username));
658 # ifdef HAVE_HOST_IN_UTMP
659 realhostname_sa(ut->ut_host, sizeof ut->ut_host,
660 &li->hostaddr.sa, li->hostaddr.sa.sa_len);
662 # ifdef HAVE_ADDR_IN_UTMP
663 /* this is just a 32-bit IP address */
664 if (li->hostaddr.sa.sa_family == AF_INET)
665 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
668 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
671 ** utmpx utility functions
673 ** These functions manipulate struct utmpx, accounting for system
677 #if defined(USE_UTMPX) || defined (USE_WTMPX)
678 /* build the utmpx structure */
680 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
682 # ifdef HAVE_TV_IN_UTMPX
683 utx->ut_tv.tv_sec = li->tv_sec;
684 utx->ut_tv.tv_usec = li->tv_usec;
685 # else /* HAVE_TV_IN_UTMPX */
686 # ifdef HAVE_TIME_IN_UTMPX
687 utx->ut_time = li->tv_sec;
688 # endif /* HAVE_TIME_IN_UTMPX */
689 # endif /* HAVE_TV_IN_UTMPX */
693 construct_utmpx(struct logininfo *li, struct utmpx *utx)
695 memset(utx, '\0', sizeof(*utx));
696 # ifdef HAVE_ID_IN_UTMPX
697 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
700 /* this is done here to keep utmp constants out of loginrec.h */
703 utx->ut_type = USER_PROCESS;
706 utx->ut_type = DEAD_PROCESS;
709 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
710 set_utmpx_time(li, utx);
711 utx->ut_pid = li->pid;
712 /* strncpy(): Don't necessarily want null termination */
713 strncpy(utx->ut_name, li->username, MIN_SIZEOF(utx->ut_name, li->username));
715 if (li->type == LTYPE_LOGOUT)
719 * These fields are only used when logging in, and are blank
723 # ifdef HAVE_HOST_IN_UTMPX
724 strncpy(utx->ut_host, li->hostname, MIN_SIZEOF(utx->ut_host, li->hostname));
726 # ifdef HAVE_ADDR_IN_UTMPX
727 /* this is just a 32-bit IP address */
728 if (li->hostaddr.sa.sa_family == AF_INET)
729 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
731 # ifdef HAVE_SYSLEN_IN_UTMPX
732 /* ut_syslen is the length of the utx_host string */
733 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
736 #endif /* USE_UTMPX || USE_WTMPX */
739 ** Low-level utmp functions
742 /* FIXME: (ATL) utmp_write_direct needs testing */
745 /* if we can, use pututline() etc. */
746 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
747 defined(HAVE_PUTUTLINE)
748 # define UTMP_USE_LIBRARY
752 /* write a utmp entry with the system's help (pututline() and pals) */
753 # ifdef UTMP_USE_LIBRARY
755 utmp_write_library(struct logininfo *li, struct utmp *ut)
760 # ifdef HAVE_ENDUTENT
765 # else /* UTMP_USE_LIBRARY */
767 /* write a utmp entry direct to the file */
768 /* This is a slightly modification of code in OpenBSD's login.c */
770 utmp_write_direct(struct logininfo *li, struct utmp *ut)
776 /* FIXME: (ATL) ttyslot() needs local implementation */
778 #if defined(HAVE_GETTTYENT)
779 register struct ttyent *ty;
784 while ((struct ttyent *)0 != (ty = getttyent())) {
786 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
791 if((struct ttyent *)0 == ty) {
792 log("utmp_write_entry: tty not found");
797 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
799 #endif /* HAVE_GETTTYENT */
801 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
802 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
804 * Prevent luser from zero'ing out ut_host.
805 * If the new ut_line is empty but the old one is not
806 * and ut_line and ut_name match, preserve the old ut_line.
808 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
809 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
810 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
811 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0)) {
812 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
815 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
816 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut))
817 log("utmp_write_direct: error writing %s: %s",
818 UTMP_FILE, strerror(errno));
826 # endif /* UTMP_USE_LIBRARY */
829 utmp_perform_login(struct logininfo *li)
833 construct_utmp(li, &ut);
834 # ifdef UTMP_USE_LIBRARY
835 if (!utmp_write_library(li, &ut)) {
836 log("utmp_perform_login: utmp_write_library() failed");
840 if (!utmp_write_direct(li, &ut)) {
841 log("utmp_perform_login: utmp_write_direct() failed");
850 utmp_perform_logout(struct logininfo *li)
854 construct_utmp(li, &ut);
855 # ifdef UTMP_USE_LIBRARY
856 if (!utmp_write_library(li, &ut)) {
857 log("utmp_perform_logout: utmp_write_library() failed");
861 if (!utmp_write_direct(li, &ut)) {
862 log("utmp_perform_logout: utmp_write_direct() failed");
871 utmp_write_entry(struct logininfo *li)
875 return utmp_perform_login(li);
878 return utmp_perform_logout(li);
881 log("utmp_write_entry: invalid type field");
885 #endif /* USE_UTMP */
889 ** Low-level utmpx functions
892 /* not much point if we don't want utmpx entries */
895 /* if we have the wherewithall, use pututxline etc. */
896 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
897 defined(HAVE_PUTUTXLINE)
898 # define UTMPX_USE_LIBRARY
902 /* write a utmpx entry with the system's help (pututxline() and pals) */
903 # ifdef UTMPX_USE_LIBRARY
905 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
910 # ifdef HAVE_ENDUTXENT
916 # else /* UTMPX_USE_LIBRARY */
918 /* write a utmp entry direct to the file */
920 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
922 log("utmpx_write_direct: not implemented!");
925 # endif /* UTMPX_USE_LIBRARY */
928 utmpx_perform_login(struct logininfo *li)
932 construct_utmpx(li, &utx);
933 # ifdef UTMPX_USE_LIBRARY
934 if (!utmpx_write_library(li, &utx)) {
935 log("utmpx_perform_login: utmp_write_library() failed");
939 if (!utmpx_write_direct(li, &ut)) {
940 log("utmpx_perform_login: utmp_write_direct() failed");
949 utmpx_perform_logout(struct logininfo *li)
953 construct_utmpx(li, &utx);
954 # ifdef HAVE_ID_IN_UTMPX
955 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
957 # ifdef HAVE_TYPE_IN_UTMPX
958 utx.ut_type = DEAD_PROCESS;
961 # ifdef UTMPX_USE_LIBRARY
962 utmpx_write_library(li, &utx);
964 utmpx_write_direct(li, &utx);
970 utmpx_write_entry(struct logininfo *li)
974 return utmpx_perform_login(li);
976 return utmpx_perform_logout(li);
978 log("utmpx_write_entry: invalid type field");
982 #endif /* USE_UTMPX */
986 ** Low-level wtmp functions
991 /* write a wtmp entry direct to the end of the file */
992 /* This is a slight modification of code in OpenBSD's logwtmp.c */
994 wtmp_write(struct logininfo *li, struct utmp *ut)
999 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1000 log("wtmp_write: problem writing %s: %s",
1001 WTMP_FILE, strerror(errno));
1004 if (fstat(fd, &buf) == 0)
1005 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
1006 ftruncate(fd, buf.st_size);
1007 log("wtmp_write: problem writing %s: %s",
1008 WTMP_FILE, strerror(errno));
1016 wtmp_perform_login(struct logininfo *li)
1020 construct_utmp(li, &ut);
1021 return wtmp_write(li, &ut);
1026 wtmp_perform_logout(struct logininfo *li)
1030 construct_utmp(li, &ut);
1031 return wtmp_write(li, &ut);
1036 wtmp_write_entry(struct logininfo *li)
1040 return wtmp_perform_login(li);
1042 return wtmp_perform_logout(li);
1044 log("wtmp_write_entry: invalid type field");
1050 /* Notes on fetching login data from wtmp/wtmpx
1052 * Logouts are usually recorded with (amongst other things) a blank
1053 * username on a given tty line. However, some systems (HP-UX is one)
1054 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1056 * Since we're only looking for logins here, we know that the username
1057 * must be set correctly. On systems that leave it in, we check for
1058 * ut_type==USER_PROCESS (indicating a login.)
1060 * Portability: Some systems may set something other than USER_PROCESS
1061 * to indicate a login process. I don't know of any as I write. Also,
1062 * it's possible that some systems may both leave the username in
1063 * place and not have ut_type.
1066 /* return true if this wtmp entry indicates a login */
1068 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1070 if (strncmp(li->username, ut->ut_name,
1071 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1072 # ifdef HAVE_TYPE_IN_UTMP
1073 if (ut->ut_type & USER_PROCESS)
1083 wtmp_get_entry(struct logininfo *li)
1089 /* Clear the time entries in our logininfo */
1090 li->tv_sec = li->tv_usec = 0;
1092 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1093 log("wtmp_get_entry: problem opening %s: %s",
1094 WTMP_FILE, strerror(errno));
1097 if (fstat(fd, &st) != 0) {
1098 log("wtmp_get_entry: couldn't stat %s: %s",
1099 WTMP_FILE, strerror(errno));
1104 /* Seek to the start of the last struct utmp */
1105 if (lseek(fd, -(off_t)sizeof(struct utmp), SEEK_END) == -1) {
1106 /* Looks like we've got a fresh wtmp file */
1112 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1113 log("wtmp_get_entry: read of %s failed: %s",
1114 WTMP_FILE, strerror(errno));
1118 if ( wtmp_islogin(li, &ut) ) {
1120 /* We've already checked for a time in struct
1121 * utmp, in login_getlast(). */
1122 # ifdef HAVE_TIME_IN_UTMP
1123 li->tv_sec = ut.ut_time;
1125 # if HAVE_TV_IN_UTMP
1126 li->tv_sec = ut.ut_tv.tv_sec;
1129 line_fullname(li->line, ut.ut_line,
1130 MIN_SIZEOF(li->line, ut.ut_line));
1131 # ifdef HAVE_HOST_IN_UTMP
1132 strlcpy(li->hostname, ut.ut_host,
1133 MIN_SIZEOF(li->hostname, ut.ut_host));
1137 /* Seek back 2 x struct utmp */
1138 if (lseek(fd, -(off_t)(2 * sizeof(struct utmp)), SEEK_CUR) == -1) {
1139 /* We've found the start of the file, so quit */
1145 /* We found an entry. Tidy up and return */
1149 # endif /* USE_WTMP */
1153 ** Low-level wtmpx functions
1157 /* write a wtmpx entry direct to the end of the file */
1158 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1160 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1165 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1166 log("wtmpx_write: problem opening %s: %s",
1167 WTMPX_FILE, strerror(errno));
1171 if (fstat(fd, &buf) == 0)
1172 if (atomicio(write, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1173 ftruncate(fd, buf.st_size);
1174 log("wtmpx_write: problem writing %s: %s",
1175 WTMPX_FILE, strerror(errno));
1185 wtmpx_perform_login(struct logininfo *li)
1189 construct_utmpx(li, &utx);
1190 return wtmpx_write(li, &utx);
1195 wtmpx_perform_logout(struct logininfo *li)
1199 construct_utmpx(li, &utx);
1200 return wtmpx_write(li, &utx);
1205 wtmpx_write_entry(struct logininfo *li)
1209 return wtmpx_perform_login(li);
1211 return wtmpx_perform_logout(li);
1213 log("wtmpx_write_entry: invalid type field");
1218 /* Please see the notes above wtmp_islogin() for information about the
1219 next two functions */
1221 /* Return true if this wtmpx entry indicates a login */
1223 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1225 if ( strncmp(li->username, utx->ut_name,
1226 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1227 # ifdef HAVE_TYPE_IN_UTMPX
1228 if (utx->ut_type == USER_PROCESS)
1239 wtmpx_get_entry(struct logininfo *li)
1245 /* Clear the time entries */
1246 li->tv_sec = li->tv_usec = 0;
1248 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1249 log("wtmpx_get_entry: problem opening %s: %s",
1250 WTMPX_FILE, strerror(errno));
1253 if (fstat(fd, &st) != 0) {
1254 log("wtmpx_get_entry: couldn't stat %s: %s",
1255 WTMPX_FILE, strerror(errno));
1260 /* Seek to the start of the last struct utmpx */
1261 if (lseek(fd, -(off_t)sizeof(struct utmpx), SEEK_END) == -1 ) {
1262 /* probably a newly rotated wtmpx file */
1268 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1269 log("wtmpx_get_entry: read of %s failed: %s",
1270 WTMPX_FILE, strerror(errno));
1274 /* Logouts are recorded as a blank username on a particular line.
1275 * So, we just need to find the username in struct utmpx */
1276 if ( wtmpx_islogin(li, &utx) ) {
1278 # ifdef HAVE_TV_IN_UTMPX
1279 li->tv_sec = utx.ut_tv.tv_sec;
1281 # ifdef HAVE_TIME_IN_UTMPX
1282 li->tv_sec = utx.ut_time;
1285 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1286 # ifdef HAVE_HOST_IN_UTMPX
1287 strlcpy(li->hostname, utx.ut_host,
1288 MIN_SIZEOF(li->hostname, utx.ut_host));
1292 if (lseek(fd, -(off_t)(2 * sizeof(struct utmpx)), SEEK_CUR) == -1) {
1301 #endif /* USE_WTMPX */
1304 ** Low-level libutil login() functions
1309 syslogin_perform_login(struct logininfo *li)
1313 if (! (ut = (struct utmp *)malloc(sizeof(*ut)))) {
1314 log("syslogin_perform_login: couldn't malloc()");
1317 construct_utmp(li, ut);
1324 syslogin_perform_logout(struct logininfo *li)
1329 (void)line_stripname(line, li->line, sizeof(line));
1331 if (!logout(line)) {
1332 log("syslogin_perform_logout: logout() returned an error");
1333 # ifdef HAVE_LOGWTMP
1335 logwtmp(line, "", "");
1338 /* FIXME: (ATL - if the need arises) What to do if we have
1339 * login, but no logout? what if logout but no logwtmp? All
1340 * routines are in libutil so they should all be there,
1347 syslogin_write_entry(struct logininfo *li)
1351 return syslogin_perform_login(li);
1353 return syslogin_perform_logout(li);
1355 log("syslogin_write_entry: Invalid type field");
1359 #endif /* USE_LOGIN */
1361 /* end of file log-syslogin.c */
1364 ** Low-level lastlog functions
1373 lastlog_construct(struct logininfo *li, struct lastlog *last)
1375 /* clear the structure */
1376 memset(last, '\0', sizeof(*last));
1378 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1379 strlcpy(last->ll_host, li->hostname,
1380 MIN_SIZEOF(last->ll_host, li->hostname));
1381 last->ll_time = li->tv_sec;
1385 lastlog_filetype(char *filename)
1389 if (stat(LASTLOG_FILE, &st) != 0) {
1390 log("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1394 if (S_ISDIR(st.st_mode))
1396 else if (S_ISREG(st.st_mode))
1403 /* open the file (using filemode) and seek to the login entry */
1405 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1409 char lastlog_file[1024];
1411 type = lastlog_filetype(LASTLOG_FILE);
1414 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1417 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1418 LASTLOG_FILE, li->username);
1421 log("lastlog_openseek: %.100s is not a file or directory!",
1426 *fd = open(lastlog_file, filemode);
1428 debug("lastlog_openseek: Couldn't open %s: %s",
1429 lastlog_file, strerror(errno));
1433 if (type == LL_FILE) {
1434 /* find this uid's offset in the lastlog file */
1435 offset = (off_t) ((long)li->uid * sizeof(struct lastlog));
1437 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1438 log("lastlog_openseek: %s->lseek(): %s",
1439 lastlog_file, strerror(errno));
1448 lastlog_perform_login(struct logininfo *li)
1450 struct lastlog last;
1453 /* create our struct lastlog */
1454 lastlog_construct(li, &last);
1456 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1459 /* write the entry */
1460 if (atomicio(write, fd, &last, sizeof(last)) != sizeof(last)) {
1462 log("lastlog_write_filemode: Error writing to %s: %s",
1463 LASTLOG_FILE, strerror(errno));
1472 lastlog_write_entry(struct logininfo *li)
1476 return lastlog_perform_login(li);
1478 log("lastlog_write_entry: Invalid type field");
1484 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1486 line_fullname(li->line, last->ll_line, sizeof(li->line));
1487 strlcpy(li->hostname, last->ll_host,
1488 MIN_SIZEOF(li->hostname, last->ll_host));
1489 li->tv_sec = last->ll_time;
1493 lastlog_get_entry(struct logininfo *li)
1495 struct lastlog last;
1498 if (!lastlog_openseek(li, &fd, O_RDONLY))
1501 if (atomicio(read, fd, &last, sizeof(last)) != sizeof(last)) {
1503 log("lastlog_get_entry: Error reading from %s: %s",
1504 LASTLOG_FILE, strerror(errno));
1510 lastlog_populate_entry(li, &last);
1514 #endif /* USE_LASTLOG */