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
19 * @brief Implements SQL 'users' file, and SQL accounting.
21 * @copyright 2012 Arran Cudbard-Bell <a.cudbardb@freeradius.org>
22 * @copyright 2000,2006 The FreeRADIUS server project
23 * @copyright 2000 Mike Machado <mike@innercite.com>
24 * @copyright 2000 Alan DeKok <aland@ox.org>
30 #include <freeradius-devel/radiusd.h>
31 #include <freeradius-devel/modules.h>
32 #include <freeradius-devel/token.h>
33 #include <freeradius-devel/rad_assert.h>
40 * So we can do pass2 xlat checks on the queries.
42 static const CONF_PARSER query_config[] = {
44 { "query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT | PW_TYPE_MULTI, rlm_sql_config_t, accounting.query), NULL },
46 {NULL, -1, 0, NULL, NULL}
50 * For now hard-code the subsections. This isn't perfect, but it
51 * helps the average case.
53 static const CONF_PARSER type_config[] = {
55 { "accounting-on", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
56 { "accounting-off", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
57 { "start", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
58 { "interim-update", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
59 { "stop", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) query_config },
61 {NULL, -1, 0, NULL, NULL}
66 static const CONF_PARSER acct_config[] = {
67 { "reference", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, accounting.reference), ".query" },
68 { "logfile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, accounting.logfile), NULL },
70 { "type", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) type_config },
72 {NULL, -1, 0, NULL, NULL}
75 static const CONF_PARSER postauth_config[] = {
76 { "reference", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, postauth.reference), ".query" },
77 { "logfile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, postauth.logfile), NULL },
79 { "query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT | PW_TYPE_MULTI, rlm_sql_config_t, postauth.query), NULL },
81 {NULL, -1, 0, NULL, NULL}
84 static const CONF_PARSER module_config[] = {
85 { "driver", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_driver_name), "rlm_sql_null" },
86 { "server", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_server), "localhost" },
87 { "port", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_port), "" },
88 { "login", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_login), "" },
89 { "password", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_SECRET, rlm_sql_config_t, sql_password), "" },
90 { "radius_db", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, sql_db), "radius" },
91 { "read_groups", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, read_groups), "yes" },
92 { "read_profiles", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, read_profiles), "yes" },
93 { "readclients", FR_CONF_OFFSET(PW_TYPE_BOOLEAN | PW_TYPE_DEPRECATED, rlm_sql_config_t, do_clients), NULL },
94 { "read_clients", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, do_clients), "no" },
95 { "deletestalesessions", FR_CONF_OFFSET(PW_TYPE_BOOLEAN | PW_TYPE_DEPRECATED, rlm_sql_config_t, deletestalesessions), NULL },
96 { "delete_stale_sessions", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_sql_config_t, deletestalesessions), "yes" },
97 { "sql_user_name", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, query_user), "" },
98 { "logfile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, logfile), NULL },
99 { "default_user_profile", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, default_profile), "" },
100 { "nas_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_DEPRECATED, rlm_sql_config_t, client_query), NULL },
101 { "client_query", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, client_query), "SELECT id,nasname,shortname,type,secret FROM nas" },
102 { "open_query", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, open_query), NULL },
104 { "authorize_check_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_check_query), NULL },
105 { "authorize_reply_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_reply_query), NULL },
107 { "authorize_group_check_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_group_check_query), "" },
108 { "authorize_group_reply_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, authorize_group_reply_query), "" },
109 { "group_membership_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, groupmemb_query), NULL },
110 #ifdef WITH_SESSION_MGMT
111 { "simul_count_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, simul_count_query), "" },
112 { "simul_verify_query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT, rlm_sql_config_t, simul_verify_query), "" },
114 { "safe-characters", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_DEPRECATED, rlm_sql_config_t, allowed_chars), NULL },
115 { "safe_characters", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_sql_config_t, allowed_chars), "@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /" },
118 * This only works for a few drivers.
120 { "query_timeout", FR_CONF_OFFSET(PW_TYPE_INTEGER, rlm_sql_config_t, query_timeout), NULL },
122 { "accounting", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) acct_config },
124 { "post-auth", FR_CONF_POINTER(PW_TYPE_SUBSECTION, NULL), (void const *) postauth_config },
126 {NULL, -1, 0, NULL, NULL}
130 * Fall-Through checking function from rlm_files.c
132 static sql_fall_through_t fall_through(VALUE_PAIR *vp)
135 tmp = pairfind(vp, PW_FALL_THROUGH, 0, TAG_ANY);
137 return tmp ? tmp->vp_integer : FALL_THROUGH_DEFAULT;
143 static int generate_sql_clients(rlm_sql_t *inst);
144 static size_t sql_escape_func(REQUEST *, char *out, size_t outlen, char const *in, void *arg);
149 * For selects the first value of the first column will be returned,
150 * for inserts, updates and deletes the number of rows affected will be
153 static ssize_t sql_xlat(void *instance, REQUEST *request, char const *query, char *out, size_t freespace)
155 rlm_sql_handle_t *handle = NULL;
157 rlm_sql_t *inst = instance;
162 * Add SQL-User-Name attribute just in case it is needed
163 * We could search the string fmt for SQL-User-Name to see if this is
166 sql_set_user(inst, request, NULL);
168 handle = fr_connection_get(inst->pool);
173 rlm_sql_query_log(inst, request, NULL, query);
176 * If the query starts with any of the following prefixes,
177 * then return the number of rows affected
179 if ((strncasecmp(query, "insert", 6) == 0) ||
180 (strncasecmp(query, "update", 6) == 0) ||
181 (strncasecmp(query, "delete", 6) == 0)) {
183 char buffer[21]; /* 64bit max is 20 decimal chars + null byte */
185 if (rlm_sql_query(&handle, inst, query) != RLM_SQL_OK) {
186 char const *error = (inst->module->sql_error)(handle, inst->config);
187 REDEBUG("SQL query failed: %s", error);
193 numaffected = (inst->module->sql_affected_rows)(handle, inst->config);
194 if (numaffected < 1) {
195 RDEBUG("SQL query affected no rows");
201 * Don't chop the returned number if freespace is
202 * too small. This hack is necessary because
203 * some implementations of snprintf return the
204 * size of the written data, and others return
205 * the size of the data they *would* have written
206 * if the output buffer was large enough.
208 snprintf(buffer, sizeof(buffer), "%d", numaffected);
210 len = strlen(buffer);
211 if (len >= freespace){
212 RDEBUG("rlm_sql (%s): Can't write result, insufficient string space", inst->config->xlat_name);
214 (inst->module->sql_finish_query)(handle, inst->config);
220 memcpy(out, buffer, len + 1); /* we did bounds checking above */
223 (inst->module->sql_finish_query)(handle, inst->config);
226 } /* else it's a SELECT statement */
228 if (rlm_sql_select_query(&handle, inst, query) != RLM_SQL_OK) {
229 ret = -1; /* error handled by rlm_sql_select_query */
234 ret = rlm_sql_fetch_row(&handle, inst);
236 REDEBUG("SQL query failed");
237 (inst->module->sql_finish_select_query)(handle, inst->config);
245 RDEBUG("SQL query returned no results");
246 (inst->module->sql_finish_select_query)(handle, inst->config);
253 RDEBUG("NULL value in first column of result");
254 (inst->module->sql_finish_select_query)(handle, inst->config);
260 len = strlen(row[0]);
261 if (len >= freespace){
262 RDEBUG("Insufficient string space");
263 (inst->module->sql_finish_select_query)(handle, inst->config);
269 strlcpy(out, row[0], freespace);
272 (inst->module->sql_finish_select_query)(handle, inst->config);
275 fr_connection_release(inst->pool, handle);
280 static int generate_sql_clients(rlm_sql_t *inst)
282 rlm_sql_handle_t *handle;
287 DEBUG("rlm_sql (%s): Processing generate_sql_clients",
288 inst->config->xlat_name);
290 DEBUG("rlm_sql (%s) in generate_sql_clients: query is %s",
291 inst->config->xlat_name, inst->config->client_query);
293 handle = fr_connection_get(inst->pool);
298 if (rlm_sql_select_query(&handle, inst, inst->config->client_query) != RLM_SQL_OK) return -1;
300 while ((rlm_sql_fetch_row(&handle, inst) == 0) && (row = handle->row)) {
305 * The return data for each row MUST be in the following order:
307 * 0. Row ID (currently unused)
308 * 1. Name (or IP address)
312 * 5. Virtual Server (optional)
315 ERROR("rlm_sql (%s): No row id found on pass %d",inst->config->xlat_name,i);
319 ERROR("rlm_sql (%s): No nasname found for row %s",inst->config->xlat_name,row[0]);
323 ERROR("rlm_sql (%s): No short name found for row %s",inst->config->xlat_name,row[0]);
327 ERROR("rlm_sql (%s): No secret found for row %s",inst->config->xlat_name,row[0]);
331 if (((inst->module->sql_num_fields)(handle, inst->config) > 5) && (row[5] != NULL) && *row[5]) {
335 DEBUG("rlm_sql (%s): Adding client %s (%s) to %s clients list",
336 inst->config->xlat_name,
337 row[1], row[2], server ? server : "global");
339 /* FIXME: We should really pass a proper ctx */
340 c = client_afrom_query(NULL,
341 row[1], /* identifier */
343 row[2], /* shortname */
346 false); /* require message authenticator */
351 if (!client_add(NULL, c)) {
352 WARN("Failed to add client, possible duplicate?");
358 DEBUG("rlm_sql (%s): Client \"%s\" (%s) added", c->longname, c->shortname,
359 inst->config->xlat_name);
362 (inst->module->sql_finish_select_query)(handle, inst->config);
363 fr_connection_release(inst->pool, handle);
370 * Translate the SQL queries.
372 static size_t sql_escape_func(UNUSED REQUEST *request, char *out, size_t outlen,
373 char const *in, void *arg)
375 rlm_sql_t *inst = arg;
382 * Allow all multi-byte UTF8 characters.
384 utf8_len = fr_utf8_char((uint8_t const *) in);
386 if (outlen <= utf8_len) break;
388 memcpy(out, in, utf8_len);
398 * Because we register our own escape function
399 * we're now responsible for escaping all special
400 * chars in an xlat expansion or attribute value.
404 if (outlen <= 2) break;
415 if (outlen <= 2) break;
426 if (outlen <= 2) break;
438 * Non-printable characters get replaced with their
439 * mime-encoded equivalents.
442 strchr(inst->config->allowed_chars, *in) == NULL) {
444 * Only 3 or less bytes available.
450 snprintf(out, outlen, "=%02X", (unsigned char) in[0]);
459 * Only one byte left.
479 * Set the SQL user name.
481 * We don't call the escape function here. The resulting string
482 * will be escaped later in the queries xlat so we don't need to
483 * escape it twice. (it will make things wrong if we have an
484 * escape candidate character in the username)
486 int sql_set_user(rlm_sql_t *inst, REQUEST *request, char const *username)
488 char *expanded = NULL;
489 VALUE_PAIR *vp = NULL;
493 rad_assert(request->packet != NULL);
495 if (username != NULL) {
497 } else if (inst->config->query_user[0] != '\0') {
498 sqluser = inst->config->query_user;
503 len = radius_axlat(&expanded, request, sqluser, NULL, NULL);
508 vp = pairalloc(request->packet, inst->sql_user);
510 talloc_free(expanded);
514 pairstrsteal(vp, expanded);
515 RDEBUG2("SQL-User-Name set to '%s'", vp->vp_strvalue);
517 radius_pairmove(request, &request->packet->vps, vp, false); /* needs to be pair move else op is not respected */
523 * Do a set/unset user, so it's a bit clearer what's going on.
525 #define sql_unset_user(_i, _r) pairdelete(&_r->packet->vps, _i->sql_user->attr, _i->sql_user->vendor, TAG_ANY)
527 static int sql_get_grouplist(rlm_sql_t *inst, rlm_sql_handle_t **handle, REQUEST *request,
528 rlm_sql_grouplist_t **phead)
530 char *expanded = NULL;
533 rlm_sql_grouplist_t *entry;
536 /* NOTE: sql_set_user should have been run before calling this function */
538 entry = *phead = NULL;
540 if (!inst->config->groupmemb_query) return 0;
541 if (radius_axlat(&expanded, request, inst->config->groupmemb_query, sql_escape_func, inst) < 0) return -1;
543 ret = rlm_sql_select_query(handle, inst, expanded);
544 talloc_free(expanded);
545 if (ret != RLM_SQL_OK) return -1;
547 while (rlm_sql_fetch_row(handle, inst) == 0) {
548 row = (*handle)->row;
553 RDEBUG("row[0] returned NULL");
554 (inst->module->sql_finish_select_query)(*handle, inst->config);
560 *phead = talloc_zero(*handle, rlm_sql_grouplist_t);
563 entry->next = talloc_zero(*phead, rlm_sql_grouplist_t);
567 entry->name = talloc_typed_strdup(entry, row[0]);
572 (inst->module->sql_finish_select_query)(*handle, inst->config);
579 * sql groupcmp function. That way we can do group comparisons (in the users file for example)
580 * with the group memberships reciding in sql
581 * The group membership query should only return one element which is the username. The returned
582 * username will then be checked with the passed check string.
585 static int CC_HINT(nonnull (1, 2, 4)) sql_groupcmp(void *instance, REQUEST *request, UNUSED VALUE_PAIR *request_vp,
586 VALUE_PAIR *check, UNUSED VALUE_PAIR *check_pairs,
587 UNUSED VALUE_PAIR **reply_pairs)
589 rlm_sql_handle_t *handle;
590 rlm_sql_t *inst = instance;
591 rlm_sql_grouplist_t *head, *entry;
593 RDEBUG("sql_groupcmp");
595 if (check->length == 0){
596 RDEBUG("sql_groupcmp: Illegal group name");
601 * Set, escape, and check the user attr here
603 if (sql_set_user(inst, request, NULL) < 0)
607 * Get a socket for this lookup
609 handle = fr_connection_get(inst->pool);
615 * Get the list of groups this user is a member of
617 if (sql_get_grouplist(inst, &handle, request, &head) < 0) {
618 REDEBUG("Error getting group membership");
619 fr_connection_release(inst->pool, handle);
623 for (entry = head; entry != NULL; entry = entry->next) {
624 if (strcmp(entry->name, check->vp_strvalue) == 0){
625 RDEBUG("sql_groupcmp finished: User is a member of group %s",
628 fr_connection_release(inst->pool, handle);
633 /* Free the grouplist */
635 fr_connection_release(inst->pool, handle);
637 RDEBUG("sql_groupcmp finished: User is NOT a member of group %s", check->vp_strvalue);
642 static rlm_rcode_t rlm_sql_process_groups(rlm_sql_t *inst, REQUEST *request, rlm_sql_handle_t **handle,
643 sql_fall_through_t *do_fall_through)
645 rlm_rcode_t rcode = RLM_MODULE_NOOP;
646 VALUE_PAIR *check_tmp = NULL, *reply_tmp = NULL, *sql_group = NULL;
647 rlm_sql_grouplist_t *head = NULL, *entry = NULL;
649 char *expanded = NULL;
652 rad_assert(request->packet != NULL);
655 * Get the list of groups this user is a member of
657 rows = sql_get_grouplist(inst, handle, request, &head);
659 REDEBUG("Error retrieving group list");
661 return RLM_MODULE_FAIL;
664 RDEBUG2("User not found in any groups");
665 rcode = RLM_MODULE_NOTFOUND;
670 RDEBUG2("User found in the group table");
673 * Add the Sql-Group attribute to the request list so we know
674 * which group we're retrieving attributes for
676 sql_group = pairmake_packet("Sql-Group", NULL, T_OP_EQ);
678 REDEBUG("Error creating Sql-Group attribute");
679 rcode = RLM_MODULE_FAIL;
686 pairstrcpy(sql_group, entry->name);
688 if (inst->config->authorize_group_check_query && *inst->config->authorize_group_check_query) {
693 * Expand the group query
695 if (radius_axlat(&expanded, request, inst->config->authorize_group_check_query,
696 sql_escape_func, inst) < 0) {
697 REDEBUG("Error generating query");
698 rcode = RLM_MODULE_FAIL;
702 rows = sql_getvpdata(request, inst, request, handle, &check_tmp, expanded);
703 TALLOC_FREE(expanded);
705 REDEBUG("Error retrieving check pairs for group %s", entry->name);
706 rcode = RLM_MODULE_FAIL;
711 * If we got check rows we need to process them before we decide to
712 * process the reply rows
715 (paircompare(request, request->packet->vps, check_tmp, &request->reply->vps) != 0)) {
716 pairfree(&check_tmp);
719 goto next; /* != continue */
722 RDEBUG2("Group \"%s\": Conditional check items matched", entry->name);
723 rcode = RLM_MODULE_OK;
725 RDEBUG2("Group \"%s\": Merging assignment check items", entry->name);
727 for (vp = fr_cursor_init(&cursor, &check_tmp);
729 vp = fr_cursor_next(&cursor)) {
730 if (!fr_assignment_op[vp->op]) continue;
732 rdebug_pair(L_DBG_LVL_2, request, vp);
735 radius_pairmove(request, &request->config_items, check_tmp, true);
739 if (inst->config->authorize_group_reply_query && *inst->config->authorize_group_reply_query) {
741 * Now get the reply pairs since the paircompare matched
743 if (radius_axlat(&expanded, request, inst->config->authorize_group_reply_query,
744 sql_escape_func, inst) < 0) {
745 REDEBUG("Error generating query");
746 rcode = RLM_MODULE_FAIL;
750 rows = sql_getvpdata(request->reply, inst, request, handle, &reply_tmp, expanded);
751 TALLOC_FREE(expanded);
753 REDEBUG("Error retrieving reply pairs for group %s", entry->name);
754 rcode = RLM_MODULE_FAIL;
757 *do_fall_through = fall_through(reply_tmp);
759 RDEBUG2("Group \"%s\": Merging reply items", entry->name);
760 rcode = RLM_MODULE_OK;
762 rdebug_pair_list(L_DBG_LVL_2, request, reply_tmp, NULL);
764 radius_pairmove(request, &request->reply->vps, reply_tmp, true);
767 * If there's no reply query configured, then we assume
768 * FALL_THROUGH_NO, which is the same as the users file if you
769 * had no reply attributes.
772 *do_fall_through = FALL_THROUGH_DEFAULT;
776 } while (entry != NULL && (*do_fall_through == FALL_THROUGH_YES));
780 pairdelete(&request->packet->vps, PW_SQL_GROUP, 0, TAG_ANY);
786 static int mod_detach(void *instance)
788 rlm_sql_t *inst = instance;
790 if (inst->pool) fr_connection_pool_delete(inst->pool);
793 * We need to explicitly free all children, so if the driver
794 * parented any memory off the instance, their destructors
795 * run before we unload the bytecode for them.
797 * If we don't do this, we get a SEGV deep inside the talloc code
798 * when it tries to call a destructor that no longer exists.
800 talloc_free_children(inst);
803 * Decrements the reference count. The driver object won't be unloaded
804 * until all instances of rlm_sql that use it have been destroyed.
806 if (inst->handle) dlclose(inst->handle);
811 static int mod_instantiate(CONF_SECTION *conf, void *instance)
813 rlm_sql_t *inst = instance;
818 inst->config = &inst->myconfig;
821 inst->config->xlat_name = cf_section_name2(conf);
822 if (!inst->config->xlat_name) {
823 inst->config->xlat_name = cf_section_name1(conf);
830 * Allocate room for <instance>-SQL-Group
832 group_name = talloc_typed_asprintf(inst, "%s-SQL-Group", inst->config->xlat_name);
833 DEBUG("rlm_sql (%s): Creating new attribute %s",
834 inst->config->xlat_name, group_name);
836 memset(&flags, 0, sizeof(flags));
837 if (dict_addattr(group_name, -1, 0, PW_TYPE_STRING, flags) < 0) {
838 ERROR("rlm_sql (%s): Failed to create "
839 "attribute %s: %s", inst->config->xlat_name, group_name,
844 da = dict_attrbyname(group_name);
846 ERROR("rlm_sql (%s): Failed to create "
847 "attribute %s", inst->config->xlat_name, group_name);
851 if (inst->config->groupmemb_query &&
852 inst->config->groupmemb_query[0]) {
853 DEBUG("rlm_sql (%s): Registering sql_groupcmp for %s",
854 inst->config->xlat_name, group_name);
855 paircompare_register(da, dict_attrbyvalue(PW_USER_NAME, 0),
856 false, sql_groupcmp, inst);
860 rad_assert(inst->config->xlat_name);
863 * Complain if the strings exist, but are empty.
865 #define CHECK_STRING(_x) if (inst->config->_x && !inst->config->_x) WARN("rlm_sql (%s): " STRINGIFY(_x) " is empty. Please delete it from the configuration", inst->config->xlat_name)
867 CHECK_STRING(authorize_check_query);
868 CHECK_STRING(authorize_reply_query);
869 CHECK_STRING(authorize_group_check_query);
870 CHECK_STRING(authorize_group_reply_query);
873 * This will always exist, as cf_section_parse_init()
874 * will create it if it doesn't exist. However, the
875 * "reference" config item won't exist in an auto-created
876 * configuration. So if that doesn't exist, we ignore
877 * the whole subsection.
879 inst->config->accounting.cs = cf_section_sub_find(conf, "accounting");
880 inst->config->accounting.reference_cp = (cf_pair_find(inst->config->accounting.cs, "reference") != NULL);
882 inst->config->postauth.cs = cf_section_sub_find(conf, "post-auth");
883 inst->config->postauth.reference_cp = (cf_pair_find(inst->config->postauth.cs, "reference") != NULL);
886 * Cache the SQL-User-Name DICT_ATTR, so we can be slightly
887 * more efficient about creating SQL-User-Name attributes.
889 inst->sql_user = dict_attrbyname("SQL-User-Name");
890 if (!inst->sql_user) {
895 * Export these methods, too. This avoids RTDL_GLOBAL.
897 inst->sql_set_user = sql_set_user;
898 inst->sql_escape_func = sql_escape_func;
899 inst->sql_query = rlm_sql_query;
900 inst->sql_select_query = rlm_sql_select_query;
901 inst->sql_fetch_row = rlm_sql_fetch_row;
904 * Register the SQL xlat function
906 xlat_register(inst->config->xlat_name, sql_xlat, sql_escape_func, inst);
909 * Sanity check for crazy people.
911 if (strncmp(inst->config->sql_driver_name, "rlm_sql_", 8) != 0) {
912 ERROR("rlm_sql (%s): \"%s\" is NOT an SQL driver!", inst->config->xlat_name, inst->config->sql_driver_name);
917 * Load the appropriate driver for our database
919 inst->handle = lt_dlopenext(inst->config->sql_driver_name);
921 ERROR("Could not link driver %s: %s", inst->config->sql_driver_name, dlerror());
922 ERROR("Make sure it (and all its dependent libraries!) are in the search path of your system's ld");
926 inst->module = (rlm_sql_module_t *) dlsym(inst->handle,
927 inst->config->sql_driver_name);
929 ERROR("Could not link symbol %s: %s", inst->config->sql_driver_name, dlerror());
933 if (inst->module->mod_instantiate) {
937 name = strrchr(inst->config->sql_driver_name, '_');
939 name = inst->config->sql_driver_name;
944 cs = cf_section_sub_find(conf, name);
946 cs = cf_section_alloc(conf, name, NULL);
953 * It's up to the driver to register a destructor
955 if (inst->module->mod_instantiate(cs, inst->config) < 0) {
960 inst->lf = fr_logfile_init(inst);
962 cf_log_err_cs(conf, "Failed creating log file context");
966 INFO("rlm_sql (%s): Driver %s (module %s) loaded and linked", inst->config->xlat_name,
967 inst->config->sql_driver_name, inst->module->name);
970 * Initialise the connection pool for this instance
972 INFO("rlm_sql (%s): Attempting to connect to database \"%s\"", inst->config->xlat_name, inst->config->sql_db);
974 inst->pool = fr_connection_pool_module_init(inst->cs, inst, mod_conn_create, NULL, NULL);
975 if (!inst->pool) return -1;
977 if (inst->config->groupmemb_query &&
978 inst->config->groupmemb_query[0]) {
979 paircompare_register(dict_attrbyvalue(PW_SQL_GROUP, 0),
980 dict_attrbyvalue(PW_USER_NAME, 0), false, sql_groupcmp, inst);
983 if (inst->config->do_clients) {
984 if (generate_sql_clients(inst) == -1){
985 ERROR("Failed to load clients from SQL");
990 return RLM_MODULE_OK;
994 static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *request)
996 rlm_rcode_t rcode = RLM_MODULE_NOOP;
998 rlm_sql_t *inst = instance;
999 rlm_sql_handle_t *handle;
1001 VALUE_PAIR *check_tmp = NULL;
1002 VALUE_PAIR *reply_tmp = NULL;
1003 VALUE_PAIR *user_profile = NULL;
1005 bool user_found = false;
1007 sql_fall_through_t do_fall_through = FALL_THROUGH_DEFAULT;
1011 char *expanded = NULL;
1013 rad_assert(request->packet != NULL);
1014 rad_assert(request->reply != NULL);
1016 if (!inst->config->authorize_check_query && !inst->config->authorize_reply_query &&
1017 !inst->config->read_groups && !inst->config->read_profiles) {
1018 RWDEBUG("No authorization checks configured, returning noop");
1020 return RLM_MODULE_NOOP;
1024 * Set, escape, and check the user attr here
1026 if (sql_set_user(inst, request, NULL) < 0) {
1027 return RLM_MODULE_FAIL;
1033 * After this point use goto error or goto release to cleanup socket temporary pairlists and
1034 * temporary attributes.
1036 handle = fr_connection_get(inst->pool);
1038 rcode = RLM_MODULE_FAIL;
1043 * Query the check table to find any conditions associated with this user/realm/whatever...
1045 if (inst->config->authorize_check_query && *inst->config->authorize_check_query) {
1049 if (radius_axlat(&expanded, request, inst->config->authorize_check_query,
1050 sql_escape_func, inst) < 0) {
1051 REDEBUG("Error generating query");
1052 rcode = RLM_MODULE_FAIL;
1056 rows = sql_getvpdata(request, inst, request, &handle, &check_tmp, expanded);
1057 TALLOC_FREE(expanded);
1059 REDEBUG("SQL query error getting check attributes");
1060 rcode = RLM_MODULE_FAIL;
1064 if (rows == 0) goto skipreply; /* Don't need to free VPs we don't have */
1067 * Only do this if *some* check pairs were returned
1069 RDEBUG2("User found in radcheck table");
1071 if (paircompare(request, request->packet->vps, check_tmp, &request->reply->vps) != 0) {
1072 pairfree(&check_tmp);
1077 RDEBUG2("Conditional check items matched, merging assignment check items");
1079 for (vp = fr_cursor_init(&cursor, &check_tmp);
1081 vp = fr_cursor_next(&cursor)) {
1082 if (!fr_assignment_op[vp->op]) continue;
1084 rdebug_pair(2, request, vp);
1087 radius_pairmove(request, &request->config_items, check_tmp, true);
1089 rcode = RLM_MODULE_OK;
1093 if (inst->config->authorize_reply_query && *inst->config->authorize_reply_query) {
1095 * Now get the reply pairs since the paircompare matched
1097 if (radius_axlat(&expanded, request, inst->config->authorize_reply_query,
1098 sql_escape_func, inst) < 0) {
1099 REDEBUG("Error generating query");
1100 rcode = RLM_MODULE_FAIL;
1104 rows = sql_getvpdata(request->reply, inst, request, &handle, &reply_tmp, expanded);
1105 TALLOC_FREE(expanded);
1107 REDEBUG("SQL query error getting reply attributes");
1108 rcode = RLM_MODULE_FAIL;
1112 if (rows == 0) goto skipreply;
1114 do_fall_through = fall_through(reply_tmp);
1116 RDEBUG2("User found in radreply table, merging reply items");
1119 rdebug_pair_list(L_DBG_LVL_2, request, reply_tmp, NULL);
1121 radius_pairmove(request, &request->reply->vps, reply_tmp, true);
1123 rcode = RLM_MODULE_OK;
1128 if ((do_fall_through == FALL_THROUGH_YES) ||
1129 (inst->config->read_groups && (do_fall_through == FALL_THROUGH_DEFAULT))) {
1132 RDEBUG3("... falling-through to group processing");
1133 ret = rlm_sql_process_groups(inst, request, &handle, &do_fall_through);
1136 * Nothing bad happened, continue...
1138 case RLM_MODULE_UPDATED:
1139 rcode = RLM_MODULE_UPDATED;
1142 if (rcode != RLM_MODULE_UPDATED) {
1143 rcode = RLM_MODULE_OK;
1146 case RLM_MODULE_NOOP:
1150 case RLM_MODULE_NOTFOUND:
1160 * Repeat the above process with the default profile or User-Profile
1162 if ((do_fall_through == FALL_THROUGH_YES) ||
1163 (inst->config->read_profiles && (do_fall_through == FALL_THROUGH_DEFAULT))) {
1167 * Check for a default_profile or for a User-Profile.
1169 RDEBUG3("... falling-through to profile processing");
1170 user_profile = pairfind(request->config_items, PW_USER_PROFILE, 0, TAG_ANY);
1172 char const *profile = user_profile ?
1173 user_profile->vp_strvalue :
1174 inst->config->default_profile;
1176 if (!profile || !*profile) {
1180 RDEBUG2("Checking profile %s", profile);
1182 if (sql_set_user(inst, request, profile) < 0) {
1183 REDEBUG("Error setting profile");
1184 rcode = RLM_MODULE_FAIL;
1188 ret = rlm_sql_process_groups(inst, request, &handle, &do_fall_through);
1191 * Nothing bad happened, continue...
1193 case RLM_MODULE_UPDATED:
1194 rcode = RLM_MODULE_UPDATED;
1197 if (rcode != RLM_MODULE_UPDATED) {
1198 rcode = RLM_MODULE_OK;
1201 case RLM_MODULE_NOOP:
1205 case RLM_MODULE_NOTFOUND:
1215 * At this point the key (user) hasn't be found in the check table, the reply table
1216 * or the group mapping table, and there was no matching profile.
1220 rcode = RLM_MODULE_NOTFOUND;
1223 fr_connection_release(inst->pool, handle);
1224 sql_unset_user(inst, request);
1229 pairfree(&check_tmp);
1230 pairfree(&reply_tmp);
1231 sql_unset_user(inst, request);
1233 fr_connection_release(inst->pool, handle);
1239 * Generic function for failing between a bunch of queries.
1241 * Uses the same principle as rlm_linelog, expanding the 'reference' config
1242 * item using xlat to figure out what query it should execute.
1244 * If the reference matches multiple config items, and a query fails or
1245 * doesn't update any rows, the next matching config item is used.
1248 static int acct_redundant(rlm_sql_t *inst, REQUEST *request, sql_acct_section_t *section)
1250 rlm_rcode_t rcode = RLM_MODULE_OK;
1252 rlm_sql_handle_t *handle = NULL;
1254 int numaffected = 0;
1258 char const *attr = NULL;
1261 char path[MAX_STRING_LEN];
1263 char *expanded = NULL;
1265 rad_assert(section);
1267 if (section->reference[0] != '.') {
1271 if (radius_xlat(p, sizeof(path) - (p - path), request, section->reference, NULL, NULL) < 0) {
1272 rcode = RLM_MODULE_FAIL;
1277 item = cf_reference_item(NULL, section->cs, path);
1279 rcode = RLM_MODULE_FAIL;
1284 if (cf_item_is_section(item)){
1285 REDEBUG("Sections are not supported as references");
1286 rcode = RLM_MODULE_FAIL;
1291 pair = cf_itemtopair(item);
1292 attr = cf_pair_attr(pair);
1294 RDEBUG2("Using query template '%s'", attr);
1296 handle = fr_connection_get(inst->pool);
1298 rcode = RLM_MODULE_FAIL;
1303 sql_set_user(inst, request, NULL);
1306 value = cf_pair_value(pair);
1308 RDEBUG("Ignoring null query");
1309 rcode = RLM_MODULE_NOOP;
1314 if (radius_axlat(&expanded, request, value, sql_escape_func, inst) < 0) {
1315 rcode = RLM_MODULE_FAIL;
1321 RDEBUG("Ignoring null query");
1322 rcode = RLM_MODULE_NOOP;
1323 talloc_free(expanded);
1328 rlm_sql_query_log(inst, request, section, expanded);
1331 * If rlm_sql_query cannot use the socket it'll try and
1332 * reconnect. Reconnecting will automatically release
1333 * the current socket, and try to select a new one.
1335 * If we get RLM_SQL_RECONNECT it means all connections in the pool
1336 * were exhausted, and we couldn't create a new connection,
1337 * so we do not need to call fr_connection_release.
1339 sql_ret = rlm_sql_query(&handle, inst, expanded);
1340 TALLOC_FREE(expanded);
1341 if (sql_ret == RLM_SQL_RECONNECT) {
1342 rcode = RLM_MODULE_FAIL;
1348 * Assume all other errors are incidental, and just meant our
1349 * operation failed and its not a client or SQL syntax error.
1351 * @fixme We should actually be able to distinguish between key
1352 * constraint violations (which we expect) and other errors.
1354 if (sql_ret == RLM_SQL_OK) {
1355 numaffected = (inst->module->sql_affected_rows)(handle, inst->config);
1356 if (numaffected > 0) {
1357 break; /* A query succeeded, were done! */
1360 RDEBUG("No records updated");
1363 (inst->module->sql_finish_query)(handle, inst->config);
1366 * We assume all entries with the same name form a redundant
1369 pair = cf_pair_find_next(section->cs, pair, attr);
1372 RDEBUG("No additional queries configured");
1373 rcode = RLM_MODULE_NOOP;
1378 RDEBUG("Trying next query...");
1381 (inst->module->sql_finish_query)(handle, inst->config);
1384 talloc_free(expanded);
1385 fr_connection_release(inst->pool, handle);
1386 sql_unset_user(inst, request);
1391 #ifdef WITH_ACCOUNTING
1394 * Accounting: Insert or update session data in our sql table
1396 static rlm_rcode_t CC_HINT(nonnull) mod_accounting(void *instance, REQUEST * request) {
1397 rlm_sql_t *inst = instance;
1399 if (inst->config->accounting.reference_cp) {
1400 return acct_redundant(inst, request, &inst->config->accounting);
1403 return RLM_MODULE_NOOP;
1408 #ifdef WITH_SESSION_MGMT
1410 * See if a user is already logged in. Sets request->simul_count to the
1411 * current session count for this user.
1413 * Check twice. If on the first pass the user exceeds his
1414 * max. number of logins, do a second pass and validate all
1415 * logins by querying the terminal server (using eg. SNMP).
1418 static rlm_rcode_t CC_HINT(nonnull) mod_checksimul(void *instance, REQUEST * request) {
1419 rlm_rcode_t rcode = RLM_MODULE_OK;
1420 rlm_sql_handle_t *handle = NULL;
1421 rlm_sql_t *inst = instance;
1425 char const *call_num = NULL;
1428 uint32_t nas_addr = 0;
1429 uint32_t nas_port = 0;
1431 char *expanded = NULL;
1433 /* If simul_count_query is not defined, we don't do any checking */
1434 if (!inst->config->simul_count_query || (inst->config->simul_count_query[0] == '\0')) {
1435 return RLM_MODULE_NOOP;
1438 if((!request->username) || (request->username->length == '\0')) {
1439 REDEBUG("Zero Length username not permitted");
1441 return RLM_MODULE_INVALID;
1445 if(sql_set_user(inst, request, NULL) < 0) {
1446 return RLM_MODULE_FAIL;
1449 if (radius_axlat(&expanded, request, inst->config->simul_count_query, sql_escape_func, inst) < 0) {
1450 sql_unset_user(inst, request);
1451 return RLM_MODULE_FAIL;
1454 /* initialize the sql socket */
1455 handle = fr_connection_get(inst->pool);
1457 talloc_free(expanded);
1458 sql_unset_user(inst, request);
1459 return RLM_MODULE_FAIL;
1462 if (rlm_sql_select_query(&handle, inst, expanded) != RLM_SQL_OK) {
1463 rcode = RLM_MODULE_FAIL;
1467 ret = rlm_sql_fetch_row(&handle, inst);
1469 rcode = RLM_MODULE_FAIL;
1475 rcode = RLM_MODULE_FAIL;
1479 request->simul_count = atoi(row[0]);
1481 (inst->module->sql_finish_select_query)(handle, inst->config);
1482 TALLOC_FREE(expanded);
1484 if (request->simul_count < request->simul_max) {
1485 rcode = RLM_MODULE_OK;
1490 * Looks like too many sessions, so let's start verifying
1491 * them, unless told to rely on count query only.
1493 if (!inst->config->simul_verify_query || (inst->config->simul_verify_query[0] == '\0')) {
1494 rcode = RLM_MODULE_OK;
1499 if (radius_axlat(&expanded, request, inst->config->simul_verify_query, sql_escape_func, inst) < 0) {
1500 rcode = RLM_MODULE_FAIL;
1505 if (rlm_sql_select_query(&handle, inst, expanded) != RLM_SQL_OK) goto finish;
1508 * Setup some stuff, like for MPP detection.
1510 request->simul_count = 0;
1512 if ((vp = pairfind(request->packet->vps, PW_FRAMED_IP_ADDRESS, 0, TAG_ANY)) != NULL) {
1513 ipno = vp->vp_ipaddr;
1516 if ((vp = pairfind(request->packet->vps, PW_CALLING_STATION_ID, 0, TAG_ANY)) != NULL) {
1517 call_num = vp->vp_strvalue;
1520 while (rlm_sql_fetch_row(&handle, inst) == 0) {
1527 RDEBUG("Cannot zap stale entry. No username present in entry");
1528 rcode = RLM_MODULE_FAIL;
1534 RDEBUG("Cannot zap stale entry. No session id in entry");
1535 rcode = RLM_MODULE_FAIL;
1541 nas_addr = inet_addr(row[3]);
1545 nas_port = atoi(row[4]);
1548 check = rad_check_ts(nas_addr, nas_port, row[2], row[1]);
1551 * Stale record - zap it.
1553 if (inst->config->deletestalesessions == true) {
1554 uint32_t framed_addr = 0;
1559 framed_addr = inet_addr(row[5]);
1561 if (strcmp(row[7], "PPP") == 0)
1563 else if (strcmp(row[7], "SLIP") == 0)
1567 sess_time = atoi(row[8]);
1568 session_zap(request, nas_addr, nas_port,
1569 row[2], row[1], framed_addr,
1573 else if (check == 1) {
1575 * User is still logged in.
1577 ++request->simul_count;
1580 * Does it look like a MPP attempt?
1582 if (row[5] && ipno && inet_addr(row[5]) == ipno) {
1583 request->simul_mpp = 2;
1584 } else if (row[6] && call_num && !strncmp(row[6],call_num,16)) {
1585 request->simul_mpp = 2;
1589 * Failed to check the terminal server for
1590 * duplicate logins: return an error.
1592 REDEBUG("Failed to check the terminal server for user '%s'.", row[2]);
1594 rcode = RLM_MODULE_FAIL;
1601 (inst->module->sql_finish_select_query)(handle, inst->config);
1602 fr_connection_release(inst->pool, handle);
1603 talloc_free(expanded);
1604 sql_unset_user(inst, request);
1607 * The Auth module apparently looks at request->simul_count,
1608 * not the return value of this module when deciding to deny
1609 * a call for too many sessions.
1616 * Postauth: Write a record of the authentication attempt
1618 static rlm_rcode_t CC_HINT(nonnull) mod_post_auth(void *instance, REQUEST * request) {
1619 rlm_sql_t *inst = instance;
1621 if (inst->config->postauth.reference_cp) {
1622 return acct_redundant(inst, request, &inst->config->postauth);
1625 return RLM_MODULE_NOOP;
1629 * Execute postauth_query after authentication
1633 /* globally exported name */
1634 module_t rlm_sql = {
1637 RLM_TYPE_THREAD_SAFE, /* type: reserved */
1640 mod_instantiate, /* instantiation */
1641 mod_detach, /* detach */
1643 NULL, /* authentication */
1644 mod_authorize, /* authorization */
1645 NULL, /* preaccounting */
1646 #ifdef WITH_ACCOUNTING
1647 mod_accounting, /* accounting */
1651 #ifdef WITH_SESSION_MGMT
1652 mod_checksimul, /* checksimul */
1656 NULL, /* pre-proxy */
1657 NULL, /* post-proxy */
1658 mod_post_auth /* post-auth */