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)
288 memset(li, '\0', sizeof(struct logininfo));
292 /* If we don't have a 'real' lastlog, we need the username to
293 * reliably search wtmp(x) for the last login (see
294 * wtmp_get_entry().) */
297 fatal("login_get_lastlog: Cannot find account for uid %i", uid);
299 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
301 strlcpy(li->username, pw->pw_name, sizeof(li->username));
304 if (getlast_entry(li))
311 /* login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
312 * a logininfo structure
314 * This function creates a new struct logininfo, a data structure
315 * meant to carry the information required to portably record login info.
317 * Returns a pointer to a newly created struct logininfo. If memory
318 * allocation fails, the program halts.
321 logininfo *login_alloc_entry(int pid, const char *username,
322 const char *hostname, const char *line)
324 struct logininfo *newli;
326 newli = (struct logininfo *) xmalloc (sizeof(struct logininfo));
327 (void)login_init_entry(newli, pid, username, hostname, line);
332 /* login_free_entry(struct logininfo *) - free struct memory */
334 login_free_entry(struct logininfo *li)
340 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
341 * - initialise a struct logininfo
343 * Populates a new struct logininfo, a data structure meant to carry
344 * the information required to portably record login info.
349 login_init_entry(struct logininfo *li, int pid, const char *username,
350 const char *hostname, const char *line)
354 memset(li, 0, sizeof(struct logininfo));
358 /* set the line information */
360 line_fullname(li->line, line, sizeof(li->line));
363 strlcpy(li->username, username, sizeof(li->username));
364 pw = getpwnam(li->username);
366 fatal("login_init_entry: Cannot find user \"%s\"", li->username);
367 li->uid = pw->pw_uid;
371 strlcpy(li->hostname, hostname, sizeof(li->hostname));
376 /* login_set_current_time(struct logininfo *) - set the current time
378 * Set the current time in a logininfo structure. This function is
379 * meant to eliminate the need to deal with system dependencies for
383 login_set_current_time(struct logininfo *li)
387 gettimeofday(&tv, NULL);
389 li->tv_sec = tv.tv_sec;
390 li->tv_usec = tv.tv_usec;
393 /* copy a sockaddr_* into our logininfo */
395 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
396 const unsigned int sa_size)
398 unsigned int bufsize = sa_size;
400 /* make sure we don't overrun our union */
401 if (sizeof(li->hostaddr) < sa_size)
402 bufsize = sizeof(li->hostaddr);
404 memcpy((void *)&(li->hostaddr.sa), (const void *)sa, bufsize);
409 ** login_write: Call low-level recording functions based on autoconf
413 login_write (struct logininfo *li)
415 if ((int)geteuid() != 0) {
416 log("Attempt to write login records by non-root user (aborting)");
420 /* set the timestamp */
421 login_set_current_time(li);
423 syslogin_write_entry(li);
426 if (li->type == LTYPE_LOGIN) {
427 lastlog_write_entry(li);
431 utmp_write_entry(li);
434 wtmp_write_entry(li);
437 utmpx_write_entry(li);
440 wtmpx_write_entry(li);
446 ** getlast_entry: Call low-level functions to retrieve the last login
450 /* take the uid in li and return the last login time */
452 getlast_entry(struct logininfo *li)
455 if (lastlog_get_entry(li))
459 #else /* !USE_LASTLOG */
461 #ifdef DISABLE_LASTLOG
462 /* On some systems we shouldn't even try to obtain last login
465 # else /* DISABLE_LASTLOG */
466 /* Try to retrieve the last login time from wtmp */
467 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
468 /* retrieve last login time from utmp */
469 return (wtmp_get_entry(li));
470 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
471 /* If wtmp isn't available, try wtmpx */
472 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
473 /* retrieve last login time from utmpx */
474 return (wtmpx_get_entry(li));
476 /* Give up: No means of retrieving last login time */
478 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
479 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
480 # endif /* DISABLE_LASTLOG */
481 #endif /* USE_LASTLOG */
487 * 'line' string utility functions
489 * These functions process the 'line' string into one of three forms:
491 * 1. The full filename (including '/dev')
492 * 2. The stripped name (excluding '/dev')
493 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
494 * /dev/pts/1 -> ts/1 )
496 * Form 3 is used on some systems to identify a .tmp.? entry when
497 * attempting to remove it. Typically both addition and removal is
498 * performed by one application - say, sshd - so as long as the choice
499 * uniquely identifies a terminal it's ok.
503 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
504 * sure dst has enough space, if not just copy src (ugh) */
506 line_fullname(char *dst, const char *src, int dstsize)
508 memset(dst, '\0', dstsize);
509 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
510 strlcpy(dst, src, dstsize);
512 strlcpy(dst, "/dev/", dstsize);
513 strlcat(dst, src, dstsize);
518 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
520 line_stripname(char *dst, const char *src, int dstsize)
522 memset(dst, '\0', dstsize);
523 if (strncmp(src, "/dev/", 5) == 0)
524 strlcpy(dst, &src[5], dstsize);
526 strlcpy(dst, src, dstsize);
530 /* line_abbrevname(): Return the abbreviated (usually four-character)
531 * form of the line (Just use the last <dstsize> characters of the
534 * NOTE: use strncpy because we do NOT necessarily want zero
537 line_abbrevname(char *dst, const char *src, int dstsize)
541 memset(dst, '\0', dstsize);
546 src += (len - dstsize);
547 strncpy(dst, src, dstsize); /* note: _don't_ change this to strlcpy */
554 ** utmp utility functions
556 ** These functions manipulate struct utmp, taking system differences
560 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
562 /* build the utmp structure */
564 set_utmp_time(struct logininfo *li, struct utmp *ut)
566 # ifdef HAVE_TV_IN_UTMP
567 ut->ut_tv.tv_sec = li->tv_sec;
568 ut->ut_tv.tv_usec = li->tv_usec;
570 # ifdef HAVE_TIME_IN_UTMP
571 ut->ut_time = li->tv_sec;
577 construct_utmp(struct logininfo *li,
580 memset(ut, '\0', sizeof(struct utmp));
582 /* First fill out fields used for both logins and logouts */
584 # ifdef HAVE_ID_IN_UTMP
585 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
588 # ifdef HAVE_TYPE_IN_UTMP
589 /* This is done here to keep utmp constants out of struct logininfo */
592 ut->ut_type = USER_PROCESS;
595 ut->ut_type = DEAD_PROCESS;
599 set_utmp_time(li, ut);
601 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
603 # ifdef HAVE_PID_IN_UTMP
604 ut->ut_pid = li->pid;
607 /* If we're logging out, leave all other fields blank */
608 if (li->type == LTYPE_LOGOUT)
612 * These fields are only used when logging in, and are blank
616 /* Use strncpy because we don't necessarily want null termination */
617 strncpy(ut->ut_user, li->username, MIN_SIZEOF(ut->ut_user, li->username));
618 # ifdef HAVE_HOST_IN_UTMP
619 strncpy(ut->ut_host, li->hostname, MIN_SIZEOF(ut->ut_host, li->hostname));
621 # ifdef HAVE_ADDR_IN_UTMP
622 /* this is just a 32-bit IP address */
623 if (li->hostaddr.sa.sa_family == AF_INET)
624 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
627 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
630 ** utmpx utility functions
632 ** These functions manipulate struct utmpx, accounting for system
636 #if defined(USE_UTMPX) || defined (USE_WTMPX)
637 /* build the utmpx structure */
639 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
641 # ifdef HAVE_TV_IN_UTMPX
642 utx->ut_tv.tv_sec = li->tv_sec;
643 utx->ut_tv.tv_usec = li->tv_usec;
644 # else /* HAVE_TV_IN_UTMPX */
645 # ifdef HAVE_TIME_IN_UTMPX
646 utx->ut_time = li->tv_sec;
647 # endif /* HAVE_TIME_IN_UTMPX */
648 # endif /* HAVE_TV_IN_UTMPX */
652 construct_utmpx(struct logininfo *li, struct utmpx *utx)
654 memset(utx, '\0', sizeof(struct utmpx));
655 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
657 /* this is done here to keep utmp constants out of loginrec.h */
660 utx->ut_type = USER_PROCESS;
663 utx->ut_type = DEAD_PROCESS;
666 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
667 set_utmpx_time(li, utx);
668 utx->ut_pid = li->pid;
670 if (li->type == LTYPE_LOGOUT)
674 * These fields are only used when logging in, and are blank
678 /* strncpy(): Don't necessarily want null termination */
679 strncpy(utx->ut_name, li->username, MIN_SIZEOF(utx->ut_name, li->username));
680 # ifdef HAVE_HOST_IN_UTMPX
681 strncpy(utx->ut_host, li->hostname, MIN_SIZEOF(utx->ut_host, li->hostname));
683 # ifdef HAVE_ADDR_IN_UTMPX
684 /* FIXME: (ATL) not supported yet */
686 # ifdef HAVE_SYSLEN_IN_UTMPX
687 /* ut_syslen is the length of the utx_host string */
688 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
691 #endif /* USE_UTMPX || USE_WTMPX */
694 ** Low-level utmp functions
697 /* FIXME: (ATL) utmp_write_direct needs testing */
700 /* if we can, use pututline() etc. */
701 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
702 defined(HAVE_PUTUTLINE)
703 # define UTMP_USE_LIBRARY
707 /* write a utmp entry with the system's help (pututline() and pals) */
708 # ifdef UTMP_USE_LIBRARY
710 utmp_write_library(struct logininfo *li, struct utmp *ut)
715 # ifdef HAVE_ENDUTENT
720 # else /* UTMP_USE_LIBRARY */
722 /* write a utmp entry direct to the file */
723 /* This is a slightly modification of code in OpenBSD's login.c */
725 utmp_write_direct(struct logininfo *li, struct utmp *ut)
731 /* FIXME: (ATL) ttyslot() needs local implementation */
732 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
734 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
735 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
737 * Prevent luser from zero'ing out ut_host.
738 * If the new ut_line is empty but the old one is not
739 * and ut_line and ut_name match, preserve the old ut_line.
741 if ( read(fd, &old_ut, sizeof(struct utmp)) == sizeof(struct utmp)
742 && ut->ut_host[0] == '\0'
743 && old_ut.ut_host[0] != '\0'
744 && strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0
745 && strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0 )
746 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
748 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
749 if (write(fd, ut, sizeof(struct utmp))==-1)
750 log("utmp_write_direct: error writing %s: %s",
751 UTMP_FILE, strerror(errno));
758 # endif /* UTMP_USE_LIBRARY */
761 utmp_perform_login(struct logininfo *li)
765 construct_utmp(li, &ut);
766 # ifdef UTMP_USE_LIBRARY
767 if (!utmp_write_library(li, &ut)) {
768 log("utmp_perform_login: utmp_write_library() failed");
772 if (!utmp_write_direct(li, &ut)) {
773 log("utmp_perform_login: utmp_write_direct() failed");
782 utmp_perform_logout(struct logininfo *li)
786 construct_utmp(li, &ut);
787 # ifdef UTMP_USE_LIBRARY
788 if (!utmp_write_library(li, &ut)) {
789 log("utmp_perform_logout: utmp_write_library() failed");
793 if (!utmp_write_direct(li, &ut)) {
794 log("utmp_perform_logout: utmp_write_direct() failed");
803 utmp_write_entry(struct logininfo *li)
807 return utmp_perform_login(li);
810 return utmp_perform_logout(li);
813 log("utmp_write_entry: invalid type field");
817 #endif /* USE_UTMP */
821 ** Low-level utmpx functions
824 /* not much point if we don't want utmpx entries */
827 /* if we have the wherewithall, use pututxline etc. */
828 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
829 defined(HAVE_PUTUTXLINE)
830 # define UTMPX_USE_LIBRARY
834 /* write a utmpx entry with the system's help (pututxline() and pals) */
835 # ifdef UTMPX_USE_LIBRARY
837 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
842 # ifdef HAVE_ENDUTXENT
848 # else /* UTMPX_USE_LIBRARY */
850 /* write a utmp entry direct to the file */
852 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
854 log("utmpx_write_direct: not implemented!");
857 # endif /* UTMPX_USE_LIBRARY */
860 utmpx_perform_login(struct logininfo *li)
864 construct_utmpx(li, &utx);
865 # ifdef UTMPX_USE_LIBRARY
866 if (!utmpx_write_library(li, &utx)) {
867 log("utmpx_perform_login: utmp_write_library() failed");
871 if (!utmpx_write_direct(li, &ut)) {
872 log("utmpx_perform_login: utmp_write_direct() failed");
881 utmpx_perform_logout(struct logininfo *li)
885 memset(&utx, '\0', sizeof(utx));
886 set_utmpx_time(li, &utx);
887 line_stripname(utx.ut_line, li->line, sizeof(utx.ut_line));
888 # ifdef HAVE_ID_IN_UTMPX
889 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
891 # ifdef HAVE_TYPE_IN_UTMPX
892 utx.ut_type = DEAD_PROCESS;
895 # ifdef UTMPX_USE_LIBRARY
896 utmpx_write_library(li, &utx);
898 utmpx_write_direct(li, &utx);
904 utmpx_write_entry(struct logininfo *li)
908 return utmpx_perform_login(li);
910 return utmpx_perform_logout(li);
912 log("utmpx_write_entry: invalid type field");
916 #endif /* USE_UTMPX */
920 ** Low-level wtmp functions
925 /* write a wtmp entry direct to the end of the file */
926 /* This is a slight modification of code in OpenBSD's logwtmp.c */
928 wtmp_write(struct logininfo *li, struct utmp *ut)
933 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
934 log("wtmp_write: problem writing %s: %s",
935 WTMP_FILE, strerror(errno));
938 if (fstat(fd, &buf) == 0)
939 if (write(fd, (char *)ut, sizeof(struct utmp)) !=
940 sizeof(struct utmp)) {
941 ftruncate(fd, buf.st_size);
942 log("wtmp_write: problem writing %s: %s",
943 WTMP_FILE, strerror(errno));
951 wtmp_perform_login(struct logininfo *li)
955 construct_utmp(li, &ut);
956 return wtmp_write(li, &ut);
961 wtmp_perform_logout(struct logininfo *li)
965 construct_utmp(li, &ut);
966 return wtmp_write(li, &ut);
971 wtmp_write_entry(struct logininfo *li)
975 return wtmp_perform_login(li);
977 return wtmp_perform_logout(li);
979 log("wtmp_write_entry: invalid type field");
985 /* Notes on fetching login data from wtmp/wtmpx
987 * Logouts are usually recorded with (amongst other things) a blank
988 * username on a given tty line. However, some systems (HP-UX is one)
989 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
991 * Since we're only looking for logins here, we know that the username
992 * must be set correctly. On systems that leave it in, we check for
993 * ut_type==USER_PROCESS (indicating a login.)
995 * Portability: Some systems may set something other than USER_PROCESS
996 * to indicate a login process. I don't know of any as I write. Also,
997 * it's possible that some systems may both leave the username in
998 * place and not have ut_type.
1001 /* return true if this wtmp entry indicates a login */
1003 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1005 if (strncmp(li->username, ut->ut_user,
1006 MIN_SIZEOF(li->username, ut->ut_user)) == 0) {
1007 # ifdef HAVE_TYPE_IN_UTMP
1008 if (ut->ut_type & USER_PROCESS)
1018 wtmp_get_entry(struct logininfo *li)
1024 /* Clear the time entries in our logininfo */
1025 li->tv_sec = li->tv_usec = 0;
1027 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1028 log("wtmp_get_entry: problem opening %s: %s",
1029 WTMP_FILE, strerror(errno));
1032 if (fstat(fd, &st) != 0) {
1033 log("wtmp_get_entry: couldn't stat %s: %s",
1034 WTMP_FILE, strerror(errno));
1039 /* Seek to the start of the last struct utmp */
1040 if (lseek(fd, (off_t)(0-sizeof(struct utmp)), SEEK_END) == -1) {
1041 /* Looks like we've got a fresh wtmp file */
1047 if (read(fd, &ut, sizeof(ut)) != sizeof(ut)) {
1048 log("wtmp_get_entry: read of %s failed: %s",
1049 WTMP_FILE, strerror(errno));
1053 if ( wtmp_islogin(li, &ut) ) {
1055 /* We've already checked for a time in struct
1056 * utmp, in login_getlast(). */
1057 # ifdef HAVE_TIME_IN_UTMP
1058 li->tv_sec = ut.ut_time;
1060 # if HAVE_TV_IN_UTMP
1061 li->tv_sec = ut.ut_tv.tv_sec;
1064 line_fullname(li->line, ut.ut_line,
1065 MIN_SIZEOF(li->line, ut.ut_line));
1066 # ifdef HAVE_HOST_IN_UTMP
1067 strlcpy(li->hostname, ut.ut_host,
1068 MIN_SIZEOF(li->hostname, ut.ut_host));
1072 /* Seek back 2 x struct utmp */
1073 if (lseek(fd, (off_t)(0-2*sizeof(struct utmp)), SEEK_CUR) == -1) {
1074 /* We've found the start of the file, so quit */
1080 /* We found an entry. Tidy up and return */
1084 # endif /* USE_WTMP */
1088 ** Low-level wtmpx functions
1092 /* write a wtmpx entry direct to the end of the file */
1093 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1095 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1100 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1101 log("wtmpx_write: problem opening %s: %s",
1102 WTMPX_FILE, strerror(errno));
1106 if (fstat(fd, &buf) == 0)
1107 if (write(fd, (char *)utx, sizeof(struct utmpx)) !=
1108 sizeof(struct utmpx)) {
1109 ftruncate(fd, buf.st_size);
1110 log("wtmpx_write: problem writing %s: %s",
1111 WTMPX_FILE, strerror(errno));
1121 wtmpx_perform_login(struct logininfo *li)
1125 construct_utmpx(li, &utx);
1126 return wtmpx_write(li, &utx);
1131 wtmpx_perform_logout(struct logininfo *li)
1135 construct_utmpx(li, &utx);
1136 return wtmpx_write(li, &utx);
1141 wtmpx_write_entry(struct logininfo *li)
1145 return wtmpx_perform_login(li);
1147 return wtmpx_perform_logout(li);
1149 log("wtmpx_write_entry: invalid type field");
1154 /* Please see the notes above wtmp_islogin() for information about the
1155 next two functions */
1157 /* Return true if this wtmpx entry indicates a login */
1159 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1161 if ( strncmp(li->username, utx->ut_user,
1162 MIN_SIZEOF(li->username, utx->ut_user)) == 0 ) {
1163 # ifdef HAVE_TYPE_IN_UTMPX
1164 if (utx->ut_type == USER_PROCESS)
1175 wtmpx_get_entry(struct logininfo *li)
1181 /* Clear the time entries */
1182 li->tv_sec = li->tv_usec = 0;
1184 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1185 log("wtmpx_get_entry: problem opening %s: %s",
1186 WTMPX_FILE, strerror(errno));
1189 if (fstat(fd, &st) != 0) {
1190 log("wtmpx_get_entry: couldn't stat %s: %s",
1191 WTMP_FILE, strerror(errno));
1196 /* Seek to the start of the last struct utmpx */
1197 if (lseek(fd, (off_t)(0-sizeof(struct utmpx)), SEEK_END) == -1 ) {
1198 /* probably a newly rotated wtmpx file */
1204 if (read(fd, &utx, sizeof(utx)) != sizeof(utx)) {
1205 log("wtmpx_get_entry: read of %s failed: %s",
1206 WTMPX_FILE, strerror(errno));
1210 /* Logouts are recorded as a blank username on a particular line.
1211 * So, we just need to find the username in struct utmpx */
1212 if ( wtmpx_islogin(li, &utx) ) {
1213 # ifdef HAVE_TV_IN_UTMPX
1214 li->tv_sec = utx.ut_tv.tv_sec;
1216 # ifdef HAVE_TIME_IN_UTMPX
1217 li->tv_sec = utx.ut_time;
1220 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1221 # ifdef HAVE_HOST_IN_UTMPX
1222 strlcpy(li->hostname, utx.ut_host,
1223 MIN_SIZEOF(li->hostname, utx.ut_host));
1227 if (lseek(fd, (off_t)(0-2*sizeof(struct utmpx)), SEEK_CUR) == -1) {
1236 #endif /* USE_WTMPX */
1239 ** Low-level libutil login() functions
1244 syslogin_perform_login(struct logininfo *li)
1248 if (! (ut = (struct utmp *)malloc(sizeof(struct utmp)))) {
1249 log("syslogin_perform_login: couldn't malloc()");
1252 construct_utmp(li, ut);
1259 syslogin_perform_logout(struct logininfo *li)
1264 (void)line_stripname(line, li->line, sizeof(line));
1266 if (!logout(line)) {
1267 log("syslogin_perform_logout: logout() returned an error");
1268 # ifdef HAVE_LOGWTMP
1270 logwtmp(line, "", "");
1273 /* FIXME: (ATL - if the need arises) What to do if we have
1274 * login, but no logout? what if logout but no logwtmp? All
1275 * routines are in libutil so they should all be there,
1282 syslogin_write_entry(struct logininfo *li)
1286 return syslogin_perform_login(li);
1288 return syslogin_perform_logout(li);
1290 log("syslogin_write_entry: Invalid type field");
1294 #endif /* USE_LOGIN */
1296 /* end of file log-syslogin.c */
1299 ** Low-level lastlog functions
1308 lastlog_construct(struct logininfo *li, struct lastlog *last)
1310 /* clear the structure */
1311 memset(last, '\0', sizeof(struct lastlog));
1313 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1314 strlcpy(last->ll_host, li->hostname,
1315 MIN_SIZEOF(last->ll_host, li->hostname));
1316 last->ll_time = li->tv_sec;
1320 lastlog_filetype(char *filename)
1324 if (stat(LASTLOG_FILE, &st) != 0) {
1325 log("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1329 if (S_ISDIR(st.st_mode))
1331 else if (S_ISREG(st.st_mode))
1338 /* open the file (using filemode) and seek to the login entry */
1340 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1344 char lastlog_file[1024];
1346 type = lastlog_filetype(LASTLOG_FILE);
1349 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1352 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1353 LASTLOG_FILE, li->username);
1356 log("lastlog_openseek: %.100s is not a file or directory!",
1361 *fd = open(lastlog_file, filemode);
1363 log("lastlog_openseek: Couldn't open %s: %s",
1364 lastlog_file, strerror(errno));
1368 /* find this uid's offset in the lastlog file */
1369 offset = (off_t) ( (long)li->uid * sizeof(struct lastlog));
1371 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1372 log("lastlog_openseek: %s->lseek(): %s",
1373 lastlog_file, strerror(errno));
1380 lastlog_perform_login(struct logininfo *li)
1382 struct lastlog last;
1385 /* create our struct lastlog */
1386 lastlog_construct(li, &last);
1388 /* write the entry */
1389 if (lastlog_openseek(li, &fd, O_RDWR)) {
1390 if (write(fd, &last, sizeof(struct lastlog)) !=
1391 sizeof(struct lastlog)) {
1392 log("lastlog_write_filemode: Error writing to %s: %s",
1393 LASTLOG_FILE, strerror(errno));
1403 lastlog_write_entry(struct logininfo *li)
1407 return lastlog_perform_login(li);
1409 log("lastlog_write_entry: Invalid type field");
1415 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1417 line_fullname(li->line, last->ll_line, sizeof(li->line));
1418 strlcpy(li->hostname, last->ll_host,
1419 MIN_SIZEOF(li->hostname, last->ll_host));
1420 li->tv_sec = last->ll_time;
1424 lastlog_get_entry(struct logininfo *li)
1426 struct lastlog last;
1429 if (lastlog_openseek(li, &fd, O_RDONLY)) {
1430 if ( read(fd, &last, sizeof(struct lastlog)) !=
1431 sizeof(struct lastlog) ) {
1432 log("lastlog_write_filemode: Error reading from %s: %s",
1433 LASTLOG_FILE, strerror(errno));
1436 lastlog_populate_entry(li, &last);
1443 #endif /* USE_LASTLOG */