src/modules/rlm_sql/rlm_sql.c

   1 /*
   2  *   This program is is free software; you can redistribute it and/or modify
   3  *   it under the terms of the GNU General Public License, version 2 if the
   4  *   License as published by the Free Software Foundation.
   5  *
   6  *   This program is distributed in the hope that it will be useful,
   7  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   8  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9  *   GNU General Public License for more details.
  10  *
  11  *   You should have received a copy of the GNU General Public License
  12  *   along with this program; if not, write to the Free Software
  13  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  14  */
  15
  16 /**
  17  * $Id$
  18  * @file rlm_sql.c
  19  * @brief Implements SQL 'users' file, and SQL accounting.
  20  *
  21  * @copyright 2012  Arran Cudbard-Bell <a.cudbardb@freeradius.org>
  22  * @copyright 2000,2006  The FreeRADIUS server project
  23  * @copyright 2000  Mike Machado <mike@innercite.com>
  24  * @copyright 2000  Alan DeKok <aland@ox.org>
  25  */
  26 RCSID("$Id$")
  27
  28 #include <ctype.h>
  29
  30 #include <freeradius-devel/radiusd.h>
  31 #include <freeradius-devel/modules.h>
  32 #include <freeradius-devel/token.h>
  33 #include <freeradius-devel/rad_assert.h>
  34
  35 #include <sys/stat.h>
  36
  37 #include "rlm_sql.h"
  38
  39 /*
  40  *      So we can do pass2 xlat checks on the queries.
  41  */
  42 static const CONF_PARSER query_config[] = {
  43
  44         { "query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT | PW_TYPE_MULTI, rlm_sql_config_t, accounting.query), NULL },
  45
  46         {NULL, -1, 0, NULL, NULL}
  47 };
  48
  49 /*
  50  *      For now hard-code the subsections.  This isn't perfect, but it
  51  *      helps the average case.
  52  */
  53 static const CONF_PARSER type_config[] = {
  54
  55         { "accounting-on", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
  56         { "accounting-off", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
  57         { "start", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
  58         { "interim-update", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
  59         { "stop", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
  60
  61         {NULL, -1, 0, NULL, NULL}
  62 };
  63
  64
  65
  66 static const CONF_PARSER acct_config[] = {
  67         { "reference", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, accounting.reference), ".query" },
  68         { "logfile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, accounting.logfile), NULL },
  69
  70         { "type", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) type_config },
  71
  72         {NULL, -1, 0, NULL, NULL}
  73 };
  74
  75 static const CONF_PARSER postauth_config[] = {
  76         { "reference", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, postauth.reference), ".query" },
  77         { "logfile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, postauth.logfile), NULL },
  78
  79         { "query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT | PW_TYPE_MULTI, rlm_sql_config_t, postauth.query), NULL },
  80
  81         {NULL, -1, 0, NULL, NULL}
  82 };
  83
  84 static const CONF_PARSER module_config[] = {
  85         { "driver", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_driver_name), "rlm_sql_null" },
  86         { "server", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_server), "localhost" },
  87         { "port", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_port), "" },
  88         { "login", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_login), "" },
  89         { "password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, rlm_sql_config_t, sql_password), "" },
  90         { "radius_db", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_db), "radius" },
  91         { "read_groups", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, read_groups), "yes" },
  92         { "read_profiles", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, read_profiles), "yes" },
  93         { "readclients", FR_CONF_OFFSET(PW_TYPE_BOOLEAN | PW_TYPE_DEPRECATED, rlm_sql_config_t, do_clients), NULL },
  94         { "read_clients", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, do_clients), "no" },
  95         { "deletestalesessions", FR_CONF_OFFSET(PW_TYPE_BOOLEAN | PW_TYPE_DEPRECATED, rlm_sql_config_t, deletestalesessions), NULL },
  96         { "delete_stale_sessions", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, deletestalesessions), "yes" },
  97         { "sql_user_name", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, query_user), "" },
  98         { "logfile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, logfile), NULL },
  99         { "default_user_profile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, default_profile), "" },
 100         { "nas_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_DEPRECATED, rlm_sql_config_t, client_query), NULL },
 101         { "client_query", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, client_query), "SELECT id,nasname,shortname,type,secret FROM nas" },
 102         { "open_query", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, open_query), NULL },
 103
 104         { "authorize_check_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_check_query), NULL },
 105         { "authorize_reply_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_reply_query), NULL },
 106
 107         { "authorize_group_check_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_group_check_query), "" },
 108         { "authorize_group_reply_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_group_reply_query), "" },
 109         { "group_membership_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, groupmemb_query), NULL },
 110 #ifdef WITH_SESSION_MGMT
 111         { "simul_count_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, simul_count_query), "" },
 112         { "simul_verify_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, simul_verify_query), "" },
 113 #endif
 114         { "safe-characters", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_DEPRECATED, rlm_sql_config_t, allowed_chars), NULL },
 115         { "safe_characters", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, allowed_chars), "@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /" },
 116
 117         /*
 118          *      This only works for a few drivers.
 119          */
 120         { "query_timeout", FR_CONF_OFFSET(PW_TYPE_INTEGER, rlm_sql_config_t, query_timeout), NULL },
 121
 122         { "accounting", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) acct_config },
 123
 124         { "post-auth", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) postauth_config },
 125
 126         {NULL, -1, 0, NULL, NULL}
 127 };
 128
 129 /*
 130  *      Fall-Through checking function from rlm_files.c
 131  */
 132 static sql_fall_through_t fall_through(VALUE_PAIR *vp)
 133 {
 134         VALUE_PAIR *tmp;
 135         tmp = pairfind(vp, PW_FALL_THROUGH, 0, TAG_ANY);
 136
 137         return tmp ? tmp->vp_integer : FALL_THROUGH_DEFAULT;
 138 }
 139
 140 /*
 141  *      Yucky prototype.
 142  */
 143 static int generate_sql_clients(rlm_sql_t *inst);
 144 static size_t sql_escape_func(REQUEST *, char *out, size_t outlen, char const *in, void *arg);
 145
 146 /*
 147  *                      SQL xlat function
 148  *
 149  *  For selects the first value of the first column will be returned,
 150  *  for inserts, updates and deletes the number of rows affected will be
 151  *  returned instead.
 152  */
 153 static ssize_t sql_xlat(void *instance, REQUEST *request, char const *query, char *out, size_t freespace)
 154 {
 155         rlm_sql_handle_t *handle = NULL;
 156         rlm_sql_row_t row;
 157         rlm_sql_t *inst = instance;
 158         ssize_t ret = 0;
 159         size_t len = 0;
 160
 161         /*
 162          *      Add SQL-User-Name attribute just in case it is needed
 163          *      We could search the string fmt for SQL-User-Name to see if this is
 164          *      needed or not
 165          */
 166         sql_set_user(inst, request, NULL);
 167
 168         handle = fr_connection_get(inst->pool);
 169         if (!handle) {
 170                 return 0;
 171         }
 172
 173         rlm_sql_query_log(inst, request, NULL, query);
 174
 175         /*
 176          *      If the query starts with any of the following prefixes,
 177          *      then return the number of rows affected
 178          */
 179         if ((strncasecmp(query, "insert", 6) == 0) ||
 180             (strncasecmp(query, "update", 6) == 0) ||
 181             (strncasecmp(query, "delete", 6) == 0)) {
 182                 int numaffected;
 183                 char buffer[21]; /* 64bit max is 20 decimal chars + null byte */
 184
 185                 if (rlm_sql_query(&handle, inst, query) != RLM_SQL_OK) {
 186                         char const *error = (inst->module->sql_error)(handle, inst->config);
 187                         REDEBUG("SQL query failed: %s", error);
 188
 189                         ret = -1;
 190                         goto finish;
 191                 }
 192
 193                 numaffected = (inst->module->sql_affected_rows)(handle, inst->config);
 194                 if (numaffected < 1) {
 195                         RDEBUG("SQL query affected no rows");
 196
 197                         goto finish;
 198                 }
 199
 200                 /*
 201                  *      Don't chop the returned number if freespace is
 202                  *      too small.  This hack is necessary because
 203                  *      some implementations of snprintf return the
 204                  *      size of the written data, and others return
 205                  *      the size of the data they *would* have written
 206                  *      if the output buffer was large enough.
 207                  */
 208                 snprintf(buffer, sizeof(buffer), "%d", numaffected);
 209
 210                 len = strlen(buffer);
 211                 if (len >= freespace){
 212                         RDEBUG("rlm_sql (%s): Can't write result, insufficient string space", inst->config->xlat_name);
 213
 214                         (inst->module->sql_finish_query)(handle, inst->config);
 215
 216                         ret = -1;
 217                         goto finish;
 218                 }
 219
 220                 memcpy(out, buffer, len + 1); /* we did bounds checking above */
 221                 ret = len;
 222
 223                 (inst->module->sql_finish_query)(handle, inst->config);
 224
 225                 goto finish;
 226         } /* else it's a SELECT statement */
 227
 228         if (rlm_sql_select_query(&handle, inst, query) != RLM_SQL_OK) {
 229                 ret = -1;  /* error handled by rlm_sql_select_query */
 230
 231                 goto finish;
 232         }
 233
 234         ret = rlm_sql_fetch_row(&handle, inst);
 235         if (ret) {
 236                 REDEBUG("SQL query failed");
 237                 (inst->module->sql_finish_select_query)(handle, inst->config);
 238                 ret = -1;
 239
 240                 goto finish;
 241         }
 242
 243         row = handle->row;
 244         if (!row) {
 245                 RDEBUG("SQL query returned no results");
 246                 (inst->module->sql_finish_select_query)(handle, inst->config);
 247                 ret = -1;
 248
 249                 goto finish;
 250         }
 251
 252         if (!row[0]){
 253                 RDEBUG("NULL value in first column of result");
 254                 (inst->module->sql_finish_select_query)(handle, inst->config);
 255                 ret = -1;
 256
 257                 goto finish;
 258         }
 259
 260         len = strlen(row[0]);
 261         if (len >= freespace){
 262                 RDEBUG("Insufficient string space");
 263                 (inst->module->sql_finish_select_query)(handle, inst->config);
 264
 265                 ret = -1;
 266                 goto finish;
 267         }
 268
 269         strlcpy(out, row[0], freespace);
 270         ret = len;
 271
 272         (inst->module->sql_finish_select_query)(handle, inst->config);
 273
 274 finish:
 275         fr_connection_release(inst->pool, handle);
 276
 277         return ret;
 278 }
 279
 280 static int generate_sql_clients(rlm_sql_t *inst)
 281 {
 282         rlm_sql_handle_t *handle;
 283         rlm_sql_row_t row;
 284         unsigned int i = 0;
 285         RADCLIENT *c;
 286
 287         DEBUG("rlm_sql (%s): Processing generate_sql_clients",
 288               inst->config->xlat_name);
 289
 290         DEBUG("rlm_sql (%s) in generate_sql_clients: query is %s",
 291               inst->config->xlat_name, inst->config->client_query);
 292
 293         handle = fr_connection_get(inst->pool);
 294         if (!handle) {
 295                 return -1;
 296         }
 297
 298         if (rlm_sql_select_query(&handle, inst, inst->config->client_query) != RLM_SQL_OK) return -1;
 299
 300         while ((rlm_sql_fetch_row(&handle, inst) == 0) && (row = handle->row)) {
 301                 char *server = NULL;
 302                 i++;
 303
 304                 /*
 305                  *  The return data for each row MUST be in the following order:
 306                  *
 307                  *  0. Row ID (currently unused)
 308                  *  1. Name (or IP address)
 309                  *  2. Shortname
 310                  *  3. Type
 311                  *  4. Secret
 312                  *  5. Virtual Server (optional)
 313                  */
 314                 if (!row[0]){
 315                         ERROR("rlm_sql (%s): No row id found on pass %d",inst->config->xlat_name,i);
 316                         continue;
 317                 }
 318                 if (!row[1]){
 319                         ERROR("rlm_sql (%s): No nasname found for row %s",inst->config->xlat_name,row[0]);
 320                         continue;
 321                 }
 322                 if (!row[2]){
 323                         ERROR("rlm_sql (%s): No short name found for row %s",inst->config->xlat_name,row[0]);
 324                         continue;
 325                 }
 326                 if (!row[4]){
 327                         ERROR("rlm_sql (%s): No secret found for row %s",inst->config->xlat_name,row[0]);
 328                         continue;
 329                 }
 330
 331                 if (((inst->module->sql_num_fields)(handle, inst->config) > 5) && (row[5] != NULL) && *row[5]) {
 332                         server = row[5];
 333                 }
 334
 335                 DEBUG("rlm_sql (%s): Adding client %s (%s) to %s clients list",
 336                       inst->config->xlat_name,
 337                       row[1], row[2], server ? server : "global");
 338
 339                 /* FIXME: We should really pass a proper ctx */
 340                 c = client_afrom_query(NULL,
 341                                       row[1],   /* identifier */
 342                                       row[4],   /* secret */
 343                                       row[2],   /* shortname */
 344                                       row[3],   /* type */
 345                                       server,   /* server */
 346                                       false);   /* require message authenticator */
 347                 if (!c) {
 348                         continue;
 349                 }
 350
 351                 if (!client_add(NULL, c)) {
 352                         WARN("Failed to add client, possible duplicate?");
 353
 354                         client_free(c);
 355                         continue;
 356                 }
 357
 358                 DEBUG("rlm_sql (%s): Client \"%s\" (%s) added", c->longname, c->shortname,
 359                       inst->config->xlat_name);
 360         }
 361
 362         (inst->module->sql_finish_select_query)(handle, inst->config);
 363         fr_connection_release(inst->pool, handle);
 364
 365         return 0;
 366 }
 367
 368
 369 /*
 370  *      Translate the SQL queries.
 371  */
 372 static size_t sql_escape_func(UNUSED REQUEST *request, char *out, size_t outlen,
 373                               char const *in, void *arg)
 374 {
 375         rlm_sql_t *inst = arg;
 376         size_t len = 0;
 377
 378         while (in[0]) {
 379                 size_t utf8_len;
 380
 381                 /*
 382                  *      Allow all multi-byte UTF8 characters.
 383                  */
 384                 utf8_len = fr_utf8_char((uint8_t const *) in);
 385                 if (utf8_len > 1) {
 386                         if (outlen <= utf8_len) break;
 387
 388                         memcpy(out, in, utf8_len);
 389                         in += utf8_len;
 390                         out += utf8_len;
 391
 392                         outlen -= utf8_len;
 393                         len += utf8_len;
 394                         continue;
 395                 }
 396
 397                 /*
 398                  *      Because we register our own escape function
 399                  *      we're now responsible for escaping all special
 400                  *      chars in an xlat expansion or attribute value.
 401                  */
 402                 switch (in[0]) {
 403                 case '\n':
 404                         if (outlen <= 2) break;
 405                         out[0] = '\'';
 406                         out[1] = 'n';
 407
 408                         in++;
 409                         out += 2;
 410                         outlen -= 2;
 411                         len += 2;
 412                         break;
 413
 414                 case '\r':
 415                         if (outlen <= 2) break;
 416                         out[0] = '\'';
 417                         out[1] = 'r';
 418
 419                         in++;
 420                         out += 2;
 421                         outlen -= 2;
 422                         len += 2;
 423                         break;
 424
 425                 case '\t':
 426                         if (outlen <= 2) break;
 427                         out[0] = '\'';
 428                         out[1] = 't';
 429
 430                         in++;
 431                         out += 2;
 432                         outlen -= 2;
 433                         len += 2;
 434                         break;
 435                 }
 436
 437                 /*
 438                  *      Non-printable characters get replaced with their
 439                  *      mime-encoded equivalents.
 440                  */
 441                 if ((in[0] < 32) ||
 442                     strchr(inst->config->allowed_chars, *in) == NULL) {
 443                         /*
 444                          *      Only 3 or less bytes available.
 445                          */
 446                         if (outlen <= 3) {
 447                                 break;
 448                         }
 449
 450                         snprintf(out, outlen, "=%02X", (unsigned char) in[0]);
 451                         in++;
 452                         out += 3;
 453                         outlen -= 3;
 454                         len += 3;
 455                         continue;
 456                 }
 457
 458                 /*
 459                  *      Only one byte left.
 460                  */
 461                 if (outlen <= 1) {
 462                         break;
 463                 }
 464
 465                 /*
 466                  *      Allowed character.
 467                  */
 468                 *out = *in;
 469                 out++;
 470                 in++;
 471                 outlen--;
 472                 len++;
 473         }
 474         *out = '\0';
 475         return len;
 476 }
 477
 478 /*
 479  *      Set the SQL user name.
 480  *
 481  *      We don't call the escape function here. The resulting string
 482  *      will be escaped later in the queries xlat so we don't need to
 483  *      escape it twice. (it will make things wrong if we have an
 484  *      escape candidate character in the username)
 485  */
 486 int sql_set_user(rlm_sql_t *inst, REQUEST *request, char const *username)
 487 {
 488         char *expanded = NULL;
 489         VALUE_PAIR *vp = NULL;
 490         char const *sqluser;
 491         ssize_t len;
 492
 493         rad_assert(request->packet != NULL);
 494
 495         if (username != NULL) {
 496                 sqluser = username;
 497         } else if (inst->config->query_user[0] != '\0') {
 498                 sqluser = inst->config->query_user;
 499         } else {
 500                 return 0;
 501         }
 502
 503         len = radius_axlat(&expanded, request, sqluser, NULL, NULL);
 504         if (len < 0) {
 505                 return -1;
 506         }
 507
 508         vp = pairalloc(request->packet, inst->sql_user);
 509         if (!vp) {
 510                 talloc_free(expanded);
 511                 return -1;
 512         }
 513
 514         pairstrsteal(vp, expanded);
 515         RDEBUG2("SQL-User-Name set to '%s'", vp->vp_strvalue);
 516         vp->op = T_OP_SET;
 517         radius_pairmove(request, &request->packet->vps, vp, false);     /* needs to be pair move else op is not respected */
 518
 519         return 0;
 520 }
 521
 522 /*
 523  *      Do a set/unset user, so it's a bit clearer what's going on.
 524  */
 525 #define sql_unset_user(_i, _r) pairdelete(&_r->packet->vps, _i->sql_user->attr, _i->sql_user->vendor, TAG_ANY)
 526
 527 static int sql_get_grouplist(rlm_sql_t *inst, rlm_sql_handle_t **handle, REQUEST *request,
 528                              rlm_sql_grouplist_t **phead)
 529 {
 530         char    *expanded = NULL;
 531         int     num_groups = 0;
 532         rlm_sql_row_t row;
 533         rlm_sql_grouplist_t *entry;
 534         int ret;
 535
 536         /* NOTE: sql_set_user should have been run before calling this function */
 537
 538         entry = *phead = NULL;
 539
 540         if (!inst->config->groupmemb_query) return 0;
 541
 542         if (radius_axlat(&expanded, request, inst->config->groupmemb_query, sql_escape_func, inst) < 0) return -1;
 543
 544         ret = rlm_sql_select_query(handle, inst, expanded);
 545         talloc_free(expanded);
 546         if (ret != RLM_SQL_OK) return -1;
 547
 548         while (rlm_sql_fetch_row(handle, inst) == 0) {
 549                 row = (*handle)->row;
 550                 if (!row)
 551                         break;
 552
 553                 if (!row[0]){
 554                         RDEBUG("row[0] returned NULL");
 555                         (inst->module->sql_finish_select_query)(*handle, inst->config);
 556                         talloc_free(entry);
 557                         return -1;
 558                 }
 559
 560                 if (!*phead) {
 561                         *phead = talloc_zero(*handle, rlm_sql_grouplist_t);
 562                         entry = *phead;
 563                 } else {
 564                         entry->next = talloc_zero(*phead, rlm_sql_grouplist_t);
 565                         entry = entry->next;
 566                 }
 567                 entry->next = NULL;
 568                 entry->name = talloc_typed_strdup(entry, row[0]);
 569
 570                 num_groups++;
 571         }
 572
 573         (inst->module->sql_finish_select_query)(*handle, inst->config);
 574
 575         return num_groups;
 576 }
 577
 578
 579 /*
 580  * sql groupcmp function. That way we can do group comparisons (in the users file for example)
 581  * with the group memberships reciding in sql
 582  * The group membership query should only return one element which is the username. The returned
 583  * username will then be checked with the passed check string.
 584  */
 585
 586 static int CC_HINT(nonnull (1, 2, 4)) sql_groupcmp(void *instance, REQUEST *request, UNUSED VALUE_PAIR *request_vp,
 587                                                    VALUE_PAIR *check, UNUSED VALUE_PAIR *check_pairs,
 588                                                    UNUSED VALUE_PAIR **reply_pairs)
 589 {
 590         rlm_sql_handle_t *handle;
 591         rlm_sql_t *inst = instance;
 592         rlm_sql_grouplist_t *head, *entry;
 593
 594         RDEBUG("sql_groupcmp");
 595
 596         if (check->length == 0){
 597                 RDEBUG("sql_groupcmp: Illegal group name");
 598                 return 1;
 599         }
 600
 601         /*
 602          *      Set, escape, and check the user attr here
 603          */
 604         if (sql_set_user(inst, request, NULL) < 0)
 605                 return 1;
 606
 607         /*
 608          *      Get a socket for this lookup
 609          */
 610         handle = fr_connection_get(inst->pool);
 611         if (!handle) {
 612                 return 1;
 613         }
 614
 615         /*
 616          *      Get the list of groups this user is a member of
 617          */
 618         if (sql_get_grouplist(inst, &handle, request, &head) < 0) {
 619                 REDEBUG("Error getting group membership");
 620                 fr_connection_release(inst->pool, handle);
 621                 return 1;
 622         }
 623
 624         for (entry = head; entry != NULL; entry = entry->next) {
 625                 if (strcmp(entry->name, check->vp_strvalue) == 0){
 626                         RDEBUG("sql_groupcmp finished: User is a member of group %s",
 627                                check->vp_strvalue);
 628                         talloc_free(head);
 629                         fr_connection_release(inst->pool, handle);
 630                         return 0;
 631                 }
 632         }
 633
 634         /* Free the grouplist */
 635         talloc_free(head);
 636         fr_connection_release(inst->pool, handle);
 637
 638         RDEBUG("sql_groupcmp finished: User is NOT a member of group %s", check->vp_strvalue);
 639
 640         return 1;
 641 }
 642
 643 static rlm_rcode_t rlm_sql_process_groups(rlm_sql_t *inst, REQUEST *request, rlm_sql_handle_t **handle,
 644                                           sql_fall_through_t *do_fall_through)
 645 {
 646         rlm_rcode_t             rcode = RLM_MODULE_NOOP;
 647         VALUE_PAIR              *check_tmp = NULL, *reply_tmp = NULL, *sql_group = NULL;
 648         rlm_sql_grouplist_t     *head = NULL, *entry = NULL;
 649
 650         char                    *expanded = NULL;
 651         int                     rows;
 652
 653         rad_assert(request->packet != NULL);
 654
 655         /*
 656          *      Get the list of groups this user is a member of
 657          */
 658         rows = sql_get_grouplist(inst, handle, request, &head);
 659         if (rows < 0) {
 660                 REDEBUG("Error retrieving group list");
 661
 662                 return RLM_MODULE_FAIL;
 663         }
 664         if (rows == 0) {
 665                 RDEBUG2("User not found in any groups");
 666                 rcode = RLM_MODULE_NOTFOUND;
 667                 *do_fall_through = FALL_THROUGH_DEFAULT;
 668
 669                 goto finish;
 670         }
 671         rad_assert(head);
 672
 673         RDEBUG2("User found in the group table");
 674
 675         /*
 676          *      Add the Sql-Group attribute to the request list so we know
 677          *      which group we're retrieving attributes for
 678          */
 679         sql_group = pairmake_packet("Sql-Group", NULL, T_OP_EQ);
 680         if (!sql_group) {
 681                 REDEBUG("Error creating Sql-Group attribute");
 682                 rcode = RLM_MODULE_FAIL;
 683                 goto finish;
 684         }
 685
 686         entry = head;
 687         do {
 688         next:
 689                 pairstrcpy(sql_group, entry->name);
 690
 691                 if (inst->config->authorize_group_check_query && *inst->config->authorize_group_check_query) {
 692                         vp_cursor_t cursor;
 693                         VALUE_PAIR *vp;
 694
 695                         /*
 696                          *      Expand the group query
 697                          */
 698                         if (radius_axlat(&expanded, request, inst->config->authorize_group_check_query,
 699                                          sql_escape_func, inst) < 0) {
 700                                 REDEBUG("Error generating query");
 701                                 rcode = RLM_MODULE_FAIL;
 702                                 goto finish;
 703                         }
 704
 705                         rows = sql_getvpdata(request, inst, request, handle, &check_tmp, expanded);
 706                         TALLOC_FREE(expanded);
 707                         if (rows < 0) {
 708                                 REDEBUG("Error retrieving check pairs for group %s", entry->name);
 709                                 rcode = RLM_MODULE_FAIL;
 710                                 goto finish;
 711                         }
 712
 713                         /*
 714                          *      If we got check rows we need to process them before we decide to
 715                          *      process the reply rows
 716                          */
 717                         if ((rows > 0) &&
 718                             (paircompare(request, request->packet->vps, check_tmp, &request->reply->vps) != 0)) {
 719                                 pairfree(&check_tmp);
 720                                 entry = entry->next;
 721
 722                                 goto next;      /* != continue */
 723                         }
 724
 725                         RDEBUG2("Group \"%s\": Conditional check items matched", entry->name);
 726                         rcode = RLM_MODULE_OK;
 727
 728                         RDEBUG2("Group \"%s\": Merging assignment check items", entry->name);
 729                         RINDENT();
 730                         for (vp = fr_cursor_init(&cursor, &check_tmp);
 731                              vp;
 732                              vp = fr_cursor_next(&cursor)) {
 733                                 if (!fr_assignment_op[vp->op]) continue;
 734
 735                                 rdebug_pair(L_DBG_LVL_2, request, vp);
 736                         }
 737                         REXDENT();
 738                         radius_pairmove(request, &request->config_items, check_tmp, true);
 739                         check_tmp = NULL;
 740                 }
 741
 742                 if (inst->config->authorize_group_reply_query && *inst->config->authorize_group_reply_query) {
 743                         /*
 744                          *      Now get the reply pairs since the paircompare matched
 745                          */
 746                         if (radius_axlat(&expanded, request, inst->config->authorize_group_reply_query,
 747                                          sql_escape_func, inst) < 0) {
 748                                 REDEBUG("Error generating query");
 749                                 rcode = RLM_MODULE_FAIL;
 750                                 goto finish;
 751                         }
 752
 753                         rows = sql_getvpdata(request->reply, inst, request, handle, &reply_tmp, expanded);
 754                         TALLOC_FREE(expanded);
 755                         if (rows < 0) {
 756                                 REDEBUG("Error retrieving reply pairs for group %s", entry->name);
 757                                 rcode = RLM_MODULE_FAIL;
 758                                 goto finish;
 759                         }
 760                         *do_fall_through = fall_through(reply_tmp);
 761
 762                         RDEBUG2("Group \"%s\": Merging reply items", entry->name);
 763                         rcode = RLM_MODULE_OK;
 764
 765                         rdebug_pair_list(L_DBG_LVL_2, request, reply_tmp, NULL);
 766
 767                         radius_pairmove(request, &request->reply->vps, reply_tmp, true);
 768                         reply_tmp = NULL;
 769                 /*
 770                  *      If there's no reply query configured, then we assume
 771                  *      FALL_THROUGH_NO, which is the same as the users file if you
 772                  *      had no reply attributes.
 773                  */
 774                 } else {
 775                         *do_fall_through = FALL_THROUGH_DEFAULT;
 776                 }
 777
 778                 entry = entry->next;
 779         } while (entry != NULL && (*do_fall_through == FALL_THROUGH_YES));
 780
 781 finish:
 782         talloc_free(head);
 783         pairdelete(&request->packet->vps, PW_SQL_GROUP, 0, TAG_ANY);
 784
 785         return rcode;
 786 }
 787
 788
 789 static int mod_detach(void *instance)
 790 {
 791         rlm_sql_t *inst = instance;
 792
 793         if (inst->pool) fr_connection_pool_delete(inst->pool);
 794
 795         /*
 796          *  We need to explicitly free all children, so if the driver
 797          *  parented any memory off the instance, their destructors
 798          *  run before we unload the bytecode for them.
 799          *
 800          *  If we don't do this, we get a SEGV deep inside the talloc code
 801          *  when it tries to call a destructor that no longer exists.
 802          */
 803         talloc_free_children(inst);
 804
 805         /*
 806          *  Decrements the reference count. The driver object won't be unloaded
 807          *  until all instances of rlm_sql that use it have been destroyed.
 808          */
 809         if (inst->handle) dlclose(inst->handle);
 810
 811         return 0;
 812 }
 813
 814 static int mod_instantiate(CONF_SECTION *conf, void *instance)
 815 {
 816         rlm_sql_t *inst = instance;
 817
 818         /*
 819          *      Hack...
 820          */
 821         inst->config = &inst->myconfig;
 822         inst->cs = conf;
 823
 824         inst->config->xlat_name = cf_section_name2(conf);
 825         if (!inst->config->xlat_name) {
 826                 inst->config->xlat_name = cf_section_name1(conf);
 827         } else {
 828                 char *group_name;
 829                 DICT_ATTR const *da;
 830                 ATTR_FLAGS flags;
 831
 832                 /*
 833                  *      Allocate room for <instance>-SQL-Group
 834                  */
 835                 group_name = talloc_typed_asprintf(inst, "%s-SQL-Group", inst->config->xlat_name);
 836                 DEBUG("rlm_sql (%s): Creating new attribute %s",
 837                       inst->config->xlat_name, group_name);
 838
 839                 memset(&flags, 0, sizeof(flags));
 840                 if (dict_addattr(group_name, -1, 0, PW_TYPE_STRING, flags) < 0) {
 841                         ERROR("rlm_sql (%s): Failed to create "
 842                                "attribute %s: %s", inst->config->xlat_name, group_name,
 843                                fr_strerror());
 844                         return -1;
 845                 }
 846
 847                 da = dict_attrbyname(group_name);
 848                 if (!da) {
 849                         ERROR("rlm_sql (%s): Failed to create "
 850                                "attribute %s", inst->config->xlat_name, group_name);
 851                         return -1;
 852                 }
 853
 854                 if (inst->config->groupmemb_query &&
 855                     inst->config->groupmemb_query[0]) {
 856                         DEBUG("rlm_sql (%s): Registering sql_groupcmp for %s",
 857                               inst->config->xlat_name, group_name);
 858                         paircompare_register(da, dict_attrbyvalue(PW_USER_NAME, 0),
 859                                              false, sql_groupcmp, inst);
 860                 }
 861         }
 862
 863         rad_assert(inst->config->xlat_name);
 864
 865         /*
 866          *      Complain if the strings exist, but are empty.
 867          */
 868 #define CHECK_STRING(_x) if (inst->config->_x && !inst->config->_x[0]) \
 869 do { \
 870         WARN("rlm_sql (%s): " STRINGIFY(_x) " is empty.  Please delete it from the configuration", inst->config->xlat_name);\
 871         inst->config->_x = NULL;\
 872 } while (0)
 873
 874         CHECK_STRING(groupmemb_query);
 875         CHECK_STRING(authorize_check_query);
 876         CHECK_STRING(authorize_reply_query);
 877         CHECK_STRING(authorize_group_check_query);
 878         CHECK_STRING(authorize_group_reply_query);
 879
 880         /*
 881          *      Sanity check for crazy people.
 882          */
 883         if (strncmp(inst->config->sql_driver_name, "rlm_sql_", 8) != 0) {
 884                 ERROR("rlm_sql (%s): \"%s\" is NOT an SQL driver!", inst->config->xlat_name, inst->config->sql_driver_name);
 885                 return -1;
 886         }
 887
 888         /*
 889          *      We need authorize_group_check_query or authorize_group_reply_query
 890          *      if group_membership_query is set.
 891          *
 892          *      Or we need group_membership_query if authorize_group_check_query or
 893          *      authorize_group_reply_query is set.
 894          */
 895         if (!inst->config->groupmemb_query) {
 896                 if (inst->config->authorize_group_check_query) {
 897                         WARN("rlm_sql (%s): Ignoring authorize_group_check_query as group_membership_query is not configured",
 898                              inst->config->xlat_name);
 899                         return -1;
 900                 }
 901
 902                 if (inst->config->authorize_group_reply_query) {
 903                         WARN("rlm_sql (%s): Ignoring authorize_group_reply_query as group_membership_query is not configured",
 904                              inst->config->xlat_name);
 905                         return -1;
 906                 }
 907         } else {
 908                 if (!inst->config->authorize_group_check_query) {
 909                         ERROR("rlm_sql (%s): authorize_group_check_query is required because group_membership_query is configured",
 910                              inst->config->xlat_name);
 911                         return -1;
 912                 }
 913
 914                 if (inst->config->authorize_group_reply_query) {
 915                         ERROR("rlm_sql (%s): authorize_group_reply_query is required because group_membership_query is configured",
 916                              inst->config->xlat_name);
 917                         return -1;
 918                 }
 919         }
 920
 921         /*
 922          *      This will always exist, as cf_section_parse_init()
 923          *      will create it if it doesn't exist.  However, the
 924          *      "reference" config item won't exist in an auto-created
 925          *      configuration.  So if that doesn't exist, we ignore
 926          *      the whole subsection.
 927          */
 928         inst->config->accounting.cs = cf_section_sub_find(conf, "accounting");
 929         inst->config->accounting.reference_cp = (cf_pair_find(inst->config->accounting.cs, "reference") != NULL);
 930
 931         inst->config->postauth.cs = cf_section_sub_find(conf, "post-auth");
 932         inst->config->postauth.reference_cp = (cf_pair_find(inst->config->postauth.cs, "reference") != NULL);
 933
 934         /*
 935          *      Cache the SQL-User-Name DICT_ATTR, so we can be slightly
 936          *      more efficient about creating SQL-User-Name attributes.
 937          */
 938         inst->sql_user = dict_attrbyname("SQL-User-Name");
 939         if (!inst->sql_user) {
 940                 return -1;
 941         }
 942
 943         /*
 944          *      Export these methods, too.  This avoids RTDL_GLOBAL.
 945          */
 946         inst->sql_set_user              = sql_set_user;
 947         inst->sql_escape_func           = sql_escape_func;
 948         inst->sql_query                 = rlm_sql_query;
 949         inst->sql_select_query          = rlm_sql_select_query;
 950         inst->sql_fetch_row             = rlm_sql_fetch_row;
 951
 952         /*
 953          *      Register the SQL xlat function
 954          */
 955         xlat_register(inst->config->xlat_name, sql_xlat, sql_escape_func, inst);
 956
 957         /*
 958          *      Load the appropriate driver for our database
 959          */
 960         inst->handle = lt_dlopenext(inst->config->sql_driver_name);
 961         if (!inst->handle) {
 962                 ERROR("Could not link driver %s: %s", inst->config->sql_driver_name, dlerror());
 963                 ERROR("Make sure it (and all its dependent libraries!) are in the search path of your system's ld");
 964                 return -1;
 965         }
 966
 967         inst->module = (rlm_sql_module_t *) dlsym(inst->handle,
 968                                                   inst->config->sql_driver_name);
 969         if (!inst->module) {
 970                 ERROR("Could not link symbol %s: %s", inst->config->sql_driver_name, dlerror());
 971                 return -1;
 972         }
 973
 974         if (inst->module->mod_instantiate) {
 975                 CONF_SECTION *cs;
 976                 char const *name;
 977
 978                 name = strrchr(inst->config->sql_driver_name, '_');
 979                 if (!name) {
 980                         name = inst->config->sql_driver_name;
 981                 } else {
 982                         name++;
 983                 }
 984
 985                 cs = cf_section_sub_find(conf, name);
 986                 if (!cs) {
 987                         cs = cf_section_alloc(conf, name, NULL);
 988                         if (!cs) {
 989                                 return -1;
 990                         }
 991                 }
 992
 993                 /*
 994                  *      It's up to the driver to register a destructor
 995                  */
 996                 if (inst->module->mod_instantiate(cs, inst->config) < 0) {
 997                         return -1;
 998                 }
 999         }
1000
1001         inst->lf = fr_logfile_init(inst);
1002         if (!inst->lf) {
1003                 cf_log_err_cs(conf, "Failed creating log file context");
1004                 return -1;
1005         }
1006
1007         INFO("rlm_sql (%s): Driver %s (module %s) loaded and linked", inst->config->xlat_name,
1008              inst->config->sql_driver_name, inst->module->name);
1009
1010         /*
1011          *      Initialise the connection pool for this instance
1012          */
1013         INFO("rlm_sql (%s): Attempting to connect to database \"%s\"", inst->config->xlat_name, inst->config->sql_db);
1014
1015         inst->pool = fr_connection_pool_module_init(inst->cs, inst, mod_conn_create, NULL, NULL);
1016         if (!inst->pool) return -1;
1017
1018         if (inst->config->groupmemb_query &&
1019             inst->config->groupmemb_query[0]) {
1020                 paircompare_register(dict_attrbyvalue(PW_SQL_GROUP, 0),
1021                                 dict_attrbyvalue(PW_USER_NAME, 0), false, sql_groupcmp, inst);
1022         }
1023
1024         if (inst->config->do_clients) {
1025                 if (generate_sql_clients(inst) == -1){
1026                         ERROR("Failed to load clients from SQL");
1027                         return -1;
1028                 }
1029         }
1030
1031         return RLM_MODULE_OK;
1032 }
1033
1034
1035 static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *request)
1036 {
1037         rlm_rcode_t rcode = RLM_MODULE_NOOP;
1038
1039         rlm_sql_t *inst = instance;
1040         rlm_sql_handle_t  *handle;
1041
1042         VALUE_PAIR *check_tmp = NULL;
1043         VALUE_PAIR *reply_tmp = NULL;
1044         VALUE_PAIR *user_profile = NULL;
1045
1046         bool    user_found = false;
1047
1048         sql_fall_through_t do_fall_through = FALL_THROUGH_DEFAULT;
1049
1050         int     rows;
1051
1052         char    *expanded = NULL;
1053
1054         rad_assert(request->packet != NULL);
1055         rad_assert(request->reply != NULL);
1056
1057         if (!inst->config->authorize_check_query && !inst->config->authorize_reply_query &&
1058             !inst->config->read_groups && !inst->config->read_profiles) {
1059                 RWDEBUG("No authorization checks configured, returning noop");
1060
1061                 return RLM_MODULE_NOOP;
1062         }
1063
1064         /*
1065          *      Set, escape, and check the user attr here
1066          */
1067         if (sql_set_user(inst, request, NULL) < 0) {
1068                 return RLM_MODULE_FAIL;
1069         }
1070
1071         /*
1072          *      Reserve a socket
1073          *
1074          *      After this point use goto error or goto release to cleanup socket temporary pairlists and
1075          *      temporary attributes.
1076          */
1077         handle = fr_connection_get(inst->pool);
1078         if (!handle) {
1079                 rcode = RLM_MODULE_FAIL;
1080                 goto error;
1081         }
1082
1083         /*
1084          *      Query the check table to find any conditions associated with this user/realm/whatever...
1085          */
1086         if (inst->config->authorize_check_query && *inst->config->authorize_check_query) {
1087                 vp_cursor_t cursor;
1088                 VALUE_PAIR *vp;
1089
1090                 if (radius_axlat(&expanded, request, inst->config->authorize_check_query,
1091                                  sql_escape_func, inst) < 0) {
1092                         REDEBUG("Error generating query");
1093                         rcode = RLM_MODULE_FAIL;
1094                         goto error;
1095                 }
1096
1097                 rows = sql_getvpdata(request, inst, request, &handle, &check_tmp, expanded);
1098                 TALLOC_FREE(expanded);
1099                 if (rows < 0) {
1100                         REDEBUG("SQL query error getting check attributes");
1101                         rcode = RLM_MODULE_FAIL;
1102                         goto error;
1103                 }
1104
1105                 if (rows == 0) goto skipreply;  /* Don't need to free VPs we don't have */
1106
1107                 /*
1108                  *      Only do this if *some* check pairs were returned
1109                  */
1110                 RDEBUG2("User found in radcheck table");
1111                 user_found = true;
1112                 if (paircompare(request, request->packet->vps, check_tmp, &request->reply->vps) != 0) {
1113                         pairfree(&check_tmp);
1114                         check_tmp = NULL;
1115                         goto skipreply;
1116                 }
1117
1118                 RDEBUG2("Conditional check items matched, merging assignment check items");
1119                 RINDENT();
1120                 for (vp = fr_cursor_init(&cursor, &check_tmp);
1121                      vp;
1122                      vp = fr_cursor_next(&cursor)) {
1123                         if (!fr_assignment_op[vp->op]) continue;
1124
1125                         rdebug_pair(2, request, vp);
1126                 }
1127                 REXDENT();
1128                 radius_pairmove(request, &request->config_items, check_tmp, true);
1129
1130                 rcode = RLM_MODULE_OK;
1131                 check_tmp = NULL;
1132         }
1133
1134         if (inst->config->authorize_reply_query && *inst->config->authorize_reply_query) {
1135                 /*
1136                  *      Now get the reply pairs since the paircompare matched
1137                  */
1138                 if (radius_axlat(&expanded, request, inst->config->authorize_reply_query,
1139                                  sql_escape_func, inst) < 0) {
1140                         REDEBUG("Error generating query");
1141                         rcode = RLM_MODULE_FAIL;
1142                         goto error;
1143                 }
1144
1145                 rows = sql_getvpdata(request->reply, inst, request, &handle, &reply_tmp, expanded);
1146                 TALLOC_FREE(expanded);
1147                 if (rows < 0) {
1148                         REDEBUG("SQL query error getting reply attributes");
1149                         rcode = RLM_MODULE_FAIL;
1150                         goto error;
1151                 }
1152
1153                 if (rows == 0) goto skipreply;
1154
1155                 do_fall_through = fall_through(reply_tmp);
1156
1157                 RDEBUG2("User found in radreply table, merging reply items");
1158                 user_found = true;
1159
1160                 rdebug_pair_list(L_DBG_LVL_2, request, reply_tmp, NULL);
1161
1162                 radius_pairmove(request, &request->reply->vps, reply_tmp, true);
1163
1164                 rcode = RLM_MODULE_OK;
1165                 reply_tmp = NULL;
1166         }
1167
1168 skipreply:
1169         if ((do_fall_through == FALL_THROUGH_YES) ||
1170             (inst->config->read_groups && (do_fall_through == FALL_THROUGH_DEFAULT))) {
1171                 rlm_rcode_t ret;
1172
1173                 RDEBUG3("... falling-through to group processing");
1174                 ret = rlm_sql_process_groups(inst, request, &handle, &do_fall_through);
1175                 switch (ret) {
1176                 /*
1177                  *      Nothing bad happened, continue...
1178                  */
1179                 case RLM_MODULE_UPDATED:
1180                         rcode = RLM_MODULE_UPDATED;
1181                         /* FALL-THROUGH */
1182                 case RLM_MODULE_OK:
1183                         if (rcode != RLM_MODULE_UPDATED) {
1184                                 rcode = RLM_MODULE_OK;
1185                         }
1186                         /* FALL-THROUGH */
1187                 case RLM_MODULE_NOOP:
1188                         user_found = true;
1189                         break;
1190
1191                 case RLM_MODULE_NOTFOUND:
1192                         break;
1193
1194                 default:
1195                         rcode = ret;
1196                         goto release;
1197                 }
1198         }
1199
1200         /*
1201          *      Repeat the above process with the default profile or User-Profile
1202          */
1203         if ((do_fall_through == FALL_THROUGH_YES) ||
1204             (inst->config->read_profiles && (do_fall_through == FALL_THROUGH_DEFAULT))) {
1205                 rlm_rcode_t ret;
1206
1207                 /*
1208                  *  Check for a default_profile or for a User-Profile.
1209                  */
1210                 RDEBUG3("... falling-through to profile processing");
1211                 user_profile = pairfind(request->config_items, PW_USER_PROFILE, 0, TAG_ANY);
1212
1213                 char const *profile = user_profile ?
1214                                       user_profile->vp_strvalue :
1215                                       inst->config->default_profile;
1216
1217                 if (!profile || !*profile) {
1218                         goto release;
1219                 }
1220
1221                 RDEBUG2("Checking profile %s", profile);
1222
1223                 if (sql_set_user(inst, request, profile) < 0) {
1224                         REDEBUG("Error setting profile");
1225                         rcode = RLM_MODULE_FAIL;
1226                         goto error;
1227                 }
1228
1229                 ret = rlm_sql_process_groups(inst, request, &handle, &do_fall_through);
1230                 switch (ret) {
1231                 /*
1232                  *      Nothing bad happened, continue...
1233                  */
1234                 case RLM_MODULE_UPDATED:
1235                         rcode = RLM_MODULE_UPDATED;
1236                         /* FALL-THROUGH */
1237                 case RLM_MODULE_OK:
1238                         if (rcode != RLM_MODULE_UPDATED) {
1239                                 rcode = RLM_MODULE_OK;
1240                         }
1241                         /* FALL-THROUGH */
1242                 case RLM_MODULE_NOOP:
1243                         user_found = true;
1244                         break;
1245
1246                 case RLM_MODULE_NOTFOUND:
1247                         break;
1248
1249                 default:
1250                         rcode = ret;
1251                         goto release;
1252                 }
1253         }
1254
1255         /*
1256          *      At this point the key (user) hasn't be found in the check table, the reply table
1257          *      or the group mapping table, and there was no matching profile.
1258          */
1259 release:
1260         if (!user_found) {
1261                 rcode = RLM_MODULE_NOTFOUND;
1262         }
1263
1264         fr_connection_release(inst->pool, handle);
1265         sql_unset_user(inst, request);
1266
1267         return rcode;
1268
1269 error:
1270         pairfree(&check_tmp);
1271         pairfree(&reply_tmp);
1272         sql_unset_user(inst, request);
1273
1274         fr_connection_release(inst->pool, handle);
1275
1276         return rcode;
1277 }
1278
1279 /*
1280  *      Generic function for failing between a bunch of queries.
1281  *
1282  *      Uses the same principle as rlm_linelog, expanding the 'reference' config
1283  *      item using xlat to figure out what query it should execute.
1284  *
1285  *      If the reference matches multiple config items, and a query fails or
1286  *      doesn't update any rows, the next matching config item is used.
1287  *
1288  */
1289 static int acct_redundant(rlm_sql_t *inst, REQUEST *request, sql_acct_section_t *section)
1290 {
1291         rlm_rcode_t             rcode = RLM_MODULE_OK;
1292
1293         rlm_sql_handle_t        *handle = NULL;
1294         int                     sql_ret;
1295         int                     numaffected = 0;
1296
1297         CONF_ITEM               *item;
1298         CONF_PAIR               *pair;
1299         char const              *attr = NULL;
1300         char const              *value;
1301
1302         char                    path[MAX_STRING_LEN];
1303         char                    *p = path;
1304         char                    *expanded = NULL;
1305
1306         rad_assert(section);
1307
1308         if (section->reference[0] != '.') {
1309                 *p++ = '.';
1310         }
1311
1312         if (radius_xlat(p, sizeof(path) - (p - path), request, section->reference, NULL, NULL) < 0) {
1313                 rcode = RLM_MODULE_FAIL;
1314
1315                 goto finish;
1316         }
1317
1318         item = cf_reference_item(NULL, section->cs, path);
1319         if (!item) {
1320                 rcode = RLM_MODULE_FAIL;
1321
1322                 goto finish;
1323         }
1324
1325         if (cf_item_is_section(item)){
1326                 REDEBUG("Sections are not supported as references");
1327                 rcode = RLM_MODULE_FAIL;
1328
1329                 goto finish;
1330         }
1331
1332         pair = cf_itemtopair(item);
1333         attr = cf_pair_attr(pair);
1334
1335         RDEBUG2("Using query template '%s'", attr);
1336
1337         handle = fr_connection_get(inst->pool);
1338         if (!handle) {
1339                 rcode = RLM_MODULE_FAIL;
1340
1341                 goto finish;
1342         }
1343
1344         sql_set_user(inst, request, NULL);
1345
1346         while (true) {
1347                 value = cf_pair_value(pair);
1348                 if (!value) {
1349                         RDEBUG("Ignoring null query");
1350                         rcode = RLM_MODULE_NOOP;
1351
1352                         goto finish;
1353                 }
1354
1355                 if (radius_axlat(&expanded, request, value, sql_escape_func, inst) < 0) {
1356                         rcode = RLM_MODULE_FAIL;
1357
1358                         goto finish;
1359                 }
1360
1361                 if (!*expanded) {
1362                         RDEBUG("Ignoring null query");
1363                         rcode = RLM_MODULE_NOOP;
1364                         talloc_free(expanded);
1365
1366                         goto finish;
1367                 }
1368
1369                 rlm_sql_query_log(inst, request, section, expanded);
1370
1371                 /*
1372                  *  If rlm_sql_query cannot use the socket it'll try and
1373                  *  reconnect. Reconnecting will automatically release
1374                  *  the current socket, and try to select a new one.
1375                  *
1376                  *  If we get RLM_SQL_RECONNECT it means all connections in the pool
1377                  *  were exhausted, and we couldn't create a new connection,
1378                  *  so we do not need to call fr_connection_release.
1379                  */
1380                 sql_ret = rlm_sql_query(&handle, inst, expanded);
1381                 TALLOC_FREE(expanded);
1382                 if (sql_ret == RLM_SQL_RECONNECT) {
1383                         rcode = RLM_MODULE_FAIL;
1384                         goto finish;
1385                 }
1386                 rad_assert(handle);
1387
1388                 /*
1389                  *  Assume all other errors are incidental, and just meant our
1390                  *  operation failed and its not a client or SQL syntax error.
1391                  *
1392                  *  @fixme We should actually be able to distinguish between key
1393                  *  constraint violations (which we expect) and other errors.
1394                  */
1395                 if (sql_ret == RLM_SQL_OK) {
1396                         numaffected = (inst->module->sql_affected_rows)(handle, inst->config);
1397                         if (numaffected > 0) {
1398                                 break;  /* A query succeeded, were done! */
1399                         }
1400
1401                         RDEBUG("No records updated");
1402                 }
1403
1404                 (inst->module->sql_finish_query)(handle, inst->config);
1405
1406                 /*
1407                  *  We assume all entries with the same name form a redundant
1408                  *  set of queries.
1409                  */
1410                 pair = cf_pair_find_next(section->cs, pair, attr);
1411
1412                 if (!pair) {
1413                         RDEBUG("No additional queries configured");
1414                         rcode = RLM_MODULE_NOOP;
1415
1416                         goto finish;
1417                 }
1418
1419                 RDEBUG("Trying next query...");
1420         }
1421
1422         (inst->module->sql_finish_query)(handle, inst->config);
1423
1424 finish:
1425         talloc_free(expanded);
1426         fr_connection_release(inst->pool, handle);
1427         sql_unset_user(inst, request);
1428
1429         return rcode;
1430 }
1431
1432 #ifdef WITH_ACCOUNTING
1433
1434 /*
1435  *      Accounting: Insert or update session data in our sql table
1436  */
1437 static rlm_rcode_t CC_HINT(nonnull) mod_accounting(void *instance, REQUEST * request) {
1438         rlm_sql_t *inst = instance;
1439
1440         if (inst->config->accounting.reference_cp) {
1441                 return acct_redundant(inst, request, &inst->config->accounting);
1442         }
1443
1444         return RLM_MODULE_NOOP;
1445 }
1446
1447 #endif
1448
1449 #ifdef WITH_SESSION_MGMT
1450 /*
1451  *      See if a user is already logged in. Sets request->simul_count to the
1452  *      current session count for this user.
1453  *
1454  *      Check twice. If on the first pass the user exceeds his
1455  *      max. number of logins, do a second pass and validate all
1456  *      logins by querying the terminal server (using eg. SNMP).
1457  */
1458
1459 static rlm_rcode_t CC_HINT(nonnull) mod_checksimul(void *instance, REQUEST * request) {
1460         rlm_rcode_t             rcode = RLM_MODULE_OK;
1461         rlm_sql_handle_t        *handle = NULL;
1462         rlm_sql_t               *inst = instance;
1463         rlm_sql_row_t           row;
1464         int                     check = 0;
1465         uint32_t                ipno = 0;
1466         char const              *call_num = NULL;
1467         VALUE_PAIR              *vp;
1468         int                     ret;
1469         uint32_t                nas_addr = 0;
1470         uint32_t                nas_port = 0;
1471
1472         char                    *expanded = NULL;
1473
1474         /* If simul_count_query is not defined, we don't do any checking */
1475         if (!inst->config->simul_count_query || (inst->config->simul_count_query[0] == '\0')) {
1476                 return RLM_MODULE_NOOP;
1477         }
1478
1479         if((!request->username) || (request->username->length == '\0')) {
1480                 REDEBUG("Zero Length username not permitted");
1481
1482                 return RLM_MODULE_INVALID;
1483         }
1484
1485
1486         if(sql_set_user(inst, request, NULL) < 0) {
1487                 return RLM_MODULE_FAIL;
1488         }
1489
1490         if (radius_axlat(&expanded, request, inst->config->simul_count_query, sql_escape_func, inst) < 0) {
1491                 sql_unset_user(inst, request);
1492                 return RLM_MODULE_FAIL;
1493         }
1494
1495         /* initialize the sql socket */
1496         handle = fr_connection_get(inst->pool);
1497         if (!handle) {
1498                 talloc_free(expanded);
1499                 sql_unset_user(inst, request);
1500                 return RLM_MODULE_FAIL;
1501         }
1502
1503         if (rlm_sql_select_query(&handle, inst, expanded) != RLM_SQL_OK) {
1504                 rcode = RLM_MODULE_FAIL;
1505                 goto finish;
1506         }
1507
1508         ret = rlm_sql_fetch_row(&handle, inst);
1509         if (ret != 0) {
1510                 rcode = RLM_MODULE_FAIL;
1511                 goto finish;
1512         }
1513
1514         row = handle->row;
1515         if (!row) {
1516                 rcode = RLM_MODULE_FAIL;
1517                 goto finish;
1518         }
1519
1520         request->simul_count = atoi(row[0]);
1521
1522         (inst->module->sql_finish_select_query)(handle, inst->config);
1523         TALLOC_FREE(expanded);
1524
1525         if (request->simul_count < request->simul_max) {
1526                 rcode = RLM_MODULE_OK;
1527                 goto finish;
1528         }
1529
1530         /*
1531          *      Looks like too many sessions, so let's start verifying
1532          *      them, unless told to rely on count query only.
1533          */
1534         if (!inst->config->simul_verify_query || (inst->config->simul_verify_query[0] == '\0')) {
1535                 rcode = RLM_MODULE_OK;
1536
1537                 goto finish;
1538         }
1539
1540         if (radius_axlat(&expanded, request, inst->config->simul_verify_query, sql_escape_func, inst) < 0) {
1541                 rcode = RLM_MODULE_FAIL;
1542
1543                 goto finish;
1544         }
1545
1546         if (rlm_sql_select_query(&handle, inst, expanded) != RLM_SQL_OK) goto finish;
1547
1548         /*
1549          *      Setup some stuff, like for MPP detection.
1550          */
1551         request->simul_count = 0;
1552
1553         if ((vp = pairfind(request->packet->vps, PW_FRAMED_IP_ADDRESS, 0, TAG_ANY)) != NULL) {
1554                 ipno = vp->vp_ipaddr;
1555         }
1556
1557         if ((vp = pairfind(request->packet->vps, PW_CALLING_STATION_ID, 0, TAG_ANY)) != NULL) {
1558                 call_num = vp->vp_strvalue;
1559         }
1560
1561         while (rlm_sql_fetch_row(&handle, inst) == 0) {
1562                 row = handle->row;
1563                 if (!row) {
1564                         break;
1565                 }
1566
1567                 if (!row[2]){
1568                         RDEBUG("Cannot zap stale entry. No username present in entry");
1569                         rcode = RLM_MODULE_FAIL;
1570
1571                         goto finish;
1572                 }
1573
1574                 if (!row[1]){
1575                         RDEBUG("Cannot zap stale entry. No session id in entry");
1576                         rcode = RLM_MODULE_FAIL;
1577
1578                         goto finish;
1579                 }
1580
1581                 if (row[3]) {
1582                         nas_addr = inet_addr(row[3]);
1583                 }
1584
1585                 if (row[4]) {
1586                         nas_port = atoi(row[4]);
1587                 }
1588
1589                 check = rad_check_ts(nas_addr, nas_port, row[2], row[1]);
1590                 if (check == 0) {
1591                         /*
1592                          *      Stale record - zap it.
1593                          */
1594                         if (inst->config->deletestalesessions == true) {
1595                                 uint32_t framed_addr = 0;
1596                                 char proto = 0;
1597                                 int sess_time = 0;
1598
1599                                 if (row[5])
1600                                         framed_addr = inet_addr(row[5]);
1601                                 if (row[7]){
1602                                         if (strcmp(row[7], "PPP") == 0)
1603                                                 proto = 'P';
1604                                         else if (strcmp(row[7], "SLIP") == 0)
1605                                                 proto = 'S';
1606                                 }
1607                                 if (row[8])
1608                                         sess_time = atoi(row[8]);
1609                                 session_zap(request, nas_addr, nas_port,
1610                                             row[2], row[1], framed_addr,
1611                                             proto, sess_time);
1612                         }
1613                 }
1614                 else if (check == 1) {
1615                         /*
1616                          *      User is still logged in.
1617                          */
1618                         ++request->simul_count;
1619
1620                         /*
1621                          *      Does it look like a MPP attempt?
1622                          */
1623                         if (row[5] && ipno && inet_addr(row[5]) == ipno) {
1624                                 request->simul_mpp = 2;
1625                         } else if (row[6] && call_num && !strncmp(row[6],call_num,16)) {
1626                                 request->simul_mpp = 2;
1627                         }
1628                 } else {
1629                         /*
1630                          *      Failed to check the terminal server for
1631                          *      duplicate logins: return an error.
1632                          */
1633                         REDEBUG("Failed to check the terminal server for user '%s'.", row[2]);
1634
1635                         rcode = RLM_MODULE_FAIL;
1636                         goto finish;
1637                 }
1638         }
1639
1640         finish:
1641
1642         (inst->module->sql_finish_select_query)(handle, inst->config);
1643         fr_connection_release(inst->pool, handle);
1644         talloc_free(expanded);
1645         sql_unset_user(inst, request);
1646
1647         /*
1648          *      The Auth module apparently looks at request->simul_count,
1649          *      not the return value of this module when deciding to deny
1650          *      a call for too many sessions.
1651          */
1652         return rcode;
1653 }
1654 #endif
1655
1656 /*
1657  *      Postauth: Write a record of the authentication attempt
1658  */
1659 static rlm_rcode_t CC_HINT(nonnull) mod_post_auth(void *instance, REQUEST * request) {
1660         rlm_sql_t *inst = instance;
1661
1662         if (inst->config->postauth.reference_cp) {
1663                 return acct_redundant(inst, request, &inst->config->postauth);
1664         }
1665
1666         return RLM_MODULE_NOOP;
1667 }
1668
1669 /*
1670  *      Execute postauth_query after authentication
1671  */
1672
1673
1674 /* globally exported name */
1675 module_t rlm_sql = {
1676         RLM_MODULE_INIT,
1677         "SQL",
1678         RLM_TYPE_THREAD_SAFE,   /* type: reserved */
1679         sizeof(rlm_sql_t),
1680         module_config,
1681         mod_instantiate,        /* instantiation */
1682         mod_detach,             /* detach */
1683         {
1684                 NULL,                   /* authentication */
1685                 mod_authorize,  /* authorization */
1686                 NULL,                   /* preaccounting */
1687 #ifdef WITH_ACCOUNTING
1688                 mod_accounting, /* accounting */
1689 #else
1690                 NULL,
1691 #endif
1692 #ifdef WITH_SESSION_MGMT
1693                 mod_checksimul, /* checksimul */
1694 #else
1695                 NULL,
1696 #endif
1697                 NULL,                   /* pre-proxy */
1698                 NULL,                   /* post-proxy */
1699                 mod_post_auth   /* post-auth */
1700         },
1701 };