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.
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.
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
18 * @file rlm_sql_sqlite.c
19 * @brief SQLite driver.
21 * @copyright 2013 Network RADIUS SARL <info@networkradius.com>
22 * @copyright 2007 Apple Inc.
27 #include <freeradius-devel/radiusd.h>
37 #define BOOTSTRAP_MAX (1048576 * 10)
40 * Allow us to use versions < 3.6.0 beta0
42 #ifndef SQLITE_OPEN_NOMUTEX
43 # define SQLITE_OPEN_NOMUTEX 0
46 #ifndef HAVE_SQLITE3_INT64
47 typedef sqlite3_int64 sqlite_int64
50 typedef struct rlm_sql_sqlite_conn {
52 sqlite3_stmt *statement;
54 } rlm_sql_sqlite_conn_t;
56 typedef struct rlm_sql_sqlite_config {
58 char const *bootstrap;
59 } rlm_sql_sqlite_config_t;
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 },
65 {NULL, -1, 0, NULL, NULL}
68 static int sql_check_error(sqlite3 *db)
70 int error = sqlite3_errcode(db);
80 * User/transient errors
82 case SQLITE_ERROR: /* SQL error or missing database */
84 case SQLITE_CONSTRAINT:
90 * Errors with the handle, that probably require reinitialisation
93 ERROR("rlm_sql_sqlite: Handle is unusable, error (%d): %s", error, sqlite3_errmsg(db));
94 return RLM_SQL_RECONNECT;
99 #ifdef HAVE_SQLITE3_OPEN_V2
100 static int sql_loadfile(TALLOC_CTX *ctx, sqlite3 *db, char const *filename)
110 sqlite3_stmt *statement;
113 INFO("rlm_sql_sqlite: Executing SQL statements from file \"%s\"", filename);
115 f = fopen(filename, "r");
117 ERROR("rlm_sql_sqlite: Failed opening SQL file \"%s\": %s", filename,
123 if (fstat(fileno(f), &finfo) < 0) {
124 ERROR("rlm_sql_sqlite: Failed stating SQL file \"%s\": %s", filename,
132 if (finfo.st_size > BOOTSTRAP_MAX) {
134 ERROR("rlm_sql_sqlite: Size of SQL (%zu) file exceeds limit (%uk)",
135 (size_t) finfo.st_size / 1024, BOOTSTRAP_MAX / 1024);
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) {
151 ERROR("rlm_sql_sqlite: Error reading SQL file: %s", fr_syserror(errno));
159 DEBUG("rlm_sql_sqlite: Ignoring empty SQL file");
171 * Check if input data is UTF-8. Allow CR/LF \t, too.
173 for (p = buffer; p < (buffer + len); p += cl) {
175 if ((*p != 0x0a) && (*p != 0x0d) && (*p != '\t')) break;
178 cl = fr_utf8_char((uint8_t *) p);
183 if ((p - buffer) != len) {
184 ERROR("rlm_sql_sqlite: Bootstrap file contains non-UTF8 char at offset %zu", p - buffer);
190 * Statement delimiter is ;\n
193 while ((q = strchr(p, ';'))) {
201 #ifdef HAVE_SQLITE3_PREPARE_V2
202 (void) sqlite3_prepare_v2(db, s, len, &statement, &z_tail);
204 (void) sqlite3_prepare(db, s, len, &>statement, &z_tail);
206 if (sql_check_error(db)) {
211 (void) sqlite3_step(statement);
212 status = sql_check_error(db);
214 (void) sqlite3_finalize(statement);
215 if (status || sql_check_error(db)) {
228 static int mod_instantiate(CONF_SECTION *conf, rlm_sql_config_t *config)
230 static bool version_done;
233 rlm_sql_sqlite_config_t *driver;
239 if (sqlite3_libversion_number() != SQLITE_VERSION_NUMBER) {
240 WARN("rlm_sql_sqlite: libsqlite version changed since the server was built");
241 WARN("rlm_sql_sqlite: linked: %s built: %s", sqlite3_libversion(), SQLITE_VERSION);
243 INFO("rlm_sql_sqlite: libsqlite version: %s", sqlite3_libversion());
246 MEM(driver = config->driver = talloc_zero(config, rlm_sql_sqlite_config_t));
247 if (cf_section_parse(conf, driver, driver_config) < 0) {
250 if (!driver->filename) {
251 MEM(driver->filename = talloc_typed_asprintf(driver, "%s/%s", get_radius_dir(), config->sql_db));
254 if (stat(driver->filename, &buf) == 0) {
256 } else if (errno == ENOENT) {
259 ERROR("rlm_sql_sqlite: Database exists, but couldn't be opened: %s", fr_syserror(errno));
263 if (driver->bootstrap && !exists) {
264 # ifdef HAVE_SQLITE3_OPEN_V2
271 INFO("rlm_sql_sqlite: Database doesn't exist, creating it and loading schema");
273 p = strrchr(driver->filename, '/');
275 size_t len = (p - driver->filename) + 1;
277 buff = talloc_array(conf, char, len);
278 strlcpy(buff, driver->filename, len);
280 MEM(buff = talloc_typed_strdup(conf, driver->filename));
283 ret = rad_mkdir(buff, 0700);
286 ERROR("rlm_sql_sqlite: Failed creating directory for SQLite database: %s", fr_syserror(errno));
291 status = sqlite3_open_v2(driver->filename, &db, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, NULL);
293 # ifdef HAVE_SQLITE3_ERRSTR
294 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database: %s",
295 sqlite3_errstr(status));
297 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database, got code (%i)",
304 if (sql_check_error(db)) {
305 (void) sqlite3_close(db);
310 ret = sql_loadfile(conf, db, driver->bootstrap);
311 status = sqlite3_close(db);
312 if (status != SQLITE_OK) {
314 * Safer to use sqlite3_errstr here, just in case the handle is in a weird state
316 # ifdef HAVE_SQLITE3_ERRSTR
317 ERROR("rlm_sql_sqlite: Error closing SQLite handle: %s", sqlite3_errstr(status));
319 ERROR("rlm_sql_sqlite: Error closing SQLite handle, got code (%i)", status);
326 if ((unlink(driver->filename) < 0) && (errno != ENOENT)) {
327 ERROR("rlm_sql_sqlite: Error removing partially initialised database: %s",
333 WARN("rlm_sql_sqlite: sqlite3_open_v2() not available, cannot bootstrap database. "
334 "Upgrade to SQLite >= 3.5.1 if you need this functionality");
341 static int sql_socket_destructor(void *c)
344 rlm_sql_sqlite_conn_t * conn = c;
346 DEBUG2("rlm_sql_sqlite: Socket destructor called, closing socket");
349 status = sqlite3_close(conn->db);
350 if (status != SQLITE_OK) {
351 WARN("rlm_sql_sqlite: Got SQLite error code (%u) when closing socket", status);
358 static void _sql_greatest(sqlite3_context *ctx, int num_values, sqlite3_value **values)
361 sqlite3_int64 value, max = 0;
363 for (i = 0; i < num_values; i++) {
364 value = sqlite3_value_int64(values[i]);
370 sqlite3_result_int64(ctx, max);
373 static sql_rcode_t sql_socket_init(rlm_sql_handle_t *handle, rlm_sql_config_t *config)
375 rlm_sql_sqlite_conn_t *conn;
376 rlm_sql_sqlite_config_t *driver = config->driver;
380 MEM(conn = handle->conn = talloc_zero(handle, rlm_sql_sqlite_conn_t));
381 talloc_set_destructor((void *) conn, sql_socket_destructor);
383 INFO("rlm_sql_sqlite: Opening SQLite database \"%s\"", driver->filename);
384 #ifdef HAVE_SQLITE3_OPEN_V2
385 status = sqlite3_open_v2(driver->filename, &(conn->db), SQLITE_OPEN_READWRITE | SQLITE_OPEN_NOMUTEX, NULL);
387 status = sqlite3_open(driver->filename, &(conn->db));
390 #ifdef HAVE_SQLITE3_ERRSTR
391 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite: %s", sqlite3_errstr(status));
393 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database error code (%i)",
400 if (sql_check_error(conn->db)) {
405 * Enable extended return codes for extra debugging info.
407 #ifdef HAVE_SQLITE3_EXTENDED_RESULT_CODES
408 (void) sqlite3_extended_result_codes(conn->db, 1);
410 if (sql_check_error(conn->db)) {
414 #ifdef HAVE_SQLITE3_CREATE_FUNCTION_V2
415 status = sqlite3_create_function_v2(conn->db, "GREATEST", -1, SQLITE_ANY, NULL,
416 _sql_greatest, NULL, NULL, NULL);
418 status = sqlite3_create_function(conn->db, "GREATEST", -1, SQLITE_ANY, NULL,
419 _sql_greatest, NULL, NULL);
421 if (status != SQLITE_OK) {
422 ERROR("rlm_sql_sqlite: Failed registering 'GREATEST' sql function: %s", sqlite3_errmsg(conn->db));
428 static sql_rcode_t sql_select_query(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config, char const *query)
430 rlm_sql_sqlite_conn_t *conn = handle->conn;
433 #ifdef HAVE_SQLITE3_PREPARE_V2
434 (void) sqlite3_prepare_v2(conn->db, query, strlen(query), &conn->statement, &z_tail);
436 (void) sqlite3_prepare(conn->db, query, strlen(query), &conn->statement, &z_tail);
441 return sql_check_error(conn->db);
445 static sql_rcode_t sql_query(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config, char const *query)
448 rlm_sql_sqlite_conn_t *conn = handle->conn;
451 #ifdef HAVE_SQLITE3_PREPARE_V2
452 status = sqlite3_prepare_v2(conn->db, query, strlen(query), &conn->statement, &z_tail);
454 status = sqlite3_prepare(conn->db, query, strlen(query), &conn->statement, &z_tail);
456 if (status != SQLITE_OK) {
457 return sql_check_error(conn->db);
460 (void) sqlite3_step(conn->statement);
462 return sql_check_error(conn->db);
465 static sql_rcode_t sql_store_result(UNUSED rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config)
470 static int sql_num_fields(rlm_sql_handle_t * handle, UNUSED rlm_sql_config_t *config)
472 rlm_sql_sqlite_conn_t *conn = handle->conn;
474 if (conn->statement) {
475 return sqlite3_column_count(conn->statement);
481 static int sql_num_rows(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config)
483 rlm_sql_sqlite_conn_t *conn = handle->conn;
485 if (conn->statement) {
486 return sqlite3_data_count(conn->statement);
492 static sql_rcode_t sql_fetch_row(rlm_sql_handle_t *handle, rlm_sql_config_t *config)
495 rlm_sql_sqlite_conn_t *conn = handle->conn;
502 * Executes the SQLite query and interates over the results
504 status = sqlite3_step(conn->statement);
507 * Error getting next row
509 if (sql_check_error(conn->db)) {
514 * No more rows to process (were done)
516 if (status == SQLITE_DONE) {
521 * We only need to do this once per result set, because
522 * the number of columns won't change.
524 if (conn->col_count == 0) {
525 conn->col_count = sql_num_fields(handle, config);
526 if (conn->col_count == 0) {
532 * Free the previous result (also gets called on finish_query)
534 talloc_free(handle->row);
536 MEM(row = handle->row = talloc_zero_array(handle->conn, char *, conn->col_count + 1));
538 for (i = 0; i < conn->col_count; i++) {
539 switch (sqlite3_column_type(conn->statement, i)) {
541 MEM(row[i] = talloc_typed_asprintf(row, "%d", sqlite3_column_int(conn->statement, i)));
545 MEM(row[i] = talloc_typed_asprintf(row, "%f", sqlite3_column_double(conn->statement, i)));
551 p = (char const *) sqlite3_column_text(conn->statement, i);
554 MEM(row[i] = talloc_typed_strdup(row, p));
564 p = sqlite3_column_blob(conn->statement, i);
566 len = sqlite3_column_bytes(conn->statement, i);
568 MEM(row[i] = talloc_zero_array(row, char, len + 1));
569 memcpy(row[i], p, len);
582 static sql_rcode_t sql_free_result(rlm_sql_handle_t *handle,
583 UNUSED rlm_sql_config_t *config)
585 rlm_sql_sqlite_conn_t *conn = handle->conn;
587 if (conn->statement) {
588 TALLOC_FREE(handle->row);
590 (void) sqlite3_finalize(conn->statement);
591 conn->statement = NULL;
596 * There's no point in checking the code returned by finalize
597 * as it'll have already been encountered elsewhere in the code.
599 * It's just the last error that occurred processing the
605 static char const *sql_error(rlm_sql_handle_t *handle,
606 UNUSED rlm_sql_config_t *config)
608 rlm_sql_sqlite_conn_t *conn = handle->conn;
611 return sqlite3_errmsg(conn->db);
614 return "Invalid handle";
617 static sql_rcode_t sql_finish_query(rlm_sql_handle_t *handle,
618 UNUSED rlm_sql_config_t *config)
620 return sql_free_result(handle, config);
623 static int sql_affected_rows(rlm_sql_handle_t *handle,
624 UNUSED rlm_sql_config_t *config)
626 rlm_sql_sqlite_conn_t *conn = handle->conn;
629 return sqlite3_changes(conn->db);
636 /* Exported to rlm_sql */
637 rlm_sql_module_t rlm_sql_sqlite = {