2 * Copyright (c) 2000 Andre Lucas. All rights reserved.
3 * Portions copyright (c) 1998 Todd C. Miller
4 * Portions copyright (c) 1996 Jason Downs
5 * Portions copyright (c) 1996 Theo de Raadt
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Markus Friedl.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 ** loginrec.c: platform-independent login recording and lastlog retrieval
38 The new login code explained
39 ============================
41 This code attempts to provide a common interface to login recording
42 (utmp and friends) and last login time retrieval.
44 Its primary means of achieving this is to use 'struct logininfo', a
45 union of all the useful fields in the various different types of
46 system login record structures one finds on UNIX variants.
48 We depend on autoconf to define which recording methods are to be
49 used, and which fields are contained in the relevant data structures
50 on the local system. Many C preprocessor symbols affect which code
53 The code is designed to make it easy to modify a particular
54 recording method, without affecting other methods nor requiring so
55 many nested conditional compilation blocks as were commonplace in
58 For login recording, we try to use the local system's libraries as
59 these are clearly most likely to work correctly. For utmp systems
60 this usually means login() and logout() or setutent() etc., probably
61 in libutil, along with logwtmp() etc. On these systems, we fall back
62 to writing the files directly if we have to, though this method
63 requires very thorough testing so we do not corrupt local auditing
64 information. These files and their access methods are very system
67 For utmpx systems, the corresponding library functions are
68 setutxent() etc. To the author's knowledge, all utmpx systems have
69 these library functions and so no direct write is attempted. If such
70 a system exists and needs support, direct analogues of the [uw]tmp
73 Retrieving the time of last login ('lastlog') is in some ways even
74 more problemmatic than login recording. Some systems provide a
75 simple table of all users which we seek based on uid and retrieve a
76 relatively standard structure. Others record the same information in
77 a directory with a separate file, and others don't record the
78 information separately at all. For systems in the latter category,
79 we look backwards in the wtmp or wtmpx file for the last login entry
80 for our user. Naturally this is slower and on busy systems could
81 incur a significant performance penalty.
86 In OpenSSH all login recording and retrieval is performed in
87 login.c. Here you'll find working examples. Also, in the logintest.c
88 program there are more examples.
90 Internal handler calling method
91 -------------------------------
93 When a call is made to login_login() or login_logout(), both
94 routines set a struct logininfo flag defining which action (log in,
95 or log out) is to be taken. They both then call login_write(), which
96 calls whichever of the many structure-specific handlers autoconf
97 selects for the local system.
99 The handlers themselves handle system data structure specifics. Both
100 struct utmp and struct utmpx have utility functions (see
101 construct_utmp*()) to try to make it simpler to add extra systems
102 that introduce new features to either structure.
104 While it may seem terribly wasteful to replicate so much similar
105 code for each method, experience has shown that maintaining code to
106 write both struct utmp and utmpx in one function, whilst maintaining
107 support for all systems whether they have library support or not, is
108 a difficult and time-consuming task.
110 Lastlog support proceeds similarly. Functions login_get_lastlog()
111 (and its OpenSSH-tuned friend login_get_lastlog_time()) call
112 getlast_entry(), which tries one of three methods to find the last
113 login time. It uses local system lastlog support if it can,
114 otherwise it tries wtmp or wtmpx before giving up and returning 0,
120 In many cases it's possible to tweak autoconf to select the correct
121 methods for a particular platform, either by improving the detection
122 code (best), or by presetting DISABLE_<method> or CONF_<method>_FILE
123 symbols for the platform.
125 Use logintest to check which symbols are defined before modifying
126 configure.in and loginrec.c. (You have to build logintest yourself
127 with 'make logintest' as it's not built by default.)
129 Otherwise, patches to the specific method(s) are very helpful!
135 ** homegrown ttyslot()q
142 ** Linux (Redhat 6.2, need more variants)
143 ** HP-UX 10.20 (gcc only)
146 ** Testing required: Please send reports!
152 ** Platforms with known problems:
157 #include "includes.h"
166 # include <lastlog.h>
171 #include "loginrec.h"
176 ** prototypes for helper functions in this file
180 void set_utmp_time(struct logininfo *li, struct utmp *ut);
181 void construct_utmp(struct logininfo *li, struct utmp *ut);
185 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
186 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
189 int utmp_write_entry(struct logininfo *li);
190 int utmpx_write_entry(struct logininfo *li);
191 int wtmp_write_entry(struct logininfo *li);
192 int wtmpx_write_entry(struct logininfo *li);
193 int lastlog_write_entry(struct logininfo *li);
194 int syslogin_write_entry(struct logininfo *li);
196 int getlast_entry(struct logininfo *li);
197 int lastlog_get_entry(struct logininfo *li);
198 int wtmp_get_entry(struct logininfo *li);
199 int wtmpx_get_entry(struct logininfo *li);
201 /* pick the shortest string */
202 #define MIN_SIZEOF(s1,s2) ( sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2) )
205 ** platform-independent login functions
208 /* login_login(struct logininfo *) -Record a login
210 * Call with a pointer to a struct logininfo initialised with
211 * login_init_entry() or login_alloc_entry()
215 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
218 login_login (struct logininfo *li)
220 li->type = LTYPE_LOGIN;
221 return login_write(li);
225 /* login_logout(struct logininfo *) - Record a logout
227 * Call as with login_login()
231 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
234 login_logout(struct logininfo *li)
236 li->type = LTYPE_LOGOUT;
237 return login_write(li);
240 /* login_get_lastlog_time(int) - Retrieve the last login time
242 * Retrieve the last login time for the given uid. Will try to use the
243 * system lastlog facilities if they are available, but will fall back
244 * to looking in wtmp/wtmpx if necessary
247 * 0 on failure, or if user has never logged in
248 * Time in seconds from the epoch if successful
250 * Useful preprocessor symbols:
251 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
253 * USE_LASTLOG: If set, indicates the presence of system lastlog
254 * facilities. If this and DISABLE_LASTLOG are not set,
255 * try to retrieve lastlog information from wtmp/wtmpx.
258 login_get_lastlog_time(const int uid)
262 if (login_get_lastlog(&li, uid))
268 /* login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
270 * Retrieve a logininfo structure populated (only partially) with
271 * information from the system lastlog data, or from wtmp/wtmpx if no
272 * system lastlog information exists.
274 * Note this routine must be given a pre-allocated logininfo.
277 * >0: A pointer to your struct logininfo if successful
278 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
282 login_get_lastlog(struct logininfo *li, const int uid)
286 memset(li, '\0', sizeof(struct logininfo));
290 * If we don't have a 'real' lastlog, we need the username to
291 * reliably search wtmp(x) for the last login (see
296 fatal("login_get_lastlog: Cannot find account for uid %i", uid);
298 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
300 strlcpy(li->username, pw->pw_name, sizeof(li->username));
302 if (getlast_entry(li))
309 /* login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
310 * a logininfo structure
312 * This function creates a new struct logininfo, a data structure
313 * meant to carry the information required to portably record login info.
315 * Returns a pointer to a newly created struct logininfo. If memory
316 * allocation fails, the program halts.
319 logininfo *login_alloc_entry(int pid, const char *username,
320 const char *hostname, const char *line)
322 struct logininfo *newli;
324 newli = (struct logininfo *) xmalloc (sizeof(struct logininfo));
325 (void)login_init_entry(newli, pid, username, hostname, line);
330 /* login_free_entry(struct logininfo *) - free struct memory */
332 login_free_entry(struct logininfo *li)
338 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
339 * - initialise a struct logininfo
341 * Populates a new struct logininfo, a data structure meant to carry
342 * the information required to portably record login info.
347 login_init_entry(struct logininfo *li, int pid, const char *username,
348 const char *hostname, const char *line)
352 memset(li, 0, sizeof(struct logininfo));
356 /* set the line information */
358 line_fullname(li->line, line, sizeof(li->line));
361 strlcpy(li->username, username, sizeof(li->username));
362 pw = getpwnam(li->username);
364 fatal("login_init_entry: Cannot find user \"%s\"", li->username);
365 li->uid = pw->pw_uid;
369 strlcpy(li->hostname, hostname, sizeof(li->hostname));
374 /* login_set_current_time(struct logininfo *) - set the current time
376 * Set the current time in a logininfo structure. This function is
377 * meant to eliminate the need to deal with system dependencies for
381 login_set_current_time(struct logininfo *li)
385 gettimeofday(&tv, NULL);
387 li->tv_sec = tv.tv_sec;
388 li->tv_usec = tv.tv_usec;
391 /* copy a sockaddr_* into our logininfo */
393 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
394 const unsigned int sa_size)
396 unsigned int bufsize = sa_size;
398 /* make sure we don't overrun our union */
399 if (sizeof(li->hostaddr) < sa_size)
400 bufsize = sizeof(li->hostaddr);
402 memcpy((void *)&(li->hostaddr.sa), (const void *)sa, bufsize);
407 ** login_write: Call low-level recording functions based on autoconf
411 login_write (struct logininfo *li)
413 if ((int)geteuid() != 0) {
414 log("Attempt to write login records by non-root user (aborting)");
418 /* set the timestamp */
419 login_set_current_time(li);
421 syslogin_write_entry(li);
424 if (li->type == LTYPE_LOGIN) {
425 lastlog_write_entry(li);
429 utmp_write_entry(li);
432 wtmp_write_entry(li);
435 utmpx_write_entry(li);
438 wtmpx_write_entry(li);
444 ** getlast_entry: Call low-level functions to retrieve the last login
448 /* take the uid in li and return the last login time */
450 getlast_entry(struct logininfo *li)
453 return(lastlog_get_entry(li));
454 #else /* !USE_LASTLOG */
456 #ifdef DISABLE_LASTLOG
457 /* On some systems we shouldn't even try to obtain last login
460 # else /* DISABLE_LASTLOG */
461 /* Try to retrieve the last login time from wtmp */
462 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
463 /* retrieve last login time from utmp */
464 return (wtmp_get_entry(li));
465 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
466 /* If wtmp isn't available, try wtmpx */
467 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
468 /* retrieve last login time from utmpx */
469 return (wtmpx_get_entry(li));
471 /* Give up: No means of retrieving last login time */
473 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
474 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
475 # endif /* DISABLE_LASTLOG */
476 #endif /* USE_LASTLOG */
482 * 'line' string utility functions
484 * These functions process the 'line' string into one of three forms:
486 * 1. The full filename (including '/dev')
487 * 2. The stripped name (excluding '/dev')
488 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
489 * /dev/pts/1 -> ts/1 )
491 * Form 3 is used on some systems to identify a .tmp.? entry when
492 * attempting to remove it. Typically both addition and removal is
493 * performed by one application - say, sshd - so as long as the choice
494 * uniquely identifies a terminal it's ok.
498 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
499 * sure dst has enough space, if not just copy src (ugh) */
501 line_fullname(char *dst, const char *src, int dstsize)
503 memset(dst, '\0', dstsize);
504 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
505 strlcpy(dst, src, dstsize);
507 strlcpy(dst, "/dev/", dstsize);
508 strlcat(dst, src, dstsize);
513 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
515 line_stripname(char *dst, const char *src, int dstsize)
517 memset(dst, '\0', dstsize);
518 if (strncmp(src, "/dev/", 5) == 0)
519 strlcpy(dst, &src[5], dstsize);
521 strlcpy(dst, src, dstsize);
525 /* line_abbrevname(): Return the abbreviated (usually four-character)
526 * form of the line (Just use the last <dstsize> characters of the
529 * NOTE: use strncpy because we do NOT necessarily want zero
532 line_abbrevname(char *dst, const char *src, int dstsize)
536 memset(dst, '\0', dstsize);
541 src += (len - dstsize);
542 strncpy(dst, src, dstsize); /* note: _don't_ change this to strlcpy */
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(struct utmp));
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_user, li->username, MIN_SIZEOF(ut->ut_user, 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(struct utmpx));
650 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 */
727 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
729 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
730 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
732 * Prevent luser from zero'ing out ut_host.
733 * If the new ut_line is empty but the old one is not
734 * and ut_line and ut_name match, preserve the old ut_line.
736 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
737 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
738 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
739 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0)) {
740 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
743 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
744 if (atomicio(write, fd, ut, sizeof(ut)) != sizeof(ut))
745 log("utmp_write_direct: error writing %s: %s",
746 UTMP_FILE, strerror(errno));
754 # endif /* UTMP_USE_LIBRARY */
757 utmp_perform_login(struct logininfo *li)
761 construct_utmp(li, &ut);
762 # ifdef UTMP_USE_LIBRARY
763 if (!utmp_write_library(li, &ut)) {
764 log("utmp_perform_login: utmp_write_library() failed");
768 if (!utmp_write_direct(li, &ut)) {
769 log("utmp_perform_login: utmp_write_direct() failed");
778 utmp_perform_logout(struct logininfo *li)
782 construct_utmp(li, &ut);
783 # ifdef UTMP_USE_LIBRARY
784 if (!utmp_write_library(li, &ut)) {
785 log("utmp_perform_logout: utmp_write_library() failed");
789 if (!utmp_write_direct(li, &ut)) {
790 log("utmp_perform_logout: utmp_write_direct() failed");
799 utmp_write_entry(struct logininfo *li)
803 return utmp_perform_login(li);
806 return utmp_perform_logout(li);
809 log("utmp_write_entry: invalid type field");
813 #endif /* USE_UTMP */
817 ** Low-level utmpx functions
820 /* not much point if we don't want utmpx entries */
823 /* if we have the wherewithall, use pututxline etc. */
824 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
825 defined(HAVE_PUTUTXLINE)
826 # define UTMPX_USE_LIBRARY
830 /* write a utmpx entry with the system's help (pututxline() and pals) */
831 # ifdef UTMPX_USE_LIBRARY
833 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
838 # ifdef HAVE_ENDUTXENT
844 # else /* UTMPX_USE_LIBRARY */
846 /* write a utmp entry direct to the file */
848 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
850 log("utmpx_write_direct: not implemented!");
853 # endif /* UTMPX_USE_LIBRARY */
856 utmpx_perform_login(struct logininfo *li)
860 construct_utmpx(li, &utx);
861 # ifdef UTMPX_USE_LIBRARY
862 if (!utmpx_write_library(li, &utx)) {
863 log("utmpx_perform_login: utmp_write_library() failed");
867 if (!utmpx_write_direct(li, &ut)) {
868 log("utmpx_perform_login: utmp_write_direct() failed");
877 utmpx_perform_logout(struct logininfo *li)
881 memset(&utx, '\0', sizeof(utx));
882 set_utmpx_time(li, &utx);
883 line_stripname(utx.ut_line, li->line, sizeof(utx.ut_line));
884 # ifdef HAVE_ID_IN_UTMPX
885 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
887 # ifdef HAVE_TYPE_IN_UTMPX
888 utx.ut_type = DEAD_PROCESS;
891 # ifdef UTMPX_USE_LIBRARY
892 utmpx_write_library(li, &utx);
894 utmpx_write_direct(li, &utx);
900 utmpx_write_entry(struct logininfo *li)
904 return utmpx_perform_login(li);
906 return utmpx_perform_logout(li);
908 log("utmpx_write_entry: invalid type field");
912 #endif /* USE_UTMPX */
916 ** Low-level wtmp functions
921 /* write a wtmp entry direct to the end of the file */
922 /* This is a slight modification of code in OpenBSD's logwtmp.c */
924 wtmp_write(struct logininfo *li, struct utmp *ut)
929 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
930 log("wtmp_write: problem writing %s: %s",
931 WTMP_FILE, strerror(errno));
934 if (fstat(fd, &buf) == 0)
935 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
936 ftruncate(fd, buf.st_size);
937 log("wtmp_write: problem writing %s: %s",
938 WTMP_FILE, strerror(errno));
946 wtmp_perform_login(struct logininfo *li)
950 construct_utmp(li, &ut);
951 return wtmp_write(li, &ut);
956 wtmp_perform_logout(struct logininfo *li)
960 construct_utmp(li, &ut);
961 return wtmp_write(li, &ut);
966 wtmp_write_entry(struct logininfo *li)
970 return wtmp_perform_login(li);
972 return wtmp_perform_logout(li);
974 log("wtmp_write_entry: invalid type field");
980 /* Notes on fetching login data from wtmp/wtmpx
982 * Logouts are usually recorded with (amongst other things) a blank
983 * username on a given tty line. However, some systems (HP-UX is one)
984 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
986 * Since we're only looking for logins here, we know that the username
987 * must be set correctly. On systems that leave it in, we check for
988 * ut_type==USER_PROCESS (indicating a login.)
990 * Portability: Some systems may set something other than USER_PROCESS
991 * to indicate a login process. I don't know of any as I write. Also,
992 * it's possible that some systems may both leave the username in
993 * place and not have ut_type.
996 /* return true if this wtmp entry indicates a login */
998 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1000 if (strncmp(li->username, ut->ut_user,
1001 MIN_SIZEOF(li->username, ut->ut_user)) == 0) {
1002 # ifdef HAVE_TYPE_IN_UTMP
1003 if (ut->ut_type & USER_PROCESS)
1013 wtmp_get_entry(struct logininfo *li)
1019 /* Clear the time entries in our logininfo */
1020 li->tv_sec = li->tv_usec = 0;
1022 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1023 log("wtmp_get_entry: problem opening %s: %s",
1024 WTMP_FILE, strerror(errno));
1027 if (fstat(fd, &st) != 0) {
1028 log("wtmp_get_entry: couldn't stat %s: %s",
1029 WTMP_FILE, strerror(errno));
1034 /* Seek to the start of the last struct utmp */
1035 if (lseek(fd, (off_t)(0-sizeof(struct utmp)), SEEK_END) == -1) {
1036 /* Looks like we've got a fresh wtmp file */
1042 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1043 log("wtmp_get_entry: read of %s failed: %s",
1044 WTMP_FILE, strerror(errno));
1048 if ( wtmp_islogin(li, &ut) ) {
1050 /* We've already checked for a time in struct
1051 * utmp, in login_getlast(). */
1052 # ifdef HAVE_TIME_IN_UTMP
1053 li->tv_sec = ut.ut_time;
1055 # if HAVE_TV_IN_UTMP
1056 li->tv_sec = ut.ut_tv.tv_sec;
1059 line_fullname(li->line, ut.ut_line,
1060 MIN_SIZEOF(li->line, ut.ut_line));
1061 # ifdef HAVE_HOST_IN_UTMP
1062 strlcpy(li->hostname, ut.ut_host,
1063 MIN_SIZEOF(li->hostname, ut.ut_host));
1067 /* Seek back 2 x struct utmp */
1068 if (lseek(fd, (off_t)(0-2*sizeof(struct utmp)), SEEK_CUR) == -1) {
1069 /* We've found the start of the file, so quit */
1075 /* We found an entry. Tidy up and return */
1079 # endif /* USE_WTMP */
1083 ** Low-level wtmpx functions
1087 /* write a wtmpx entry direct to the end of the file */
1088 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1090 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1095 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1096 log("wtmpx_write: problem opening %s: %s",
1097 WTMPX_FILE, strerror(errno));
1101 if (fstat(fd, &buf) == 0)
1102 if (atomicio(write, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1103 ftruncate(fd, buf.st_size);
1104 log("wtmpx_write: problem writing %s: %s",
1105 WTMPX_FILE, strerror(errno));
1115 wtmpx_perform_login(struct logininfo *li)
1119 construct_utmpx(li, &utx);
1120 return wtmpx_write(li, &utx);
1125 wtmpx_perform_logout(struct logininfo *li)
1129 construct_utmpx(li, &utx);
1130 return wtmpx_write(li, &utx);
1135 wtmpx_write_entry(struct logininfo *li)
1139 return wtmpx_perform_login(li);
1141 return wtmpx_perform_logout(li);
1143 log("wtmpx_write_entry: invalid type field");
1148 /* Please see the notes above wtmp_islogin() for information about the
1149 next two functions */
1151 /* Return true if this wtmpx entry indicates a login */
1153 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1155 if ( strncmp(li->username, utx->ut_user,
1156 MIN_SIZEOF(li->username, utx->ut_user)) == 0 ) {
1157 # ifdef HAVE_TYPE_IN_UTMPX
1158 if (utx->ut_type == USER_PROCESS)
1169 wtmpx_get_entry(struct logininfo *li)
1175 /* Clear the time entries */
1176 li->tv_sec = li->tv_usec = 0;
1178 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1179 log("wtmpx_get_entry: problem opening %s: %s",
1180 WTMPX_FILE, strerror(errno));
1183 if (fstat(fd, &st) != 0) {
1184 log("wtmpx_get_entry: couldn't stat %s: %s",
1185 WTMP_FILE, strerror(errno));
1190 /* Seek to the start of the last struct utmpx */
1191 if (lseek(fd, (off_t)(0-sizeof(struct utmpx)), SEEK_END) == -1 ) {
1192 /* probably a newly rotated wtmpx file */
1198 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1199 log("wtmpx_get_entry: read of %s failed: %s",
1200 WTMPX_FILE, strerror(errno));
1204 /* Logouts are recorded as a blank username on a particular line.
1205 * So, we just need to find the username in struct utmpx */
1206 if ( wtmpx_islogin(li, &utx) ) {
1207 # ifdef HAVE_TV_IN_UTMPX
1208 li->tv_sec = utx.ut_tv.tv_sec;
1210 # ifdef HAVE_TIME_IN_UTMPX
1211 li->tv_sec = utx.ut_time;
1214 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1215 # ifdef HAVE_HOST_IN_UTMPX
1216 strlcpy(li->hostname, utx.ut_host,
1217 MIN_SIZEOF(li->hostname, utx.ut_host));
1221 if (lseek(fd, (off_t)(0-2*sizeof(struct utmpx)), SEEK_CUR) == -1) {
1230 #endif /* USE_WTMPX */
1233 ** Low-level libutil login() functions
1238 syslogin_perform_login(struct logininfo *li)
1242 if (! (ut = (struct utmp *)malloc(sizeof(struct utmp)))) {
1243 log("syslogin_perform_login: couldn't malloc()");
1246 construct_utmp(li, ut);
1253 syslogin_perform_logout(struct logininfo *li)
1258 (void)line_stripname(line, li->line, sizeof(line));
1260 if (!logout(line)) {
1261 log("syslogin_perform_logout: logout() returned an error");
1262 # ifdef HAVE_LOGWTMP
1264 logwtmp(line, "", "");
1267 /* FIXME: (ATL - if the need arises) What to do if we have
1268 * login, but no logout? what if logout but no logwtmp? All
1269 * routines are in libutil so they should all be there,
1276 syslogin_write_entry(struct logininfo *li)
1280 return syslogin_perform_login(li);
1282 return syslogin_perform_logout(li);
1284 log("syslogin_write_entry: Invalid type field");
1288 #endif /* USE_LOGIN */
1290 /* end of file log-syslogin.c */
1293 ** Low-level lastlog functions
1302 lastlog_construct(struct logininfo *li, struct lastlog *last)
1304 /* clear the structure */
1305 memset(last, '\0', sizeof(struct lastlog));
1307 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1308 strlcpy(last->ll_host, li->hostname,
1309 MIN_SIZEOF(last->ll_host, li->hostname));
1310 last->ll_time = li->tv_sec;
1314 lastlog_filetype(char *filename)
1318 if (stat(LASTLOG_FILE, &st) != 0) {
1319 log("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1323 if (S_ISDIR(st.st_mode))
1325 else if (S_ISREG(st.st_mode))
1332 /* open the file (using filemode) and seek to the login entry */
1334 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1338 char lastlog_file[1024];
1340 type = lastlog_filetype(LASTLOG_FILE);
1343 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1346 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1347 LASTLOG_FILE, li->username);
1350 log("lastlog_openseek: %.100s is not a file or directory!",
1355 *fd = open(lastlog_file, filemode);
1357 debug("lastlog_openseek: Couldn't open %s: %s",
1358 lastlog_file, strerror(errno));
1362 /* find this uid's offset in the lastlog file */
1363 offset = (off_t) ( (long)li->uid * sizeof(struct lastlog));
1365 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1366 log("lastlog_openseek: %s->lseek(): %s",
1367 lastlog_file, strerror(errno));
1374 lastlog_perform_login(struct logininfo *li)
1376 struct lastlog last;
1379 /* create our struct lastlog */
1380 lastlog_construct(li, &last);
1382 /* write the entry */
1383 if (lastlog_openseek(li, &fd, O_RDWR|O_CREAT)) {
1384 if (atomicio(write, fd, &last, sizeof(last)) != sizeof(last)) {
1385 log("lastlog_write_filemode: Error writing to %s: %s",
1386 LASTLOG_FILE, strerror(errno));
1396 lastlog_write_entry(struct logininfo *li)
1400 return lastlog_perform_login(li);
1402 log("lastlog_write_entry: Invalid type field");
1408 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1410 line_fullname(li->line, last->ll_line, sizeof(li->line));
1411 strlcpy(li->hostname, last->ll_host,
1412 MIN_SIZEOF(li->hostname, last->ll_host));
1413 li->tv_sec = last->ll_time;
1417 lastlog_get_entry(struct logininfo *li)
1419 struct lastlog last;
1422 if (lastlog_openseek(li, &fd, O_RDONLY)) {
1423 if (atomicio(read, fd, &last, sizeof(last)) != sizeof(last)) {
1424 log("lastlog_get_entry: Error reading from %s: %s",
1425 LASTLOG_FILE, strerror(errno));
1428 lastlog_populate_entry(li, &last);
1435 #endif /* USE_LASTLOG */