6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2000,2006 The FreeRADIUS server project
21 * FIXME add copyrights
24 #include <freeradius-devel/ident.h>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/radutmp.h>
29 #include <freeradius-devel/modules.h>
30 #include <freeradius-devel/rad_assert.h>
37 #define LOCK_LEN sizeof(struct radutmp)
39 static const char porttypes[] = "ASITX";
42 * used for caching radutmp lookups in the accounting component. The
43 * session (checksimul) component doesn't use it, but probably should.
45 typedef struct nas_port {
49 struct nas_port *next;
52 typedef struct rlm_radutmp_t {
53 NAS_PORT *nas_port_list;
62 static const CONF_PARSER module_config[] = {
63 { "filename", PW_TYPE_STRING_PTR,
64 offsetof(rlm_radutmp_t,filename), NULL, RADUTMP },
65 { "username", PW_TYPE_STRING_PTR,
66 offsetof(rlm_radutmp_t,username), NULL, "%{User-Name}"},
67 { "case_sensitive", PW_TYPE_BOOLEAN,
68 offsetof(rlm_radutmp_t,case_sensitive), NULL, "yes"},
69 { "check_with_nas", PW_TYPE_BOOLEAN,
70 offsetof(rlm_radutmp_t,check_nas), NULL, "yes"},
71 { "perm", PW_TYPE_INTEGER,
72 offsetof(rlm_radutmp_t,permission), NULL, "0644" },
73 { "callerid", PW_TYPE_BOOLEAN,
74 offsetof(rlm_radutmp_t,callerid_ok), NULL, "no" },
75 { NULL, -1, 0, NULL, NULL } /* end the list */
78 static int radutmp_instantiate(CONF_SECTION *conf, void **instance)
82 inst = rad_malloc(sizeof(*inst));
86 memset(inst, 0, sizeof(*inst));
88 if (cf_section_parse(conf, inst, module_config)) {
93 inst->nas_port_list = NULL;
102 static int radutmp_detach(void *instance)
105 rlm_radutmp_t *inst = instance;
107 for (p = inst->nas_port_list ; p ; p=next) {
116 * Zap all users on a NAS from the radutmp file.
118 static int radutmp_zap(rlm_radutmp_t *inst,
119 const char *filename,
126 if (t == 0) time(&t);
128 fd = open(filename, O_RDWR);
130 radlog(L_ERR, "rlm_radutmp: Error accessing file %s: %s",
131 filename, strerror(errno));
132 return RLM_MODULE_FAIL;
136 * Lock the utmp file, prefer lockf() over flock().
138 rad_lockfd(fd, LOCK_LEN);
141 * Find the entry for this NAS / portno combination.
143 while (read(fd, &u, sizeof(u)) == sizeof(u)) {
144 if ((nasaddr != 0 && nasaddr != u.nas_address) ||
150 if (lseek(fd, -(off_t)sizeof(u), SEEK_CUR) < 0) {
151 radlog(L_ERR, "rlm_radutmp: radutmp_zap: negative lseek!");
152 lseek(fd, (off_t)0, SEEK_SET);
156 write(fd, &u, sizeof(u));
158 close(fd); /* and implicitely release the locks */
164 * Lookup a NAS_PORT in the nas_port_list
166 static NAS_PORT *nas_port_find(NAS_PORT *nas_port_list, uint32_t nasaddr, unsigned int port)
170 for(cl = nas_port_list; cl; cl = cl->next)
171 if (nasaddr == cl->nasaddr &&
179 * Store logins in the RADIUS utmp file.
181 static int radutmp_accounting(void *instance, REQUEST *request)
183 struct radutmp ut, u;
186 uint32_t nas_address = 0;
187 uint32_t framed_address = 0;
191 int just_an_update = 0;
193 int nas_port_type = 0;
195 rlm_radutmp_t *inst = instance;
198 char ip_name[32]; /* 255.255.255.255 */
203 if (request->packet->src_ipaddr.af != AF_INET) {
204 DEBUG("rlm_radutmp: IPv6 not supported!");
205 return RLM_MODULE_NOOP;
209 * Which type is this.
211 if ((vp = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE)) == NULL) {
212 radlog(L_ERR, "rlm_radutmp: No Accounting-Status-Type record.");
213 return RLM_MODULE_NOOP;
215 status = vp->vp_integer;
218 * Look for weird reboot packets.
220 * ComOS (up to and including 3.5.1b20) does not send
221 * standard PW_STATUS_ACCOUNTING_XXX messages.
223 * Check for: o no Acct-Session-Time, or time of 0
224 * o Acct-Session-Id of "00000000".
226 * We could also check for NAS-Port, that attribute
227 * should NOT be present (but we don't right now).
229 if ((status != PW_STATUS_ACCOUNTING_ON) &&
230 (status != PW_STATUS_ACCOUNTING_OFF)) do {
234 if ((vp = pairfind(request->packet->vps, PW_ACCT_SESSION_TIME))
235 == NULL || vp->vp_date == 0)
237 if ((vp = pairfind(request->packet->vps, PW_ACCT_SESSION_ID))
238 != NULL && vp->length == 8 &&
239 memcmp(vp->vp_strvalue, "00000000", 8) == 0)
241 if (check1 == 0 || check2 == 0) {
242 #if 0 /* Cisco sometimes sends START records without username. */
243 radlog(L_ERR, "rlm_radutmp: no username in record");
244 return RLM_MODULE_FAIL;
249 radlog(L_INFO, "rlm_radutmp: converting reboot records.");
250 if (status == PW_STATUS_STOP)
251 status = PW_STATUS_ACCOUNTING_OFF;
252 if (status == PW_STATUS_START)
253 status = PW_STATUS_ACCOUNTING_ON;
257 memset(&ut, 0, sizeof(ut));
261 * First, find the interesting attributes.
263 for (vp = request->packet->vps; vp; vp = vp->next) {
264 switch (vp->attribute) {
265 case PW_LOGIN_IP_HOST:
266 case PW_FRAMED_IP_ADDRESS:
267 framed_address = vp->vp_ipaddr;
268 ut.framed_address = vp->vp_ipaddr;
270 case PW_FRAMED_PROTOCOL:
271 protocol = vp->vp_integer;
273 case PW_NAS_IP_ADDRESS:
274 nas_address = vp->vp_ipaddr;
275 ut.nas_address = vp->vp_ipaddr;
278 ut.nas_port = vp->vp_integer;
281 case PW_ACCT_DELAY_TIME:
282 ut.delay = vp->vp_integer;
284 case PW_ACCT_SESSION_ID:
286 * If length > 8, only store the
289 off = vp->length - sizeof(ut.session_id);
291 * Ascend is br0ken - it adds a \0
292 * to the end of any string.
295 if (vp->length > 0 &&
296 vp->vp_strvalue[vp->length - 1] == 0)
298 if (off < 0) off = 0;
299 memcpy(ut.session_id, vp->vp_strvalue + off,
300 sizeof(ut.session_id));
302 case PW_NAS_PORT_TYPE:
303 if (vp->vp_integer <= 4)
304 ut.porttype = porttypes[vp->vp_integer];
305 nas_port_type = vp->vp_integer;
307 case PW_CALLING_STATION_ID:
308 if(inst->callerid_ok)
309 strlcpy(ut.caller_id,
310 (char *)vp->vp_strvalue,
311 sizeof(ut.caller_id));
317 * If we didn't find out the NAS address, use the
318 * originator's IP address.
320 if (nas_address == 0) {
321 nas_address = request->packet->src_ipaddr.ipaddr.ip4addr.s_addr;
322 ut.nas_address = nas_address;
323 nas = client_name_old(&request->packet->src_ipaddr); /* MUST be a valid client */
325 } else if (request->packet->src_ipaddr.ipaddr.ip4addr.s_addr == nas_address) { /* might be a client, might not be. */
329 * Hack like 'client_name()', but with sane
332 cl = client_find_old(&request->packet->src_ipaddr);
333 if (!cl) rad_assert(0 == 1); /* WTF? */
334 if (cl->shortname && cl->shortname[0]) {
341 * The NAS isn't a client, it's behind
342 * a proxy server. In that case, just
343 * get the IP address.
345 nas = ip_ntoa(ip_name, nas_address);
349 * Set the protocol field.
351 if (protocol == PW_PPP)
353 else if (protocol == PW_SLIP)
357 ut.time = t - ut.delay;
360 * Get the utmp filename, via xlat.
362 radius_xlat(filename, sizeof(filename), inst->filename, request, NULL);
365 * See if this was a reboot.
367 * Hmm... we may not want to zap all of the users when
368 * the NAS comes up, because of issues with receiving
369 * UDP packets out of order.
371 if (status == PW_STATUS_ACCOUNTING_ON && nas_address) {
372 radlog(L_INFO, "rlm_radutmp: NAS %s restarted (Accounting-On packet seen)",
374 radutmp_zap(inst, filename, nas_address, ut.time);
375 return RLM_MODULE_OK;
378 if (status == PW_STATUS_ACCOUNTING_OFF && nas_address) {
379 radlog(L_INFO, "rlm_radutmp: NAS %s rebooted (Accounting-Off packet seen)",
381 radutmp_zap(inst, filename, nas_address, ut.time);
382 return RLM_MODULE_OK;
386 * If we don't know this type of entry pretend we succeeded.
388 if (status != PW_STATUS_START &&
389 status != PW_STATUS_STOP &&
390 status != PW_STATUS_ALIVE) {
391 radlog(L_ERR, "rlm_radutmp: NAS %s port %u unknown packet type %d)",
392 nas, ut.nas_port, status);
393 return RLM_MODULE_NOOP;
397 * Translate the User-Name attribute, or whatever else
398 * they told us to use.
401 radius_xlat(buffer, sizeof(buffer), inst->username, request, NULL);
404 * Copy the previous translated user name.
406 strlcpy(ut.login, buffer, RUT_NAMESIZE);
409 * Perhaps we don't want to store this record into
410 * radutmp. We skip records:
412 * - without a NAS-Port (telnet / tcp access)
413 * - with the username "!root" (console admin login)
416 DEBUG2(" rlm_radutmp: No NAS-Port seen. Cannot do anything.");
417 DEBUG2(" rlm_radumtp: WARNING: checkrad will probably not work!");
418 return RLM_MODULE_NOOP;
421 if (strncmp(ut.login, "!root", RUT_NAMESIZE) == 0) {
422 DEBUG2(" rlm_radutmp: Not recording administrative user");
424 return RLM_MODULE_NOOP;
428 * Enter into the radutmp file.
430 fd = open(filename, O_RDWR|O_CREAT, inst->permission);
432 radlog(L_ERR, "rlm_radutmp: Error accessing file %s: %s",
433 filename, strerror(errno));
434 return RLM_MODULE_FAIL;
438 * Lock the utmp file, prefer lockf() over flock().
440 rad_lockfd(fd, LOCK_LEN);
443 * Find the entry for this NAS / portno combination.
445 if ((cache = nas_port_find(inst->nas_port_list, ut.nas_address,
446 ut.nas_port)) != NULL) {
447 lseek(fd, (off_t)cache->offset, SEEK_SET);
452 while (read(fd, &u, sizeof(u)) == sizeof(u)) {
454 if (u.nas_address != ut.nas_address ||
455 u.nas_port != ut.nas_port)
459 * Don't compare stop records to unused entries.
461 if (status == PW_STATUS_STOP &&
466 if (status == PW_STATUS_STOP &&
467 strncmp(ut.session_id, u.session_id,
468 sizeof(u.session_id)) != 0) {
470 * Don't complain if this is not a
471 * login record (some clients can
472 * send _only_ logout records).
474 if (u.type == P_LOGIN)
475 radlog(L_ERR, "rlm_radutmp: Logout entry for NAS %s port %u has wrong ID",
481 if (status == PW_STATUS_START &&
482 strncmp(ut.session_id, u.session_id,
483 sizeof(u.session_id)) == 0 &&
485 if (u.type == P_LOGIN) {
486 radlog(L_INFO, "rlm_radutmp: Login entry for NAS %s port %u duplicate",
491 radlog(L_ERR, "rlm_radutmp: Login entry for NAS %s port %u wrong order",
498 * FIXME: the ALIVE record could need
499 * some more checking, but anyway I'd
500 * rather rewrite this mess -- miquels.
502 if (status == PW_STATUS_ALIVE &&
503 strncmp(ut.session_id, u.session_id,
504 sizeof(u.session_id)) == 0 &&
507 * Keep the original login time.
514 if (lseek(fd, -(off_t)sizeof(u), SEEK_CUR) < 0) {
515 radlog(L_ERR, "rlm_radutmp: negative lseek!");
516 lseek(fd, (off_t)0, SEEK_SET);
522 } /* read the file until we find a match */
525 * Found the entry, do start/update it with
526 * the information from the packet.
528 if (r >= 0 && (status == PW_STATUS_START ||
529 status == PW_STATUS_ALIVE)) {
531 * Remember where the entry was, because it's
532 * easier than searching through the entire file.
535 cache = rad_malloc(sizeof(NAS_PORT));
536 cache->nasaddr = ut.nas_address;
537 cache->port = ut.nas_port;
539 cache->next = inst->nas_port_list;
540 inst->nas_port_list = cache;
544 write(fd, &ut, sizeof(u));
548 * The user has logged off, delete the entry by
549 * re-writing it in place.
551 if (status == PW_STATUS_STOP) {
556 write(fd, &u, sizeof(u));
558 radlog(L_ERR, "rlm_radutmp: Logout for NAS %s port %u, but no Login record",
563 close(fd); /* and implicitely release the locks */
565 return RLM_MODULE_OK;
569 * See if a user is already logged in. Sets request->simul_count to the
570 * current session count for this user and sets request->simul_mpp to 2
571 * if it looks like a multilink attempt based on the requested IP
572 * address, otherwise leaves request->simul_mpp alone.
574 * Check twice. If on the first pass the user exceeds his
575 * max. number of logins, do a second pass and validate all
576 * logins by querying the terminal server (using eg. SNMP).
578 static int radutmp_checksimul(void *instance, REQUEST *request)
584 char *call_num = NULL;
586 rlm_radutmp_t *inst = instance;
591 * Get the filename, via xlat.
593 radius_xlat(filename, sizeof(filename), inst->filename, request, NULL);
595 if ((fd = open(filename, O_RDWR)) < 0) {
597 * If the file doesn't exist, then no users
600 if (errno == ENOENT) {
601 request->simul_count=0;
602 return RLM_MODULE_OK;
606 * Error accessing the file.
608 radlog(L_ERR, "rlm_radumtp: Error accessing file %s: %s",
609 filename, strerror(errno));
610 return RLM_MODULE_FAIL;
614 radius_xlat(login, sizeof(login), inst->username, request, NULL);
616 return RLM_MODULE_NOOP;
620 * WTF? This is probably wrong... we probably want to
621 * be able to check users across multiple session accounting
624 request->simul_count = 0;
627 * Loop over utmp, counting how many people MAY be logged in.
629 while (read(fd, &u, sizeof(u)) == sizeof(u)) {
630 if (((strncmp(login, u.login, RUT_NAMESIZE) == 0) ||
631 (!inst->case_sensitive &&
632 (strncasecmp(login, u.login, RUT_NAMESIZE) == 0))) &&
633 (u.type == P_LOGIN)) {
634 ++request->simul_count;
639 * The number of users logged in is OK,
640 * OR, we've been told to not check the NAS.
642 if ((request->simul_count < request->simul_max) ||
645 return RLM_MODULE_OK;
647 lseek(fd, (off_t)0, SEEK_SET);
650 * Setup some stuff, like for MPP detection.
652 if ((vp = pairfind(request->packet->vps, PW_FRAMED_IP_ADDRESS)) != NULL)
653 ipno = vp->vp_ipaddr;
654 if ((vp = pairfind(request->packet->vps, PW_CALLING_STATION_ID)) != NULL)
655 call_num = vp->vp_strvalue;
658 * lock the file while reading/writing.
660 rad_lockfd(fd, LOCK_LEN);
663 * FIXME: If we get a 'Start' for a user/nas/port which is
664 * listed, but for which we did NOT get a 'Stop', then
665 * it's not a duplicate session. This happens with
666 * static IP's like DSL.
668 request->simul_count = 0;
669 while (read(fd, &u, sizeof(u)) == sizeof(u)) {
670 if (((strncmp(login, u.login, RUT_NAMESIZE) == 0) ||
671 (!inst->case_sensitive &&
672 (strncasecmp(login, u.login, RUT_NAMESIZE) == 0))) &&
673 (u.type == P_LOGIN)) {
674 char session_id[sizeof(u.session_id) + 1];
675 char utmp_login[sizeof(u.login) + 1];
677 strlcpy(session_id, u.session_id, sizeof(session_id));
680 * The login name MAY fill the whole field,
681 * and thus won't be zero-filled.
683 * Note that we take the user name from
684 * the utmp file, as that's the canonical
685 * form. The 'login' variable may contain
686 * a string which is an upper/lowercase
687 * version of u.login. When we call the
688 * routine to check the terminal server,
689 * the NAS may be case sensitive.
691 * e.g. We ask if "bob" is using a port,
692 * and the NAS says "no", because "BOB"
695 strlcpy(utmp_login, u.login, sizeof(u.login));
698 * rad_check_ts may take seconds
699 * to return, and we don't want
700 * to block everyone else while
701 * that's happening. */
702 rad_unlockfd(fd, LOCK_LEN);
703 rcode = rad_check_ts(u.nas_address, u.nas_port,
704 utmp_login, session_id);
705 rad_lockfd(fd, LOCK_LEN);
709 * Stale record - zap it.
711 session_zap(request, u.nas_address,
712 u.nas_port, login, session_id,
713 u.framed_address, u.proto,0);
715 else if (rcode == 1) {
717 * User is still logged in.
719 ++request->simul_count;
722 * Does it look like a MPP attempt?
724 if (strchr("SCPA", u.proto) &&
725 ipno && u.framed_address == ipno)
726 request->simul_mpp = 2;
727 else if (strchr("SCPA", u.proto) && call_num &&
728 !strncmp(u.caller_id,call_num,16))
729 request->simul_mpp = 2;
733 * Failed to check the terminal
734 * server for duplicate logins:
738 radlog(L_ERR, "rlm_radutmp: Failed to check the terminal server for user '%s'.", utmp_login);
739 return RLM_MODULE_FAIL;
743 close(fd); /* and implicitely release the locks */
745 return RLM_MODULE_OK;
748 /* globally exported name */
749 module_t rlm_radutmp = {
752 RLM_TYPE_CHECK_CONFIG_SAFE, /* type */
753 radutmp_instantiate, /* instantiation */
754 radutmp_detach, /* detach */
756 NULL, /* authentication */
757 NULL, /* authorization */
758 NULL, /* preaccounting */
759 radutmp_accounting, /* accounting */
760 radutmp_checksimul, /* checksimul */
761 NULL, /* pre-proxy */
762 NULL, /* post-proxy */