2 * sql.c rlm_sql - FreeRADIUS SQL Module
3 * Main code directly taken from ICRADIUS
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.
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.
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
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>
29 #include <freeradius-devel/radiusd.h>
30 #include <freeradius-devel/rad_assert.h>
42 static int _sql_conn_free(rlm_sql_handle_t *conn)
44 rlm_sql_t *inst = conn->inst;
48 exec_trigger(NULL, inst->cs, "modules.sql.close", false);
53 static void *mod_conn_create(TALLOC_CTX *ctx, void *instance)
56 rlm_sql_t *inst = instance;
57 rlm_sql_handle_t *handle;
60 * Connections cannot be alloced from the inst or
61 * pool contexts due to threading issues.
63 handle = talloc_zero(ctx, rlm_sql_handle_t);
64 if (!handle) return NULL;
67 * Handle requires a pointer to the SQL inst so the
68 * destructor has access to the module configuration.
73 * When something frees this handle the destructor set by
74 * the driver will be called first, closing any open sockets.
75 * Then we call our destructor to trigger an modules.sql.close
76 * event, then all the memory is freed.
78 talloc_set_destructor(handle, _sql_conn_free);
80 rcode = (inst->module->sql_socket_init)(handle, inst->config);
83 exec_trigger(NULL, inst->cs, "modules.sql.fail", true);
86 * Destroy any half opened connections.
92 if (inst->config->open_query && *inst->config->open_query) {
93 if (rlm_sql_select_query(&handle, inst, inst->config->open_query)) {
96 (inst->module->sql_finish_select_query)(handle, inst->config);
99 exec_trigger(NULL, inst->cs, "modules.sql.open", false);
103 /*************************************************************************
105 * Function: sql_socket_pool_init
107 * Purpose: Connect to the sql server, if possible
109 *************************************************************************/
110 int sql_socket_pool_init(rlm_sql_t * inst)
112 inst->pool = fr_connection_pool_init(inst->cs, inst, mod_conn_create, NULL, NULL, NULL);
113 if (!inst->pool) return -1;
118 /*************************************************************************
120 * Function: sql_poolfree
122 * Purpose: Clean up and free sql pool
124 *************************************************************************/
125 void sql_poolfree(rlm_sql_t * inst)
127 fr_connection_pool_delete(inst->pool);
131 /*************************************************************************
133 * Function: sql_get_socket
135 * Purpose: Return a SQL handle from the connection pool
137 *************************************************************************/
138 rlm_sql_handle_t * sql_get_socket(rlm_sql_t * inst)
140 return fr_connection_get(inst->pool);
143 /*************************************************************************
145 * Function: sql_release_socket
147 * Purpose: Frees a SQL handle back to the connection pool
149 *************************************************************************/
150 int sql_release_socket(rlm_sql_t * inst, rlm_sql_handle_t * handle)
152 fr_connection_release(inst->pool, handle);
157 /*************************************************************************
159 * Function: sql_userparse
161 * Purpose: Read entries from the database and fill VALUE_PAIR structures
163 *************************************************************************/
164 int sql_userparse(TALLOC_CTX *ctx, VALUE_PAIR **head, rlm_sql_row_t row)
167 char const *ptr, *value;
168 char buf[MAX_STRING_LEN];
170 FR_TOKEN token, operator = T_EOL;
173 * Verify the 'Attribute' field
175 if (!row[2] || row[2][0] == '\0') {
176 ERROR("rlm_sql: The 'Attribute' field is empty or NULL, skipping the entire row");
181 * Verify the 'op' field
183 if (row[4] != NULL && row[4][0] != '\0') {
185 operator = gettoken(&ptr, buf, sizeof(buf), false);
186 if ((operator < T_OP_ADD) ||
187 (operator > T_OP_CMP_EQ)) {
188 ERROR("rlm_sql: Invalid operator \"%s\" for attribute %s", row[4], row[2]);
194 * Complain about empty or invalid 'op' field
196 operator = T_OP_CMP_EQ;
197 ERROR("rlm_sql: The 'op' field for attribute '%s = %s' is NULL, or non-existent.", row[2], row[3]);
198 ERROR("rlm_sql: You MUST FIX THIS if you want the configuration to behave as you expect");
202 * The 'Value' field may be empty or NULL
206 * If we have a new-style quoted string, where the
207 * *entire* string is quoted, do xlat's.
209 if (row[3] != NULL &&
210 ((row[3][0] == '\'') || (row[3][0] == '`') || (row[3][0] == '"')) &&
211 (row[3][0] == row[3][strlen(row[3])-1])) {
213 token = gettoken(&value, buf, sizeof(buf), false);
216 * Take the unquoted string.
218 case T_SINGLE_QUOTED_STRING:
219 case T_DOUBLE_QUOTED_STRING:
224 * Mark the pair to be allocated later.
226 case T_BACK_QUOTED_STRING:
232 * Keep the original string.
243 vp = pairmake(ctx, NULL, row[2], NULL, operator);
245 ERROR("rlm_sql: Failed to create the pair: %s",
251 if (pairmark_xlat(vp, value) < 0) {
252 ERROR("rlm_sql: Error marking pair for xlat");
258 if (pairparsevalue(vp, value, 0) < 0) {
259 ERROR("rlm_sql: Error parsing value: %s", fr_strerror());
267 * Add the pair into the packet
274 /*************************************************************************
276 * Function: rlm_sql_fetch_row
278 * Purpose: call the module's sql_fetch_row and implement re-connect
280 *************************************************************************/
281 int rlm_sql_fetch_row(rlm_sql_handle_t **handle, rlm_sql_t *inst)
285 if (!*handle || !(*handle)->conn) {
290 * We can't implement reconnect logic here, because the caller may require
291 * the original connection to free up queries or result sets associated with
294 ret = (inst->module->sql_fetch_row)(*handle, inst->config);
296 char const *error = (inst->module->sql_error)(*handle, inst->config);
297 ERROR("rlm_sql (%s): Error fetching row: %s",
298 inst->config->xlat_name, error ? error : "<UNKNOWN>");
304 static void rlm_sql_query_error(rlm_sql_handle_t *handle, rlm_sql_t *inst)
308 p = (inst->module->sql_error)(handle, inst->config);
310 ERROR("rlm_sql (%s): Unknown query error", inst->config->xlat_name);
315 * Some drivers are nice and provide us with a ^ pointer to
316 * the place in the query string where the error occurred.
318 * For this to be useful we need to split log messages on
319 * \n and output each of the lines individually.
321 while ((q = strchr(p, '\n'))) {
322 ERROR("rlm_sql (%s): %.*s", inst->config->xlat_name, (int) (q - p), p);
327 ERROR("rlm_sql (%s): %s", inst->config->xlat_name, p);
331 static void rlm_sql_query_debug(rlm_sql_handle_t *handle, rlm_sql_t *inst)
335 p = (inst->module->sql_error)(handle, inst->config);
341 * Some drivers are nice and provide us with a ^ pointer to
342 * the place in the query string where the error occurred.
344 * For this to be useful we need to split log messages on
345 * \n and output each of the lines individually.
347 while ((q = strchr(p, '\n'))) {
348 DEBUG2("rlm_sql (%s): %.*s", inst->config->xlat_name, (int) (q - p), p);
353 DEBUG2("rlm_sql (%s): %s", inst->config->xlat_name, p);
357 /** Call the driver's sql_query method, reconnecting if necessary.
359 * @param handle to query the database with. *handle should not be NULL, as this indicates
360 * previous reconnection attempt has failed.
361 * @param inst rlm_sql instance data.
362 * @param query to execute. Should not be zero length.
363 * @return RLM_SQL_OK on success, RLM_SQL_RECONNECT if a new handle is required (also sets *handle = NULL),
364 * RLM_SQL_QUERY_ERROR/RLM_SQL_ERROR on invalid query or connection error, RLM_SQL_DUPLICATE on constraints
367 sql_rcode_t rlm_sql_query(rlm_sql_handle_t **handle, rlm_sql_t *inst, char const *query)
369 int ret = RLM_SQL_ERROR;
372 /* There's no query to run, return an error */
373 if (query[0] == '\0') return RLM_SQL_QUERY_ERROR;
375 /* There's no handle, we need a new one */
376 if (!*handle) return RLM_SQL_RECONNECT;
378 /* For sanity, for when no connections are viable, and we can't make a new one */
379 for (i = fr_connection_get_num(inst->pool); i >= 0; i--) {
380 DEBUG("rlm_sql (%s): Executing query: '%s'", inst->config->xlat_name, query);
382 ret = (inst->module->sql_query)(*handle, inst->config, query);
388 * Run through all available sockets until we exhaust all existing
389 * sockets in the pool and fail to establish a *new* connection.
391 case RLM_SQL_RECONNECT:
392 *handle = fr_connection_reconnect(inst->pool, *handle);
393 /* Reconnection failed */
394 if (!*handle) return RLM_SQL_RECONNECT;
395 /* Reconnection succeeded, try again with the new handle */
398 case RLM_SQL_QUERY_ERROR:
400 rlm_sql_query_error(*handle, inst);
403 case RLM_SQL_DUPLICATE:
404 rlm_sql_query_debug(*handle, inst);
412 ERROR("rlm_sql (%s): Hit reconnection limit", inst->config->xlat_name);
414 return RLM_SQL_ERROR;
417 /** Call the driver's sql_select_query method, reconnecting if necessary.
419 * @param handle to query the database with. *handle should not be NULL, as this indicates
420 * previous reconnection attempt has failed.
421 * @param inst rlm_sql instance data.
422 * @param query to execute. Should not be zero length.
423 * @return RLM_SQL_OK on success, RLM_SQL_RECONNECT if a new handle is required (also sets *handle = NULL),
424 * RLM_SQL_QUERY_ERROR/RLM_SQL_ERROR on invalid query or connection error.
426 sql_rcode_t rlm_sql_select_query(rlm_sql_handle_t **handle, rlm_sql_t *inst, char const *query)
428 int ret = RLM_SQL_ERROR;
431 /* There's no query to run, return an error */
432 if (query[0] == '\0') return RLM_SQL_QUERY_ERROR;
434 /* There's no handle, we need a new one */
435 if (!*handle) return RLM_SQL_RECONNECT;
437 /* For sanity, for when no connections are viable, and we can't make a new one */
438 for (i = fr_connection_get_num(inst->pool); i >= 0; i--) {
439 DEBUG("rlm_sql (%s): Executing query: '%s'", inst->config->xlat_name, query);
441 ret = (inst->module->sql_select_query)(*handle, inst->config, query);
447 * Run through all available sockets until we exhaust all existing
448 * sockets in the pool and fail to establish a *new* connection.
450 case RLM_SQL_RECONNECT:
451 *handle = fr_connection_reconnect(inst->pool, *handle);
452 /* Reconnection failed */
453 if (!*handle) return RLM_SQL_RECONNECT;
454 /* Reconnection succeeded, try again with the new handle */
457 case RLM_SQL_QUERY_ERROR:
460 rlm_sql_query_error(*handle, inst);
467 ERROR("rlm_sql (%s): Hit reconnection limit", inst->config->xlat_name);
469 return RLM_SQL_ERROR;
473 /*************************************************************************
475 * Function: sql_getvpdata
477 * Purpose: Get any group check or reply pairs
479 *************************************************************************/
480 int sql_getvpdata(rlm_sql_t * inst, rlm_sql_handle_t **handle,
481 TALLOC_CTX *ctx, VALUE_PAIR **pair, char const *query)
486 if (rlm_sql_select_query(handle, inst, query)) {
490 while (rlm_sql_fetch_row(handle, inst) == 0) {
491 row = (*handle)->row;
494 if (sql_userparse(ctx, pair, row) != 0) {
495 ERROR("rlm_sql (%s): Error parsing user data from database result", inst->config->xlat_name);
497 (inst->module->sql_finish_select_query)(*handle, inst->config);
503 (inst->module->sql_finish_select_query)(*handle, inst->config);
509 * Log the query to a file.
511 void rlm_sql_query_log(rlm_sql_t *inst, REQUEST *request,
512 sql_acct_section_t *section, char const *query)
515 char const *filename = NULL;
516 char *expanded = NULL;
518 bool failed = false; /* Write the log message outside of the critical region */
521 filename = section->logfile;
523 filename = inst->config->logfile;
530 if (radius_axlat(&expanded, request, filename, NULL, NULL) < 0) {
534 fd = fr_logfile_open(inst->lf, filename, 0640);
536 ERROR("rlm_sql (%s): Couldn't open logfile '%s': %s", inst->config->xlat_name,
537 expanded, fr_syserror(errno));
539 talloc_free(expanded);
544 if ((write(fd, query, len) < 0) || (write(fd, ";\n", 2) < 0)) {
549 ERROR("rlm_sql (%s): Failed writing to logfile '%s': %s", inst->config->xlat_name, expanded,
553 talloc_free(expanded);
554 fr_logfile_close(inst->lf, fd);