2 Unix SMB/CIFS implementation.
4 Copyright (C) T.D.Lee@durham.ac.uk 1999
5 Heavily modified by Andrew Bartlett and Tridge, April 2001
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /****************************************************************************
24 Reflect connection status in utmp/wtmp files.
25 T.D.Lee@durham.ac.uk September 1999
27 With grateful thanks since then to many who have helped port it to
28 different operating systems. The variety of OS quirks thereby
29 uncovered is amazing...
32 o Always attempt to use programmatic interface (pututline() etc.)
33 Indeed, at present only programmatic use is supported.
34 o The only currently supported programmatic interface to "wtmp{,x}"
35 is through "updwtmp*()" routines.
36 o The "x" (utmpx/wtmpx; HAVE_UTMPX_H) seems preferable.
37 o The HAVE_* items should identify supported features.
38 o If at all possible, avoid "if defined(MY-OS)" constructions.
40 OS observations and status:
41 Almost every OS seems to have its own quirks.
44 Tested on 2.6 and 2.7; should be OK on other flavours.
46 Apparently has utmpx.h but doesn't implement.
48 Has utmpx.h, but (e.g.) no "getutmpx()". (Is this like AIX ?)
50 utmpx.h seems not to set default filenames. non-x better.
52 Not tested. Appears to have "x".
54 Not tested. Appears to lack "x".
57 "updwtmp*()" routines seem absent, so no current wtmp* support.
58 Has "ut_addr": probably trivial to implement (although remember
59 that IPv6 is coming...).
62 No "putut*()" type of interface.
63 No "ut_type" and associated defines.
64 Write files directly. Alternatively use its login(3)/logout(3).
66 Not tested. Resembles FreeBSD, but no login()/logout().
69 Should "lastlog" files, if any, be updated?
70 BSD systems (SunOS 4, FreeBSD):
71 o Prominent mention on man pages.
72 System-V (e.g. Solaris 2):
73 o No mention on man pages, even under "man -k".
74 o Has a "/var/adm/lastlog" file, but pututxline() etc. seem
76 o Despite downplaying (above), nevertheless has <lastlog.h>.
77 So perhaps UN*X "lastlog" facility is intended for tty/terminal only?
80 Each connection requires a small number (starting at 0, working up)
81 to represent the line. This must be unique within and across all
82 smbd processes. It is the 'id_num' from Samba's session.c code.
84 The 4 byte 'ut_id' component is vital to distinguish connections,
85 of which there could be several hundred or even thousand.
86 Entries seem to be printable characters, with optional NULL pads.
88 We need to be distinct from other entries in utmp/wtmp.
90 Observed things: therefore avoid them. Add to this list please.
91 From Solaris 2.x (because that's what I have):
92 'sN' : run-levels; N: [0-9]
94 'CC' : arbitrary things; C: [a-z]
95 'rXNN' : rlogin; N: [0-9]; X: [0-9a-z]
96 'tXNN' : rlogin; N: [0-9]; X: [0-9a-z]
98 'ftpZ' : ftp (Z is the number 255, aka 0377, aka 0xff)
99 Mostly a record uses the same 'ut_id' in both "utmp" and "wtmp",
100 but differences have been seen.
102 Arbitrarily I have chosen to use a distinctive 'SM' for the
105 The remaining two bytes encode the session 'id_num' (see above).
106 Our caller (session.c) should note our 16-bit limitation.
108 ****************************************************************************/
112 * Not WITH_UTMP? Simply supply dummy routines.
115 void sys_utmp_claim(const char *username, const char *hostname,
116 const char *ip_addr_str,
117 const char *id_str, int id_num)
120 void sys_utmp_yield(const char *username, const char *hostname,
121 const char *ip_addr_str,
122 const char *id_str, int id_num)
125 #else /* WITH_UTMP */
133 /* BSD systems: some may need lastlog.h (SunOS 4), some may not (FreeBSD) */
134 /* Some System-V systems (e.g. Solaris 2) declare this too. */
135 #ifdef HAVE_LASTLOG_H
139 /****************************************************************************
140 Default paths to various {u,w}tmp{,x} files.
141 ****************************************************************************/
145 static const char *ux_pathname =
146 # if defined (UTMPX_FILE)
148 # elif defined (_UTMPX_FILE)
150 # elif defined (_PATH_UTMPX)
156 static const char *wx_pathname =
157 # if defined (WTMPX_FILE)
159 # elif defined (_WTMPX_FILE)
161 # elif defined (_PATH_WTMPX)
167 #endif /* HAVE_UTMPX_H */
169 static const char *ut_pathname =
170 # if defined (UTMP_FILE)
172 # elif defined (_UTMP_FILE)
174 # elif defined (_PATH_UTMP)
180 static const char *wt_pathname =
181 # if defined (WTMP_FILE)
183 # elif defined (_WTMP_FILE)
185 # elif defined (_PATH_WTMP)
191 /* BSD-like systems might want "lastlog" support. */
192 /* *** Not yet implemented */
193 #ifndef HAVE_PUTUTLINE /* see "pututline_my()" */
194 static const char *ll_pathname =
195 # if defined (_PATH_LASTLOG) /* what other names (if any?) */
199 # endif /* _PATH_LASTLOG */
200 #endif /* HAVE_PUTUTLINE */
203 * Get name of {u,w}tmp{,x} file.
204 * return: fname contains filename
205 * Possibly empty if this code not yet ported to this system.
207 * utmp{,x}: try "utmp dir", then default (a define)
208 * wtmp{,x}: try "wtmp dir", then "utmp dir", then default (a define)
210 static char *uw_pathname(TALLOC_CTX *ctx,
212 const char *uw_default)
214 char *dirname = NULL;
216 /* For w-files, first look for explicit "wtmp dir" */
217 if (uw_name[0] == 'w') {
218 dirname = talloc_strdup(ctx, lp_wtmpdir());
222 trim_char(dirname,'\0','/');
225 /* For u-files and non-explicit w-dir, look for "utmp dir" */
226 if (!dirname == 0 || strlen(dirname) == 0) {
227 dirname = talloc_strdup(ctx, lp_utmpdir());
231 trim_char(dirname,'\0','/');
234 /* If explicit directory above, use it */
235 if (dirname && strlen(dirname) != 0) {
236 return talloc_asprintf(ctx,
242 /* No explicit directory: attempt to use default paths */
243 if (strlen(uw_default) == 0) {
244 /* No explicit setting, no known default.
245 * Has it yet been ported to this OS?
247 DEBUG(2,("uw_pathname: unable to determine pathname\n"));
249 return talloc_strdup(ctx, uw_default);
252 #ifndef HAVE_PUTUTLINE
253 /****************************************************************************
254 Update utmp file directly. No subroutine interface: probably a BSD system.
255 ****************************************************************************/
257 static void pututline_my(const char *uname, struct utmp *u, bool claim)
259 DEBUG(1,("pututline_my: not yet implemented\n"));
260 /* BSD implementor: may want to consider (or not) adjusting "lastlog" */
262 #endif /* HAVE_PUTUTLINE */
266 /****************************************************************************
267 Update wtmp file directly. No subroutine interface: probably a BSD system.
268 Credit: Michail Vidiassov <master@iaas.msu.ru>
269 ****************************************************************************/
271 static void updwtmp_my(const char *wname, struct utmp *u, bool claim)
279 * may use empty ut_name to distinguish a logout record.
281 * May need "if defined(SUNOS4)" etc. around some of these,
282 * but try to avoid if possible.
285 * man page indicates ut_name and ut_host both NULL
287 * man page appears not to specify (hints non-NULL)
288 * A correspondent suggest at least ut_name should be NULL
290 #if defined(HAVE_UT_UT_NAME)
291 memset((char *)&u->ut_name, '\0', sizeof(u->ut_name));
293 #if defined(HAVE_UT_UT_HOST)
294 memset((char *)&u->ut_host, '\0', sizeof(u->ut_host));
297 /* Stolen from logwtmp function in libutil.
298 * May be more locking/blocking is needed?
300 if ((fd = open(wname, O_WRONLY|O_APPEND, 0)) < 0)
302 if (fstat(fd, &buf) == 0) {
303 if (write(fd, (char *)u, sizeof(struct utmp)) != sizeof(struct utmp))
304 (void) ftruncate(fd, buf.st_size);
308 #endif /* HAVE_UPDWTMP */
310 /****************************************************************************
311 Update via utmp/wtmp (not utmpx/wtmpx).
312 ****************************************************************************/
314 static void utmp_nox_update(struct utmp *u, bool claim)
318 #if defined(PUTUTLINE_RETURNS_UTMP)
320 #endif /* PUTUTLINE_RETURNS_UTMP */
322 uname = uw_pathname(talloc_tos(), "utmp", ut_pathname);
326 DEBUG(2,("utmp_nox_update: uname:%s\n", uname));
328 #ifdef HAVE_PUTUTLINE
329 if (strlen(uname) != 0) {
333 # if defined(PUTUTLINE_RETURNS_UTMP)
338 DEBUG(2,("utmp_nox_update: pututline() failed\n"));
341 # else /* PUTUTLINE_RETURNS_UTMP */
345 # endif /* PUTUTLINE_RETURNS_UTMP */
347 #else /* HAVE_PUTUTLINE */
348 if (strlen(uname) != 0) {
349 pututline_my(uname, u, claim);
351 #endif /* HAVE_PUTUTLINE */
353 wname = uw_pathname(talloc_tos(), "wtmp", wt_pathname);
357 DEBUG(2,("utmp_nox_update: wname:%s\n", wname));
358 if (strlen(wname) != 0) {
362 * updwtmp() and the newer updwtmpx() may be unsymmetrical.
363 * At least one OS, Solaris 2.x declares the former in the
364 * "utmpx" (latter) file and context.
365 * In the Solaris case this is irrelevant: it has both and
366 * we always prefer the "x" case, so doesn't come here.
367 * But are there other systems, with no "x", which lack
371 updwtmp_my(wname, u, claim);
372 #endif /* HAVE_UPDWTMP */
376 /****************************************************************************
377 Copy a string in the utmp structure.
378 ****************************************************************************/
380 static void utmp_strcpy(char *dest, const char *src, size_t n)
384 memset(dest, '\0', n);
388 memcpy(dest, src, n);
391 memcpy(dest, src, len);
395 /****************************************************************************
396 Update via utmpx/wtmpx (preferred) or via utmp/wtmp.
397 ****************************************************************************/
399 static void sys_utmp_update(struct utmp *u, const char *hostname, bool claim)
401 #if !defined(HAVE_UTMPX_H)
402 /* No utmpx stuff. Drop to non-x stuff */
403 utmp_nox_update(u, claim);
404 #elif !defined(HAVE_PUTUTXLINE)
405 /* Odd. Have utmpx.h but no "pututxline()". Drop to non-x stuff */
406 DEBUG(1,("utmp_update: have utmpx.h but no pututxline() function\n"));
407 utmp_nox_update(u, claim);
408 #elif !defined(HAVE_GETUTMPX)
409 /* Odd. Have utmpx.h but no "getutmpx()". Drop to non-x stuff */
410 DEBUG(1,("utmp_update: have utmpx.h but no getutmpx() function\n"));
411 utmp_nox_update(u, claim);
415 struct utmpx ux, *uxrc;
419 #if defined(HAVE_UX_UT_SYSLEN)
421 ux.ut_syslen = strlen(hostname) + 1; /* include end NULL */
425 #if defined(HAVE_UT_UT_HOST)
426 utmp_strcpy(ux.ut_host, hostname, sizeof(ux.ut_host));
429 uname = uw_pathname(talloc_tos(), "utmpx", ux_pathname);
430 wname = uw_pathname(talloc_tos(), "wtmpx", wx_pathname);
431 if (uname && wname) {
432 DEBUG(2,("utmp_update: uname:%s wname:%s\n", uname, wname));
436 * Check for either uname or wname being empty.
437 * Some systems, such as Redhat 6, have a "utmpx.h" which doesn't
438 * define default filenames.
439 * Also, our local installation has not provided an override.
440 * Drop to non-x method. (E.g. RH6 has good defaults in "utmp.h".)
442 if (!uname || !wname || (strlen(uname) == 0) || (strlen(wname) == 0)) {
443 utmp_nox_update(u, claim);
447 uxrc = pututxline(&ux);
450 DEBUG(2,("utmp_update: pututxline() failed\n"));
453 updwtmpx(wname, &ux);
455 #endif /* HAVE_UTMPX_H */
458 #if defined(HAVE_UT_UT_ID)
459 /****************************************************************************
460 Encode the unique connection number into "ut_id".
461 ****************************************************************************/
463 static int ut_id_encode(int i, char *fourbyte)
466 const char *ut_id_encstr = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
472 * Encode remaining 2 bytes from 'i'.
473 * 'ut_id_encstr' is the character set on which modulo arithmetic is done.
474 * Example: digits would produce the base-10 numbers from '001'.
476 nbase = strlen(ut_id_encstr);
478 fourbyte[3] = ut_id_encstr[i % nbase];
480 fourbyte[2] = ut_id_encstr[i % nbase];
483 return(i); /* 0: good; else overflow */
485 #endif /* defined(HAVE_UT_UT_ID) */
489 fill a system utmp structure given all the info we can gather
491 static bool sys_utmp_fill(struct utmp *u,
492 const char *username, const char *hostname,
493 const char *ip_addr_str,
494 const char *id_str, int id_num)
496 struct timeval timeval;
500 * Several (all?) systems seems to define one as the other.
501 * It is easier and clearer simply to let the following take its course,
502 * rather than to try to detect and optimise.
504 #if defined(HAVE_UT_UT_USER)
505 utmp_strcpy(u->ut_user, username, sizeof(u->ut_user));
506 #elif defined(HAVE_UT_UT_NAME)
507 utmp_strcpy(u->ut_name, username, sizeof(u->ut_name));
512 * If size limit proves troublesome, then perhaps use "ut_id_encode()".
514 if (strlen(id_str) > sizeof(u->ut_line)) {
515 DEBUG(1,("id_str [%s] is too long for %lu char utmp field\n",
516 id_str, (unsigned long)sizeof(u->ut_line)));
519 utmp_strcpy(u->ut_line, id_str, sizeof(u->ut_line));
521 #if defined(HAVE_UT_UT_PID)
522 u->ut_pid = sys_getpid();
527 * Some have one, some the other. Many have both, but defined (aliased).
528 * It is easier and clearer simply to let the following take its course.
529 * But note that we do the more precise ut_tv as the final assignment.
531 #if defined(HAVE_UT_UT_TIME)
532 GetTimeOfDay(&timeval);
533 u->ut_time = timeval.tv_sec;
534 #elif defined(HAVE_UT_UT_TV)
535 GetTimeOfDay(&timeval);
538 #error "with-utmp must have UT_TIME or UT_TV"
541 #if defined(HAVE_UT_UT_HOST)
542 utmp_strcpy(u->ut_host, hostname, sizeof(u->ut_host));
544 #if defined(HAVE_IPV6) && defined(HAVE_UT_UT_ADDR_V6)
545 memset(&u->ut_addr_v6, '\0', sizeof(u->ut_addr_v6));
547 struct in6_addr addr;
548 if (inet_pton(AF_INET6, ip_addr_str, &addr) > 0) {
549 memcpy(&u->ut_addr_v6, &addr, sizeof(addr));
552 #elif defined(HAVE_UT_UT_ADDR)
553 memset(&u->ut_addr, '\0', sizeof(u->ut_addr));
556 if (inet_pton(AF_INET, ip_addr_str, &addr) > 0) {
557 memcpy(&u->ut_addr, &addr, sizeof(addr));
561 * "(unsigned long) ut_addr" apparently exists on at least HP-UX 10.20.
562 * Volunteer to implement, please ...
566 #if defined(HAVE_UT_UT_ID)
567 if (ut_id_encode(id_num, u->ut_id) != 0) {
568 DEBUG(1,("utmp_fill: cannot encode id %d\n", id_num));
576 /****************************************************************************
578 ****************************************************************************/
580 void sys_utmp_yield(const char *username, const char *hostname,
581 const char *ip_addr_str,
582 const char *id_str, int id_num)
588 #if defined(HAVE_UT_UT_EXIT)
589 u.ut_exit.e_termination = 0;
590 u.ut_exit.e_exit = 0;
593 #if defined(HAVE_UT_UT_TYPE)
594 u.ut_type = DEAD_PROCESS;
597 if (!sys_utmp_fill(&u, username, hostname, ip_addr_str, id_str, id_num))
600 sys_utmp_update(&u, NULL, False);
603 /****************************************************************************
604 Claim a entry in whatever utmp system the OS uses.
605 ****************************************************************************/
607 void sys_utmp_claim(const char *username, const char *hostname,
608 const char *ip_addr_str,
609 const char *id_str, int id_num)
615 #if defined(HAVE_UT_UT_TYPE)
616 u.ut_type = USER_PROCESS;
619 if (!sys_utmp_fill(&u, username, hostname, ip_addr_str, id_str, id_num))
622 sys_utmp_update(&u, hostname, True);
625 #endif /* WITH_UTMP */