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