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