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. */
81 GDBM_FILE gdbm; /* The gdbm file handle */
82 pthread_mutex_t mutex; /* A mutex to lock the gdbm file for only one reader/writer */
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 (gdbm_setopt(data->gdbm, GDBM_CACHESIZE, &cache_size, sizeof(int)) == -1)
200 radlog(L_ERR, "rlm_counter: Failed to set cache size");
201 DEBUG2("rlm_counter: reset_db: Opened new database");
206 ret = add_defaults(data);
207 if (ret != RLM_MODULE_OK)
210 DEBUG2("rlm_counter: reset_db ended");
212 return RLM_MODULE_OK;
215 static int find_next_reset(rlm_counter_t *data, time_t timeval)
222 tm = localtime_r(&timeval, &s_tm);
223 tm->tm_sec = tm->tm_min = 0;
225 if (data->reset == NULL)
227 if (isdigit((int) data->reset[0])){
230 len = strlen(data->reset);
233 last = data->reset[len - 1];
234 if (!isalpha((int) last))
236 num = atoi(data->reset);
237 DEBUG("rlm_counter: num=%d, last=%c",num,last);
239 if (strcmp(data->reset, "hourly") == 0 || last == 'h') {
241 * Round up to the next nearest hour.
244 data->reset_time = mktime(tm);
245 } else if (strcmp(data->reset, "daily") == 0 || last == 'd') {
247 * Round up to the next nearest day.
251 data->reset_time = mktime(tm);
252 } else if (strcmp(data->reset, "weekly") == 0 || last == 'w') {
254 * Round up to the next nearest week.
257 tm->tm_mday += (7 - tm->tm_wday) +(7*(num-1));
258 data->reset_time = mktime(tm);
259 } else if (strcmp(data->reset, "monthly") == 0 || last == 'm') {
263 data->reset_time = mktime(tm);
264 } else if (strcmp(data->reset, "never") == 0) {
265 data->reset_time = 0;
267 radlog(L_ERR, "rlm_counter: Unknown reset timer \"%s\"",
271 DEBUG2("rlm_counter: Current Time: %d, Next reset %d",
272 (int)timeval,(int)data->reset_time);
279 * Do any per-module initialization that is separate to each
280 * configured instance of the module. e.g. set up connections
281 * to external databases, read configuration files, set up
282 * dictionary entries, etc.
284 * If configuration information is given in the config section
285 * that must be referenced in later calls, store a handle to it
286 * in *instance otherwise put a null pointer there.
288 static int counter_instantiate(CONF_SECTION *conf, void **instance)
299 const char *default1 = "DEFAULT1";
300 const char *default2 = "DEFAULT2";
303 * Set up a storage area for instance data
305 data = rad_malloc(sizeof(*data));
308 * If the configuration parameters can't be parsed, then
311 if (cf_section_parse(conf, data, module_config) < 0) {
315 cache_size = data->cache_size;
318 * Discover the attribute number of the key.
320 if (data->key_name == NULL) {
321 radlog(L_ERR, "rlm_counter: 'key' must be set.");
324 dattr = dict_attrbyname(data->key_name);
326 radlog(L_ERR, "rlm_counter: No such attribute %s",
330 data->key_attr = dattr->attr;
333 * Discover the attribute number of the counter.
335 if (data->count_attribute == NULL) {
336 radlog(L_ERR, "rlm_counter: 'count-attribute' must be set.");
339 dattr = dict_attrbyname(data->count_attribute);
341 radlog(L_ERR, "rlm_counter: No such attribute %s",
342 data->count_attribute);
345 data->count_attr = dattr->attr;
348 * Create a new attribute for the counter.
350 if (data->counter_name == NULL) {
351 radlog(L_ERR, "rlm_counter: 'counter-name' must be set.");
355 memset(&flags, 0, sizeof(flags));
356 dict_addattr(data->counter_name, 0, PW_TYPE_INTEGER, -1, flags);
357 dattr = dict_attrbyname(data->counter_name);
359 radlog(L_ERR, "rlm_counter: Failed to create counter attribute %s",
363 data->dict_attr = dattr->attr;
364 DEBUG2("rlm_counter: Counter attribute %s is number %d",
365 data->counter_name, data->dict_attr);
368 * Create a new attribute for the check item.
370 if (data->check_name == NULL) {
371 radlog(L_ERR, "rlm_counter: 'check-name' must be set.");
374 dict_addattr(data->check_name, 0, PW_TYPE_INTEGER, -1, flags);
375 dattr = dict_attrbyname(data->check_name);
377 radlog(L_ERR, "rlm_counter: Failed to create check attribute %s",
383 * Find the attribute for the allowed protocol
385 if (data->service_type != NULL) {
386 if ((dval = dict_valbyname(PW_SERVICE_TYPE, data->service_type)) == NULL) {
387 radlog(L_ERR, "rlm_counter: Failed to find attribute number for %s",
391 data->service_val = dval->value;
395 * Find when to reset the database.
397 if (data->reset == NULL) {
398 radlog(L_ERR, "rlm_counter: 'reset' must be set.");
402 data->reset_time = 0;
403 data->last_reset = now;
405 if (find_next_reset(data,now) == -1)
408 if (data->filename == NULL) {
409 radlog(L_ERR, "rlm_counter: 'filename' must be set.");
412 data->gdbm = gdbm_open(data->filename, sizeof(int),
413 GDBM_WRCREAT | GDBM_COUNTER_OPTS, 0600, NULL);
414 if (data->gdbm == NULL) {
415 radlog(L_ERR, "rlm_counter: Failed to open file %s: %s",
416 data->filename, strerror(errno));
419 if (gdbm_setopt(data->gdbm, GDBM_CACHESIZE, &cache_size, sizeof(int)) == -1)
420 radlog(L_ERR, "rlm_counter: Failed to set cache size");
423 * Look for the DEFAULT1 entry. This entry if it exists contains the
424 * time of the next database reset. This time is set each time we reset
425 * the database. If next_reset < now then we reset the database.
426 * That way we can overcome the problem where radiusd is down during a database
427 * reset time. If we did not keep state information in the database then the reset
428 * would be extended and that would create problems.
430 * We also store the time of the last reset in the DEFAULT2 entry.
432 * If DEFAULT1 and DEFAULT2 do not exist (new database) we add them to the database
435 key_datum.dptr = (const char *)default1;
436 key_datum.dsize = strlen(default1);
438 time_datum = gdbm_fetch(data->gdbm, key_datum);
439 if (time_datum.dptr != NULL){
440 time_t next_reset = 0;
442 memcpy(&next_reset, time_datum.dptr, sizeof(time_t));
443 free(time_datum.dptr);
444 if (next_reset <= now){
446 data->last_reset = now;
447 ret = reset_db(data);
448 if (ret != RLM_MODULE_OK)
452 data->reset_time = next_reset;
453 key_datum.dptr = (const char *)default2;
454 key_datum.dsize = strlen(default2);
456 time_datum = gdbm_fetch(data->gdbm, key_datum);
457 if (time_datum.dptr != NULL){
458 memcpy(&data->last_reset, time_datum.dptr, sizeof(time_t));
459 free(time_datum.dptr);
463 ret = add_defaults(data);
464 if (ret != RLM_MODULE_OK)
470 * Register the counter comparison operation.
472 paircompare_register(data->dict_attr, 0, counter_cmp, data);
477 pthread_mutex_init(&data->mutex, NULL);
485 * Write accounting information to this modules database.
487 static int counter_accounting(void *instance, REQUEST *request)
489 rlm_counter_t *data = (rlm_counter_t *)instance;
492 VALUE_PAIR *key_vp, *count_vp, *proto_vp;
498 * Before doing anything else, see if we have to reset
501 if (data->reset_time && (data->reset_time <= request->timestamp)) {
504 data->last_reset = data->reset_time;
505 find_next_reset(data,request->timestamp);
506 pthread_mutex_lock(&data->mutex);
507 ret = reset_db(data);
508 pthread_mutex_unlock(&data->mutex);
509 if (ret != RLM_MODULE_OK)
513 * Check if we need to watch out for a specific service-type. If yes then check it
515 if (data->service_type != NULL) {
516 if ((proto_vp = pairfind(request->packet->vps, PW_SERVICE_TYPE)) == NULL)
517 return RLM_MODULE_NOOP;
518 if (proto_vp->lvalue != data->service_val)
519 return RLM_MODULE_NOOP;
525 * Look for the key. User-Name is special. It means
526 * The REAL username, after stripping.
528 key_vp = (data->key_attr == PW_USER_NAME) ? request->username : pairfind(request->packet->vps, data->key_attr);
530 return RLM_MODULE_NOOP;
533 * Look for the attribute to use as a counter.
535 count_vp = pairfind(request->packet->vps, data->count_attr);
536 if (count_vp == NULL)
537 return RLM_MODULE_NOOP;
539 key_datum.dptr = key_vp->strvalue;
540 key_datum.dsize = key_vp->length;
542 pthread_mutex_lock(&data->mutex);
543 count_datum = gdbm_fetch(data->gdbm, key_datum);
544 pthread_mutex_unlock(&data->mutex);
545 if (count_datum.dptr == NULL)
548 memcpy(&counter, count_datum.dptr, sizeof(int));
549 free(count_datum.dptr);
552 if (count_vp->type == PW_TYPE_DATE) {
554 * If session time < diff then the user got in after the
555 * last reset. So add his session time, otherwise add the
558 * That way if he logged in at 23:00 and we reset the
559 * daily counter at 24:00 and he logged out at 01:00
560 * then we will only count one hour (the one in the new
561 * day). That is the right thing
563 diff = request->timestamp - data->last_reset;
564 counter += (count_vp->lvalue < diff) ? count_vp->lvalue : diff;
566 } else if (count_vp->type == PW_TYPE_INTEGER) {
568 * Integers get counted, without worrying about
571 counter += count_vp->lvalue;
575 * The attribute is NOT an integer, just count once
576 * more that we've seen it.
580 count_datum.dptr = (char *) &counter;
581 count_datum.dsize = sizeof(int);
583 pthread_mutex_lock(&data->mutex);
584 rcode = gdbm_store(data->gdbm, key_datum, count_datum, GDBM_REPLACE);
585 pthread_mutex_unlock(&data->mutex);
587 radlog(L_ERR, "rlm_counter: Failed storing data to %s: %s",
588 data->filename, gdbm_strerror(gdbm_errno));
589 return RLM_MODULE_FAIL;
592 return RLM_MODULE_OK;
596 * Find the named user in this modules database. Create the set
597 * of attribute-value pairs to check and reply with for this user
598 * from the database. The authentication code only needs to check
599 * the password, the rest is done here.
601 static int counter_authorize(void *instance, REQUEST *request)
603 rlm_counter_t *data = (rlm_counter_t *) instance;
604 int ret=RLM_MODULE_NOOP;
610 VALUE_PAIR *key_vp, *check_vp;
611 VALUE_PAIR *reply_item;
614 /* quiet the compiler */
619 * Before doing anything else, see if we have to reset
622 if (data->reset_time && (data->reset_time <= request->timestamp)) {
625 data->last_reset = data->reset_time;
626 find_next_reset(data,request->timestamp);
627 pthread_mutex_lock(&data->mutex);
628 ret2 = reset_db(data);
629 pthread_mutex_unlock(&data->mutex);
630 if (ret2 != RLM_MODULE_OK)
636 * Look for the key. User-Name is special. It means
637 * The REAL username, after stripping.
639 DEBUG2("rlm_counter: Entering module authorize code");
640 key_vp = (data->key_attr == PW_USER_NAME) ? request->username : pairfind(request->packet->vps, data->key_attr);
641 if (key_vp == NULL) {
642 DEBUG2("rlm_counter: Could not find Key value pair");
647 * Look for the check item
649 if ((dattr = dict_attrbyname(data->check_name)) == NULL) {
652 if ((check_vp= pairfind(request->config_items, dattr->attr)) == NULL) {
653 DEBUG2("rlm_counter: Could not find Check item value pair");
657 key_datum.dptr = key_vp->strvalue;
658 key_datum.dsize = key_vp->length;
660 pthread_mutex_lock(&data->mutex);
661 count_datum = gdbm_fetch(data->gdbm, key_datum);
662 pthread_mutex_unlock(&data->mutex);
663 if (count_datum.dptr != NULL){
664 memcpy(&counter, count_datum.dptr, sizeof(int));
665 free(count_datum.dptr);
669 * Check if check item > counter
671 res=check_vp->lvalue - counter;
674 * We are assuming that simultaneous-use=1. But
675 * even if that does not happen then our user
676 * could login at max for 2*max-usage-time Is
681 * User is allowed, but set Session-Timeout.
682 * Stolen from main/auth.c
686 * If we are near a reset then add the next
687 * limit, so that the user will not need to
690 if (data->reset_time && (
691 res >= (data->reset_time - request->timestamp))) {
692 res += check_vp->lvalue;
695 DEBUG2("rlm_counter: (Check item - counter) is greater than zero");
696 if ((reply_item = pairfind(request->reply->vps, PW_SESSION_TIMEOUT)) != NULL) {
697 if (reply_item->lvalue > res)
698 reply_item->lvalue = res;
700 if ((reply_item = paircreate(PW_SESSION_TIMEOUT, PW_TYPE_INTEGER)) == NULL) {
701 radlog(L_ERR|L_CONS, "no memory");
702 return RLM_MODULE_NOOP;
704 reply_item->lvalue = res;
705 pairadd(&request->reply->vps, reply_item);
710 DEBUG2("rlm_counter: Authorized user %s, check_item=%d, counter=%d",
711 key_vp->strvalue,check_vp->lvalue,counter);
712 DEBUG2("rlm_counter: Sent Reply-Item for user %s, Type=Session-Timeout, value=%d",
713 key_vp->strvalue,res);
716 char module_fmsg[MAX_STRING_LEN];
717 VALUE_PAIR *module_fmsg_vp;
720 * User is denied access, send back a reply message
722 sprintf(msg, "Your maximum %s usage time has been reached", data->reset);
723 reply_item=pairmake("Reply-Message", msg, T_OP_EQ);
724 pairadd(&request->reply->vps, reply_item);
726 snprintf(module_fmsg,sizeof(module_fmsg), "rlm_counter: Maximum %s usage time reached", data->reset);
727 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
728 pairadd(&request->packet->vps, module_fmsg_vp);
730 ret=RLM_MODULE_REJECT;
732 DEBUG2("rlm_counter: Rejected user %s, check_item=%d, counter=%d",
733 key_vp->strvalue,check_vp->lvalue,counter);
739 static int counter_detach(void *instance)
741 rlm_counter_t *data = (rlm_counter_t *) instance;
743 paircompare_unregister(data->dict_attr, counter_cmp);
744 gdbm_close(data->gdbm);
745 free(data->filename);
747 free(data->key_name);
748 free(data->count_attribute);
749 free(data->counter_name);
750 pthread_mutex_destroy(&data->mutex);
757 * The module name should be the only globally exported symbol.
758 * That is, everything else should be 'static'.
760 * If the module needs to temporarily modify it's instantiation
761 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
762 * The server will then take care of ensuring that the module
763 * is single-threaded.
765 module_t rlm_counter = {
767 RLM_TYPE_THREAD_SAFE, /* type */
768 NULL, /* initialization */
769 counter_instantiate, /* instantiation */
771 NULL, /* authentication */
772 counter_authorize, /* authorization */
773 NULL, /* preaccounting */
774 counter_accounting, /* accounting */
775 NULL, /* checksimul */
776 NULL, /* pre-proxy */
777 NULL, /* post-proxy */
780 counter_detach, /* detach */