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"
149 __RCSID("$FreeBSD$");
151 #include <sys/types.h>
152 #include <sys/stat.h>
153 #include <sys/socket.h>
155 #include <netinet/in.h>
170 #include "hostfile.h"
172 #include "loginrec.h"
174 #include "atomicio.h"
176 #include "canohost.h"
184 #ifdef HAVE_LIBUTIL_H
185 # include <libutil.h>
189 ** prototypes for helper functions in this file
193 void set_utmp_time(struct logininfo *li, struct utmp *ut);
194 void construct_utmp(struct logininfo *li, struct utmp *ut);
198 void set_utmpx_time(struct logininfo *li, struct utmpx *ut);
199 void construct_utmpx(struct logininfo *li, struct utmpx *ut);
202 int utmp_write_entry(struct logininfo *li);
203 int utmpx_write_entry(struct logininfo *li);
204 int wtmp_write_entry(struct logininfo *li);
205 int wtmpx_write_entry(struct logininfo *li);
206 int lastlog_write_entry(struct logininfo *li);
207 int syslogin_write_entry(struct logininfo *li);
209 int getlast_entry(struct logininfo *li);
210 int lastlog_get_entry(struct logininfo *li);
211 int utmpx_get_entry(struct logininfo *li);
212 int wtmp_get_entry(struct logininfo *li);
213 int wtmpx_get_entry(struct logininfo *li);
215 extern Buffer loginmsg;
217 /* pick the shortest string */
218 #define MIN_SIZEOF(s1,s2) (sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2))
221 ** platform-independent login functions
225 * login_login(struct logininfo *) - Record a login
227 * Call with a pointer to a struct logininfo initialised with
228 * login_init_entry() or login_alloc_entry()
232 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
235 login_login(struct logininfo *li)
237 li->type = LTYPE_LOGIN;
238 return (login_write(li));
243 * login_logout(struct logininfo *) - Record a logout
245 * Call as with login_login()
249 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
252 login_logout(struct logininfo *li)
254 li->type = LTYPE_LOGOUT;
255 return (login_write(li));
259 * login_get_lastlog_time(int) - Retrieve the last login time
261 * Retrieve the last login time for the given uid. Will try to use the
262 * system lastlog facilities if they are available, but will fall back
263 * to looking in wtmp/wtmpx if necessary
266 * 0 on failure, or if user has never logged in
267 * Time in seconds from the epoch if successful
269 * Useful preprocessor symbols:
270 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
272 * USE_LASTLOG: If set, indicates the presence of system lastlog
273 * facilities. If this and DISABLE_LASTLOG are not set,
274 * try to retrieve lastlog information from wtmp/wtmpx.
277 login_get_lastlog_time(const int uid)
281 if (login_get_lastlog(&li, uid))
288 * login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
290 * Retrieve a logininfo structure populated (only partially) with
291 * information from the system lastlog data, or from wtmp/wtmpx if no
292 * system lastlog information exists.
294 * Note this routine must be given a pre-allocated logininfo.
297 * >0: A pointer to your struct logininfo if successful
298 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
301 login_get_lastlog(struct logininfo *li, const int uid)
305 memset(li, '\0', sizeof(*li));
309 * If we don't have a 'real' lastlog, we need the username to
310 * reliably search wtmp(x) for the last login (see
315 fatal("%s: Cannot find account for uid %i", __func__, uid);
317 /* No MIN_SIZEOF here - we absolutely *must not* truncate the
318 * username (XXX - so check for trunc!) */
319 strlcpy(li->username, pw->pw_name, sizeof(li->username));
321 if (getlast_entry(li))
329 * login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
330 * a logininfo structure
332 * This function creates a new struct logininfo, a data structure
333 * meant to carry the information required to portably record login info.
335 * Returns a pointer to a newly created struct logininfo. If memory
336 * allocation fails, the program halts.
339 logininfo *login_alloc_entry(int pid, const char *username,
340 const char *hostname, const char *line)
342 struct logininfo *newli;
344 newli = xmalloc(sizeof(*newli));
345 login_init_entry(newli, pid, username, hostname, line);
350 /* login_free_entry(struct logininfo *) - free struct memory */
352 login_free_entry(struct logininfo *li)
358 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
359 * - initialise a struct logininfo
361 * Populates a new struct logininfo, a data structure meant to carry
362 * the information required to portably record login info.
367 login_init_entry(struct logininfo *li, int pid, const char *username,
368 const char *hostname, const char *line)
372 memset(li, 0, sizeof(*li));
376 /* set the line information */
378 line_fullname(li->line, line, sizeof(li->line));
381 strlcpy(li->username, username, sizeof(li->username));
382 pw = getpwnam(li->username);
384 fatal("%s: Cannot find user \"%s\"", __func__,
387 li->uid = pw->pw_uid;
391 strlcpy(li->hostname, hostname, sizeof(li->hostname));
397 * login_set_current_time(struct logininfo *) - set the current time
399 * Set the current time in a logininfo structure. This function is
400 * meant to eliminate the need to deal with system dependencies for
404 login_set_current_time(struct logininfo *li)
408 gettimeofday(&tv, NULL);
410 li->tv_sec = tv.tv_sec;
411 li->tv_usec = tv.tv_usec;
414 /* copy a sockaddr_* into our logininfo */
416 login_set_addr(struct logininfo *li, const struct sockaddr *sa,
417 const unsigned int sa_size)
419 unsigned int bufsize = sa_size;
421 /* make sure we don't overrun our union */
422 if (sizeof(li->hostaddr) < sa_size)
423 bufsize = sizeof(li->hostaddr);
425 memcpy(&li->hostaddr.sa, sa, bufsize);
430 ** login_write: Call low-level recording functions based on autoconf
434 login_write(struct logininfo *li)
437 if (geteuid() != 0) {
438 logit("Attempt to write login records by non-root user (aborting)");
443 /* set the timestamp */
444 login_set_current_time(li);
446 syslogin_write_entry(li);
449 if (li->type == LTYPE_LOGIN)
450 lastlog_write_entry(li);
453 utmp_write_entry(li);
456 wtmp_write_entry(li);
459 utmpx_write_entry(li);
462 wtmpx_write_entry(li);
464 #ifdef CUSTOM_SYS_AUTH_RECORD_LOGIN
465 if (li->type == LTYPE_LOGIN &&
466 !sys_auth_record_login(li->username,li->hostname,li->line,
468 logit("Writing login record failed for %s", li->username);
470 #ifdef SSH_AUDIT_EVENTS
471 if (li->type == LTYPE_LOGIN)
472 audit_session_open(li->line);
473 else if (li->type == LTYPE_LOGOUT)
474 audit_session_close(li->line);
479 #ifdef LOGIN_NEEDS_UTMPX
481 login_utmp_only(struct logininfo *li)
483 li->type = LTYPE_LOGIN;
484 login_set_current_time(li);
486 utmp_write_entry(li);
489 wtmp_write_entry(li);
492 utmpx_write_entry(li);
495 wtmpx_write_entry(li);
502 ** getlast_entry: Call low-level functions to retrieve the last login
506 /* take the uid in li and return the last login time */
508 getlast_entry(struct logininfo *li)
511 return(lastlog_get_entry(li));
512 #else /* !USE_LASTLOG */
513 #if defined(USE_UTMPX) && defined(HAVE_SETUTXDB) && \
514 defined(UTXDB_LASTLOGIN) && defined(HAVE_GETUTXUSER)
515 return (utmpx_get_entry(li));
519 return (utmpx_get_entry(li));
522 #if defined(DISABLE_LASTLOG)
523 /* On some systems we shouldn't even try to obtain last login
526 # elif defined(USE_WTMP) && \
527 (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
528 /* retrieve last login time from utmp */
529 return (wtmp_get_entry(li));
530 # elif defined(USE_WTMPX) && \
531 (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
532 /* If wtmp isn't available, try wtmpx */
533 return (wtmpx_get_entry(li));
535 /* Give up: No means of retrieving last login time */
537 # endif /* DISABLE_LASTLOG */
538 #endif /* USE_LASTLOG */
544 * 'line' string utility functions
546 * These functions process the 'line' string into one of three forms:
548 * 1. The full filename (including '/dev')
549 * 2. The stripped name (excluding '/dev')
550 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
551 * /dev/pts/1 -> ts/1 )
553 * Form 3 is used on some systems to identify a .tmp.? entry when
554 * attempting to remove it. Typically both addition and removal is
555 * performed by one application - say, sshd - so as long as the choice
556 * uniquely identifies a terminal it's ok.
561 * line_fullname(): add the leading '/dev/' if it doesn't exist make
562 * sure dst has enough space, if not just copy src (ugh)
565 line_fullname(char *dst, const char *src, u_int dstsize)
567 memset(dst, '\0', dstsize);
568 if ((strncmp(src, "/dev/", 5) == 0) || (dstsize < (strlen(src) + 5)))
569 strlcpy(dst, src, dstsize);
571 strlcpy(dst, "/dev/", dstsize);
572 strlcat(dst, src, dstsize);
577 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
579 line_stripname(char *dst, const char *src, int dstsize)
581 memset(dst, '\0', dstsize);
582 if (strncmp(src, "/dev/", 5) == 0)
583 strlcpy(dst, src + 5, dstsize);
585 strlcpy(dst, src, dstsize);
590 * line_abbrevname(): Return the abbreviated (usually four-character)
591 * form of the line (Just use the last <dstsize> characters of the
594 * NOTE: use strncpy because we do NOT necessarily want zero
598 line_abbrevname(char *dst, const char *src, int dstsize)
602 memset(dst, '\0', dstsize);
604 /* Always skip prefix if present */
605 if (strncmp(src, "/dev/", 5) == 0)
608 #ifdef WITH_ABBREV_NO_TTY
609 if (strncmp(src, "tty", 3) == 0)
616 if (((int)len - dstsize) > 0)
617 src += ((int)len - dstsize);
619 /* note: _don't_ change this to strlcpy */
620 strncpy(dst, src, (size_t)dstsize);
627 ** utmp utility functions
629 ** These functions manipulate struct utmp, taking system differences
633 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
635 /* build the utmp structure */
637 set_utmp_time(struct logininfo *li, struct utmp *ut)
639 # if defined(HAVE_TV_IN_UTMP)
640 ut->ut_tv.tv_sec = li->tv_sec;
641 ut->ut_tv.tv_usec = li->tv_usec;
642 # elif defined(HAVE_TIME_IN_UTMP)
643 ut->ut_time = li->tv_sec;
648 construct_utmp(struct logininfo *li,
651 # ifdef HAVE_ADDR_V6_IN_UTMP
652 struct sockaddr_in6 *sa6;
655 memset(ut, '\0', sizeof(*ut));
657 /* First fill out fields used for both logins and logouts */
659 # ifdef HAVE_ID_IN_UTMP
660 line_abbrevname(ut->ut_id, li->line, sizeof(ut->ut_id));
663 # ifdef HAVE_TYPE_IN_UTMP
664 /* This is done here to keep utmp constants out of struct logininfo */
667 ut->ut_type = USER_PROCESS;
673 ut->ut_type = DEAD_PROCESS;
675 cray_retain_utmp(ut, li->pid);
680 set_utmp_time(li, ut);
682 line_stripname(ut->ut_line, li->line, sizeof(ut->ut_line));
684 # ifdef HAVE_PID_IN_UTMP
685 ut->ut_pid = li->pid;
688 /* If we're logging out, leave all other fields blank */
689 if (li->type == LTYPE_LOGOUT)
693 * These fields are only used when logging in, and are blank
697 /* Use strncpy because we don't necessarily want null termination */
698 strncpy(ut->ut_name, li->username,
699 MIN_SIZEOF(ut->ut_name, li->username));
700 # ifdef HAVE_HOST_IN_UTMP
701 strncpy(ut->ut_host, li->hostname,
702 MIN_SIZEOF(ut->ut_host, li->hostname));
704 # ifdef HAVE_ADDR_IN_UTMP
705 /* this is just a 32-bit IP address */
706 if (li->hostaddr.sa.sa_family == AF_INET)
707 ut->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
709 # ifdef HAVE_ADDR_V6_IN_UTMP
710 /* this is just a 128-bit IPv6 address */
711 if (li->hostaddr.sa.sa_family == AF_INET6) {
712 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
713 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
714 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
715 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
716 ut->ut_addr_v6[1] = 0;
717 ut->ut_addr_v6[2] = 0;
718 ut->ut_addr_v6[3] = 0;
723 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
726 ** utmpx utility functions
728 ** These functions manipulate struct utmpx, accounting for system
732 #if defined(USE_UTMPX) || defined (USE_WTMPX)
733 /* build the utmpx structure */
735 set_utmpx_time(struct logininfo *li, struct utmpx *utx)
737 # if defined(HAVE_TV_IN_UTMPX)
738 utx->ut_tv.tv_sec = li->tv_sec;
739 utx->ut_tv.tv_usec = li->tv_usec;
740 # elif defined(HAVE_TIME_IN_UTMPX)
741 utx->ut_time = li->tv_sec;
746 construct_utmpx(struct logininfo *li, struct utmpx *utx)
748 # ifdef HAVE_ADDR_V6_IN_UTMP
749 struct sockaddr_in6 *sa6;
751 memset(utx, '\0', sizeof(*utx));
753 # ifdef HAVE_ID_IN_UTMPX
754 line_abbrevname(utx->ut_id, li->line, sizeof(utx->ut_id));
757 /* this is done here to keep utmp constants out of loginrec.h */
760 utx->ut_type = USER_PROCESS;
763 utx->ut_type = DEAD_PROCESS;
766 line_stripname(utx->ut_line, li->line, sizeof(utx->ut_line));
767 set_utmpx_time(li, utx);
768 utx->ut_pid = li->pid;
770 /* strncpy(): Don't necessarily want null termination */
771 strncpy(utx->ut_user, li->username,
772 MIN_SIZEOF(utx->ut_user, li->username));
774 if (li->type == LTYPE_LOGOUT)
778 * These fields are only used when logging in, and are blank
782 # ifdef HAVE_HOST_IN_UTMPX
783 strncpy(utx->ut_host, li->hostname,
784 MIN_SIZEOF(utx->ut_host, li->hostname));
786 # ifdef HAVE_ADDR_IN_UTMPX
787 /* this is just a 32-bit IP address */
788 if (li->hostaddr.sa.sa_family == AF_INET)
789 utx->ut_addr = li->hostaddr.sa_in.sin_addr.s_addr;
791 # ifdef HAVE_ADDR_V6_IN_UTMP
792 /* this is just a 128-bit IPv6 address */
793 if (li->hostaddr.sa.sa_family == AF_INET6) {
794 sa6 = ((struct sockaddr_in6 *)&li->hostaddr.sa);
795 memcpy(ut->ut_addr_v6, sa6->sin6_addr.s6_addr, 16);
796 if (IN6_IS_ADDR_V4MAPPED(&sa6->sin6_addr)) {
797 ut->ut_addr_v6[0] = ut->ut_addr_v6[3];
798 ut->ut_addr_v6[1] = 0;
799 ut->ut_addr_v6[2] = 0;
800 ut->ut_addr_v6[3] = 0;
804 # ifdef HAVE_SYSLEN_IN_UTMPX
805 /* ut_syslen is the length of the utx_host string */
806 utx->ut_syslen = MIN(strlen(li->hostname), sizeof(utx->ut_host));
809 #endif /* USE_UTMPX || USE_WTMPX */
812 ** Low-level utmp functions
815 /* FIXME: (ATL) utmp_write_direct needs testing */
818 /* if we can, use pututline() etc. */
819 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
820 defined(HAVE_PUTUTLINE)
821 # define UTMP_USE_LIBRARY
825 /* write a utmp entry with the system's help (pututline() and pals) */
826 # ifdef UTMP_USE_LIBRARY
828 utmp_write_library(struct logininfo *li, struct utmp *ut)
832 # ifdef HAVE_ENDUTENT
837 # else /* UTMP_USE_LIBRARY */
840 * Write a utmp entry direct to the file
841 * This is a slightly modification of code in OpenBSD's login.c
844 utmp_write_direct(struct logininfo *li, struct utmp *ut)
850 /* FIXME: (ATL) ttyslot() needs local implementation */
852 #if defined(HAVE_GETTTYENT)
857 while (NULL != (ty = getttyent())) {
859 if (!strncmp(ty->ty_name, ut->ut_line, sizeof(ut->ut_line)))
865 logit("%s: tty not found", __func__);
870 tty = ttyslot(); /* seems only to work for /dev/ttyp? style names */
872 #endif /* HAVE_GETTTYENT */
874 if (tty > 0 && (fd = open(UTMP_FILE, O_RDWR|O_CREAT, 0644)) >= 0) {
877 pos = (off_t)tty * sizeof(struct utmp);
878 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
879 logit("%s: lseek: %s", __func__, strerror(errno));
883 logit("%s: Couldn't seek to tty %d slot in %s",
884 __func__, tty, UTMP_FILE);
888 * Prevent luser from zero'ing out ut_host.
889 * If the new ut_line is empty but the old one is not
890 * and ut_line and ut_name match, preserve the old ut_line.
892 if (atomicio(read, fd, &old_ut, sizeof(old_ut)) == sizeof(old_ut) &&
893 (ut->ut_host[0] == '\0') && (old_ut.ut_host[0] != '\0') &&
894 (strncmp(old_ut.ut_line, ut->ut_line, sizeof(ut->ut_line)) == 0) &&
895 (strncmp(old_ut.ut_name, ut->ut_name, sizeof(ut->ut_name)) == 0))
896 memcpy(ut->ut_host, old_ut.ut_host, sizeof(ut->ut_host));
898 if ((ret = lseek(fd, pos, SEEK_SET)) == -1) {
899 logit("%s: lseek: %s", __func__, strerror(errno));
903 logit("%s: Couldn't seek to tty %d slot in %s",
904 __func__, tty, UTMP_FILE);
907 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
908 logit("%s: error writing %s: %s", __func__,
909 UTMP_FILE, strerror(errno));
918 # endif /* UTMP_USE_LIBRARY */
921 utmp_perform_login(struct logininfo *li)
925 construct_utmp(li, &ut);
926 # ifdef UTMP_USE_LIBRARY
927 if (!utmp_write_library(li, &ut)) {
928 logit("%s: utmp_write_library() failed", __func__);
932 if (!utmp_write_direct(li, &ut)) {
933 logit("%s: utmp_write_direct() failed", __func__);
942 utmp_perform_logout(struct logininfo *li)
946 construct_utmp(li, &ut);
947 # ifdef UTMP_USE_LIBRARY
948 if (!utmp_write_library(li, &ut)) {
949 logit("%s: utmp_write_library() failed", __func__);
953 if (!utmp_write_direct(li, &ut)) {
954 logit("%s: utmp_write_direct() failed", __func__);
963 utmp_write_entry(struct logininfo *li)
967 return (utmp_perform_login(li));
970 return (utmp_perform_logout(li));
973 logit("%s: invalid type field", __func__);
977 #endif /* USE_UTMP */
981 ** Low-level utmpx functions
984 /* not much point if we don't want utmpx entries */
987 /* if we have the wherewithall, use pututxline etc. */
988 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
989 defined(HAVE_PUTUTXLINE)
990 # define UTMPX_USE_LIBRARY
994 /* write a utmpx entry with the system's help (pututxline() and pals) */
995 # ifdef UTMPX_USE_LIBRARY
997 utmpx_write_library(struct logininfo *li, struct utmpx *utx)
1002 # ifdef HAVE_ENDUTXENT
1008 # else /* UTMPX_USE_LIBRARY */
1010 /* write a utmp entry direct to the file */
1012 utmpx_write_direct(struct logininfo *li, struct utmpx *utx)
1014 logit("%s: not implemented!", __func__);
1017 # endif /* UTMPX_USE_LIBRARY */
1020 utmpx_perform_login(struct logininfo *li)
1024 construct_utmpx(li, &utx);
1025 # ifdef UTMPX_USE_LIBRARY
1026 if (!utmpx_write_library(li, &utx)) {
1027 logit("%s: utmp_write_library() failed", __func__);
1031 if (!utmpx_write_direct(li, &ut)) {
1032 logit("%s: utmp_write_direct() failed", __func__);
1041 utmpx_perform_logout(struct logininfo *li)
1045 construct_utmpx(li, &utx);
1046 # ifdef HAVE_ID_IN_UTMPX
1047 line_abbrevname(utx.ut_id, li->line, sizeof(utx.ut_id));
1049 # ifdef HAVE_TYPE_IN_UTMPX
1050 utx.ut_type = DEAD_PROCESS;
1053 # ifdef UTMPX_USE_LIBRARY
1054 utmpx_write_library(li, &utx);
1056 utmpx_write_direct(li, &utx);
1062 utmpx_write_entry(struct logininfo *li)
1066 return (utmpx_perform_login(li));
1068 return (utmpx_perform_logout(li));
1070 logit("%s: invalid type field", __func__);
1074 #endif /* USE_UTMPX */
1078 ** Low-level wtmp functions
1084 * Write a wtmp entry direct to the end of the file
1085 * This is a slight modification of code in OpenBSD's logwtmp.c
1088 wtmp_write(struct logininfo *li, struct utmp *ut)
1093 if ((fd = open(WTMP_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1094 logit("%s: problem writing %s: %s", __func__,
1095 WTMP_FILE, strerror(errno));
1098 if (fstat(fd, &buf) == 0)
1099 if (atomicio(vwrite, fd, ut, sizeof(*ut)) != sizeof(*ut)) {
1100 ftruncate(fd, buf.st_size);
1101 logit("%s: problem writing %s: %s", __func__,
1102 WTMP_FILE, strerror(errno));
1110 wtmp_perform_login(struct logininfo *li)
1114 construct_utmp(li, &ut);
1115 return (wtmp_write(li, &ut));
1120 wtmp_perform_logout(struct logininfo *li)
1124 construct_utmp(li, &ut);
1125 return (wtmp_write(li, &ut));
1130 wtmp_write_entry(struct logininfo *li)
1134 return (wtmp_perform_login(li));
1136 return (wtmp_perform_logout(li));
1138 logit("%s: invalid type field", __func__);
1145 * Notes on fetching login data from wtmp/wtmpx
1147 * Logouts are usually recorded with (amongst other things) a blank
1148 * username on a given tty line. However, some systems (HP-UX is one)
1149 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1151 * Since we're only looking for logins here, we know that the username
1152 * must be set correctly. On systems that leave it in, we check for
1153 * ut_type==USER_PROCESS (indicating a login.)
1155 * Portability: Some systems may set something other than USER_PROCESS
1156 * to indicate a login process. I don't know of any as I write. Also,
1157 * it's possible that some systems may both leave the username in
1158 * place and not have ut_type.
1161 /* return true if this wtmp entry indicates a login */
1163 wtmp_islogin(struct logininfo *li, struct utmp *ut)
1165 if (strncmp(li->username, ut->ut_name,
1166 MIN_SIZEOF(li->username, ut->ut_name)) == 0) {
1167 # ifdef HAVE_TYPE_IN_UTMP
1168 if (ut->ut_type & USER_PROCESS)
1178 wtmp_get_entry(struct logininfo *li)
1184 /* Clear the time entries in our logininfo */
1185 li->tv_sec = li->tv_usec = 0;
1187 if ((fd = open(WTMP_FILE, O_RDONLY)) < 0) {
1188 logit("%s: problem opening %s: %s", __func__,
1189 WTMP_FILE, strerror(errno));
1192 if (fstat(fd, &st) != 0) {
1193 logit("%s: couldn't stat %s: %s", __func__,
1194 WTMP_FILE, strerror(errno));
1199 /* Seek to the start of the last struct utmp */
1200 if (lseek(fd, -(off_t)sizeof(struct utmp), SEEK_END) == -1) {
1201 /* Looks like we've got a fresh wtmp file */
1207 if (atomicio(read, fd, &ut, sizeof(ut)) != sizeof(ut)) {
1208 logit("%s: read of %s failed: %s", __func__,
1209 WTMP_FILE, strerror(errno));
1213 if ( wtmp_islogin(li, &ut) ) {
1216 * We've already checked for a time in struct
1217 * utmp, in login_getlast()
1219 # ifdef HAVE_TIME_IN_UTMP
1220 li->tv_sec = ut.ut_time;
1222 # if HAVE_TV_IN_UTMP
1223 li->tv_sec = ut.ut_tv.tv_sec;
1226 line_fullname(li->line, ut.ut_line,
1227 MIN_SIZEOF(li->line, ut.ut_line));
1228 # ifdef HAVE_HOST_IN_UTMP
1229 strlcpy(li->hostname, ut.ut_host,
1230 MIN_SIZEOF(li->hostname, ut.ut_host));
1234 /* Seek back 2 x struct utmp */
1235 if (lseek(fd, -(off_t)(2 * sizeof(struct utmp)), SEEK_CUR) == -1) {
1236 /* We've found the start of the file, so quit */
1242 /* We found an entry. Tidy up and return */
1246 # endif /* USE_WTMP */
1250 ** Low-level wtmpx functions
1255 * Write a wtmpx entry direct to the end of the file
1256 * This is a slight modification of code in OpenBSD's logwtmp.c
1259 wtmpx_write(struct logininfo *li, struct utmpx *utx)
1261 #ifndef HAVE_UPDWTMPX
1265 if ((fd = open(WTMPX_FILE, O_WRONLY|O_APPEND, 0)) < 0) {
1266 logit("%s: problem opening %s: %s", __func__,
1267 WTMPX_FILE, strerror(errno));
1271 if (fstat(fd, &buf) == 0)
1272 if (atomicio(vwrite, fd, utx, sizeof(*utx)) != sizeof(*utx)) {
1273 ftruncate(fd, buf.st_size);
1274 logit("%s: problem writing %s: %s", __func__,
1275 WTMPX_FILE, strerror(errno));
1282 updwtmpx(WTMPX_FILE, utx);
1289 wtmpx_perform_login(struct logininfo *li)
1293 construct_utmpx(li, &utx);
1294 return (wtmpx_write(li, &utx));
1299 wtmpx_perform_logout(struct logininfo *li)
1303 construct_utmpx(li, &utx);
1304 return (wtmpx_write(li, &utx));
1309 wtmpx_write_entry(struct logininfo *li)
1313 return (wtmpx_perform_login(li));
1315 return (wtmpx_perform_logout(li));
1317 logit("%s: invalid type field", __func__);
1322 /* Please see the notes above wtmp_islogin() for information about the
1323 next two functions */
1325 /* Return true if this wtmpx entry indicates a login */
1327 wtmpx_islogin(struct logininfo *li, struct utmpx *utx)
1329 if (strncmp(li->username, utx->ut_user,
1330 MIN_SIZEOF(li->username, utx->ut_user)) == 0 ) {
1331 # ifdef HAVE_TYPE_IN_UTMPX
1332 if (utx->ut_type == USER_PROCESS)
1343 wtmpx_get_entry(struct logininfo *li)
1349 /* Clear the time entries */
1350 li->tv_sec = li->tv_usec = 0;
1352 if ((fd = open(WTMPX_FILE, O_RDONLY)) < 0) {
1353 logit("%s: problem opening %s: %s", __func__,
1354 WTMPX_FILE, strerror(errno));
1357 if (fstat(fd, &st) != 0) {
1358 logit("%s: couldn't stat %s: %s", __func__,
1359 WTMPX_FILE, strerror(errno));
1364 /* Seek to the start of the last struct utmpx */
1365 if (lseek(fd, -(off_t)sizeof(struct utmpx), SEEK_END) == -1 ) {
1366 /* probably a newly rotated wtmpx file */
1372 if (atomicio(read, fd, &utx, sizeof(utx)) != sizeof(utx)) {
1373 logit("%s: read of %s failed: %s", __func__,
1374 WTMPX_FILE, strerror(errno));
1379 * Logouts are recorded as a blank username on a particular
1380 * line. So, we just need to find the username in struct utmpx
1382 if (wtmpx_islogin(li, &utx)) {
1384 # if defined(HAVE_TV_IN_UTMPX)
1385 li->tv_sec = utx.ut_tv.tv_sec;
1386 # elif defined(HAVE_TIME_IN_UTMPX)
1387 li->tv_sec = utx.ut_time;
1389 line_fullname(li->line, utx.ut_line, sizeof(li->line));
1390 # if defined(HAVE_HOST_IN_UTMPX)
1391 strlcpy(li->hostname, utx.ut_host,
1392 MIN_SIZEOF(li->hostname, utx.ut_host));
1396 if (lseek(fd, -(off_t)(2 * sizeof(struct utmpx)), SEEK_CUR) == -1) {
1405 #endif /* USE_WTMPX */
1408 ** Low-level libutil login() functions
1413 syslogin_perform_login(struct logininfo *li)
1417 ut = xmalloc(sizeof(*ut));
1418 construct_utmp(li, ut);
1426 syslogin_perform_logout(struct logininfo *li)
1429 char line[UT_LINESIZE];
1431 (void)line_stripname(line, li->line, sizeof(line));
1434 logit("%s: logout() returned an error", __func__);
1435 # ifdef HAVE_LOGWTMP
1437 logwtmp(line, "", "");
1439 /* FIXME: (ATL - if the need arises) What to do if we have
1440 * login, but no logout? what if logout but no logwtmp? All
1441 * routines are in libutil so they should all be there,
1448 syslogin_write_entry(struct logininfo *li)
1452 return (syslogin_perform_login(li));
1454 return (syslogin_perform_logout(li));
1456 logit("%s: Invalid type field", __func__);
1460 #endif /* USE_LOGIN */
1462 /* end of file log-syslogin.c */
1465 ** Low-level lastlog functions
1470 #if !defined(LASTLOG_WRITE_PUTUTXLINE) || !defined(HAVE_GETLASTLOGXBYNAME)
1471 /* open the file (using filemode) and seek to the login entry */
1473 lastlog_openseek(struct logininfo *li, int *fd, int filemode)
1476 char lastlog_file[1024];
1479 if (stat(LASTLOG_FILE, &st) != 0) {
1480 logit("%s: Couldn't stat %s: %s", __func__,
1481 LASTLOG_FILE, strerror(errno));
1484 if (S_ISDIR(st.st_mode)) {
1485 snprintf(lastlog_file, sizeof(lastlog_file), "%s/%s",
1486 LASTLOG_FILE, li->username);
1487 } else if (S_ISREG(st.st_mode)) {
1488 strlcpy(lastlog_file, LASTLOG_FILE, sizeof(lastlog_file));
1490 logit("%s: %.100s is not a file or directory!", __func__,
1495 *fd = open(lastlog_file, filemode, 0600);
1497 debug("%s: Couldn't open %s: %s", __func__,
1498 lastlog_file, strerror(errno));
1502 if (S_ISREG(st.st_mode)) {
1503 /* find this uid's offset in the lastlog file */
1504 offset = (off_t) ((long)li->uid * sizeof(struct lastlog));
1506 if (lseek(*fd, offset, SEEK_SET) != offset) {
1507 logit("%s: %s->lseek(): %s", __func__,
1508 lastlog_file, strerror(errno));
1515 #endif /* !LASTLOG_WRITE_PUTUTXLINE || !HAVE_GETLASTLOGXBYNAME */
1517 #ifdef LASTLOG_WRITE_PUTUTXLINE
1519 lastlog_write_entry(struct logininfo *li)
1523 return 1; /* lastlog written by pututxline */
1525 logit("lastlog_write_entry: Invalid type field");
1529 #else /* LASTLOG_WRITE_PUTUTXLINE */
1531 lastlog_write_entry(struct logininfo *li)
1533 struct lastlog last;
1538 /* create our struct lastlog */
1539 memset(&last, '\0', sizeof(last));
1540 line_stripname(last.ll_line, li->line, sizeof(last.ll_line));
1541 strlcpy(last.ll_host, li->hostname,
1542 MIN_SIZEOF(last.ll_host, li->hostname));
1543 last.ll_time = li->tv_sec;
1545 if (!lastlog_openseek(li, &fd, O_RDWR|O_CREAT))
1548 /* write the entry */
1549 if (atomicio(vwrite, fd, &last, sizeof(last)) != sizeof(last)) {
1551 logit("%s: Error writing to %s: %s", __func__,
1552 LASTLOG_FILE, strerror(errno));
1559 logit("%s: Invalid type field", __func__);
1563 #endif /* LASTLOG_WRITE_PUTUTXLINE */
1565 #ifdef HAVE_GETLASTLOGXBYNAME
1567 lastlog_get_entry(struct logininfo *li)
1569 struct lastlogx l, *ll;
1571 if ((ll = getlastlogxbyname(li->username, &l)) == NULL) {
1572 memset(&l, '\0', sizeof(l));
1575 line_fullname(li->line, ll->ll_line, sizeof(li->line));
1576 strlcpy(li->hostname, ll->ll_host,
1577 MIN_SIZEOF(li->hostname, ll->ll_host));
1578 li->tv_sec = ll->ll_tv.tv_sec;
1579 li->tv_usec = ll->ll_tv.tv_usec;
1582 #else /* HAVE_GETLASTLOGXBYNAME */
1584 lastlog_get_entry(struct logininfo *li)
1586 struct lastlog last;
1589 if (!lastlog_openseek(li, &fd, O_RDONLY))
1592 ret = atomicio(read, fd, &last, sizeof(last));
1597 memset(&last, '\0', sizeof(last));
1600 line_fullname(li->line, last.ll_line, sizeof(li->line));
1601 strlcpy(li->hostname, last.ll_host,
1602 MIN_SIZEOF(li->hostname, last.ll_host));
1603 li->tv_sec = last.ll_time;
1606 error("%s: Error reading from %s: %s", __func__,
1607 LASTLOG_FILE, strerror(errno));
1610 error("%s: Error reading from %s: Expecting %d, got %d",
1611 __func__, LASTLOG_FILE, (int)sizeof(last), ret);
1618 #endif /* HAVE_GETLASTLOGXBYNAME */
1619 #endif /* USE_LASTLOG */
1621 #if defined(USE_UTMPX) && defined(HAVE_SETUTXDB) && \
1622 defined(UTXDB_LASTLOGIN) && defined(HAVE_GETUTXUSER)
1624 utmpx_get_entry(struct logininfo *li)
1628 if (setutxdb(UTXDB_LASTLOGIN, NULL) != 0)
1630 utx = getutxuser(li->username);
1636 line_fullname(li->line, utx->ut_line,
1637 MIN_SIZEOF(li->line, utx->ut_line));
1638 strlcpy(li->hostname, utx->ut_host,
1639 MIN_SIZEOF(li->hostname, utx->ut_host));
1640 li->tv_sec = utx->ut_tv.tv_sec;
1641 li->tv_usec = utx->ut_tv.tv_usec;
1645 #endif /* USE_UTMPX && HAVE_SETUTXDB && UTXDB_LASTLOGIN && HAVE_GETUTXUSER */
1649 * Logs failed login attempts in _PATH_BTMP if that exists.
1650 * The most common login failure is to give password instead of username.
1651 * So the _PATH_BTMP file checked for the correct permission, so that
1652 * only root can read it.
1656 record_failed_login(const char *username, const char *hostname,
1661 struct sockaddr_storage from;
1662 socklen_t fromlen = sizeof(from);
1663 struct sockaddr_in *a4;
1664 struct sockaddr_in6 *a6;
1670 if ((fd = open(_PATH_BTMP, O_WRONLY | O_APPEND)) < 0) {
1671 debug("Unable to open the btmp file %s: %s", _PATH_BTMP,
1675 if (fstat(fd, &fst) < 0) {
1676 logit("%s: fstat of %s failed: %s", __func__, _PATH_BTMP,
1680 if((fst.st_mode & (S_IRWXG | S_IRWXO)) || (fst.st_uid != 0)){
1681 logit("Excess permission or bad ownership on file %s",
1686 memset(&ut, 0, sizeof(ut));
1687 /* strncpy because we don't necessarily want nul termination */
1688 strncpy(ut.ut_user, username, sizeof(ut.ut_user));
1689 strlcpy(ut.ut_line, "ssh:notty", sizeof(ut.ut_line));
1692 ut.ut_time = t; /* ut_time is not always a time_t */
1693 ut.ut_type = LOGIN_PROCESS;
1694 ut.ut_pid = getpid();
1696 /* strncpy because we don't necessarily want nul termination */
1697 strncpy(ut.ut_host, hostname, sizeof(ut.ut_host));
1699 if (packet_connection_is_on_socket() &&
1700 getpeername(packet_get_connection_in(),
1701 (struct sockaddr *)&from, &fromlen) == 0) {
1702 ipv64_normalise_mapped(&from, &fromlen);
1703 if (from.ss_family == AF_INET) {
1704 a4 = (struct sockaddr_in *)&from;
1705 memcpy(&ut.ut_addr, &(a4->sin_addr),
1706 MIN_SIZEOF(ut.ut_addr, a4->sin_addr));
1708 #ifdef HAVE_ADDR_V6_IN_UTMP
1709 if (from.ss_family == AF_INET6) {
1710 a6 = (struct sockaddr_in6 *)&from;
1711 memcpy(&ut.ut_addr_v6, &(a6->sin6_addr),
1712 MIN_SIZEOF(ut.ut_addr_v6, a6->sin6_addr));
1717 if (atomicio(vwrite, fd, &ut, sizeof(ut)) != sizeof(ut))
1718 error("Failed to write to %s: %s", _PATH_BTMP,
1724 #endif /* USE_BTMP */