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 * The btmp logging code is derived from login.c from util-linux and is under
30 * the the following license:
32 * Copyright (c) 1980, 1987, 1988 The Regents of the University of California.
33 * All rights reserved.
35 * Redistribution and use in source and binary forms are permitted
36 * provided that the above copyright notice and this paragraph are
37 * duplicated in all such forms and that any documentation,
38 * advertising materials, and other materials related to such
39 * distribution and use acknowledge that the software was developed
40 * by the University of California, Berkeley. The name of the
41 * University may not be used to endorse or promote products derived
42 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
44 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
45 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
50 ** loginrec.c: platform-independent login recording and lastlog retrieval
54 * The new login code explained
55 * ============================
57 * This code attempts to provide a common interface to login recording
58 * (utmp and friends) and last login time retrieval.
60 * Its primary means of achieving this is to use 'struct logininfo', a
61 * union of all the useful fields in the various different types of
62 * system login record structures one finds on UNIX variants.
64 * We depend on autoconf to define which recording methods are to be
65 * used, and which fields are contained in the relevant data structures
66 * on the local system. Many C preprocessor symbols affect which code
69 * The code is designed to make it easy to modify a particular
70 * recording method, without affecting other methods nor requiring so
71 * many nested conditional compilation blocks as were commonplace in
74 * For login recording, we try to use the local system's libraries as
75 * these are clearly most likely to work correctly. For utmp systems
76 * this usually means login() and logout() or setutent() etc., probably
77 * in libutil, along with logwtmp() etc. On these systems, we fall back
78 * to writing the files directly if we have to, though this method
79 * requires very thorough testing so we do not corrupt local auditing
80 * information. These files and their access methods are very system
83 * For utmpx systems, the corresponding library functions are
84 * setutxent() etc. To the author's knowledge, all utmpx systems have
85 * these library functions and so no direct write is attempted. If such
86 * a system exists and needs support, direct analogues of the [uw]tmp
87 * code should suffice.
89 * Retrieving the time of last login ('lastlog') is in some ways even
90 * more problemmatic than login recording. Some systems provide a
91 * simple table of all users which we seek based on uid and retrieve a
92 * relatively standard structure. Others record the same information in
93 * a directory with a separate file, and others don't record the
94 * information separately at all. For systems in the latter category,
95 * we look backwards in the wtmp or wtmpx file for the last login entry
96 * for our user. Naturally this is slower and on busy systems could
97 * incur a significant performance penalty.
99 * Calling the new code
100 * --------------------
102 * In OpenSSH all login recording and retrieval is performed in
103 * login.c. Here you'll find working examples. Also, in the logintest.c
104 * program there are more examples.
106 * Internal handler calling method
107 * -------------------------------
109 * When a call is made to login_login() or login_logout(), both
110 * routines set a struct logininfo flag defining which action (log in,
111 * or log out) is to be taken. They both then call login_write(), which
112 * calls whichever of the many structure-specific handlers autoconf
113 * selects for the local system.
115 * The handlers themselves handle system data structure specifics. Both
116 * struct utmp and struct utmpx have utility functions (see
117 * construct_utmp*()) to try to make it simpler to add extra systems
118 * that introduce new features to either structure.
120 * While it may seem terribly wasteful to replicate so much similar
121 * code for each method, experience has shown that maintaining code to
122 * write both struct utmp and utmpx in one function, whilst maintaining
123 * support for all systems whether they have library support or not, is
124 * a difficult and time-consuming task.
126 * Lastlog support proceeds similarly. Functions login_get_lastlog()
127 * (and its OpenSSH-tuned friend login_get_lastlog_time()) call
128 * getlast_entry(), which tries one of three methods to find the last
129 * login time. It uses local system lastlog support if it can,
130 * otherwise it tries wtmp or wtmpx before giving up and returning 0,
136 * In many cases it's possible to tweak autoconf to select the correct
137 * methods for a particular platform, either by improving the detection
138 * code (best), or by presetting DISABLE_<method> or CONF_<method>_FILE
139 * symbols for the platform.
141 * Use logintest to check which symbols are defined before modifying
142 * configure.ac and loginrec.c. (You have to build logintest yourself
143 * with 'make logintest' as it's not built by default.)
145 * Otherwise, patches to the specific method(s) are very helpful!
148 #include "includes.h"
152 #include "loginrec.h"
154 #include "atomicio.h"
156 #include "canohost.h"
163 #ifdef HAVE_LIBUTIL_H
164 # include <libutil.h>
170 ** prototypes for helper functions in this file
174 void set_utmp_time(struct logininfo *li, struct utmp *ut);
175 void construct_utmp(struct logininfo *li, struct utmp *ut);
179 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
180 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
183 int utmp_write_entry(struct logininfo *li);
184 int utmpx_write_entry(struct logininfo *li);
185 int wtmp_write_entry(struct logininfo *li);
186 int wtmpx_write_entry(struct logininfo *li);
187 int lastlog_write_entry(struct logininfo *li);
188 int syslogin_write_entry(struct logininfo *li);
190 int getlast_entry(struct logininfo *li);
191 int lastlog_get_entry(struct logininfo *li);
192 int wtmp_get_entry(struct logininfo *li);
193 int wtmpx_get_entry(struct logininfo *li);
195 /* pick the shortest string */
196 #define MIN_SIZEOF(s1,s2) (sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2))
199 ** 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));
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));
237 * login_get_lastlog_time(int) - Retrieve the last login time
239 * Retrieve the last login time for the given uid. Will try to use the
240 * system lastlog facilities if they are available, but will fall back
241 * to looking in wtmp/wtmpx if necessary
244 * 0 on failure, or if user has never logged in
245 * Time in seconds from the epoch if successful
247 * Useful preprocessor symbols:
248 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
250 * USE_LASTLOG: If set, indicates the presence of system lastlog
251 * facilities. If this and DISABLE_LASTLOG are not set,
252 * try to retrieve lastlog information from wtmp/wtmpx.
255 login_get_lastlog_time(const int uid)
259 if (login_get_lastlog(&li, uid))
266 * login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
268 * Retrieve a logininfo structure populated (only partially) with
269 * information from the system lastlog data, or from wtmp/wtmpx if no
270 * system lastlog information exists.
272 * Note this routine must be given a pre-allocated logininfo.
275 * >0: A pointer to your struct logininfo if successful
276 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
279 login_get_lastlog(struct logininfo *li, const int uid)
283 memset(li, '\0', sizeof(*li));
287 * If we don't have a 'real' lastlog, we need the username to
288 * reliably search wtmp(x) for the last login (see
293 fatal("%s: Cannot find account for uid %i", __func__, uid);
295 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
296 * username (XXX - so check for trunc!) */
297 strlcpy(li->username, pw->pw_name, sizeof(li->username));
299 if (getlast_entry(li))
307 * login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
308 * a logininfo structure
310 * This function creates a new struct logininfo, a data structure
311 * meant to carry the information required to portably record login info.
313 * Returns a pointer to a newly created struct logininfo. If memory
314 * allocation fails, the program halts.
317 logininfo *login_alloc_entry(int pid, const char *username,
318 const char *hostname, const char *line)
320 struct logininfo *newli;
322 newli = xmalloc(sizeof(*newli));
323 login_init_entry(newli, pid, username, hostname, line);
328 /* login_free_entry(struct logininfo *) - free struct memory */
330 login_free_entry(struct logininfo *li)
336 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
337 * - initialise a struct logininfo
339 * Populates a new struct logininfo, a data structure meant to carry
340 * the information required to portably record login info.
345 login_init_entry(struct logininfo *li, int pid, const char *username,
346 const char *hostname, const char *line)
350 memset(li, 0, sizeof(*li));
354 /* set the line information */
356 line_fullname(li->line, line, sizeof(li->line));
359 strlcpy(li->username, username, sizeof(li->username));
360 pw = getpwnam(li->username);
362 fatal("%s: Cannot find user \"%s\"", __func__,
365 li->uid = pw->pw_uid;
369 strlcpy(li->hostname, hostname, sizeof(li->hostname));
375 * login_set_current_time(struct logininfo *) - set the current time
377 * Set the current time in a logininfo structure. This function is
378 * meant to eliminate the need to deal with system dependencies for
382 login_set_current_time(struct logininfo *li)
386 gettimeofday(&tv, NULL);
388 li->tv_sec = tv.tv_sec;
389 li->tv_usec = tv.tv_usec;
392 /* copy a sockaddr_* into our logininfo */
394 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
395 const unsigned int sa_size)
397 unsigned int bufsize = sa_size;
399 /* make sure we don't overrun our union */
400 if (sizeof(li->hostaddr) < sa_size)
401 bufsize = sizeof(li->hostaddr);
403 memcpy(&li->hostaddr.sa, sa, bufsize);
408 ** login_write: Call low-level recording functions based on autoconf
412 login_write(struct logininfo *li)
415 if (geteuid() != 0) {
416 logit("Attempt to write login records by non-root user (aborting)");
421 /* set the timestamp */
422 login_set_current_time(li);
424 syslogin_write_entry(li);
427 if (li->type == LTYPE_LOGIN)
428 lastlog_write_entry(li);
431 utmp_write_entry(li);
434 wtmp_write_entry(li);
437 utmpx_write_entry(li);
440 wtmpx_write_entry(li);
442 #ifdef CUSTOM_SYS_AUTH_RECORD_LOGIN
443 if (li->type == LTYPE_LOGIN &&
444 !sys_auth_record_login(li->username,li->hostname,li->line))
445 logit("Writing login record failed for %s", li->username);
448 if (li->type == LTYPE_LOGIN)
449 audit_session_open(li->line);
450 else if (li->type == LTYPE_LOGOUT)
451 audit_session_close(li->line);
456 #ifdef LOGIN_NEEDS_UTMPX
458 login_utmp_only(struct logininfo *li)
460 li->type = LTYPE_LOGIN;
461 login_set_current_time(li);
463 utmp_write_entry(li);
466 wtmp_write_entry(li);
469 utmpx_write_entry(li);
472 wtmpx_write_entry(li);
479 ** getlast_entry: Call low-level functions to retrieve the last login
483 /* take the uid in li and return the last login time */
485 getlast_entry(struct logininfo *li)
488 return(lastlog_get_entry(li));
489 #else /* !USE_LASTLOG */
491 #if defined(DISABLE_LASTLOG)
492 /* On some systems we shouldn't even try to obtain last login
495 # elif defined(USE_WTMP) && \
496 (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
497 /* retrieve last login time from utmp */
498 return (wtmp_get_entry(li));
499 # elif defined(USE_WTMPX) && \
500 (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
501 /* If wtmp isn't available, try wtmpx */
502 return (wtmpx_get_entry(li));
504 /* Give up: No means of retrieving last login time */
506 # endif /* DISABLE_LASTLOG */
507 #endif /* USE_LASTLOG */
513 * 'line' string utility functions
515 * These functions process the 'line' string into one of three forms:
517 * 1. The full filename (including '/dev')
518 * 2. The stripped name (excluding '/dev')
519 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
520 * /dev/pts/1 -> ts/1 )
522 * Form 3 is used on some systems to identify a .tmp.? entry when
523 * attempting to remove it. Typically both addition and removal is
524 * performed by one application - say, sshd - so as long as the choice
525 * uniquely identifies a terminal it's ok.
530 * line_fullname(): add the leading '/dev/' if it doesn't exist make
531 * sure dst has enough space, if not just copy src (ugh)
534 line_fullname(char *dst, const char *src, int dstsize)
536 memset(dst, '\0', dstsize);
537 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
538 strlcpy(dst, src, dstsize);
540 strlcpy(dst, "/dev/", dstsize);
541 strlcat(dst, src, dstsize);
546 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
548 line_stripname(char *dst, const char *src, int dstsize)
550 memset(dst, '\0', dstsize);
551 if (strncmp(src, "/dev/", 5) == 0)
552 strlcpy(dst, src + 5, dstsize);
554 strlcpy(dst, src, dstsize);
559 * line_abbrevname(): Return the abbreviated (usually four-character)
560 * form of the line (Just use the last <dstsize> characters of the
563 * NOTE: use strncpy because we do NOT necessarily want zero
567 line_abbrevname(char *dst, const char *src, int dstsize)
571 memset(dst, '\0', dstsize);
573 /* Always skip prefix if present */
574 if (strncmp(src, "/dev/", 5) == 0)
577 #ifdef WITH_ABBREV_NO_TTY
578 if (strncmp(src, "tty", 3) == 0)
585 if (((int)len - dstsize) > 0)
586 src += ((int)len - dstsize);
588 /* note: _don't_ change this to strlcpy */
589 strncpy(dst, src, (size_t)dstsize);
596 ** utmp utility functions
598 ** These functions manipulate struct utmp, taking system differences
602 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
604 /* build the utmp structure */
606 set_utmp_time(struct logininfo *li, struct utmp *ut)
608 # if defined(HAVE_TV_IN_UTMP)
609 ut->ut_tv.tv_sec = li->tv_sec;
610 ut->ut_tv.tv_usec = li->tv_usec;
611 # elif defined(HAVE_TIME_IN_UTMP)
612 ut->ut_time = li->tv_sec;
617 construct_utmp(struct logininfo *li,
620 # ifdef HAVE_ADDR_V6_IN_UTMP
621 struct sockaddr_in6 *sa6;
624 memset(ut, '\0', sizeof(*ut));
626 /* First fill out fields used for both logins and logouts */
628 # ifdef HAVE_ID_IN_UTMP
629 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
632 # ifdef HAVE_TYPE_IN_UTMP
633 /* This is done here to keep utmp constants out of struct logininfo */
636 ut->ut_type = USER_PROCESS;
642 ut->ut_type = DEAD_PROCESS;
644 cray_retain_utmp(ut, li->pid);
649 set_utmp_time(li, ut);
651 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
653 # ifdef HAVE_PID_IN_UTMP
654 ut->ut_pid = li->pid;
657 /* If we're logging out, leave all other fields blank */
658 if (li->type == LTYPE_LOGOUT)
662 * These fields are only used when logging in, and are blank
666 /* Use strncpy because we don't necessarily want null termination */
667 strncpy(ut->ut_name, li->username,
668 MIN_SIZEOF(ut->ut_name, li->username));
669 # ifdef HAVE_HOST_IN_UTMP
670 strncpy(ut->ut_host, li->hostname,
671 MIN_SIZEOF(ut->ut_host, li->hostname));
673 # ifdef HAVE_ADDR_IN_UTMP
674 /* this is just a 32-bit IP address */
675 if (li->hostaddr.sa.sa_family == AF_INET)
676 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
678 # ifdef HAVE_ADDR_V6_IN_UTMP
679 /* this is just a 128-bit IPv6 address */
680 if (li->hostaddr.sa.sa_family == AF_INET6) {
681 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
682 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
683 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
684 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
685 ut->ut_addr_v6[1] = 0;
686 ut->ut_addr_v6[2] = 0;
687 ut->ut_addr_v6[3] = 0;
692 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
695 ** utmpx utility functions
697 ** These functions manipulate struct utmpx, accounting for system
701 #if defined(USE_UTMPX) || defined (USE_WTMPX)
702 /* build the utmpx structure */
704 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
706 # if defined(HAVE_TV_IN_UTMPX)
707 utx->ut_tv.tv_sec = li->tv_sec;
708 utx->ut_tv.tv_usec = li->tv_usec;
709 # elif defined(HAVE_TIME_IN_UTMPX)
710 utx->ut_time = li->tv_sec;
715 construct_utmpx(struct logininfo *li, struct utmpx *utx)
717 # ifdef HAVE_ADDR_V6_IN_UTMP
718 struct sockaddr_in6 *sa6;
720 memset(utx, '\0', sizeof(*utx));
722 # ifdef HAVE_ID_IN_UTMPX
723 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
726 /* this is done here to keep utmp constants out of loginrec.h */
729 utx->ut_type = USER_PROCESS;
732 utx->ut_type = DEAD_PROCESS;
735 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
736 set_utmpx_time(li, utx);
737 utx->ut_pid = li->pid;
739 /* strncpy(): Don't necessarily want null termination */
740 strncpy(utx->ut_name, li->username,
741 MIN_SIZEOF(utx->ut_name, li->username));
743 if (li->type == LTYPE_LOGOUT)
747 * These fields are only used when logging in, and are blank
751 # ifdef HAVE_HOST_IN_UTMPX
752 strncpy(utx->ut_host, li->hostname,
753 MIN_SIZEOF(utx->ut_host, li->hostname));
755 # ifdef HAVE_ADDR_IN_UTMPX
756 /* this is just a 32-bit IP address */
757 if (li->hostaddr.sa.sa_family == AF_INET)
758 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
760 # ifdef HAVE_ADDR_V6_IN_UTMP
761 /* this is just a 128-bit IPv6 address */
762 if (li->hostaddr.sa.sa_family == AF_INET6) {
763 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
764 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
765 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
766 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
767 ut->ut_addr_v6[1] = 0;
768 ut->ut_addr_v6[2] = 0;
769 ut->ut_addr_v6[3] = 0;
773 # ifdef HAVE_SYSLEN_IN_UTMPX
774 /* ut_syslen is the length of the utx_host string */
775 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
778 #endif /* USE_UTMPX || USE_WTMPX */
781 ** Low-level utmp functions
784 /* FIXME: (ATL) utmp_write_direct needs testing */
787 /* if we can, use pututline() etc. */
788 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
789 defined(HAVE_PUTUTLINE)
790 # define UTMP_USE_LIBRARY
794 /* write a utmp entry with the system's help (pututline() and pals) */
795 # ifdef UTMP_USE_LIBRARY
797 utmp_write_library(struct logininfo *li, struct utmp *ut)
801 # ifdef HAVE_ENDUTENT
806 # else /* UTMP_USE_LIBRARY */
809 * Write a utmp entry direct to the file
810 * This is a slightly modification of code in OpenBSD's login.c
813 utmp_write_direct(struct logininfo *li, struct utmp *ut)
819 /* FIXME: (ATL) ttyslot() needs local implementation */
821 #if defined(HAVE_GETTTYENT)
826 while (NULL != (ty = getttyent())) {
828 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
834 logit("%s: tty not found", __func__);
839 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
841 #endif /* HAVE_GETTTYENT */
843 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
846 pos = (off_t)tty * sizeof(struct utmp);
847 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
848 logit("%s: lseek: %s", __func__, strerror(errno));
852 logit("%s: Couldn't seek to tty %d slot in %s",
853 __func__, tty, UTMP_FILE);
857 * Prevent luser from zero'ing out ut_host.
858 * If the new ut_line is empty but the old one is not
859 * and ut_line and ut_name match, preserve the old ut_line.
861 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
862 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
863 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
864 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0))
865 memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
867 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
868 logit("%s: lseek: %s", __func__, strerror(errno));
872 logit("%s: Couldn't seek to tty %d slot in %s",
873 __func__, tty, UTMP_FILE);
876 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
877 logit("%s: error writing %s: %s", __func__,
878 UTMP_FILE, strerror(errno));
887 # endif /* UTMP_USE_LIBRARY */
890 utmp_perform_login(struct logininfo *li)
894 construct_utmp(li, &ut);
895 # ifdef UTMP_USE_LIBRARY
896 if (!utmp_write_library(li, &ut)) {
897 logit("%s: utmp_write_library() failed", __func__);
901 if (!utmp_write_direct(li, &ut)) {
902 logit("%s: utmp_write_direct() failed", __func__);
911 utmp_perform_logout(struct logininfo *li)
915 construct_utmp(li, &ut);
916 # ifdef UTMP_USE_LIBRARY
917 if (!utmp_write_library(li, &ut)) {
918 logit("%s: utmp_write_library() failed", __func__);
922 if (!utmp_write_direct(li, &ut)) {
923 logit("%s: utmp_write_direct() failed", __func__);
932 utmp_write_entry(struct logininfo *li)
936 return (utmp_perform_login(li));
939 return (utmp_perform_logout(li));
942 logit("%s: invalid type field", __func__);
946 #endif /* USE_UTMP */
950 ** Low-level utmpx functions
953 /* not much point if we don't want utmpx entries */
956 /* if we have the wherewithall, use pututxline etc. */
957 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
958 defined(HAVE_PUTUTXLINE)
959 # define UTMPX_USE_LIBRARY
963 /* write a utmpx entry with the system's help (pututxline() and pals) */
964 # ifdef UTMPX_USE_LIBRARY
966 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
971 # ifdef HAVE_ENDUTXENT
977 # else /* UTMPX_USE_LIBRARY */
979 /* write a utmp entry direct to the file */
981 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
983 logit("%s: not implemented!", __func__);
986 # endif /* UTMPX_USE_LIBRARY */
989 utmpx_perform_login(struct logininfo *li)
993 construct_utmpx(li, &utx);
994 # ifdef UTMPX_USE_LIBRARY
995 if (!utmpx_write_library(li, &utx)) {
996 logit("%s: utmp_write_library() failed", __func__);
1000 if (!utmpx_write_direct(li, &ut)) {
1001 logit("%s: utmp_write_direct() failed", __func__);
1010 utmpx_perform_logout(struct logininfo *li)
1014 construct_utmpx(li, &utx);
1015 # ifdef HAVE_ID_IN_UTMPX
1016 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
1018 # ifdef HAVE_TYPE_IN_UTMPX
1019 utx.ut_type = DEAD_PROCESS;
1022 # ifdef UTMPX_USE_LIBRARY
1023 utmpx_write_library(li, &utx);
1025 utmpx_write_direct(li, &utx);
1031 utmpx_write_entry(struct logininfo *li)
1035 return (utmpx_perform_login(li));
1037 return (utmpx_perform_logout(li));
1039 logit("%s: invalid type field", __func__);
1043 #endif /* USE_UTMPX */
1047 ** Low-level wtmp functions
1053 * Write a wtmp entry direct to the end of the file
1054 * This is a slight modification of code in OpenBSD's logwtmp.c
1057 wtmp_write(struct logininfo *li, struct utmp *ut)
1062 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1063 logit("%s: problem writing %s: %s", __func__,
1064 WTMP_FILE, strerror(errno));
1067 if (fstat(fd, &buf) == 0)
1068 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
1069 ftruncate(fd, buf.st_size);
1070 logit("%s: problem writing %s: %s", __func__,
1071 WTMP_FILE, strerror(errno));
1079 wtmp_perform_login(struct logininfo *li)
1083 construct_utmp(li, &ut);
1084 return (wtmp_write(li, &ut));
1089 wtmp_perform_logout(struct logininfo *li)
1093 construct_utmp(li, &ut);
1094 return (wtmp_write(li, &ut));
1099 wtmp_write_entry(struct logininfo *li)
1103 return (wtmp_perform_login(li));
1105 return (wtmp_perform_logout(li));
1107 logit("%s: invalid type field", __func__);
1114 * Notes on fetching login data from wtmp/wtmpx
1116 * Logouts are usually recorded with (amongst other things) a blank
1117 * username on a given tty line. However, some systems (HP-UX is one)
1118 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1120 * Since we're only looking for logins here, we know that the username
1121 * must be set correctly. On systems that leave it in, we check for
1122 * ut_type==USER_PROCESS (indicating a login.)
1124 * Portability: Some systems may set something other than USER_PROCESS
1125 * to indicate a login process. I don't know of any as I write. Also,
1126 * it's possible that some systems may both leave the username in
1127 * place and not have ut_type.
1130 /* return true if this wtmp entry indicates a login */
1132 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1134 if (strncmp(li->username, ut->ut_name,
1135 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1136 # ifdef HAVE_TYPE_IN_UTMP
1137 if (ut->ut_type & USER_PROCESS)
1147 wtmp_get_entry(struct logininfo *li)
1153 /* Clear the time entries in our logininfo */
1154 li->tv_sec = li->tv_usec = 0;
1156 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1157 logit("%s: problem opening %s: %s", __func__,
1158 WTMP_FILE, strerror(errno));
1161 if (fstat(fd, &st) != 0) {
1162 logit("%s: couldn't stat %s: %s", __func__,
1163 WTMP_FILE, strerror(errno));
1168 /* Seek to the start of the last struct utmp */
1169 if (lseek(fd, -(off_t)sizeof(struct utmp), SEEK_END) == -1) {
1170 /* Looks like we've got a fresh wtmp file */
1176 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1177 logit("%s: read of %s failed: %s", __func__,
1178 WTMP_FILE, strerror(errno));
1182 if ( wtmp_islogin(li, &ut) ) {
1185 * We've already checked for a time in struct
1186 * utmp, in login_getlast()
1188 # ifdef HAVE_TIME_IN_UTMP
1189 li->tv_sec = ut.ut_time;
1191 # if HAVE_TV_IN_UTMP
1192 li->tv_sec = ut.ut_tv.tv_sec;
1195 line_fullname(li->line, ut.ut_line,
1196 MIN_SIZEOF(li->line, ut.ut_line));
1197 # ifdef HAVE_HOST_IN_UTMP
1198 strlcpy(li->hostname, ut.ut_host,
1199 MIN_SIZEOF(li->hostname, ut.ut_host));
1203 /* Seek back 2 x struct utmp */
1204 if (lseek(fd, -(off_t)(2 * sizeof(struct utmp)), SEEK_CUR) == -1) {
1205 /* We've found the start of the file, so quit */
1211 /* We found an entry. Tidy up and return */
1215 # endif /* USE_WTMP */
1219 ** Low-level wtmpx functions
1224 * Write a wtmpx entry direct to the end of the file
1225 * This is a slight modification of code in OpenBSD's logwtmp.c
1228 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1230 #ifndef HAVE_UPDWTMPX
1234 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1235 logit("%s: problem opening %s: %s", __func__,
1236 WTMPX_FILE, strerror(errno));
1240 if (fstat(fd, &buf) == 0)
1241 if (atomicio(vwrite, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1242 ftruncate(fd, buf.st_size);
1243 logit("%s: problem writing %s: %s", __func__,
1244 WTMPX_FILE, strerror(errno));
1251 updwtmpx(WTMPX_FILE, utx);
1258 wtmpx_perform_login(struct logininfo *li)
1262 construct_utmpx(li, &utx);
1263 return (wtmpx_write(li, &utx));
1268 wtmpx_perform_logout(struct logininfo *li)
1272 construct_utmpx(li, &utx);
1273 return (wtmpx_write(li, &utx));
1278 wtmpx_write_entry(struct logininfo *li)
1282 return (wtmpx_perform_login(li));
1284 return (wtmpx_perform_logout(li));
1286 logit("%s: invalid type field", __func__);
1291 /* Please see the notes above wtmp_islogin() for information about the
1292 next two functions */
1294 /* Return true if this wtmpx entry indicates a login */
1296 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1298 if (strncmp(li->username, utx->ut_name,
1299 MIN_SIZEOF(li->username, utx->ut_name)) == 0 ) {
1300 # ifdef HAVE_TYPE_IN_UTMPX
1301 if (utx->ut_type == USER_PROCESS)
1312 wtmpx_get_entry(struct logininfo *li)
1318 /* Clear the time entries */
1319 li->tv_sec = li->tv_usec = 0;
1321 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1322 logit("%s: problem opening %s: %s", __func__,
1323 WTMPX_FILE, strerror(errno));
1326 if (fstat(fd, &st) != 0) {
1327 logit("%s: couldn't stat %s: %s", __func__,
1328 WTMPX_FILE, strerror(errno));
1333 /* Seek to the start of the last struct utmpx */
1334 if (lseek(fd, -(off_t)sizeof(struct utmpx), SEEK_END) == -1 ) {
1335 /* probably a newly rotated wtmpx file */
1341 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1342 logit("%s: read of %s failed: %s", __func__,
1343 WTMPX_FILE, strerror(errno));
1348 * Logouts are recorded as a blank username on a particular
1349 * line. So, we just need to find the username in struct utmpx
1351 if (wtmpx_islogin(li, &utx)) {
1353 # if defined(HAVE_TV_IN_UTMPX)
1354 li->tv_sec = utx.ut_tv.tv_sec;
1355 # elif defined(HAVE_TIME_IN_UTMPX)
1356 li->tv_sec = utx.ut_time;
1358 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1359 # if defined(HAVE_HOST_IN_UTMPX)
1360 strlcpy(li->hostname, utx.ut_host,
1361 MIN_SIZEOF(li->hostname, utx.ut_host));
1365 if (lseek(fd, -(off_t)(2 * sizeof(struct utmpx)), SEEK_CUR) == -1) {
1374 #endif /* USE_WTMPX */
1377 ** Low-level libutil login() functions
1382 syslogin_perform_login(struct logininfo *li)
1386 ut = xmalloc(sizeof(*ut));
1387 construct_utmp(li, ut);
1395 syslogin_perform_logout(struct logininfo *li)
1398 char line[UT_LINESIZE];
1400 (void)line_stripname(line, li->line, sizeof(line));
1403 logit("%s: logout() returned an error", __func__);
1404 # ifdef HAVE_LOGWTMP
1406 logwtmp(line, "", "");
1408 /* FIXME: (ATL - if the need arises) What to do if we have
1409 * login, but no logout? what if logout but no logwtmp? All
1410 * routines are in libutil so they should all be there,
1417 syslogin_write_entry(struct logininfo *li)
1421 return (syslogin_perform_login(li));
1423 return (syslogin_perform_logout(li));
1425 logit("%s: Invalid type field", __func__);
1429 #endif /* USE_LOGIN */
1431 /* end of file log-syslogin.c */
1434 ** Low-level lastlog functions
1443 lastlog_construct(struct logininfo *li, struct lastlog *last)
1445 /* clear the structure */
1446 memset(last, '\0', sizeof(*last));
1448 line_stripname(last->ll_line, li->line, sizeof(last->ll_line));
1449 strlcpy(last->ll_host, li->hostname,
1450 MIN_SIZEOF(last->ll_host, li->hostname));
1451 last->ll_time = li->tv_sec;
1455 lastlog_filetype(char *filename)
1459 if (stat(LASTLOG_FILE, &st) != 0) {
1460 logit("%s: Couldn't stat %s: %s", __func__,
1461 LASTLOG_FILE, strerror(errno));
1464 if (S_ISDIR(st.st_mode))
1466 else if (S_ISREG(st.st_mode))
1473 /* open the file (using filemode) and seek to the login entry */
1475 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1479 char lastlog_file[1024];
1481 type = lastlog_filetype(LASTLOG_FILE);
1484 strlcpy(lastlog_file, LASTLOG_FILE,
1485 sizeof(lastlog_file));
1488 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1489 LASTLOG_FILE, li->username);
1492 logit("%s: %.100s is not a file or directory!", __func__,
1497 *fd = open(lastlog_file, filemode, 0600);
1499 debug("%s: Couldn't open %s: %s", __func__,
1500 lastlog_file, strerror(errno));
1504 if (type == LL_FILE) {
1505 /* find this uid's offset in the lastlog file */
1506 offset = (off_t) ((long)li->uid * sizeof(struct lastlog));
1508 if (lseek(*fd, offset, SEEK_SET) != offset) {
1509 logit("%s: %s->lseek(): %s", __func__,
1510 lastlog_file, strerror(errno));
1519 lastlog_perform_login(struct logininfo *li)
1521 struct lastlog last;
1524 /* create our struct lastlog */
1525 lastlog_construct(li, &last);
1527 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1530 /* write the entry */
1531 if (atomicio(vwrite, fd, &last, sizeof(last)) != sizeof(last)) {
1533 logit("%s: Error writing to %s: %s", __func__,
1534 LASTLOG_FILE, strerror(errno));
1543 lastlog_write_entry(struct logininfo *li)
1547 return (lastlog_perform_login(li));
1549 logit("%s: Invalid type field", __func__);
1555 lastlog_populate_entry(struct logininfo *li, struct lastlog *last)
1557 line_fullname(li->line, last->ll_line, sizeof(li->line));
1558 strlcpy(li->hostname, last->ll_host,
1559 MIN_SIZEOF(li->hostname, last->ll_host));
1560 li->tv_sec = last->ll_time;
1564 lastlog_get_entry(struct logininfo *li)
1566 struct lastlog last;
1569 if (!lastlog_openseek(li, &fd, O_RDONLY))
1572 ret = atomicio(read, fd, &last, sizeof(last));
1577 memset(&last, '\0', sizeof(last));
1580 lastlog_populate_entry(li, &last);
1583 error("%s: Error reading from %s: %s", __func__,
1584 LASTLOG_FILE, strerror(errno));
1587 error("%s: Error reading from %s: Expecting %d, got %d",
1588 __func__, LASTLOG_FILE, sizeof(last), ret);
1595 #endif /* USE_LASTLOG */
1599 * Logs failed login attempts in _PATH_BTMP if that exists.
1600 * The most common login failure is to give password instead of username.
1601 * So the _PATH_BTMP file checked for the correct permission, so that
1602 * only root can read it.
1606 record_failed_login(const char *username, const char *hostname,
1611 struct sockaddr_storage from;
1612 size_t fromlen = sizeof(from);
1613 struct sockaddr_in *a4;
1614 struct sockaddr_in6 *a6;
1620 if ((fd = open(_PATH_BTMP, O_WRONLY | O_APPEND)) < 0) {
1621 debug("Unable to open the btmp file %s: %s", _PATH_BTMP,
1625 if (fstat(fd, &fst) < 0) {
1626 logit("%s: fstat of %s failed: %s", __func__, _PATH_BTMP,
1630 if((fst.st_mode & (S_IRWXG | S_IRWXO)) || (fst.st_uid != 0)){
1631 logit("Excess permission or bad ownership on file %s",
1636 memset(&ut, 0, sizeof(ut));
1637 /* strncpy because we don't necessarily want nul termination */
1638 strncpy(ut.ut_user, username, sizeof(ut.ut_user));
1639 strlcpy(ut.ut_line, "ssh:notty", sizeof(ut.ut_line));
1642 ut.ut_time = t; /* ut_time is not always a time_t */
1643 ut.ut_type = LOGIN_PROCESS;
1644 ut.ut_pid = getpid();
1646 /* strncpy because we don't necessarily want nul termination */
1647 strncpy(ut.ut_host, hostname, sizeof(ut.ut_host));
1649 if (packet_connection_is_on_socket() &&
1650 getpeername(packet_get_connection_in(),
1651 (struct sockaddr *)&from, &fromlen) == 0) {
1652 ipv64_normalise_mapped(&from, &fromlen);
1653 if (from.ss_family == AF_INET) {
1654 a4 = (struct sockaddr_in *)&from;
1655 memcpy(&ut.ut_addr, &(a4->sin_addr),
1656 MIN_SIZEOF(ut.ut_addr, a4->sin_addr));
1658 #ifdef HAVE_ADDR_V6_IN_UTMP
1659 if (from.ss_family == AF_INET6) {
1660 a6 = (struct sockaddr_in6 *)&from;
1661 memcpy(&ut.ut_addr_v6, &(a6->sin6_addr),
1662 MIN_SIZEOF(ut.ut_addr_v6, a6->sin6_addr));
1667 if (atomicio(vwrite, fd, &ut, sizeof(ut)) != sizeof(ut))
1668 error("Failed to write to %s: %s", _PATH_BTMP,
1674 #endif /* USE_BTMP */