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 #include <freeradius-devel/ident.h>
  28 RCSID("$Id$")
  29
  30 #include        <freeradius-devel/radiusd.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 /*
  44  * Connect to a server.  If error, set this socket's state to be
  45  * "sockunconnected" and set a grace period, during which we won't try
  46  * connecting again (to prevent unduly lagging the server and being
  47  * impolite to a DB server that may be having other issues).  If
  48  * successful in connecting, set state to sockconnected.
  49  * - chad
  50  */
  51 static int connect_single_socket(SQLSOCK *sqlsocket, SQL_INST *inst)
  52 {
  53         int rcode;
  54         radlog(L_DBG, "rlm_sql (%s): Attempting to connect %s #%d",
  55                inst->config->xlat_name, inst->module->name, sqlsocket->id);
  56
  57         rcode = (inst->module->sql_init_socket)(sqlsocket, inst->config);
  58         if (rcode == 0) {
  59                 radlog(L_DBG, "rlm_sql (%s): Connected new DB handle, #%d",
  60                        inst->config->xlat_name, sqlsocket->id);
  61                 sqlsocket->state = sockconnected;
  62                 return(0);
  63         }
  64
  65         /*
  66          *  Error, or SQL_DOWN.
  67          */
  68         radlog(L_CONS | L_ERR, "rlm_sql (%s): Failed to connect DB handle #%d", inst->config->xlat_name, sqlsocket->id);
  69         inst->connect_after = time(NULL) + inst->config->connect_failure_retry_delay;
  70         sqlsocket->state = sockunconnected;
  71         return(-1);
  72 }
  73
  74
  75 /*************************************************************************
  76  *
  77  *      Function: sql_init_socketpool
  78  *
  79  *      Purpose: Connect to the sql server, if possible
  80  *
  81  *************************************************************************/
  82 int sql_init_socketpool(SQL_INST * inst)
  83 {
  84         int i, rcode;
  85         int success = 0;
  86         SQLSOCK *sqlsocket;
  87
  88         inst->connect_after = 0;
  89         inst->sqlpool = NULL;
  90
  91         for (i = 0; i < inst->config->num_sql_socks; i++) {
  92                 radlog(L_DBG, "rlm_sql (%s): starting %d",
  93                        inst->config->xlat_name, i);
  94
  95                 sqlsocket = rad_malloc(sizeof(*sqlsocket));
  96                 if (sqlsocket == NULL) {
  97                         return -1;
  98                 }
  99                 memset(sqlsocket, 0, sizeof(*sqlsocket));
 100                 sqlsocket->conn = NULL;
 101                 sqlsocket->id = i;
 102                 sqlsocket->state = sockunconnected;
 103
 104 #ifdef HAVE_PTHREAD_H
 105                 rcode = pthread_mutex_init(&sqlsocket->mutex,NULL);
 106                 if (rcode != 0) {
 107                         free(sqlsocket);
 108                         radlog(L_ERR, "rlm_sql: Failed to init lock: %s",
 109                                strerror(errno));
 110                         return 0;
 111                 }
 112 #endif
 113
 114                 if (time(NULL) > inst->connect_after) {
 115                         /*
 116                          *      This sets the sqlsocket->state, and
 117                          *      possibly also inst->connect_after
 118                          */
 119                         if (connect_single_socket(sqlsocket, inst) == 0) {
 120                                 success = 1;
 121                         }
 122                 }
 123
 124                 /* Add this socket to the list of sockets */
 125                 sqlsocket->next = inst->sqlpool;
 126                 inst->sqlpool = sqlsocket;
 127         }
 128         inst->last_used = NULL;
 129
 130         if (!success) {
 131                 radlog(L_DBG, "rlm_sql (%s): Failed to connect to any SQL server.",
 132                        inst->config->xlat_name);
 133         }
 134
 135         return 1;
 136 }
 137
 138 /*************************************************************************
 139  *
 140  *     Function: sql_poolfree
 141  *
 142  *     Purpose: Clean up and free sql pool
 143  *
 144  *************************************************************************/
 145 void sql_poolfree(SQL_INST * inst)
 146 {
 147         SQLSOCK *cur;
 148         SQLSOCK *next;
 149
 150         for (cur = inst->sqlpool; cur; cur = next) {
 151                 next = cur->next;
 152                 sql_close_socket(inst, cur);
 153         }
 154
 155         inst->sqlpool = NULL;
 156 }
 157
 158
 159 /*************************************************************************
 160  *
 161  *      Function: sql_close_socket
 162  *
 163  *      Purpose: Close and free a sql sqlsocket
 164  *
 165  *************************************************************************/
 166 int sql_close_socket(SQL_INST *inst, SQLSOCK * sqlsocket)
 167 {
 168         radlog(L_DBG, "rlm_sql (%s): Closing sqlsocket %d",
 169                inst->config->xlat_name, sqlsocket->id);
 170         if (sqlsocket->state == sockconnected) {
 171                 (inst->module->sql_close)(sqlsocket, inst->config);
 172         }
 173         if (inst->module->sql_destroy_socket) {
 174                 (inst->module->sql_destroy_socket)(sqlsocket, inst->config);
 175         }
 176 #ifdef HAVE_PTHREAD_H
 177         pthread_mutex_destroy(&sqlsocket->mutex);
 178 #endif
 179         free(sqlsocket);
 180         return 1;
 181 }
 182
 183 static time_t last_logged_failure = 0;
 184
 185
 186 /*************************************************************************
 187  *
 188  *      Function: sql_get_socket
 189  *
 190  *      Purpose: Return a SQL sqlsocket from the connection pool
 191  *
 192  *************************************************************************/
 193 SQLSOCK * sql_get_socket(SQL_INST * inst)
 194 {
 195         SQLSOCK *cur, *start;
 196         int tried_to_connect = 0;
 197         int unconnected = 0;
 198         time_t now;
 199
 200         /*
 201          *      Start at the last place we left off.
 202          */
 203         start = inst->last_used;
 204         if (!start) start = inst->sqlpool;
 205
 206         cur = start;
 207
 208         while (cur) {
 209 #ifdef HAVE_PTHREAD_H
 210                 /*
 211                  *      If this socket is in use by another thread,
 212                  *      skip it, and try another socket.
 213                  *
 214                  *      If it isn't used, then grab it ourselves.
 215                  */
 216                 if (pthread_mutex_trylock(&cur->mutex) != 0) {
 217                         goto next;
 218                 } /* else we now have the lock */
 219 #endif
 220
 221                 /*
 222                  *      If we happen upon an unconnected socket, and
 223                  *      this instance's grace period on
 224                  *      (re)connecting has expired, then try to
 225                  *      connect it.  This should be really rare.
 226                  */
 227                 if ((cur->state == sockunconnected) && (time(NULL) > inst->connect_after)) {
 228                         radlog(L_INFO, "rlm_sql (%s): Trying to (re)connect unconnected handle %d..", inst->config->xlat_name, cur->id);
 229                         tried_to_connect++;
 230                         connect_single_socket(cur, inst);
 231                 }
 232
 233                 /* if we still aren't connected, ignore this handle */
 234                 if (cur->state == sockunconnected) {
 235                         radlog(L_DBG, "rlm_sql (%s): Ignoring unconnected handle %d..", inst->config->xlat_name, cur->id);
 236                         unconnected++;
 237 #ifdef HAVE_PTHREAD_H
 238                         pthread_mutex_unlock(&cur->mutex);
 239 #endif
 240                         goto next;
 241                 }
 242
 243                 /* should be connected, grab it */
 244                 radlog(L_DBG, "rlm_sql (%s): Reserving sql socket id: %d", inst->config->xlat_name, cur->id);
 245
 246                 if (unconnected != 0 || tried_to_connect != 0) {
 247                         radlog(L_INFO, "rlm_sql (%s): got socket %d after skipping %d unconnected handles, tried to reconnect %d though", inst->config->xlat_name, cur->id, unconnected, tried_to_connect);
 248                 }
 249
 250                 /*
 251                  *      The socket is returned in the locked
 252                  *      state.
 253                  *
 254                  *      We also remember where we left off,
 255                  *      so that the next search can start from
 256                  *      here.
 257                  *
 258                  *      Note that multiple threads MAY over-write
 259                  *      the 'inst->last_used' variable.  This is OK,
 260                  *      as it's a pointer only used for reading.
 261                  */
 262                 inst->last_used = cur->next;
 263                 return cur;
 264
 265                 /* move along the list */
 266         next:
 267                 cur = cur->next;
 268
 269                 /*
 270                  *      Because we didnt start at the start, once we
 271                  *      hit the end of the linklist, we should go
 272                  *      back to the beginning and work toward the
 273                  *      middle!
 274                  */
 275                 if (!cur) {
 276                         cur = inst->sqlpool;
 277                 }
 278
 279                 /*
 280                  *      If we're at the socket we started
 281                  */
 282                 if (cur == start) {
 283                         break;
 284                 }
 285         }
 286
 287         /*
 288          *      Suppress most of the log messages.  We don't want to
 289          *      flood the log with this message for EVERY packet.
 290          *      Instead, write to the log only once a second or so.
 291          *
 292          *      This code has race conditions when threaded, but the
 293          *      only result is that a few more messages are logged.
 294          */
 295         now = time(NULL);
 296         if (now <= last_logged_failure) return NULL;
 297         last_logged_failure = now;
 298
 299         /* We get here if every DB handle is unconnected and unconnectABLE */
 300         radlog(L_INFO, "rlm_sql (%s): There are no DB handles to use! skipped %d, tried to connect %d", inst->config->xlat_name, unconnected, tried_to_connect);
 301         return NULL;
 302 }
 303
 304 /*************************************************************************
 305  *
 306  *      Function: sql_release_socket
 307  *
 308  *      Purpose: Frees a SQL sqlsocket back to the connection pool
 309  *
 310  *************************************************************************/
 311 int sql_release_socket(SQL_INST * inst, SQLSOCK * sqlsocket)
 312 {
 313 #ifdef HAVE_PTHREAD_H
 314         pthread_mutex_unlock(&sqlsocket->mutex);
 315 #endif
 316
 317         radlog(L_DBG, "rlm_sql (%s): Released sql socket id: %d",
 318                inst->config->xlat_name, sqlsocket->id);
 319
 320         return 0;
 321 }
 322
 323
 324 /*************************************************************************
 325  *
 326  *      Function: sql_userparse
 327  *
 328  *      Purpose: Read entries from the database and fill VALUE_PAIR structures
 329  *
 330  *************************************************************************/
 331 int sql_userparse(VALUE_PAIR ** first_pair, SQL_ROW row)
 332 {
 333         VALUE_PAIR *pair;
 334         const char *ptr, *value;
 335         char buf[MAX_STRING_LEN];
 336         char do_xlat = 0;
 337         FR_TOKEN token, operator = T_EOL;
 338
 339         /*
 340          *      Verify the 'Attribute' field
 341          */
 342         if (row[2] == NULL || row[2][0] == '\0') {
 343                 radlog(L_ERR, "rlm_sql: The 'Attribute' field is empty or NULL, skipping the entire row.");
 344                 return -1;
 345         }
 346
 347         /*
 348          *      Verify the 'op' field
 349          */
 350         if (row[4] != NULL && row[4][0] != '\0') {
 351                 ptr = row[4];
 352                 operator = gettoken(&ptr, buf, sizeof(buf));
 353         }
 354         if (operator <= T_EOL) {
 355                 /*
 356                  *  Complain about empty or invalid 'op' field
 357                  */
 358                 operator = T_OP_CMP_EQ;
 359                 radlog(L_ERR, "rlm_sql: The 'op' field for attribute '%s = %s' is NULL, or non-existent.", row[2], row[3]);
 360                 radlog(L_ERR, "rlm_sql: You MUST FIX THIS if you want the configuration to behave as you expect.");
 361         }
 362
 363         /*
 364          *      The 'Value' field may be empty or NULL
 365          */
 366         value = row[3];
 367         /*
 368          *      If we have a new-style quoted string, where the
 369          *      *entire* string is quoted, do xlat's.
 370          */
 371         if (row[3] != NULL &&
 372            ((row[3][0] == '\'') || (row[3][0] == '`') || (row[3][0] == '"')) &&
 373            (row[3][0] == row[3][strlen(row[3])-1])) {
 374
 375                 token = gettoken(&value, buf, sizeof(buf));
 376                 switch (token) {
 377                         /*
 378                          *      Take the unquoted string.
 379                          */
 380                 case T_SINGLE_QUOTED_STRING:
 381                 case T_DOUBLE_QUOTED_STRING:
 382                         value = buf;
 383                         break;
 384
 385                         /*
 386                          *      Mark the pair to be allocated later.
 387                          */
 388                 case T_BACK_QUOTED_STRING:
 389                         value = NULL;
 390                         do_xlat = 1;
 391                         break;
 392
 393                         /*
 394                          *      Keep the original string.
 395                          */
 396                 default:
 397                         value = row[3];
 398                         break;
 399                 }
 400         }
 401
 402         /*
 403          *      Create the pair
 404          */
 405         pair = pairmake(row[2], value, operator);
 406         if (pair == NULL) {
 407                 radlog(L_ERR, "rlm_sql: Failed to create the pair: %s", fr_strerror);
 408                 return -1;
 409         }
 410         if (do_xlat) {
 411                 pair->flags.do_xlat = 1;
 412                 strlcpy(pair->vp_strvalue, buf, sizeof(pair->vp_strvalue));
 413                 pair->length = 0;
 414         }
 415
 416         /*
 417          *      Add the pair into the packet
 418          */
 419         pairadd(first_pair, pair);
 420         return 0;
 421 }
 422
 423
 424 /*************************************************************************
 425  *
 426  *      Function: rlm_sql_fetch_row
 427  *
 428  *      Purpose: call the module's sql_fetch_row and implement re-connect
 429  *
 430  *************************************************************************/
 431 int rlm_sql_fetch_row(SQLSOCK *sqlsocket, SQL_INST *inst)
 432 {
 433         int ret;
 434
 435         if (sqlsocket->conn) {
 436                 ret = (inst->module->sql_fetch_row)(sqlsocket, inst->config);
 437         } else {
 438                 ret = SQL_DOWN;
 439         }
 440
 441         if (ret == SQL_DOWN) {
 442                 /* close the socket that failed, but only if it was open */
 443                 if (sqlsocket->conn) {
 444                         (inst->module->sql_close)(sqlsocket, inst->config);
 445                 }
 446
 447                 /* reconnect the socket */
 448                 if (connect_single_socket(sqlsocket, inst) < 0) {
 449                         radlog(L_ERR, "rlm_sql (%s): reconnect failed, database down?", inst->config->xlat_name);
 450                         return -1;
 451                 }
 452
 453                 /* retry the query on the newly connected socket */
 454                 ret = (inst->module->sql_fetch_row)(sqlsocket, inst->config);
 455
 456                 if (ret) {
 457                         radlog(L_ERR, "rlm_sql (%s): failed after re-connect",
 458                                inst->config->xlat_name);
 459                         return -1;
 460                 }
 461         }
 462
 463         return ret;
 464 }
 465
 466 /*************************************************************************
 467  *
 468  *      Function: rlm_sql_query
 469  *
 470  *      Purpose: call the module's sql_query and implement re-connect
 471  *
 472  *************************************************************************/
 473 int rlm_sql_query(SQLSOCK *sqlsocket, SQL_INST *inst, char *query)
 474 {
 475         int ret;
 476
 477         /*
 478          *      If there's no query, return an error.
 479          */
 480         if (!query || !*query) {
 481                 return -1;
 482         }
 483
 484         ret = (inst->module->sql_query)(sqlsocket, inst->config, query);
 485
 486         if (ret == SQL_DOWN) {
 487                 /* close the socket that failed */
 488                 if (sqlsocket->state == sockconnected) {
 489                         (inst->module->sql_close)(sqlsocket, inst->config);
 490                 }
 491
 492                 /* reconnect the socket */
 493                 if (connect_single_socket(sqlsocket, inst) < 0) {
 494                         radlog(L_ERR, "rlm_sql (%s): reconnect failed, database down?", inst->config->xlat_name);
 495                         return -1;
 496                 }
 497
 498                 /* retry the query on the newly connected socket */
 499                 ret = (inst->module->sql_query)(sqlsocket, inst->config, query);
 500
 501                 if (ret) {
 502                         radlog(L_ERR, "rlm_sql (%s): failed after re-connect",
 503                                inst->config->xlat_name);
 504                         return -1;
 505                 }
 506         }
 507
 508         return ret;
 509 }
 510
 511 /*************************************************************************
 512  *
 513  *      Function: rlm_sql_select_query
 514  *
 515  *      Purpose: call the module's sql_select_query and implement re-connect
 516  *
 517  *************************************************************************/
 518 int rlm_sql_select_query(SQLSOCK *sqlsocket, SQL_INST *inst, char *query)
 519 {
 520         int ret;
 521
 522         /*
 523          *      If there's no query, return an error.
 524          */
 525         if (!query || !*query) {
 526                 return -1;
 527         }
 528
 529         ret = (inst->module->sql_select_query)(sqlsocket, inst->config, query);
 530
 531         if (ret == SQL_DOWN) {
 532                 /* close the socket that failed */
 533                 if (sqlsocket->state == sockconnected) {
 534                         (inst->module->sql_close)(sqlsocket, inst->config);
 535                 }
 536
 537                 /* reconnect the socket */
 538                 if (connect_single_socket(sqlsocket, inst) < 0) {
 539                         radlog(L_ERR, "rlm_sql (%s): reconnect failed, database down?", inst->config->xlat_name);
 540                         return -1;
 541                 }
 542
 543                 /* retry the query on the newly connected socket */
 544                 ret = (inst->module->sql_select_query)(sqlsocket, inst->config, query);
 545
 546                 if (ret) {
 547                         radlog(L_ERR, "rlm_sql (%s): failed after re-connect",
 548                                inst->config->xlat_name);
 549                         return -1;
 550                 }
 551         }
 552
 553         return ret;
 554 }
 555
 556
 557 /*************************************************************************
 558  *
 559  *      Function: sql_getvpdata
 560  *
 561  *      Purpose: Get any group check or reply pairs
 562  *
 563  *************************************************************************/
 564 int sql_getvpdata(SQL_INST * inst, SQLSOCK * sqlsocket, VALUE_PAIR **pair, char *query)
 565 {
 566         SQL_ROW row;
 567         int     rows = 0;
 568
 569         /*
 570          *      If there's no query, return an error.
 571          */
 572         if (!query || !*query) {
 573                 return -1;
 574         }
 575
 576         if (rlm_sql_select_query(sqlsocket, inst, query)) {
 577                 radlog(L_ERR, "rlm_sql_getvpdata: database query error");
 578                 return -1;
 579         }
 580         while (rlm_sql_fetch_row(sqlsocket, inst)==0) {
 581                 row = sqlsocket->row;
 582                 if (!row)
 583                         break;
 584                 if (sql_userparse(pair, row) != 0) {
 585                         radlog(L_ERR | L_CONS, "rlm_sql (%s): Error getting data from database", inst->config->xlat_name);
 586                         (inst->module->sql_finish_select_query)(sqlsocket, inst->config);
 587                         return -1;
 588                 }
 589                 rows++;
 590         }
 591         (inst->module->sql_finish_select_query)(sqlsocket, inst->config);
 592
 593         return rows;
 594 }
 595
 596 void query_log(REQUEST *request, SQL_INST *inst, char *querystr)
 597 {
 598         FILE   *sqlfile = NULL;
 599
 600         if (inst->config->sqltrace) {
 601                 char buffer[8192];
 602
 603                 if (!radius_xlat(buffer, sizeof(buffer),
 604                                  inst->config->tracefile, request, NULL)) {
 605                   radlog(L_ERR, "rlm_sql (%s): xlat failed.",
 606                          inst->config->xlat_name);
 607                   return;
 608                 }
 609
 610                 if ((sqlfile = fopen(buffer, "a")) == (FILE *) NULL) {
 611                         radlog(L_ERR, "rlm_sql (%s): Couldn't open file %s",
 612                                inst->config->xlat_name,
 613                                buffer);
 614                 } else {
 615                         int fd = fileno(sqlfile);
 616
 617                         rad_lockfd(fd, MAX_QUERY_LEN);
 618                         fputs(querystr, sqlfile);
 619                         fputs(";\n", sqlfile);
 620                         fclose(sqlfile); /* and release the lock */
 621                 }
 622         }
 623 }