src/modules/rlm_sql/drivers/rlm_sql_sqlite/rlm_sql_sqlite.c

   1 /*
   2  *   This program is is free software; you can redistribute it and/or modify
   3  *   it under the terms of the GNU General Public License, version 2 if the
   4  *   License as published by the Free Software Foundation.
   5  *
   6  *   This program is distributed in the hope that it will be useful,
   7  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   8  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   9  *   GNU General Public License for more details.
  10  *
  11  *   You should have received a copy of the GNU General Public License
  12  *   along with this program; if not, write to the Free Software
  13  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  14  */
  15
  16 /**
  17  * $Id$
  18  * @file rlm_sql_sqlite.c
  19  * @brief SQLite driver.
  20  *
  21  * @copyright 2013 Network RADIUS SARL <info@networkradius.com>
  22  * @copyright 2007 Apple Inc.
  23  */
  24
  25 RCSID("$Id$")
  26
  27 #include <freeradius-devel/radiusd.h>
  28
  29 #include <fcntl.h>
  30 #include <sys/stat.h>
  31
  32 #include <sqlite3.h>
  33
  34 #include "rlm_sql.h"
  35 #include "config.h"
  36
  37 #define BOOTSTRAP_MAX (1048576 * 10)
  38
  39 /*
  40  *      Allow us to use versions < 3.6.0 beta0
  41  */
  42 #ifndef SQLITE_OPEN_NOMUTEX
  43 #  define SQLITE_OPEN_NOMUTEX 0
  44 #endif
  45
  46 #ifndef HAVE_SQLITE3_INT64
  47 typedef sqlite3_int64 sqlite_int64
  48 #endif
  49
  50 typedef struct rlm_sql_sqlite_conn {
  51         sqlite3 *db;
  52         sqlite3_stmt *statement;
  53         int col_count;
  54 } rlm_sql_sqlite_conn_t;
  55
  56 typedef struct rlm_sql_sqlite_config {
  57         char const *filename;
  58         char const *bootstrap;
  59 } rlm_sql_sqlite_config_t;
  60
  61 static const CONF_PARSER driver_config[] = {
  62         { "filename", FR_CONF_OFFSET(PW_TYPE_FILE_OUTPUT | PW_TYPE_REQUIRED, rlm_sql_sqlite_config_t, filename), NULL },
  63         { "bootstrap", FR_CONF_OFFSET(PW_TYPE_FILE_INPUT, rlm_sql_sqlite_config_t, bootstrap), NULL },
  64
  65         {NULL, -1, 0, NULL, NULL}
  66 };
  67
  68 static int sql_check_error(sqlite3 *db)
  69 {
  70         int error = sqlite3_errcode(db);
  71         switch(error) {
  72         /*
  73          *      Not errors
  74          */
  75         case SQLITE_OK:
  76         case SQLITE_DONE:
  77         case SQLITE_ROW:
  78                 return 0;
  79         /*
  80          *      User/transient errors
  81          */
  82         case SQLITE_ERROR:      /* SQL error or missing database */
  83         case SQLITE_FULL:
  84         case SQLITE_CONSTRAINT:
  85         case SQLITE_MISMATCH:
  86                 return -1;
  87                 break;
  88
  89         /*
  90          *      Errors with the handle, that probably require reinitialisation
  91          */
  92         default:
  93                 ERROR("rlm_sql_sqlite: Handle is unusable, error (%d): %s", error, sqlite3_errmsg(db));
  94                 return RLM_SQL_RECONNECT;
  95                 break;
  96         }
  97 }
  98
  99 #ifdef HAVE_SQLITE3_OPEN_V2
 100 static int sql_loadfile(TALLOC_CTX *ctx, sqlite3 *db, char const *filename)
 101 {
 102         ssize_t len;
 103         char *buffer;
 104         char *p, *q, *s;
 105         int cl;
 106         FILE *f;
 107         struct stat finfo;
 108
 109         int status;
 110         sqlite3_stmt *statement;
 111         char const *z_tail;
 112
 113         INFO("rlm_sql_sqlite: Executing SQL statements from file \"%s\"", filename);
 114
 115         f = fopen(filename, "r");
 116         if (!f) {
 117                 ERROR("rlm_sql_sqlite: Failed opening SQL file \"%s\": %s", filename,
 118                        fr_syserror(errno));
 119
 120                 return -1;
 121         }
 122
 123         if (fstat(fileno(f), &finfo) < 0) {
 124                 ERROR("rlm_sql_sqlite: Failed stating SQL file \"%s\": %s", filename,
 125                        fr_syserror(errno));
 126
 127                 fclose(f);
 128
 129                 return -1;
 130         }
 131
 132         if (finfo.st_size > BOOTSTRAP_MAX) {
 133                 too_big:
 134                 ERROR("rlm_sql_sqlite: Size of SQL (%zu) file exceeds limit (%uk)",
 135                        (size_t) finfo.st_size / 1024, BOOTSTRAP_MAX / 1024);
 136
 137                 fclose(f);
 138
 139                 return -1;
 140         }
 141
 142         MEM(buffer = talloc_array(ctx, char, finfo.st_size + 1));
 143         len = fread(buffer, sizeof(char), finfo.st_size + 1, f);
 144         if (len > finfo.st_size) {
 145                 talloc_free(buffer);
 146                 goto too_big;
 147         }
 148
 149         if (!len) {
 150                 if (ferror(f)) {
 151                         ERROR("rlm_sql_sqlite: Error reading SQL file: %s", fr_syserror(errno));
 152
 153                         fclose(f);
 154                         talloc_free(buffer);
 155
 156                         return -1;
 157                 }
 158
 159                 DEBUG("rlm_sql_sqlite: Ignoring empty SQL file");
 160
 161                 fclose(f);
 162                 talloc_free(buffer);
 163
 164                 return 0;
 165         }
 166
 167         buffer[len] = '\0';
 168         fclose(f);
 169
 170         /*
 171          *      Check if input data is UTF-8.  Allow CR/LF \t, too.
 172          */
 173         for (p = buffer; p < (buffer + len); p += cl) {
 174                 if (*p < ' ') {
 175                         if ((*p != 0x0a) && (*p != 0x0d) && (*p != '\t')) break;
 176                         cl = 1;
 177                 } else {
 178                         cl = fr_utf8_char((uint8_t *) p);
 179                         if (!cl) break;
 180                 }
 181         }
 182
 183         if ((p - buffer) != len) {
 184                 ERROR("rlm_sql_sqlite: Bootstrap file contains non-UTF8 char at offset %zu", p - buffer);
 185                 talloc_free(buffer);
 186                 return -1;
 187         }
 188
 189         /*
 190          *      Statement delimiter is ;\n
 191          */
 192         s = p = buffer;
 193         while ((q = strchr(p, ';'))) {
 194                 if (q[1] != '\n') {
 195                         p = q + 1;
 196                         continue;
 197                 }
 198
 199                 *q = '\0';
 200
 201 #ifdef HAVE_SQLITE3_PREPARE_V2
 202                 (void) sqlite3_prepare_v2(db, s, len, &statement, &z_tail);
 203 #else
 204                 (void) sqlite3_prepare(db, s, len, &>statement, &z_tail);
 205 #endif
 206                 if (sql_check_error(db)) {
 207                         talloc_free(buffer);
 208                         return -1;
 209                 }
 210
 211                 (void) sqlite3_step(statement);
 212                 status = sql_check_error(db);
 213
 214                 (void) sqlite3_finalize(statement);
 215                 if (status || sql_check_error(db)) {
 216                         talloc_free(buffer);
 217                         return -1;
 218                 }
 219
 220                 p = s = q + 1;
 221         }
 222
 223         talloc_free(buffer);
 224         return 0;
 225 }
 226 #endif
 227
 228 static int mod_instantiate(CONF_SECTION *conf, rlm_sql_config_t *config)
 229 {
 230         bool exists;
 231         rlm_sql_sqlite_config_t *driver;
 232         struct stat buf;
 233
 234         if (sqlite3_libversion_number() != SQLITE_VERSION_NUMBER) {
 235                 DEBUG2("rlm_sql_sqlite: SQLite library version (%s) is different from the version the server was "
 236                        "originally built against (%s), this may cause issues",
 237                        sqlite3_libversion(), SQLITE_VERSION);
 238         }
 239
 240         MEM(driver = config->driver = talloc_zero(config, rlm_sql_sqlite_config_t));
 241         if (cf_section_parse(conf, driver, driver_config) < 0) {
 242                 return -1;
 243         }
 244
 245         INFO("rlm_sql_sqlite: SQLite library version: %s", sqlite3_libversion());
 246         if (!driver->filename) {
 247                 MEM(driver->filename = talloc_typed_asprintf(driver, "%s/%s", get_radius_dir(), config->sql_db));
 248         }
 249
 250         if (stat(driver->filename, &buf) == 0) {
 251                 exists = true;
 252         } else if (errno == ENOENT) {
 253                 exists = false;
 254         } else {
 255                 ERROR("rlm_sql_sqlite: Database exists, but couldn't be opened: %s", fr_syserror(errno));
 256                 return -1;
 257         }
 258
 259         if (driver->bootstrap && !exists) {
 260 #  ifdef HAVE_SQLITE3_OPEN_V2
 261                 int status;
 262                 int ret;
 263                 char *p;
 264                 char *buff;
 265                 sqlite3 *db = NULL;
 266
 267                 INFO("rlm_sql_sqlite: Database doesn't exist, creating it and loading schema");
 268
 269                 p = strrchr(driver->filename, '/');
 270                 if (p) {
 271                         size_t len = (p - driver->filename) + 1;
 272
 273                         buff = talloc_array(conf, char, len);
 274                         strlcpy(buff, driver->filename, len);
 275                 } else {
 276                         MEM(buff = talloc_typed_strdup(conf, driver->filename));
 277                 }
 278
 279                 ret = rad_mkdir(buff, 0700);
 280                 talloc_free(buff);
 281                 if (ret < 0) {
 282                         ERROR("rlm_sql_sqlite: Failed creating directory for SQLite database: %s", fr_syserror(errno));
 283
 284                         return -1;
 285                 };
 286
 287                 status = sqlite3_open_v2(driver->filename, &db, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, NULL);
 288                 if (!db) {
 289 #  ifdef HAVE_SQLITE3_ERRSTR
 290                         ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database: %s",
 291                               sqlite3_errstr(status));
 292 #  else
 293                         ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database, got code (%i)",
 294                               status);
 295 #  endif
 296
 297                         goto unlink;
 298                 }
 299
 300                 if (sql_check_error(db)) {
 301                         (void) sqlite3_close(db);
 302
 303                         goto unlink;
 304                 }
 305
 306                 ret = sql_loadfile(conf, db, driver->bootstrap);
 307                 status = sqlite3_close(db);
 308                 if (status != SQLITE_OK) {
 309                 /*
 310                  *      Safer to use sqlite3_errstr here, just in case the handle is in a weird state
 311                  */
 312 #  ifdef HAVE_SQLITE3_ERRSTR
 313                         ERROR("rlm_sql_sqlite: Error closing SQLite handle: %s", sqlite3_errstr(status));
 314 #  else
 315                         ERROR("rlm_sql_sqlite: Error closing SQLite handle, got code (%i)", status);
 316 #  endif
 317
 318                         goto unlink;
 319                 }
 320                 if (ret < 0) {
 321                 unlink:
 322                         if ((unlink(driver->filename) < 0) && (errno != ENOENT)) {
 323                                 ERROR("rlm_sql_sqlite: Error removing partially initialised database: %s",
 324                                       fr_syserror(errno));
 325                         }
 326                         return -1;
 327                 }
 328 #else
 329                 WARN("rlm_sql_sqlite: sqlite3_open_v2() not available, cannot bootstrap database. "
 330                        "Upgrade to SQLite >= 3.5.1 if you need this functionality");
 331 #endif
 332         }
 333
 334         return 0;
 335 }
 336
 337 static int sql_socket_destructor(void *c)
 338 {
 339         int status = 0;
 340         rlm_sql_sqlite_conn_t * conn = c;
 341
 342         DEBUG2("rlm_sql_sqlite: Socket destructor called, closing socket");
 343
 344         if (conn->db) {
 345                 status = sqlite3_close(conn->db);
 346                 if (status != SQLITE_OK) {
 347                         WARN("rlm_sql_sqlite: Got SQLite error code (%u) when closing socket", status);
 348                 }
 349         }
 350
 351         return 0;
 352 }
 353
 354 static void _sql_greatest(sqlite3_context *ctx, int num_values, sqlite3_value **values)
 355 {
 356         int i;
 357         sqlite3_int64 value, max = 0;
 358
 359         for (i = 0; i < num_values; i++) {
 360                 value = sqlite3_value_int64(values[i]);
 361                 if (value > max) {
 362                         max = value;
 363                 }
 364         }
 365
 366         sqlite3_result_int64(ctx, max);
 367 }
 368
 369 static sql_rcode_t sql_socket_init(rlm_sql_handle_t *handle, rlm_sql_config_t *config)
 370 {
 371         rlm_sql_sqlite_conn_t *conn;
 372         rlm_sql_sqlite_config_t *driver = config->driver;
 373
 374         int status;
 375
 376         MEM(conn = handle->conn = talloc_zero(handle, rlm_sql_sqlite_conn_t));
 377         talloc_set_destructor((void *) conn, sql_socket_destructor);
 378
 379         INFO("rlm_sql_sqlite: Opening SQLite database \"%s\"", driver->filename);
 380 #ifdef HAVE_SQLITE3_OPEN_V2
 381         status = sqlite3_open_v2(driver->filename, &(conn->db), SQLITE_OPEN_READWRITE | SQLITE_OPEN_NOMUTEX, NULL);
 382 #else
 383         status = sqlite3_open(driver->filename, &(conn->db));
 384 #endif
 385         if (!conn->db) {
 386 #ifdef HAVE_SQLITE3_ERRSTR
 387                 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite: %s", sqlite3_errstr(status));
 388 #else
 389                 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database error code (%i)",
 390                       status);
 391 #endif
 392
 393                 return -1;
 394         }
 395
 396         if (sql_check_error(conn->db)) {
 397                 return -1;
 398         }
 399
 400         /*
 401          *      Enable extended return codes for extra debugging info.
 402          */
 403 #ifdef HAVE_SQLITE3_EXTENDED_RESULT_CODES
 404         (void) sqlite3_extended_result_codes(conn->db, 1);
 405 #endif
 406         if (sql_check_error(conn->db)) {
 407                 return -1;
 408         }
 409
 410 #ifdef HAVE_SQLITE3_CREATE_FUNCTION_V2
 411         status = sqlite3_create_function_v2(conn->db, "GREATEST", -1, SQLITE_ANY, NULL,
 412                                             _sql_greatest, NULL, NULL, NULL);
 413 #else
 414         status = sqlite3_create_function(conn->db, "GREATEST", -1, SQLITE_ANY, NULL,
 415                                          _sql_greatest, NULL, NULL);
 416 #endif
 417         if (status != SQLITE_OK) {
 418                 ERROR("rlm_sql_sqlite: Failed registering 'GREATEST' sql function: %s", sqlite3_errmsg(conn->db));
 419         }
 420
 421         return 0;
 422 }
 423
 424 static sql_rcode_t sql_select_query(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config, char const *query)
 425 {
 426         rlm_sql_sqlite_conn_t *conn = handle->conn;
 427         char const *z_tail;
 428
 429 #ifdef HAVE_SQLITE3_PREPARE_V2
 430         (void) sqlite3_prepare_v2(conn->db, query, strlen(query), &conn->statement, &z_tail);
 431 #else
 432         (void) sqlite3_prepare(conn->db, query, strlen(query), &conn->statement, &z_tail);
 433 #endif
 434
 435         conn->col_count = 0;
 436
 437         return sql_check_error(conn->db);
 438 }
 439
 440
 441 static sql_rcode_t sql_query(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config, char const *query)
 442 {
 443         int status;
 444         rlm_sql_sqlite_conn_t *conn = handle->conn;
 445         char const *z_tail;
 446
 447 #ifdef HAVE_SQLITE3_PREPARE_V2
 448         status = sqlite3_prepare_v2(conn->db, query, strlen(query), &conn->statement, &z_tail);
 449 #else
 450         status = sqlite3_prepare(conn->db, query, strlen(query), &conn->statement, &z_tail);
 451 #endif
 452         if (status != SQLITE_OK) {
 453                 return sql_check_error(conn->db);
 454         }
 455
 456         (void) sqlite3_step(conn->statement);
 457
 458         return sql_check_error(conn->db);
 459 }
 460
 461 static sql_rcode_t sql_store_result(UNUSED rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config)
 462 {
 463         return 0;
 464 }
 465
 466 static int sql_num_fields(rlm_sql_handle_t * handle, UNUSED rlm_sql_config_t *config)
 467 {
 468         rlm_sql_sqlite_conn_t *conn = handle->conn;
 469
 470         if (conn->statement) {
 471                 return sqlite3_column_count(conn->statement);
 472         }
 473
 474         return 0;
 475 }
 476
 477 static int sql_num_rows(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config)
 478 {
 479         rlm_sql_sqlite_conn_t *conn = handle->conn;
 480
 481         if (conn->statement) {
 482                 return sqlite3_data_count(conn->statement);
 483         }
 484
 485         return 0;
 486 }
 487
 488 static sql_rcode_t sql_fetch_row(rlm_sql_handle_t *handle, rlm_sql_config_t *config)
 489 {
 490         int status;
 491         rlm_sql_sqlite_conn_t *conn = handle->conn;
 492
 493         int i = 0;
 494
 495         char **row;
 496
 497         /*
 498          *      Executes the SQLite query and interates over the results
 499          */
 500         status = sqlite3_step(conn->statement);
 501
 502         /*
 503          *      Error getting next row
 504          */
 505         if (sql_check_error(conn->db)) {
 506                 return -1;
 507         }
 508
 509         /*
 510          *      No more rows to process (were done)
 511          */
 512         if (status == SQLITE_DONE) {
 513                 return 1;
 514         }
 515
 516         /*
 517          *      We only need to do this once per result set, because
 518          *      the number of columns won't change.
 519          */
 520         if (conn->col_count == 0) {
 521                 conn->col_count = sql_num_fields(handle, config);
 522                 if (conn->col_count == 0) {
 523                         return -1;
 524                 }
 525         }
 526
 527         /*
 528          *      Free the previous result (also gets called on finish_query)
 529          */
 530         talloc_free(handle->row);
 531
 532         MEM(row = handle->row = talloc_zero_array(handle->conn, char *, conn->col_count + 1));
 533
 534         for (i = 0; i < conn->col_count; i++) {
 535                 switch (sqlite3_column_type(conn->statement, i)) {
 536                 case SQLITE_INTEGER:
 537                         MEM(row[i] = talloc_typed_asprintf(row, "%d", sqlite3_column_int(conn->statement, i)));
 538                         break;
 539
 540                 case SQLITE_FLOAT:
 541                         MEM(row[i] = talloc_typed_asprintf(row, "%f", sqlite3_column_double(conn->statement, i)));
 542                         break;
 543
 544                 case SQLITE_TEXT:
 545                         {
 546                                 char const *p;
 547                                 p = (char const *) sqlite3_column_text(conn->statement, i);
 548
 549                                 if (p) {
 550                                         MEM(row[i] = talloc_typed_strdup(row, p));
 551                                 }
 552                         }
 553                         break;
 554
 555                 case SQLITE_BLOB:
 556                         {
 557                                 uint8_t const *p;
 558                                 size_t len;
 559
 560                                 p = sqlite3_column_blob(conn->statement, i);
 561                                 if (p) {
 562                                         len = sqlite3_column_bytes(conn->statement, i);
 563
 564                                         MEM(row[i] = talloc_zero_array(row, char, len + 1));
 565                                         memcpy(row[i], p, len);
 566                                 }
 567                         }
 568                         break;
 569
 570                 default:
 571                         break;
 572                 }
 573         }
 574
 575         return 0;
 576 }
 577
 578 static sql_rcode_t sql_free_result(rlm_sql_handle_t *handle,
 579                            UNUSED rlm_sql_config_t *config)
 580 {
 581         rlm_sql_sqlite_conn_t *conn = handle->conn;
 582
 583         if (conn->statement) {
 584                 TALLOC_FREE(handle->row);
 585
 586                 (void) sqlite3_finalize(conn->statement);
 587                 conn->statement = NULL;
 588                 conn->col_count = 0;
 589         }
 590
 591         /*
 592          *      There's no point in checking the code returned by finalize
 593          *      as it'll have already been encountered elsewhere in the code.
 594          *
 595          *      It's just the last error that occurred processing the
 596          *      statement.
 597          */
 598         return 0;
 599 }
 600
 601 static char const *sql_error(rlm_sql_handle_t *handle,
 602                              UNUSED rlm_sql_config_t *config)
 603 {
 604         rlm_sql_sqlite_conn_t *conn = handle->conn;
 605
 606         if (conn->db) {
 607                 return sqlite3_errmsg(conn->db);
 608         }
 609
 610         return "Invalid handle";
 611 }
 612
 613 static sql_rcode_t sql_finish_query(rlm_sql_handle_t *handle,
 614                             UNUSED rlm_sql_config_t *config)
 615 {
 616         return sql_free_result(handle, config);
 617 }
 618
 619 static int sql_affected_rows(rlm_sql_handle_t *handle,
 620                              UNUSED rlm_sql_config_t *config)
 621 {
 622         rlm_sql_sqlite_conn_t *conn = handle->conn;
 623
 624         if (conn->db) {
 625                 return sqlite3_changes(conn->db);
 626         }
 627
 628         return -1;
 629 }
 630
 631
 632 /* Exported to rlm_sql */
 633 rlm_sql_module_t rlm_sql_sqlite = {
 634         "rlm_sql_sqlite",
 635         mod_instantiate,
 636         sql_socket_init,
 637         sql_query,
 638         sql_select_query,
 639         sql_store_result,
 640         sql_num_fields,
 641         sql_num_rows,
 642         sql_fetch_row,
 643         sql_free_result,
 644         sql_error,
 645         sql_finish_query,
 646         sql_finish_query,
 647         sql_affected_rows
 648 };