src/modules/rlm_sqlcounter/rlm_sqlcounter.c

   1 /*
   2  * rlm_sqlcounter.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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  * Copyright 2001,2006  The FreeRADIUS server project
  21  * Copyright 2001  Alan DeKok <aland@ox.org>
  22  */
  23
  24 /* This module is based directly on the rlm_counter module */
  25
  26
  27 #include <freeradius-devel/ident.h>
  28 RCSID("$Id$")
  29
  30 #include <freeradius-devel/radiusd.h>
  31 #include <freeradius-devel/modules.h>
  32
  33 #include <ctype.h>
  34
  35 #define MAX_QUERY_LEN 1024
  36
  37 static int sqlcounter_detach(void *instance);
  38
  39 /*
  40  *      Note: When your counter spans more than 1 period (ie 3 months
  41  *      or 2 weeks), this module probably does NOT do what you want! It
  42  *      calculates the range of dates to count across by first calculating
  43  *      the End of the Current period and then subtracting the number of
  44  *      periods you specify from that to determine the beginning of the
  45  *      range.
  46  *
  47  *      For example, if you specify a 3 month counter and today is June 15th,
  48  *      the end of the current period is June 30. Subtracting 3 months from
  49  *      that gives April 1st. So, the counter will sum radacct entries from
  50  *      April 1st to June 30. Then, next month, it will sum entries from
  51  *      May 1st to July 31st.
  52  *
  53  *      To fix this behavior, we need to add some way of storing the Next
  54  *      Reset Time.
  55  */
  56
  57 /*
  58  *      Define a structure for our module configuration.
  59  *
  60  *      These variables do not need to be in a structure, but it's
  61  *      a lot cleaner to do so, and a pointer to the structure can
  62  *      be used as the instance handle.
  63  */
  64 typedef struct rlm_sqlcounter_t {
  65         char *counter_name;     /* Daily-Session-Time */
  66         char *check_name;       /* Max-Daily-Session */
  67         char *reply_name;       /* Session-Timeout */
  68         char *key_name;         /* User-Name */
  69         char *sqlmod_inst;      /* instance of SQL module to use, usually just 'sql' */
  70         char *query;            /* SQL query to retrieve current session time */
  71         char *reset;            /* daily, weekly, monthly, never or user defined */
  72         char *allowed_chars;    /* safe characters list for SQL queries */
  73         time_t reset_time;
  74         time_t last_reset;
  75         int  key_attr;          /* attribute number for key field */
  76         int  dict_attr;         /* attribute number for the counter. */
  77         int  reply_attr;        /* attribute number for the reply */
  78 } rlm_sqlcounter_t;
  79
  80 /*
  81  *      A mapping of configuration file names to internal variables.
  82  *
  83  *      Note that the string is dynamically allocated, so it MUST
  84  *      be freed.  When the configuration file parse re-reads the string,
  85  *      it free's the old one, and strdup's the new one, placing the pointer
  86  *      to the strdup'd string into 'config.string'.  This gets around
  87  *      buffer over-flows.
  88  */
  89 static const CONF_PARSER module_config[] = {
  90   { "counter-name", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,counter_name), NULL,  NULL },
  91   { "check-name", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,check_name), NULL, NULL },
  92   { "reply-name", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,reply_name), NULL, NULL },
  93   { "key", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,key_name), NULL, NULL },
  94   { "sqlmod-inst", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,sqlmod_inst), NULL, NULL },
  95   { "query", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,query), NULL, NULL },
  96   { "reset", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,reset), NULL,  NULL },
  97   { "safe-characters", PW_TYPE_STRING_PTR, offsetof(rlm_sqlcounter_t,allowed_chars), NULL, "@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /"},
  98   { NULL, -1, 0, NULL, NULL }
  99 };
 100
 101 static char *allowed_chars = NULL;
 102
 103 /*
 104  *      Translate the SQL queries.
 105  */
 106 static int sql_escape_func(char *out, int outlen, const char *in)
 107 {
 108         int len = 0;
 109
 110         while (in[0]) {
 111                 /*
 112                  *      Non-printable characters get replaced with their
 113                  *      mime-encoded equivalents.
 114                  */
 115                 if ((in[0] < 32) ||
 116                     strchr(allowed_chars, *in) == NULL) {
 117                         /*
 118                          *      Only 3 or less bytes available.
 119                          */
 120                         if (outlen <= 3) {
 121                                 break;
 122                         }
 123
 124                         snprintf(out, outlen, "=%02X", (unsigned char) in[0]);
 125                         in++;
 126                         out += 3;
 127                         outlen -= 3;
 128                         len += 3;
 129                         continue;
 130                 }
 131
 132                 /*
 133                  *      Only one byte left.
 134                  */
 135                 if (outlen <= 1) {
 136                         break;
 137                 }
 138
 139                 /*
 140                  *      Allowed character.
 141                  */
 142                 *out = *in;
 143                 out++;
 144                 in++;
 145                 outlen--;
 146                 len++;
 147         }
 148         *out = '\0';
 149         return len;
 150 }
 151
 152 static int find_next_reset(rlm_sqlcounter_t *data, time_t timeval)
 153 {
 154         int ret = 0;
 155         size_t len;
 156         unsigned int num = 1;
 157         char last = '\0';
 158         struct tm *tm, s_tm;
 159         char sCurrentTime[40], sNextTime[40];
 160
 161         tm = localtime_r(&timeval, &s_tm);
 162         len = strftime(sCurrentTime, sizeof(sCurrentTime), "%Y-%m-%d %H:%M:%S", tm);
 163         if (len == 0) *sCurrentTime = '\0';
 164         tm->tm_sec = tm->tm_min = 0;
 165
 166         if (data->reset == NULL)
 167                 return -1;
 168         if (isdigit((int) data->reset[0])){
 169                 len = strlen(data->reset);
 170                 if (len == 0)
 171                         return -1;
 172                 last = data->reset[len - 1];
 173                 if (!isalpha((int) last))
 174                         last = 'd';
 175                 num = atoi(data->reset);
 176                 DEBUG("rlm_sqlcounter: num=%d, last=%c",num,last);
 177         }
 178         if (strcmp(data->reset, "hourly") == 0 || last == 'h') {
 179                 /*
 180                  *  Round up to the next nearest hour.
 181                  */
 182                 tm->tm_hour += num;
 183                 data->reset_time = mktime(tm);
 184         } else if (strcmp(data->reset, "daily") == 0 || last == 'd') {
 185                 /*
 186                  *  Round up to the next nearest day.
 187                  */
 188                 tm->tm_hour = 0;
 189                 tm->tm_mday += num;
 190                 data->reset_time = mktime(tm);
 191         } else if (strcmp(data->reset, "weekly") == 0 || last == 'w') {
 192                 /*
 193                  *  Round up to the next nearest week.
 194                  */
 195                 tm->tm_hour = 0;
 196                 tm->tm_mday += (7 - tm->tm_wday) +(7*(num-1));
 197                 data->reset_time = mktime(tm);
 198         } else if (strcmp(data->reset, "monthly") == 0 || last == 'm') {
 199                 tm->tm_hour = 0;
 200                 tm->tm_mday = 1;
 201                 tm->tm_mon += num;
 202                 data->reset_time = mktime(tm);
 203         } else if (strcmp(data->reset, "never") == 0) {
 204                 data->reset_time = 0;
 205         } else {
 206                 radlog(L_ERR, "rlm_sqlcounter: Unknown reset timer \"%s\"",
 207                         data->reset);
 208                 return -1;
 209         }
 210
 211         len = strftime(sNextTime, sizeof(sNextTime),"%Y-%m-%d %H:%M:%S",tm);
 212         if (len == 0) *sNextTime = '\0';
 213         DEBUG2("rlm_sqlcounter: Current Time: %li [%s], Next reset %li [%s]",
 214                 timeval, sCurrentTime, data->reset_time, sNextTime);
 215
 216         return ret;
 217 }
 218
 219
 220 /*  I don't believe that this routine handles Daylight Saving Time adjustments
 221     properly.  Any suggestions?
 222 */
 223
 224 static int find_prev_reset(rlm_sqlcounter_t *data, time_t timeval)
 225 {
 226         int ret = 0;
 227         size_t len;
 228         unsigned int num = 1;
 229         char last = '\0';
 230         struct tm *tm, s_tm;
 231         char sCurrentTime[40], sPrevTime[40];
 232
 233         tm = localtime_r(&timeval, &s_tm);
 234         len = strftime(sCurrentTime, sizeof(sCurrentTime), "%Y-%m-%d %H:%M:%S", tm);
 235         if (len == 0) *sCurrentTime = '\0';
 236         tm->tm_sec = tm->tm_min = 0;
 237
 238         if (data->reset == NULL)
 239                 return -1;
 240         if (isdigit((int) data->reset[0])){
 241                 len = strlen(data->reset);
 242                 if (len == 0)
 243                         return -1;
 244                 last = data->reset[len - 1];
 245                 if (!isalpha((int) last))
 246                         last = 'd';
 247                 num = atoi(data->reset);
 248                 DEBUG("rlm_sqlcounter: num=%d, last=%c",num,last);
 249         }
 250         if (strcmp(data->reset, "hourly") == 0 || last == 'h') {
 251                 /*
 252                  *  Round down to the prev nearest hour.
 253                  */
 254                 tm->tm_hour -= num - 1;
 255                 data->last_reset = mktime(tm);
 256         } else if (strcmp(data->reset, "daily") == 0 || last == 'd') {
 257                 /*
 258                  *  Round down to the prev nearest day.
 259                  */
 260                 tm->tm_hour = 0;
 261                 tm->tm_mday -= num - 1;
 262                 data->last_reset = mktime(tm);
 263         } else if (strcmp(data->reset, "weekly") == 0 || last == 'w') {
 264                 /*
 265                  *  Round down to the prev nearest week.
 266                  */
 267                 tm->tm_hour = 0;
 268                 tm->tm_mday -= (7 - tm->tm_wday) +(7*(num-1));
 269                 data->last_reset = mktime(tm);
 270         } else if (strcmp(data->reset, "monthly") == 0 || last == 'm') {
 271                 tm->tm_hour = 0;
 272                 tm->tm_mday = 1;
 273                 tm->tm_mon -= num - 1;
 274                 data->last_reset = mktime(tm);
 275         } else if (strcmp(data->reset, "never") == 0) {
 276                 data->reset_time = 0;
 277         } else {
 278                 radlog(L_ERR, "rlm_sqlcounter: Unknown reset timer \"%s\"",
 279                         data->reset);
 280                 return -1;
 281         }
 282         len = strftime(sPrevTime, sizeof(sPrevTime), "%Y-%m-%d %H:%M:%S", tm);
 283         if (len == 0) *sPrevTime = '\0';
 284         DEBUG2("rlm_sqlcounter: Current Time: %li [%s], Prev reset %li [%s]",
 285                timeval, sCurrentTime, data->last_reset, sPrevTime);
 286
 287         return ret;
 288 }
 289
 290
 291 /*
 292  *      Replace %<whatever> in a string.
 293  *
 294  *      %b      last_reset
 295  *      %e      reset_time
 296  *      %k      key_name
 297  *      %S      sqlmod_inst
 298  *
 299  */
 300
 301 static int sqlcounter_expand(char *out, int outlen, const char *fmt, void *instance)
 302 {
 303         rlm_sqlcounter_t *data = (rlm_sqlcounter_t *) instance;
 304         int c,freespace;
 305         const char *p;
 306         char *q;
 307         char tmpdt[40]; /* For temporary storing of dates */
 308         int openbraces=0;
 309
 310         q = out;
 311         for (p = fmt; *p ; p++) {
 312         /* Calculate freespace in output */
 313         freespace = outlen - (q - out);
 314                 if (freespace <= 1)
 315                         break;
 316                 c = *p;
 317                 if ((c != '%') && (c != '$') && (c != '\\')) {
 318                         /*
 319                          * We check if we're inside an open brace.  If we are
 320                          * then we assume this brace is NOT literal, but is
 321                          * a closing brace and apply it
 322                          */
 323                         if((c == '}') && openbraces) {
 324                                 openbraces--;
 325                                 continue;
 326                         }
 327                         *q++ = *p;
 328                         continue;
 329                 }
 330                 if (*++p == '\0') break;
 331                 if (c == '\\') switch(*p) {
 332                         case '\\':
 333                                 *q++ = *p;
 334                                 break;
 335                         case 't':
 336                                 *q++ = '\t';
 337                                 break;
 338                         case 'n':
 339                                 *q++ = '\n';
 340                                 break;
 341                         default:
 342                                 *q++ = c;
 343                                 *q++ = *p;
 344                                 break;
 345
 346                 } else if (c == '%') switch(*p) {
 347
 348                         case '%':
 349                                 *q++ = *p;
 350                         case 'b': /* last_reset */
 351                                 snprintf(tmpdt, sizeof(tmpdt), "%lu", data->last_reset);
 352                                 strlcpy(q, tmpdt, freespace);
 353                                 q += strlen(q);
 354                                 break;
 355                         case 'e': /* reset_time */
 356                                 snprintf(tmpdt, sizeof(tmpdt), "%lu", data->reset_time);
 357                                 strlcpy(q, tmpdt, freespace);
 358                                 q += strlen(q);
 359                                 break;
 360                         case 'k': /* Key Name */
 361                                 strlcpy(q, data->key_name, freespace);
 362                                 q += strlen(q);
 363                                 break;
 364                         case 'S': /* SQL module instance */
 365                                 strlcpy(q, data->sqlmod_inst, freespace);
 366                                 q += strlen(q);
 367                                 break;
 368                         default:
 369                                 *q++ = '%';
 370                                 *q++ = *p;
 371                                 break;
 372                 }
 373         }
 374         *q = '\0';
 375
 376         DEBUG2("sqlcounter_expand:  '%s'", out);
 377
 378         return strlen(out);
 379 }
 380
 381
 382 /*
 383  *      See if the counter matches.
 384  */
 385 static int sqlcounter_cmp(void *instance, REQUEST *req,
 386                           UNUSED VALUE_PAIR *request, VALUE_PAIR *check,
 387                           VALUE_PAIR *check_pairs, VALUE_PAIR **reply_pairs)
 388 {
 389         rlm_sqlcounter_t *data = (rlm_sqlcounter_t *) instance;
 390         int counter;
 391         char querystr[MAX_QUERY_LEN];
 392         char responsestr[MAX_QUERY_LEN];
 393
 394         check_pairs = check_pairs; /* shut the compiler up */
 395         reply_pairs = reply_pairs;
 396
 397         /* first, expand %k, %b and %e in query */
 398         sqlcounter_expand(querystr, MAX_QUERY_LEN, data->query, instance);
 399
 400         /* second, xlat any request attribs in query */
 401         radius_xlat(responsestr, MAX_QUERY_LEN, querystr, req, sql_escape_func);
 402
 403         /* third, wrap query with sql module call & expand */
 404         snprintf(querystr, sizeof(querystr), "%%{%%S:%s}", responsestr);
 405         sqlcounter_expand(responsestr, MAX_QUERY_LEN, querystr, instance);
 406
 407         /* Finally, xlat resulting SQL query */
 408         radius_xlat(querystr, MAX_QUERY_LEN, responsestr, req, sql_escape_func);
 409
 410         counter = atoi(querystr);
 411
 412         return counter - check->vp_integer;
 413 }
 414
 415
 416 /*
 417  *      Do any per-module initialization that is separate to each
 418  *      configured instance of the module.  e.g. set up connections
 419  *      to external databases, read configuration files, set up
 420  *      dictionary entries, etc.
 421  *
 422  *      If configuration information is given in the config section
 423  *      that must be referenced in later calls, store a handle to it
 424  *      in *instance otherwise put a null pointer there.
 425  */
 426 static int sqlcounter_instantiate(CONF_SECTION *conf, void **instance)
 427 {
 428         rlm_sqlcounter_t *data;
 429         DICT_ATTR *dattr;
 430         ATTR_FLAGS flags;
 431         time_t now;
 432         char buffer[MAX_STRING_LEN];
 433
 434         /*
 435          *      Set up a storage area for instance data
 436          */
 437         data = rad_malloc(sizeof(*data));
 438         if (!data) {
 439                 radlog(L_ERR, "rlm_sqlcounter: Not enough memory.");
 440                 return -1;
 441         }
 442         memset(data, 0, sizeof(*data));
 443
 444         /*
 445          *      If the configuration parameters can't be parsed, then
 446          *      fail.
 447          */
 448         if (cf_section_parse(conf, data, module_config) < 0) {
 449                 radlog(L_ERR, "rlm_sqlcounter: Unable to parse parameters.");
 450                 sqlcounter_detach(data);
 451                 return -1;
 452         }
 453
 454         /*
 455          *      No query, die.
 456          */
 457         if (data->query == NULL) {
 458                 radlog(L_ERR, "rlm_sqlcounter: 'query' must be set.");
 459                 sqlcounter_detach(data);
 460                 return -1;
 461         }
 462
 463         /*
 464          *      Safe characters list for sql queries. Everything else is
 465          *      replaced with their mime-encoded equivalents.
 466          */
 467         allowed_chars = data->allowed_chars;
 468
 469         /*
 470          *      Discover the attribute number of the key.
 471          */
 472         if (data->key_name == NULL) {
 473                 radlog(L_ERR, "rlm_sqlcounter: 'key' must be set.");
 474                 sqlcounter_detach(data);
 475                 return -1;
 476         }
 477         sql_escape_func(buffer, sizeof(buffer), data->key_name);
 478         if (strcmp(buffer, data->key_name) != 0) {
 479                 radlog(L_ERR, "rlm_sqlcounter: The value for option 'key' is too long or contains unsafe characters.");
 480                 sqlcounter_detach(data);
 481                 return -1;
 482         }
 483         dattr = dict_attrbyname(data->key_name);
 484         if (dattr == NULL) {
 485                 radlog(L_ERR, "rlm_sqlcounter: No such attribute %s",
 486                                 data->key_name);
 487                 sqlcounter_detach(data);
 488                 return -1;
 489         }
 490         data->key_attr = dattr->attr;
 491
 492         /*
 493          *      Discover the attribute number of the reply.
 494          *      If not set, set it to Session-Timeout
 495          *      for backward compatibility.
 496          */
 497         if (data->reply_name == NULL) {
 498                 DEBUG2("rlm_sqlcounter: Reply attribute set to Session-Timeout.");
 499                 data->reply_attr = PW_SESSION_TIMEOUT;
 500                 data->reply_name = strdup("Session-Timeout");
 501         }
 502         else {
 503                 dattr = dict_attrbyname(data->reply_name);
 504                 if (dattr == NULL) {
 505                         radlog(L_ERR, "rlm_sqlcounter: No such attribute %s",
 506                                data->reply_name);
 507                         sqlcounter_detach(data);
 508                         return -1;
 509                 }
 510                 data->reply_attr = dattr->attr;
 511                 DEBUG2("rlm_sqlcounter: Reply attribute %s is number %d",
 512                        data->reply_name, dattr->attr);
 513         }
 514
 515         /*
 516          *      Check the "sqlmod-inst" option.
 517          */
 518         if (data->sqlmod_inst == NULL) {
 519                 radlog(L_ERR, "rlm_sqlcounter: 'sqlmod-inst' must be set.");
 520                 sqlcounter_detach(data);
 521                 return -1;
 522         }
 523         sql_escape_func(buffer, sizeof(buffer), data->sqlmod_inst);
 524         if (strcmp(buffer, data->sqlmod_inst) != 0) {
 525                 radlog(L_ERR, "rlm_sqlcounter: The value for option 'sqlmod-inst' is too long or contains unsafe characters.");
 526                 sqlcounter_detach(data);
 527                 return -1;
 528         }
 529
 530         /*
 531          *  Create a new attribute for the counter.
 532          */
 533         if (data->counter_name == NULL) {
 534                 radlog(L_ERR, "rlm_sqlcounter: 'counter-name' must be set.");
 535                 sqlcounter_detach(data);
 536                 return -1;
 537         }
 538
 539         memset(&flags, 0, sizeof(flags));
 540         dict_addattr(data->counter_name, 0, PW_TYPE_INTEGER, -1, flags);
 541         dattr = dict_attrbyname(data->counter_name);
 542         if (dattr == NULL) {
 543                 radlog(L_ERR, "rlm_sqlcounter: Failed to create counter attribute %s",
 544                                 data->counter_name);
 545                 sqlcounter_detach(data);
 546                 return -1;
 547         }
 548         data->dict_attr = dattr->attr;
 549         DEBUG2("rlm_sqlcounter: Counter attribute %s is number %d",
 550                         data->counter_name, data->dict_attr);
 551
 552         /*
 553          * Create a new attribute for the check item.
 554          */
 555         if (data->check_name == NULL) {
 556                 radlog(L_ERR, "rlm_sqlcounter: 'check-name' must be set.");
 557                 sqlcounter_detach(data);
 558                 return -1;
 559         }
 560         dict_addattr(data->check_name, 0, PW_TYPE_INTEGER, -1, flags);
 561         dattr = dict_attrbyname(data->check_name);
 562         if (dattr == NULL) {
 563                 radlog(L_ERR, "rlm_sqlcounter: Failed to create check attribute %s",
 564                                 data->check_name);
 565                 sqlcounter_detach(data);
 566                 return -1;
 567         }
 568         DEBUG2("rlm_sqlcounter: Check attribute %s is number %d",
 569                         data->check_name, dattr->attr);
 570
 571         /*
 572          *  Discover the end of the current time period.
 573          */
 574         if (data->reset == NULL) {
 575                 radlog(L_ERR, "rlm_sqlcounter: 'reset' must be set.");
 576                 sqlcounter_detach(data);
 577                 return -1;
 578         }
 579         now = time(NULL);
 580         data->reset_time = 0;
 581
 582         if (find_next_reset(data,now) == -1) {
 583                 radlog(L_ERR, "rlm_sqlcounter: Failed to find the next reset time.");
 584                 sqlcounter_detach(data);
 585                 return -1;
 586         }
 587
 588         /*
 589          *  Discover the beginning of the current time period.
 590          */
 591         data->last_reset = 0;
 592
 593         if (find_prev_reset(data,now) == -1) {
 594                 radlog(L_ERR, "rlm_sqlcounter: Failed to find the previous reset time.");
 595                 sqlcounter_detach(data);
 596                 return -1;
 597         }
 598
 599         /*
 600          *      Register the counter comparison operation.
 601          */
 602         paircompare_register(data->dict_attr, 0, sqlcounter_cmp, data);
 603
 604         *instance = data;
 605
 606         return 0;
 607 }
 608
 609 /*
 610  *      Find the named user in this modules database.  Create the set
 611  *      of attribute-value pairs to check and reply with for this user
 612  *      from the database. The authentication code only needs to check
 613  *      the password, the rest is done here.
 614  */
 615 static int sqlcounter_authorize(void *instance, REQUEST *request)
 616 {
 617         rlm_sqlcounter_t *data = (rlm_sqlcounter_t *) instance;
 618         int ret=RLM_MODULE_NOOP;
 619         int counter=0;
 620         int res=0;
 621         DICT_ATTR *dattr;
 622         VALUE_PAIR *key_vp, *check_vp;
 623         VALUE_PAIR *reply_item;
 624         char msg[128];
 625         char querystr[MAX_QUERY_LEN];
 626         char responsestr[MAX_QUERY_LEN];
 627
 628         /* quiet the compiler */
 629         instance = instance;
 630         request = request;
 631
 632         /*
 633          *      Before doing anything else, see if we have to reset
 634          *      the counters.
 635          */
 636         if (data->reset_time && (data->reset_time <= request->timestamp)) {
 637
 638                 /*
 639                  *      Re-set the next time and prev_time for this counters range
 640                  */
 641                 data->last_reset = data->reset_time;
 642                 find_next_reset(data,request->timestamp);
 643         }
 644
 645
 646         /*
 647          *      Look for the key.  User-Name is special.  It means
 648          *      The REAL username, after stripping.
 649          */
 650         DEBUG2("rlm_sqlcounter: Entering module authorize code");
 651         key_vp = (data->key_attr == PW_USER_NAME) ? request->username : pairfind(request->packet->vps, data->key_attr);
 652         if (key_vp == NULL) {
 653                 DEBUG2("rlm_sqlcounter: Could not find Key value pair");
 654                 return ret;
 655         }
 656
 657         /*
 658          *      Look for the check item
 659          */
 660         if ((dattr = dict_attrbyname(data->check_name)) == NULL) {
 661                 return ret;
 662         }
 663         /* DEBUG2("rlm_sqlcounter: Found Check item attribute %d", dattr->attr); */
 664         if ((check_vp= pairfind(request->config_items, dattr->attr)) == NULL) {
 665                 DEBUG2("rlm_sqlcounter: Could not find Check item value pair");
 666                 return ret;
 667         }
 668
 669         /* first, expand %k, %b and %e in query */
 670         sqlcounter_expand(querystr, MAX_QUERY_LEN, data->query, instance);
 671
 672         /* second, xlat any request attribs in query */
 673         radius_xlat(responsestr, MAX_QUERY_LEN, querystr, request, sql_escape_func);
 674
 675         /* third, wrap query with sql module & expand */
 676         snprintf(querystr, sizeof(querystr), "%%{%%S:%s}", responsestr);
 677         sqlcounter_expand(responsestr, MAX_QUERY_LEN, querystr, instance);
 678
 679         /* Finally, xlat resulting SQL query */
 680         radius_xlat(querystr, MAX_QUERY_LEN, responsestr, request, sql_escape_func);
 681
 682         counter = atoi(querystr);
 683
 684
 685         /*
 686          * Check if check item > counter
 687          */
 688         res=check_vp->vp_integer - counter;
 689         if (res > 0) {
 690                 DEBUG2("rlm_sqlcounter: (Check item - counter) is greater than zero");
 691                 /*
 692                  *      We are assuming that simultaneous-use=1. But
 693                  *      even if that does not happen then our user
 694                  *      could login at max for 2*max-usage-time Is
 695                  *      that acceptable?
 696                  */
 697
 698                 /*
 699                  *      User is allowed, but set Session-Timeout.
 700                  *      Stolen from main/auth.c
 701                  */
 702
 703                 /*
 704                  *      If we are near a reset then add the next
 705                  *      limit, so that the user will not need to
 706                  *      login again
 707                  */
 708                 if (data->reset_time && (
 709                         res >= (data->reset_time - request->timestamp))) {
 710                         res = data->reset_time - request->timestamp;
 711                         res += check_vp->vp_integer;
 712                 }
 713
 714                 if ((reply_item = pairfind(request->reply->vps, data->reply_attr)) != NULL) {
 715                         if (reply_item->vp_integer > res)
 716                                 reply_item->vp_integer = res;
 717                 } else {
 718                         reply_item = radius_paircreate(request,
 719                                                        &request->reply->vps,
 720                                                        data->reply_attr,
 721                                                        PW_TYPE_INTEGER);
 722                         reply_item->vp_integer = res;
 723                 }
 724
 725                 ret=RLM_MODULE_OK;
 726
 727                 DEBUG2("rlm_sqlcounter: Authorized user %s, check_item=%d, counter=%d",
 728                                 key_vp->vp_strvalue,check_vp->vp_integer,counter);
 729                 DEBUG2("rlm_sqlcounter: Sent Reply-Item for user %s, Type=%s, value=%d",
 730                                 key_vp->vp_strvalue,data->reply_name,reply_item->vp_integer);
 731         }
 732         else{
 733                 char module_fmsg[MAX_STRING_LEN];
 734                 VALUE_PAIR *module_fmsg_vp;
 735
 736                 DEBUG2("rlm_sqlcounter: (Check item - counter) is less than zero");
 737
 738                 /*
 739                  * User is denied access, send back a reply message
 740                  */
 741                 snprintf(msg, sizeof(msg), "Your maximum %s usage time has been reached", data->reset);
 742                 reply_item=pairmake("Reply-Message", msg, T_OP_EQ);
 743                 pairadd(&request->reply->vps, reply_item);
 744
 745                 snprintf(module_fmsg, sizeof(module_fmsg), "rlm_sqlcounter: Maximum %s usage time reached", data->reset);
 746                 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
 747                 pairadd(&request->packet->vps, module_fmsg_vp);
 748
 749                 ret=RLM_MODULE_REJECT;
 750
 751                 DEBUG2("rlm_sqlcounter: Rejected user %s, check_item=%d, counter=%d",
 752                                 key_vp->vp_strvalue,check_vp->vp_integer,counter);
 753         }
 754
 755         return ret;
 756 }
 757
 758 static int sqlcounter_detach(void *instance)
 759 {
 760         int i;
 761         char **p;
 762         rlm_sqlcounter_t *inst = (rlm_sqlcounter_t *)instance;
 763
 764         allowed_chars = NULL;
 765         paircompare_unregister(inst->dict_attr, sqlcounter_cmp);
 766
 767         /*
 768          *      Free up dynamically allocated string pointers.
 769          */
 770         for (i = 0; module_config[i].name != NULL; i++) {
 771                 if (module_config[i].type != PW_TYPE_STRING_PTR) {
 772                         continue;
 773                 }
 774
 775                 /*
 776                  *      Treat 'config' as an opaque array of bytes,
 777                  *      and take the offset into it.  There's a
 778                  *      (char*) pointer at that offset, and we want
 779                  *      to point to it.
 780                  */
 781                 p = (char **) (((char *)inst) + module_config[i].offset);
 782                 if (!*p) { /* nothing allocated */
 783                         continue;
 784                 }
 785                 free(*p);
 786                 *p = NULL;
 787         }
 788         free(inst);
 789         return 0;
 790 }
 791
 792 /*
 793  *      The module name should be the only globally exported symbol.
 794  *      That is, everything else should be 'static'.
 795  *
 796  *      If the module needs to temporarily modify it's instantiation
 797  *      data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
 798  *      The server will then take care of ensuring that the module
 799  *      is single-threaded.
 800  */
 801 module_t rlm_sqlcounter = {
 802         RLM_MODULE_INIT,
 803         "SQL Counter",
 804         RLM_TYPE_THREAD_SAFE,           /* type */
 805         sqlcounter_instantiate,         /* instantiation */
 806         sqlcounter_detach,              /* detach */
 807         {
 808                 NULL,                   /* authentication */
 809                 sqlcounter_authorize,   /* authorization */
 810                 NULL,                   /* preaccounting */
 811                 NULL,                   /* accounting */
 812                 NULL,                   /* checksimul */
 813                 NULL,                   /* pre-proxy */
 814                 NULL,                   /* post-proxy */
 815                 NULL                    /* post-auth */
 816         },
 817 };
 818