2 * Copyright (c) 2000 Andre Lucas. All rights reserved.
3 * Portions copyright (c) 1998 Todd C. Miller
4 * Portions copyright (c) 1996 Jason Downs
5 * Portions copyright (c) 1996 Theo de Raadt
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Markus Friedl.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 ** loginrec.c: platform-independent login recording and lastlog retrieval
38 The new login code explained
39 ============================
41 This code attempts to provide a common interface to login recording
42 (utmp and friends) and last login time retrieval.
44 Its primary means of achieving this is to use 'struct logininfo', a
45 union of all the useful fields in the various different types of
46 system login record structures one finds on UNIX variants.
48 We depend on autoconf to define which recording methods are to be
49 used, and which fields are contained in the relevant data structures
50 on the local system. Many C preprocessor symbols affect which code
53 The code is designed to make it easy to modify a particular
54 recording method, without affecting other methods nor requiring so
55 many nested conditional compilation blocks as were commonplace in
58 For login recording, we try to use the local system's libraries as
59 these are clearly most likely to work correctly. For utmp systems
60 this usually means login() and logout() or setutent() etc., probably
61 in libutil, along with logwtmp() etc. On these systems, we fall back
62 to writing the files directly if we have to, though this method
63 requires very thorough testing so we do not corrupt local auditing
64 information. These files and their access methods are very system
67 For utmpx systems, the corresponding library functions are
68 setutxent() etc. To the author's knowledge, all utmpx systems have
69 these library functions and so no direct write is attempted. If such
70 a system exists and needs support, direct analogues of the [uw]tmp
73 Retrieving the time of last login ('lastlog') is in some ways even
74 more problemmatic than login recording. Some systems provide a
75 simple table of all users which we seek based on uid and retrieve a
76 relatively standard structure. Others record the same information in
77 a directory with a separate file, and others don't record the
78 information separately at all. For systems in the latter category,
79 we look backwards in the wtmp or wtmpx file for the last login entry
80 for our user. Naturally this is slower and on busy systems could
81 incur a significant performance penalty.
86 In OpenSSH all login recording and retrieval is performed in
87 login.c. Here you'll find working examples. Also, in the logintest.c
88 program there are more examples.
90 Internal handler calling method
91 -------------------------------
93 When a call is made to login_login() or login_logout(), both
94 routines set a struct logininfo flag defining which action (log in,
95 or log out) is to be taken. They both then call login_write(), which
96 calls whichever of the many structure-specific handlers autoconf
97 selects for the local system.
99 The handlers themselves handle system data structure specifics. Both
100 struct utmp and struct utmpx have utility functions (see
101 construct_utmp*()) to try to make it simpler to add extra systems
102 that introduce new features to either structure.
104 While it may seem terribly wasteful to replicate so much similar
105 code for each method, experience has shown that maintaining code to
106 write both struct utmp and utmpx in one function, whilst maintaining
107 support for all systems whether they have library support or not, is
108 a difficult and time-consuming task.
110 Lastlog support proceeds similarly. Functions login_get_lastlog()
111 (and its OpenSSH-tuned friend login_get_lastlog_time()) call
112 getlast_entry(), which tries one of three methods to find the last
113 login time. It uses local system lastlog support if it can,
114 otherwise it tries wtmp or wtmpx before giving up and returning 0,
120 In many cases it's possible to tweak autoconf to select the correct
121 methods for a particular platform, either by improving the detection
122 code (best), or by presetting DISABLE_<method> or CONF_<method>_FILE
123 symbols for the platform.
125 Use logintest to check which symbols are defined before modifying
126 configure.in and loginrec.c. (You have to build logintest yourself
127 with 'make logintest' as it's not built by default.)
129 Otherwise, patches to the specific method(s) are very helpful!
135 ** homegrown ttyslot()
142 ** Linux (Redhat 6.2, Debian)
144 ** HP-UX 10.20 (gcc only)
146 ** NeXT - M68k/HPPA/Sparc (4.2/3.3)
148 ** Testing required: Please send reports!
153 ** Platforms with known problems:
154 ** Some variants of Slackware Linux
158 #include "includes.h"
162 #include "loginrec.h"
171 ** prototypes for helper functions in this file
175 void set_utmp_time(struct logininfo *li, struct utmp *ut);
176 void construct_utmp(struct logininfo *li, struct utmp *ut);
180 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
181 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
184 int utmp_write_entry(struct logininfo *li);
185 int utmpx_write_entry(struct logininfo *li);
186 int wtmp_write_entry(struct logininfo *li);
187 int wtmpx_write_entry(struct logininfo *li);
188 int lastlog_write_entry(struct logininfo *li);
189 int syslogin_write_entry(struct logininfo *li);
191 int getlast_entry(struct logininfo *li);
192 int lastlog_get_entry(struct logininfo *li);
193 int wtmp_get_entry(struct logininfo *li);
194 int wtmpx_get_entry(struct logininfo *li);
196 /* pick the shortest string */
197 #define MIN_SIZEOF(s1,s2) ( sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2) )
200 ** platform-independent login functions
203 /* login_login(struct logininfo *) -Record a login
205 * Call with a pointer to a struct logininfo initialised with
206 * login_init_entry() or login_alloc_entry()
210 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
213 login_login (struct logininfo *li)
215 li->type = LTYPE_LOGIN;
216 return login_write(li);
220 /* login_logout(struct logininfo *) - Record a logout
222 * Call as with login_login()
226 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
229 login_logout(struct logininfo *li)
231 li->type = LTYPE_LOGOUT;
232 return login_write(li);
235 /* login_get_lastlog_time(int) - Retrieve the last login time
237 * Retrieve the last login time for the given uid. Will try to use the
238 * system lastlog facilities if they are available, but will fall back
239 * to looking in wtmp/wtmpx if necessary
242 * 0 on failure, or if user has never logged in
243 * Time in seconds from the epoch if successful
245 * Useful preprocessor symbols:
246 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
248 * USE_LASTLOG: If set, indicates the presence of system lastlog
249 * facilities. If this and DISABLE_LASTLOG are not set,
250 * try to retrieve lastlog information from wtmp/wtmpx.
253 login_get_lastlog_time(const int uid)
257 if (login_get_lastlog(&li, uid))
263 /* login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
265 * Retrieve a logininfo structure populated (only partially) with
266 * information from the system lastlog data, or from wtmp/wtmpx if no
267 * system lastlog information exists.
269 * Note this routine must be given a pre-allocated logininfo.
272 * >0: A pointer to your struct logininfo if successful
273 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
277 login_get_lastlog(struct logininfo *li, const int uid)
281 memset(li, '\0', sizeof(*li));
285 * If we don't have a 'real' lastlog, we need the username to
286 * reliably search wtmp(x) for the last login (see
291 fatal("login_get_lastlog: Cannot find account for uid %i", uid);
293 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
295 strlcpy(li->username, pw->pw_name, sizeof(li->username));
297 if (getlast_entry(li))
304 /* login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
305 * a logininfo structure
307 * This function creates a new struct logininfo, a data structure
308 * meant to carry the information required to portably record login info.
310 * Returns a pointer to a newly created struct logininfo. If memory
311 * allocation fails, the program halts.
314 logininfo *login_alloc_entry(int pid, const char *username,
315 const char *hostname, const char *line)
317 struct logininfo *newli;
319 newli = (struct logininfo *) xmalloc (sizeof(*newli));
320 (void)login_init_entry(newli, pid, username, hostname, line);
325 /* login_free_entry(struct logininfo *) - free struct memory */
327 login_free_entry(struct logininfo *li)
333 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
334 * - initialise a struct logininfo
336 * Populates a new struct logininfo, a data structure meant to carry
337 * the information required to portably record login info.
342 login_init_entry(struct logininfo *li, int pid, const char *username,
343 const char *hostname, const char *line)
347 memset(li, 0, sizeof(*li));
351 /* set the line information */
353 line_fullname(li->line, line, sizeof(li->line));
356 strlcpy(li->username, username, sizeof(li->username));
357 pw = getpwnam(li->username);
359 fatal("login_init_entry: Cannot find user \"%s\"", li->username);
360 li->uid = pw->pw_uid;
364 strlcpy(li->hostname, hostname, sizeof(li->hostname));
369 /* login_set_current_time(struct logininfo *) - set the current time
371 * Set the current time in a logininfo structure. This function is
372 * meant to eliminate the need to deal with system dependencies for
376 login_set_current_time(struct logininfo *li)
380 gettimeofday(&tv, NULL);
382 li->tv_sec = tv.tv_sec;
383 li->tv_usec = tv.tv_usec;
386 /* copy a sockaddr_* into our logininfo */
388 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
389 const unsigned int sa_size)
391 unsigned int bufsize = sa_size;
393 /* make sure we don't overrun our union */
394 if (sizeof(li->hostaddr) < sa_size)
395 bufsize = sizeof(li->hostaddr);
397 memcpy((void *)&(li->hostaddr.sa), (const void *)sa, bufsize);
402 ** login_write: Call low-level recording functions based on autoconf
406 login_write (struct logininfo *li)
409 if ((int)geteuid() != 0) {
410 log("Attempt to write login records by non-root user (aborting)");
415 /* set the timestamp */
416 login_set_current_time(li);
418 syslogin_write_entry(li);
421 if (li->type == LTYPE_LOGIN) {
422 lastlog_write_entry(li);
426 utmp_write_entry(li);
429 wtmp_write_entry(li);
432 utmpx_write_entry(li);
435 wtmpx_write_entry(li);
441 ** getlast_entry: Call low-level functions to retrieve the last login
445 /* take the uid in li and return the last login time */
447 getlast_entry(struct logininfo *li)
450 return(lastlog_get_entry(li));
451 #else /* !USE_LASTLOG */
453 #ifdef DISABLE_LASTLOG
454 /* On some systems we shouldn't even try to obtain last login
457 # else /* DISABLE_LASTLOG */
458 /* Try to retrieve the last login time from wtmp */
459 # if defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
460 /* retrieve last login time from utmp */
461 return (wtmp_get_entry(li));
462 # else /* defined(USE_WTMP) && (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP)) */
463 /* If wtmp isn't available, try wtmpx */
464 # if defined(USE_WTMPX) && (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
465 /* retrieve last login time from utmpx */
466 return (wtmpx_get_entry(li));
468 /* Give up: No means of retrieving last login time */
470 # endif /* USE_WTMPX && (HAVE_TIME_IN_UTMPX || HAVE_TV_IN_UTMPX) */
471 # endif /* USE_WTMP && (HAVE_TIME_IN_UTMP || HAVE_TV_IN_UTMP) */
472 # endif /* DISABLE_LASTLOG */
473 #endif /* USE_LASTLOG */
479 * 'line' string utility functions
481 * These functions process the 'line' string into one of three forms:
483 * 1. The full filename (including '/dev')
484 * 2. The stripped name (excluding '/dev')
485 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
486 * /dev/pts/1 -> ts/1 )
488 * Form 3 is used on some systems to identify a .tmp.? entry when
489 * attempting to remove it. Typically both addition and removal is
490 * performed by one application - say, sshd - so as long as the choice
491 * uniquely identifies a terminal it's ok.
495 /* line_fullname(): add the leading '/dev/' if it doesn't exist make
496 * sure dst has enough space, if not just copy src (ugh) */
498 line_fullname(char *dst, const char *src, int dstsize)
500 memset(dst, '\0', dstsize);
501 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5))) {
502 strlcpy(dst, src, dstsize);
504 strlcpy(dst, "/dev/", dstsize);
505 strlcat(dst, src, dstsize);
510 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
512 line_stripname(char *dst, const char *src, int dstsize)
514 memset(dst, '\0', dstsize);
515 if (strncmp(src, "/dev/", 5) == 0)
516 strlcpy(dst, src + 5, dstsize);
518 strlcpy(dst, src, dstsize);
522 /* line_abbrevname(): Return the abbreviated (usually four-character)
523 * form of the line (Just use the last <dstsize> characters of the
526 * NOTE: use strncpy because we do NOT necessarily want zero
529 line_abbrevname(char *dst, const char *src, int dstsize)
533 memset(dst, '\0', dstsize);
535 /* Always skip prefix if present */
537 if (strncmp(src, "/dev/tty", 8) == 0)
540 if (strncmp(src, "/dev/", 5) == 0)
547 if (((int)len - dstsize) > 0)
548 src += ((int)len - dstsize);
550 /* note: _don't_ change this to strlcpy */
551 strncpy(dst, src, (size_t)dstsize);
558 ** utmp utility functions
560 ** These functions manipulate struct utmp, taking system differences
564 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
566 /* build the utmp structure */
568 set_utmp_time(struct logininfo *li, struct utmp *ut)
570 # ifdef HAVE_TV_IN_UTMP
571 ut->ut_tv.tv_sec = li->tv_sec;
572 ut->ut_tv.tv_usec = li->tv_usec;
574 # ifdef HAVE_TIME_IN_UTMP
575 ut->ut_time = li->tv_sec;
581 construct_utmp(struct logininfo *li,
584 memset(ut, '\0', sizeof(*ut));
586 /* First fill out fields used for both logins and logouts */
588 # ifdef HAVE_ID_IN_UTMP
589 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
592 # ifdef HAVE_TYPE_IN_UTMP
593 /* This is done here to keep utmp constants out of struct logininfo */
596 ut->ut_type = USER_PROCESS;
599 ut->ut_type = DEAD_PROCESS;
603 set_utmp_time(li, ut);
605 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
607 # ifdef HAVE_PID_IN_UTMP
608 ut->ut_pid = li->pid;
611 /* If we're logging out, leave all other fields blank */
612 if (li->type == LTYPE_LOGOUT)
616 * These fields are only used when logging in, and are blank
620 /* Use strncpy because we don't necessarily want null termination */
621 strncpy(ut->ut_name, li->username, MIN_SIZEOF(ut->ut_name, li->username));
622 # ifdef HAVE_HOST_IN_UTMP
623 strncpy(ut->ut_host, li->hostname, MIN_SIZEOF(ut->ut_host, li->hostname));
625 # ifdef HAVE_ADDR_IN_UTMP
626 /* this is just a 32-bit IP address */
627 if (li->hostaddr.sa.sa_family == AF_INET)
628 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
631 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
634 ** utmpx utility functions
636 ** These functions manipulate struct utmpx, accounting for system
640 #if defined(USE_UTMPX) || defined (USE_WTMPX)
641 /* build the utmpx structure */
643 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
645 # ifdef HAVE_TV_IN_UTMPX
646 utx->ut_tv.tv_sec = li->tv_sec;
647 utx->ut_tv.tv_usec = li->tv_usec;
648 # else /* HAVE_TV_IN_UTMPX */
649 # ifdef HAVE_TIME_IN_UTMPX
650 utx->ut_time = li->tv_sec;
651 # endif /* HAVE_TIME_IN_UTMPX */
652 # endif /* HAVE_TV_IN_UTMPX */
656 construct_utmpx(struct logininfo *li, struct utmpx *utx)
658 memset(utx, '\0', sizeof(*utx));
659 # ifdef HAVE_ID_IN_UTMPX
660 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
663 /* this is done here to keep utmp constants out of loginrec.h */
666 utx->ut_type = USER_PROCESS;
669 utx->ut_type = DEAD_PROCESS;
672 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
673 set_utmpx_time(li, utx);
674 utx->ut_pid = li->pid;
676 if (li->type == LTYPE_LOGOUT)
680 * These fields are only used when logging in, and are blank
684 /* strncpy(): Don't necessarily want null termination */
685 strncpy(utx->ut_name, li->username, MIN_SIZEOF(utx->ut_name, li->username));
686 # ifdef HAVE_HOST_IN_UTMPX
687 strncpy(utx->ut_host, li->hostname, MIN_SIZEOF(utx->ut_host, li->hostname));
689 # ifdef HAVE_ADDR_IN_UTMPX
690 /* this is just a 32-bit IP address */
691 if (li->hostaddr.sa.sa_family == AF_INET)
692 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
694 # ifdef HAVE_SYSLEN_IN_UTMPX
695 /* ut_syslen is the length of the utx_host string */
696 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
699 #endif /* USE_UTMPX || USE_WTMPX */
702 ** Low-level utmp functions
705 /* FIXME: (ATL) utmp_write_direct needs testing */
708 /* if we can, use pututline() etc. */
709 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
710 defined(HAVE_PUTUTLINE)
711 # define UTMP_USE_LIBRARY
715 /* write a utmp entry with the system's help (pututline() and pals) */
716 # ifdef UTMP_USE_LIBRARY
718 utmp_write_library(struct logininfo *li, struct utmp *ut)
723 # ifdef HAVE_ENDUTENT
728 # else /* UTMP_USE_LIBRARY */
730 /* write a utmp entry direct to the file */
731 /* This is a slightly modification of code in OpenBSD's login.c */
733 utmp_write_direct(struct logininfo *li, struct utmp *ut)
739 /* FIXME: (ATL) ttyslot() needs local implementation */
741 #if defined(HAVE_GETTTYENT)
742 register struct ttyent *ty;
747 while ((struct ttyent *)0 != (ty = getttyent())) {
749 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
754 if((struct ttyent *)0 == ty) {
755 log("utmp_write_entry: tty not found");
760 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
762 #endif /* HAVE_GETTTYENT */
764 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
765 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
767 * Prevent luser from zero'ing out ut_host.
768 * If the new ut_line is empty but the old one is not
769 * and ut_line and ut_name match, preserve the old ut_line.
771 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
772 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
773 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
774 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0)) {
775 (void)memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
778 (void)lseek(fd, (off_t)(tty * sizeof(struct utmp)), SEEK_SET);
779 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut))
780 log("utmp_write_direct: error writing %s: %s",
781 UTMP_FILE, strerror(errno));
789 # endif /* UTMP_USE_LIBRARY */
792 utmp_perform_login(struct logininfo *li)
796 construct_utmp(li, &ut);
797 # ifdef UTMP_USE_LIBRARY
798 if (!utmp_write_library(li, &ut)) {
799 log("utmp_perform_login: utmp_write_library() failed");
803 if (!utmp_write_direct(li, &ut)) {
804 log("utmp_perform_login: utmp_write_direct() failed");
813 utmp_perform_logout(struct logininfo *li)
817 construct_utmp(li, &ut);
818 # ifdef UTMP_USE_LIBRARY
819 if (!utmp_write_library(li, &ut)) {
820 log("utmp_perform_logout: utmp_write_library() failed");
824 if (!utmp_write_direct(li, &ut)) {
825 log("utmp_perform_logout: utmp_write_direct() failed");
834 utmp_write_entry(struct logininfo *li)
838 return utmp_perform_login(li);
841 return utmp_perform_logout(li);
844 log("utmp_write_entry: invalid type field");
848 #endif /* USE_UTMP */
852 ** Low-level utmpx functions
855 /* not much point if we don't want utmpx entries */
858 /* if we have the wherewithall, use pututxline etc. */
859 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
860 defined(HAVE_PUTUTXLINE)
861 # define UTMPX_USE_LIBRARY
865 /* write a utmpx entry with the system's help (pututxline() and pals) */
866 # ifdef UTMPX_USE_LIBRARY
868 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
873 # ifdef HAVE_ENDUTXENT
879 # else /* UTMPX_USE_LIBRARY */
881 /* write a utmp entry direct to the file */
883 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
885 log("utmpx_write_direct: not implemented!");
888 # endif /* UTMPX_USE_LIBRARY */
891 utmpx_perform_login(struct logininfo *li)
895 construct_utmpx(li, &utx);
896 # ifdef UTMPX_USE_LIBRARY
897 if (!utmpx_write_library(li, &utx)) {
898 log("utmpx_perform_login: utmp_write_library() failed");
902 if (!utmpx_write_direct(li, &ut)) {
903 log("utmpx_perform_login: utmp_write_direct() failed");
912 utmpx_perform_logout(struct logininfo *li)
916 memset(&utx, '\0', sizeof(utx));
917 set_utmpx_time(li, &utx);
918 line_stripname(utx.ut_line, li->line, sizeof(utx.ut_line));
919 # ifdef HAVE_ID_IN_UTMPX
920 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
922 # ifdef HAVE_TYPE_IN_UTMPX
923 utx.ut_type = DEAD_PROCESS;
926 # ifdef UTMPX_USE_LIBRARY
927 utmpx_write_library(li, &utx);
929 utmpx_write_direct(li, &utx);
935 utmpx_write_entry(struct logininfo *li)
939 return utmpx_perform_login(li);
941 return utmpx_perform_logout(li);
943 log("utmpx_write_entry: invalid type field");
947 #endif /* USE_UTMPX */
951 ** Low-level wtmp functions
956 /* write a wtmp entry direct to the end of the file */
957 /* This is a slight modification of code in OpenBSD's logwtmp.c */
959 wtmp_write(struct logininfo *li, struct utmp *ut)
964 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
965 log("wtmp_write: problem writing %s: %s",
966 WTMP_FILE, strerror(errno));
969 if (fstat(fd, &buf) == 0)
970 if (atomicio(write, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
971 ftruncate(fd, buf.st_size);
972 log("wtmp_write: problem writing %s: %s",
973 WTMP_FILE, strerror(errno));
981 wtmp_perform_login(struct logininfo *li)
985 construct_utmp(li, &ut);
986 return wtmp_write(li, &ut);
991 wtmp_perform_logout(struct logininfo *li)
995 construct_utmp(li, &ut);
996 return wtmp_write(li, &ut);
1001 wtmp_write_entry(struct logininfo *li)
1005 return wtmp_perform_login(li);
1007 return wtmp_perform_logout(li);
1009 log("wtmp_write_entry: invalid type field");
1015 /* Notes on fetching login data from wtmp/wtmpx
1017 * Logouts are usually recorded with (amongst other things) a blank
1018 * username on a given tty line. However, some systems (HP-UX is one)
1019 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1021 * Since we're only looking for logins here, we know that the username
1022 * must be set correctly. On systems that leave it in, we check for
1023 * ut_type==USER_PROCESS (indicating a login.)
1025 * Portability: Some systems may set something other than USER_PROCESS
1026 * to indicate a login process. I don't know of any as I write. Also,
1027 * it's possible that some systems may both leave the username in
1028 * place and not have ut_type.
1031 /* return true if this wtmp entry indicates a login */
1033 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1035 if (strncmp(li->username, ut->ut_name,
1036 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1037 # ifdef HAVE_TYPE_IN_UTMP
1038 if (ut->ut_type & USER_PROCESS)
1048 wtmp_get_entry(struct logininfo *li)
1054 /* Clear the time entries in our logininfo */
1055 li->tv_sec = li->tv_usec = 0;
1057 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1058 log("wtmp_get_entry: problem opening %s: %s",
1059 WTMP_FILE, strerror(errno));
1062 if (fstat(fd, &st) != 0) {
1063 log("wtmp_get_entry: couldn't stat %s: %s",
1064 WTMP_FILE, strerror(errno));
1069 /* Seek to the start of the last struct utmp */
1070 if (lseek(fd, (off_t)(0 - sizeof(struct utmp)), SEEK_END) == -1) {
1071 /* Looks like we've got a fresh wtmp file */
1077 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1078 log("wtmp_get_entry: read of %s failed: %s",
1079 WTMP_FILE, strerror(errno));
1083 if ( wtmp_islogin(li, &ut) ) {
1085 /* We've already checked for a time in struct
1086 * utmp, in login_getlast(). */
1087 # ifdef HAVE_TIME_IN_UTMP
1088 li->tv_sec = ut.ut_time;
1090 # if HAVE_TV_IN_UTMP
1091 li->tv_sec = ut.ut_tv.tv_sec;
1094 line_fullname(li->line, ut.ut_line,
1095 MIN_SIZEOF(li->line, ut.ut_line));
1096 # ifdef HAVE_HOST_IN_UTMP
1097 strlcpy(li->hostname, ut.ut_host,
1098 MIN_SIZEOF(li->hostname, ut.ut_host));
1102 /* Seek back 2 x struct utmp */
1103 if (lseek(fd, (off_t)(0-2*sizeof(struct utmp)), SEEK_CUR) == -1) {
1104 /* We've found the start of the file, so quit */
1110 /* We found an entry. Tidy up and return */
1114 # endif /* USE_WTMP */
1118 ** Low-level wtmpx functions
1122 /* write a wtmpx entry direct to the end of the file */
1123 /* This is a slight modification of code in OpenBSD's logwtmp.c */
1125 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1130 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1131 log("wtmpx_write: problem opening %s: %s",
1132 WTMPX_FILE, strerror(errno));
1136 if (fstat(fd, &buf) == 0)
1137 if (atomicio(write, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1138 ftruncate(fd, buf.st_size);
1139 log("wtmpx_write: problem writing %s: %s",
1140 WTMPX_FILE, strerror(errno));
1150 wtmpx_perform_login(struct logininfo *li)
1154 construct_utmpx(li, &utx);
1155 return wtmpx_write(li, &utx);
1160 wtmpx_perform_logout(struct logininfo *li)
1164 construct_utmpx(li, &utx);
1165 return wtmpx_write(li, &utx);
1170 wtmpx_write_entry(struct logininfo *li)
1174 return wtmpx_perform_login(li);
1176 return wtmpx_perform_logout(li);
1178 log("wtmpx_write_entry: invalid type field");
1183 /* Please see the notes above wtmp_islogin() for information about the
1184 next two functions */
1186 /* Return true if this wtmpx entry indicates a login */
1188 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1190 if ( strncmp(li->username, utx->ut_name,
1191 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1192 # ifdef HAVE_TYPE_IN_UTMPX
1193 if (utx->ut_type == USER_PROCESS)
1204 wtmpx_get_entry(struct logininfo *li)
1210 /* Clear the time entries */
1211 li->tv_sec = li->tv_usec = 0;
1213 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1214 log("wtmpx_get_entry: problem opening %s: %s",
1215 WTMPX_FILE, strerror(errno));
1218 if (fstat(fd, &st) != 0) {
1219 log("wtmpx_get_entry: couldn't stat %s: %s",
1220 WTMP_FILE, strerror(errno));
1225 /* Seek to the start of the last struct utmpx */
1226 if (lseek(fd, (off_t)(0-sizeof(struct utmpx)), SEEK_END) == -1 ) {
1227 /* probably a newly rotated wtmpx file */
1233 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1234 log("wtmpx_get_entry: read of %s failed: %s",
1235 WTMPX_FILE, strerror(errno));
1239 /* Logouts are recorded as a blank username on a particular line.
1240 * So, we just need to find the username in struct utmpx */
1241 if ( wtmpx_islogin(li, &utx) ) {
1242 # ifdef HAVE_TV_IN_UTMPX
1243 li->tv_sec = utx.ut_tv.tv_sec;
1245 # ifdef HAVE_TIME_IN_UTMPX
1246 li->tv_sec = utx.ut_time;
1249 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1250 # ifdef HAVE_HOST_IN_UTMPX
1251 strlcpy(li->hostname, utx.ut_host,
1252 MIN_SIZEOF(li->hostname, utx.ut_host));
1256 if (lseek(fd, (off_t)(0-2*sizeof(struct utmpx)), SEEK_CUR) == -1) {
1265 #endif /* USE_WTMPX */
1268 ** Low-level libutil login() functions
1273 syslogin_perform_login(struct logininfo *li)
1277 if (! (ut = (struct utmp *)malloc(sizeof(*ut)))) {
1278 log("syslogin_perform_login: couldn't malloc()");
1281 construct_utmp(li, ut);
1288 syslogin_perform_logout(struct logininfo *li)
1293 (void)line_stripname(line, li->line, sizeof(line));
1295 if (!logout(line)) {
1296 log("syslogin_perform_logout: logout() returned an error");
1297 # ifdef HAVE_LOGWTMP
1299 logwtmp(line, "", "");
1302 /* FIXME: (ATL - if the need arises) What to do if we have
1303 * login, but no logout? what if logout but no logwtmp? All
1304 * routines are in libutil so they should all be there,
1311 syslogin_write_entry(struct logininfo *li)
1315 return syslogin_perform_login(li);
1317 return syslogin_perform_logout(li);
1319 log("syslogin_write_entry: Invalid type field");
1323 #endif /* USE_LOGIN */
1325 /* end of file log-syslogin.c */
1328 ** Low-level lastlog functions
1337 lastlog_construct(struct logininfo *li, struct lastlog *last)
1339 /* clear the structure */
1340 memset(last, '\0', sizeof(*last));
1342 (void)line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1343 strlcpy(last->ll_host, li->hostname,
1344 MIN_SIZEOF(last->ll_host, li->hostname));
1345 last->ll_time = li->tv_sec;
1349 lastlog_filetype(char *filename)
1353 if (stat(LASTLOG_FILE, &st) != 0) {
1354 log("lastlog_perform_login: Couldn't stat %s: %s", LASTLOG_FILE,
1358 if (S_ISDIR(st.st_mode))
1360 else if (S_ISREG(st.st_mode))
1367 /* open the file (using filemode) and seek to the login entry */
1369 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1373 char lastlog_file[1024];
1375 type = lastlog_filetype(LASTLOG_FILE);
1378 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1381 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1382 LASTLOG_FILE, li->username);
1385 log("lastlog_openseek: %.100s is not a file or directory!",
1390 *fd = open(lastlog_file, filemode);
1392 debug("lastlog_openseek: Couldn't open %s: %s",
1393 lastlog_file, strerror(errno));
1397 if (type == LL_FILE) {
1398 /* find this uid's offset in the lastlog file */
1399 offset = (off_t) ( (long)li->uid * sizeof(struct lastlog));
1401 if ( lseek(*fd, offset, SEEK_SET) != offset ) {
1402 log("lastlog_openseek: %s->lseek(): %s",
1403 lastlog_file, strerror(errno));
1412 lastlog_perform_login(struct logininfo *li)
1414 struct lastlog last;
1417 /* create our struct lastlog */
1418 lastlog_construct(li, &last);
1420 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1423 /* write the entry */
1424 if (atomicio(write, fd, &last, sizeof(last)) != sizeof(last)) {
1426 log("lastlog_write_filemode: Error writing to %s: %s",
1427 LASTLOG_FILE, strerror(errno));
1436 lastlog_write_entry(struct logininfo *li)
1440 return lastlog_perform_login(li);
1442 log("lastlog_write_entry: Invalid type field");
1448 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1450 line_fullname(li->line, last->ll_line, sizeof(li->line));
1451 strlcpy(li->hostname, last->ll_host,
1452 MIN_SIZEOF(li->hostname, last->ll_host));
1453 li->tv_sec = last->ll_time;
1457 lastlog_get_entry(struct logininfo *li)
1459 struct lastlog last;
1462 if (lastlog_openseek(li, &fd, O_RDONLY)) {
1463 if (atomicio(read, fd, &last, sizeof(last)) != sizeof(last)) {
1464 log("lastlog_get_entry: Error reading from %s: %s",
1465 LASTLOG_FILE, strerror(errno));
1468 lastlog_populate_entry(li, &last);
1475 #endif /* USE_LASTLOG */