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 void uw_pathname(pstring fname, const char *uw_name, const char *uw_default)
214 pstrcpy(dirname, "");
216 /* For w-files, first look for explicit "wtmp dir" */
217 if (uw_name[0] == 'w') {
218 pstrcpy(dirname,lp_wtmpdir());
219 trim_char(dirname,'\0','/');
222 /* For u-files and non-explicit w-dir, look for "utmp dir" */
223 if (dirname == 0 || strlen(dirname) == 0) {
224 pstrcpy(dirname,lp_utmpdir());
225 trim_char(dirname,'\0','/');
228 /* If explicit directory above, use it */
229 if (dirname != 0 && strlen(dirname) != 0) {
230 pstrcpy(fname, dirname);
232 pstrcat(fname, uw_name);
236 /* No explicit directory: attempt to use default paths */
237 if (strlen(uw_default) == 0) {
238 /* No explicit setting, no known default.
239 * Has it yet been ported to this OS?
241 DEBUG(2,("uw_pathname: unable to determine pathname\n"));
243 pstrcpy(fname, uw_default);
246 #ifndef HAVE_PUTUTLINE
248 /****************************************************************************
249 Update utmp file directly. No subroutine interface: probably a BSD system.
250 ****************************************************************************/
252 static void pututline_my(pstring uname, struct utmp *u, BOOL claim)
254 DEBUG(1,("pututline_my: not yet implemented\n"));
255 /* BSD implementor: may want to consider (or not) adjusting "lastlog" */
257 #endif /* HAVE_PUTUTLINE */
261 /****************************************************************************
262 Update wtmp file directly. No subroutine interface: probably a BSD system.
263 Credit: Michail Vidiassov <master@iaas.msu.ru>
264 ****************************************************************************/
266 static void updwtmp_my(pstring wname, struct utmp *u, BOOL claim)
274 * may use empty ut_name to distinguish a logout record.
276 * May need "if defined(SUNOS4)" etc. around some of these,
277 * but try to avoid if possible.
280 * man page indicates ut_name and ut_host both NULL
282 * man page appears not to specify (hints non-NULL)
283 * A correspondent suggest at least ut_name should be NULL
285 #if defined(HAVE_UT_UT_NAME)
286 memset((char *)&u->ut_name, '\0', sizeof(u->ut_name));
288 #if defined(HAVE_UT_UT_HOST)
289 memset((char *)&u->ut_host, '\0', sizeof(u->ut_host));
292 /* Stolen from logwtmp function in libutil.
293 * May be more locking/blocking is needed?
295 if ((fd = open(wname, O_WRONLY|O_APPEND, 0)) < 0)
297 if (fstat(fd, &buf) == 0) {
298 if (write(fd, (char *)u, sizeof(struct utmp)) != sizeof(struct utmp))
299 (void) ftruncate(fd, buf.st_size);
303 #endif /* HAVE_UPDWTMP */
305 /****************************************************************************
306 Update via utmp/wtmp (not utmpx/wtmpx).
307 ****************************************************************************/
309 static void utmp_nox_update(struct utmp *u, BOOL claim)
311 pstring uname, wname;
312 #if defined(PUTUTLINE_RETURNS_UTMP)
314 #endif /* PUTUTLINE_RETURNS_UTMP */
316 uw_pathname(uname, "utmp", ut_pathname);
317 DEBUG(2,("utmp_nox_update: uname:%s\n", uname));
319 #ifdef HAVE_PUTUTLINE
320 if (strlen(uname) != 0) {
324 # if defined(PUTUTLINE_RETURNS_UTMP)
329 DEBUG(2,("utmp_nox_update: pututline() failed\n"));
332 # else /* PUTUTLINE_RETURNS_UTMP */
336 # endif /* PUTUTLINE_RETURNS_UTMP */
338 #else /* HAVE_PUTUTLINE */
339 if (strlen(uname) != 0) {
340 pututline_my(uname, u, claim);
342 #endif /* HAVE_PUTUTLINE */
344 uw_pathname(wname, "wtmp", wt_pathname);
345 DEBUG(2,("utmp_nox_update: wname:%s\n", wname));
346 if (strlen(wname) != 0) {
350 * updwtmp() and the newer updwtmpx() may be unsymmetrical.
351 * At least one OS, Solaris 2.x declares the former in the
352 * "utmpx" (latter) file and context.
353 * In the Solaris case this is irrelevant: it has both and
354 * we always prefer the "x" case, so doesn't come here.
355 * But are there other systems, with no "x", which lack
359 updwtmp_my(wname, u, claim);
360 #endif /* HAVE_UPDWTMP */
364 /****************************************************************************
365 Copy a string in the utmp structure.
366 ****************************************************************************/
368 static void utmp_strcpy(char *dest, const char *src, size_t n)
372 memset(dest, '\0', n);
376 memcpy(dest, src, n);
379 memcpy(dest, src, len);
383 /****************************************************************************
384 Update via utmpx/wtmpx (preferred) or via utmp/wtmp.
385 ****************************************************************************/
387 static void sys_utmp_update(struct utmp *u, const char *hostname, BOOL claim)
389 #if !defined(HAVE_UTMPX_H)
390 /* No utmpx stuff. Drop to non-x stuff */
391 utmp_nox_update(u, claim);
392 #elif !defined(HAVE_PUTUTXLINE)
393 /* Odd. Have utmpx.h but no "pututxline()". Drop to non-x stuff */
394 DEBUG(1,("utmp_update: have utmpx.h but no pututxline() function\n"));
395 utmp_nox_update(u, claim);
396 #elif !defined(HAVE_GETUTMPX)
397 /* Odd. Have utmpx.h but no "getutmpx()". Drop to non-x stuff */
398 DEBUG(1,("utmp_update: have utmpx.h but no getutmpx() function\n"));
399 utmp_nox_update(u, claim);
401 pstring uname, wname;
402 struct utmpx ux, *uxrc;
406 #if defined(HAVE_UX_UT_SYSLEN)
408 ux.ut_syslen = strlen(hostname) + 1; /* include end NULL */
412 #if defined(HAVE_UT_UT_HOST)
413 utmp_strcpy(ux.ut_host, hostname, sizeof(ux.ut_host));
416 uw_pathname(uname, "utmpx", ux_pathname);
417 uw_pathname(wname, "wtmpx", wx_pathname);
418 DEBUG(2,("utmp_update: uname:%s wname:%s\n", uname, wname));
420 * Check for either uname or wname being empty.
421 * Some systems, such as Redhat 6, have a "utmpx.h" which doesn't
422 * define default filenames.
423 * Also, our local installation has not provided an override.
424 * Drop to non-x method. (E.g. RH6 has good defaults in "utmp.h".)
426 if ((strlen(uname) == 0) || (strlen(wname) == 0)) {
427 utmp_nox_update(u, claim);
431 uxrc = pututxline(&ux);
434 DEBUG(2,("utmp_update: pututxline() failed\n"));
437 updwtmpx(wname, &ux);
439 #endif /* HAVE_UTMPX_H */
442 #if defined(HAVE_UT_UT_ID)
443 /****************************************************************************
444 Encode the unique connection number into "ut_id".
445 ****************************************************************************/
447 static int ut_id_encode(int i, char *fourbyte)
450 const char *ut_id_encstr = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
456 * Encode remaining 2 bytes from 'i'.
457 * 'ut_id_encstr' is the character set on which modulo arithmetic is done.
458 * Example: digits would produce the base-10 numbers from '001'.
460 nbase = strlen(ut_id_encstr);
462 fourbyte[3] = ut_id_encstr[i % nbase];
464 fourbyte[2] = ut_id_encstr[i % nbase];
467 return(i); /* 0: good; else overflow */
469 #endif /* defined(HAVE_UT_UT_ID) */
473 fill a system utmp structure given all the info we can gather
475 static BOOL sys_utmp_fill(struct utmp *u,
476 const char *username, const char *hostname,
477 const char *ip_addr_str,
478 const char *id_str, int id_num)
480 struct timeval timeval;
484 * Several (all?) systems seems to define one as the other.
485 * It is easier and clearer simply to let the following take its course,
486 * rather than to try to detect and optimise.
488 #if defined(HAVE_UT_UT_USER)
489 utmp_strcpy(u->ut_user, username, sizeof(u->ut_user));
490 #elif defined(HAVE_UT_UT_NAME)
491 utmp_strcpy(u->ut_name, username, sizeof(u->ut_name));
496 * If size limit proves troublesome, then perhaps use "ut_id_encode()".
498 if (strlen(id_str) > sizeof(u->ut_line)) {
499 DEBUG(1,("id_str [%s] is too long for %lu char utmp field\n",
500 id_str, (unsigned long)sizeof(u->ut_line)));
503 utmp_strcpy(u->ut_line, id_str, sizeof(u->ut_line));
505 #if defined(HAVE_UT_UT_PID)
506 u->ut_pid = sys_getpid();
511 * Some have one, some the other. Many have both, but defined (aliased).
512 * It is easier and clearer simply to let the following take its course.
513 * But note that we do the more precise ut_tv as the final assignment.
515 #if defined(HAVE_UT_UT_TIME)
516 GetTimeOfDay(&timeval);
517 u->ut_time = timeval.tv_sec;
518 #elif defined(HAVE_UT_UT_TV)
519 GetTimeOfDay(&timeval);
522 #error "with-utmp must have UT_TIME or UT_TV"
525 #if defined(HAVE_UT_UT_HOST)
526 utmp_strcpy(u->ut_host, hostname, sizeof(u->ut_host));
528 #if defined(AF_INET6) && defined(HAVE_UT_UT_ADDR_V6)
529 memset(&u->ut_addr_v6, '\0', sizeof(u->ut_addr_v6));
531 struct in6_addr addr;
532 if (inet_pton(AF_INET6, ip_addr_str, &addr) > 0) {
533 memcpy(&u->ut_addr_v6, &addr, sizeof(addr));
536 #elif defined(HAVE_UT_UT_ADDR)
537 memset(&u->ut_addr, '\0', sizeof(u->ut_addr));
540 if (inet_pton(AF_INET, ip_addr_str, &addr) > 0) {
541 memcpy(&u->ut_addr, &addr, sizeof(addr));
545 * "(unsigned long) ut_addr" apparently exists on at least HP-UX 10.20.
546 * Volunteer to implement, please ...
550 #if defined(HAVE_UT_UT_ID)
551 if (ut_id_encode(id_num, u->ut_id) != 0) {
552 DEBUG(1,("utmp_fill: cannot encode id %d\n", id_num));
560 /****************************************************************************
562 ****************************************************************************/
564 void sys_utmp_yield(const char *username, const char *hostname,
565 const char *ip_addr_str,
566 const char *id_str, int id_num)
572 #if defined(HAVE_UT_UT_EXIT)
573 u.ut_exit.e_termination = 0;
574 u.ut_exit.e_exit = 0;
577 #if defined(HAVE_UT_UT_TYPE)
578 u.ut_type = DEAD_PROCESS;
581 if (!sys_utmp_fill(&u, username, hostname, ip_addr_str, id_str, id_num))
584 sys_utmp_update(&u, NULL, False);
587 /****************************************************************************
588 Claim a entry in whatever utmp system the OS uses.
589 ****************************************************************************/
591 void sys_utmp_claim(const char *username, const char *hostname,
592 const char *ip_addr_str,
593 const char *id_str, int id_num)
599 #if defined(HAVE_UT_UT_TYPE)
600 u.ut_type = USER_PROCESS;
603 if (!sys_utmp_fill(&u, username, hostname, ip_addr_str, id_str, id_num))
606 sys_utmp_update(&u, hostname, True);
609 #endif /* WITH_UTMP */