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)
404 if ((int)geteuid() != 0) {
405 log("Attempt to write login records by non-root user (aborting)");
409 /* set the timestamp */
410 login_set_current_time(li);
412 syslogin_write_entry(li);
415 if (li->type == LTYPE_LOGIN) {
416 lastlog_write_entry(li);
420 utmp_write_entry(li);
423 wtmp_write_entry(li);
426 utmpx_write_entry(li);
429 wtmpx_write_entry(li);
435 ** getlast_entry: Call low-level functions to retrieve the last login
439 /* take the uid in li and return the last login time */
441 getlast_entry(struct logininfo *li)
444 return(lastlog_get_entry(li));
445 #else /* !USE_LASTLOG */
447 #ifdef DISABLE_LASTLOG
448 /* On some systems we shouldn't even try to obtain last login
451 # else /* DISABLE_LASTLOG */
452 /* Try to retrieve the last login time from wtmp */
453 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
454 /* retrieve last login time from utmp */
455 return (wtmp_get_entry(li));
456 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
457 /* If wtmp isn't available, try wtmpx */
458 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
459 /* retrieve last login time from utmpx */
460 return (wtmpx_get_entry(li));
462 /* Give up: No means of retrieving last login time */
464 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
465 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
466 # endif /* DISABLE_LASTLOG */
467 #endif /* USE_LASTLOG */
473 * 'line' string utility functions
475 * These functions process the 'line' string into one of three forms:
477 * 1. The full filename (including '/dev')
478 * 2. The stripped name (excluding '/dev')
479 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
480 * /dev/pts/1 -> ts/1 )
482 * Form 3 is used on some systems to identify a .tmp.? entry when
483 * attempting to remove it. Typically both addition and removal is
484 * performed by one application - say, sshd - so as long as the choice
485 * uniquely identifies a terminal it's ok.
489 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
490 * sure dst has enough space, if not just copy src (ugh) */
492 line_fullname(char *dst, const char *src, int dstsize)
494 memset(dst, '\0', dstsize);
495 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
496 strlcpy(dst, src, dstsize);
498 strlcpy(dst, "/dev/", dstsize);
499 strlcat(dst, src, dstsize);
504 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
506 line_stripname(char *dst, const char *src, int dstsize)
508 memset(dst, '\0', dstsize);
509 if (strncmp(src, "/dev/", 5) == 0)
510 strlcpy(dst, &src[5], dstsize);
512 strlcpy(dst, src, dstsize);
516 /* line_abbrevname(): Return the abbreviated (usually four-character)
517 * form of the line (Just use the last <dstsize> characters of the
520 * NOTE: use strncpy because we do NOT necessarily want zero
523 line_abbrevname(char *dst, const char *src, int dstsize)
527 memset(dst, '\0', dstsize);
529 /* Always skip prefix if present */
530 if (strncmp(src, "/dev/", 5) == 0)
536 if (((int)len - dstsize) > 0)
537 src += ((int)len - dstsize);
539 /* note: _don't_ change this to strlcpy */
540 strncpy(dst, src, (size_t)dstsize);
547 ** utmp utility functions
549 ** These functions manipulate struct utmp, taking system differences
553 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
555 /* build the utmp structure */
557 set_utmp_time(struct logininfo *li, struct utmp *ut)
559 # ifdef HAVE_TV_IN_UTMP
560 ut->ut_tv.tv_sec = li->tv_sec;
561 ut->ut_tv.tv_usec = li->tv_usec;
563 # ifdef HAVE_TIME_IN_UTMP
564 ut->ut_time = li->tv_sec;
570 construct_utmp(struct logininfo *li,
573 memset(ut, '\0', sizeof(*ut));
575 /* First fill out fields used for both logins and logouts */
577 # ifdef HAVE_ID_IN_UTMP
578 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
581 # ifdef HAVE_TYPE_IN_UTMP
582 /* This is done here to keep utmp constants out of struct logininfo */
585 ut->ut_type = USER_PROCESS;
588 ut->ut_type = DEAD_PROCESS;
592 set_utmp_time(li, ut);
594 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
596 # ifdef HAVE_PID_IN_UTMP
597 ut->ut_pid = li->pid;
600 /* If we're logging out, leave all other fields blank */
601 if (li->type == LTYPE_LOGOUT)
605 * These fields are only used when logging in, and are blank
609 /* Use strncpy because we don't necessarily want null termination */
610 strncpy(ut->ut_name, li->username, MIN_SIZEOF(ut->ut_name, li->username));
611 # ifdef HAVE_HOST_IN_UTMP
612 strncpy(ut->ut_host, li->hostname, MIN_SIZEOF(ut->ut_host, li->hostname));
614 # ifdef HAVE_ADDR_IN_UTMP
615 /* this is just a 32-bit IP address */
616 if (li->hostaddr.sa.sa_family == AF_INET)
617 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
620 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
623 ** utmpx utility functions
625 ** These functions manipulate struct utmpx, accounting for system
629 #if defined(USE_UTMPX) || defined (USE_WTMPX)
630 /* build the utmpx structure */
632 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
634 # ifdef HAVE_TV_IN_UTMPX
635 utx->ut_tv.tv_sec = li->tv_sec;
636 utx->ut_tv.tv_usec = li->tv_usec;
637 # else /* HAVE_TV_IN_UTMPX */
638 # ifdef HAVE_TIME_IN_UTMPX
639 utx->ut_time = li->tv_sec;
640 # endif /* HAVE_TIME_IN_UTMPX */
641 # endif /* HAVE_TV_IN_UTMPX */
645 construct_utmpx(struct logininfo *li, struct utmpx *utx)
647 memset(utx, '\0', sizeof(*utx));
648 # ifdef HAVE_ID_IN_UTMPX
649 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
652 /* this is done here to keep utmp constants out of loginrec.h */
655 utx->ut_type = USER_PROCESS;
658 utx->ut_type = DEAD_PROCESS;
661 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
662 set_utmpx_time(li, utx);
663 utx->ut_pid = li->pid;
665 if (li->type == LTYPE_LOGOUT)
669 * These fields are only used when logging in, and are blank
673 /* strncpy(): Don't necessarily want null termination */
674 strncpy(utx->ut_name, li->username, MIN_SIZEOF(utx->ut_name, li->username));
675 # ifdef HAVE_HOST_IN_UTMPX
676 strncpy(utx->ut_host, li->hostname, MIN_SIZEOF(utx->ut_host, li->hostname));
678 # ifdef HAVE_ADDR_IN_UTMPX
679 /* FIXME: (ATL) not supported yet */
681 # ifdef HAVE_SYSLEN_IN_UTMPX
682 /* ut_syslen is the length of the utx_host string */
683 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
686 #endif /* USE_UTMPX || USE_WTMPX */
689 ** Low-level utmp functions
692 /* FIXME: (ATL) utmp_write_direct needs testing */
695 /* if we can, use pututline() etc. */
696 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
697 defined(HAVE_PUTUTLINE)
698 # define UTMP_USE_LIBRARY
702 /* write a utmp entry with the system's help (pututline() and pals) */
703 # ifdef UTMP_USE_LIBRARY
705 utmp_write_library(struct logininfo *li, struct utmp *ut)
710 # ifdef HAVE_ENDUTENT
715 # else /* UTMP_USE_LIBRARY */
717 /* write a utmp entry direct to the file */
718 /* This is a slightly modification of code in OpenBSD's login.c */
720 utmp_write_direct(struct logininfo *li, struct utmp *ut)
726 /* FIXME: (ATL) ttyslot() needs local implementation */
728 #if defined(HAVE_GETTTYENT)
729 register struct ttyent *ty;
734 while ((struct ttyent *)0 != (ty = getttyent())) {
736 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
741 if((struct ttyent *)0 == ty) {
742 log("utmp_write_entry: tty not found");
747 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
749 #endif /* HAVE_GETTTYENT */
751 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
752 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
754 * Prevent luser from zero'ing out ut_host.
755 * If the new ut_line is empty but the old one is not
756 * and ut_line and ut_name match, preserve the old ut_line.
758 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
759 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
760 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
761 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0)) {
762 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
765 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
766 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut))
767 log("utmp_write_direct: error writing %s: %s",
768 UTMP_FILE, strerror(errno));
776 # endif /* UTMP_USE_LIBRARY */
779 utmp_perform_login(struct logininfo *li)
783 construct_utmp(li, &ut);
784 # ifdef UTMP_USE_LIBRARY
785 if (!utmp_write_library(li, &ut)) {
786 log("utmp_perform_login: utmp_write_library() failed");
790 if (!utmp_write_direct(li, &ut)) {
791 log("utmp_perform_login: utmp_write_direct() failed");
800 utmp_perform_logout(struct logininfo *li)
804 construct_utmp(li, &ut);
805 # ifdef UTMP_USE_LIBRARY
806 if (!utmp_write_library(li, &ut)) {
807 log("utmp_perform_logout: utmp_write_library() failed");
811 if (!utmp_write_direct(li, &ut)) {
812 log("utmp_perform_logout: utmp_write_direct() failed");
821 utmp_write_entry(struct logininfo *li)
825 return utmp_perform_login(li);
828 return utmp_perform_logout(li);
831 log("utmp_write_entry: invalid type field");
835 #endif /* USE_UTMP */
839 ** Low-level utmpx functions
842 /* not much point if we don't want utmpx entries */
845 /* if we have the wherewithall, use pututxline etc. */
846 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
847 defined(HAVE_PUTUTXLINE)
848 # define UTMPX_USE_LIBRARY
852 /* write a utmpx entry with the system's help (pututxline() and pals) */
853 # ifdef UTMPX_USE_LIBRARY
855 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
860 # ifdef HAVE_ENDUTXENT
866 # else /* UTMPX_USE_LIBRARY */
868 /* write a utmp entry direct to the file */
870 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
872 log("utmpx_write_direct: not implemented!");
875 # endif /* UTMPX_USE_LIBRARY */
878 utmpx_perform_login(struct logininfo *li)
882 construct_utmpx(li, &utx);
883 # ifdef UTMPX_USE_LIBRARY
884 if (!utmpx_write_library(li, &utx)) {
885 log("utmpx_perform_login: utmp_write_library() failed");
889 if (!utmpx_write_direct(li, &ut)) {
890 log("utmpx_perform_login: utmp_write_direct() failed");
899 utmpx_perform_logout(struct logininfo *li)
903 memset(&utx, '\0', sizeof(utx));
904 set_utmpx_time(li, &utx);
905 line_stripname(utx.ut_line, li->line, sizeof(utx.ut_line));
906 # ifdef HAVE_ID_IN_UTMPX
907 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
909 # ifdef HAVE_TYPE_IN_UTMPX
910 utx.ut_type = DEAD_PROCESS;
913 # ifdef UTMPX_USE_LIBRARY
914 utmpx_write_library(li, &utx);
916 utmpx_write_direct(li, &utx);
922 utmpx_write_entry(struct logininfo *li)
926 return utmpx_perform_login(li);
928 return utmpx_perform_logout(li);
930 log("utmpx_write_entry: invalid type field");
934 #endif /* USE_UTMPX */
938 ** Low-level wtmp functions
943 /* write a wtmp entry direct to the end of the file */
944 /* This is a slight modification of code in OpenBSD's logwtmp.c */
946 wtmp_write(struct logininfo *li, struct utmp *ut)
951 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
952 log("wtmp_write: problem writing %s: %s",
953 WTMP_FILE, strerror(errno));
956 if (fstat(fd, &buf) == 0)
957 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
958 ftruncate(fd, buf.st_size);
959 log("wtmp_write: problem writing %s: %s",
960 WTMP_FILE, strerror(errno));
968 wtmp_perform_login(struct logininfo *li)
972 construct_utmp(li, &ut);
973 return wtmp_write(li, &ut);
978 wtmp_perform_logout(struct logininfo *li)
982 construct_utmp(li, &ut);
983 return wtmp_write(li, &ut);
988 wtmp_write_entry(struct logininfo *li)
992 return wtmp_perform_login(li);
994 return wtmp_perform_logout(li);
996 log("wtmp_write_entry: invalid type field");
1002 /* Notes on fetching login data from wtmp/wtmpx
1004 * Logouts are usually recorded with (amongst other things) a blank
1005 * username on a given tty line. However, some systems (HP-UX is one)
1006 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1008 * Since we're only looking for logins here, we know that the username
1009 * must be set correctly. On systems that leave it in, we check for
1010 * ut_type==USER_PROCESS (indicating a login.)
1012 * Portability: Some systems may set something other than USER_PROCESS
1013 * to indicate a login process. I don't know of any as I write. Also,
1014 * it's possible that some systems may both leave the username in
1015 * place and not have ut_type.
1018 /* return true if this wtmp entry indicates a login */
1020 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1022 if (strncmp(li->username, ut->ut_name,
1023 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1024 # ifdef HAVE_TYPE_IN_UTMP
1025 if (ut->ut_type & USER_PROCESS)
1035 wtmp_get_entry(struct logininfo *li)
1041 /* Clear the time entries in our logininfo */
1042 li->tv_sec = li->tv_usec = 0;
1044 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1045 log("wtmp_get_entry: problem opening %s: %s",
1046 WTMP_FILE, strerror(errno));
1049 if (fstat(fd, &st) != 0) {
1050 log("wtmp_get_entry: couldn't stat %s: %s",
1051 WTMP_FILE, strerror(errno));
1056 /* Seek to the start of the last struct utmp */
1057 if (lseek(fd, (off_t)(0 - sizeof(struct utmp)), SEEK_END) == -1) {
1058 /* Looks like we've got a fresh wtmp file */
1064 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1065 log("wtmp_get_entry: read of %s failed: %s",
1066 WTMP_FILE, strerror(errno));
1070 if ( wtmp_islogin(li, &ut) ) {
1072 /* We've already checked for a time in struct
1073 * utmp, in login_getlast(). */
1074 # ifdef HAVE_TIME_IN_UTMP
1075 li->tv_sec = ut.ut_time;
1077 # if HAVE_TV_IN_UTMP
1078 li->tv_sec = ut.ut_tv.tv_sec;
1081 line_fullname(li->line, ut.ut_line,
1082 MIN_SIZEOF(li->line, ut.ut_line));
1083 # ifdef HAVE_HOST_IN_UTMP
1084 strlcpy(li->hostname, ut.ut_host,
1085 MIN_SIZEOF(li->hostname, ut.ut_host));
1089 /* Seek back 2 x struct utmp */
1090 if (lseek(fd, (off_t)(0-2*sizeof(struct utmp)), SEEK_CUR) == -1) {
1091 /* We've found the start of the file, so quit */
1097 /* We found an entry. Tidy up and return */
1101 # endif /* USE_WTMP */
1105 ** Low-level wtmpx functions
1109 /* write a wtmpx entry direct to the end of the file */
1110 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1112 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1117 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1118 log("wtmpx_write: problem opening %s: %s",
1119 WTMPX_FILE, strerror(errno));
1123 if (fstat(fd, &buf) == 0)
1124 if (atomicio(write, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1125 ftruncate(fd, buf.st_size);
1126 log("wtmpx_write: problem writing %s: %s",
1127 WTMPX_FILE, strerror(errno));
1137 wtmpx_perform_login(struct logininfo *li)
1141 construct_utmpx(li, &utx);
1142 return wtmpx_write(li, &utx);
1147 wtmpx_perform_logout(struct logininfo *li)
1151 construct_utmpx(li, &utx);
1152 return wtmpx_write(li, &utx);
1157 wtmpx_write_entry(struct logininfo *li)
1161 return wtmpx_perform_login(li);
1163 return wtmpx_perform_logout(li);
1165 log("wtmpx_write_entry: invalid type field");
1170 /* Please see the notes above wtmp_islogin() for information about the
1171 next two functions */
1173 /* Return true if this wtmpx entry indicates a login */
1175 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1177 if ( strncmp(li->username, utx->ut_name,
1178 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1179 # ifdef HAVE_TYPE_IN_UTMPX
1180 if (utx->ut_type == USER_PROCESS)
1191 wtmpx_get_entry(struct logininfo *li)
1197 /* Clear the time entries */
1198 li->tv_sec = li->tv_usec = 0;
1200 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1201 log("wtmpx_get_entry: problem opening %s: %s",
1202 WTMPX_FILE, strerror(errno));
1205 if (fstat(fd, &st) != 0) {
1206 log("wtmpx_get_entry: couldn't stat %s: %s",
1207 WTMP_FILE, strerror(errno));
1212 /* Seek to the start of the last struct utmpx */
1213 if (lseek(fd, (off_t)(0-sizeof(struct utmpx)), SEEK_END) == -1 ) {
1214 /* probably a newly rotated wtmpx file */
1220 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1221 log("wtmpx_get_entry: read of %s failed: %s",
1222 WTMPX_FILE, strerror(errno));
1226 /* Logouts are recorded as a blank username on a particular line.
1227 * So, we just need to find the username in struct utmpx */
1228 if ( wtmpx_islogin(li, &utx) ) {
1229 # ifdef HAVE_TV_IN_UTMPX
1230 li->tv_sec = utx.ut_tv.tv_sec;
1232 # ifdef HAVE_TIME_IN_UTMPX
1233 li->tv_sec = utx.ut_time;
1236 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1237 # ifdef HAVE_HOST_IN_UTMPX
1238 strlcpy(li->hostname, utx.ut_host,
1239 MIN_SIZEOF(li->hostname, utx.ut_host));
1243 if (lseek(fd, (off_t)(0-2*sizeof(struct utmpx)), SEEK_CUR) == -1) {
1252 #endif /* USE_WTMPX */
1255 ** Low-level libutil login() functions
1260 syslogin_perform_login(struct logininfo *li)
1264 if (! (ut = (struct utmp *)malloc(sizeof(*ut)))) {
1265 log("syslogin_perform_login: couldn't malloc()");
1268 construct_utmp(li, ut);
1275 syslogin_perform_logout(struct logininfo *li)
1280 (void)line_stripname(line, li->line, sizeof(line));
1282 if (!logout(line)) {
1283 log("syslogin_perform_logout: logout() returned an error");
1284 # ifdef HAVE_LOGWTMP
1286 logwtmp(line, "", "");
1289 /* FIXME: (ATL - if the need arises) What to do if we have
1290 * login, but no logout? what if logout but no logwtmp? All
1291 * routines are in libutil so they should all be there,
1298 syslogin_write_entry(struct logininfo *li)
1302 return syslogin_perform_login(li);
1304 return syslogin_perform_logout(li);
1306 log("syslogin_write_entry: Invalid type field");
1310 #endif /* USE_LOGIN */
1312 /* end of file log-syslogin.c */
1315 ** Low-level lastlog functions
1324 lastlog_construct(struct logininfo *li, struct lastlog *last)
1326 /* clear the structure */
1327 memset(last, '\0', sizeof(*last));
1329 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1330 strlcpy(last->ll_host, li->hostname,
1331 MIN_SIZEOF(last->ll_host, li->hostname));
1332 last->ll_time = li->tv_sec;
1336 lastlog_filetype(char *filename)
1340 if (stat(LASTLOG_FILE, &st) != 0) {
1341 log("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1345 if (S_ISDIR(st.st_mode))
1347 else if (S_ISREG(st.st_mode))
1354 /* open the file (using filemode) and seek to the login entry */
1356 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1360 char lastlog_file[1024];
1362 type = lastlog_filetype(LASTLOG_FILE);
1365 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1368 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1369 LASTLOG_FILE, li->username);
1372 log("lastlog_openseek: %.100s is not a file or directory!",
1377 *fd = open(lastlog_file, filemode);
1379 debug("lastlog_openseek: Couldn't open %s: %s",
1380 lastlog_file, strerror(errno));
1384 if (type == LL_FILE) {
1385 /* find this uid's offset in the lastlog file */
1386 offset = (off_t) ( (long)li->uid * sizeof(struct lastlog));
1388 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1389 log("lastlog_openseek: %s->lseek(): %s",
1390 lastlog_file, strerror(errno));
1399 lastlog_perform_login(struct logininfo *li)
1401 struct lastlog last;
1404 /* create our struct lastlog */
1405 lastlog_construct(li, &last);
1407 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1410 /* write the entry */
1411 if (atomicio(write, fd, &last, sizeof(last)) != sizeof(last)) {
1413 log("lastlog_write_filemode: Error writing to %s: %s",
1414 LASTLOG_FILE, strerror(errno));
1423 lastlog_write_entry(struct logininfo *li)
1427 return lastlog_perform_login(li);
1429 log("lastlog_write_entry: Invalid type field");
1435 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1437 line_fullname(li->line, last->ll_line, sizeof(li->line));
1438 strlcpy(li->hostname, last->ll_host,
1439 MIN_SIZEOF(li->hostname, last->ll_host));
1440 li->tv_sec = last->ll_time;
1444 lastlog_get_entry(struct logininfo *li)
1446 struct lastlog last;
1449 if (lastlog_openseek(li, &fd, O_RDONLY)) {
1450 if (atomicio(read, fd, &last, sizeof(last)) != sizeof(last)) {
1451 log("lastlog_get_entry: Error reading from %s: %s",
1452 LASTLOG_FILE, strerror(errno));
1455 lastlog_populate_entry(li, &last);
1462 #endif /* USE_LASTLOG */