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 as published by
4 * the Free Software Foundation; either version 2 of the License, or (at
5 * your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 * @file rlm_sql_sqlite.c
20 * @brief SQLite driver.
22 * @copyright 2013 Network RADIUS SARL <info@networkradius.com>
23 * @copyright 2007 Apple Inc.
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/rad_assert.h>
38 #define BOOTSTRAP_MAX (1048576 * 10)
41 * Allow us to use versions < 3.6.0 beta0
43 #ifndef SQLITE_OPEN_NOMUTEX
44 # define SQLITE_OPEN_NOMUTEX 0
47 #ifndef HAVE_SQLITE3_INT64
48 typedef sqlite3_int64 sqlite_int64
51 typedef struct rlm_sql_sqlite_conn {
53 sqlite3_stmt *statement;
55 } rlm_sql_sqlite_conn_t;
57 typedef struct rlm_sql_sqlite_config {
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 },
64 {NULL, -1, 0, NULL, NULL}
67 static sql_rcode_t sql_check_error(sqlite3 *db)
69 int error = sqlite3_errcode(db);
72 * Lowest byte is error category, other byte may contain
73 * the extended error, depending on version.
75 switch (error & 0xff) {
84 * User/transient errors
86 case SQLITE_ERROR: /* SQL error or missing database */
92 * Constraints violations
94 case SQLITE_CONSTRAINT:
95 return RLM_SQL_ALT_QUERY;
98 * Errors with the handle, that probably require reinitialisation
101 ERROR("rlm_sql_sqlite: Handle is unusable, error (%d): %s", error, sqlite3_errmsg(db));
102 return RLM_SQL_RECONNECT;
106 #ifdef HAVE_SQLITE3_OPEN_V2
107 static int sql_loadfile(TALLOC_CTX *ctx, sqlite3 *db, char const *filename)
117 sqlite3_stmt *statement;
120 INFO("rlm_sql_sqlite: Executing SQL statements from file \"%s\"", filename);
122 f = fopen(filename, "r");
124 ERROR("rlm_sql_sqlite: Failed opening SQL file \"%s\": %s", filename,
130 if (fstat(fileno(f), &finfo) < 0) {
131 ERROR("rlm_sql_sqlite: Failed stating SQL file \"%s\": %s", filename,
139 if (finfo.st_size > BOOTSTRAP_MAX) {
141 ERROR("rlm_sql_sqlite: Size of SQL (%zu) file exceeds limit (%uk)",
142 (size_t) finfo.st_size / 1024, BOOTSTRAP_MAX / 1024);
149 MEM(buffer = talloc_array(ctx, char, finfo.st_size + 1));
150 len = fread(buffer, sizeof(char), finfo.st_size + 1, f);
151 if (len > finfo.st_size) {
158 ERROR("rlm_sql_sqlite: Error reading SQL file: %s", fr_syserror(errno));
166 DEBUG("rlm_sql_sqlite: Ignoring empty SQL file");
178 * Check if input data is UTF-8. Allow CR/LF \t, too.
180 for (p = buffer; p < (buffer + len); p += cl) {
182 if ((*p != 0x0a) && (*p != 0x0d) && (*p != '\t')) break;
185 cl = fr_utf8_char((uint8_t *) p);
190 if ((p - buffer) != len) {
191 ERROR("rlm_sql_sqlite: Bootstrap file contains non-UTF8 char at offset %zu", p - buffer);
197 * Statement delimiter is ;\n
200 while ((q = strchr(p, ';'))) {
208 #ifdef HAVE_SQLITE3_PREPARE_V2
209 (void) sqlite3_prepare_v2(db, s, len, &statement, &z_tail);
211 (void) sqlite3_prepare(db, s, len, &>statement, &z_tail);
213 if (sql_check_error(db) != RLM_SQL_OK) {
218 (void) sqlite3_step(statement);
219 status = sql_check_error(db);
221 (void) sqlite3_finalize(statement);
222 if ((status != RLM_SQL_OK) || sql_check_error(db)) {
235 static int mod_instantiate(CONF_SECTION *conf, rlm_sql_config_t *config)
237 static bool version_done;
240 rlm_sql_sqlite_config_t *driver;
246 if (sqlite3_libversion_number() != SQLITE_VERSION_NUMBER) {
247 WARN("rlm_sql_sqlite: libsqlite version changed since the server was built");
248 WARN("rlm_sql_sqlite: linked: %s built: %s", sqlite3_libversion(), SQLITE_VERSION);
250 INFO("rlm_sql_sqlite: libsqlite version: %s", sqlite3_libversion());
253 MEM(driver = config->driver = talloc_zero(config, rlm_sql_sqlite_config_t));
254 if (cf_section_parse(conf, driver, driver_config) < 0) {
257 if (!driver->filename) {
258 MEM(driver->filename = talloc_typed_asprintf(driver, "%s/%s", get_radius_dir(), config->sql_db));
261 if (stat(driver->filename, &buf) == 0) {
263 } else if (errno == ENOENT) {
266 ERROR("rlm_sql_sqlite: Database exists, but couldn't be opened: %s", fr_syserror(errno));
270 if (cf_pair_find(conf, "bootstrap") && !exists) {
271 # ifdef HAVE_SQLITE3_OPEN_V2
279 INFO("rlm_sql_sqlite: Database doesn't exist, creating it and loading schema");
281 p = strrchr(driver->filename, '/');
283 size_t len = (p - driver->filename) + 1;
285 buff = talloc_array(conf, char, len);
286 strlcpy(buff, driver->filename, len);
288 MEM(buff = talloc_typed_strdup(conf, driver->filename));
291 ret = rad_mkdir(buff, 0700, -1, -1);
294 ERROR("rlm_sql_sqlite: Failed creating directory for SQLite database: %s", fr_syserror(errno));
299 status = sqlite3_open_v2(driver->filename, &db, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, NULL);
301 # ifdef HAVE_SQLITE3_ERRSTR
302 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database: %s",
303 sqlite3_errstr(status));
305 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database, got code (%i)",
312 if (sql_check_error(db) != RLM_SQL_OK) {
313 (void) sqlite3_close(db);
319 * Execute multiple bootstrap SQL files in order
321 for (cp = cf_pair_find(conf, "bootstrap");
323 cp = cf_pair_find_next(conf, cp, "bootstrap")) {
324 p = cf_pair_value(cp);
327 ret = sql_loadfile(conf, db, p);
328 if (ret < 0) goto unlink;
331 status = sqlite3_close(db);
332 if (status != SQLITE_OK) {
334 * Safer to use sqlite3_errstr here, just in case the handle is in a weird state
336 # ifdef HAVE_SQLITE3_ERRSTR
337 ERROR("rlm_sql_sqlite: Error closing SQLite handle: %s", sqlite3_errstr(status));
339 ERROR("rlm_sql_sqlite: Error closing SQLite handle, got code (%i)", status);
347 if ((unlink(driver->filename) < 0) && (errno != ENOENT)) {
348 ERROR("rlm_sql_sqlite: Error removing partially initialised database: %s",
354 WARN("rlm_sql_sqlite: sqlite3_open_v2() not available, cannot bootstrap database. "
355 "Upgrade to SQLite >= 3.5.1 if you need this functionality");
362 static int _sql_socket_destructor(rlm_sql_sqlite_conn_t *conn)
366 DEBUG2("rlm_sql_sqlite: Socket destructor called, closing socket");
369 status = sqlite3_close(conn->db);
370 if (status != SQLITE_OK) {
371 WARN("rlm_sql_sqlite: Got SQLite error code (%u) when closing socket", status);
378 static void _sql_greatest(sqlite3_context *ctx, int num_values, sqlite3_value **values)
381 sqlite3_int64 value, max = 0;
383 for (i = 0; i < num_values; i++) {
384 value = sqlite3_value_int64(values[i]);
390 sqlite3_result_int64(ctx, max);
393 static sql_rcode_t sql_socket_init(rlm_sql_handle_t *handle, rlm_sql_config_t *config)
395 rlm_sql_sqlite_conn_t *conn;
396 rlm_sql_sqlite_config_t *driver = config->driver;
400 MEM(conn = handle->conn = talloc_zero(handle, rlm_sql_sqlite_conn_t));
401 talloc_set_destructor(conn, _sql_socket_destructor);
403 INFO("rlm_sql_sqlite: Opening SQLite database \"%s\"", driver->filename);
404 #ifdef HAVE_SQLITE3_OPEN_V2
405 status = sqlite3_open_v2(driver->filename, &(conn->db), SQLITE_OPEN_READWRITE | SQLITE_OPEN_NOMUTEX, NULL);
407 status = sqlite3_open(driver->filename, &(conn->db));
410 #ifdef HAVE_SQLITE3_ERRSTR
411 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite: %s", sqlite3_errstr(status));
413 ERROR("rlm_sql_sqlite: Failed creating opening/creating SQLite database error code (%i)",
417 return RLM_SQL_ERROR;
420 if (sql_check_error(conn->db) != RLM_SQL_OK) return RLM_SQL_ERROR;
423 * Enable extended return codes for extra debugging info.
425 #ifdef HAVE_SQLITE3_EXTENDED_RESULT_CODES
426 (void) sqlite3_extended_result_codes(conn->db, 1);
428 if (sql_check_error(conn->db) != RLM_SQL_OK) return RLM_SQL_ERROR;
430 #ifdef HAVE_SQLITE3_CREATE_FUNCTION_V2
431 status = sqlite3_create_function_v2(conn->db, "GREATEST", -1, SQLITE_ANY, NULL,
432 _sql_greatest, NULL, NULL, NULL);
434 status = sqlite3_create_function(conn->db, "GREATEST", -1, SQLITE_ANY, NULL,
435 _sql_greatest, NULL, NULL);
437 if (status != SQLITE_OK) {
438 ERROR("rlm_sql_sqlite: Failed registering 'GREATEST' sql function: %s", sqlite3_errmsg(conn->db));
444 static sql_rcode_t sql_select_query(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config, char const *query)
446 rlm_sql_sqlite_conn_t *conn = handle->conn;
449 #ifdef HAVE_SQLITE3_PREPARE_V2
450 (void) sqlite3_prepare_v2(conn->db, query, strlen(query), &conn->statement, &z_tail);
452 (void) sqlite3_prepare(conn->db, query, strlen(query), &conn->statement, &z_tail);
457 return sql_check_error(conn->db);
461 static sql_rcode_t sql_query(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config, char const *query)
464 rlm_sql_sqlite_conn_t *conn = handle->conn;
467 #ifdef HAVE_SQLITE3_PREPARE_V2
468 status = sqlite3_prepare_v2(conn->db, query, strlen(query), &conn->statement, &z_tail);
470 status = sqlite3_prepare(conn->db, query, strlen(query), &conn->statement, &z_tail);
472 if (status != SQLITE_OK) return sql_check_error(conn->db);
474 (void) sqlite3_step(conn->statement);
476 return sql_check_error(conn->db);
479 static sql_rcode_t sql_store_result(UNUSED rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config)
484 static int sql_num_fields(rlm_sql_handle_t * handle, UNUSED rlm_sql_config_t *config)
486 rlm_sql_sqlite_conn_t *conn = handle->conn;
488 if (conn->statement) {
489 return sqlite3_column_count(conn->statement);
495 static int sql_num_rows(rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config)
497 rlm_sql_sqlite_conn_t *conn = handle->conn;
499 if (conn->statement) {
500 return sqlite3_data_count(conn->statement);
506 static sql_rcode_t sql_fetch_row(rlm_sql_handle_t *handle, rlm_sql_config_t *config)
509 rlm_sql_sqlite_conn_t *conn = handle->conn;
516 * Executes the SQLite query and interates over the results
518 status = sqlite3_step(conn->statement);
521 * Error getting next row
523 if (sql_check_error(conn->db) != RLM_SQL_OK) return RLM_SQL_ERROR;
526 * No more rows to process (were done)
528 if (status == SQLITE_DONE) {
533 * We only need to do this once per result set, because
534 * the number of columns won't change.
536 if (conn->col_count == 0) {
537 conn->col_count = sql_num_fields(handle, config);
538 if (conn->col_count == 0) return RLM_SQL_ERROR;
542 * Free the previous result (also gets called on finish_query)
544 talloc_free(handle->row);
546 MEM(row = handle->row = talloc_zero_array(handle->conn, char *, conn->col_count + 1));
548 for (i = 0; i < conn->col_count; i++) {
549 switch (sqlite3_column_type(conn->statement, i)) {
551 MEM(row[i] = talloc_typed_asprintf(row, "%d", sqlite3_column_int(conn->statement, i)));
555 MEM(row[i] = talloc_typed_asprintf(row, "%f", sqlite3_column_double(conn->statement, i)));
561 p = (char const *) sqlite3_column_text(conn->statement, i);
564 MEM(row[i] = talloc_typed_strdup(row, p));
574 p = sqlite3_column_blob(conn->statement, i);
576 len = sqlite3_column_bytes(conn->statement, i);
578 MEM(row[i] = talloc_zero_array(row, char, len + 1));
579 memcpy(row[i], p, len);
592 static sql_rcode_t sql_free_result(rlm_sql_handle_t *handle,
593 UNUSED rlm_sql_config_t *config)
595 rlm_sql_sqlite_conn_t *conn = handle->conn;
597 if (conn->statement) {
598 TALLOC_FREE(handle->row);
600 (void) sqlite3_finalize(conn->statement);
601 conn->statement = NULL;
606 * There's no point in checking the code returned by finalize
607 * as it'll have already been encountered elsewhere in the code.
609 * It's just the last error that occurred processing the
615 /** Retrieves any errors associated with the connection handle
617 * @note Caller will free any memory allocated in ctx.
619 * @param ctx to allocate temporary error buffers in.
620 * @param out Array of sql_log_entrys to fill.
621 * @param outlen Length of out array.
622 * @param handle rlm_sql connection handle.
623 * @param config rlm_sql config.
624 * @return number of errors written to the sql_log_entry array.
626 static size_t sql_error(UNUSED TALLOC_CTX *ctx, sql_log_entry_t out[], size_t outlen,
627 rlm_sql_handle_t *handle, UNUSED rlm_sql_config_t *config)
629 rlm_sql_sqlite_conn_t *conn = handle->conn;
632 rad_assert(outlen > 0);
634 error = sqlite3_errmsg(conn->db);
635 if (!error) return 0;
643 static sql_rcode_t sql_finish_query(rlm_sql_handle_t *handle, rlm_sql_config_t *config)
645 return sql_free_result(handle, config);
648 static int sql_affected_rows(rlm_sql_handle_t *handle,
649 UNUSED rlm_sql_config_t *config)
651 rlm_sql_sqlite_conn_t *conn = handle->conn;
654 return sqlite3_changes(conn->db);
661 /* Exported to rlm_sql */
662 extern rlm_sql_module_t rlm_sql_sqlite;
663 rlm_sql_module_t rlm_sql_sqlite = {
664 .name = "rlm_sql_sqlite",
665 .flags = RLM_SQL_RCODE_FLAGS_ALT_QUERY,
666 .mod_instantiate = mod_instantiate,
667 .sql_socket_init = sql_socket_init,
668 .sql_query = sql_query,
669 .sql_select_query = sql_select_query,
670 .sql_store_result = sql_store_result,
671 .sql_num_fields = sql_num_fields,
672 .sql_num_rows = sql_num_rows,
673 .sql_affected_rows = sql_affected_rows,
674 .sql_fetch_row = sql_fetch_row,
675 .sql_free_result = sql_free_result,
676 .sql_error = sql_error,
677 .sql_finish_query = sql_finish_query,
678 .sql_finish_select_query = sql_finish_query