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