src/modules/rlm_sql/sql.c

   1 /*
   2  *  sql.c               rlm_sql - FreeRADIUS SQL Module
   3  *              Main code directly taken from ICRADIUS
   4  *
   5  * Version:     $Id$
   6  *
   7  *   This program is free software; you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License as published by
   9  *   the Free Software Foundation; either version 2 of the License, or
  10  *   (at your option) any later version.
  11  *
  12  *   This program is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with this program; if not, write to the Free Software
  19  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  *
  21  * Copyright 2001,2006  The FreeRADIUS server project
  22  * Copyright 2000  Mike Machado <mike@innercite.com>
  23  * Copyright 2000  Alan DeKok <aland@ox.org>
  24  * Copyright 2001  Chad Miller <cmiller@surfsouth.com>
  25  */
  26
  27 RCSID("$Id$")
  28
  29 #include        <freeradius-devel/radiusd.h>
  30 #include        <freeradius-devel/rad_assert.h>
  31
  32 #include        <sys/file.h>
  33 #include        <sys/stat.h>
  34
  35 #include        <ctype.h>
  36
  37 #include        "rlm_sql.h"
  38
  39 #ifdef HAVE_PTHREAD_H
  40 #endif
  41
  42 /*
  43  *      Translate rlm_sql rcodes to humanly
  44  *      readable reason strings.
  45  */
  46 const FR_NAME_NUMBER sql_rcode_table[] = {
  47         { "success",            RLM_SQL_OK              },
  48         { "need alt query",     RLM_SQL_ALT_QUERY       },
  49         { "server error",       RLM_SQL_ERROR           },
  50         { "query invalid",      RLM_SQL_QUERY_INVALID   },
  51         { "no connection",      RLM_SQL_RECONNECT       },
  52         { NULL, 0 }
  53 };
  54
  55
  56 void *mod_conn_create(TALLOC_CTX *ctx, void *instance)
  57 {
  58         int rcode;
  59         rlm_sql_t *inst = instance;
  60         rlm_sql_handle_t *handle;
  61
  62         /*
  63          *      Connections cannot be alloced from the inst or
  64          *      pool contexts due to threading issues.
  65          */
  66         handle = talloc_zero(ctx, rlm_sql_handle_t);
  67         if (!handle) return NULL;
  68
  69         handle->log_ctx = talloc_pool(handle, 2048);
  70         if (!handle->log_ctx) {
  71                 talloc_free(handle);
  72                 return NULL;
  73         }
  74
  75         /*
  76          *      Handle requires a pointer to the SQL inst so the
  77          *      destructor has access to the module configuration.
  78          */
  79         handle->inst = inst;
  80
  81         rcode = (inst->module->sql_socket_init)(handle, inst->config);
  82         if (rcode != 0) {
  83         fail:
  84                 /*
  85                  *      Destroy any half opened connections.
  86                  */
  87                 talloc_free(handle);
  88                 return NULL;
  89         }
  90
  91         if (inst->config->connect_query) {
  92                 if (rlm_sql_select_query(inst, NULL, &handle, inst->config->connect_query) != RLM_SQL_OK) goto fail;
  93                 (inst->module->sql_finish_select_query)(handle, inst->config);
  94         }
  95
  96         return handle;
  97 }
  98
  99 /*************************************************************************
 100  *
 101  *      Function: sql_fr_pair_list_afrom_str
 102  *
 103  *      Purpose: Read entries from the database and fill VALUE_PAIR structures
 104  *
 105  *************************************************************************/
 106 int sql_fr_pair_list_afrom_str(TALLOC_CTX *ctx, REQUEST *request, VALUE_PAIR **head, rlm_sql_row_t row)
 107 {
 108         VALUE_PAIR *vp;
 109         char const *ptr, *value;
 110         char buf[MAX_STRING_LEN];
 111         char do_xlat = 0;
 112         FR_TOKEN token, op = T_EOL;
 113
 114         /*
 115          *      Verify the 'Attribute' field
 116          */
 117         if (!row[2] || row[2][0] == '\0') {
 118                 REDEBUG("The 'Attribute' field is empty or NULL, skipping the entire row");
 119                 return -1;
 120         }
 121
 122         /*
 123          *      Verify the 'op' field
 124          */
 125         if (row[4] != NULL && row[4][0] != '\0') {
 126                 ptr = row[4];
 127                 op = gettoken(&ptr, buf, sizeof(buf), false);
 128                 if (!fr_assignment_op[op] && !fr_equality_op[op]) {
 129                         REDEBUG("Invalid op \"%s\" for attribute %s", row[4], row[2]);
 130                         return -1;
 131                 }
 132
 133         } else {
 134                 /*
 135                  *  Complain about empty or invalid 'op' field
 136                  */
 137                 op = T_OP_CMP_EQ;
 138                 REDEBUG("The 'op' field for attribute '%s = %s' is NULL, or non-existent.", row[2], row[3]);
 139                 REDEBUG("You MUST FIX THIS if you want the configuration to behave as you expect");
 140         }
 141
 142         /*
 143          *      The 'Value' field may be empty or NULL
 144          */
 145         value = row[3];
 146         /*
 147          *      If we have a new-style quoted string, where the
 148          *      *entire* string is quoted, do xlat's.
 149          */
 150         if (row[3] != NULL &&
 151            ((row[3][0] == '\'') || (row[3][0] == '`') || (row[3][0] == '"')) &&
 152            (row[3][0] == row[3][strlen(row[3])-1])) {
 153
 154                 token = gettoken(&value, buf, sizeof(buf), false);
 155                 switch (token) {
 156                 /*
 157                  *      Take the unquoted string.
 158                  */
 159                 case T_SINGLE_QUOTED_STRING:
 160                 case T_DOUBLE_QUOTED_STRING:
 161                         value = buf;
 162                         break;
 163
 164                 /*
 165                  *      Mark the pair to be allocated later.
 166                  */
 167                 case T_BACK_QUOTED_STRING:
 168                         value = NULL;
 169                         do_xlat = 1;
 170                         break;
 171
 172                 /*
 173                  *      Keep the original string.
 174                  */
 175                 default:
 176                         value = row[3];
 177                         break;
 178                 }
 179         }
 180
 181         /*
 182          *      Create the pair
 183          */
 184         vp = fr_pair_make(ctx, NULL, row[2], NULL, op);
 185         if (!vp) {
 186                 REDEBUG("Failed to create the pair: %s", fr_strerror());
 187                 return -1;
 188         }
 189
 190         if (do_xlat) {
 191                 if (fr_pair_mark_xlat(vp, value) < 0) {
 192                         REDEBUG("Error marking pair for xlat");
 193
 194                         talloc_free(vp);
 195                         return -1;
 196                 }
 197         } else {
 198                 if (fr_pair_value_from_str(vp, value, -1) < 0) {
 199                         REDEBUG("Error parsing value: %s", fr_strerror());
 200
 201                         talloc_free(vp);
 202                         return -1;
 203                 }
 204         }
 205
 206         /*
 207          *      Add the pair into the packet
 208          */
 209         fr_pair_add(head, vp);
 210         return 0;
 211 }
 212
 213 /** Call the driver's sql_fetch_row function
 214  *
 215  * Calls the driver's sql_fetch_row logging any errors. On success, will
 216  * write row data to (*handle)->row.
 217  *
 218  * @param inst Instance of rlm_sql.
 219  * @param request The Current request, may be NULL.
 220  * @param handle Handle to retrieve errors for.
 221  * @return on success RLM_SQL_OK, other sql_rcode_t constants on error.
 222  */
 223 sql_rcode_t rlm_sql_fetch_row(rlm_sql_t *inst, REQUEST *request, rlm_sql_handle_t **handle)
 224 {
 225         int ret;
 226
 227         if (!*handle || !(*handle)->conn) return RLM_SQL_ERROR;
 228
 229         /*
 230          *      We can't implement reconnect logic here, because the caller
 231          *      may require the original connection to free up queries or
 232          *      result sets associated with that connection.
 233          */
 234         ret = (inst->module->sql_fetch_row)(*handle, inst->config);
 235         if (ret < 0) {
 236                 MOD_ROPTIONAL(RERROR, ERROR, "Error fetching row");
 237
 238                 rlm_sql_print_error(inst, request, *handle, false);
 239         }
 240
 241         return ret;
 242 }
 243
 244 /** Retrieve any errors from the SQL driver
 245  *
 246  * Retrieves errors from the driver from the last operation and writes them to
 247  * to request/global log, in the ERROR, WARN, INFO and DEBUG categories.
 248  *
 249  * @param inst Instance of rlm_sql.
 250  * @param request Current request, may be NULL.
 251  * @param handle Handle to retrieve errors for.
 252  * @param force_debug Force all errors to be logged as debug messages.
 253  */
 254 void rlm_sql_print_error(rlm_sql_t *inst, REQUEST *request, rlm_sql_handle_t *handle, bool force_debug)
 255 {
 256         char const      *driver;
 257         sql_log_entry_t log[20];
 258         size_t          num, i;
 259
 260         num = (inst->module->sql_error)(handle->log_ctx, log, (sizeof(log) / sizeof(*log)), handle, inst->config);
 261         if (num == 0) {
 262                 MOD_ROPTIONAL(RERROR, ERROR, "Unknown error");
 263                 return;
 264         }
 265
 266         driver = inst->config->sql_driver_name;
 267
 268         for (i = 0; i < num; i++) {
 269                 if (force_debug) goto debug;
 270
 271                 switch (log[i].type) {
 272                 case L_ERR:
 273                         MOD_ROPTIONAL(RERROR, ERROR, "%s: %s", driver, log[i].msg);
 274                         break;
 275
 276                 case L_WARN:
 277                         MOD_ROPTIONAL(RWARN, WARN, "%s: %s", driver, log[i].msg);
 278                         break;
 279
 280                 case L_INFO:
 281                         MOD_ROPTIONAL(RINFO, INFO, "%s: %s", driver, log[i].msg);
 282                         break;
 283
 284                 case L_DBG:
 285                 default:
 286                 debug:
 287                         MOD_ROPTIONAL(RDEBUG, DEBUG, "%s: %s", driver, log[i].msg);
 288                         break;
 289                 }
 290         }
 291
 292         talloc_free_children(handle->log_ctx);
 293 }
 294
 295 /** Call the driver's sql_query method, reconnecting if necessary.
 296  *
 297  * @note Caller must call (inst->module->sql_finish_query)(handle, inst->config);
 298  *      after they're done with the result.
 299  *
 300  * @param handle to query the database with. *handle should not be NULL, as this indicates
 301  *      previous reconnection attempt has failed.
 302  * @param request Current request.
 303  * @param inst rlm_sql instance data.
 304  * @param query to execute. Should not be zero length.
 305  * @return RLM_SQL_OK on success, RLM_SQL_RECONNECT if a new handle is required
 306  *      (also sets *handle = NULL), RLM_SQL_QUERY_INVALID/RLM_SQL_ERROR on invalid query or
 307  *      connection error, RLM_SQL_ALT_QUERY on constraints violation.
 308  */
 309 sql_rcode_t rlm_sql_query(rlm_sql_t *inst, REQUEST *request, rlm_sql_handle_t **handle, char const *query)
 310 {
 311         int ret = RLM_SQL_ERROR;
 312         int i, count;
 313
 314         /* Caller should check they have a valid handle */
 315         rad_assert(*handle);
 316
 317         /* There's no query to run, return an error */
 318         if (query[0] == '\0') {
 319                 if (request) REDEBUG("Zero length query");
 320                 return RLM_SQL_QUERY_INVALID;
 321         }
 322
 323         /*
 324          *  inst->pool may be NULL is this function is called by mod_conn_create.
 325          */
 326         count = inst->pool ? fr_connection_pool_get_num(inst->pool) : 0;
 327
 328         /*
 329          *  Here we try with each of the existing connections, then try to create
 330          *  a new connection, then give up.
 331          */
 332         for (i = 0; i < (count + 1); i++) {
 333                 MOD_ROPTIONAL(RDEBUG2, DEBUG2, "Executing query: %s", query);
 334
 335                 ret = (inst->module->sql_query)(*handle, inst->config, query);
 336                 switch (ret) {
 337                 case RLM_SQL_OK:
 338                         break;
 339
 340                 /*
 341                  *      Run through all available sockets until we exhaust all existing
 342                  *      sockets in the pool and fail to establish a *new* connection.
 343                  */
 344                 case RLM_SQL_RECONNECT:
 345                         *handle = fr_connection_reconnect(inst->pool, *handle);
 346                         /* Reconnection failed */
 347                         if (!*handle) return RLM_SQL_RECONNECT;
 348                         /* Reconnection succeeded, try again with the new handle */
 349                         continue;
 350
 351                 /*
 352                  *      These are bad and should make rlm_sql return invalid
 353                  */
 354                 case RLM_SQL_QUERY_INVALID:
 355                         rlm_sql_print_error(inst, request, *handle, false);
 356                         (inst->module->sql_finish_query)(*handle, inst->config);
 357                         break;
 358
 359                 /*
 360                  *      Server or client errors.
 361                  *
 362                  *      If the driver claims to be able to distinguish between
 363                  *      duplicate row errors and other errors, and we hit a
 364                  *      general error treat it as a failure.
 365                  *
 366                  *      Otherwise rewrite it to RLM_SQL_ALT_QUERY.
 367                  */
 368                 case RLM_SQL_ERROR:
 369                         if (inst->module->flags & RLM_SQL_RCODE_FLAGS_ALT_QUERY) {
 370                                 rlm_sql_print_error(inst, request, *handle, false);
 371                                 (inst->module->sql_finish_query)(*handle, inst->config);
 372                                 break;
 373                         }
 374                         ret = RLM_SQL_ALT_QUERY;
 375                         /* FALL-THROUGH */
 376
 377                 /*
 378                  *      Driver suggested using an alternative query
 379                  */
 380                 case RLM_SQL_ALT_QUERY:
 381                         rlm_sql_print_error(inst, request, *handle, true);
 382                         (inst->module->sql_finish_query)(*handle, inst->config);
 383                         break;
 384
 385                 }
 386
 387                 return ret;
 388         }
 389
 390         MOD_ROPTIONAL(RERROR, ERROR, "Hit reconnection limit");
 391
 392         return RLM_SQL_ERROR;
 393 }
 394
 395 /** Call the driver's sql_select_query method, reconnecting if necessary.
 396  *
 397  * @note Caller must call (inst->module->sql_finish_select_query)(handle, inst->config);
 398  *      after they're done with the result.
 399  *
 400  * @param inst rlm_sql instance data.
 401  * @param request Current request.
 402  * @param handle to query the database with. *handle should not be NULL, as this indicates
 403  *        previous reconnection attempt has failed.
 404  * @param query to execute. Should not be zero length.
 405  * @return RLM_SQL_OK on success, RLM_SQL_RECONNECT if a new handle is required (also sets *handle = NULL),
 406  *         RLM_SQL_QUERY_INVALID/RLM_SQL_ERROR on invalid query or connection error.
 407  */
 408 sql_rcode_t rlm_sql_select_query(rlm_sql_t *inst, REQUEST *request, rlm_sql_handle_t **handle,  char const *query)
 409 {
 410         int ret = RLM_SQL_ERROR;
 411         int i, count;
 412
 413         /* Caller should check they have a valid handle */
 414         rad_assert(*handle);
 415
 416         /* There's no query to run, return an error */
 417         if (query[0] == '\0') {
 418                 if (request) REDEBUG("Zero length query");
 419
 420                 return RLM_SQL_QUERY_INVALID;
 421         }
 422
 423         /*
 424          *  inst->pool may be NULL is this function is called by mod_conn_create.
 425          */
 426         count = inst->pool ? fr_connection_pool_get_num(inst->pool) : 0;
 427
 428         /*
 429          *  For sanity, for when no connections are viable, and we can't make a new one
 430          */
 431         for (i = 0; i < (count + 1); i++) {
 432                 MOD_ROPTIONAL(RDEBUG2, DEBUG2, "Executing select query: %s", query);
 433
 434                 ret = (inst->module->sql_select_query)(*handle, inst->config, query);
 435                 switch (ret) {
 436                 case RLM_SQL_OK:
 437                         break;
 438
 439                 /*
 440                  *      Run through all available sockets until we exhaust all existing
 441                  *      sockets in the pool and fail to establish a *new* connection.
 442                  */
 443                 case RLM_SQL_RECONNECT:
 444                         *handle = fr_connection_reconnect(inst->pool, *handle);
 445                         /* Reconnection failed */
 446                         if (!*handle) return RLM_SQL_RECONNECT;
 447                         /* Reconnection succeeded, try again with the new handle */
 448                         continue;
 449
 450                 case RLM_SQL_QUERY_INVALID:
 451                 case RLM_SQL_ERROR:
 452                 default:
 453                         rlm_sql_print_error(inst, request, *handle, false);
 454                         (inst->module->sql_finish_select_query)(*handle, inst->config);
 455                         break;
 456                 }
 457
 458                 return ret;
 459         }
 460
 461         MOD_ROPTIONAL(RERROR, ERROR, "Hit reconnection limit");
 462
 463         return RLM_SQL_ERROR;
 464 }
 465
 466
 467 /*************************************************************************
 468  *
 469  *      Function: sql_getvpdata
 470  *
 471  *      Purpose: Get any group check or reply pairs
 472  *
 473  *************************************************************************/
 474 int sql_getvpdata(TALLOC_CTX *ctx, rlm_sql_t *inst, REQUEST *request, rlm_sql_handle_t **handle,
 475                   VALUE_PAIR **pair, char const *query)
 476 {
 477         rlm_sql_row_t   row;
 478         int             rows = 0;
 479         sql_rcode_t     rcode;
 480
 481         rad_assert(request);
 482
 483         rcode = rlm_sql_select_query(inst, request, handle, query);
 484         if (rcode != RLM_SQL_OK) return -1; /* error handled by rlm_sql_select_query */
 485
 486         while (rlm_sql_fetch_row(inst, request, handle) == 0) {
 487                 row = (*handle)->row;
 488                 if (!row) break;
 489                 if (sql_fr_pair_list_afrom_str(ctx, request, pair, row) != 0) {
 490                         REDEBUG("Error parsing user data from database result");
 491
 492                         (inst->module->sql_finish_select_query)(*handle, inst->config);
 493
 494                         return -1;
 495                 }
 496                 rows++;
 497         }
 498         (inst->module->sql_finish_select_query)(*handle, inst->config);
 499
 500         return rows;
 501 }
 502
 503 /*
 504  *      Log the query to a file.
 505  */
 506 void rlm_sql_query_log(rlm_sql_t *inst, REQUEST *request,
 507                        sql_acct_section_t *section, char const *query)
 508 {
 509         int fd;
 510         char const *filename = NULL;
 511         char *expanded = NULL;
 512         size_t len;
 513         bool failed = false;    /* Write the log message outside of the critical region */
 514
 515         filename = inst->config->logfile;
 516         if (section && section->logfile) filename = section->logfile;
 517
 518         if (!filename || !*filename) {
 519                 return;
 520         }
 521
 522         if (radius_axlat(&expanded, request, filename, NULL, NULL) < 0) {
 523                 return;
 524         }
 525
 526         fd = exfile_open(inst->ef, filename, 0640, true);
 527         if (fd < 0) {
 528                 ERROR("rlm_sql (%s): Couldn't open logfile '%s': %s", inst->name,
 529                       expanded, fr_syserror(errno));
 530
 531                 talloc_free(expanded);
 532                 return;
 533         }
 534
 535         len = strlen(query);
 536         if ((write(fd, query, len) < 0) || (write(fd, ";\n", 2) < 0)) {
 537                 failed = true;
 538         }
 539
 540         if (failed) {
 541                 ERROR("rlm_sql (%s): Failed writing to logfile '%s': %s", inst->name, expanded,
 542                       fr_syserror(errno));
 543         }
 544
 545         talloc_free(expanded);
 546         exfile_close(inst->ef, fd);
 547 }