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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Copyright 2001 The FreeRADIUS server project
21 * Copyright 2001 Alan DeKok <aland@ox.org>
22 * Copyright 2001,2002 Kostas Kalevras <kkalev@noc.ntua.gr>
27 #include "libradius.h"
41 #ifdef NEEDS_GDBM_SYNC
42 # define GDBM_SYNCOPT GDBM_SYNC
44 # define GDBM_SYNCOPT 0
48 #define GDBM_COUNTER_OPTS (GDBM_SYNCOPT | GDBM_NOLOCK)
50 #define GDBM_COUNTER_OPTS (GDBM_SYNCOPT)
53 #ifndef HAVE_GDBM_FDESC
54 #define gdbm_fdesc(foo) (-1)
57 static const char rcsid[] = "$Id$";
60 * Define a structure for our module configuration.
62 * These variables do not need to be in a structure, but it's
63 * a lot cleaner to do so, and a pointer to the structure can
64 * be used as the instance handle.
66 typedef struct rlm_counter_t {
67 char *filename; /* name of the database file */
68 char *reset; /* daily, weekly, monthly, never or user defined */
69 char *key_name; /* User-Name */
70 char *count_attribute; /* Acct-Session-Time */
71 char *counter_name; /* Daily-Session-Time */
72 char *check_name; /* Daily-Max-Session */
73 char *service_type; /* Service-Type to search for */
78 time_t reset_time; /* The time of the next reset. */
79 time_t last_reset; /* The time of the last reset. */
80 int dict_attr; /* attribute number for the counter. */
86 * A mapping of configuration file names to internal variables.
88 * Note that the string is dynamically allocated, so it MUST
89 * be freed. When the configuration file parse re-reads the string,
90 * it free's the old one, and strdup's the new one, placing the pointer
91 * to the strdup'd string into 'config.string'. This gets around
94 static CONF_PARSER module_config[] = {
95 { "filename", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,filename), NULL, NULL },
96 { "key", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,key_name), NULL, NULL },
97 { "reset", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,reset), NULL, NULL },
98 { "count-attribute", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,count_attribute), NULL, NULL },
99 { "counter-name", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,counter_name), NULL, NULL },
100 { "check-name", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,check_name), NULL, NULL },
101 { "allowed-servicetype", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,service_type),NULL, NULL },
102 { "cache-size", PW_TYPE_INTEGER, offsetof(rlm_counter_t,cache_size), NULL, "1000" },
103 { NULL, -1, 0, NULL, NULL }
108 * See if the counter matches.
110 static int counter_cmp(void *instance, REQUEST *req, VALUE_PAIR *request, VALUE_PAIR *check,
111 VALUE_PAIR *check_pairs, VALUE_PAIR **reply_pairs)
113 rlm_counter_t *data = (rlm_counter_t *) instance;
119 check_pairs = check_pairs; /* shut the compiler up */
120 reply_pairs = reply_pairs;
123 * Find the key attribute.
125 key_vp = pairfind(request, data->key_attr);
126 if (key_vp == NULL) {
127 return RLM_MODULE_NOOP;
130 key_datum.dptr = key_vp->strvalue;
131 key_datum.dsize = key_vp->length;
133 count_datum = gdbm_fetch(data->gdbm, key_datum);
135 if (count_datum.dptr == NULL) {
138 memcpy(&counter, count_datum.dptr, sizeof(int));
139 free(count_datum.dptr);
141 return counter - check->lvalue;
144 static int add_defaults(rlm_counter_t *data)
148 const char *default1 = "DEFAULT1";
149 const char *default2 = "DEFAULT2";
151 DEBUG2("rlm_counter: add_defaults: Start");
153 key_datum.dptr = (const char *) default1;
154 key_datum.dsize = strlen(default1);
155 time_datum.dptr = (char *) &data->reset_time;
156 time_datum.dsize = sizeof(time_t);
158 if (gdbm_store(data->gdbm, key_datum, time_datum, GDBM_REPLACE) < 0){
159 radlog(L_ERR, "rlm_counter: Failed storing data to %s: %s",
160 data->filename, gdbm_strerror(gdbm_errno));
161 return RLM_MODULE_FAIL;
163 DEBUG2("rlm_counter: DEFAULT1 set to %d",(int)data->reset_time);
165 key_datum.dptr = (const char *) default2;
166 key_datum.dsize = strlen(default2);
167 time_datum.dptr = (char *) &data->last_reset;
168 time_datum.dsize = sizeof(time_t);
170 if (gdbm_store(data->gdbm, key_datum, time_datum, GDBM_REPLACE) < 0){
171 radlog(L_ERR, "rlm_counter: Failed storing data to %s: %s",
172 data->filename, gdbm_strerror(gdbm_errno));
173 return RLM_MODULE_FAIL;
175 DEBUG2("rlm_counter: DEFAULT2 set to %d",(int)data->last_reset);
176 DEBUG2("rlm_counter: add_defaults: End");
178 return RLM_MODULE_OK;
181 static int reset_db(rlm_counter_t *data)
183 int cache_size = data->cache_size;
186 DEBUG2("rlm_counter: reset_db: Closing database");
187 gdbm_close(data->gdbm);
190 * Open a completely new database.
192 data->gdbm = gdbm_open(data->filename, sizeof(int),
193 GDBM_NEWDB | GDBM_COUNTER_OPTS, 0600, NULL);
194 if (data->gdbm == NULL) {
195 radlog(L_ERR, "rlm_counter: Failed to open file %s: %s",
196 data->filename, strerror(errno));
197 return RLM_MODULE_FAIL;
199 if (data->fd >= 0) data->fd = gdbm_fdesc(data->gdbm);
200 if (gdbm_setopt(data->gdbm, GDBM_CACHESIZE, &cache_size, sizeof(int)) == -1)
201 radlog(L_ERR, "rlm_counter: Failed to set cache size");
202 DEBUG2("rlm_counter: reset_db: Opened new database");
207 ret = add_defaults(data);
208 if (ret != RLM_MODULE_OK)
211 DEBUG2("rlm_counter: reset_db ended");
213 return RLM_MODULE_OK;
216 static int find_next_reset(rlm_counter_t *data, time_t timeval)
223 tm = localtime_r(&timeval, &s_tm);
224 tm->tm_sec = tm->tm_min = 0;
226 if (data->reset == NULL)
228 if (isdigit((int) data->reset[0])){
231 len = strlen(data->reset);
234 last = data->reset[len - 1];
235 if (!isalpha((int) last))
237 num = atoi(data->reset);
238 DEBUG("rlm_counter: num=%d, last=%c",num,last);
240 if (strcmp(data->reset, "hourly") == 0 || last == 'h') {
242 * Round up to the next nearest hour.
245 data->reset_time = mktime(tm);
246 } else if (strcmp(data->reset, "daily") == 0 || last == 'd') {
248 * Round up to the next nearest day.
252 data->reset_time = mktime(tm);
253 } else if (strcmp(data->reset, "weekly") == 0 || last == 'w') {
255 * Round up to the next nearest week.
258 tm->tm_mday += (7 - tm->tm_wday) +(7*(num-1));
259 data->reset_time = mktime(tm);
260 } else if (strcmp(data->reset, "monthly") == 0 || last == 'm') {
264 data->reset_time = mktime(tm);
265 } else if (strcmp(data->reset, "never") == 0) {
266 data->reset_time = 0;
268 radlog(L_ERR, "rlm_counter: Unknown reset timer \"%s\"",
272 DEBUG2("rlm_counter: Current Time: %d, Next reset %d",
273 (int)timeval,(int)data->reset_time);
280 * Do any per-module initialization that is separate to each
281 * configured instance of the module. e.g. set up connections
282 * to external databases, read configuration files, set up
283 * dictionary entries, etc.
285 * If configuration information is given in the config section
286 * that must be referenced in later calls, store a handle to it
287 * in *instance otherwise put a null pointer there.
289 static int counter_instantiate(CONF_SECTION *conf, void **instance)
300 const char *default1 = "DEFAULT1";
301 const char *default2 = "DEFAULT2";
304 * Set up a storage area for instance data
306 data = rad_malloc(sizeof(*data));
309 * If the configuration parameters can't be parsed, then
312 if (cf_section_parse(conf, data, module_config) < 0) {
316 cache_size = data->cache_size;
319 * Discover the attribute number of the key.
321 if (data->key_name == NULL) {
322 radlog(L_ERR, "rlm_counter: 'key' must be set.");
325 dattr = dict_attrbyname(data->key_name);
327 radlog(L_ERR, "rlm_counter: No such attribute %s",
331 data->key_attr = dattr->attr;
334 * Discover the attribute number of the counter.
336 if (data->count_attribute == NULL) {
337 radlog(L_ERR, "rlm_counter: 'count-attribute' must be set.");
340 dattr = dict_attrbyname(data->count_attribute);
342 radlog(L_ERR, "rlm_counter: No such attribute %s",
343 data->count_attribute);
346 data->count_attr = dattr->attr;
349 * Create a new attribute for the counter.
351 if (data->counter_name == NULL) {
352 radlog(L_ERR, "rlm_counter: 'counter-name' must be set.");
356 memset(&flags, 0, sizeof(flags));
357 dict_addattr(data->counter_name, 0, PW_TYPE_INTEGER, -1, flags);
358 dattr = dict_attrbyname(data->counter_name);
360 radlog(L_ERR, "rlm_counter: Failed to create counter attribute %s",
364 data->dict_attr = dattr->attr;
365 DEBUG2("rlm_counter: Counter attribute %s is number %d",
366 data->counter_name, data->dict_attr);
369 * Create a new attribute for the check item.
371 if (data->check_name == NULL) {
372 radlog(L_ERR, "rlm_counter: 'check-name' must be set.");
375 dict_addattr(data->check_name, 0, PW_TYPE_INTEGER, -1, flags);
376 dattr = dict_attrbyname(data->check_name);
378 radlog(L_ERR, "rlm_counter: Failed to create check attribute %s",
384 * Find the attribute for the allowed protocol
386 if (data->service_type != NULL) {
387 if ((dval = dict_valbyname(PW_SERVICE_TYPE, data->service_type)) == NULL) {
388 radlog(L_ERR, "rlm_counter: Failed to find attribute number for %s",
392 data->service_val = dval->value;
396 * Find when to reset the database.
398 if (data->reset == NULL) {
399 radlog(L_ERR, "rlm_counter: 'reset' must be set.");
403 data->reset_time = 0;
404 data->last_reset = now;
406 if (find_next_reset(data,now) == -1)
409 if (data->filename == NULL) {
410 radlog(L_ERR, "rlm_counter: 'filename' must be set.");
413 data->gdbm = gdbm_open(data->filename, sizeof(int),
414 GDBM_WRCREAT | GDBM_COUNTER_OPTS, 0600, NULL);
415 if (data->gdbm == NULL) {
416 radlog(L_ERR, "rlm_counter: Failed to open file %s: %s",
417 data->filename, strerror(errno));
421 * Look for the DEFAULT1 entry. This entry if it exists contains the
422 * time of the next database reset. This time is set each time we reset
423 * the database. If next_reset < now then we reset the database.
424 * That way we can overcome the problem where radiusd is down during a database
425 * reset time. If we did not keep state information in the database then the reset
426 * would be extended and that would create problems.
428 * We also store the time of the last reset in the DEFAULT2 entry.
430 * If DEFAULT1 and DEFAULT2 do not exist (new database) we add them to the database
433 key_datum.dptr = (const char *)default1;
434 key_datum.dsize = strlen(default1);
436 time_datum = gdbm_fetch(data->gdbm, key_datum);
437 if (time_datum.dptr != NULL){
438 time_t next_reset = 0;
440 memcpy(&next_reset, time_datum.dptr, sizeof(time_t));
441 free(time_datum.dptr);
442 if (next_reset <= now){
444 data->last_reset = now;
445 ret = reset_db(data);
446 if (ret != RLM_MODULE_OK)
450 data->reset_time = next_reset;
451 key_datum.dptr = (const char *)default2;
452 key_datum.dsize = strlen(default2);
454 time_datum = gdbm_fetch(data->gdbm, key_datum);
455 if (time_datum.dptr != NULL){
456 memcpy(&data->last_reset, time_datum.dptr, sizeof(time_t));
457 free(time_datum.dptr);
461 ret = add_defaults(data);
462 if (ret != RLM_MODULE_OK)
466 if (data->fd >= 0) data->fd = gdbm_fdesc(data->gdbm);
468 if (gdbm_setopt(data->gdbm, GDBM_CACHESIZE, &cache_size, sizeof(int)) == -1)
469 radlog(L_ERR, "rlm_counter: Failed to set cache size");
473 * Register the counter comparison operation.
475 paircompare_register(data->dict_attr, 0, counter_cmp, data);
483 * Write accounting information to this modules database.
485 static int counter_accounting(void *instance, REQUEST *request)
487 rlm_counter_t *data = (rlm_counter_t *)instance;
490 VALUE_PAIR *key_vp, *count_vp, *proto_vp;
496 * Before doing anything else, see if we have to reset
499 if (data->reset_time && (data->reset_time <= request->timestamp)) {
502 data->last_reset = data->reset_time;
503 find_next_reset(data,request->timestamp);
504 ret = reset_db(data);
505 if (ret != RLM_MODULE_OK)
509 * Check if we need to watch out for a specific service-type. If yes then check it
511 if (data->service_type != NULL) {
512 if ((proto_vp = pairfind(request->packet->vps, PW_SERVICE_TYPE)) == NULL)
513 return RLM_MODULE_NOOP;
514 if (proto_vp->lvalue != data->service_val)
515 return RLM_MODULE_NOOP;
521 * Look for the key. User-Name is special. It means
522 * The REAL username, after stripping.
524 key_vp = (data->key_attr == PW_USER_NAME) ? request->username : pairfind(request->packet->vps, data->key_attr);
526 return RLM_MODULE_NOOP;
529 * Look for the attribute to use as a counter.
531 count_vp = pairfind(request->packet->vps, data->count_attr);
532 if (count_vp == NULL)
533 return RLM_MODULE_NOOP;
535 key_datum.dptr = key_vp->strvalue;
536 key_datum.dsize = key_vp->length;
538 count_datum = gdbm_fetch(data->gdbm, key_datum);
539 if (count_datum.dptr == NULL)
542 memcpy(&counter, count_datum.dptr, sizeof(int));
543 free(count_datum.dptr);
546 if (count_vp->type == PW_TYPE_DATE) {
548 * If session time < diff then the user got in after the
549 * last reset. So add his session time, otherwise add the
552 * That way if he logged in at 23:00 and we reset the
553 * daily counter at 24:00 and he logged out at 01:00
554 * then we will only count one hour (the one in the new
555 * day). That is the right thing
557 diff = request->timestamp - data->last_reset;
558 counter += (count_vp->lvalue < diff) ? count_vp->lvalue : diff;
560 } else if (count_vp->type == PW_TYPE_INTEGER) {
562 * Integers get counted, without worrying about
565 counter += count_vp->lvalue;
569 * The attribute is NOT an integer, just count once
570 * more that we've seen it.
574 count_datum.dptr = (char *) &counter;
575 count_datum.dsize = sizeof(int);
577 rcode = gdbm_store(data->gdbm, key_datum, count_datum, GDBM_REPLACE);
579 radlog(L_ERR, "rlm_counter: Failed storing data to %s: %s",
580 data->filename, gdbm_strerror(gdbm_errno));
581 return RLM_MODULE_FAIL;
584 return RLM_MODULE_OK;
588 * Find the named user in this modules database. Create the set
589 * of attribute-value pairs to check and reply with for this user
590 * from the database. The authentication code only needs to check
591 * the password, the rest is done here.
593 static int counter_authorize(void *instance, REQUEST *request)
595 rlm_counter_t *data = (rlm_counter_t *) instance;
596 int ret=RLM_MODULE_NOOP;
602 VALUE_PAIR *key_vp, *check_vp;
603 VALUE_PAIR *reply_item;
606 /* quiet the compiler */
611 * Before doing anything else, see if we have to reset
614 if (data->reset_time && (data->reset_time <= request->timestamp)) {
617 data->last_reset = data->reset_time;
618 find_next_reset(data,request->timestamp);
619 ret2 = reset_db(data);
620 if (ret2 != RLM_MODULE_OK)
626 * Look for the key. User-Name is special. It means
627 * The REAL username, after stripping.
629 DEBUG2("rlm_counter: Entering module authorize code");
630 key_vp = (data->key_attr == PW_USER_NAME) ? request->username : pairfind(request->packet->vps, data->key_attr);
631 if (key_vp == NULL) {
632 DEBUG2("rlm_counter: Could not find Key value pair");
637 * Look for the check item
639 if ((dattr = dict_attrbyname(data->check_name)) == NULL) {
642 if ((check_vp= pairfind(request->config_items, dattr->attr)) == NULL) {
643 DEBUG2("rlm_counter: Could not find Check item value pair");
647 key_datum.dptr = key_vp->strvalue;
648 key_datum.dsize = key_vp->length;
650 count_datum = gdbm_fetch(data->gdbm, key_datum);
651 if (count_datum.dptr != NULL){
652 memcpy(&counter, count_datum.dptr, sizeof(int));
653 free(count_datum.dptr);
657 * Check if check item > counter
659 res=check_vp->lvalue - counter;
662 * We are assuming that simultaneous-use=1. But
663 * even if that does not happen then our user
664 * could login at max for 2*max-usage-time Is
669 * User is allowed, but set Session-Timeout.
670 * Stolen from main/auth.c
674 * If we are near a reset then add the next
675 * limit, so that the user will not need to
678 if (data->reset_time && (
679 res >= (data->reset_time - request->timestamp))) {
680 res += check_vp->lvalue;
683 DEBUG2("rlm_counter: (Check item - counter) is greater than zero");
684 if ((reply_item = pairfind(request->reply->vps, PW_SESSION_TIMEOUT)) != NULL) {
685 if (reply_item->lvalue > res)
686 reply_item->lvalue = res;
688 if ((reply_item = paircreate(PW_SESSION_TIMEOUT, PW_TYPE_INTEGER)) == NULL) {
689 radlog(L_ERR|L_CONS, "no memory");
690 return RLM_MODULE_NOOP;
692 reply_item->lvalue = res;
693 pairadd(&request->reply->vps, reply_item);
698 DEBUG2("rlm_counter: Authorized user %s, check_item=%d, counter=%d",
699 key_vp->strvalue,check_vp->lvalue,counter);
700 DEBUG2("rlm_counter: Sent Reply-Item for user %s, Type=Session-Timeout, value=%d",
701 key_vp->strvalue,res);
704 char module_fmsg[MAX_STRING_LEN];
705 VALUE_PAIR *module_fmsg_vp;
708 * User is denied access, send back a reply message
710 sprintf(msg, "Your maximum %s usage time has been reached", data->reset);
711 reply_item=pairmake("Reply-Message", msg, T_OP_EQ);
712 pairadd(&request->reply->vps, reply_item);
714 snprintf(module_fmsg,sizeof(module_fmsg), "rlm_counter: Maximum %s usage time reached", data->reset);
715 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
716 pairadd(&request->packet->vps, module_fmsg_vp);
718 ret=RLM_MODULE_REJECT;
720 DEBUG2("rlm_counter: Rejected user %s, check_item=%d, counter=%d",
721 key_vp->strvalue,check_vp->lvalue,counter);
727 static int counter_detach(void *instance)
729 rlm_counter_t *data = (rlm_counter_t *) instance;
731 paircompare_unregister(data->dict_attr, counter_cmp);
732 gdbm_close(data->gdbm);
733 free(data->filename);
735 free(data->key_name);
736 free(data->count_attribute);
737 free(data->counter_name);
744 * The module name should be the only globally exported symbol.
745 * That is, everything else should be 'static'.
747 * If the module needs to temporarily modify it's instantiation
748 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
749 * The server will then take care of ensuring that the module
750 * is single-threaded.
752 module_t rlm_counter = {
754 RLM_TYPE_THREAD_UNSAFE, /* type */
755 NULL, /* initialization */
756 counter_instantiate, /* instantiation */
758 NULL, /* authentication */
759 counter_authorize, /* authorization */
760 NULL, /* preaccounting */
761 counter_accounting, /* accounting */
762 NULL, /* checksimul */
763 NULL, /* pre-proxy */
764 NULL, /* post-proxy */
767 counter_detach, /* detach */