src/modules/rlm_counter/rlm_counter.c

   1 /*
   2  * rlm_counter.c
   3  *
   4  * Version:  $Id$
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Copyright 2001  The FreeRADIUS server project
  21  * Copyright 2001  Alan DeKok <aland@ox.org>
  22  * Copyright 2001-3  Kostas Kalevras <kkalev@noc.ntua.gr>
  23  */
  24
  25 #include "config.h"
  26 #include "autoconf.h"
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <ctype.h>
  32
  33 #include "radiusd.h"
  34 #include "modules.h"
  35 #include "conffile.h"
  36
  37 #include <gdbm.h>
  38 #include <time.h>
  39
  40 #ifdef NEEDS_GDBM_SYNC
  41 #       define GDBM_SYNCOPT GDBM_SYNC
  42 #else
  43 #       define GDBM_SYNCOPT 0
  44 #endif
  45
  46 #ifdef GDBM_NOLOCK
  47 #define GDBM_COUNTER_OPTS (GDBM_SYNCOPT | GDBM_NOLOCK)
  48 #else
  49 #define GDBM_COUNTER_OPTS (GDBM_SYNCOPT)
  50 #endif
  51
  52 #ifndef HAVE_GDBM_FDESC
  53 #define gdbm_fdesc(foo) (-1)
  54 #endif
  55
  56 #define UNIQUEID_MAX_LEN 32
  57
  58 static const char rcsid[] = "$Id$";
  59
  60 /*
  61  *      Define a structure for our module configuration.
  62  *
  63  *      These variables do not need to be in a structure, but it's
  64  *      a lot cleaner to do so, and a pointer to the structure can
  65  *      be used as the instance handle.
  66  */
  67 typedef struct rlm_counter_t {
  68         char *filename;         /* name of the database file */
  69         char *reset;            /* daily, weekly, monthly, never or user defined */
  70         char *key_name;         /* User-Name */
  71         char *count_attribute;  /* Acct-Session-Time */
  72         char *return_attribute; /* Session-Timeout */
  73         char *counter_name;     /* Daily-Session-Time */
  74         char *check_name;       /* Daily-Max-Session */
  75         char *service_type;     /* Service-Type to search for */
  76         int cache_size;
  77         int service_val;
  78         int key_attr;
  79         int count_attr;
  80         int return_attr;
  81         int check_attr;
  82         time_t reset_time;      /* The time of the next reset. */
  83         time_t last_reset;      /* The time of the last reset. */
  84         int dict_attr;          /* attribute number for the counter. */
  85         GDBM_FILE gdbm;         /* The gdbm file handle */
  86 #ifdef HAVE_PTHREAD_H
  87         pthread_mutex_t mutex;  /* A mutex to lock the gdbm file for only one reader/writer */
  88 #endif
  89 } rlm_counter_t;
  90
  91 #ifndef HAVE_PTHREAD_H
  92 /*
  93  *      This is a lot simpler than putting ifdef's around
  94  *      every use of the pthread functions.
  95  */
  96 #define pthread_mutex_lock(a)
  97 #define pthread_mutex_unlock(a)
  98 #define pthread_mutex_init(a,b)
  99 #define pthread_mutex_destroy(a)
 100 #endif
 101
 102 typedef struct rad_counter {
 103         unsigned int user_counter;
 104         char uniqueid[UNIQUEID_MAX_LEN];
 105 } rad_counter;
 106
 107 /*
 108  *      A mapping of configuration file names to internal variables.
 109  *
 110  *      Note that the string is dynamically allocated, so it MUST
 111  *      be freed.  When the configuration file parse re-reads the string,
 112  *      it free's the old one, and strdup's the new one, placing the pointer
 113  *      to the strdup'd string into 'config.string'.  This gets around
 114  *      buffer over-flows.
 115  */
 116 static const CONF_PARSER module_config[] = {
 117   { "filename", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,filename), NULL, NULL },
 118   { "key", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,key_name), NULL, NULL },
 119   { "reset", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,reset), NULL,  NULL },
 120   { "count-attribute", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,count_attribute), NULL, NULL },
 121   { "return-attribute", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,return_attribute), NULL, NULL },
 122   { "counter-name", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,counter_name), NULL,  NULL },
 123   { "check-name", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,check_name), NULL, NULL },
 124   { "allowed-servicetype", PW_TYPE_STRING_PTR, offsetof(rlm_counter_t,service_type),NULL, NULL },
 125   { "cache-size", PW_TYPE_INTEGER, offsetof(rlm_counter_t,cache_size), NULL, "1000" },
 126   { NULL, -1, 0, NULL, NULL }
 127 };
 128
 129 static int counter_detach(void *instance);
 130
 131
 132 /*
 133  *      See if the counter matches.
 134  */
 135 static int counter_cmp(void *instance,
 136                        REQUEST *req UNUSED,
 137                        VALUE_PAIR *request, VALUE_PAIR *check,
 138                        VALUE_PAIR *check_pairs, VALUE_PAIR **reply_pairs)
 139 {
 140         rlm_counter_t *data = (rlm_counter_t *) instance;
 141         datum key_datum;
 142         datum count_datum;
 143         VALUE_PAIR *key_vp;
 144         rad_counter counter;
 145
 146         check_pairs = check_pairs; /* shut the compiler up */
 147         reply_pairs = reply_pairs;
 148         req = req;
 149
 150         /*
 151          *      Find the key attribute.
 152          */
 153         key_vp = pairfind(request, data->key_attr);
 154         if (key_vp == NULL) {
 155                 return RLM_MODULE_NOOP;
 156         }
 157
 158         key_datum.dptr = key_vp->strvalue;
 159         key_datum.dsize = key_vp->length;
 160
 161         count_datum = gdbm_fetch(data->gdbm, key_datum);
 162
 163         if (count_datum.dptr == NULL) {
 164                 return -1;
 165         }
 166         memcpy(&counter, count_datum.dptr, sizeof(rad_counter));
 167         free(count_datum.dptr);
 168
 169         return counter.user_counter - check->lvalue;
 170 }
 171
 172
 173 static int add_defaults(rlm_counter_t *data)
 174 {
 175         datum key_datum;
 176         datum time_datum;
 177         const char *default1 = "DEFAULT1";
 178         const char *default2 = "DEFAULT2";
 179
 180         DEBUG2("rlm_counter: add_defaults: Start");
 181
 182         key_datum.dptr = (char *) default1;
 183         key_datum.dsize = strlen(default1);
 184         time_datum.dptr = (char *) &data->reset_time;
 185         time_datum.dsize = sizeof(time_t);
 186
 187         if (gdbm_store(data->gdbm, key_datum, time_datum, GDBM_REPLACE) < 0){
 188                 radlog(L_ERR, "rlm_counter: Failed storing data to %s: %s",
 189                                 data->filename, gdbm_strerror(gdbm_errno));
 190                 return RLM_MODULE_FAIL;
 191         }
 192         DEBUG2("rlm_counter: DEFAULT1 set to %d",(int)data->reset_time);
 193
 194         key_datum.dptr = (char *) default2;
 195         key_datum.dsize = strlen(default2);
 196         time_datum.dptr = (char *) &data->last_reset;
 197         time_datum.dsize = sizeof(time_t);
 198
 199         if (gdbm_store(data->gdbm, key_datum, time_datum, GDBM_REPLACE) < 0){
 200                 radlog(L_ERR, "rlm_counter: Failed storing data to %s: %s",
 201                                 data->filename, gdbm_strerror(gdbm_errno));
 202                 return RLM_MODULE_FAIL;
 203         }
 204         DEBUG2("rlm_counter: DEFAULT2 set to %d",(int)data->last_reset);
 205         DEBUG2("rlm_counter: add_defaults: End");
 206
 207         return RLM_MODULE_OK;
 208 }
 209
 210 static int reset_db(rlm_counter_t *data)
 211 {
 212         int cache_size = data->cache_size;
 213         int ret;
 214
 215         DEBUG2("rlm_counter: reset_db: Closing database");
 216         gdbm_close(data->gdbm);
 217
 218         /*
 219          *      Open a completely new database.
 220          */
 221         data->gdbm = gdbm_open(data->filename, sizeof(int),
 222                         GDBM_NEWDB | GDBM_COUNTER_OPTS, 0600, NULL);
 223         if (data->gdbm == NULL) {
 224                 radlog(L_ERR, "rlm_counter: Failed to open file %s: %s",
 225                                 data->filename, strerror(errno));
 226                 return RLM_MODULE_FAIL;
 227         }
 228         if (gdbm_setopt(data->gdbm, GDBM_CACHESIZE, &cache_size, sizeof(int)) == -1)
 229                 radlog(L_ERR, "rlm_counter: Failed to set cache size");
 230         DEBUG2("rlm_counter: reset_db: Opened new database");
 231
 232         /*
 233          * Add defaults
 234          */
 235         ret = add_defaults(data);
 236         if (ret != RLM_MODULE_OK)
 237                 return ret;
 238
 239         DEBUG2("rlm_counter: reset_db ended");
 240
 241         return RLM_MODULE_OK;
 242 }
 243
 244 static int find_next_reset(rlm_counter_t *data, time_t timeval)
 245 {
 246         int ret=0;
 247         unsigned int num=1;
 248         char last = 0;
 249         struct tm *tm, s_tm;
 250         char sCurrentTime[40], sNextTime[40];
 251
 252         tm = localtime_r(&timeval, &s_tm);
 253         strftime(sCurrentTime, sizeof(sCurrentTime),"%Y-%m-%d %H:%M:%S",tm);
 254         tm->tm_sec = tm->tm_min = 0;
 255
 256         if (data->reset == NULL)
 257                 return -1;
 258         if (isdigit((int) data->reset[0])){
 259                 unsigned int len=0;
 260
 261                 len = strlen(data->reset);
 262                 if (len == 0)
 263                         return -1;
 264                 last = data->reset[len - 1];
 265                 if (!isalpha((int) last))
 266                         last = 'd';
 267                 num = atoi(data->reset);
 268                 DEBUG("rlm_counter: num=%d, last=%c",num,last);
 269         }
 270         if (strcmp(data->reset, "hourly") == 0 || last == 'h') {
 271                 /*
 272                  *  Round up to the next nearest hour.
 273                  */
 274                 tm->tm_hour += num;
 275                 data->reset_time = mktime(tm);
 276         } else if (strcmp(data->reset, "daily") == 0 || last == 'd') {
 277                 /*
 278                  *  Round up to the next nearest day.
 279                  */
 280                 tm->tm_hour = 0;
 281                 tm->tm_mday += num;
 282                 data->reset_time = mktime(tm);
 283         } else if (strcmp(data->reset, "weekly") == 0 || last == 'w') {
 284                 /*
 285                  *  Round up to the next nearest week.
 286                  */
 287                 tm->tm_hour = 0;
 288                 tm->tm_mday += (7 - tm->tm_wday) +(7*(num-1));
 289                 data->reset_time = mktime(tm);
 290         } else if (strcmp(data->reset, "monthly") == 0 || last == 'm') {
 291                 tm->tm_hour = 0;
 292                 tm->tm_mday = 1;
 293                 tm->tm_mon += num;
 294                 data->reset_time = mktime(tm);
 295         } else if (strcmp(data->reset, "never") == 0) {
 296                 data->reset_time = 0;
 297         } else {
 298                 radlog(L_ERR, "rlm_counter: Unknown reset timer \"%s\"",
 299                         data->reset);
 300                 return -1;
 301         }
 302         strftime(sNextTime, sizeof(sNextTime),"%Y-%m-%d %H:%M:%S",tm);
 303         DEBUG2("rlm_counter: Current Time: %d [%s], Next reset %d [%s]",
 304                 (int)timeval,sCurrentTime,(int)data->reset_time,sNextTime);
 305
 306         return ret;
 307 }
 308
 309
 310 /*
 311  *      Do any per-module initialization that is separate to each
 312  *      configured instance of the module.  e.g. set up connections
 313  *      to external databases, read configuration files, set up
 314  *      dictionary entries, etc.
 315  *
 316  *      If configuration information is given in the config section
 317  *      that must be referenced in later calls, store a handle to it
 318  *      in *instance otherwise put a null pointer there.
 319  */
 320 static int counter_instantiate(CONF_SECTION *conf, void **instance)
 321 {
 322         rlm_counter_t *data;
 323         DICT_ATTR *dattr;
 324         DICT_VALUE *dval;
 325         ATTR_FLAGS flags;
 326         time_t now;
 327         int cache_size;
 328         int ret;
 329         datum key_datum;
 330         datum time_datum;
 331         const char *default1 = "DEFAULT1";
 332         const char *default2 = "DEFAULT2";
 333
 334         /*
 335          *      Set up a storage area for instance data
 336          */
 337         data = rad_malloc(sizeof(*data));
 338         if (!data) {
 339                 radlog(L_ERR, "rlm_counter: rad_malloc() failed.");
 340                 return -1;
 341         }
 342         memset(data, 0, sizeof(*data));
 343
 344         /*
 345          *      If the configuration parameters can't be parsed, then
 346          *      fail.
 347          */
 348         if (cf_section_parse(conf, data, module_config) < 0) {
 349                 free(data);
 350                 return -1;
 351         }
 352         cache_size = data->cache_size;
 353
 354         /*
 355          *      Discover the attribute number of the key.
 356          */
 357         if (data->key_name == NULL) {
 358                 radlog(L_ERR, "rlm_counter: 'key' must be set.");
 359                 counter_detach(data);
 360                 return -1;
 361         }
 362         dattr = dict_attrbyname(data->key_name);
 363         if (dattr == NULL) {
 364                 radlog(L_ERR, "rlm_counter: No such attribute %s",
 365                                 data->key_name);
 366                 counter_detach(data);
 367                 return -1;
 368         }
 369         data->key_attr = dattr->attr;
 370
 371         /*
 372          *      Discover the attribute number of the counter.
 373          */
 374         if (data->count_attribute == NULL) {
 375                 radlog(L_ERR, "rlm_counter: 'count-attribute' must be set.");
 376                 counter_detach(data);
 377                 return -1;
 378         }
 379         dattr = dict_attrbyname(data->count_attribute);
 380         if (dattr == NULL) {
 381                 radlog(L_ERR, "rlm_counter: No such attribute %s",
 382                                 data->count_attribute);
 383                 counter_detach(data);
 384                 return -1;
 385         }
 386         data->count_attr = dattr->attr;
 387
 388         /*
 389          * Discover the attribute number of the return attribute.
 390          */
 391         if (data->return_attribute != NULL) {
 392                 dattr = dict_attrbyname(data->return_attribute);
 393                 if (dattr == NULL) {
 394                         radlog(L_ERR, "rlm_counter: No such attribute %s",
 395                                         data->return_attribute);
 396                         counter_detach(data);
 397                         return -1;
 398                 }
 399                 if (dattr->type != PW_TYPE_INTEGER) {
 400                         radlog(L_ERR, "rlm_counter: Return attribute %s is not of type integer",
 401                                 data->return_attribute);
 402                         counter_detach(data);
 403                         return -1;
 404                 }
 405                 data->return_attr = dattr->attr;
 406         }
 407
 408
 409         /*
 410          *  Create a new attribute for the counter.
 411          */
 412         if (data->counter_name == NULL) {
 413                 radlog(L_ERR, "rlm_counter: 'counter-name' must be set.");
 414                 counter_detach(data);
 415                 return -1;
 416         }
 417
 418         memset(&flags, 0, sizeof(flags));
 419         dict_addattr(data->counter_name, 0, PW_TYPE_INTEGER, -1, flags);
 420         dattr = dict_attrbyname(data->counter_name);
 421         if (dattr == NULL) {
 422                 radlog(L_ERR, "rlm_counter: Failed to create counter attribute %s",
 423                                 data->counter_name);
 424                 counter_detach(data);
 425                 return -1;
 426         }
 427         data->dict_attr = dattr->attr;
 428         DEBUG2("rlm_counter: Counter attribute %s is number %d",
 429                         data->counter_name, data->dict_attr);
 430
 431         /*
 432          * Create a new attribute for the check item.
 433          */
 434         if (data->check_name == NULL) {
 435                 radlog(L_ERR, "rlm_counter: 'check-name' must be set.");
 436                 counter_detach(data);
 437                 return -1;
 438         }
 439         dict_addattr(data->check_name, 0, PW_TYPE_INTEGER, -1, flags);
 440         dattr = dict_attrbyname(data->check_name);
 441         if (dattr == NULL) {
 442                 radlog(L_ERR, "rlm_counter: Failed to create check attribute %s",
 443                                 data->counter_name);
 444                 counter_detach(data);
 445                 return -1;
 446         }
 447         data->check_attr = dattr->attr;
 448
 449         /*
 450          * Find the attribute for the allowed protocol
 451          */
 452         if (data->service_type != NULL) {
 453                 if ((dval = dict_valbyname(PW_SERVICE_TYPE, data->service_type)) == NULL) {
 454                         radlog(L_ERR, "rlm_counter: Failed to find attribute number for %s",
 455                                         data->service_type);
 456                         counter_detach(data);
 457                         return -1;
 458                 }
 459                 data->service_val = dval->value;
 460         }
 461
 462         /*
 463          * Find when to reset the database.
 464          */
 465         if (data->reset == NULL) {
 466                 radlog(L_ERR, "rlm_counter: 'reset' must be set.");
 467                 counter_detach(data);
 468                 return -1;
 469         }
 470         now = time(NULL);
 471         data->reset_time = 0;
 472         data->last_reset = now;
 473
 474         if (find_next_reset(data,now) == -1){
 475                 radlog(L_ERR, "rlm_counter: find_next_reset() returned -1. Exiting.");
 476                 counter_detach(data);
 477                 return -1;
 478         }
 479
 480         if (data->filename == NULL) {
 481                 radlog(L_ERR, "rlm_counter: 'filename' must be set.");
 482                 counter_detach(data);
 483                 return -1;
 484         }
 485         data->gdbm = gdbm_open(data->filename, sizeof(int),
 486                         GDBM_WRCREAT | GDBM_COUNTER_OPTS, 0600, NULL);
 487         if (data->gdbm == NULL) {
 488                 radlog(L_ERR, "rlm_counter: Failed to open file %s: %s",
 489                                 data->filename, strerror(errno));
 490                 counter_detach(data);
 491                 return -1;
 492         }
 493         if (gdbm_setopt(data->gdbm, GDBM_CACHESIZE, &cache_size, sizeof(int)) == -1)
 494                 radlog(L_ERR, "rlm_counter: Failed to set cache size");
 495
 496         /*
 497          * Look for the DEFAULT1 entry. This entry if it exists contains the
 498          * time of the next database reset. This time is set each time we reset
 499          * the database. If next_reset < now then we reset the database.
 500          * That way we can overcome the problem where radiusd is down during a database
 501          * reset time. If we did not keep state information in the database then the reset
 502          * would be extended and that would create problems.
 503          *
 504          * We also store the time of the last reset in the DEFAULT2 entry.
 505          *
 506          * If DEFAULT1 and DEFAULT2 do not exist (new database) we add them to the database
 507          */
 508
 509         key_datum.dptr = (char *)default1;
 510         key_datum.dsize = strlen(default1);
 511
 512         time_datum = gdbm_fetch(data->gdbm, key_datum);
 513         if (time_datum.dptr != NULL){
 514                 time_t next_reset = 0;
 515
 516                 memcpy(&next_reset, time_datum.dptr, sizeof(time_t));
 517                 free(time_datum.dptr);
 518                 if (next_reset && next_reset <= now){
 519
 520                         data->last_reset = now;
 521                         ret = reset_db(data);
 522                         if (ret != RLM_MODULE_OK){
 523                                 radlog(L_ERR, "rlm_counter: reset_db() failed");
 524                                 counter_detach(data);
 525                                 return -1;
 526                         }
 527                 }
 528                 else
 529                         data->reset_time = next_reset;
 530                 key_datum.dptr = (char *)default2;
 531                 key_datum.dsize = strlen(default2);
 532
 533                 time_datum = gdbm_fetch(data->gdbm, key_datum);
 534                 if (time_datum.dptr != NULL){
 535                         memcpy(&data->last_reset, time_datum.dptr, sizeof(time_t));
 536                         free(time_datum.dptr);
 537                 }
 538         }
 539         else{
 540                 ret = add_defaults(data);
 541                 if (ret != RLM_MODULE_OK){
 542                         radlog(L_ERR, "rlm_counter: add_defaults() failed");
 543                         counter_detach(data);
 544                         return -1;
 545                 }
 546         }
 547
 548
 549         /*
 550          *      Register the counter comparison operation.
 551          */
 552         paircompare_register(data->dict_attr, 0, counter_cmp, data);
 553
 554         /*
 555          * Init the mutex
 556          */
 557         pthread_mutex_init(&data->mutex, NULL);
 558
 559         *instance = data;
 560
 561         return 0;
 562 }
 563
 564 /*
 565  *      Write accounting information to this modules database.
 566  */
 567 static int counter_accounting(void *instance, REQUEST *request)
 568 {
 569         rlm_counter_t *data = (rlm_counter_t *)instance;
 570         datum key_datum;
 571         datum count_datum;
 572         VALUE_PAIR *key_vp, *count_vp, *proto_vp, *uniqueid_vp;
 573         rad_counter counter;
 574         int rcode;
 575         int acctstatustype = 0;
 576         time_t diff;
 577
 578         if ((key_vp = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE)) != NULL)
 579                 acctstatustype = key_vp->lvalue;
 580         else {
 581                 DEBUG("rlm_counter: Could not find account status type in packet.");
 582                 return RLM_MODULE_NOOP;
 583         }
 584         if (acctstatustype != PW_STATUS_STOP){
 585                 DEBUG("rlm_counter: We only run on Accounting-Stop packets.");
 586                 return RLM_MODULE_NOOP;
 587         }
 588         uniqueid_vp = pairfind(request->packet->vps, PW_ACCT_UNIQUE_SESSION_ID);
 589         if (uniqueid_vp != NULL)
 590                 DEBUG("rlm_counter: Packet Unique ID = '%s'",uniqueid_vp->strvalue);
 591
 592         /*
 593          *      Before doing anything else, see if we have to reset
 594          *      the counters.
 595          */
 596         if (data->reset_time && (data->reset_time <= request->timestamp)) {
 597                 int ret;
 598
 599                 DEBUG("rlm_counter: Time to reset the database.");
 600                 data->last_reset = data->reset_time;
 601                 find_next_reset(data,request->timestamp);
 602                 pthread_mutex_lock(&data->mutex);
 603                 ret = reset_db(data);
 604                 pthread_mutex_unlock(&data->mutex);
 605                 if (ret != RLM_MODULE_OK)
 606                         return ret;
 607         }
 608         /*
 609          * Check if we need to watch out for a specific service-type. If yes then check it
 610          */
 611         if (data->service_type != NULL) {
 612                 if ((proto_vp = pairfind(request->packet->vps, PW_SERVICE_TYPE)) == NULL){
 613                         DEBUG("rlm_counter: Could not find Service-Type attribute in the request. Returning NOOP.");
 614                         return RLM_MODULE_NOOP;
 615                 }
 616                 if ((unsigned)proto_vp->lvalue != data->service_val){
 617                         DEBUG("rlm_counter: This Service-Type is not allowed. Returning NOOP.");
 618                         return RLM_MODULE_NOOP;
 619                 }
 620         }
 621         /*
 622          * Check if request->timestamp - {Acct-Delay-Time} < last_reset
 623          * If yes reject the packet since it is very old
 624          */
 625         key_vp = pairfind(request->packet->vps, PW_ACCT_DELAY_TIME);
 626         if (key_vp != NULL){
 627                 if (key_vp->lvalue != 0 &&
 628                     (request->timestamp - key_vp->lvalue) < data->last_reset){
 629                         DEBUG("rlm_counter: This packet is too old. Returning NOOP.");
 630                         return RLM_MODULE_NOOP;
 631                 }
 632         }
 633
 634
 635
 636         /*
 637          *      Look for the key.  User-Name is special.  It means
 638          *      The REAL username, after stripping.
 639          */
 640         key_vp = (data->key_attr == PW_USER_NAME) ? request->username : pairfind(request->packet->vps, data->key_attr);
 641         if (key_vp == NULL){
 642                 DEBUG("rlm_counter: Could not find the key-attribute in the request. Returning NOOP.");
 643                 return RLM_MODULE_NOOP;
 644         }
 645
 646         /*
 647          *      Look for the attribute to use as a counter.
 648          */
 649         count_vp = pairfind(request->packet->vps, data->count_attr);
 650         if (count_vp == NULL){
 651                 DEBUG("rlm_counter: Could not find the count-attribute in the request.");
 652                 return RLM_MODULE_NOOP;
 653         }
 654
 655         key_datum.dptr = key_vp->strvalue;
 656         key_datum.dsize = key_vp->length;
 657
 658         DEBUG("rlm_counter: Searching the database for key '%s'",key_vp->strvalue);
 659         pthread_mutex_lock(&data->mutex);
 660         count_datum = gdbm_fetch(data->gdbm, key_datum);
 661         pthread_mutex_unlock(&data->mutex);
 662         if (count_datum.dptr == NULL){
 663                 DEBUG("rlm_counter: Could not find the requested key in the database.");
 664                 counter.user_counter = 0;
 665                 if (uniqueid_vp != NULL)
 666                         strncpy(counter.uniqueid,uniqueid_vp->strvalue,UNIQUEID_MAX_LEN - 1);
 667                 else
 668                         memset((char *)counter.uniqueid,0,UNIQUEID_MAX_LEN);
 669         }
 670         else{
 671                 DEBUG("rlm_counter: Key found.");
 672                 memcpy(&counter, count_datum.dptr, sizeof(rad_counter));
 673                 free(count_datum.dptr);
 674                 if (counter.uniqueid)
 675                         DEBUG("rlm_counter: Counter Unique ID = '%s'",counter.uniqueid);
 676                 if (uniqueid_vp != NULL){
 677                         if (counter.uniqueid != NULL &&
 678                                 strncmp(uniqueid_vp->strvalue,counter.uniqueid, UNIQUEID_MAX_LEN - 1) == 0){
 679                                 DEBUG("rlm_counter: Unique IDs for user match. Droping the request.");
 680                                 return RLM_MODULE_NOOP;
 681                         }
 682                         strncpy(counter.uniqueid,uniqueid_vp->strvalue,UNIQUEID_MAX_LEN - 1);
 683                 }
 684                 DEBUG("rlm_counter: User=%s, Counter=%d.",request->username->strvalue,counter.user_counter);
 685         }
 686
 687         if (data->count_attr == PW_ACCT_SESSION_TIME) {
 688                 /*
 689                  *      If session time < diff then the user got in after the
 690                  *      last reset. So add his session time, otherwise add the
 691                  *      diff.
 692                  *
 693                  *      That way if he logged in at 23:00 and we reset the
 694                  *      daily counter at 24:00 and he logged out at 01:00
 695                  *      then we will only count one hour (the one in the new
 696                  *      day). That is the right thing
 697                  */
 698                 diff = request->timestamp - data->last_reset;
 699                 counter.user_counter += (count_vp->lvalue < diff) ? count_vp->lvalue : diff;
 700
 701         } else if (count_vp->type == PW_TYPE_INTEGER) {
 702                 /*
 703                  *      Integers get counted, without worrying about
 704                  *      reset dates.
 705                  */
 706                 counter.user_counter += count_vp->lvalue;
 707
 708         } else {
 709                 /*
 710                  *      The attribute is NOT an integer, just count once
 711                  *      more that we've seen it.
 712                  */
 713                 counter.user_counter++;
 714         }
 715
 716         DEBUG("rlm_counter: User=%s, New Counter=%d.",request->username->strvalue,counter.user_counter);
 717         count_datum.dptr = (char *) &counter;
 718         count_datum.dsize = sizeof(rad_counter);
 719
 720         DEBUG("rlm_counter: Storing new value in database.");
 721         pthread_mutex_lock(&data->mutex);
 722         rcode = gdbm_store(data->gdbm, key_datum, count_datum, GDBM_REPLACE);
 723         pthread_mutex_unlock(&data->mutex);
 724         if (rcode < 0) {
 725                 radlog(L_ERR, "rlm_counter: Failed storing data to %s: %s",
 726                                 data->filename, gdbm_strerror(gdbm_errno));
 727                 return RLM_MODULE_FAIL;
 728         }
 729         DEBUG("rlm_counter: New value stored successfully.");
 730
 731         return RLM_MODULE_OK;
 732 }
 733
 734 /*
 735  *      Find the named user in this modules database.  Create the set
 736  *      of attribute-value pairs to check and reply with for this user
 737  *      from the database. The authentication code only needs to check
 738  *      the password, the rest is done here.
 739  */
 740 static int counter_authorize(void *instance, REQUEST *request)
 741 {
 742         rlm_counter_t *data = (rlm_counter_t *) instance;
 743         int ret=RLM_MODULE_NOOP;
 744         datum key_datum;
 745         datum count_datum;
 746         rad_counter counter;
 747         int res=0;
 748         VALUE_PAIR *key_vp, *check_vp;
 749         VALUE_PAIR *reply_item;
 750         char msg[128];
 751
 752         /* quiet the compiler */
 753         instance = instance;
 754         request = request;
 755
 756         /*
 757          *      Before doing anything else, see if we have to reset
 758          *      the counters.
 759          */
 760         if (data->reset_time && (data->reset_time <= request->timestamp)) {
 761                 int ret2;
 762
 763                 data->last_reset = data->reset_time;
 764                 find_next_reset(data,request->timestamp);
 765                 pthread_mutex_lock(&data->mutex);
 766                 ret2 = reset_db(data);
 767                 pthread_mutex_unlock(&data->mutex);
 768                 if (ret2 != RLM_MODULE_OK)
 769                         return ret2;
 770         }
 771
 772
 773         /*
 774          *      Look for the key.  User-Name is special.  It means
 775          *      The REAL username, after stripping.
 776          */
 777         DEBUG2("rlm_counter: Entering module authorize code");
 778         key_vp = (data->key_attr == PW_USER_NAME) ? request->username : pairfind(request->packet->vps, data->key_attr);
 779         if (key_vp == NULL) {
 780                 DEBUG2("rlm_counter: Could not find Key value pair");
 781                 return ret;
 782         }
 783
 784         /*
 785          *      Look for the check item
 786          */
 787         if ((check_vp= pairfind(request->config_items, data->check_attr)) == NULL) {
 788                 DEBUG2("rlm_counter: Could not find Check item value pair");
 789                 return ret;
 790         }
 791
 792         key_datum.dptr = key_vp->strvalue;
 793         key_datum.dsize = key_vp->length;
 794
 795
 796         /*
 797          * Init to be sure
 798          */
 799
 800         counter.user_counter = 0;
 801
 802         DEBUG("rlm_counter: Searching the database for key '%s'",key_vp->strvalue);
 803         pthread_mutex_lock(&data->mutex);
 804         count_datum = gdbm_fetch(data->gdbm, key_datum);
 805         pthread_mutex_unlock(&data->mutex);
 806         if (count_datum.dptr != NULL){
 807                 DEBUG("rlm_counter: Key Found.");
 808                 memcpy(&counter, count_datum.dptr, sizeof(rad_counter));
 809                 free(count_datum.dptr);
 810         }
 811         else
 812                 DEBUG("rlm_counter: Could not find the requested key in the database.");
 813
 814         /*
 815          * Check if check item > counter
 816          */
 817         DEBUG("rlm_counter: Check item = %d, Count = %d",check_vp->lvalue,counter.user_counter);
 818         res=check_vp->lvalue - counter.user_counter;
 819         if (res > 0) {
 820                 DEBUG("rlm_counter: res is greater than zero");
 821                 if (data->count_attr == PW_ACCT_SESSION_TIME) {
 822                         /*
 823                          * Do the following only if the count attribute is
 824                          * AcctSessionTime
 825                          */
 826
 827                         /*
 828                         *       We are assuming that simultaneous-use=1. But
 829                         *       even if that does not happen then our user
 830                         *       could login at max for 2*max-usage-time Is
 831                         *       that acceptable?
 832                         */
 833
 834                         /*
 835                         *       User is allowed, but set Session-Timeout.
 836                         *       Stolen from main/auth.c
 837                         */
 838
 839                         /*
 840                         *       If we are near a reset then add the next
 841                         *       limit, so that the user will not need to
 842                         *       login again
 843                         *       Before that set the return value to the time
 844                         *       remaining to next reset
 845                         */
 846                         if (data->reset_time && (
 847                                 res >= (data->reset_time - request->timestamp))) {
 848                                 res = data->reset_time - request->timestamp;
 849                                 res += check_vp->lvalue;
 850                         }
 851
 852                         if ((reply_item = pairfind(request->reply->vps, PW_SESSION_TIMEOUT)) != NULL) {
 853                                 if (reply_item->lvalue > res)
 854                                         reply_item->lvalue = res;
 855                         } else {
 856                                 if ((reply_item = paircreate(PW_SESSION_TIMEOUT, PW_TYPE_INTEGER)) == NULL) {
 857                                         radlog(L_ERR|L_CONS, "no memory");
 858                                         return RLM_MODULE_NOOP;
 859                                 }
 860                                 reply_item->lvalue = res;
 861                                 pairadd(&request->reply->vps, reply_item);
 862                         }
 863                 }
 864                 else if (data->return_attr) {
 865                         if ((reply_item = pairfind(request->reply->vps, data->return_attr)) != NULL) {
 866                                 if (reply_item->lvalue > res)
 867                                         reply_item->lvalue = res;
 868                         }
 869                         else {
 870                                 if ((reply_item = paircreate(data->return_attr, PW_TYPE_INTEGER)) == NULL) {
 871                                         radlog(L_ERR|L_CONS, "no memory");
 872                                         return RLM_MODULE_NOOP;
 873                                 }
 874                                 reply_item->lvalue = res;
 875                                 pairadd(&request->reply->vps, reply_item);
 876                         }
 877                 }
 878
 879                 ret=RLM_MODULE_OK;
 880
 881                 DEBUG2("rlm_counter: (Check item - counter) is greater than zero");
 882                 DEBUG2("rlm_counter: Authorized user %s, check_item=%d, counter=%d",
 883                                 key_vp->strvalue,check_vp->lvalue,counter.user_counter);
 884                 DEBUG2("rlm_counter: Sent Reply-Item for user %s, Type=Session-Timeout, value=%d",
 885                                 key_vp->strvalue,res);
 886         }
 887         else{
 888                 char module_fmsg[MAX_STRING_LEN];
 889                 VALUE_PAIR *module_fmsg_vp;
 890
 891                 /*
 892                  * User is denied access, send back a reply message
 893                 */
 894                 sprintf(msg, "Your maximum %s usage time has been reached", data->reset);
 895                 reply_item=pairmake("Reply-Message", msg, T_OP_EQ);
 896                 pairadd(&request->reply->vps, reply_item);
 897
 898                 snprintf(module_fmsg,sizeof(module_fmsg), "rlm_counter: Maximum %s usage time reached", data->reset);
 899                 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
 900                 pairadd(&request->packet->vps, module_fmsg_vp);
 901
 902                 ret=RLM_MODULE_REJECT;
 903
 904                 DEBUG2("rlm_counter: Rejected user %s, check_item=%d, counter=%d",
 905                                 key_vp->strvalue,check_vp->lvalue,counter.user_counter);
 906         }
 907
 908         return ret;
 909 }
 910
 911 static int counter_detach(void *instance)
 912 {
 913         rlm_counter_t *data = (rlm_counter_t *) instance;
 914
 915         paircompare_unregister(data->dict_attr, counter_cmp);
 916         if (data->gdbm)
 917                 gdbm_close(data->gdbm);
 918         free(data->filename);
 919         free(data->reset);
 920         free(data->key_name);
 921         free(data->count_attribute);
 922         free(data->counter_name);
 923         free(data->check_name);
 924         free(data->service_type);
 925         pthread_mutex_destroy(&data->mutex);
 926
 927         free(instance);
 928         return 0;
 929 }
 930
 931 /*
 932  *      The module name should be the only globally exported symbol.
 933  *      That is, everything else should be 'static'.
 934  *
 935  *      If the module needs to temporarily modify it's instantiation
 936  *      data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
 937  *      The server will then take care of ensuring that the module
 938  *      is single-threaded.
 939  */
 940 module_t rlm_counter = {
 941         "Counter",
 942         RLM_TYPE_THREAD_SAFE,           /* type */
 943         NULL,                           /* initialization */
 944         counter_instantiate,            /* instantiation */
 945         {
 946                 NULL,                   /* authentication */
 947                 counter_authorize,      /* authorization */
 948                 NULL,                   /* preaccounting */
 949                 counter_accounting,     /* accounting */
 950                 NULL,                   /* checksimul */
 951                 NULL,                   /* pre-proxy */
 952                 NULL,                   /* post-proxy */
 953                 NULL                    /* post-auth */
 954         },
 955         counter_detach,                 /* detach */
 956         NULL,                           /* destroy */
 957 };