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>
154 #include <netinet/in.h>
169 #include "hostfile.h"
171 #include "loginrec.h"
173 #include "atomicio.h"
175 #include "canohost.h"
184 ** prototypes for helper functions in this file
188 void set_utmp_time(struct logininfo
*li
, struct utmp
*ut
);
189 void construct_utmp(struct logininfo
*li
, struct utmp
*ut
);
193 void set_utmpx_time(struct logininfo
*li
, struct utmpx
*ut
);
194 void construct_utmpx(struct logininfo
*li
, struct utmpx
*ut
);
197 int utmp_write_entry(struct logininfo
*li
);
198 int utmpx_write_entry(struct logininfo
*li
);
199 int wtmp_write_entry(struct logininfo
*li
);
200 int wtmpx_write_entry(struct logininfo
*li
);
201 int lastlog_write_entry(struct logininfo
*li
);
202 int syslogin_write_entry(struct logininfo
*li
);
204 int getlast_entry(struct logininfo
*li
);
205 int lastlog_get_entry(struct logininfo
*li
);
206 int utmpx_get_entry(struct logininfo
*li
);
207 int wtmp_get_entry(struct logininfo
*li
);
208 int wtmpx_get_entry(struct logininfo
*li
);
210 extern Buffer loginmsg
;
212 /* pick the shortest string */
213 #define MIN_SIZEOF(s1,s2) (sizeof(s1) < sizeof(s2) ? sizeof(s1) : sizeof(s2))
216 ** platform-independent login functions
220 * login_login(struct logininfo *) - Record a login
222 * Call with a pointer to a struct logininfo initialised with
223 * login_init_entry() or login_alloc_entry()
227 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
230 login_login(struct logininfo
*li
)
232 li
->type
= LTYPE_LOGIN
;
233 return (login_write(li
));
238 * login_logout(struct logininfo *) - Record a logout
240 * Call as with login_login()
244 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
247 login_logout(struct logininfo
*li
)
249 li
->type
= LTYPE_LOGOUT
;
250 return (login_write(li
));
254 * login_get_lastlog_time(int) - Retrieve the last login time
256 * Retrieve the last login time for the given uid. Will try to use the
257 * system lastlog facilities if they are available, but will fall back
258 * to looking in wtmp/wtmpx if necessary
261 * 0 on failure, or if user has never logged in
262 * Time in seconds from the epoch if successful
264 * Useful preprocessor symbols:
265 * DISABLE_LASTLOG: If set, *never* even try to retrieve lastlog
267 * USE_LASTLOG: If set, indicates the presence of system lastlog
268 * facilities. If this and DISABLE_LASTLOG are not set,
269 * try to retrieve lastlog information from wtmp/wtmpx.
272 login_get_lastlog_time(const uid_t uid
)
276 if (login_get_lastlog(&li
, uid
))
283 * login_get_lastlog(struct logininfo *, int) - Retrieve a lastlog entry
285 * Retrieve a logininfo structure populated (only partially) with
286 * information from the system lastlog data, or from wtmp/wtmpx if no
287 * system lastlog information exists.
289 * Note this routine must be given a pre-allocated logininfo.
292 * >0: A pointer to your struct logininfo if successful
293 * 0 on failure (will use OpenSSH's logging facilities for diagnostics)
296 login_get_lastlog(struct logininfo
*li
, const uid_t uid
)
300 memset(li
, '\0', sizeof(*li
));
304 * If we don't have a 'real' lastlog, we need the username to
305 * reliably search wtmp(x) for the last login (see
310 fatal("%s: Cannot find account for uid %ld", __func__
,
313 if (strlcpy(li
->username
, pw
->pw_name
, sizeof(li
->username
)) >=
314 sizeof(li
->username
)) {
315 error("%s: username too long (%lu > max %lu)", __func__
,
316 (unsigned long)strlen(pw
->pw_name
),
317 (unsigned long)sizeof(li
->username
) - 1);
321 if (getlast_entry(li
))
328 * login_alloc_entry(int, char*, char*, char*) - Allocate and initialise
329 * a logininfo structure
331 * This function creates a new struct logininfo, a data structure
332 * meant to carry the information required to portably record login info.
334 * Returns a pointer to a newly created struct logininfo. If memory
335 * allocation fails, the program halts.
338 logininfo
*login_alloc_entry(pid_t pid
, const char *username
,
339 const char *hostname
, const char *line
)
341 struct logininfo
*newli
;
343 newli
= xmalloc(sizeof(*newli
));
344 login_init_entry(newli
, pid
, username
, hostname
, line
);
349 /* login_free_entry(struct logininfo *) - free struct memory */
351 login_free_entry(struct logininfo
*li
)
357 /* login_init_entry(struct logininfo *, int, char*, char*, char*)
358 * - initialise a struct logininfo
360 * Populates a new struct logininfo, a data structure meant to carry
361 * the information required to portably record login info.
366 login_init_entry(struct logininfo
*li
, pid_t pid
, const char *username
,
367 const char *hostname
, const char *line
)
371 memset(li
, 0, sizeof(*li
));
375 /* set the line information */
377 line_fullname(li
->line
, line
, sizeof(li
->line
));
380 strlcpy(li
->username
, username
, sizeof(li
->username
));
381 pw
= getpwnam(li
->username
);
383 fatal("%s: Cannot find user \"%s\"", __func__
,
386 li
->uid
= pw
->pw_uid
;
390 strlcpy(li
->hostname
, hostname
, sizeof(li
->hostname
));
396 * login_set_current_time(struct logininfo *) - set the current time
398 * Set the current time in a logininfo structure. This function is
399 * meant to eliminate the need to deal with system dependencies for
403 login_set_current_time(struct logininfo
*li
)
407 gettimeofday(&tv
, NULL
);
409 li
->tv_sec
= tv
.tv_sec
;
410 li
->tv_usec
= tv
.tv_usec
;
413 /* copy a sockaddr_* into our logininfo */
415 login_set_addr(struct logininfo
*li
, const struct sockaddr
*sa
,
416 const unsigned int sa_size
)
418 unsigned int bufsize
= sa_size
;
420 /* make sure we don't overrun our union */
421 if (sizeof(li
->hostaddr
) < sa_size
)
422 bufsize
= sizeof(li
->hostaddr
);
424 memcpy(&li
->hostaddr
.sa
, sa
, bufsize
);
429 ** login_write: Call low-level recording functions based on autoconf
433 login_write(struct logininfo
*li
)
436 if (geteuid() != 0) {
437 logit("Attempt to write login records by non-root user (aborting)");
442 /* set the timestamp */
443 login_set_current_time(li
);
445 syslogin_write_entry(li
);
448 if (li
->type
== LTYPE_LOGIN
)
449 lastlog_write_entry(li
);
452 utmp_write_entry(li
);
455 wtmp_write_entry(li
);
458 utmpx_write_entry(li
);
461 wtmpx_write_entry(li
);
463 #ifdef CUSTOM_SYS_AUTH_RECORD_LOGIN
464 if (li
->type
== LTYPE_LOGIN
&&
465 !sys_auth_record_login(li
->username
,li
->hostname
,li
->line
,
467 logit("Writing login record failed for %s", li
->username
);
469 #ifdef SSH_AUDIT_EVENTS
470 if (li
->type
== LTYPE_LOGIN
)
471 audit_session_open(li
);
472 else if (li
->type
== LTYPE_LOGOUT
)
473 audit_session_close(li
);
478 #ifdef LOGIN_NEEDS_UTMPX
480 login_utmp_only(struct logininfo
*li
)
482 li
->type
= LTYPE_LOGIN
;
483 login_set_current_time(li
);
485 utmp_write_entry(li
);
488 wtmp_write_entry(li
);
491 utmpx_write_entry(li
);
494 wtmpx_write_entry(li
);
501 ** getlast_entry: Call low-level functions to retrieve the last login
505 /* take the uid in li and return the last login time */
507 getlast_entry(struct logininfo
*li
)
510 return(lastlog_get_entry(li
));
511 #else /* !USE_LASTLOG */
512 #if defined(USE_UTMPX) && defined(HAVE_SETUTXDB) && \
513 defined(UTXDB_LASTLOGIN) && defined(HAVE_GETUTXUSER)
514 return (utmpx_get_entry(li
));
517 #if defined(DISABLE_LASTLOG)
518 /* On some systems we shouldn't even try to obtain last login
521 # elif defined(USE_WTMP) && \
522 (defined(HAVE_TIME_IN_UTMP) || defined(HAVE_TV_IN_UTMP))
523 /* retrieve last login time from utmp */
524 return (wtmp_get_entry(li
));
525 # elif defined(USE_WTMPX) && \
526 (defined(HAVE_TIME_IN_UTMPX) || defined(HAVE_TV_IN_UTMPX))
527 /* If wtmp isn't available, try wtmpx */
528 return (wtmpx_get_entry(li
));
530 /* Give up: No means of retrieving last login time */
532 # endif /* DISABLE_LASTLOG */
533 #endif /* USE_LASTLOG */
539 * 'line' string utility functions
541 * These functions process the 'line' string into one of three forms:
543 * 1. The full filename (including '/dev')
544 * 2. The stripped name (excluding '/dev')
545 * 3. The abbreviated name (e.g. /dev/ttyp00 -> yp00
546 * /dev/pts/1 -> ts/1 )
548 * Form 3 is used on some systems to identify a .tmp.? entry when
549 * attempting to remove it. Typically both addition and removal is
550 * performed by one application - say, sshd - so as long as the choice
551 * uniquely identifies a terminal it's ok.
556 * line_fullname(): add the leading '/dev/' if it doesn't exist make
557 * sure dst has enough space, if not just copy src (ugh)
560 line_fullname(char *dst
, const char *src
, u_int dstsize
)
562 memset(dst
, '\0', dstsize
);
563 if ((strncmp(src
, "/dev/", 5) == 0) || (dstsize
< (strlen(src
) + 5)))
564 strlcpy(dst
, src
, dstsize
);
566 strlcpy(dst
, "/dev/", dstsize
);
567 strlcat(dst
, src
, dstsize
);
572 /* line_stripname(): strip the leading '/dev' if it exists, return dst */
574 line_stripname(char *dst
, const char *src
, int dstsize
)
576 memset(dst
, '\0', dstsize
);
577 if (strncmp(src
, "/dev/", 5) == 0)
578 strlcpy(dst
, src
+ 5, dstsize
);
580 strlcpy(dst
, src
, dstsize
);
585 * line_abbrevname(): Return the abbreviated (usually four-character)
586 * form of the line (Just use the last <dstsize> characters of the
589 * NOTE: use strncpy because we do NOT necessarily want zero
593 line_abbrevname(char *dst
, const char *src
, int dstsize
)
597 memset(dst
, '\0', dstsize
);
599 /* Always skip prefix if present */
600 if (strncmp(src
, "/dev/", 5) == 0)
603 #ifdef WITH_ABBREV_NO_TTY
604 if (strncmp(src
, "tty", 3) == 0)
611 if (((int)len
- dstsize
) > 0)
612 src
+= ((int)len
- dstsize
);
614 /* note: _don't_ change this to strlcpy */
615 strncpy(dst
, src
, (size_t)dstsize
);
622 ** utmp utility functions
624 ** These functions manipulate struct utmp, taking system differences
628 #if defined(USE_UTMP) || defined (USE_WTMP) || defined (USE_LOGIN)
630 /* build the utmp structure */
632 set_utmp_time(struct logininfo
*li
, struct utmp
*ut
)
634 # if defined(HAVE_TV_IN_UTMP)
635 ut
->ut_tv
.tv_sec
= li
->tv_sec
;
636 ut
->ut_tv
.tv_usec
= li
->tv_usec
;
637 # elif defined(HAVE_TIME_IN_UTMP)
638 ut
->ut_time
= li
->tv_sec
;
643 construct_utmp(struct logininfo
*li
,
646 # ifdef HAVE_ADDR_V6_IN_UTMP
647 struct sockaddr_in6
*sa6
;
650 memset(ut
, '\0', sizeof(*ut
));
652 /* First fill out fields used for both logins and logouts */
654 # ifdef HAVE_ID_IN_UTMP
655 line_abbrevname(ut
->ut_id
, li
->line
, sizeof(ut
->ut_id
));
658 # ifdef HAVE_TYPE_IN_UTMP
659 /* This is done here to keep utmp constants out of struct logininfo */
662 ut
->ut_type
= USER_PROCESS
;
668 ut
->ut_type
= DEAD_PROCESS
;
670 cray_retain_utmp(ut
, li
->pid
);
675 set_utmp_time(li
, ut
);
677 line_stripname(ut
->ut_line
, li
->line
, sizeof(ut
->ut_line
));
679 # ifdef HAVE_PID_IN_UTMP
680 ut
->ut_pid
= li
->pid
;
683 /* If we're logging out, leave all other fields blank */
684 if (li
->type
== LTYPE_LOGOUT
)
688 * These fields are only used when logging in, and are blank
692 /* Use strncpy because we don't necessarily want null termination */
693 strncpy(ut
->ut_name
, li
->username
,
694 MIN_SIZEOF(ut
->ut_name
, li
->username
));
695 # ifdef HAVE_HOST_IN_UTMP
696 realhostname_sa(ut
->ut_host
, sizeof ut
->ut_host
,
697 &li
->hostaddr
.sa
, li
->hostaddr
.sa
.sa_len
);
699 # ifdef HAVE_ADDR_IN_UTMP
700 /* this is just a 32-bit IP address */
701 if (li
->hostaddr
.sa
.sa_family
== AF_INET
)
702 ut
->ut_addr
= li
->hostaddr
.sa_in
.sin_addr
.s_addr
;
704 # ifdef HAVE_ADDR_V6_IN_UTMP
705 /* this is just a 128-bit IPv6 address */
706 if (li
->hostaddr
.sa
.sa_family
== AF_INET6
) {
707 sa6
= ((struct sockaddr_in6
*)&li
->hostaddr
.sa
);
708 memcpy(ut
->ut_addr_v6
, sa6
->sin6_addr
.s6_addr
, 16);
709 if (IN6_IS_ADDR_V4MAPPED(&sa6
->sin6_addr
)) {
710 ut
->ut_addr_v6
[0] = ut
->ut_addr_v6
[3];
711 ut
->ut_addr_v6
[1] = 0;
712 ut
->ut_addr_v6
[2] = 0;
713 ut
->ut_addr_v6
[3] = 0;
718 #endif /* USE_UTMP || USE_WTMP || USE_LOGIN */
721 ** utmpx utility functions
723 ** These functions manipulate struct utmpx, accounting for system
727 #if defined(USE_UTMPX) || defined (USE_WTMPX)
728 /* build the utmpx structure */
730 set_utmpx_time(struct logininfo
*li
, struct utmpx
*utx
)
732 # if defined(HAVE_TV_IN_UTMPX)
733 utx
->ut_tv
.tv_sec
= li
->tv_sec
;
734 utx
->ut_tv
.tv_usec
= li
->tv_usec
;
735 # elif defined(HAVE_TIME_IN_UTMPX)
736 utx
->ut_time
= li
->tv_sec
;
741 construct_utmpx(struct logininfo
*li
, struct utmpx
*utx
)
743 # ifdef HAVE_ADDR_V6_IN_UTMP
744 struct sockaddr_in6
*sa6
;
746 memset(utx
, '\0', sizeof(*utx
));
748 # ifdef HAVE_ID_IN_UTMPX
749 line_abbrevname(utx
->ut_id
, li
->line
, sizeof(utx
->ut_id
));
752 /* this is done here to keep utmp constants out of loginrec.h */
755 utx
->ut_type
= USER_PROCESS
;
758 utx
->ut_type
= DEAD_PROCESS
;
761 line_stripname(utx
->ut_line
, li
->line
, sizeof(utx
->ut_line
));
762 set_utmpx_time(li
, utx
);
763 utx
->ut_pid
= li
->pid
;
765 /* strncpy(): Don't necessarily want null termination */
766 strncpy(utx
->ut_user
, li
->username
,
767 MIN_SIZEOF(utx
->ut_user
, li
->username
));
769 if (li
->type
== LTYPE_LOGOUT
)
773 * These fields are only used when logging in, and are blank
777 # ifdef HAVE_HOST_IN_UTMPX
778 strncpy(utx
->ut_host
, li
->hostname
,
779 MIN_SIZEOF(utx
->ut_host
, li
->hostname
));
781 # ifdef HAVE_ADDR_IN_UTMPX
782 /* this is just a 32-bit IP address */
783 if (li
->hostaddr
.sa
.sa_family
== AF_INET
)
784 utx
->ut_addr
= li
->hostaddr
.sa_in
.sin_addr
.s_addr
;
786 # ifdef HAVE_ADDR_V6_IN_UTMP
787 /* this is just a 128-bit IPv6 address */
788 if (li
->hostaddr
.sa
.sa_family
== AF_INET6
) {
789 sa6
= ((struct sockaddr_in6
*)&li
->hostaddr
.sa
);
790 memcpy(ut
->ut_addr_v6
, sa6
->sin6_addr
.s6_addr
, 16);
791 if (IN6_IS_ADDR_V4MAPPED(&sa6
->sin6_addr
)) {
792 ut
->ut_addr_v6
[0] = ut
->ut_addr_v6
[3];
793 ut
->ut_addr_v6
[1] = 0;
794 ut
->ut_addr_v6
[2] = 0;
795 ut
->ut_addr_v6
[3] = 0;
799 # ifdef HAVE_SYSLEN_IN_UTMPX
800 /* ut_syslen is the length of the utx_host string */
801 utx
->ut_syslen
= MIN(strlen(li
->hostname
), sizeof(utx
->ut_host
));
804 #endif /* USE_UTMPX || USE_WTMPX */
807 ** Low-level utmp functions
810 /* FIXME: (ATL) utmp_write_direct needs testing */
813 /* if we can, use pututline() etc. */
814 # if !defined(DISABLE_PUTUTLINE) && defined(HAVE_SETUTENT) && \
815 defined(HAVE_PUTUTLINE)
816 # define UTMP_USE_LIBRARY
820 /* write a utmp entry with the system's help (pututline() and pals) */
821 # ifdef UTMP_USE_LIBRARY
823 utmp_write_library(struct logininfo
*li
, struct utmp
*ut
)
827 # ifdef HAVE_ENDUTENT
832 # else /* UTMP_USE_LIBRARY */
835 * Write a utmp entry direct to the file
836 * This is a slightly modification of code in OpenBSD's login.c
839 utmp_write_direct(struct logininfo
*li
, struct utmp
*ut
)
845 /* FIXME: (ATL) ttyslot() needs local implementation */
847 #if defined(HAVE_GETTTYENT)
852 while (NULL
!= (ty
= getttyent())) {
854 if (!strncmp(ty
->ty_name
, ut
->ut_line
, sizeof(ut
->ut_line
)))
860 logit("%s: tty not found", __func__
);
865 tty
= ttyslot(); /* seems only to work for /dev/ttyp? style names */
867 #endif /* HAVE_GETTTYENT */
869 if (tty
> 0 && (fd
= open(UTMP_FILE
, O_RDWR
|O_CREAT
, 0644)) >= 0) {
872 pos
= (off_t
)tty
* sizeof(struct utmp
);
873 if ((ret
= lseek(fd
, pos
, SEEK_SET
)) == -1) {
874 logit("%s: lseek: %s", __func__
, strerror(errno
));
879 logit("%s: Couldn't seek to tty %d slot in %s",
880 __func__
, tty
, UTMP_FILE
);
885 * Prevent luser from zero'ing out ut_host.
886 * If the new ut_line is empty but the old one is not
887 * and ut_line and ut_name match, preserve the old ut_line.
889 if (atomicio(read
, fd
, &old_ut
, sizeof(old_ut
)) == sizeof(old_ut
) &&
890 (ut
->ut_host
[0] == '\0') && (old_ut
.ut_host
[0] != '\0') &&
891 (strncmp(old_ut
.ut_line
, ut
->ut_line
, sizeof(ut
->ut_line
)) == 0) &&
892 (strncmp(old_ut
.ut_name
, ut
->ut_name
, sizeof(ut
->ut_name
)) == 0))
893 memcpy(ut
->ut_host
, old_ut
.ut_host
, sizeof(ut
->ut_host
));
895 if ((ret
= lseek(fd
, pos
, SEEK_SET
)) == -1) {
896 logit("%s: lseek: %s", __func__
, strerror(errno
));
901 logit("%s: Couldn't seek to tty %d slot in %s",
902 __func__
, tty
, UTMP_FILE
);
906 if (atomicio(vwrite
, fd
, ut
, sizeof(*ut
)) != sizeof(*ut
)) {
907 logit("%s: error writing %s: %s", __func__
,
908 UTMP_FILE
, strerror(errno
));
919 # endif /* UTMP_USE_LIBRARY */
922 utmp_perform_login(struct logininfo
*li
)
926 construct_utmp(li
, &ut
);
927 # ifdef UTMP_USE_LIBRARY
928 if (!utmp_write_library(li
, &ut
)) {
929 logit("%s: utmp_write_library() failed", __func__
);
933 if (!utmp_write_direct(li
, &ut
)) {
934 logit("%s: utmp_write_direct() failed", __func__
);
943 utmp_perform_logout(struct logininfo
*li
)
947 construct_utmp(li
, &ut
);
948 # ifdef UTMP_USE_LIBRARY
949 if (!utmp_write_library(li
, &ut
)) {
950 logit("%s: utmp_write_library() failed", __func__
);
954 if (!utmp_write_direct(li
, &ut
)) {
955 logit("%s: utmp_write_direct() failed", __func__
);
964 utmp_write_entry(struct logininfo
*li
)
968 return (utmp_perform_login(li
));
971 return (utmp_perform_logout(li
));
974 logit("%s: invalid type field", __func__
);
978 #endif /* USE_UTMP */
982 ** Low-level utmpx functions
985 /* not much point if we don't want utmpx entries */
988 /* if we have the wherewithall, use pututxline etc. */
989 # if !defined(DISABLE_PUTUTXLINE) && defined(HAVE_SETUTXENT) && \
990 defined(HAVE_PUTUTXLINE)
991 # define UTMPX_USE_LIBRARY
995 /* write a utmpx entry with the system's help (pututxline() and pals) */
996 # ifdef UTMPX_USE_LIBRARY
998 utmpx_write_library(struct logininfo
*li
, struct utmpx
*utx
)
1003 # ifdef HAVE_ENDUTXENT
1009 # else /* UTMPX_USE_LIBRARY */
1011 /* write a utmp entry direct to the file */
1013 utmpx_write_direct(struct logininfo
*li
, struct utmpx
*utx
)
1015 logit("%s: not implemented!", __func__
);
1018 # endif /* UTMPX_USE_LIBRARY */
1021 utmpx_perform_login(struct logininfo
*li
)
1025 construct_utmpx(li
, &utx
);
1026 # ifdef UTMPX_USE_LIBRARY
1027 if (!utmpx_write_library(li
, &utx
)) {
1028 logit("%s: utmp_write_library() failed", __func__
);
1032 if (!utmpx_write_direct(li
, &ut
)) {
1033 logit("%s: utmp_write_direct() failed", __func__
);
1042 utmpx_perform_logout(struct logininfo
*li
)
1046 construct_utmpx(li
, &utx
);
1047 # ifdef HAVE_ID_IN_UTMPX
1048 line_abbrevname(utx
.ut_id
, li
->line
, sizeof(utx
.ut_id
));
1050 # ifdef HAVE_TYPE_IN_UTMPX
1051 utx
.ut_type
= DEAD_PROCESS
;
1054 # ifdef UTMPX_USE_LIBRARY
1055 utmpx_write_library(li
, &utx
);
1057 utmpx_write_direct(li
, &utx
);
1063 utmpx_write_entry(struct logininfo
*li
)
1067 return (utmpx_perform_login(li
));
1069 return (utmpx_perform_logout(li
));
1071 logit("%s: invalid type field", __func__
);
1075 #endif /* USE_UTMPX */
1079 ** Low-level wtmp functions
1085 * Write a wtmp entry direct to the end of the file
1086 * This is a slight modification of code in OpenBSD's logwtmp.c
1089 wtmp_write(struct logininfo
*li
, struct utmp
*ut
)
1094 if ((fd
= open(WTMP_FILE
, O_WRONLY
|O_APPEND
, 0)) < 0) {
1095 logit("%s: problem writing %s: %s", __func__
,
1096 WTMP_FILE
, strerror(errno
));
1099 if (fstat(fd
, &buf
) == 0)
1100 if (atomicio(vwrite
, fd
, ut
, sizeof(*ut
)) != sizeof(*ut
)) {
1101 ftruncate(fd
, buf
.st_size
);
1102 logit("%s: problem writing %s: %s", __func__
,
1103 WTMP_FILE
, strerror(errno
));
1111 wtmp_perform_login(struct logininfo
*li
)
1115 construct_utmp(li
, &ut
);
1116 return (wtmp_write(li
, &ut
));
1121 wtmp_perform_logout(struct logininfo
*li
)
1125 construct_utmp(li
, &ut
);
1126 return (wtmp_write(li
, &ut
));
1131 wtmp_write_entry(struct logininfo
*li
)
1135 return (wtmp_perform_login(li
));
1137 return (wtmp_perform_logout(li
));
1139 logit("%s: invalid type field", __func__
);
1146 * Notes on fetching login data from wtmp/wtmpx
1148 * Logouts are usually recorded with (amongst other things) a blank
1149 * username on a given tty line. However, some systems (HP-UX is one)
1150 * leave all fields set, but change the ut_type field to DEAD_PROCESS.
1152 * Since we're only looking for logins here, we know that the username
1153 * must be set correctly. On systems that leave it in, we check for
1154 * ut_type==USER_PROCESS (indicating a login.)
1156 * Portability: Some systems may set something other than USER_PROCESS
1157 * to indicate a login process. I don't know of any as I write. Also,
1158 * it's possible that some systems may both leave the username in
1159 * place and not have ut_type.
1162 /* return true if this wtmp entry indicates a login */
1164 wtmp_islogin(struct logininfo
*li
, struct utmp
*ut
)
1166 if (strncmp(li
->username
, ut
->ut_name
,
1167 MIN_SIZEOF(li
->username
, ut
->ut_name
)) == 0) {
1168 # ifdef HAVE_TYPE_IN_UTMP
1169 if (ut
->ut_type
& USER_PROCESS
)
1179 wtmp_get_entry(struct logininfo
*li
)
1185 /* Clear the time entries in our logininfo */
1186 li
->tv_sec
= li
->tv_usec
= 0;
1188 if ((fd
= open(WTMP_FILE
, O_RDONLY
)) < 0) {
1189 logit("%s: problem opening %s: %s", __func__
,
1190 WTMP_FILE
, strerror(errno
));
1193 if (fstat(fd
, &st
) != 0) {
1194 logit("%s: couldn't stat %s: %s", __func__
,
1195 WTMP_FILE
, strerror(errno
));
1200 /* Seek to the start of the last struct utmp */
1201 if (lseek(fd
, -(off_t
)sizeof(struct utmp
), SEEK_END
) == -1) {
1202 /* Looks like we've got a fresh wtmp file */
1208 if (atomicio(read
, fd
, &ut
, sizeof(ut
)) != sizeof(ut
)) {
1209 logit("%s: read of %s failed: %s", __func__
,
1210 WTMP_FILE
, strerror(errno
));
1214 if (wtmp_islogin(li
, &ut
) ) {
1217 * We've already checked for a time in struct
1218 * utmp, in login_getlast()
1220 # ifdef HAVE_TIME_IN_UTMP
1221 li
->tv_sec
= ut
.ut_time
;
1223 # if HAVE_TV_IN_UTMP
1224 li
->tv_sec
= ut
.ut_tv
.tv_sec
;
1227 line_fullname(li
->line
, ut
.ut_line
,
1228 MIN_SIZEOF(li
->line
, ut
.ut_line
));
1229 # ifdef HAVE_HOST_IN_UTMP
1230 strlcpy(li
->hostname
, ut
.ut_host
,
1231 MIN_SIZEOF(li
->hostname
, ut
.ut_host
));
1235 /* Seek back 2 x struct utmp */
1236 if (lseek(fd
, -(off_t
)(2 * sizeof(struct utmp
)), SEEK_CUR
) == -1) {
1237 /* We've found the start of the file, so quit */
1243 /* We found an entry. Tidy up and return */
1247 # endif /* USE_WTMP */
1251 ** Low-level wtmpx functions
1256 * Write a wtmpx entry direct to the end of the file
1257 * This is a slight modification of code in OpenBSD's logwtmp.c
1260 wtmpx_write(struct logininfo
*li
, struct utmpx
*utx
)
1262 #ifndef HAVE_UPDWTMPX
1266 if ((fd
= open(WTMPX_FILE
, O_WRONLY
|O_APPEND
, 0)) < 0) {
1267 logit("%s: problem opening %s: %s", __func__
,
1268 WTMPX_FILE
, strerror(errno
));
1272 if (fstat(fd
, &buf
) == 0)
1273 if (atomicio(vwrite
, fd
, utx
, sizeof(*utx
)) != sizeof(*utx
)) {
1274 ftruncate(fd
, buf
.st_size
);
1275 logit("%s: problem writing %s: %s", __func__
,
1276 WTMPX_FILE
, strerror(errno
));
1283 updwtmpx(WTMPX_FILE
, utx
);
1290 wtmpx_perform_login(struct logininfo
*li
)
1294 construct_utmpx(li
, &utx
);
1295 return (wtmpx_write(li
, &utx
));
1300 wtmpx_perform_logout(struct logininfo
*li
)
1304 construct_utmpx(li
, &utx
);
1305 return (wtmpx_write(li
, &utx
));
1310 wtmpx_write_entry(struct logininfo
*li
)
1314 return (wtmpx_perform_login(li
));
1316 return (wtmpx_perform_logout(li
));
1318 logit("%s: invalid type field", __func__
);
1323 /* Please see the notes above wtmp_islogin() for information about the
1324 next two functions */
1326 /* Return true if this wtmpx entry indicates a login */
1328 wtmpx_islogin(struct logininfo
*li
, struct utmpx
*utx
)
1330 if (strncmp(li
->username
, utx
->ut_user
,
1331 MIN_SIZEOF(li
->username
, utx
->ut_user
)) == 0 ) {
1332 # ifdef HAVE_TYPE_IN_UTMPX
1333 if (utx
->ut_type
== USER_PROCESS
)
1344 wtmpx_get_entry(struct logininfo
*li
)
1350 /* Clear the time entries */
1351 li
->tv_sec
= li
->tv_usec
= 0;
1353 if ((fd
= open(WTMPX_FILE
, O_RDONLY
)) < 0) {
1354 logit("%s: problem opening %s: %s", __func__
,
1355 WTMPX_FILE
, strerror(errno
));
1358 if (fstat(fd
, &st
) != 0) {
1359 logit("%s: couldn't stat %s: %s", __func__
,
1360 WTMPX_FILE
, strerror(errno
));
1365 /* Seek to the start of the last struct utmpx */
1366 if (lseek(fd
, -(off_t
)sizeof(struct utmpx
), SEEK_END
) == -1 ) {
1367 /* probably a newly rotated wtmpx file */
1373 if (atomicio(read
, fd
, &utx
, sizeof(utx
)) != sizeof(utx
)) {
1374 logit("%s: read of %s failed: %s", __func__
,
1375 WTMPX_FILE
, strerror(errno
));
1380 * Logouts are recorded as a blank username on a particular
1381 * line. So, we just need to find the username in struct utmpx
1383 if (wtmpx_islogin(li
, &utx
)) {
1385 # if defined(HAVE_TV_IN_UTMPX)
1386 li
->tv_sec
= utx
.ut_tv
.tv_sec
;
1387 # elif defined(HAVE_TIME_IN_UTMPX)
1388 li
->tv_sec
= utx
.ut_time
;
1390 line_fullname(li
->line
, utx
.ut_line
, sizeof(li
->line
));
1391 # if defined(HAVE_HOST_IN_UTMPX)
1392 strlcpy(li
->hostname
, utx
.ut_host
,
1393 MIN_SIZEOF(li
->hostname
, utx
.ut_host
));
1397 if (lseek(fd
, -(off_t
)(2 * sizeof(struct utmpx
)), SEEK_CUR
) == -1) {
1406 #endif /* USE_WTMPX */
1409 ** Low-level libutil login() functions
1414 syslogin_perform_login(struct logininfo
*li
)
1418 ut
= xmalloc(sizeof(*ut
));
1419 construct_utmp(li
, ut
);
1427 syslogin_perform_logout(struct logininfo
*li
)
1430 char line
[UT_LINESIZE
];
1432 (void)line_stripname(line
, li
->line
, sizeof(line
));
1435 logit("%s: logout() returned an error", __func__
);
1436 # ifdef HAVE_LOGWTMP
1438 logwtmp(line
, "", "");
1440 /* FIXME: (ATL - if the need arises) What to do if we have
1441 * login, but no logout? what if logout but no logwtmp? All
1442 * routines are in libutil so they should all be there,
1449 syslogin_write_entry(struct logininfo
*li
)
1453 return (syslogin_perform_login(li
));
1455 return (syslogin_perform_logout(li
));
1457 logit("%s: Invalid type field", __func__
);
1461 #endif /* USE_LOGIN */
1463 /* end of file log-syslogin.c */
1466 ** Low-level lastlog functions
1471 #if !defined(LASTLOG_WRITE_PUTUTXLINE) || !defined(HAVE_GETLASTLOGXBYNAME)
1472 /* open the file (using filemode) and seek to the login entry */
1474 lastlog_openseek(struct logininfo
*li
, int *fd
, int filemode
)
1477 char lastlog_file
[1024];
1480 if (stat(LASTLOG_FILE
, &st
) != 0) {
1481 logit("%s: Couldn't stat %s: %s", __func__
,
1482 LASTLOG_FILE
, strerror(errno
));
1485 if (S_ISDIR(st
.st_mode
)) {
1486 snprintf(lastlog_file
, sizeof(lastlog_file
), "%s/%s",
1487 LASTLOG_FILE
, li
->username
);
1488 } else if (S_ISREG(st
.st_mode
)) {
1489 strlcpy(lastlog_file
, LASTLOG_FILE
, sizeof(lastlog_file
));
1491 logit("%s: %.100s is not a file or directory!", __func__
,
1496 *fd
= open(lastlog_file
, filemode
, 0600);
1498 debug("%s: Couldn't open %s: %s", __func__
,
1499 lastlog_file
, strerror(errno
));
1503 if (S_ISREG(st
.st_mode
)) {
1504 /* find this uid's offset in the lastlog file */
1505 offset
= (off_t
) ((u_long
)li
->uid
* sizeof(struct lastlog
));
1507 if (lseek(*fd
, offset
, SEEK_SET
) != offset
) {
1508 logit("%s: %s->lseek(): %s", __func__
,
1509 lastlog_file
, strerror(errno
));
1517 #endif /* !LASTLOG_WRITE_PUTUTXLINE || !HAVE_GETLASTLOGXBYNAME */
1519 #ifdef LASTLOG_WRITE_PUTUTXLINE
1521 lastlog_write_entry(struct logininfo
*li
)
1525 return 1; /* lastlog written by pututxline */
1527 logit("lastlog_write_entry: Invalid type field");
1531 #else /* LASTLOG_WRITE_PUTUTXLINE */
1533 lastlog_write_entry(struct logininfo
*li
)
1535 struct lastlog last
;
1540 /* create our struct lastlog */
1541 memset(&last
, '\0', sizeof(last
));
1542 line_stripname(last
.ll_line
, li
->line
, sizeof(last
.ll_line
));
1543 strlcpy(last
.ll_host
, li
->hostname
,
1544 MIN_SIZEOF(last
.ll_host
, li
->hostname
));
1545 last
.ll_time
= li
->tv_sec
;
1547 if (!lastlog_openseek(li
, &fd
, O_RDWR
|O_CREAT
))
1550 /* write the entry */
1551 if (atomicio(vwrite
, fd
, &last
, sizeof(last
)) != sizeof(last
)) {
1553 logit("%s: Error writing to %s: %s", __func__
,
1554 LASTLOG_FILE
, strerror(errno
));
1561 logit("%s: Invalid type field", __func__
);
1565 #endif /* LASTLOG_WRITE_PUTUTXLINE */
1567 #ifdef HAVE_GETLASTLOGXBYNAME
1569 lastlog_get_entry(struct logininfo
*li
)
1571 struct lastlogx l
, *ll
;
1573 if ((ll
= getlastlogxbyname(li
->username
, &l
)) == NULL
) {
1574 memset(&l
, '\0', sizeof(l
));
1577 line_fullname(li
->line
, ll
->ll_line
, sizeof(li
->line
));
1578 strlcpy(li
->hostname
, ll
->ll_host
,
1579 MIN_SIZEOF(li
->hostname
, ll
->ll_host
));
1580 li
->tv_sec
= ll
->ll_tv
.tv_sec
;
1581 li
->tv_usec
= ll
->ll_tv
.tv_usec
;
1584 #else /* HAVE_GETLASTLOGXBYNAME */
1586 lastlog_get_entry(struct logininfo
*li
)
1588 struct lastlog last
;
1591 if (!lastlog_openseek(li
, &fd
, O_RDONLY
))
1594 ret
= atomicio(read
, fd
, &last
, sizeof(last
));
1599 memset(&last
, '\0', sizeof(last
));
1602 line_fullname(li
->line
, last
.ll_line
, sizeof(li
->line
));
1603 strlcpy(li
->hostname
, last
.ll_host
,
1604 MIN_SIZEOF(li
->hostname
, last
.ll_host
));
1605 li
->tv_sec
= last
.ll_time
;
1608 error("%s: Error reading from %s: %s", __func__
,
1609 LASTLOG_FILE
, strerror(errno
));
1612 error("%s: Error reading from %s: Expecting %d, got %d",
1613 __func__
, LASTLOG_FILE
, (int)sizeof(last
), ret
);
1620 #endif /* HAVE_GETLASTLOGXBYNAME */
1621 #endif /* USE_LASTLOG */
1623 #if defined(USE_UTMPX) && defined(HAVE_SETUTXDB) && \
1624 defined(UTXDB_LASTLOGIN) && defined(HAVE_GETUTXUSER)
1626 utmpx_get_entry(struct logininfo
*li
)
1630 if (setutxdb(UTXDB_LASTLOGIN
, NULL
) != 0)
1632 utx
= getutxuser(li
->username
);
1638 line_fullname(li
->line
, utx
->ut_line
,
1639 MIN_SIZEOF(li
->line
, utx
->ut_line
));
1640 strlcpy(li
->hostname
, utx
->ut_host
,
1641 MIN_SIZEOF(li
->hostname
, utx
->ut_host
));
1642 li
->tv_sec
= utx
->ut_tv
.tv_sec
;
1643 li
->tv_usec
= utx
->ut_tv
.tv_usec
;
1647 #endif /* USE_UTMPX && HAVE_SETUTXDB && UTXDB_LASTLOGIN && HAVE_GETUTXUSER */
1651 * Logs failed login attempts in _PATH_BTMP if that exists.
1652 * The most common login failure is to give password instead of username.
1653 * So the _PATH_BTMP file checked for the correct permission, so that
1654 * only root can read it.
1658 record_failed_login(const char *username
, const char *hostname
,
1663 struct sockaddr_storage from
;
1664 socklen_t fromlen
= sizeof(from
);
1665 struct sockaddr_in
*a4
;
1666 struct sockaddr_in6
*a6
;
1672 if ((fd
= open(_PATH_BTMP
, O_WRONLY
| O_APPEND
)) < 0) {
1673 debug("Unable to open the btmp file %s: %s", _PATH_BTMP
,
1677 if (fstat(fd
, &fst
) < 0) {
1678 logit("%s: fstat of %s failed: %s", __func__
, _PATH_BTMP
,
1682 if((fst
.st_mode
& (S_IXGRP
| S_IRWXO
)) || (fst
.st_uid
!= 0)){
1683 logit("Excess permission or bad ownership on file %s",
1688 memset(&ut
, 0, sizeof(ut
));
1689 /* strncpy because we don't necessarily want nul termination */
1690 strncpy(ut
.ut_user
, username
, sizeof(ut
.ut_user
));
1691 strlcpy(ut
.ut_line
, "ssh:notty", sizeof(ut
.ut_line
));
1694 ut
.ut_time
= t
; /* ut_time is not always a time_t */
1695 ut
.ut_type
= LOGIN_PROCESS
;
1696 ut
.ut_pid
= getpid();
1698 /* strncpy because we don't necessarily want nul termination */
1699 strncpy(ut
.ut_host
, hostname
, sizeof(ut
.ut_host
));
1701 if (packet_connection_is_on_socket() &&
1702 getpeername(packet_get_connection_in(),
1703 (struct sockaddr
*)&from
, &fromlen
) == 0) {
1704 ipv64_normalise_mapped(&from
, &fromlen
);
1705 if (from
.ss_family
== AF_INET
) {
1706 a4
= (struct sockaddr_in
*)&from
;
1707 memcpy(&ut
.ut_addr
, &(a4
->sin_addr
),
1708 MIN_SIZEOF(ut
.ut_addr
, a4
->sin_addr
));
1710 #ifdef HAVE_ADDR_V6_IN_UTMP
1711 if (from
.ss_family
== AF_INET6
) {
1712 a6
= (struct sockaddr_in6
*)&from
;
1713 memcpy(&ut
.ut_addr_v6
, &(a6
->sin6_addr
),
1714 MIN_SIZEOF(ut
.ut_addr_v6
, a6
->sin6_addr
));
1719 if (atomicio(vwrite
, fd
, &ut
, sizeof(ut
)) != sizeof(ut
))
1720 error("Failed to write to %s: %s", _PATH_BTMP
,
1726 #endif /* USE_BTMP */