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.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 ** loginrec.c: platform-independent login recording and lastlog retrieval
33 The new login code explained
34 ============================
36 This code attempts to provide a common interface to login recording
37 (utmp and friends) and last login time retrieval.
39 Its primary means of achieving this is to use 'struct logininfo', a
40 union of all the useful fields in the various different types of
41 system login record structures one finds on UNIX variants.
43 We depend on autoconf to define which recording methods are to be
44 used, and which fields are contained in the relevant data structures
45 on the local system. Many C preprocessor symbols affect which code
48 The code is designed to make it easy to modify a particular
49 recording method, without affecting other methods nor requiring so
50 many nested conditional compilation blocks as were commonplace in
53 For login recording, we try to use the local system's libraries as
54 these are clearly most likely to work correctly. For utmp systems
55 this usually means login() and logout() or setutent() etc., probably
56 in libutil, along with logwtmp() etc. On these systems, we fall back
57 to writing the files directly if we have to, though this method
58 requires very thorough testing so we do not corrupt local auditing
59 information. These files and their access methods are very system
62 For utmpx systems, the corresponding library functions are
63 setutxent() etc. To the author's knowledge, all utmpx systems have
64 these library functions and so no direct write is attempted. If such
65 a system exists and needs support, direct analogues of the [uw]tmp
68 Retrieving the time of last login ('lastlog') is in some ways even
69 more problemmatic than login recording. Some systems provide a
70 simple table of all users which we seek based on uid and retrieve a
71 relatively standard structure. Others record the same information in
72 a directory with a separate file, and others don't record the
73 information separately at all. For systems in the latter category,
74 we look backwards in the wtmp or wtmpx file for the last login entry
75 for our user. Naturally this is slower and on busy systems could
76 incur a significant performance penalty.
81 In OpenSSH all login recording and retrieval is performed in
82 login.c. Here you'll find working examples. Also, in the logintest.c
83 program there are more examples.
85 Internal handler calling method
86 -------------------------------
88 When a call is made to login_login() or login_logout(), both
89 routines set a struct logininfo flag defining which action (log in,
90 or log out) is to be taken. They both then call login_write(), which
91 calls whichever of the many structure-specific handlers autoconf
92 selects for the local system.
94 The handlers themselves handle system data structure specifics. Both
95 struct utmp and struct utmpx have utility functions (see
96 construct_utmp*()) to try to make it simpler to add extra systems
97 that introduce new features to either structure.
99 While it may seem terribly wasteful to replicate so much similar
100 code for each method, experience has shown that maintaining code to
101 write both struct utmp and utmpx in one function, whilst maintaining
102 support for all systems whether they have library support or not, is
103 a difficult and time-consuming task.
105 Lastlog support proceeds similarly. Functions login_get_lastlog()
106 (and its OpenSSH-tuned friend login_get_lastlog_time()) call
107 getlast_entry(), which tries one of three methods to find the last
108 login time. It uses local system lastlog support if it can,
109 otherwise it tries wtmp or wtmpx before giving up and returning 0,
115 In many cases it's possible to tweak autoconf to select the correct
116 methods for a particular platform, either by improving the detection
117 code (best), or by presetting DISABLE_<method> or CONF_<method>_FILE
118 symbols for the platform.
120 Use logintest to check which symbols are defined before modifying
121 configure.ac and loginrec.c. (You have to build logintest yourself
122 with 'make logintest' as it's not built by default.)
124 Otherwise, patches to the specific method(s) are very helpful!
130 ** homegrown ttyslot()
137 ** Linux (Redhat 6.2, Debian)
139 ** HP-UX 10.20 (gcc only)
141 ** NeXT - M68k/HPPA/Sparc (4.2/3.3)
143 ** Testing required: Please send reports!
148 ** Platforms with known problems:
149 ** Some variants of Slackware Linux
153 #include "includes.h"
157 #include "loginrec.h"
159 #include "atomicio.h"
167 #ifdef HAVE_LIBUTIL_H
168 # include <libutil.h>
172 ** prototypes for helper functions in this file
176 void set_utmp_time(struct logininfo *li, struct utmp *ut);
177 void construct_utmp(struct logininfo *li, struct utmp *ut);
181 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
182 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
185 int utmp_write_entry(struct logininfo *li);
186 int utmpx_write_entry(struct logininfo *li);
187 int wtmp_write_entry(struct logininfo *li);
188 int wtmpx_write_entry(struct logininfo *li);
189 int lastlog_write_entry(struct logininfo *li);
190 int syslogin_write_entry(struct logininfo *li);
192 int getlast_entry(struct logininfo *li);
193 int lastlog_get_entry(struct logininfo *li);
194 int wtmp_get_entry(struct logininfo *li);
195 int wtmpx_get_entry(struct logininfo *li);
197 /* pick the shortest string */
198 #define MIN_SIZEOF(s1,s2) ( sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2) )
201 ** platform-independent login functions
204 /* login_login(struct logininfo *) -Record a login
206 * Call with a pointer to a struct logininfo initialised with
207 * login_init_entry() or login_alloc_entry()
211 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
214 login_login (struct logininfo *li)
216 li->type = LTYPE_LOGIN;
217 return login_write(li);
221 /* login_logout(struct logininfo *) - Record a logout
223 * Call as with login_login()
227 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
230 login_logout(struct logininfo *li)
232 li->type = LTYPE_LOGOUT;
233 return login_write(li);
236 /* login_get_lastlog_time(int) - Retrieve the last login time
238 * Retrieve the last login time for the given uid. Will try to use the
239 * system lastlog facilities if they are available, but will fall back
240 * to looking in wtmp/wtmpx if necessary
243 * 0 on failure, or if user has never logged in
244 * Time in seconds from the epoch if successful
246 * Useful preprocessor symbols:
247 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
249 * USE_LASTLOG: If set, indicates the presence of system lastlog
250 * facilities. If this and DISABLE_LASTLOG are not set,
251 * try to retrieve lastlog information from wtmp/wtmpx.
254 login_get_lastlog_time(const int uid)
258 if (login_get_lastlog(&li, uid))
264 /* login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
266 * Retrieve a logininfo structure populated (only partially) with
267 * information from the system lastlog data, or from wtmp/wtmpx if no
268 * system lastlog information exists.
270 * Note this routine must be given a pre-allocated logininfo.
273 * >0: A pointer to your struct logininfo if successful
274 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
278 login_get_lastlog(struct logininfo *li, const int uid)
282 memset(li, '\0', sizeof(*li));
286 * If we don't have a 'real' lastlog, we need the username to
287 * reliably search wtmp(x) for the last login (see
292 fatal("login_get_lastlog: Cannot find account for uid %i", uid);
294 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
296 strlcpy(li->username, pw->pw_name, sizeof(li->username));
298 if (getlast_entry(li))
305 /* login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
306 * a logininfo structure
308 * This function creates a new struct logininfo, a data structure
309 * meant to carry the information required to portably record login info.
311 * Returns a pointer to a newly created struct logininfo. If memory
312 * allocation fails, the program halts.
315 logininfo *login_alloc_entry(int pid, const char *username,
316 const char *hostname, const char *line)
318 struct logininfo *newli;
320 newli = (struct logininfo *) xmalloc (sizeof(*newli));
321 (void)login_init_entry(newli, pid, username, hostname, line);
326 /* login_free_entry(struct logininfo *) - free struct memory */
328 login_free_entry(struct logininfo *li)
334 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
335 * - initialise a struct logininfo
337 * Populates a new struct logininfo, a data structure meant to carry
338 * the information required to portably record login info.
343 login_init_entry(struct logininfo *li, int pid, const char *username,
344 const char *hostname, const char *line)
348 memset(li, 0, sizeof(*li));
352 /* set the line information */
354 line_fullname(li->line, line, sizeof(li->line));
357 strlcpy(li->username, username, sizeof(li->username));
358 pw = getpwnam(li->username);
360 fatal("login_init_entry: Cannot find user \"%s\"", li->username);
361 li->uid = pw->pw_uid;
365 strlcpy(li->hostname, hostname, sizeof(li->hostname));
370 /* login_set_current_time(struct logininfo *) - set the current time
372 * Set the current time in a logininfo structure. This function is
373 * meant to eliminate the need to deal with system dependencies for
377 login_set_current_time(struct logininfo *li)
381 gettimeofday(&tv, NULL);
383 li->tv_sec = tv.tv_sec;
384 li->tv_usec = tv.tv_usec;
387 /* copy a sockaddr_* into our logininfo */
389 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
390 const unsigned int sa_size)
392 unsigned int bufsize = sa_size;
394 /* make sure we don't overrun our union */
395 if (sizeof(li->hostaddr) < sa_size)
396 bufsize = sizeof(li->hostaddr);
398 memcpy((void *)&(li->hostaddr.sa), (const void *)sa, bufsize);
403 ** login_write: Call low-level recording functions based on autoconf
407 login_write (struct logininfo *li)
410 if ((int)geteuid() != 0) {
411 logit("Attempt to write login records by non-root user (aborting)");
416 /* set the timestamp */
417 login_set_current_time(li);
419 syslogin_write_entry(li);
422 if (li->type == LTYPE_LOGIN) {
423 lastlog_write_entry(li);
427 utmp_write_entry(li);
430 wtmp_write_entry(li);
433 utmpx_write_entry(li);
436 wtmpx_write_entry(li);
438 #ifdef CUSTOM_SYS_AUTH_RECORD_LOGIN
439 if (li->type == LTYPE_LOGIN &&
440 !sys_auth_record_login(li->username,li->hostname,li->line))
441 logit("Writing login record failed for %s", li->username);
446 #ifdef LOGIN_NEEDS_UTMPX
448 login_utmp_only(struct logininfo *li)
450 li->type = LTYPE_LOGIN;
451 login_set_current_time(li);
453 utmp_write_entry(li);
456 wtmp_write_entry(li);
459 utmpx_write_entry(li);
462 wtmpx_write_entry(li);
469 ** getlast_entry: Call low-level functions to retrieve the last login
473 /* take the uid in li and return the last login time */
475 getlast_entry(struct logininfo *li)
478 return(lastlog_get_entry(li));
479 #else /* !USE_LASTLOG */
481 #ifdef DISABLE_LASTLOG
482 /* On some systems we shouldn't even try to obtain last login
485 # else /* DISABLE_LASTLOG */
486 /* Try to retrieve the last login time from wtmp */
487 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
488 /* retrieve last login time from utmp */
489 return (wtmp_get_entry(li));
490 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
491 /* If wtmp isn't available, try wtmpx */
492 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
493 /* retrieve last login time from utmpx */
494 return (wtmpx_get_entry(li));
496 /* Give up: No means of retrieving last login time */
498 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
499 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
500 # endif /* DISABLE_LASTLOG */
501 #endif /* USE_LASTLOG */
507 * 'line' string utility functions
509 * These functions process the 'line' string into one of three forms:
511 * 1. The full filename (including '/dev')
512 * 2. The stripped name (excluding '/dev')
513 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
514 * /dev/pts/1 -> ts/1 )
516 * Form 3 is used on some systems to identify a .tmp.? entry when
517 * attempting to remove it. Typically both addition and removal is
518 * performed by one application - say, sshd - so as long as the choice
519 * uniquely identifies a terminal it's ok.
523 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
524 * sure dst has enough space, if not just copy src (ugh) */
526 line_fullname(char *dst, const char *src, int dstsize)
528 memset(dst, '\0', dstsize);
529 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5))) {
530 strlcpy(dst, src, dstsize);
532 strlcpy(dst, "/dev/", dstsize);
533 strlcat(dst, src, dstsize);
538 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
540 line_stripname(char *dst, const char *src, int dstsize)
542 memset(dst, '\0', dstsize);
543 if (strncmp(src, "/dev/", 5) == 0)
544 strlcpy(dst, src + 5, dstsize);
546 strlcpy(dst, src, dstsize);
550 /* line_abbrevname(): Return the abbreviated (usually four-character)
551 * form of the line (Just use the last <dstsize> characters of the
554 * NOTE: use strncpy because we do NOT necessarily want zero
557 line_abbrevname(char *dst, const char *src, int dstsize)
561 memset(dst, '\0', dstsize);
563 /* Always skip prefix if present */
564 if (strncmp(src, "/dev/", 5) == 0)
567 #ifdef WITH_ABBREV_NO_TTY
568 if (strncmp(src, "tty", 3) == 0)
575 if (((int)len - dstsize) > 0)
576 src += ((int)len - dstsize);
578 /* note: _don't_ change this to strlcpy */
579 strncpy(dst, src, (size_t)dstsize);
586 ** utmp utility functions
588 ** These functions manipulate struct utmp, taking system differences
592 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
594 /* build the utmp structure */
596 set_utmp_time(struct logininfo *li, struct utmp *ut)
598 # ifdef HAVE_TV_IN_UTMP
599 ut->ut_tv.tv_sec = li->tv_sec;
600 ut->ut_tv.tv_usec = li->tv_usec;
602 # ifdef HAVE_TIME_IN_UTMP
603 ut->ut_time = li->tv_sec;
609 construct_utmp(struct logininfo *li,
612 # ifdef HAVE_ADDR_V6_IN_UTMP
613 struct sockaddr_in6 *sa6;
615 memset(ut, '\0', sizeof(*ut));
617 /* First fill out fields used for both logins and logouts */
619 # ifdef HAVE_ID_IN_UTMP
620 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
623 # ifdef HAVE_TYPE_IN_UTMP
624 /* This is done here to keep utmp constants out of struct logininfo */
627 ut->ut_type = USER_PROCESS;
633 ut->ut_type = DEAD_PROCESS;
635 cray_retain_utmp(ut, li->pid);
640 set_utmp_time(li, ut);
642 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
644 # ifdef HAVE_PID_IN_UTMP
645 ut->ut_pid = li->pid;
648 /* If we're logging out, leave all other fields blank */
649 if (li->type == LTYPE_LOGOUT)
653 * These fields are only used when logging in, and are blank
657 /* Use strncpy because we don't necessarily want null termination */
658 strncpy(ut->ut_name, li->username, MIN_SIZEOF(ut->ut_name, li->username));
659 # ifdef HAVE_HOST_IN_UTMP
660 strncpy(ut->ut_host, li->hostname, MIN_SIZEOF(ut->ut_host, li->hostname));
662 # ifdef HAVE_ADDR_IN_UTMP
663 /* this is just a 32-bit IP address */
664 if (li->hostaddr.sa.sa_family == AF_INET)
665 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
667 # ifdef HAVE_ADDR_V6_IN_UTMP
668 /* this is just a 128-bit IPv6 address */
669 if (li->hostaddr.sa.sa_family == AF_INET6) {
670 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
671 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
672 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
673 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
674 ut->ut_addr_v6[1] = 0;
675 ut->ut_addr_v6[2] = 0;
676 ut->ut_addr_v6[3] = 0;
681 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
684 ** utmpx utility functions
686 ** These functions manipulate struct utmpx, accounting for system
690 #if defined(USE_UTMPX) || defined (USE_WTMPX)
691 /* build the utmpx structure */
693 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
695 # ifdef HAVE_TV_IN_UTMPX
696 utx->ut_tv.tv_sec = li->tv_sec;
697 utx->ut_tv.tv_usec = li->tv_usec;
698 # else /* HAVE_TV_IN_UTMPX */
699 # ifdef HAVE_TIME_IN_UTMPX
700 utx->ut_time = li->tv_sec;
701 # endif /* HAVE_TIME_IN_UTMPX */
702 # endif /* HAVE_TV_IN_UTMPX */
706 construct_utmpx(struct logininfo *li, struct utmpx *utx)
708 # ifdef HAVE_ADDR_V6_IN_UTMP
709 struct sockaddr_in6 *sa6;
711 memset(utx, '\0', sizeof(*utx));
712 # ifdef HAVE_ID_IN_UTMPX
713 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
716 /* this is done here to keep utmp constants out of loginrec.h */
719 utx->ut_type = USER_PROCESS;
722 utx->ut_type = DEAD_PROCESS;
725 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
726 set_utmpx_time(li, utx);
727 utx->ut_pid = li->pid;
728 /* strncpy(): Don't necessarily want null termination */
729 strncpy(utx->ut_name, li->username, MIN_SIZEOF(utx->ut_name, li->username));
731 if (li->type == LTYPE_LOGOUT)
735 * These fields are only used when logging in, and are blank
739 # ifdef HAVE_HOST_IN_UTMPX
740 strncpy(utx->ut_host, li->hostname, MIN_SIZEOF(utx->ut_host, li->hostname));
742 # ifdef HAVE_ADDR_IN_UTMPX
743 /* this is just a 32-bit IP address */
744 if (li->hostaddr.sa.sa_family == AF_INET)
745 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
747 # ifdef HAVE_ADDR_V6_IN_UTMP
748 /* this is just a 128-bit IPv6 address */
749 if (li->hostaddr.sa.sa_family == AF_INET6) {
750 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
751 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
752 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
753 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
754 ut->ut_addr_v6[1] = 0;
755 ut->ut_addr_v6[2] = 0;
756 ut->ut_addr_v6[3] = 0;
760 # ifdef HAVE_SYSLEN_IN_UTMPX
761 /* ut_syslen is the length of the utx_host string */
762 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
765 #endif /* USE_UTMPX || USE_WTMPX */
768 ** Low-level utmp functions
771 /* FIXME: (ATL) utmp_write_direct needs testing */
774 /* if we can, use pututline() etc. */
775 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
776 defined(HAVE_PUTUTLINE)
777 # define UTMP_USE_LIBRARY
781 /* write a utmp entry with the system's help (pututline() and pals) */
782 # ifdef UTMP_USE_LIBRARY
784 utmp_write_library(struct logininfo *li, struct utmp *ut)
789 # ifdef HAVE_ENDUTENT
794 # else /* UTMP_USE_LIBRARY */
796 /* write a utmp entry direct to the file */
797 /* This is a slightly modification of code in OpenBSD's login.c */
799 utmp_write_direct(struct logininfo *li, struct utmp *ut)
805 /* FIXME: (ATL) ttyslot() needs local implementation */
807 #if defined(HAVE_GETTTYENT)
808 register struct ttyent *ty;
813 while ((struct ttyent *)0 != (ty = getttyent())) {
815 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
820 if((struct ttyent *)0 == ty) {
821 logit("utmp_write_entry: tty not found");
826 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
828 #endif /* HAVE_GETTTYENT */
830 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
831 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
833 * Prevent luser from zero'ing out ut_host.
834 * If the new ut_line is empty but the old one is not
835 * and ut_line and ut_name match, preserve the old ut_line.
837 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
838 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
839 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
840 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0)) {
841 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
844 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
845 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut))
846 logit("utmp_write_direct: error writing %s: %s",
847 UTMP_FILE, strerror(errno));
855 # endif /* UTMP_USE_LIBRARY */
858 utmp_perform_login(struct logininfo *li)
862 construct_utmp(li, &ut);
863 # ifdef UTMP_USE_LIBRARY
864 if (!utmp_write_library(li, &ut)) {
865 logit("utmp_perform_login: utmp_write_library() failed");
869 if (!utmp_write_direct(li, &ut)) {
870 logit("utmp_perform_login: utmp_write_direct() failed");
879 utmp_perform_logout(struct logininfo *li)
883 construct_utmp(li, &ut);
884 # ifdef UTMP_USE_LIBRARY
885 if (!utmp_write_library(li, &ut)) {
886 logit("utmp_perform_logout: utmp_write_library() failed");
890 if (!utmp_write_direct(li, &ut)) {
891 logit("utmp_perform_logout: utmp_write_direct() failed");
900 utmp_write_entry(struct logininfo *li)
904 return utmp_perform_login(li);
907 return utmp_perform_logout(li);
910 logit("utmp_write_entry: invalid type field");
914 #endif /* USE_UTMP */
918 ** Low-level utmpx functions
921 /* not much point if we don't want utmpx entries */
924 /* if we have the wherewithall, use pututxline etc. */
925 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
926 defined(HAVE_PUTUTXLINE)
927 # define UTMPX_USE_LIBRARY
931 /* write a utmpx entry with the system's help (pututxline() and pals) */
932 # ifdef UTMPX_USE_LIBRARY
934 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
939 # ifdef HAVE_ENDUTXENT
945 # else /* UTMPX_USE_LIBRARY */
947 /* write a utmp entry direct to the file */
949 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
951 logit("utmpx_write_direct: not implemented!");
954 # endif /* UTMPX_USE_LIBRARY */
957 utmpx_perform_login(struct logininfo *li)
961 construct_utmpx(li, &utx);
962 # ifdef UTMPX_USE_LIBRARY
963 if (!utmpx_write_library(li, &utx)) {
964 logit("utmpx_perform_login: utmp_write_library() failed");
968 if (!utmpx_write_direct(li, &ut)) {
969 logit("utmpx_perform_login: utmp_write_direct() failed");
978 utmpx_perform_logout(struct logininfo *li)
982 construct_utmpx(li, &utx);
983 # ifdef HAVE_ID_IN_UTMPX
984 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
986 # ifdef HAVE_TYPE_IN_UTMPX
987 utx.ut_type = DEAD_PROCESS;
990 # ifdef UTMPX_USE_LIBRARY
991 utmpx_write_library(li, &utx);
993 utmpx_write_direct(li, &utx);
999 utmpx_write_entry(struct logininfo *li)
1003 return utmpx_perform_login(li);
1005 return utmpx_perform_logout(li);
1007 logit("utmpx_write_entry: invalid type field");
1011 #endif /* USE_UTMPX */
1015 ** Low-level wtmp functions
1020 /* write a wtmp entry direct to the end of the file */
1021 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1023 wtmp_write(struct logininfo *li, struct utmp *ut)
1028 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1029 logit("wtmp_write: problem writing %s: %s",
1030 WTMP_FILE, strerror(errno));
1033 if (fstat(fd, &buf) == 0)
1034 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
1035 ftruncate(fd, buf.st_size);
1036 logit("wtmp_write: problem writing %s: %s",
1037 WTMP_FILE, strerror(errno));
1045 wtmp_perform_login(struct logininfo *li)
1049 construct_utmp(li, &ut);
1050 return wtmp_write(li, &ut);
1055 wtmp_perform_logout(struct logininfo *li)
1059 construct_utmp(li, &ut);
1060 return wtmp_write(li, &ut);
1065 wtmp_write_entry(struct logininfo *li)
1069 return wtmp_perform_login(li);
1071 return wtmp_perform_logout(li);
1073 logit("wtmp_write_entry: invalid type field");
1079 /* Notes on fetching login data from wtmp/wtmpx
1081 * Logouts are usually recorded with (amongst other things) a blank
1082 * username on a given tty line. However, some systems (HP-UX is one)
1083 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1085 * Since we're only looking for logins here, we know that the username
1086 * must be set correctly. On systems that leave it in, we check for
1087 * ut_type==USER_PROCESS (indicating a login.)
1089 * Portability: Some systems may set something other than USER_PROCESS
1090 * to indicate a login process. I don't know of any as I write. Also,
1091 * it's possible that some systems may both leave the username in
1092 * place and not have ut_type.
1095 /* return true if this wtmp entry indicates a login */
1097 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1099 if (strncmp(li->username, ut->ut_name,
1100 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1101 # ifdef HAVE_TYPE_IN_UTMP
1102 if (ut->ut_type & USER_PROCESS)
1112 wtmp_get_entry(struct logininfo *li)
1118 /* Clear the time entries in our logininfo */
1119 li->tv_sec = li->tv_usec = 0;
1121 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1122 logit("wtmp_get_entry: problem opening %s: %s",
1123 WTMP_FILE, strerror(errno));
1126 if (fstat(fd, &st) != 0) {
1127 logit("wtmp_get_entry: couldn't stat %s: %s",
1128 WTMP_FILE, strerror(errno));
1133 /* Seek to the start of the last struct utmp */
1134 if (lseek(fd, -(off_t)sizeof(struct utmp), SEEK_END) == -1) {
1135 /* Looks like we've got a fresh wtmp file */
1141 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1142 logit("wtmp_get_entry: read of %s failed: %s",
1143 WTMP_FILE, strerror(errno));
1147 if ( wtmp_islogin(li, &ut) ) {
1149 /* We've already checked for a time in struct
1150 * utmp, in login_getlast(). */
1151 # ifdef HAVE_TIME_IN_UTMP
1152 li->tv_sec = ut.ut_time;
1154 # if HAVE_TV_IN_UTMP
1155 li->tv_sec = ut.ut_tv.tv_sec;
1158 line_fullname(li->line, ut.ut_line,
1159 MIN_SIZEOF(li->line, ut.ut_line));
1160 # ifdef HAVE_HOST_IN_UTMP
1161 strlcpy(li->hostname, ut.ut_host,
1162 MIN_SIZEOF(li->hostname, ut.ut_host));
1166 /* Seek back 2 x struct utmp */
1167 if (lseek(fd, -(off_t)(2 * sizeof(struct utmp)), SEEK_CUR) == -1) {
1168 /* We've found the start of the file, so quit */
1174 /* We found an entry. Tidy up and return */
1178 # endif /* USE_WTMP */
1182 ** Low-level wtmpx functions
1186 /* write a wtmpx entry direct to the end of the file */
1187 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1189 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1191 #ifndef HAVE_UPDWTMPX
1195 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1196 logit("wtmpx_write: problem opening %s: %s",
1197 WTMPX_FILE, strerror(errno));
1201 if (fstat(fd, &buf) == 0)
1202 if (atomicio(vwrite, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1203 ftruncate(fd, buf.st_size);
1204 logit("wtmpx_write: problem writing %s: %s",
1205 WTMPX_FILE, strerror(errno));
1212 updwtmpx(WTMPX_FILE, utx);
1219 wtmpx_perform_login(struct logininfo *li)
1223 construct_utmpx(li, &utx);
1224 return wtmpx_write(li, &utx);
1229 wtmpx_perform_logout(struct logininfo *li)
1233 construct_utmpx(li, &utx);
1234 return wtmpx_write(li, &utx);
1239 wtmpx_write_entry(struct logininfo *li)
1243 return wtmpx_perform_login(li);
1245 return wtmpx_perform_logout(li);
1247 logit("wtmpx_write_entry: invalid type field");
1252 /* Please see the notes above wtmp_islogin() for information about the
1253 next two functions */
1255 /* Return true if this wtmpx entry indicates a login */
1257 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1259 if ( strncmp(li->username, utx->ut_name,
1260 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1261 # ifdef HAVE_TYPE_IN_UTMPX
1262 if (utx->ut_type == USER_PROCESS)
1273 wtmpx_get_entry(struct logininfo *li)
1279 /* Clear the time entries */
1280 li->tv_sec = li->tv_usec = 0;
1282 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1283 logit("wtmpx_get_entry: problem opening %s: %s",
1284 WTMPX_FILE, strerror(errno));
1287 if (fstat(fd, &st) != 0) {
1288 logit("wtmpx_get_entry: couldn't stat %s: %s",
1289 WTMPX_FILE, strerror(errno));
1294 /* Seek to the start of the last struct utmpx */
1295 if (lseek(fd, -(off_t)sizeof(struct utmpx), SEEK_END) == -1 ) {
1296 /* probably a newly rotated wtmpx file */
1302 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1303 logit("wtmpx_get_entry: read of %s failed: %s",
1304 WTMPX_FILE, strerror(errno));
1308 /* Logouts are recorded as a blank username on a particular line.
1309 * So, we just need to find the username in struct utmpx */
1310 if ( wtmpx_islogin(li, &utx) ) {
1312 # ifdef HAVE_TV_IN_UTMPX
1313 li->tv_sec = utx.ut_tv.tv_sec;
1315 # ifdef HAVE_TIME_IN_UTMPX
1316 li->tv_sec = utx.ut_time;
1319 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1320 # ifdef HAVE_HOST_IN_UTMPX
1321 strlcpy(li->hostname, utx.ut_host,
1322 MIN_SIZEOF(li->hostname, utx.ut_host));
1326 if (lseek(fd, -(off_t)(2 * sizeof(struct utmpx)), SEEK_CUR) == -1) {
1335 #endif /* USE_WTMPX */
1338 ** Low-level libutil login() functions
1343 syslogin_perform_login(struct logininfo *li)
1347 if (! (ut = (struct utmp *)malloc(sizeof(*ut)))) {
1348 logit("syslogin_perform_login: couldn't malloc()");
1351 construct_utmp(li, ut);
1359 syslogin_perform_logout(struct logininfo *li)
1362 char line[UT_LINESIZE];
1364 (void)line_stripname(line, li->line, sizeof(line));
1366 if (!logout(line)) {
1367 logit("syslogin_perform_logout: logout() returned an error");
1368 # ifdef HAVE_LOGWTMP
1370 logwtmp(line, "", "");
1373 /* FIXME: (ATL - if the need arises) What to do if we have
1374 * login, but no logout? what if logout but no logwtmp? All
1375 * routines are in libutil so they should all be there,
1382 syslogin_write_entry(struct logininfo *li)
1386 return syslogin_perform_login(li);
1388 return syslogin_perform_logout(li);
1390 logit("syslogin_write_entry: Invalid type field");
1394 #endif /* USE_LOGIN */
1396 /* end of file log-syslogin.c */
1399 ** Low-level lastlog functions
1408 lastlog_construct(struct logininfo *li, struct lastlog *last)
1410 /* clear the structure */
1411 memset(last, '\0', sizeof(*last));
1413 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1414 strlcpy(last->ll_host, li->hostname,
1415 MIN_SIZEOF(last->ll_host, li->hostname));
1416 last->ll_time = li->tv_sec;
1420 lastlog_filetype(char *filename)
1424 if (stat(LASTLOG_FILE, &st) != 0) {
1425 logit("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1429 if (S_ISDIR(st.st_mode))
1431 else if (S_ISREG(st.st_mode))
1438 /* open the file (using filemode) and seek to the login entry */
1440 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1444 char lastlog_file[1024];
1446 type = lastlog_filetype(LASTLOG_FILE);
1449 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1452 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1453 LASTLOG_FILE, li->username);
1456 logit("lastlog_openseek: %.100s is not a file or directory!",
1461 *fd = open(lastlog_file, filemode, 0600);
1463 debug("lastlog_openseek: Couldn't open %s: %s",
1464 lastlog_file, strerror(errno));
1468 if (type == LL_FILE) {
1469 /* find this uid's offset in the lastlog file */
1470 offset = (off_t) ((long)li->uid * sizeof(struct lastlog));
1472 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1473 logit("lastlog_openseek: %s->lseek(): %s",
1474 lastlog_file, strerror(errno));
1483 lastlog_perform_login(struct logininfo *li)
1485 struct lastlog last;
1488 /* create our struct lastlog */
1489 lastlog_construct(li, &last);
1491 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1494 /* write the entry */
1495 if (atomicio(vwrite, fd, &last, sizeof(last)) != sizeof(last)) {
1497 logit("lastlog_write_filemode: Error writing to %s: %s",
1498 LASTLOG_FILE, strerror(errno));
1507 lastlog_write_entry(struct logininfo *li)
1511 return lastlog_perform_login(li);
1513 logit("lastlog_write_entry: Invalid type field");
1519 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1521 line_fullname(li->line, last->ll_line, sizeof(li->line));
1522 strlcpy(li->hostname, last->ll_host,
1523 MIN_SIZEOF(li->hostname, last->ll_host));
1524 li->tv_sec = last->ll_time;
1528 lastlog_get_entry(struct logininfo *li)
1530 struct lastlog last;
1533 if (!lastlog_openseek(li, &fd, O_RDONLY))
1536 ret = atomicio(read, fd, &last, sizeof(last));
1541 memset(&last, '\0', sizeof(last));
1544 lastlog_populate_entry(li, &last);
1547 error("%s: Error reading from %s: %s", __func__,
1548 LASTLOG_FILE, strerror(errno));
1551 error("%s: Error reading from %s: Expecting %d, got %d",
1552 __func__, LASTLOG_FILE, sizeof(last), ret);
1559 #endif /* USE_LASTLOG */