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"
150 #include <sys/types.h>
151 #include <sys/stat.h>
152 #include <sys/socket.h>
153 #ifdef HAVE_SYS_TIME_H
154 # include <sys/time.h>
157 #include <netinet/in.h>
172 #include "hostfile.h"
174 #include "loginrec.h"
176 #include "atomicio.h"
178 #include "canohost.h"
187 ** prototypes for helper functions in this file
191 void set_utmp_time(struct logininfo *li, struct utmp *ut);
192 void construct_utmp(struct logininfo *li, struct utmp *ut);
196 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
197 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
200 int utmp_write_entry(struct logininfo *li);
201 int utmpx_write_entry(struct logininfo *li);
202 int wtmp_write_entry(struct logininfo *li);
203 int wtmpx_write_entry(struct logininfo *li);
204 int lastlog_write_entry(struct logininfo *li);
205 int syslogin_write_entry(struct logininfo *li);
207 int getlast_entry(struct logininfo *li);
208 int lastlog_get_entry(struct logininfo *li);
209 int utmpx_get_entry(struct logininfo *li);
210 int wtmp_get_entry(struct logininfo *li);
211 int wtmpx_get_entry(struct logininfo *li);
213 extern Buffer loginmsg;
215 /* pick the shortest string */
216 #define MIN_SIZEOF(s1,s2) (sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2))
219 ** platform-independent login functions
223 * login_login(struct logininfo *) - Record a login
225 * Call with a pointer to a struct logininfo initialised with
226 * login_init_entry() or login_alloc_entry()
230 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
233 login_login(struct logininfo *li)
235 li->type = LTYPE_LOGIN;
236 return (login_write(li));
241 * login_logout(struct logininfo *) - Record a logout
243 * Call as with login_login()
247 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
250 login_logout(struct logininfo *li)
252 li->type = LTYPE_LOGOUT;
253 return (login_write(li));
257 * login_get_lastlog_time(int) - Retrieve the last login time
259 * Retrieve the last login time for the given uid. Will try to use the
260 * system lastlog facilities if they are available, but will fall back
261 * to looking in wtmp/wtmpx if necessary
264 * 0 on failure, or if user has never logged in
265 * Time in seconds from the epoch if successful
267 * Useful preprocessor symbols:
268 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
270 * USE_LASTLOG: If set, indicates the presence of system lastlog
271 * facilities. If this and DISABLE_LASTLOG are not set,
272 * try to retrieve lastlog information from wtmp/wtmpx.
275 login_get_lastlog_time(const uid_t uid)
279 if (login_get_lastlog(&li, uid))
286 * login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
288 * Retrieve a logininfo structure populated (only partially) with
289 * information from the system lastlog data, or from wtmp/wtmpx if no
290 * system lastlog information exists.
292 * Note this routine must be given a pre-allocated logininfo.
295 * >0: A pointer to your struct logininfo if successful
296 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
299 login_get_lastlog(struct logininfo *li, const uid_t uid)
303 memset(li, '\0', sizeof(*li));
307 * If we don't have a 'real' lastlog, we need the username to
308 * reliably search wtmp(x) for the last login (see
313 fatal("%s: Cannot find account for uid %ld", __func__,
316 if (strlcpy(li->username, pw->pw_name, sizeof(li->username)) >=
317 sizeof(li->username)) {
318 error("%s: username too long (%lu > max %lu)", __func__,
319 (unsigned long)strlen(pw->pw_name),
320 (unsigned long)sizeof(li->username) - 1);
324 if (getlast_entry(li))
331 * login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
332 * a logininfo structure
334 * This function creates a new struct logininfo, a data structure
335 * meant to carry the information required to portably record login info.
337 * Returns a pointer to a newly created struct logininfo. If memory
338 * allocation fails, the program halts.
341 logininfo *login_alloc_entry(pid_t pid, const char *username,
342 const char *hostname, const char *line)
344 struct logininfo *newli;
346 newli = xmalloc(sizeof(*newli));
347 login_init_entry(newli, pid, username, hostname, line);
352 /* login_free_entry(struct logininfo *) - free struct memory */
354 login_free_entry(struct logininfo *li)
360 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
361 * - initialise a struct logininfo
363 * Populates a new struct logininfo, a data structure meant to carry
364 * the information required to portably record login info.
369 login_init_entry(struct logininfo *li, pid_t pid, const char *username,
370 const char *hostname, const char *line)
374 memset(li, 0, sizeof(*li));
378 /* set the line information */
380 line_fullname(li->line, line, sizeof(li->line));
383 strlcpy(li->username, username, sizeof(li->username));
384 pw = getpwnam(li->username);
386 fatal("%s: Cannot find user \"%s\"", __func__,
389 li->uid = pw->pw_uid;
393 strlcpy(li->hostname, hostname, sizeof(li->hostname));
399 * login_set_current_time(struct logininfo *) - set the current time
401 * Set the current time in a logininfo structure. This function is
402 * meant to eliminate the need to deal with system dependencies for
406 login_set_current_time(struct logininfo *li)
410 gettimeofday(&tv, NULL);
412 li->tv_sec = tv.tv_sec;
413 li->tv_usec = tv.tv_usec;
416 /* copy a sockaddr_* into our logininfo */
418 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
419 const unsigned int sa_size)
421 unsigned int bufsize = sa_size;
423 /* make sure we don't overrun our union */
424 if (sizeof(li->hostaddr) < sa_size)
425 bufsize = sizeof(li->hostaddr);
427 memcpy(&li->hostaddr.sa, sa, bufsize);
432 ** login_write: Call low-level recording functions based on autoconf
436 login_write(struct logininfo *li)
439 if (geteuid() != 0) {
440 logit("Attempt to write login records by non-root user (aborting)");
445 /* set the timestamp */
446 login_set_current_time(li);
448 syslogin_write_entry(li);
451 if (li->type == LTYPE_LOGIN)
452 lastlog_write_entry(li);
455 utmp_write_entry(li);
458 wtmp_write_entry(li);
461 utmpx_write_entry(li);
464 wtmpx_write_entry(li);
466 #ifdef CUSTOM_SYS_AUTH_RECORD_LOGIN
467 if (li->type == LTYPE_LOGIN &&
468 !sys_auth_record_login(li->username,li->hostname,li->line,
470 logit("Writing login record failed for %s", li->username);
472 #ifdef SSH_AUDIT_EVENTS
473 if (li->type == LTYPE_LOGIN)
474 audit_session_open(li);
475 else if (li->type == LTYPE_LOGOUT)
476 audit_session_close(li);
481 #ifdef LOGIN_NEEDS_UTMPX
483 login_utmp_only(struct logininfo *li)
485 li->type = LTYPE_LOGIN;
486 login_set_current_time(li);
488 utmp_write_entry(li);
491 wtmp_write_entry(li);
494 utmpx_write_entry(li);
497 wtmpx_write_entry(li);
504 ** getlast_entry: Call low-level functions to retrieve the last login
508 /* take the uid in li and return the last login time */
510 getlast_entry(struct logininfo *li)
513 return(lastlog_get_entry(li));
514 #else /* !USE_LASTLOG */
515 #if defined(USE_UTMPX) && defined(HAVE_SETUTXDB) && \
516 defined(UTXDB_LASTLOGIN) && defined(HAVE_GETUTXUSER)
517 return (utmpx_get_entry(li));
520 #if defined(DISABLE_LASTLOG)
521 /* On some systems we shouldn't even try to obtain last login
524 # elif defined(USE_WTMP) && \
525 (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
526 /* retrieve last login time from utmp */
527 return (wtmp_get_entry(li));
528 # elif defined(USE_WTMPX) && \
529 (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
530 /* If wtmp isn't available, try wtmpx */
531 return (wtmpx_get_entry(li));
533 /* Give up: No means of retrieving last login time */
535 # endif /* DISABLE_LASTLOG */
536 #endif /* USE_LASTLOG */
542 * 'line' string utility functions
544 * These functions process the 'line' string into one of three forms:
546 * 1. The full filename (including '/dev')
547 * 2. The stripped name (excluding '/dev')
548 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
549 * /dev/pts/1 -> ts/1 )
551 * Form 3 is used on some systems to identify a .tmp.? entry when
552 * attempting to remove it. Typically both addition and removal is
553 * performed by one application - say, sshd - so as long as the choice
554 * uniquely identifies a terminal it's ok.
559 * line_fullname(): add the leading '/dev/' if it doesn't exist make
560 * sure dst has enough space, if not just copy src (ugh)
563 line_fullname(char *dst, const char *src, u_int dstsize)
565 memset(dst, '\0', dstsize);
566 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
567 strlcpy(dst, src, dstsize);
569 strlcpy(dst, "/dev/", dstsize);
570 strlcat(dst, src, dstsize);
575 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
577 line_stripname(char *dst, const char *src, int dstsize)
579 memset(dst, '\0', dstsize);
580 if (strncmp(src, "/dev/", 5) == 0)
581 strlcpy(dst, src + 5, dstsize);
583 strlcpy(dst, src, dstsize);
588 * line_abbrevname(): Return the abbreviated (usually four-character)
589 * form of the line (Just use the last <dstsize> characters of the
592 * NOTE: use strncpy because we do NOT necessarily want zero
596 line_abbrevname(char *dst, const char *src, int dstsize)
600 memset(dst, '\0', dstsize);
602 /* Always skip prefix if present */
603 if (strncmp(src, "/dev/", 5) == 0)
606 #ifdef WITH_ABBREV_NO_TTY
607 if (strncmp(src, "tty", 3) == 0)
614 if (((int)len - dstsize) > 0)
615 src += ((int)len - dstsize);
617 /* note: _don't_ change this to strlcpy */
618 strncpy(dst, src, (size_t)dstsize);
625 ** utmp utility functions
627 ** These functions manipulate struct utmp, taking system differences
631 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
633 /* build the utmp structure */
635 set_utmp_time(struct logininfo *li, struct utmp *ut)
637 # if defined(HAVE_TV_IN_UTMP)
638 ut->ut_tv.tv_sec = li->tv_sec;
639 ut->ut_tv.tv_usec = li->tv_usec;
640 # elif defined(HAVE_TIME_IN_UTMP)
641 ut->ut_time = li->tv_sec;
646 construct_utmp(struct logininfo *li,
649 # ifdef HAVE_ADDR_V6_IN_UTMP
650 struct sockaddr_in6 *sa6;
653 memset(ut, '\0', sizeof(*ut));
655 /* First fill out fields used for both logins and logouts */
657 # ifdef HAVE_ID_IN_UTMP
658 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
661 # ifdef HAVE_TYPE_IN_UTMP
662 /* This is done here to keep utmp constants out of struct logininfo */
665 ut->ut_type = USER_PROCESS;
668 ut->ut_type = DEAD_PROCESS;
672 set_utmp_time(li, ut);
674 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
676 # ifdef HAVE_PID_IN_UTMP
677 ut->ut_pid = li->pid;
680 /* If we're logging out, leave all other fields blank */
681 if (li->type == LTYPE_LOGOUT)
685 * These fields are only used when logging in, and are blank
689 /* Use strncpy because we don't necessarily want null termination */
690 strncpy(ut->ut_name, li->username,
691 MIN_SIZEOF(ut->ut_name, li->username));
692 # ifdef HAVE_HOST_IN_UTMP
693 strncpy(ut->ut_host, li->hostname,
694 MIN_SIZEOF(ut->ut_host, li->hostname));
696 # ifdef HAVE_ADDR_IN_UTMP
697 /* this is just a 32-bit IP address */
698 if (li->hostaddr.sa.sa_family == AF_INET)
699 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
701 # ifdef HAVE_ADDR_V6_IN_UTMP
702 /* this is just a 128-bit IPv6 address */
703 if (li->hostaddr.sa.sa_family == AF_INET6) {
704 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
705 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
706 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
707 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
708 ut->ut_addr_v6[1] = 0;
709 ut->ut_addr_v6[2] = 0;
710 ut->ut_addr_v6[3] = 0;
715 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
718 ** utmpx utility functions
720 ** These functions manipulate struct utmpx, accounting for system
724 #if defined(USE_UTMPX) || defined (USE_WTMPX)
725 /* build the utmpx structure */
727 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
729 # if defined(HAVE_TV_IN_UTMPX)
730 utx->ut_tv.tv_sec = li->tv_sec;
731 utx->ut_tv.tv_usec = li->tv_usec;
732 # elif defined(HAVE_TIME_IN_UTMPX)
733 utx->ut_time = li->tv_sec;
738 construct_utmpx(struct logininfo *li, struct utmpx *utx)
740 # ifdef HAVE_ADDR_V6_IN_UTMP
741 struct sockaddr_in6 *sa6;
743 memset(utx, '\0', sizeof(*utx));
745 # ifdef HAVE_ID_IN_UTMPX
746 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
749 /* this is done here to keep utmp constants out of loginrec.h */
752 utx->ut_type = USER_PROCESS;
755 utx->ut_type = DEAD_PROCESS;
758 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
759 set_utmpx_time(li, utx);
760 utx->ut_pid = li->pid;
762 /* strncpy(): Don't necessarily want null termination */
763 strncpy(utx->ut_user, li->username,
764 MIN_SIZEOF(utx->ut_user, li->username));
766 if (li->type == LTYPE_LOGOUT)
770 * These fields are only used when logging in, and are blank
774 # ifdef HAVE_HOST_IN_UTMPX
775 strncpy(utx->ut_host, li->hostname,
776 MIN_SIZEOF(utx->ut_host, li->hostname));
778 # ifdef HAVE_ADDR_IN_UTMPX
779 /* this is just a 32-bit IP address */
780 if (li->hostaddr.sa.sa_family == AF_INET)
781 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
783 # ifdef HAVE_ADDR_V6_IN_UTMP
784 /* this is just a 128-bit IPv6 address */
785 if (li->hostaddr.sa.sa_family == AF_INET6) {
786 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
787 memcpy(utx->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
788 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
789 utx->ut_addr_v6[0] = utx->ut_addr_v6[3];
790 utx->ut_addr_v6[1] = 0;
791 utx->ut_addr_v6[2] = 0;
792 utx->ut_addr_v6[3] = 0;
796 # ifdef HAVE_SYSLEN_IN_UTMPX
797 /* ut_syslen is the length of the utx_host string */
798 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
801 #endif /* USE_UTMPX || USE_WTMPX */
804 ** Low-level utmp functions
807 /* FIXME: (ATL) utmp_write_direct needs testing */
810 /* if we can, use pututline() etc. */
811 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
812 defined(HAVE_PUTUTLINE)
813 # define UTMP_USE_LIBRARY
817 /* write a utmp entry with the system's help (pututline() and pals) */
818 # ifdef UTMP_USE_LIBRARY
820 utmp_write_library(struct logininfo *li, struct utmp *ut)
824 # ifdef HAVE_ENDUTENT
829 # else /* UTMP_USE_LIBRARY */
832 * Write a utmp entry direct to the file
833 * This is a slightly modification of code in OpenBSD's login.c
836 utmp_write_direct(struct logininfo *li, struct utmp *ut)
842 /* FIXME: (ATL) ttyslot() needs local implementation */
844 #if defined(HAVE_GETTTYENT)
849 while (NULL != (ty = getttyent())) {
851 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
857 logit("%s: tty not found", __func__);
862 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
864 #endif /* HAVE_GETTTYENT */
866 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
869 pos = (off_t)tty * sizeof(struct utmp);
870 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
871 logit("%s: lseek: %s", __func__, strerror(errno));
876 logit("%s: Couldn't seek to tty %d slot in %s",
877 __func__, tty, UTMP_FILE);
882 * Prevent luser from zero'ing out ut_host.
883 * If the new ut_line is empty but the old one is not
884 * and ut_line and ut_name match, preserve the old ut_line.
886 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
887 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
888 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
889 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0))
890 memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
892 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
893 logit("%s: lseek: %s", __func__, strerror(errno));
898 logit("%s: Couldn't seek to tty %d slot in %s",
899 __func__, tty, UTMP_FILE);
903 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
904 logit("%s: error writing %s: %s", __func__,
905 UTMP_FILE, strerror(errno));
916 # endif /* UTMP_USE_LIBRARY */
919 utmp_perform_login(struct logininfo *li)
923 construct_utmp(li, &ut);
924 # ifdef UTMP_USE_LIBRARY
925 if (!utmp_write_library(li, &ut)) {
926 logit("%s: utmp_write_library() failed", __func__);
930 if (!utmp_write_direct(li, &ut)) {
931 logit("%s: utmp_write_direct() failed", __func__);
940 utmp_perform_logout(struct logininfo *li)
944 construct_utmp(li, &ut);
945 # ifdef UTMP_USE_LIBRARY
946 if (!utmp_write_library(li, &ut)) {
947 logit("%s: utmp_write_library() failed", __func__);
951 if (!utmp_write_direct(li, &ut)) {
952 logit("%s: utmp_write_direct() failed", __func__);
961 utmp_write_entry(struct logininfo *li)
965 return (utmp_perform_login(li));
968 return (utmp_perform_logout(li));
971 logit("%s: invalid type field", __func__);
975 #endif /* USE_UTMP */
979 ** Low-level utmpx functions
982 /* not much point if we don't want utmpx entries */
985 /* if we have the wherewithall, use pututxline etc. */
986 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
987 defined(HAVE_PUTUTXLINE)
988 # define UTMPX_USE_LIBRARY
992 /* write a utmpx entry with the system's help (pututxline() and pals) */
993 # ifdef UTMPX_USE_LIBRARY
995 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
1000 # ifdef HAVE_ENDUTXENT
1006 # else /* UTMPX_USE_LIBRARY */
1008 /* write a utmp entry direct to the file */
1010 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
1012 logit("%s: not implemented!", __func__);
1015 # endif /* UTMPX_USE_LIBRARY */
1018 utmpx_perform_login(struct logininfo *li)
1022 construct_utmpx(li, &utx);
1023 # ifdef UTMPX_USE_LIBRARY
1024 if (!utmpx_write_library(li, &utx)) {
1025 logit("%s: utmp_write_library() failed", __func__);
1029 if (!utmpx_write_direct(li, &ut)) {
1030 logit("%s: utmp_write_direct() failed", __func__);
1039 utmpx_perform_logout(struct logininfo *li)
1043 construct_utmpx(li, &utx);
1044 # ifdef HAVE_ID_IN_UTMPX
1045 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
1047 # ifdef HAVE_TYPE_IN_UTMPX
1048 utx.ut_type = DEAD_PROCESS;
1051 # ifdef UTMPX_USE_LIBRARY
1052 utmpx_write_library(li, &utx);
1054 utmpx_write_direct(li, &utx);
1060 utmpx_write_entry(struct logininfo *li)
1064 return (utmpx_perform_login(li));
1066 return (utmpx_perform_logout(li));
1068 logit("%s: invalid type field", __func__);
1072 #endif /* USE_UTMPX */
1076 ** Low-level wtmp functions
1082 * Write a wtmp entry direct to the end of the file
1083 * This is a slight modification of code in OpenBSD's logwtmp.c
1086 wtmp_write(struct logininfo *li, struct utmp *ut)
1091 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1092 logit("%s: problem writing %s: %s", __func__,
1093 WTMP_FILE, strerror(errno));
1096 if (fstat(fd, &buf) == 0)
1097 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
1098 ftruncate(fd, buf.st_size);
1099 logit("%s: problem writing %s: %s", __func__,
1100 WTMP_FILE, strerror(errno));
1108 wtmp_perform_login(struct logininfo *li)
1112 construct_utmp(li, &ut);
1113 return (wtmp_write(li, &ut));
1118 wtmp_perform_logout(struct logininfo *li)
1122 construct_utmp(li, &ut);
1123 return (wtmp_write(li, &ut));
1128 wtmp_write_entry(struct logininfo *li)
1132 return (wtmp_perform_login(li));
1134 return (wtmp_perform_logout(li));
1136 logit("%s: invalid type field", __func__);
1143 * Notes on fetching login data from wtmp/wtmpx
1145 * Logouts are usually recorded with (amongst other things) a blank
1146 * username on a given tty line. However, some systems (HP-UX is one)
1147 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1149 * Since we're only looking for logins here, we know that the username
1150 * must be set correctly. On systems that leave it in, we check for
1151 * ut_type==USER_PROCESS (indicating a login.)
1153 * Portability: Some systems may set something other than USER_PROCESS
1154 * to indicate a login process. I don't know of any as I write. Also,
1155 * it's possible that some systems may both leave the username in
1156 * place and not have ut_type.
1159 /* return true if this wtmp entry indicates a login */
1161 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1163 if (strncmp(li->username, ut->ut_name,
1164 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1165 # ifdef HAVE_TYPE_IN_UTMP
1166 if (ut->ut_type & USER_PROCESS)
1176 wtmp_get_entry(struct logininfo *li)
1182 /* Clear the time entries in our logininfo */
1183 li->tv_sec = li->tv_usec = 0;
1185 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1186 logit("%s: problem opening %s: %s", __func__,
1187 WTMP_FILE, strerror(errno));
1190 if (fstat(fd, &st) != 0) {
1191 logit("%s: couldn't stat %s: %s", __func__,
1192 WTMP_FILE, strerror(errno));
1197 /* Seek to the start of the last struct utmp */
1198 if (lseek(fd, -(off_t)sizeof(struct utmp), SEEK_END) == -1) {
1199 /* Looks like we've got a fresh wtmp file */
1205 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1206 logit("%s: read of %s failed: %s", __func__,
1207 WTMP_FILE, strerror(errno));
1211 if (wtmp_islogin(li, &ut) ) {
1214 * We've already checked for a time in struct
1215 * utmp, in login_getlast()
1217 # ifdef HAVE_TIME_IN_UTMP
1218 li->tv_sec = ut.ut_time;
1220 # if HAVE_TV_IN_UTMP
1221 li->tv_sec = ut.ut_tv.tv_sec;
1224 line_fullname(li->line, ut.ut_line,
1225 MIN_SIZEOF(li->line, ut.ut_line));
1226 # ifdef HAVE_HOST_IN_UTMP
1227 strlcpy(li->hostname, ut.ut_host,
1228 MIN_SIZEOF(li->hostname, ut.ut_host));
1232 /* Seek back 2 x struct utmp */
1233 if (lseek(fd, -(off_t)(2 * sizeof(struct utmp)), SEEK_CUR) == -1) {
1234 /* We've found the start of the file, so quit */
1240 /* We found an entry. Tidy up and return */
1244 # endif /* USE_WTMP */
1248 ** Low-level wtmpx functions
1253 * Write a wtmpx entry direct to the end of the file
1254 * This is a slight modification of code in OpenBSD's logwtmp.c
1257 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1259 #ifndef HAVE_UPDWTMPX
1263 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1264 logit("%s: problem opening %s: %s", __func__,
1265 WTMPX_FILE, strerror(errno));
1269 if (fstat(fd, &buf) == 0)
1270 if (atomicio(vwrite, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1271 ftruncate(fd, buf.st_size);
1272 logit("%s: problem writing %s: %s", __func__,
1273 WTMPX_FILE, strerror(errno));
1280 updwtmpx(WTMPX_FILE, utx);
1287 wtmpx_perform_login(struct logininfo *li)
1291 construct_utmpx(li, &utx);
1292 return (wtmpx_write(li, &utx));
1297 wtmpx_perform_logout(struct logininfo *li)
1301 construct_utmpx(li, &utx);
1302 return (wtmpx_write(li, &utx));
1307 wtmpx_write_entry(struct logininfo *li)
1311 return (wtmpx_perform_login(li));
1313 return (wtmpx_perform_logout(li));
1315 logit("%s: invalid type field", __func__);
1320 /* Please see the notes above wtmp_islogin() for information about the
1321 next two functions */
1323 /* Return true if this wtmpx entry indicates a login */
1325 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1327 if (strncmp(li->username, utx->ut_user,
1328 MIN_SIZEOF(li->username, utx->ut_user)) == 0 ) {
1329 # ifdef HAVE_TYPE_IN_UTMPX
1330 if (utx->ut_type == USER_PROCESS)
1341 wtmpx_get_entry(struct logininfo *li)
1347 /* Clear the time entries */
1348 li->tv_sec = li->tv_usec = 0;
1350 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1351 logit("%s: problem opening %s: %s", __func__,
1352 WTMPX_FILE, strerror(errno));
1355 if (fstat(fd, &st) != 0) {
1356 logit("%s: couldn't stat %s: %s", __func__,
1357 WTMPX_FILE, strerror(errno));
1362 /* Seek to the start of the last struct utmpx */
1363 if (lseek(fd, -(off_t)sizeof(struct utmpx), SEEK_END) == -1 ) {
1364 /* probably a newly rotated wtmpx file */
1370 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1371 logit("%s: read of %s failed: %s", __func__,
1372 WTMPX_FILE, strerror(errno));
1377 * Logouts are recorded as a blank username on a particular
1378 * line. So, we just need to find the username in struct utmpx
1380 if (wtmpx_islogin(li, &utx)) {
1382 # if defined(HAVE_TV_IN_UTMPX)
1383 li->tv_sec = utx.ut_tv.tv_sec;
1384 # elif defined(HAVE_TIME_IN_UTMPX)
1385 li->tv_sec = utx.ut_time;
1387 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1388 # if defined(HAVE_HOST_IN_UTMPX)
1389 strlcpy(li->hostname, utx.ut_host,
1390 MIN_SIZEOF(li->hostname, utx.ut_host));
1394 if (lseek(fd, -(off_t)(2 * sizeof(struct utmpx)), SEEK_CUR) == -1) {
1403 #endif /* USE_WTMPX */
1406 ** Low-level libutil login() functions
1411 syslogin_perform_login(struct logininfo *li)
1415 ut = xmalloc(sizeof(*ut));
1416 construct_utmp(li, ut);
1424 syslogin_perform_logout(struct logininfo *li)
1427 char line[UT_LINESIZE];
1429 (void)line_stripname(line, li->line, sizeof(line));
1432 logit("%s: logout() returned an error", __func__);
1433 # ifdef HAVE_LOGWTMP
1435 logwtmp(line, "", "");
1437 /* FIXME: (ATL - if the need arises) What to do if we have
1438 * login, but no logout? what if logout but no logwtmp? All
1439 * routines are in libutil so they should all be there,
1446 syslogin_write_entry(struct logininfo *li)
1450 return (syslogin_perform_login(li));
1452 return (syslogin_perform_logout(li));
1454 logit("%s: Invalid type field", __func__);
1458 #endif /* USE_LOGIN */
1460 /* end of file log-syslogin.c */
1463 ** Low-level lastlog functions
1468 #if !defined(LASTLOG_WRITE_PUTUTXLINE) || !defined(HAVE_GETLASTLOGXBYNAME)
1469 /* open the file (using filemode) and seek to the login entry */
1471 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1474 char lastlog_file[1024];
1477 if (stat(LASTLOG_FILE, &st) != 0) {
1478 logit("%s: Couldn't stat %s: %s", __func__,
1479 LASTLOG_FILE, strerror(errno));
1482 if (S_ISDIR(st.st_mode)) {
1483 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1484 LASTLOG_FILE, li->username);
1485 } else if (S_ISREG(st.st_mode)) {
1486 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1488 logit("%s: %.100s is not a file or directory!", __func__,
1493 *fd = open(lastlog_file, filemode, 0600);
1495 debug("%s: Couldn't open %s: %s", __func__,
1496 lastlog_file, strerror(errno));
1500 if (S_ISREG(st.st_mode)) {
1501 /* find this uid's offset in the lastlog file */
1502 offset = (off_t) ((u_long)li->uid * sizeof(struct lastlog));
1504 if (lseek(*fd, offset, SEEK_SET) != offset) {
1505 logit("%s: %s->lseek(): %s", __func__,
1506 lastlog_file, strerror(errno));
1514 #endif /* !LASTLOG_WRITE_PUTUTXLINE || !HAVE_GETLASTLOGXBYNAME */
1516 #ifdef LASTLOG_WRITE_PUTUTXLINE
1518 lastlog_write_entry(struct logininfo *li)
1522 return 1; /* lastlog written by pututxline */
1524 logit("lastlog_write_entry: Invalid type field");
1528 #else /* LASTLOG_WRITE_PUTUTXLINE */
1530 lastlog_write_entry(struct logininfo *li)
1532 struct lastlog last;
1537 /* create our struct lastlog */
1538 memset(&last, '\0', sizeof(last));
1539 line_stripname(last.ll_line, li->line, sizeof(last.ll_line));
1540 strlcpy(last.ll_host, li->hostname,
1541 MIN_SIZEOF(last.ll_host, li->hostname));
1542 last.ll_time = li->tv_sec;
1544 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1547 /* write the entry */
1548 if (atomicio(vwrite, fd, &last, sizeof(last)) != sizeof(last)) {
1550 logit("%s: Error writing to %s: %s", __func__,
1551 LASTLOG_FILE, strerror(errno));
1558 logit("%s: Invalid type field", __func__);
1562 #endif /* LASTLOG_WRITE_PUTUTXLINE */
1564 #ifdef HAVE_GETLASTLOGXBYNAME
1566 lastlog_get_entry(struct logininfo *li)
1568 struct lastlogx l, *ll;
1570 if ((ll = getlastlogxbyname(li->username, &l)) == NULL) {
1571 memset(&l, '\0', sizeof(l));
1574 line_fullname(li->line, ll->ll_line, sizeof(li->line));
1575 strlcpy(li->hostname, ll->ll_host,
1576 MIN_SIZEOF(li->hostname, ll->ll_host));
1577 li->tv_sec = ll->ll_tv.tv_sec;
1578 li->tv_usec = ll->ll_tv.tv_usec;
1581 #else /* HAVE_GETLASTLOGXBYNAME */
1583 lastlog_get_entry(struct logininfo *li)
1585 struct lastlog last;
1588 if (!lastlog_openseek(li, &fd, O_RDONLY))
1591 ret = atomicio(read, fd, &last, sizeof(last));
1596 memset(&last, '\0', sizeof(last));
1599 line_fullname(li->line, last.ll_line, sizeof(li->line));
1600 strlcpy(li->hostname, last.ll_host,
1601 MIN_SIZEOF(li->hostname, last.ll_host));
1602 li->tv_sec = last.ll_time;
1605 error("%s: Error reading from %s: %s", __func__,
1606 LASTLOG_FILE, strerror(errno));
1609 error("%s: Error reading from %s: Expecting %d, got %d",
1610 __func__, LASTLOG_FILE, (int)sizeof(last), ret);
1617 #endif /* HAVE_GETLASTLOGXBYNAME */
1618 #endif /* USE_LASTLOG */
1620 #if defined(USE_UTMPX) && defined(HAVE_SETUTXDB) && \
1621 defined(UTXDB_LASTLOGIN) && defined(HAVE_GETUTXUSER)
1623 utmpx_get_entry(struct logininfo *li)
1627 if (setutxdb(UTXDB_LASTLOGIN, NULL) != 0)
1629 utx = getutxuser(li->username);
1635 line_fullname(li->line, utx->ut_line,
1636 MIN_SIZEOF(li->line, utx->ut_line));
1637 strlcpy(li->hostname, utx->ut_host,
1638 MIN_SIZEOF(li->hostname, utx->ut_host));
1639 li->tv_sec = utx->ut_tv.tv_sec;
1640 li->tv_usec = utx->ut_tv.tv_usec;
1644 #endif /* USE_UTMPX && HAVE_SETUTXDB && UTXDB_LASTLOGIN && HAVE_GETUTXUSER */
1648 * Logs failed login attempts in _PATH_BTMP if that exists.
1649 * The most common login failure is to give password instead of username.
1650 * So the _PATH_BTMP file checked for the correct permission, so that
1651 * only root can read it.
1655 record_failed_login(const char *username, const char *hostname,
1660 struct sockaddr_storage from;
1661 socklen_t fromlen = sizeof(from);
1662 struct sockaddr_in *a4;
1663 struct sockaddr_in6 *a6;
1669 if ((fd = open(_PATH_BTMP, O_WRONLY | O_APPEND)) < 0) {
1670 debug("Unable to open the btmp file %s: %s", _PATH_BTMP,
1674 if (fstat(fd, &fst) < 0) {
1675 logit("%s: fstat of %s failed: %s", __func__, _PATH_BTMP,
1679 if((fst.st_mode & (S_IXGRP | S_IRWXO)) || (fst.st_uid != 0)){
1680 logit("Excess permission or bad ownership on file %s",
1685 memset(&ut, 0, sizeof(ut));
1686 /* strncpy because we don't necessarily want nul termination */
1687 strncpy(ut.ut_user, username, sizeof(ut.ut_user));
1688 strlcpy(ut.ut_line, "ssh:notty", sizeof(ut.ut_line));
1691 ut.ut_time = t; /* ut_time is not always a time_t */
1692 ut.ut_type = LOGIN_PROCESS;
1693 ut.ut_pid = getpid();
1695 /* strncpy because we don't necessarily want nul termination */
1696 strncpy(ut.ut_host, hostname, sizeof(ut.ut_host));
1698 if (packet_connection_is_on_socket() &&
1699 getpeername(packet_get_connection_in(),
1700 (struct sockaddr *)&from, &fromlen) == 0) {
1701 ipv64_normalise_mapped(&from, &fromlen);
1702 if (from.ss_family == AF_INET) {
1703 a4 = (struct sockaddr_in *)&from;
1704 memcpy(&ut.ut_addr, &(a4->sin_addr),
1705 MIN_SIZEOF(ut.ut_addr, a4->sin_addr));
1707 #ifdef HAVE_ADDR_V6_IN_UTMP
1708 if (from.ss_family == AF_INET6) {
1709 a6 = (struct sockaddr_in6 *)&from;
1710 memcpy(&ut.ut_addr_v6, &(a6->sin6_addr),
1711 MIN_SIZEOF(ut.ut_addr_v6, a6->sin6_addr));
1716 if (atomicio(vwrite, fd, &ut, sizeof(ut)) != sizeof(ut))
1717 error("Failed to write to %s: %s", _PATH_BTMP,
1723 #endif /* USE_BTMP */