The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
rlm_sql.c
Go to the documentation of this file.
1/*
2 * This program 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.
6 *
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.
11 *
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
15 */
16
17/**
18 * $Id: fb050bb48680911c29e372388862432b776bd80b $
19 * @file rlm_sql.c
20 * @brief Implements SQL 'users' file, and SQL accounting.
21 *
22 * @copyright 2012-2014 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
23 * @copyright 2000,2006 The FreeRADIUS server project
24 * @copyright 2000 Mike Machado (mike@innercite.com)
25 * @copyright 2000 Alan DeKok (aland@freeradius.org)
26 */
27
28RCSID("$Id: fb050bb48680911c29e372388862432b776bd80b $")
29
30#define LOG_PREFIX mctx->mi->name
31
32#include <freeradius-devel/server/base.h>
33#include <freeradius-devel/server/module_rlm.h>
34#include <freeradius-devel/util/skip.h>
35#include <freeradius-devel/unlang/function.h>
36#include <freeradius-devel/unlang/xlat_func.h>
37#include <freeradius-devel/unlang/map.h>
38
39#include <sys/stat.h>
40
41#include "rlm_sql.h"
42
43#define SQL_SAFE_FOR (fr_value_box_safe_for_t)inst->driver
44
46
47static int submodule_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule);
48
53
54static const conf_parser_t module_config[] = {
55 { FR_CONF_OFFSET_TYPE_FLAGS("driver", FR_TYPE_VOID, 0, rlm_sql_t, driver_submodule), .dflt = "null",
57 { FR_CONF_OFFSET("server", rlm_sql_config_t, sql_server), .dflt = "" }, /* Must be zero length so drivers can determine if it was set */
58 { FR_CONF_OFFSET("port", rlm_sql_config_t, sql_port), .dflt = "0" },
59 { FR_CONF_OFFSET("login", rlm_sql_config_t, sql_login), .dflt = "" },
60 { FR_CONF_OFFSET_FLAGS("password", CONF_FLAG_SECRET, rlm_sql_config_t, sql_password), .dflt = "" },
61 { FR_CONF_OFFSET("radius_db", rlm_sql_config_t, sql_db), .dflt = "radius" },
62 { FR_CONF_OFFSET("read_groups", rlm_sql_config_t, read_groups), .dflt = "yes" },
63 { FR_CONF_OFFSET("group_attribute", rlm_sql_config_t, group_attribute) },
64 { FR_CONF_OFFSET("cache_groups", rlm_sql_config_t, cache_groups) },
65 { FR_CONF_OFFSET("read_profiles", rlm_sql_config_t, read_profiles), .dflt = "yes" },
66 { FR_CONF_OFFSET("open_query", rlm_sql_config_t, connect_query) },
67 { FR_CONF_OFFSET("query_number_attribute", rlm_sql_config_t, query_number_attribute) },
68
69 { FR_CONF_OFFSET("safe_characters", rlm_sql_config_t, allowed_chars), .dflt = "@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /" },
70
71 /*
72 * This only works for a few drivers.
73 */
74 { FR_CONF_OFFSET("query_timeout", rlm_sql_config_t, query_timeout), .dflt = "5" },
75
76 /*
77 * The pool section is used for trunk config
78 */
79 { FR_CONF_OFFSET_SUBSECTION("pool", 0, rlm_sql_config_t, trunk_conf, trunk_config) },
80
82
84};
85
87
90 { .out = &dict_freeradius, .proto = "freeradius" },
92};
93
98
101 { .out = &attr_fall_through, .name = "Fall-Through", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
102 { .out = &attr_sql_user_name, .name = "SQL-User-Name", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
103 { .out = &attr_user_profile, .name = "User-Profile", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
104 { .out = &attr_expr_bool_enum, .name = "Expr-Bool-Enum", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
106};
107
108typedef struct {
109 fr_value_box_t user; //!< Expansion of the sql_user_name
110 tmpl_t *check_query; //!< Tmpl to expand to form authorize_check_query
111 tmpl_t *reply_query; //!< Tmpl to expand to form authorize_reply_query
112 tmpl_t *membership_query; //!< Tmpl to expand to form group_membership_query
113 tmpl_t *group_check_query; //!< Tmpl to expand to form authorize_group_check_query
114 tmpl_t *group_reply_query; //!< Tmpl to expand to form authorize_group_reply_query
116
117static int logfile_call_env_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *cc,
118 call_env_ctx_t const *cec, call_env_parser_t const *rule);
119
120static int query_call_env_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *cc,
121 call_env_ctx_t const *cec, call_env_parser_t const *rule);
122
126
129 .env = (call_env_parser_t[]) {
131 .pair.escape = {
132 .box_escape = {
135 .always_escape = false,
136 },
138 },
139 .pair.literals_safe_for = (fr_value_box_safe_for_t)rad_filename_box_make_safe,
140 },
142 }
143};
144
146
147/** Status of the authorization process
148 */
149typedef enum {
150 SQL_AUTZ_CHECK = 0x12, //!< Running user `check` query
151 SQL_AUTZ_CHECK_RESUME = 0x13, //!< Completed user `check` query
152 SQL_AUTZ_REPLY = 0x14, //!< Running user `reply` query
153 SQL_AUTZ_REPLY_RESUME = 0x15, //!< Completed user `reply` query
154 SQL_AUTZ_GROUP_MEMB = 0x20, //!< Running group membership query
155 SQL_AUTZ_GROUP_MEMB_RESUME = 0x21, //!< Completed group membership query
156 SQL_AUTZ_GROUP_CHECK = 0x22, //!< Running group `check` query
157 SQL_AUTZ_GROUP_CHECK_RESUME = 0x23, //!< Completed group `check` query
158 SQL_AUTZ_GROUP_REPLY = 0x24, //!< Running group `reply` query
159 SQL_AUTZ_GROUP_REPLY_RESUME = 0x25, //!< Completed group `reply` query
160 SQL_AUTZ_PROFILE_START = 0x40, //!< Starting processing user profiles
161 SQL_AUTZ_PROFILE_CHECK = 0x42, //!< Running profile `check` query
162 SQL_AUTZ_PROFILE_CHECK_RESUME = 0x43, //!< Completed profile `check` query
163 SQL_AUTZ_PROFILE_REPLY = 0x44, //!< Running profile `reply` query
164 SQL_AUTZ_PROFILE_REPLY_RESUME = 0x45, //!< Completed profile `reply` query
166
167#define SQL_AUTZ_STAGE_GROUP 0x20
168#define SQL_AUTZ_STAGE_PROFILE 0x40
169
170/** Context for group membership query evaluation
171 */
172typedef struct {
173 rlm_sql_t const *inst; //!< Module instance.
174 fr_value_box_t *query; //!< Query string used for evaluating group membership.
175 fr_sql_query_t *query_ctx; //!< Query context.
176 rlm_sql_grouplist_t *groups; //!< List of groups retrieved.
177 int num_groups; //!< How many groups have been retrieved.
179
180/** Context for SQL authorization
181 */
182typedef struct {
183 rlm_sql_t const *inst; //!< Module instance.
184 request_t *request; //!< Request being processed.
185 rlm_rcode_t rcode; //!< Module return code.
186 trunk_t *trunk; //!< Trunk connection for current authorization.
187 sql_autz_call_env_t *call_env; //!< Call environment data.
188 map_list_t check_tmp; //!< List to store check items before processing.
189 map_list_t reply_tmp; //!< List to store reply items before processing.
190 sql_autz_status_t status; //!< Current status of the authorization.
191 fr_value_box_list_t query; //!< Where expanded query tmpls will be written.
192 bool user_found; //!< Has the user been found anywhere?
193 rlm_sql_grouplist_t *group; //!< Current group being processed.
194 fr_pair_t *sql_group; //!< Pair to update with group being processed.
195 fr_pair_t *profile; //!< Current profile being processed.
196 fr_sql_map_ctx_t *map_ctx; //!< Context used for retrieving attribute value pairs as a map list.
197 sql_group_ctx_t *group_ctx; //!< Context used for retrieving user group membership.
199
200typedef struct {
201 fr_value_box_t user; //!< Expansion of sql_user_name.
202 fr_value_box_t filename; //!< File name to write SQL logs to.
203 tmpl_t **query; //!< Array of tmpls for list of queries to run.
205
215
225
226/** Context for tracking redundant SQL query sets
227 */
228typedef struct {
229 rlm_sql_t const *inst; //!< Module instance.
230 request_t *request; //!< Request being processed.
231 trunk_t *trunk; //!< Trunk connection for queries.
232 sql_redundant_call_env_t *call_env; //!< Call environment data.
233 size_t query_no; //!< Current query number.
234 fr_value_box_list_t query; //!< Where expanded query tmpl will be written.
235 fr_value_box_t *query_vb; //!< Current query string.
236 fr_sql_query_t *query_ctx; //!< Query context for current query.
238
243
252
253int submodule_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
254{
255 rlm_sql_t *inst = talloc_get_type_abort(parent, rlm_sql_t);
257 int ret;
258
259 if (unlikely((ret = module_rlm_submodule_parse(ctx, out, parent, ci, rule)) < 0)) return ret;
260
261 mi = talloc_get_type_abort(*((void **)out), module_instance_t);
262 inst->driver = (rlm_sql_driver_t const *)mi->exported; /* Public symbol exported by the submodule */
263
264 return 0;
265}
266
267static int _sql_escape_uxtx_free(void *uctx)
268{
269 return talloc_free(uctx);
270}
271
272/*
273 * Create a thread local uctx which is used in SQL value box escaping
274 * so that an already reserved connection can be used.
275 */
276static void *sql_escape_uctx_alloc(UNUSED request_t *request, void const *uctx)
277{
278 static _Thread_local rlm_sql_escape_uctx_t *t_ctx;
279
280 if (unlikely(t_ctx == NULL)) {
282
283 MEM(ctx = talloc_zero(NULL, rlm_sql_escape_uctx_t));
285 }
286 t_ctx->sql = uctx;
287
288 return t_ctx;
289}
290
291/*
292 * Fall-Through checking function from rlm_files.c
293 */
294static sql_fall_through_t fall_through(map_list_t *maps)
295{
296 bool rcode;
297 map_t *map, *next;
298
299 for (map = map_list_head(maps);
300 map != NULL;
301 map = next) {
302 next = map_list_next(maps, map);
303
305
307 (void) map_list_remove(maps, map);
308
309 if (tmpl_is_data(map->rhs)) {
311
312 rcode = tmpl_value(map->rhs)->vb_bool;
313 } else {
314 rcode = false;
315 }
316
317 talloc_free(map);
318 return rcode;
319 }
320 }
321
323}
324
325/** Escape a tainted VB used as an xlat argument
326 *
327 */
328static int CC_HINT(nonnull(2,3)) sql_xlat_escape(request_t *request, fr_value_box_t *vb, void *uctx)
329{
330 void *arg = NULL;
331 rlm_sql_escape_uctx_t *ctx = uctx;
333 rlm_sql_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, rlm_sql_thread_t);
334
335 /*
336 * If it's already safe, don't do anything.
337 */
338 if (fr_value_box_is_safe_for(vb, inst->driver)) return 0;
339
340 /*
341 * Don't print "::" for enum names. Instead we convert
342 * the box to a string which contains the enum name, and
343 * then see if we need to escape it.
344 */
345 if (vb->enumv && vb->enumv->flags.has_value) {
346 char const *name;
347
348 name = fr_dict_enum_name_by_value(vb->enumv, vb);
349 if (name) {
350 int rcode;
351
352 /*
353 * Store list pointers to restore later - fr_value_box_cast clears them
354 */
355 fr_value_box_entry_t entry = vb->entry;
356
357 rcode = fr_value_box_strdup(vb, vb, NULL, name, false);
358 vb->entry = entry;
359
360 if (rcode < 0) return rcode;
361
362 goto check_escape_arg;
363 }
364 }
365
366 /*
367 * No need to escape types with inherently safe data
368 */
369 switch (vb->type) {
370 case FR_TYPE_NUMERIC:
371 case FR_TYPE_IP:
372 case FR_TYPE_ETHERNET:
373 fr_value_box_mark_safe_for(vb, inst->driver);
374 return 0;
375
376 default:
377 break;
378 }
379
380check_escape_arg:
381 if (inst->sql_escape_arg) {
382 arg = inst->sql_escape_arg;
383 } else if (thread->sql_escape_arg) {
384 arg = thread->sql_escape_arg;
385 }
386 if (!arg) {
387 error:
389 return -1;
390 }
391
392 /*
393 * The escape function works with the bytes already in the box
394 * (using vb_length, not strlen()) so binary data containing NUL
395 * bytes survives the escape. Cast non-string boxes to a string
396 * first - the cast preserves the underlying bytes.
397 */
398 if ((vb->type != FR_TYPE_STRING) && (fr_value_box_cast_in_place(vb, vb, FR_TYPE_STRING, NULL) < 0)) goto error;
399
400 if (inst->sql_escape_func(request, vb, arg) < 0) goto error;
401
402 /*
403 * Different databases have slightly different ideas as
404 * to what is safe. So we track the database type in the
405 * safe value. This means that we don't
406 * cross-contaminate "safe" values across databases.
407 */
408 fr_value_box_mark_safe_for(vb, inst->driver);
409
410 return 0;
411}
412
413static int sql_box_escape(fr_value_box_t *vb, void *uctx)
414{
415 return sql_xlat_escape(NULL, vb, uctx);
416}
417
418/** Escape a value to make it SQL safe.
419 *
420@verbatim
421%sql.escape(<value>)
422@endverbatim
423 *
424 * @ingroup xlat_functions
425 */
426static xlat_action_t sql_escape_xlat(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx,
427 request_t *request, fr_value_box_list_t *in)
428{
429 rlm_sql_t const *inst = talloc_get_type_abort(xctx->mctx->mi->data, rlm_sql_t);
430 fr_value_box_t *vb;
431 rlm_sql_escape_uctx_t *escape_uctx = NULL;
432
433 while ((vb = fr_value_box_list_pop_head(in))) {
434 if (fr_value_box_is_safe_for(vb, inst->driver)) goto append;
435 if (!escape_uctx) escape_uctx = sql_escape_uctx_alloc(request, inst);
436 if (sql_box_escape(vb, escape_uctx) < 0) {
437 talloc_free(vb);
438 return XLAT_ACTION_FAIL;
439 }
440 append:
442 }
443 return XLAT_ACTION_DONE;
444}
445
446static xlat_action_t sql_xlat_query_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx,
447 request_t *request, UNUSED fr_value_box_list_t *in)
448{
449 fr_sql_query_t *query_ctx = talloc_get_type_abort(xctx->rctx, fr_sql_query_t);
450 rlm_sql_t const *inst = query_ctx->inst;
451 fr_value_box_t *vb;
453 int numaffected;
454
455 fr_assert(query_ctx->type == SQL_QUERY_OTHER);
456
457 switch (query_ctx->rcode) {
459 case RLM_SQL_ERROR:
462 query_ctx->rcode, "<INVALID>"));
463 rlm_sql_print_error(inst, request, query_ctx, false);
464 ret = XLAT_ACTION_FAIL;
465 goto finish;
466
467 default:
468 break;
469 }
470
471 numaffected = (inst->driver->sql_affected_rows)(query_ctx, &inst->config);
472 if (numaffected < 1) {
473 RDEBUG2("SQL query affected no rows");
474 numaffected = 0;
475 }
476
477 MEM(vb = fr_value_box_alloc_null(ctx));
478 fr_value_box_uint32(vb, NULL, (uint32_t)numaffected, false);
480
481finish:
482 talloc_free(query_ctx);
483
484 return ret;
485}
486
487static xlat_action_t sql_xlat_select_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx,
488 request_t *request, UNUSED fr_value_box_list_t *in)
489{
490 fr_sql_query_t *query_ctx = talloc_get_type_abort(xctx->rctx, fr_sql_query_t);
491 rlm_sql_t const *inst = query_ctx->inst;
492 fr_value_box_t *vb;
494 unlang_result_t p_result;
495 rlm_sql_row_t row;
496 bool fetched = false;
497
498 fr_assert(query_ctx->type == SQL_QUERY_SELECT);
499
500 if (query_ctx->rcode != RLM_SQL_OK) {
501 query_error:
503 query_ctx->rcode, "<INVALID>"));
504 rlm_sql_print_error(inst, request, query_ctx, false);
505 ret = XLAT_ACTION_FAIL;
506 goto finish;
507 }
508
509 do {
510 inst->fetch_row(&p_result, request, query_ctx);
511 row = query_ctx->row;
512 switch (query_ctx->rcode) {
513 case RLM_SQL_OK:
514 if (row[0]) break;
515
516 RDEBUG2("NULL value in first column of result");
517 goto finish;
518
520 if (!fetched) RDEBUG2("SQL query returned no results");
521 goto finish;
522
523 default:
524 goto query_error;
525 }
526
527 fetched = true;
528
529 MEM(vb = fr_value_box_alloc_null(ctx));
530 fr_value_box_strdup(vb, vb, NULL, row[0], false);
532
533 } while (1);
534
535finish:
536 talloc_free(query_ctx);
537
538 return ret;
539}
540
541/** Execute an arbitrary SQL query
542 *
543 * For SELECTs, the values of the first column will be returned.
544 * For INSERTS, UPDATEs and DELETEs, the number of rows affected will
545 * be returned instead.
546 *
547@verbatim
548%sql(<sql statement>)
549@endverbatim
550 *
551 * @ingroup xlat_functions
552 */
553static xlat_action_t sql_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out,
554 xlat_ctx_t const *xctx,
555 request_t *request, fr_value_box_list_t *in)
556{
557 sql_xlat_call_env_t *call_env = talloc_get_type_abort(xctx->env_data, sql_xlat_call_env_t);
558 rlm_sql_t const *inst = talloc_get_type_abort(xctx->mctx->mi->data, rlm_sql_t);
559 rlm_sql_thread_t *thread = talloc_get_type_abort(xctx->mctx->thread, rlm_sql_thread_t);
560 char const *p;
561 fr_value_box_t *arg = fr_value_box_list_head(in);
562 fr_sql_query_t *query_ctx = NULL;
564
565 if (call_env->filename.type == FR_TYPE_STRING && call_env->filename.vb_length > 0) {
566 rlm_sql_query_log(inst, call_env->filename.vb_strvalue, arg->vb_strvalue);
567 }
568
569 p = arg->vb_strvalue;
570
571 /*
572 * Trim whitespace for the prefix check
573 */
575
576 /*
577 * If the query starts with any of the following prefixes,
578 * then return the number of rows affected
579 */
580 if ((strncasecmp(p, "insert", 6) == 0) ||
581 (strncasecmp(p, "update", 6) == 0) ||
582 (strncasecmp(p, "delete", 6) == 0)) {
583 MEM(query_ctx = fr_sql_query_alloc(unlang_interpret_frame_talloc_ctx(request), inst, request,
584 thread->trunk, arg->vb_strvalue, SQL_QUERY_OTHER));
585
586 unlang_xlat_yield(request, sql_xlat_query_resume, NULL, 0, query_ctx);
587
588 /* Modify current frame's rcode directly */
589 query_ret = inst->query(unlang_interpret_result(request), request, query_ctx);
591
592 return sql_xlat_query_resume(ctx, out, &(xlat_ctx_t){.rctx = query_ctx, .inst = inst}, request, in);
593 } /* else it's a SELECT statement */
594
595 MEM(query_ctx = fr_sql_query_alloc(unlang_interpret_frame_talloc_ctx(request), inst, request,
596 thread->trunk, arg->vb_strvalue, SQL_QUERY_SELECT));
597
598 unlang_xlat_yield(request, sql_xlat_select_resume, NULL, 0, query_ctx);
599
600 if (unlang_function_push_with_result(/* discard, sql_xlat_select_resume just uses query_ctx->rcode */ NULL,
601 request,
602 inst->select,
603 NULL,
604 NULL, 0,
607}
608
609/** Execute an arbitrary SQL query, expecting results to be returned
610 *
611@verbatim
612%sql.fetch(<sql statement>)
613@endverbatim
614 *
615 * @ingroup xlat_functions
616 */
618 request_t *request, fr_value_box_list_t *in)
619{
620 sql_xlat_call_env_t *call_env = talloc_get_type_abort(xctx->env_data, sql_xlat_call_env_t);
621 rlm_sql_t const *inst = talloc_get_type_abort(xctx->mctx->mi->data, rlm_sql_t);
622 rlm_sql_thread_t *thread = talloc_get_type_abort(xctx->mctx->thread, rlm_sql_thread_t);
623 fr_value_box_t *arg = fr_value_box_list_head(in);
624 fr_sql_query_t *query_ctx = NULL;
625
626 if (call_env->filename.type == FR_TYPE_STRING && call_env->filename.vb_length > 0) {
627 rlm_sql_query_log(inst, call_env->filename.vb_strvalue, arg->vb_strvalue);
628 }
629
630 MEM(query_ctx = fr_sql_query_alloc(unlang_interpret_frame_talloc_ctx(request), inst, request,
631 thread->trunk, arg->vb_strvalue, SQL_QUERY_SELECT));
632
633 unlang_xlat_yield(request, sql_xlat_select_resume, NULL, 0, query_ctx);
634 if (unlang_function_push_with_result(/* discard, sql_xlat_select_resume just uses query_ctx->rcode */NULL,
635 request,
636 inst->select,
637 NULL,
638 NULL, 0,
641}
642
643/** Execute an arbitrary SQL query, returning the number of rows affected
644 *
645@verbatim
646%sql.modify(<sql statement>)
647@endverbatim
648 *
649 * @ingroup xlat_functions
650 */
651static xlat_action_t sql_modify_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx,
652 request_t *request, fr_value_box_list_t *in)
653{
654 sql_xlat_call_env_t *call_env = talloc_get_type_abort(xctx->env_data, sql_xlat_call_env_t);
655 rlm_sql_t const *inst = talloc_get_type_abort(xctx->mctx->mi->data, rlm_sql_t);
656 rlm_sql_thread_t *thread = talloc_get_type_abort(xctx->mctx->thread, rlm_sql_thread_t);
657 fr_value_box_t *arg = fr_value_box_list_head(in);
658 fr_sql_query_t *query_ctx = NULL;
659
660 if (call_env->filename.type == FR_TYPE_STRING && call_env->filename.vb_length > 0) {
661 rlm_sql_query_log(inst, call_env->filename.vb_strvalue, arg->vb_strvalue);
662 }
663
664 MEM(query_ctx = fr_sql_query_alloc(unlang_interpret_frame_talloc_ctx(request), inst, request,
665 thread->trunk, arg->vb_strvalue, SQL_QUERY_OTHER));
666
667 unlang_xlat_yield(request, sql_xlat_query_resume, NULL, 0, query_ctx);
668 /* Write out the result directly to this frame's rcode */
669 if (inst->query(unlang_interpret_result(request), request, query_ctx) == UNLANG_ACTION_PUSHED_CHILD) return XLAT_ACTION_PUSH_UNLANG;
670
671 return sql_xlat_query_resume(ctx, out, &(xlat_ctx_t){.rctx = query_ctx, .inst = inst}, request, in);
672}
673
674/** Converts a string value into a #fr_pair_t
675 *
676 * @param[in,out] ctx to allocate #fr_pair_t (s).
677 * @param[out] out where to write the resulting #fr_pair_t.
678 * @param[in] request The current request.
679 * @param[in] map to process.
680 * @param[in] uctx The value to parse.
681 * @return
682 * - 0 on success.
683 * - -1 on failure.
684 */
685static int _sql_map_proc_get_value(TALLOC_CTX *ctx, fr_pair_list_t *out,
686 request_t *request, map_t const *map, void *uctx)
687{
688 fr_pair_t *vp;
689 char const *value = uctx;
690
692 if (!vp) return -1;
693
694 /*
695 * Buffer not always talloced, sometimes it's
696 * just a pointer to a field in a result struct.
697 */
698 if (fr_pair_value_from_str(vp, value, strlen(value), NULL, true) < 0) {
699 RPEDEBUG("Failed parsing value \"%pV\" for attribute %s",
702 return -1;
703 }
705
706 return 0;
707}
708
709/*
710 * Verify the result of the map.
711 */
712static int sql_map_verify(CONF_SECTION *cs, UNUSED void const *mod_inst, UNUSED void *proc_inst,
713 tmpl_t const *src, UNUSED map_list_t const *maps)
714{
715 if (!src) {
716 cf_log_err(cs, "Missing SQL query");
717
718 return -1;
719 }
720
721 return 0;
722}
723
724#define MAX_SQL_FIELD_INDEX (64)
725
726/** Process the results of an SQL map query
727 *
728 * @param p_result Result of map expansion:
729 * - #RLM_MODULE_NOOP no rows were returned or columns matched.
730 * - #RLM_MODULE_UPDATED if one or more #fr_pair_t were added to the #request_t.
731 * - #RLM_MODULE_FAIL if a fault occurred.
732 * @param mpctx Map context, containing the module instance.
733 * @param request The current request.
734 * @param query string to execute.
735 * @param maps Head of the map list.
736 * @return UNLANG_ACTION_CALCULATE_RESULT
737 */
738static unlang_action_t mod_map_resume(unlang_result_t *p_result, map_ctx_t const *mpctx, request_t *request,
739 UNUSED fr_value_box_list_t *query, map_list_t const *maps)
740{
741 fr_sql_query_t *query_ctx = talloc_get_type_abort(mpctx->rctx, fr_sql_query_t);
742 rlm_sql_t const *inst = mpctx->moi;
743 map_t const *map;
745 sql_rcode_t ret;
746 char const **fields = NULL, *map_rhs;
747 rlm_sql_row_t row;
748 int i, j, field_cnt, rows = 0;
749 int field_index[MAX_SQL_FIELD_INDEX];
750 char map_rhs_buff[128];
751 bool found_field = false; /* Did we find any matching fields in the result set ? */
752
753 if (query_ctx->rcode != RLM_SQL_OK) {
754 RERROR("SQL query failed: %s", fr_table_str_by_value(sql_rcode_description_table, query_ctx->rcode, "<INVALID>"));
755 rcode = RLM_MODULE_FAIL;
756 goto finish;
757 }
758
759 /*
760 * Not every driver provides an sql_num_rows function
761 */
762 if (inst->driver->sql_num_rows) {
763 ret = inst->driver->sql_num_rows(query_ctx, &inst->config);
764 if (ret == 0) {
765 RDEBUG2("Server returned an empty result");
766 rcode = RLM_MODULE_NOTFOUND;
767 goto finish;
768 }
769
770 if (ret < 0) {
771 RERROR("Failed retrieving row count");
772 error:
773 rcode = RLM_MODULE_FAIL;
774 goto finish;
775 }
776 }
777
778 for (i = 0; i < MAX_SQL_FIELD_INDEX; i++) field_index[i] = -1;
779
780 /*
781 * Map proc only registered if driver provides an sql_fields function
782 */
783 ret = (inst->driver->sql_fields)(&fields, query_ctx, &inst->config);
784 if (ret != RLM_SQL_OK) {
785 RERROR("Failed retrieving field names: %s", fr_table_str_by_value(sql_rcode_description_table, ret, "<INVALID>"));
786 goto error;
787 }
788 fr_assert(fields);
789 field_cnt = talloc_array_length(fields);
790
791 if (RDEBUG_ENABLED3) for (j = 0; j < field_cnt; j++) RDEBUG3("Got field: %s", fields[j]);
792
793 /*
794 * Iterate over the maps, it's O(N2)ish but probably
795 * faster than building a radix tree each time the
796 * map set is evaluated (map->rhs can be dynamic).
797 */
798 for (map = map_list_head(maps), i = 0;
799 map && (i < MAX_SQL_FIELD_INDEX);
800 map = map_list_next(maps, map), i++) {
801 /*
802 * Expand the RHS to get the name of the SQL field
803 */
804 if (tmpl_expand(&map_rhs, map_rhs_buff, sizeof(map_rhs_buff),
805 request, map->rhs) < 0) {
806 RPERROR("Failed getting field name");
807 goto error;
808 }
809
810 for (j = 0; j < field_cnt; j++) {
811 if (strcasecmp(fields[j], map_rhs) != 0) continue;
812 field_index[i] = j;
813 found_field = true;
814 }
815 }
816
817 /*
818 * Couldn't resolve any map RHS values to fields
819 * in the result set.
820 */
821 if (!found_field) {
822 RDEBUG2("No fields matching map found in query result");
823 rcode = RLM_MODULE_NOOP;
824 goto finish;
825 }
826
827 /*
828 * We've resolved all the maps to result indexes, now convert
829 * the values at those indexes into fr_pair_ts.
830 *
831 * Note: Not all SQL client libraries provide a row count,
832 * so we have to do the count here.
833 */
834 while ((inst->fetch_row(p_result, request, query_ctx) == UNLANG_ACTION_CALCULATE_RESULT) &&
835 (query_ctx->rcode == RLM_SQL_OK)) {
836 row = query_ctx->row;
837 rows++;
838 for (map = map_list_head(maps), j = 0;
839 map && (j < MAX_SQL_FIELD_INDEX);
840 map = map_list_next(maps, map), j++) {
841 if (field_index[j] < 0) continue; /* We didn't find the map RHS in the field set */
842 if (!row[field_index[j]]) {
843 RDEBUG2("Database returned NULL for %s", fields[j]);
844 continue;
845 }
846 if (map_to_request(request, map, _sql_map_proc_get_value, row[field_index[j]]) < 0) goto error;
847 }
848 }
849
850 if (query_ctx->rcode == RLM_SQL_ERROR) goto error;
851
852 if (rows == 0) {
853 RDEBUG2("SQL query returned no results");
854 rcode = RLM_MODULE_NOTFOUND;
855 }
856
857finish:
858 talloc_free(fields);
859 talloc_free(query_ctx);
860
861 RETURN_UNLANG_RCODE(rcode);
862}
863
864/** Executes a SELECT query and maps the result to server attributes
865 *
866 * @param p_result Result of map expansion:
867 * - #RLM_MODULE_NOOP no rows were returned or columns matched.
868 * - #RLM_MODULE_UPDATED if one or more #fr_pair_t were added to the #request_t.
869 * - #RLM_MODULE_FAIL if a fault occurred.
870 * @param mpctx Map context, containing the module instance.
871 * @param request The current request.
872 * @param query string to execute.
873 * @param maps Head of the map list.
874 * @return UNLANG_ACTION_CALCULATE_RESULT
875 */
876static unlang_action_t mod_map_proc(unlang_result_t *p_result, map_ctx_t const *mpctx, request_t *request,
877 fr_value_box_list_t *query, UNUSED map_list_t const *maps)
878{
880 rlm_sql_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, rlm_sql_thread_t);
881 fr_value_box_t *query_head = fr_value_box_list_head(query);
882 fr_sql_query_t *query_ctx = NULL;
883 fr_value_box_t *vb = NULL;
884 rlm_sql_escape_uctx_t *escape_uctx = NULL;
885
886 fr_assert(inst->driver->sql_fields); /* Should have been caught during validation... */
887
888 if (!query_head) {
889 REDEBUG("Query cannot be (null)");
891 }
892
893 while ((vb = fr_value_box_list_next(query, vb))) {
894 if (fr_value_box_is_safe_for(vb, inst->driver)) continue;
895 if (!escape_uctx) escape_uctx = sql_escape_uctx_alloc(request, inst);
896 if (sql_box_escape(vb, escape_uctx) < 0) RETURN_UNLANG_FAIL;
897 }
898
900 query_head, query, FR_TYPE_STRING,
902 SIZE_MAX) < 0) {
903 RPEDEBUG("Failed concatenating input string");
905 }
906
907 query_ctx = fr_sql_query_alloc(unlang_interpret_frame_talloc_ctx(request), inst, request,
908 thread->trunk, query_head->vb_strvalue, SQL_QUERY_SELECT);
909
910 if (unlang_map_yield(request, mod_map_resume, NULL, 0, query_ctx) != UNLANG_ACTION_YIELD) RETURN_UNLANG_FAIL;
911 return unlang_function_push_with_result(/* discard, mod_map_resume just uses query_ctx->rcode */ NULL,
912 request,
913 inst->select,
914 NULL,
915 NULL,
917 query_ctx);
918}
919
920/** Default escape function for drivers which do not provide their own
921 *
922 * Multi-byte UTF-8 characters pass through unchanged, `\n` / `\r` / `\t` become
923 * their backslash-escaped equivalents, and anything else outside
924 * `allowed_chars` is replaced with `=XX` (mime-style hex).
925 */
926static int sql_escape_func(UNUSED request_t *request, fr_value_box_t *vb, void *arg)
927{
929 char const *in = vb->vb_strvalue;
930 char const *end = in + vb->vb_length;
931 char *out, *p;
932 size_t outlen = vb->vb_length * 3 + 1;
933 size_t len = 0;
934
935 /*
936 * Worst case: every input byte expands to `=XX` (3 chars), plus a NUL.
937 */
938 MEM(p = out = talloc_array(vb, char, outlen));
939
940 while (in < end) {
941 size_t utf8_len;
942
943 /*
944 * Allow all multi-byte UTF8 characters.
945 */
946 utf8_len = fr_utf8_char((uint8_t const *) in, end - in);
947 if (utf8_len > 1) {
948 memcpy(p, in, utf8_len);
949 in += utf8_len;
950 p += utf8_len;
951 len += utf8_len;
952 continue;
953 }
954
955 /*
956 * Because we register our own escape function
957 * we're now responsible for escaping all special
958 * chars in an xlat expansion or attribute value.
959 */
960 switch (*in) {
961 case '\n':
962 p[0] = '\\';
963 p[1] = 'n';
964 goto next;
965
966 case '\r':
967 p[0] = '\\';
968 p[1] = 'r';
969 goto next;
970
971 case '\t':
972 p[0] = '\\';
973 p[1] = 't';
974
975 next:
976 in++;
977 p += 2;
978 len += 2;
979 continue;
980 }
981
982 /*
983 * Non-printable characters (including embedded NULs) get
984 * replaced with their mime-encoded equivalents.
985 */
986 if (((unsigned char)*in < 32) ||
987 strchr(inst->config.allowed_chars, *in) == NULL) {
988 snprintf(p, 4, "=%02X", (unsigned char) in[0]);
989 in++;
990 p += 3;
991 len += 3;
992 continue;
993 }
994
995 /*
996 * Allowed character.
997 */
998 *p++ = *in++;
999 len++;
1000 }
1001 *p = '\0';
1002
1003 /*
1004 * Shrink the buffer to fit the actual escaped length, then
1005 * hand it to the box.
1006 */
1007 if (len + 1 < outlen) MEM(out = talloc_realloc(vb, out, char, len + 1));
1009
1010 return 0;
1011}
1012
1013/*
1014 * Set the SQL user name.
1015 *
1016 * We don't call the escape function here. The resulting string
1017 * will be escaped later in the queries xlat so we don't need to
1018 * escape it twice. (it will make things wrong if we have an
1019 * escape candidate character in the username)
1020 */
1021static void sql_set_user(rlm_sql_t const *inst, request_t *request, fr_value_box_t *user)
1022{
1023 fr_pair_t *vp = NULL;
1024
1025 fr_assert(request->packet != NULL);
1026
1027 MEM(pair_update_request(&vp, inst->sql_user) >= 0);
1028 if(!user || (user->type != FR_TYPE_STRING)) {
1030 return;
1031 }
1032
1033 /*
1034 * Replace any existing SQL-User-Name with new value
1035 */
1036 fr_pair_value_bstrdup_buffer(vp, user->vb_strvalue, user->tainted);
1037 RDEBUG2("SQL-User-Name set to '%pV'", &vp->data);
1038}
1039
1040/*
1041 * Do a set/unset user, so it's a bit clearer what's going on.
1042 */
1043#define sql_unset_user(_i, _r) fr_pair_delete_by_da(&_r->request_pairs, _i->sql_user)
1044
1045
1050
1052{
1053 sql_group_ctx_t *group_ctx = talloc_get_type_abort(uctx, sql_group_ctx_t);
1054 fr_sql_query_t *query_ctx = group_ctx->query_ctx;
1055 rlm_sql_t const *inst = group_ctx->inst;
1056 rlm_sql_row_t row;
1057 rlm_sql_grouplist_t *entry = group_ctx->groups;
1058
1059 if (query_ctx->rcode != RLM_SQL_OK) {
1060 error:
1061 rlm_sql_print_error(inst, request, query_ctx, false);
1062 talloc_free(query_ctx);
1064 }
1065
1066 while ((inst->fetch_row(p_result, request, query_ctx) == UNLANG_ACTION_CALCULATE_RESULT) &&
1067 (query_ctx->rcode == RLM_SQL_OK)) {
1068 row = query_ctx->row;
1069 if (!row[0]){
1070 RDEBUG2("row[0] returned NULL");
1071 goto error;
1072 }
1073
1074 if (!entry) {
1075 group_ctx->groups = talloc_zero(group_ctx, rlm_sql_grouplist_t);
1076 entry = group_ctx->groups;
1077 } else {
1078 entry->next = talloc_zero(group_ctx, rlm_sql_grouplist_t);
1079 entry = entry->next;
1080 }
1081 entry->next = NULL;
1082 entry->name = talloc_strdup(entry, row[0]);
1083
1084 group_ctx->num_groups++;
1085 }
1086
1087 talloc_free(query_ctx);
1089}
1090
1092{
1093 rlm_sql_t const *inst = group_ctx->inst;
1094
1095 /* NOTE: sql_set_user should have been run before calling this function */
1096
1097 if (!group_ctx->query || (group_ctx->query->vb_length == 0)) return UNLANG_ACTION_CALCULATE_RESULT;
1098
1099 MEM(group_ctx->query_ctx = fr_sql_query_alloc(group_ctx, inst, request, trunk,
1100 group_ctx->query->vb_strvalue, SQL_QUERY_SELECT));
1101
1102 if (unlang_function_push_with_result(/* sql_get_grouplist_resume translates the query_ctx->rocde into a module rcode */p_result,
1103 request,
1104 NULL,
1106 NULL,
1108 group_ctx) < 0) return UNLANG_ACTION_FAIL;
1109
1110 return unlang_function_push_with_result(/* discard, sql_get_grouplist_resume translates rcodes */NULL,
1111 request,
1112 inst->select,
1113 NULL,
1114 NULL, 0,
1115 UNLANG_SUB_FRAME, group_ctx->query_ctx);
1116}
1117
1118typedef struct {
1119 fr_value_box_list_t query;
1122
1123/** Compare list of groups returned from SQL query to xlat argument.
1124 *
1125 * Called after the SQL query has completed and group list has been built.
1126 */
1128 UNUSED request_t *request, fr_value_box_list_t *in)
1129{
1130 sql_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(xctx->rctx, sql_group_xlat_ctx_t);
1131 sql_group_ctx_t *group_ctx = talloc_get_type_abort(xlat_ctx->group_ctx, sql_group_ctx_t);
1132 fr_value_box_t *arg = fr_value_box_list_head(in);
1133 char const *name = arg->vb_strvalue;
1134 fr_value_box_t *vb;
1135 rlm_sql_grouplist_t *entry;
1136
1138
1140 for (entry = group_ctx->groups; entry != NULL; entry = entry->next) {
1141 if (strcmp(entry->name, name) == 0) {
1142 vb->vb_bool = true;
1143 break;
1144 }
1145 }
1147
1149
1150 return XLAT_ACTION_DONE;
1151}
1152
1153/** Run SQL query for group membership to return list of groups
1154 *
1155 * Called after group membership query tmpl is expanded
1156 */
1158 request_t *request, UNUSED fr_value_box_list_t *in)
1159{
1160 sql_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(xctx->rctx, sql_group_xlat_ctx_t);
1161 rlm_sql_t const *inst = talloc_get_type_abort(xctx->mctx->mi->data, rlm_sql_t);
1162 rlm_sql_thread_t *thread = talloc_get_type_abort(xctx->mctx->thread, rlm_sql_thread_t);
1163 fr_value_box_t *query;
1164
1165 query = fr_value_box_list_head(&xlat_ctx->query);
1166 if (!query) return XLAT_ACTION_FAIL;
1167
1168 MEM(xlat_ctx->group_ctx = talloc(xlat_ctx, sql_group_ctx_t));
1169
1170 *xlat_ctx->group_ctx = (sql_group_ctx_t) {
1171 .inst = inst,
1172 .query = query,
1173 };
1174
1176
1177 if (sql_get_grouplist(NULL, xlat_ctx->group_ctx, thread->trunk, request) != UNLANG_ACTION_PUSHED_CHILD) {
1178 return XLAT_ACTION_FAIL;
1179 }
1180
1182}
1183
1184
1185/** Check if the user is a member of a particular group
1186 *
1187@verbatim
1188%sql.group(<name>)
1189@endverbatim
1190 *
1191 * @ingroup xlat_functions
1192 */
1194 request_t *request, UNUSED fr_value_box_list_t *in)
1195{
1196 sql_group_xlat_call_env_t *call_env = talloc_get_type_abort(xctx->env_data, sql_group_xlat_call_env_t);
1198 rlm_sql_t const *inst = talloc_get_type_abort(xctx->mctx->mi->data, rlm_sql_t);
1199
1200 if (!call_env->membership_query) {
1201 RWARN("Cannot check group membership - group_membership_query not set");
1202 return XLAT_ACTION_FAIL;
1203 }
1204
1205 /*
1206 * Set the user attr here
1207 */
1208 sql_set_user(inst, request, &call_env->user);
1209
1211 fr_value_box_list_init(&xlat_ctx->query);
1212
1214 if (unlang_tmpl_push(xlat_ctx, NULL, &xlat_ctx->query, request, call_env->membership_query, NULL, UNLANG_SUB_FRAME) < 0) return XLAT_ACTION_FAIL;
1216}
1217
1218/** Process a "check" map
1219 *
1220 * Any entries using an assignment operator will be moved to the reply map
1221 * for later merging into the request.
1222 *
1223 * @param request Current request.
1224 * @param check_map to process.
1225 * @param reply_map where any assignment entries will be moved.
1226 * @return
1227 * - 0 if all the check entries pass.
1228 * - -1 if the checks fail.
1229 */
1230static int check_map_process(request_t *request, map_list_t *check_map, map_list_t *reply_map)
1231{
1232 map_t *map, *next;
1233
1234 for (map = map_list_head(check_map);
1235 map != NULL;
1236 map = next) {
1237 next = map_list_next(check_map, map);
1238
1239 if (fr_assignment_op[map->op]) {
1240 (void) map_list_remove(check_map, map);
1241 map_list_insert_tail(reply_map, map);
1242 continue;
1243 }
1244
1245 if (!fr_comparison_op[map->op]) {
1246 REDEBUG("Invalid operator '%s'", fr_tokens[map->op]);
1247 goto fail;
1248 }
1249
1250 if (fr_type_is_structural(tmpl_attr_tail_da(map->lhs)->type) &&
1251 (map->op != T_OP_CMP_TRUE) && (map->op != T_OP_CMP_FALSE)) {
1252 REDEBUG("Invalid comparison for structural type");
1253 goto fail;
1254 }
1255
1256 RDEBUG2(" &%s %s %s", map->lhs->name, fr_tokens[map->op], map->rhs->name);
1257 if (radius_legacy_map_cmp(request, map) != 1) {
1258 fail:
1259 map_list_talloc_free(check_map);
1260 map_list_talloc_free(reply_map);
1261 RDEBUG2("failed match: skipping this entry");
1262 return -1;
1263 }
1264 }
1265 return 0;
1266}
1267
1269{
1270 if (!to_free->inst->sql_escape_arg) (void) request_data_get(to_free->request, (void *)sql_escape_uctx_alloc, 0);
1271 map_list_talloc_free(&to_free->check_tmp);
1272 map_list_talloc_free(&to_free->reply_tmp);
1273 sql_unset_user(to_free->inst, to_free->request);
1274
1275 return 0;
1276}
1277
1278/** Resume function called after authorization group / profile expansion of check / reply query tmpl
1279 *
1280 * Groups and profiles are treated almost identically except:
1281 * - groups are read from an SQL query
1282 * - profiles are read from &control.User-Profile
1283 * - if `cache_groups` is set, groups populate &control.SQL-Group
1284 *
1285 * Profiles are handled after groups, and will not happend if the last group resulted in `Fall-Through = no`
1286 *
1287 * Before each query is run, &request.SQL-Group is populated with the value of the group being evaluated.
1288 *
1289 * @param p_result Result of current authorization.
1290 * @param mctx Current request.
1291 * @param request Current authorization context.
1292 * @return one of the RLM_MODULE_* values.
1293 */
1295{
1296 sql_autz_ctx_t *autz_ctx = talloc_get_type_abort(mctx->rctx, sql_autz_ctx_t);
1297 sql_autz_call_env_t *call_env = autz_ctx->call_env;
1298 sql_group_ctx_t *group_ctx = autz_ctx->group_ctx;
1299 fr_sql_map_ctx_t *map_ctx = autz_ctx->map_ctx;
1300 rlm_sql_t const *inst = autz_ctx->inst;
1301 fr_value_box_t *query = fr_value_box_list_pop_head(&autz_ctx->query);
1302 sql_fall_through_t do_fall_through = FALL_THROUGH_DEFAULT;
1303 fr_pair_t *vp;
1304
1305 switch (p_result->rcode) {
1308
1309 default:
1310 break;
1311 }
1312
1313 switch(autz_ctx->status) {
1315 if (!query) RETURN_UNLANG_FAIL;
1317 MEM(autz_ctx->group_ctx = talloc(autz_ctx, sql_group_ctx_t));
1318 *autz_ctx->group_ctx = (sql_group_ctx_t) {
1319 .inst = inst,
1320 .query = query,
1321 };
1322
1323 if (sql_get_grouplist(p_result, autz_ctx->group_ctx, autz_ctx->trunk, request) == UNLANG_ACTION_PUSHED_CHILD) {
1326 }
1327
1328 group_ctx = autz_ctx->group_ctx;
1329
1331
1333 talloc_free(group_ctx->query);
1334
1335 if (group_ctx->num_groups == 0) {
1336 RDEBUG2("User not found in any groups");
1337 break;
1338 }
1339 fr_assert(group_ctx->groups);
1340
1341 RDEBUG2("User found in the group table");
1342 autz_ctx->user_found = true;
1343 autz_ctx->group = group_ctx->groups;
1344 MEM(pair_update_request(&autz_ctx->sql_group, inst->group_da) >= 0);
1345
1346 next_group:
1347 fr_pair_value_strdup(autz_ctx->sql_group, autz_ctx->group->name, true);
1348 autz_ctx->status = SQL_AUTZ_GROUP_CHECK;
1350
1352 next_profile:
1353 if (autz_ctx->status & SQL_AUTZ_STAGE_PROFILE) {
1354 fr_pair_value_strdup(autz_ctx->sql_group, autz_ctx->profile->vp_strvalue, true);
1355 autz_ctx->status = SQL_AUTZ_PROFILE_CHECK;
1356 }
1357 RDEBUG3("Processing %s %pV",
1358 autz_ctx->status & SQL_AUTZ_STAGE_GROUP ? "group" : "profile", &autz_ctx->sql_group->data);
1359 if (inst->config.cache_groups && autz_ctx->status & SQL_AUTZ_STAGE_GROUP) {
1360 MEM(pair_append_control(&vp, inst->group_da) >= 0);
1361 fr_pair_value_strdup(vp, autz_ctx->group->name, true);
1362 }
1363
1364 if (call_env->group_check_query) {
1366 if (unlang_tmpl_push(autz_ctx, NULL, &autz_ctx->query, request,
1369 }
1370
1371 if (call_env->group_reply_query) goto group_reply_push;
1372
1373 break;
1374
1377 if (!query) RETURN_UNLANG_FAIL;
1378 *autz_ctx->map_ctx = (fr_sql_map_ctx_t) {
1379 .ctx = autz_ctx,
1380 .inst = inst,
1381 .out = &autz_ctx->check_tmp,
1382 .list = request_attr_request,
1383 .query = query,
1384 };
1385
1387 if (sql_get_map_list(p_result, request, map_ctx, autz_ctx->trunk) == UNLANG_ACTION_PUSHED_CHILD) {
1390 }
1391
1393
1396 talloc_free(map_ctx->query);
1397
1398 /*
1399 * If we got check rows we need to process them before we decide to
1400 * process the reply rows
1401 */
1402 if (map_ctx->rows > 0) {
1403 if (check_map_process(request, &autz_ctx->check_tmp, &autz_ctx->reply_tmp) < 0) {
1404 map_list_talloc_free(&autz_ctx->check_tmp);
1405 goto next_group_find;
1406 }
1407 RDEBUG2("%s \"%pV\": Conditional check items matched",
1408 autz_ctx->status & SQL_AUTZ_STAGE_GROUP ? "Group" : "Profile", &autz_ctx->sql_group->data);
1409 } else {
1410 RDEBUG2("%s \"%pV\": Conditional check items matched (empty)",
1411 autz_ctx->status & SQL_AUTZ_STAGE_GROUP ? "Group" : "Profile", &autz_ctx->sql_group->data);
1412 }
1413
1414 if (autz_ctx->rcode == RLM_MODULE_NOOP) autz_ctx->rcode = RLM_MODULE_OK;
1415
1416 map_list_talloc_free(&autz_ctx->check_tmp);
1417
1418 if (call_env->group_reply_query) {
1419 group_reply_push:
1421 if (unlang_tmpl_push(autz_ctx, NULL, &autz_ctx->query, request,
1425 }
1426
1427 if (map_list_num_elements(&autz_ctx->reply_tmp)) goto group_attr_cache;
1428
1429 goto next_group_find;
1430
1433 if (!query) RETURN_UNLANG_FAIL;
1434 *autz_ctx->map_ctx = (fr_sql_map_ctx_t) {
1435 .ctx = autz_ctx,
1436 .inst = inst,
1437 .out = &autz_ctx->reply_tmp,
1438 .list = request_attr_reply,
1439 .query = query,
1440 .expand_rhs = true,
1441 };
1442
1444 if (sql_get_map_list(p_result, request, map_ctx, autz_ctx->trunk) == UNLANG_ACTION_PUSHED_CHILD) {
1447 }
1448
1450
1453 talloc_free(map_ctx->query);
1454
1455 if (map_ctx->rows == 0) {
1456 do_fall_through = FALL_THROUGH_DEFAULT;
1457 goto group_attr_cache;
1458 }
1459
1460 fr_assert(!map_list_empty(&autz_ctx->reply_tmp)); /* coverity, among others */
1461 do_fall_through = fall_through(&autz_ctx->reply_tmp);
1462
1463 group_attr_cache:
1464 if (inst->config.cache_groups && autz_ctx->status & SQL_AUTZ_STAGE_GROUP) {
1465 MEM(pair_append_control(&vp, inst->group_da) >= 0);
1466 fr_pair_value_strdup(vp, autz_ctx->group->name, true);
1467 }
1468
1469 if (map_list_num_elements(&autz_ctx->reply_tmp) == 0) goto next_group_find;
1470 RDEBUG2("%s \"%pV\": Merging control and reply items",
1471 autz_ctx->status & SQL_AUTZ_STAGE_GROUP ? "Group" : "Profile", &autz_ctx->sql_group->data);
1472 autz_ctx->rcode = RLM_MODULE_UPDATED;
1473
1474 RINDENT();
1475 if (radius_legacy_map_list_apply(request, &autz_ctx->reply_tmp, NULL) < 0) {
1476 RPEDEBUG("Failed applying reply item");
1477 REXDENT();
1479 }
1480 REXDENT();
1481 map_list_talloc_free(&autz_ctx->reply_tmp);
1482
1483 next_group_find:
1484 if (do_fall_through != FALL_THROUGH_YES) break;
1485 if (autz_ctx->status & SQL_AUTZ_STAGE_PROFILE) {
1486 autz_ctx->profile = fr_pair_find_by_da(&request->control_pairs, autz_ctx->profile, attr_user_profile);
1487 if (autz_ctx->profile) goto next_profile;
1488 break;
1489 }
1490 autz_ctx->group = autz_ctx->group->next;
1491 if (autz_ctx->group) goto next_group;
1492
1493 break;
1494
1495 default:
1496 fr_assert(0);
1497 }
1498
1499 /*
1500 * If group processing has completed, check to see if profile processing should be done
1501 */
1502 if ((autz_ctx->status & SQL_AUTZ_STAGE_GROUP) &&
1503 ((do_fall_through == FALL_THROUGH_YES) ||
1504 (inst->config.read_profiles && (do_fall_through == FALL_THROUGH_DEFAULT)))) {
1505 RDEBUG3("... falling-through to profile processing");
1506
1507 autz_ctx->profile = fr_pair_find_by_da(&request->control_pairs, NULL, attr_user_profile);
1508 if (autz_ctx->profile) {
1509 MEM(pair_update_request(&autz_ctx->sql_group, inst->group_da) >= 0);
1510 autz_ctx->status = SQL_AUTZ_PROFILE_START;
1511 goto next_profile;
1512 }
1513 }
1514
1515 if (!autz_ctx->user_found) RETURN_UNLANG_NOTFOUND;
1516
1517 RETURN_UNLANG_RCODE(autz_ctx->rcode);
1518}
1519
1520/** Resume function called after authorization check / reply tmpl expansion
1521 *
1522 * @param p_result Result of current authorization.
1523 * @param mctx Module call ctx.
1524 * @param request Current request.
1525 * @return one of the RLM_MODULE_* values.
1526 */
1528{
1529 sql_autz_ctx_t *autz_ctx = talloc_get_type_abort(mctx->rctx, sql_autz_ctx_t);
1530 sql_autz_call_env_t *call_env = autz_ctx->call_env;
1531 rlm_sql_t const *inst = autz_ctx->inst;
1532 fr_value_box_t *query = fr_value_box_list_pop_head(&autz_ctx->query);
1533 sql_fall_through_t do_fall_through = FALL_THROUGH_DEFAULT;
1534 fr_sql_map_ctx_t *map_ctx = autz_ctx->map_ctx;
1535
1536 /*
1537 * If a previous async call returned one of the "failure" results just return.
1538 */
1539 switch (p_result->rcode) {
1542
1543 default:
1544 break;
1545 }
1546
1547 switch(autz_ctx->status) {
1548 case SQL_AUTZ_CHECK:
1549 if (!query) RETURN_UNLANG_FAIL;
1550 *autz_ctx->map_ctx = (fr_sql_map_ctx_t) {
1551 .ctx = autz_ctx,
1552 .inst = inst,
1553 .out = &autz_ctx->check_tmp,
1554 .list = request_attr_request,
1555 .query = query,
1556 };
1557
1559 if (sql_get_map_list(p_result, request, map_ctx, autz_ctx->trunk) == UNLANG_ACTION_PUSHED_CHILD){
1560 autz_ctx->status = SQL_AUTZ_CHECK_RESUME;
1562 }
1563
1565
1567 talloc_free(map_ctx->query);
1568
1569 if (map_ctx->rows == 0) goto skip_reply; /* Don't need to handle map entries we don't have */
1570
1571 /*
1572 * Only do this if *some* check pairs were returned
1573 */
1574 RDEBUG2("User found in radcheck table");
1575 autz_ctx->user_found = true;
1576
1577 if (check_map_process(request, &autz_ctx->check_tmp, &autz_ctx->reply_tmp) < 0) goto skip_reply;
1578 RDEBUG2("Conditional check items matched");
1579
1580 autz_ctx->rcode = RLM_MODULE_OK;
1581 map_list_talloc_free(&autz_ctx->check_tmp);
1582
1583 if (!call_env->reply_query) goto skip_reply;
1584
1586 if (unlang_tmpl_push(autz_ctx, NULL, &autz_ctx->query, request, call_env->reply_query, NULL, UNLANG_SUB_FRAME) < 0) RETURN_UNLANG_FAIL;
1587 autz_ctx->status = SQL_AUTZ_REPLY;
1589
1590 case SQL_AUTZ_REPLY:
1591 if (!query) RETURN_UNLANG_FAIL;
1592 *autz_ctx->map_ctx = (fr_sql_map_ctx_t) {
1593 .ctx = autz_ctx,
1594 .inst = inst,
1595 .out = &autz_ctx->reply_tmp,
1596 .list = request_attr_reply,
1597 .query = query,
1598 .expand_rhs = true,
1599 };
1600
1602 if (sql_get_map_list(p_result, request, map_ctx, autz_ctx->trunk) == UNLANG_ACTION_PUSHED_CHILD){
1603 autz_ctx->status = SQL_AUTZ_REPLY_RESUME;
1605 }
1606
1608
1610 talloc_free(map_ctx->query);
1611
1612 if (map_ctx->rows == 0) goto skip_reply;
1613
1614 do_fall_through = fall_through(&autz_ctx->reply_tmp);
1615
1616 RDEBUG2("User found in radreply table");
1617 autz_ctx->user_found = true;
1618
1619 skip_reply:
1620 if (map_list_num_elements(&autz_ctx->reply_tmp)) {
1621 RDEBUG2("Merging control and reply items");
1622 RINDENT();
1623 if (radius_legacy_map_list_apply(request, &autz_ctx->reply_tmp, NULL) < 0) {
1624 RPEDEBUG("Failed applying item");
1625 REXDENT();
1627 }
1628 REXDENT();
1629
1630 autz_ctx->rcode = RLM_MODULE_UPDATED;
1631 map_list_talloc_free(&autz_ctx->reply_tmp);
1632 }
1633
1634 if ((do_fall_through == FALL_THROUGH_YES) ||
1635 (inst->config.read_groups && (do_fall_through == FALL_THROUGH_DEFAULT))) {
1636 RDEBUG3("... falling-through to group processing");
1637
1638 if (!call_env->membership_query) {
1639 RWARN("Cannot check groups when group_membership_query is not set");
1640 break;
1641 }
1642
1643 if (!call_env->group_check_query && !call_env->group_reply_query) {
1644 RWARN("Cannot process groups when neither authorize_group_check_query nor authorize_group_reply_query are set");
1645 break;
1646 }
1647
1649 if (unlang_tmpl_push(autz_ctx, NULL, &autz_ctx->query, request,
1651 autz_ctx->status = SQL_AUTZ_GROUP_MEMB;
1653 }
1654
1655 if ((do_fall_through == FALL_THROUGH_YES) ||
1656 (inst->config.read_profiles && (do_fall_through == FALL_THROUGH_DEFAULT))) {
1657 RDEBUG3("... falling-through to profile processing");
1658
1659 if (!call_env->group_check_query && !call_env->group_reply_query) {
1660 RWARN("Cannot process profiles when neither authorize_group_check_query nor authorize_group_reply_query are set");
1661 break;
1662 }
1663
1664 autz_ctx->profile = fr_pair_find_by_da(&request->control_pairs, NULL, attr_user_profile);
1665 if (!autz_ctx->profile) break;
1666
1667 MEM(pair_update_request(&autz_ctx->sql_group, inst->group_da) >= 0);
1668 autz_ctx->status = SQL_AUTZ_PROFILE_START;
1669 return mod_autz_group_resume(p_result, mctx, request);
1670 }
1671 break;
1672
1673 default:
1674 fr_assert_msg(0, "Invalid status %d in mod_authorize_resume", autz_ctx->status);
1675 }
1676
1677 if (!autz_ctx->user_found) RETURN_UNLANG_NOTFOUND;
1678 RETURN_UNLANG_RCODE(autz_ctx->rcode);
1679}
1680
1681/** Start of module authorize method
1682 *
1683 * Pushes the tmpl relating to the first required query for evaluation
1684 */
1685static unlang_action_t CC_HINT(nonnull) mod_authorize(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
1686{
1688 rlm_sql_thread_t *thread = talloc_get_type_abort(mctx->thread, rlm_sql_thread_t);
1689 sql_autz_call_env_t *call_env = talloc_get_type_abort(mctx->env_data, sql_autz_call_env_t);
1690 sql_autz_ctx_t *autz_ctx;
1691
1692 fr_assert(request->packet != NULL);
1693 fr_assert(request->reply != NULL);
1694
1695 if (!call_env->check_query && !call_env->reply_query && !(inst->config.read_groups && call_env->membership_query)) {
1696 RWDEBUG("No authorization checks configured, returning noop");
1698 }
1699
1700 /*
1701 * Set and check the user attr here
1702 */
1703 sql_set_user(inst, request, &call_env->user);
1704
1705 MEM(autz_ctx = talloc(unlang_interpret_frame_talloc_ctx(request), sql_autz_ctx_t));
1706 *autz_ctx = (sql_autz_ctx_t) {
1707 .inst = inst,
1708 .call_env = call_env,
1709 .request = request,
1710 .trunk = thread->trunk,
1711 .rcode = RLM_MODULE_NOOP
1712 };
1713 map_list_init(&autz_ctx->check_tmp);
1714 map_list_init(&autz_ctx->reply_tmp);
1715 MEM(autz_ctx->map_ctx = talloc_zero(autz_ctx, fr_sql_map_ctx_t));
1716 talloc_set_destructor(autz_ctx, sql_autz_ctx_free);
1717
1718 if (unlang_module_yield(request,
1720 NULL, 0, autz_ctx) == UNLANG_ACTION_FAIL) {
1721 error:
1722 talloc_free(autz_ctx);
1724 }
1725
1726 fr_value_box_list_init(&autz_ctx->query);
1727
1728 /*
1729 * Query the check table to find any conditions associated with this user/realm/whatever...
1730 */
1731 if (call_env->check_query) {
1732 if (unlang_tmpl_push(autz_ctx, NULL, &autz_ctx->query, request, call_env->check_query, NULL, UNLANG_SUB_FRAME) < 0) goto error;
1733 autz_ctx->status = SQL_AUTZ_CHECK;
1735 }
1736
1737 if (call_env->reply_query) {
1738 if (unlang_tmpl_push(autz_ctx, NULL, &autz_ctx->query, request, call_env->reply_query, NULL, UNLANG_SUB_FRAME) < 0) goto error;
1739 autz_ctx->status = SQL_AUTZ_REPLY;
1741 }
1742
1743 /*
1744 * Neither check nor reply queries were set, so we must be doing group stuff
1745 */
1746 if (unlang_tmpl_push(autz_ctx, NULL, &autz_ctx->query, request, call_env->membership_query, NULL, UNLANG_SUB_FRAME) < 0) goto error;
1747 autz_ctx->status = SQL_AUTZ_GROUP_MEMB;
1749}
1750
1751/** Tidy up when freeing an SQL redundant context
1752 *
1753 * Release the connection handle and unset the SQL-User attribute.
1754 */
1756{
1757 if (!to_free->inst->sql_escape_arg) (void) request_data_get(to_free->request, (void *)sql_escape_uctx_alloc, 0);
1758 sql_unset_user(to_free->inst, to_free->request);
1759
1760 return 0;
1761}
1762
1763static unlang_action_t mod_sql_redundant_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request);
1764
1765/** Resume function called after executing an SQL query in a redundant list of queries.
1766 *
1767 * @param p_result Result of current module call.
1768 * @param mctx Current module ctx.
1769 * @param request Current request.
1770 * @return one of the RLM_MODULE_* values.
1771 */
1773{
1774 sql_redundant_ctx_t *redundant_ctx = talloc_get_type_abort(mctx->rctx, sql_redundant_ctx_t);
1775 sql_redundant_call_env_t *call_env = redundant_ctx->call_env;
1776 rlm_sql_t const *inst = redundant_ctx->inst;
1777 fr_sql_query_t *query_ctx = redundant_ctx->query_ctx;
1778 int numaffected = 0;
1779
1780 RDEBUG2("SQL query returned: %s", fr_table_str_by_value(sql_rcode_description_table, query_ctx->rcode, "<INVALID>"));
1781
1782 switch (query_ctx->rcode) {
1783 /*
1784 * Query was a success! Now we just need to check if it did anything.
1785 */
1786 case RLM_SQL_OK:
1787 break;
1788
1789 /*
1790 * A general, unrecoverable server fault.
1791 */
1792 case RLM_SQL_ERROR:
1793 /*
1794 * If we get RLM_SQL_RECONNECT it means all connections in the pool
1795 * were exhausted, and we couldn't create a new connection,
1796 * so we do not need to call fr_pool_connection_release.
1797 */
1798 case RLM_SQL_RECONNECT:
1799 rlm_sql_print_error(inst, request, query_ctx, false);
1801
1802 /*
1803 * Query was invalid, this is a terminal error.
1804 */
1806 rlm_sql_print_error(inst, request, query_ctx, false);
1808
1809 /*
1810 * Driver found an error (like a unique key constraint violation)
1811 * that hinted it might be a good idea to try an alternative query.
1812 */
1813 case RLM_SQL_ALT_QUERY:
1814 goto next;
1815
1817 break;
1818 }
1819
1820 /*
1821 * We need to have updated something for the query to have been
1822 * counted as successful.
1823 */
1824 numaffected = (inst->driver->sql_affected_rows)(query_ctx, &inst->config);
1825 TALLOC_FREE(query_ctx);
1826 RDEBUG2("%i record(s) updated", numaffected);
1827
1828 if (numaffected > 0) {
1829 if (inst->query_number_da) {
1830 fr_pair_t *vp;
1831 if (unlikely(pair_update_control(&vp, inst->query_number_da) < 0)) RETURN_UNLANG_FAIL;
1832 vp->vp_uint32 = redundant_ctx->query_no + 1;
1833 RDEBUG2("control.%pP", vp);
1834 }
1835 RETURN_UNLANG_OK; /* A query succeeded, were done! */
1836 }
1837next:
1838 /*
1839 * Look to see if there are any more queries to expand
1840 */
1841 talloc_free(query_ctx);
1842 redundant_ctx->query_no++;
1843 if (redundant_ctx->query_no >= talloc_array_length(call_env->query)) RETURN_UNLANG_NOOP;
1845 if (unlang_tmpl_push(redundant_ctx, NULL, &redundant_ctx->query, request, call_env->query[redundant_ctx->query_no], NULL, UNLANG_SUB_FRAME) < 0) RETURN_UNLANG_FAIL;
1846
1847 RDEBUG2("Trying next query...");
1848
1850}
1851
1852
1853/** Resume function called after expansion of next query in a redundant list of queries
1854 *
1855 * @param p_result Result of current module call.
1856 * @param mctx Current module ctx.
1857 * @param request Current request.
1858 * @return one of the RLM_MODULE_* values.
1859 */
1861{
1862 sql_redundant_ctx_t *redundant_ctx = talloc_get_type_abort(mctx->rctx, sql_redundant_ctx_t);
1863 sql_redundant_call_env_t *call_env = redundant_ctx->call_env;
1864 rlm_sql_t const *inst = redundant_ctx->inst;
1865
1866 redundant_ctx->query_vb = fr_value_box_list_pop_head(&redundant_ctx->query);
1867 if (!redundant_ctx->query_vb) RETURN_UNLANG_FAIL;
1868
1869 if ((call_env->filename.type == FR_TYPE_STRING) && (call_env->filename.vb_length > 0)) {
1870 rlm_sql_query_log(inst, call_env->filename.vb_strvalue, redundant_ctx->query_vb->vb_strvalue);
1871 }
1872
1873 MEM(redundant_ctx->query_ctx = fr_sql_query_alloc(redundant_ctx, inst, request, redundant_ctx->trunk,
1874 redundant_ctx->query_vb->vb_strvalue, SQL_QUERY_OTHER));
1875
1876 unlang_module_yield(request, mod_sql_redundant_query_resume, NULL, 0, redundant_ctx);
1877 return unlang_function_push_with_result(/* discard, mod_sql_redundant_query_resume uses query_ctx->rcode*/ NULL,
1878 request,
1879 inst->query,
1880 NULL,
1881 NULL,
1883 redundant_ctx->query_ctx);
1884}
1885
1886/** Generic module call for failing between a bunch of queries.
1887 *
1888 * Used for `accounting` and `send` module calls
1889 *
1890 */
1891static unlang_action_t CC_HINT(nonnull) mod_sql_redundant(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
1892{
1894 rlm_sql_thread_t *thread = talloc_get_type_abort(mctx->thread, rlm_sql_thread_t);
1895 sql_redundant_call_env_t *call_env = talloc_get_type_abort(mctx->env_data, sql_redundant_call_env_t);
1896 sql_redundant_ctx_t *redundant_ctx;
1897
1898 /*
1899 * No query to expand - do nothing.
1900 */
1901 if (!call_env->query) {
1902 RWARN("No query configured");
1904 }
1905
1906 MEM(redundant_ctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), sql_redundant_ctx_t));
1907 *redundant_ctx = (sql_redundant_ctx_t) {
1908 .inst = inst,
1909 .request = request,
1910 .trunk = thread->trunk,
1911 .call_env = call_env,
1912 .query_no = 0
1913 };
1914 talloc_set_destructor(redundant_ctx, sql_redundant_ctx_free);
1915
1916 sql_set_user(inst, request, &call_env->user);
1917
1918 fr_value_box_list_init(&redundant_ctx->query);
1919
1920 return unlang_module_yield_to_tmpl(request, &redundant_ctx->query, request, *call_env->query,
1921 NULL, mod_sql_redundant_resume, NULL, 0, redundant_ctx);
1922}
1923
1924static int logfile_call_env_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules,
1925 CONF_ITEM *ci,
1926 call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
1927{
1928 CONF_SECTION const *subcs = NULL, *subsubcs = NULL;
1929 CONF_PAIR const *to_parse = NULL;
1930 tmpl_t *parsed_tmpl;
1931 call_env_parsed_t *parsed_env;
1932 tmpl_rules_t our_rules;
1933 char *section2, *p;
1934
1936
1937 /*
1938 * The call env subsection which calls this has CF_IDENT_ANY as its name
1939 * which results in finding the first child section of the module config.
1940 * We actually want the whole module config - so go to the parent.
1941 */
1942 ci = cf_parent(ci);
1943
1944 /*
1945 * Find the instance of "logfile" to parse
1946 *
1947 * If the module call is from `accounting Start` then first is
1948 * <module> { accounting { start { logfile } } }
1949 * then
1950 * <module> { accounting { logfile } }
1951 * falling back to
1952 * <module> { logfile }
1953 */
1955 if (subcs) {
1956 if (cec->asked->name2) {
1957 section2 = talloc_strdup(NULL, cec->asked->name2);
1958 p = section2;
1959 while (*p != '\0') {
1960 *(p) = tolower((uint8_t)*p);
1961 p++;
1962 }
1963 subsubcs = cf_section_find(subcs, section2, CF_IDENT_ANY);
1964 talloc_free(section2);
1965 if (subsubcs) to_parse = cf_pair_find(subsubcs, "logfile");
1966 }
1967 if (!to_parse) to_parse = cf_pair_find(subcs, "logfile");
1968 }
1969
1970 if (!to_parse) to_parse = cf_pair_find(cf_item_to_section(ci), "logfile");
1971
1972 if (!to_parse) return 0;
1973
1974 /*
1975 * Use filename safety escape functions
1976 */
1977 our_rules = *t_rules;
1981 .always_escape = false,
1982 };
1984 our_rules.literals_safe_for = our_rules.escape.box_escape.safe_for;
1985
1986 MEM(parsed_env = call_env_parsed_add(ctx, out,
1988
1989 if (tmpl_afrom_substr(parsed_env, &parsed_tmpl,
1990 &FR_SBUFF_IN(cf_pair_value(to_parse), talloc_strlen(cf_pair_value(to_parse))),
1992 &our_rules) < 0) {
1993 error:
1994 call_env_parsed_free(out, parsed_env);
1995 return -1;
1996 }
1997 if (tmpl_needs_resolving(parsed_tmpl) &&
1998 (tmpl_resolve(parsed_tmpl, &(tmpl_res_rules_t){ .dict_def = our_rules.attr.dict_def }) < 0)) goto error;
1999
2000 call_env_parsed_set_tmpl(parsed_env, parsed_tmpl);
2001
2002 return 0;
2003}
2004
2005static int query_call_env_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules,
2006 CONF_ITEM *ci,
2007 call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
2008{
2010 CONF_SECTION const *subcs = NULL;
2011 CONF_PAIR const *to_parse = NULL;
2012 tmpl_t *parsed_tmpl;
2013 call_env_parsed_t *parsed_env;
2014 tmpl_rules_t our_rules;
2015 char *section2, *p;
2016 ssize_t count, slen, multi_index = 0;
2017
2019
2020 /*
2021 * Find the instance(s) of "query" to parse
2022 *
2023 * If the module call is from `accounting Start` then it should be
2024 * <module> { accounting { start { query } } }
2025 */
2026 section2 = talloc_strdup(NULL, section_name_str(cec->asked->name2));
2027 p = section2;
2028 while (*p != '\0') {
2029 *(p) = tolower((uint8_t)*p);
2030 p++;
2031 }
2032 subcs = cf_section_find(cf_item_to_section(ci), section2, CF_IDENT_ANY);
2033 if (!subcs) {
2034 no_query:
2035 cf_log_warn(ci, "No query found for \"%s.%s\", this query will be disabled",
2036 section_name_str(cec->asked->name1), section2);
2037 talloc_free(section2);
2038 return 0;
2039 }
2040 count = cf_pair_count(subcs, "query");
2041 if (count == 0) goto no_query;
2042
2043 talloc_free(section2);
2044
2045 /*
2046 * Use module specific escape functions
2047 */
2048 our_rules = *t_rules;
2049 our_rules.escape = (tmpl_escape_t) {
2052 .safe_for = SQL_SAFE_FOR,
2053 .always_escape = false,
2054 },
2055 .uctx = { .func = { .uctx = inst, .alloc = sql_escape_uctx_alloc }, .type = TMPL_ESCAPE_UCTX_ALLOC_FUNC },
2056 .mode = TMPL_ESCAPE_PRE_CONCAT,
2057 };
2058 our_rules.literals_safe_for = our_rules.escape.box_escape.safe_for;
2059
2060 while ((to_parse = cf_pair_find_next(subcs, to_parse, "query"))) {
2061 MEM(parsed_env = call_env_parsed_add(ctx, out,
2065 }));
2066
2067 slen = tmpl_afrom_substr(parsed_env, &parsed_tmpl,
2068 &FR_SBUFF_IN(cf_pair_value(to_parse), talloc_strlen(cf_pair_value(to_parse))),
2070 &our_rules);
2071 if (slen <= 0) {
2072 cf_canonicalize_error(to_parse, slen, "Failed parsing query", cf_pair_value(to_parse));
2073 error:
2074 call_env_parsed_free(out, parsed_env);
2075 return -1;
2076 }
2077 if (tmpl_needs_resolving(parsed_tmpl) &&
2078 (tmpl_resolve(parsed_tmpl, &(tmpl_res_rules_t){ .dict_def = our_rules.attr.dict_def }) < 0)) {
2079 cf_log_perr(to_parse, "Failed resolving query");
2080 goto error;
2081 }
2082
2083 call_env_parsed_set_multi_index(parsed_env, count, multi_index++);
2084 call_env_parsed_set_data(parsed_env, parsed_tmpl);
2085 }
2086
2087 return 0;
2088}
2089
2090static int mod_detach(module_detach_ctx_t const *mctx)
2091{
2092 rlm_sql_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_sql_t);
2093
2094 /*
2095 * We need to explicitly free all children, so if the driver
2096 * parented any memory off the instance, their destructors
2097 * run before we unload the bytecode for them.
2098 *
2099 * If we don't do this, we get a SEGV deep inside the talloc code
2100 * when it tries to call a destructor that no longer exists.
2101 */
2102 talloc_free_children(inst);
2103
2104 return 0;
2105}
2106
2107static int mod_instantiate(module_inst_ctx_t const *mctx)
2108{
2109 rlm_sql_boot_t const *boot = talloc_get_type_abort(mctx->mi->boot, rlm_sql_boot_t);
2110 rlm_sql_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_sql_t);
2111 CONF_SECTION *conf = mctx->mi->conf;
2112
2113 /*
2114 * We can't modify the inst field in bootstrap, and there's no
2115 * point in making rlm_sql_boot_t available everywhere.
2116 */
2117 inst->group_da = boot->group_da;
2118 inst->query_number_da = boot->query_number_da;
2119
2120 inst->name = mctx->mi->name; /* Need this for functions in sql.c */
2121 inst->mi = mctx->mi; /* For looking up thread instance data */
2122
2123 /*
2124 * We need authorize_group_check_query or authorize_group_reply_query
2125 * if group_membership_query is set.
2126 *
2127 * Or we need group_membership_query if authorize_group_check_query or
2128 * authorize_group_reply_query is set.
2129 */
2130 if (!cf_pair_find(conf, "group_membership_query")) {
2131 if (cf_pair_find(conf, "authorize_group_check_query")) {
2132 WARN("Ignoring authorize_group_check_query as group_membership_query is not configured");
2133 }
2134
2135 if (cf_pair_find(conf, "authorize_group_reply_query")) {
2136 WARN("Ignoring authorize_group_reply_query as group_membership_query is not configured");
2137 }
2138
2139 if (!inst->config.read_groups) {
2140 WARN("Ignoring read_groups as group_membership_query is not configured");
2141 inst->config.read_groups = false;
2142 }
2143 } /* allow the group check / reply queries to be NULL */
2144
2145 /*
2146 * Cache the SQL-User-Name fr_dict_attr_t, so we can be slightly
2147 * more efficient about creating SQL-User-Name attributes.
2148 */
2149 inst->sql_user = attr_sql_user_name;
2150
2151 /*
2152 * Export these methods, too. This avoids RTDL_GLOBAL.
2153 */
2154 inst->query = rlm_sql_trunk_query;
2155 inst->select = rlm_sql_trunk_query;
2156 inst->fetch_row = rlm_sql_fetch_row;
2157 inst->query_alloc = fr_sql_query_alloc;
2158
2159 /*
2160 * Either use the module specific escape function
2161 * or our default one.
2162 */
2163 if (inst->driver->sql_escape_func) {
2164 inst->sql_escape_func = inst->driver->sql_escape_func;
2165 } else {
2166 inst->sql_escape_func = sql_escape_func;
2167 inst->sql_escape_arg = inst;
2168 }
2169 inst->box_escape = (fr_value_box_escape_t) {
2170 .func = sql_box_escape,
2171 .safe_for = SQL_SAFE_FOR,
2172 .always_escape = false,
2173 };
2174
2175 inst->ef = module_rlm_exfile_init(inst, conf, 256, fr_time_delta_from_sec(30), true, false, NULL, NULL);
2176 if (!inst->ef) {
2177 cf_log_err(conf, "Failed creating log file context");
2178 return -1;
2179 }
2180
2181 /*
2182 * Most SQL trunks can only have one running request per connection.
2183 */
2184 if (!(inst->driver->flags & RLM_SQL_MULTI_QUERY_CONN)) {
2185 inst->config.trunk_conf.target_req_per_conn = 1;
2186 inst->config.trunk_conf.max_req_per_conn = 1;
2187 }
2188 if (!inst->driver->trunk_io_funcs.connection_notify) {
2189 inst->config.trunk_conf.always_writable = true;
2190 }
2191
2192 /*
2193 * Instantiate the driver module
2194 */
2195 if (unlikely(module_instantiate(inst->driver_submodule) < 0)) {
2196 cf_log_err(conf, "Failed instantiating driver module");
2197 return -1;
2198 }
2199
2200 if (!inst->config.trunk_conf.conn_triggers) return 0;
2201
2202 MEM(inst->trigger_args = fr_pair_list_alloc(inst));
2203 return module_trigger_args_build(inst->trigger_args, inst->trigger_args, cf_section_find(conf, "pool", NULL),
2205 .module = inst->mi->module->name,
2206 .name = inst->name,
2207 .server = inst->config.sql_server,
2208 .port = inst->config.sql_port
2209 });
2210}
2211
2212static int mod_bootstrap(module_inst_ctx_t const *mctx)
2213{
2214 rlm_sql_boot_t *boot = talloc_get_type_abort(mctx->mi->boot, rlm_sql_boot_t);
2215 rlm_sql_t const *inst = talloc_get_type_abort(mctx->mi->data, rlm_sql_t);
2216 CONF_SECTION *conf = mctx->mi->conf;
2217 xlat_t *xlat;
2218 xlat_arg_parser_t *sql_xlat_arg;
2220
2221 /*
2222 * Register the group comparison attribute
2223 */
2224 if (cf_pair_find(conf, "group_membership_query")) {
2225 char const *group_attribute;
2226 char buffer[256];
2227
2228 if (inst->config.group_attribute) {
2229 group_attribute = inst->config.group_attribute;
2230 } else if (cf_section_name2(conf)) {
2231 snprintf(buffer, sizeof(buffer), "%s-SQL-Group", mctx->mi->name);
2232 group_attribute = buffer;
2233 } else {
2234 group_attribute = "SQL-Group";
2235 }
2236
2237 boot->group_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), group_attribute);
2238 if (!boot->group_da) {
2240 cf_log_perr(conf, "Failed defining group attribute");
2241 return -1;
2242 }
2243
2244 boot->group_da = fr_dict_attr_search_by_qualified_oid(NULL, dict_freeradius, group_attribute,
2245 false, false);
2246 if (!boot->group_da) {
2247 cf_log_perr(conf, "Failed resolving group attribute");
2248 return -1;
2249 }
2250 }
2251
2252 /*
2253 * Define the new %sql.group(name) xlat. The
2254 * register function automatically adds the
2255 * module instance name as a prefix.
2256 */
2257 xlat = module_rlm_xlat_register(boot, mctx, "group", sql_group_xlat, FR_TYPE_BOOL);
2258 if (!xlat) {
2259 cf_log_perr(conf, "Failed registering %s expansion", group_attribute);
2260 return -1;
2261 }
2263
2264 /*
2265 * The xlat escape function needs access to inst - so
2266 * argument parser details need to be defined here
2267 */
2268 sql_xlat_arg = talloc_zero_array(xlat, xlat_arg_parser_t, 2);
2269 sql_xlat_arg[0] = (xlat_arg_parser_t){
2271 .required = true,
2272 .concat = true
2273 };
2275
2276 xlat_func_args_set(xlat, sql_xlat_arg);
2277 }
2278
2279 /*
2280 * If we need to record which query from a redundant set succeeds, find / create the attribute to use.
2281 */
2282 if (inst->config.query_number_attribute) {
2284 inst->config.query_number_attribute);
2285 if (!boot->query_number_da) {
2287 inst->config.query_number_attribute, FR_TYPE_UINT32, NULL) < 0) {
2288 ERROR("Failed defining query number attribute \"%s\"", inst->config.query_number_attribute);
2289 return -1;
2290 }
2291
2293 inst->config.query_number_attribute,
2294 false, false);
2295 if (!boot->query_number_da) {
2296 ERROR("Failed resolving query number attribute \"%s\"", inst->config.query_number_attribute);
2297 return -1;
2298 }
2299 } else {
2300 if (boot->query_number_da->type != FR_TYPE_UINT32) {
2301 ERROR("Query number attribute \"%s\" is type \"%s\", needs to be uint32",
2302 inst->config.query_number_attribute, fr_type_to_str(boot->query_number_da->type));
2303 return -1;
2304 }
2305 }
2306 }
2307
2308 /*
2309 * Register the SQL xlat function
2310 */
2311 xlat = module_rlm_xlat_register(boot, mctx, NULL, sql_xlat, FR_TYPE_VOID); /* Returns an integer sometimes */
2312 if (!xlat) {
2313 cf_log_perr(conf, "Failed registering %s expansion", mctx->mi->name);
2314 return -1;
2315 }
2317
2318 /*
2319 * The xlat escape function needs access to inst - so
2320 * argument parser details need to be defined here.
2321 * Parented off the module instance "boot" so it can be shared
2322 * between three xlats.
2323 */
2324 MEM(sql_xlat_arg = talloc_zero_array(boot, xlat_arg_parser_t, 2));
2325 MEM(uctx = talloc_zero(sql_xlat_arg, rlm_sql_escape_uctx_t));
2326 *uctx = (rlm_sql_escape_uctx_t){ .sql = inst };
2327 sql_xlat_arg[0] = (xlat_arg_parser_t){
2329 .required = true,
2330 .concat = true,
2331 .func = sql_xlat_escape,
2332 .safe_for = SQL_SAFE_FOR,
2333 .uctx = uctx
2334 };
2336
2337 xlat_func_args_set(xlat, sql_xlat_arg);
2338
2339 /*
2340 * Register instances of the SQL xlat with pre-determined output types
2341 */
2342 if (unlikely(!(xlat = module_rlm_xlat_register(boot, mctx, "fetch", sql_fetch_xlat, FR_TYPE_VOID)))) return -1;
2344 xlat_func_args_set(xlat, sql_xlat_arg);
2345
2346 if (unlikely(!(xlat = module_rlm_xlat_register(boot, mctx, "modify", sql_modify_xlat, FR_TYPE_UINT32)))) return -1;
2348 xlat_func_args_set(xlat, sql_xlat_arg);
2349
2350 if (unlikely(!(xlat = module_rlm_xlat_register(boot, mctx, "escape", sql_escape_xlat, FR_TYPE_STRING)))) return -1;
2351 sql_xlat_arg = talloc_zero_array(xlat, xlat_arg_parser_t, 2);
2352 sql_xlat_arg[0] = (xlat_arg_parser_t){
2354 .variadic = true,
2355 .concat = true,
2356 };
2358 xlat_func_args_set(xlat, sql_xlat_arg);
2361
2362 if (unlikely(!(xlat = module_rlm_xlat_register(boot, mctx, "safe", xlat_transparent, FR_TYPE_STRING)))) return -1;
2363 sql_xlat_arg = talloc_zero_array(xlat, xlat_arg_parser_t, 2);
2364 sql_xlat_arg[0] = (xlat_arg_parser_t){
2366 .variadic = true,
2367 .concat = true
2368 };
2370 xlat_func_args_set(xlat, sql_xlat_arg);
2373
2374 /*
2375 * Register the SQL map processor function
2376 */
2377 if (inst->driver->sql_fields) map_proc_register(mctx->mi->boot, inst, mctx->mi->name, mod_map_proc, sql_map_verify, 0, SQL_SAFE_FOR);
2378
2379 return 0;
2380}
2381
2382/** Initialise thread specific data structure
2383 *
2384 */
2386{
2387 rlm_sql_thread_t *thread = talloc_get_type_abort(mctx->thread, rlm_sql_thread_t);
2388 rlm_sql_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_sql_t);
2389
2390 if (inst->driver->sql_escape_arg_alloc) {
2391 thread->sql_escape_arg = inst->driver->sql_escape_arg_alloc(thread, mctx->el, inst);
2392 if (!thread->sql_escape_arg) return -1;
2393 }
2394
2395 thread->inst = inst;
2396
2397 thread->trunk = trunk_alloc(thread, mctx->el, &inst->driver->trunk_io_funcs,
2398 &inst->config.trunk_conf, inst->name, thread, false, inst->trigger_args);
2399 if (!thread->trunk) return -1;
2400
2401 return 0;
2402}
2403
2405{
2406 rlm_sql_thread_t *thread = talloc_get_type_abort(mctx->thread, rlm_sql_thread_t);
2407 rlm_sql_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_sql_t);
2408
2409 if (inst->driver->sql_escape_arg_free) inst->driver->sql_escape_arg_free(thread->sql_escape_arg);
2410
2411 return 0;
2412}
2413
2414/** Custom parser for sql call env queries
2415 *
2416 * Needed as the escape function needs to reference the correct SQL driver
2417 */
2418static int sql_call_env_parse(TALLOC_CTX *ctx, void *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci,
2419 call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
2420{
2422 tmpl_t *parsed_tmpl;
2423 CONF_PAIR const *to_parse = cf_item_to_pair(ci);
2424 tmpl_rules_t our_rules = *t_rules;
2425
2426 /*
2427 * Set the sql module instance data as the uctx for escaping
2428 * and use the same "safe_for" as the sql module.
2429 */
2432 .safe_for = SQL_SAFE_FOR,
2433 .always_escape = false,
2434 };
2435 our_rules.escape.uctx.func.uctx = inst;
2436 our_rules.literals_safe_for = SQL_SAFE_FOR;
2437
2438 if (tmpl_afrom_substr(ctx, &parsed_tmpl,
2439 &FR_SBUFF_IN(cf_pair_value(to_parse), talloc_strlen(cf_pair_value(to_parse))),
2441 &our_rules) < 0) return -1;
2442 *(void **)out = parsed_tmpl;
2443 return 0;
2444}
2445
2446#define QUERY_ESCAPE .pair.escape = { \
2447 .mode = TMPL_ESCAPE_PRE_CONCAT, \
2448 .uctx = { .func = { .alloc = sql_escape_uctx_alloc }, .type = TMPL_ESCAPE_UCTX_ALLOC_FUNC }, \
2449}, .pair.func = sql_call_env_parse
2450
2463
2464/* globally exported name */
2466 .common = {
2467 .magic = MODULE_MAGIC_INIT,
2468 .name = "sql",
2469 .boot_size = sizeof(rlm_sql_boot_t),
2470 .boot_type = "rlm_sql_boot_t",
2471 .inst_size = sizeof(rlm_sql_t),
2472 .config = module_config,
2473 .bootstrap = mod_bootstrap,
2474 .instantiate = mod_instantiate,
2475 .detach = mod_detach,
2476 .thread_inst_size = sizeof(rlm_sql_thread_t),
2479 },
2480 .method_group = {
2481 .bindings = (module_method_binding_t[]){
2482 /*
2483 * Hack to support old configurations
2484 */
2485 { .section = SECTION_NAME("accounting", CF_IDENT_ANY), .method = mod_sql_redundant, .method_env = &accounting_method_env },
2486 { .section = SECTION_NAME("authorize", CF_IDENT_ANY), .method = mod_authorize, .method_env = &authorize_method_env },
2487
2488 { .section = SECTION_NAME("recv", CF_IDENT_ANY), .method = mod_authorize, .method_env = &authorize_method_env },
2489 { .section = SECTION_NAME("send", CF_IDENT_ANY), .method = mod_sql_redundant, .method_env = &send_method_env },
2491 }
2492 }
2493};
unlang_action_t
Returned by unlang_op_t calls, determine the next action of the interpreter.
Definition action.h:35
@ UNLANG_ACTION_PUSHED_CHILD
unlang_t pushed a new child onto the stack, execute it instead of continuing.
Definition action.h:39
@ UNLANG_ACTION_FAIL
Encountered an unexpected error.
Definition action.h:36
@ UNLANG_ACTION_CALCULATE_RESULT
Calculate a new section rlm_rcode_t value.
Definition action.h:37
@ UNLANG_ACTION_YIELD
Temporarily pause execution until an event occurs.
Definition action.h:41
static int const char char buffer[256]
Definition acutest.h:576
#define fr_atexit_thread_local(_name, _free, _uctx)
Definition atexit.h:224
#define RCSID(id)
Definition build.h:512
#define FALL_THROUGH
clang 10 doesn't recognised the FALL-THROUGH comment anymore
Definition build.h:343
#define unlikely(_x)
Definition build.h:407
#define UNUSED
Definition build.h:336
void call_env_parsed_free(call_env_parsed_head_t *parsed, call_env_parsed_t *ptr)
Remove a call_env_parsed_t from the list of parsed call envs.
Definition call_env.c:777
call_env_parsed_t * call_env_parsed_add(TALLOC_CTX *ctx, call_env_parsed_head_t *head, call_env_parser_t const *rule)
Allocate a new call_env_parsed_t structure and add it to the list of parsed call envs.
Definition call_env.c:690
void call_env_parsed_set_multi_index(call_env_parsed_t *parsed, size_t count, size_t index)
Assign a count and index to a call_env_parsed_t.
Definition call_env.c:762
void call_env_parsed_set_data(call_env_parsed_t *parsed, void const *data)
Assign data to a call_env_parsed_t.
Definition call_env.c:747
void call_env_parsed_set_tmpl(call_env_parsed_t *parsed, tmpl_t const *tmpl)
Assign a tmpl to a call_env_parsed_t.
Definition call_env.c:719
#define CALL_ENV_TERMINATOR
Definition call_env.h:236
call_env_ctx_type_t type
Type of callenv ctx.
Definition call_env.h:227
@ CALL_ENV_CTX_TYPE_MODULE
The callenv is registered to a module method.
Definition call_env.h:222
#define FR_CALL_ENV_METHOD_OUT(_inst)
Helper macro for populating the size/type fields of a call_env_method_t from the output structure typ...
Definition call_env.h:240
call_env_parser_t const * env
Parsing rules for call method env.
Definition call_env.h:247
section_name_t const * asked
The actual name1/name2 that resolved to a module_method_binding_t.
Definition call_env.h:232
@ CALL_ENV_FLAG_CONCAT
If the tmpl produced multiple boxes they should be concatenated.
Definition call_env.h:76
@ CALL_ENV_FLAG_SUBSECTION
This is a subsection.
Definition call_env.h:87
@ CALL_ENV_FLAG_PARSE_ONLY
The result of parsing will not be evaluated at runtime.
Definition call_env.h:85
@ CALL_ENV_FLAG_MULTI
Multiple instances of the conf pairs are allowed.
Definition call_env.h:78
@ CALL_ENV_FLAG_NULLABLE
Tmpl expansions are allowed to produce no output.
Definition call_env.h:80
module_instance_t const * mi
Module instance that the callenv is registered to.
Definition call_env.h:229
#define FR_CALL_ENV_SUBSECTION_FUNC(_name, _name2, _flags, _func)
Specify a call_env_parser_t which parses a subsection using a callback function.
Definition call_env.h:412
#define FR_CALL_ENV_OFFSET(_name, _cast_type, _flags, _struct, _field)
Specify a call_env_parser_t which writes out runtime results to the specified field.
Definition call_env.h:340
#define FR_CALL_ENV_PARSE_ONLY_OFFSET(_name, _cast_type, _flags, _struct, _parse_field)
Specify a call_env_parser_t which writes out the result of the parsing phase to the field specified.
Definition call_env.h:389
Per method call config.
Definition call_env.h:180
#define CONF_PARSER_TERMINATOR
Definition cf_parse.h:669
cf_parse_t func
Override default parsing behaviour for the specified type with a custom parsing function.
Definition cf_parse.h:623
#define FR_CONF_OFFSET(_name, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
Definition cf_parse.h:280
#define FR_CONF_OFFSET_FLAGS(_name, _flags, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
Definition cf_parse.h:268
#define FR_CONF_OFFSET_SUBSECTION(_name, _flags, _struct, _field, _subcs)
conf_parser_t which populates a sub-struct using a CONF_SECTION
Definition cf_parse.h:309
@ CONF_FLAG_SECRET
Only print value if debug level >= 3.
Definition cf_parse.h:433
@ CONF_FLAG_HIDDEN
Used by scripts to omit items from the generated documentation.
Definition cf_parse.h:455
#define FR_CONF_OFFSET_TYPE_FLAGS(_name, _type, _flags, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
Definition cf_parse.h:238
Defines a CONF_PAIR to C data type mapping.
Definition cf_parse.h:606
Common header for all CONF_* types.
Definition cf_priv.h:54
Configuration AVP similar to a fr_pair_t.
Definition cf_priv.h:77
A section grouping multiple CONF_PAIR.
Definition cf_priv.h:106
CONF_PAIR * cf_pair_find_next(CONF_SECTION const *cs, CONF_PAIR const *prev, char const *attr)
Find a pair with a name matching attr, after specified pair.
Definition cf_util.c:1601
unsigned int cf_pair_count(CONF_SECTION const *cs, char const *attr)
Count the number of times an attribute occurs in a parent section.
Definition cf_util.c:1668
char const * cf_section_name2(CONF_SECTION const *cs)
Return the second identifier of a CONF_SECTION.
Definition cf_util.c:1352
CONF_SECTION * cf_section_find(CONF_SECTION const *cs, char const *name1, char const *name2)
Find a CONF_SECTION with name1 and optionally name2.
Definition cf_util.c:1194
CONF_SECTION * cf_item_to_section(CONF_ITEM const *ci)
Cast a CONF_ITEM to a CONF_SECTION.
Definition cf_util.c:692
CONF_PAIR * cf_pair_find(CONF_SECTION const *cs, char const *attr)
Search for a CONF_PAIR with a specific name.
Definition cf_util.c:1587
fr_token_t cf_pair_value_quote(CONF_PAIR const *pair)
Return the value (rhs) quoting of a pair.
Definition cf_util.c:1790
CONF_PAIR * cf_item_to_pair(CONF_ITEM const *ci)
Cast a CONF_ITEM to a CONF_PAIR.
Definition cf_util.c:672
char const * cf_pair_value(CONF_PAIR const *pair)
Return the value of a CONF_PAIR.
Definition cf_util.c:1746
#define cf_log_err(_cf, _fmt,...)
Definition cf_util.h:345
#define cf_parent(_cf)
Definition cf_util.h:118
#define cf_canonicalize_error(_ci, _slen, _msg, _str)
Definition cf_util.h:423
#define cf_log_perr(_cf, _fmt,...)
Definition cf_util.h:352
#define cf_log_warn(_cf, _fmt,...)
Definition cf_util.h:346
#define CF_IDENT_ANY
Definition cf_util.h:80
static int fr_dcursor_append(fr_dcursor_t *cursor, void *v)
Insert a single item at the end of the list.
Definition dcursor.h:406
#define fr_assert_msg(_x, _msg,...)
Calls panic_action ifndef NDEBUG, else logs error and causes the server to exit immediately with code...
Definition debug.h:202
#define MEM(x)
Definition debug.h:36
#define ERROR(fmt,...)
Definition dhcpclient.c:40
fr_dict_attr_t const * fr_dict_attr_search_by_qualified_oid(fr_dict_attr_err_t *err, fr_dict_t const *dict_def, char const *attr, bool internal, bool foreign))
Locate a qualified fr_dict_attr_t by its name and a dictionary qualifier.
Definition dict_util.c:3323
int fr_dict_attr_add_name_only(fr_dict_t *dict, fr_dict_attr_t const *parent, char const *name, fr_type_t type, fr_dict_attr_flags_t const *flags))
Add an attribute to the dictionary.
Definition dict_util.c:1981
fr_dict_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4880
fr_dict_attr_t const * fr_dict_attr_by_name(fr_dict_attr_err_t *err, fr_dict_attr_t const *parent, char const *attr))
Locate a fr_dict_attr_t by its name.
Definition dict_util.c:3505
fr_dict_attr_t const * fr_dict_root(fr_dict_t const *dict)
Return the root attribute of a dictionary.
Definition dict_util.c:2639
fr_dict_attr_t const ** out
Where to write a pointer to the resolved fr_dict_attr_t.
Definition dict.h:292
fr_dict_t const ** out
Where to write a pointer to the loaded/resolved fr_dict_t.
Definition dict.h:305
char const * fr_dict_enum_name_by_value(fr_dict_attr_t const *da, fr_value_box_t const *value)
Lookup the name of an enum value in a fr_dict_attr_t.
Definition dict_util.c:3665
#define DICT_AUTOLOAD_TERMINATOR
Definition dict.h:311
static fr_slen_t in
Definition dict.h:882
Specifies an attribute which must be present for the module to function.
Definition dict.h:291
Specifies a dictionary which must be loaded/loadable for the module to function.
Definition dict.h:304
Test enumeration values.
Definition dict_test.h:92
#define MODULE_MAGIC_INIT
Stop people using different module/library/server versions together.
Definition dl_module.h:63
#define unlang_function_push_with_result(_result_p, _request, _func, _repeat, _signal, _sigmask, _top_frame, _uctx)
Push a generic function onto the unlang stack that produces a result.
Definition function.h:144
static xlat_action_t sql_escape_xlat(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Escape a value to make it SQL safe.
Definition rlm_sql.c:426
static xlat_action_t sql_group_xlat(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
Check if the user is a member of a particular group.
Definition rlm_sql.c:1193
static xlat_action_t sql_modify_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Execute an arbitrary SQL query, returning the number of rows affected.
Definition rlm_sql.c:651
static xlat_action_t sql_fetch_xlat(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Execute an arbitrary SQL query, expecting results to be returned.
Definition rlm_sql.c:617
static xlat_action_t sql_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Execute an arbitrary SQL query.
Definition rlm_sql.c:553
talloc_free(hp)
unlang_result_t * unlang_interpret_result(request_t *request)
Get the last instruction result OR the last frame that was popped.
Definition interpret.c:1935
TALLOC_CTX * unlang_interpret_frame_talloc_ctx(request_t *request)
Get a talloc_ctx which is valid only for this frame.
Definition interpret.c:2035
#define UNLANG_SUB_FRAME
Definition interpret.h:37
rlm_rcode_t rcode
The current rcode, from executing the instruction or merging the result from a frame.
Definition interpret.h:139
#define REXDENT()
Exdent (unindent) R* messages by one level.
Definition log.h:455
#define RWDEBUG(fmt,...)
Definition log.h:373
#define RDEBUG_ENABLED3
True if request debug level 1-3 messages are enabled.
Definition log.h:347
#define RDEBUG3(fmt,...)
Definition log.h:355
#define RWARN(fmt,...)
Definition log.h:309
#define RERROR(fmt,...)
Definition log.h:310
#define RPERROR(fmt,...)
Definition log.h:314
#define RPEDEBUG(fmt,...)
Definition log.h:388
#define RINDENT()
Indent R* messages by one level.
Definition log.h:442
int map_to_request(request_t *request, map_t const *map, radius_map_getvalue_t func, void *ctx)
Convert map_t to fr_pair_t (s) and add them to a request_t.
Definition map.c:1884
int rad_filename_box_make_safe(fr_value_box_t *vb, UNUSED void *uxtc)
Definition util.c:131
unlang_action_t unlang_map_yield(request_t *request, map_proc_func_t resume, unlang_map_signal_t signal, fr_signal_t sigmask, void *rctx)
Yield a request back to the interpreter from within a module.
Definition map.c:109
static TALLOC_CTX * map_ctx
Definition map_builtin.c:32
int map_proc_register(TALLOC_CTX *ctx, void const *mod_inst, char const *name, map_proc_func_t evaluate, map_proc_instantiate_t instantiate, size_t inst_size, fr_value_box_safe_for_t literals_safe_for)
Register a map processor.
Definition map_proc.c:124
void * rctx
Resume ctx that a module previously set.
Definition map_proc.h:53
void const * moi
Map module instance.
Definition map_proc.h:54
Temporary structure to hold arguments for map calls.
Definition map_proc.h:52
@ FR_TYPE_ETHERNET
48 Bit Mac-Address.
@ FR_TYPE_STRING
String of printable characters.
@ FR_TYPE_UINT32
32 Bit unsigned integer.
@ FR_TYPE_VOID
User data.
@ FR_TYPE_BOOL
A truth value.
unsigned int uint32_t
long int ssize_t
unsigned char uint8_t
int strncasecmp(char *s1, char *s2, int n)
Definition missing.c:35
int strcasecmp(char *s1, char *s2)
Definition missing.c:65
void * env_data
Per call environment data.
Definition module_ctx.h:44
module_instance_t const * mi
Instance of the module being instantiated.
Definition module_ctx.h:42
void * thread
Thread specific instance data.
Definition module_ctx.h:43
void * rctx
Resume ctx that a module previously set.
Definition module_ctx.h:45
fr_event_list_t * el
Event list to register any IO handlers and timers against.
Definition module_ctx.h:68
module_instance_t * mi
Module instance to detach.
Definition module_ctx.h:57
void * thread
Thread instance data.
Definition module_ctx.h:67
module_instance_t const * mi
Instance of the module being instantiated.
Definition module_ctx.h:64
module_instance_t * mi
Instance of the module being instantiated.
Definition module_ctx.h:51
Temporary structure to hold arguments for module calls.
Definition module_ctx.h:41
Temporary structure to hold arguments for detach calls.
Definition module_ctx.h:56
Temporary structure to hold arguments for instantiation calls.
Definition module_ctx.h:50
Temporary structure to hold arguments for thread_instantiation calls.
Definition module_ctx.h:63
exfile_t * module_rlm_exfile_init(TALLOC_CTX *ctx, CONF_SECTION *module, uint32_t max_entries, fr_time_delta_t max_idle, bool locking, bool triggers, char const *trigger_prefix, fr_pair_list_t *trigger_args)
Initialise a module specific exfile handle.
Definition module_rlm.c:103
xlat_t * module_rlm_xlat_register(TALLOC_CTX *ctx, module_inst_ctx_t const *mctx, char const *name, xlat_func_t func, fr_type_t return_type)
Definition module_rlm.c:232
int module_rlm_submodule_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
Generic conf_parser_t func for loading drivers.
Definition module_rlm.c:932
module_t common
Common fields presented by all modules.
Definition module_rlm.h:39
int fr_pair_value_strdup(fr_pair_t *vp, char const *src, bool tainted)
Copy data into an "string" data type.
Definition pair.c:2663
int fr_pair_value_from_str(fr_pair_t *vp, char const *value, size_t inlen, fr_sbuff_unescape_rules_t const *uerules, UNUSED bool tainted)
Convert string value to native attribute value.
Definition pair.c:2617
fr_pair_t * fr_pair_find_by_da(fr_pair_list_t const *list, fr_pair_t const *prev, fr_dict_attr_t const *da)
Find the first pair with a matching da.
Definition pair.c:707
fr_pair_list_t * fr_pair_list_alloc(TALLOC_CTX *ctx)
Allocate a new pair list on the heap.
Definition pair.c:119
int fr_pair_append(fr_pair_list_t *list, fr_pair_t *to_add)
Add a VP to the end of the list.
Definition pair.c:1352
fr_pair_t * fr_pair_afrom_da(TALLOC_CTX *ctx, fr_dict_attr_t const *da)
Dynamically allocate a new attribute and assign a fr_dict_attr_t.
Definition pair.c:290
int radius_legacy_map_cmp(request_t *request, map_t const *map)
Definition pairmove.c:791
int radius_legacy_map_list_apply(request_t *request, map_list_t const *list, fr_edit_list_t *el)
Definition pairmove.c:772
size_t fr_utf8_char(uint8_t const *str, ssize_t inlen)
Checks for utf-8, taken from http://www.w3.org/International/questions/qa-forms-utf-8.
Definition print.c:39
#define fr_assert(_expr)
Definition rad_assert.h:37
#define pair_update_request(_attr, _da)
#define REDEBUG(fmt,...)
#define RDEBUG2(fmt,...)
#define WARN(fmt,...)
static void thread_detach(UNUSED void *uctx)
Explicitly cleanup module/xlat resources.
Definition radiusd.c:139
static int thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el, UNUSED void *uctx)
Create module and xlat per-thread instances.
Definition radiusd.c:127
static rs_t * conf
Definition radsniff.c:52
#define RLM_MODULE_USER_SECTION_REJECT
Rcodes that translate to a user configurable section failing overall.
Definition rcode.h:79
#define RETURN_UNLANG_INVALID
Definition rcode.h:66
#define RETURN_UNLANG_RCODE(_rcode)
Definition rcode.h:61
#define RETURN_UNLANG_NOTFOUND
Definition rcode.h:68
#define RETURN_UNLANG_FAIL
Definition rcode.h:63
#define RETURN_UNLANG_OK
Definition rcode.h:64
rlm_rcode_t
Return codes indicating the result of the module call.
Definition rcode.h:44
@ RLM_MODULE_OK
The module is OK, continue.
Definition rcode.h:49
@ RLM_MODULE_FAIL
Module failed, don't reply.
Definition rcode.h:48
@ RLM_MODULE_NOTFOUND
User not found.
Definition rcode.h:53
@ RLM_MODULE_UPDATED
OK (pairs modified).
Definition rcode.h:55
@ RLM_MODULE_NOOP
Module succeeded without doing anything.
Definition rcode.h:54
#define RETURN_UNLANG_NOOP
Definition rcode.h:69
fr_dict_attr_t const * request_attr_request
Definition request.c:43
fr_dict_attr_t const * request_attr_reply
Definition request.c:44
void * request_data_get(request_t *request, void const *unique_ptr, int unique_int)
Get opaque data from a request.
static char const * name
fr_value_box_t user
Definition rlm_sql.c:240
rlm_sql_t const * inst
Module instance.
Definition rlm_sql.c:229
static int sql_map_verify(CONF_SECTION *cs, UNUSED void const *mod_inst, UNUSED void *proc_inst, tmpl_t const *src, UNUSED map_list_t const *maps)
Definition rlm_sql.c:712
static int mod_detach(module_detach_ctx_t const *mctx)
Definition rlm_sql.c:2090
static unlang_action_t mod_autz_group_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Resume function called after authorization group / profile expansion of check / reply query tmpl.
Definition rlm_sql.c:1294
fr_sql_query_t * query_ctx
Query context.
Definition rlm_sql.c:175
sql_group_ctx_t * group_ctx
Definition rlm_sql.c:1120
rlm_sql_t const * inst
Module instance.
Definition rlm_sql.c:173
sql_redundant_call_env_t * call_env
Call environment data.
Definition rlm_sql.c:232
#define QUERY_ESCAPE
Definition rlm_sql.c:2446
tmpl_t * check_query
Tmpl to expand to form authorize_check_query.
Definition rlm_sql.c:110
static sql_fall_through_t fall_through(map_list_t *maps)
Definition rlm_sql.c:294
rlm_sql_grouplist_t * group
Current group being processed.
Definition rlm_sql.c:193
fr_value_box_t filename
File name to write SQL logs to.
Definition rlm_sql.c:202
static int _sql_map_proc_get_value(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, map_t const *map, void *uctx)
Converts a string value into a fr_pair_t.
Definition rlm_sql.c:685
request_t * request
Request being processed.
Definition rlm_sql.c:230
size_t query_no
Current query number.
Definition rlm_sql.c:233
static const call_env_method_t authorize_method_env
Definition rlm_sql.c:2451
tmpl_t * reply_query
Tmpl to expand to form authorize_reply_query.
Definition rlm_sql.c:111
static int _sql_escape_uxtx_free(void *uctx)
Definition rlm_sql.c:267
static fr_dict_attr_t const * attr_sql_user_name
Definition rlm_sql.c:95
fr_dict_attr_t const * query_number_da
Definition rlm_sql.c:51
static unlang_action_t sql_get_grouplist_resume(unlang_result_t *p_result, request_t *request, void *uctx)
Definition rlm_sql.c:1051
#define SQL_SAFE_FOR
Definition rlm_sql.c:43
static unlang_action_t mod_authorize_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Resume function called after authorization check / reply tmpl expansion.
Definition rlm_sql.c:1527
static int check_map_process(request_t *request, map_list_t *check_map, map_list_t *reply_map)
Process a "check" map.
Definition rlm_sql.c:1230
#define sql_unset_user(_i, _r)
Definition rlm_sql.c:1043
static fr_dict_attr_t const * attr_fall_through
Definition rlm_sql.c:94
static int logfile_call_env_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *cc, call_env_ctx_t const *cec, call_env_parser_t const *rule)
static fr_dict_t const * dict_freeradius
Definition rlm_sql.c:86
static xlat_action_t sql_group_xlat_resume(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
Run SQL query for group membership to return list of groups.
Definition rlm_sql.c:1157
fr_sql_map_ctx_t * map_ctx
Context used for retrieving attribute value pairs as a map list.
Definition rlm_sql.c:196
static xlat_action_t sql_xlat_select_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
Definition rlm_sql.c:487
static void sql_set_user(rlm_sql_t const *inst, request_t *request, fr_value_box_t *user)
Definition rlm_sql.c:1021
rlm_sql_grouplist_t * groups
List of groups retrieved.
Definition rlm_sql.c:176
fr_value_box_t filename
Definition rlm_sql.c:124
static xlat_action_t sql_group_xlat_query_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, fr_value_box_list_t *in)
Compare list of groups returned from SQL query to xlat argument.
Definition rlm_sql.c:1127
static fr_dict_attr_t const * attr_expr_bool_enum
Definition rlm_sql.c:97
fr_value_box_t user
Expansion of the sql_user_name.
Definition rlm_sql.c:109
fr_pair_t * sql_group
Pair to update with group being processed.
Definition rlm_sql.c:194
trunk_t * trunk
Trunk connection for queries.
Definition rlm_sql.c:231
#define SQL_AUTZ_STAGE_PROFILE
Definition rlm_sql.c:168
static xlat_action_t sql_xlat_query_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
Definition rlm_sql.c:446
map_list_t check_tmp
List to store check items before processing.
Definition rlm_sql.c:188
static int submodule_parse(TALLOC_CTX *ctx, void *out, void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
Definition rlm_sql.c:253
static int mod_bootstrap(module_inst_ctx_t const *mctx)
Definition rlm_sql.c:2212
fr_value_box_t * query
Query string used for evaluating group membership.
Definition rlm_sql.c:174
sql_autz_call_env_t * call_env
Call environment data.
Definition rlm_sql.c:187
module_rlm_t rlm_sql
Definition rlm_sql.c:2465
static unlang_action_t mod_authorize(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Start of module authorize method.
Definition rlm_sql.c:1685
static unlang_action_t sql_get_grouplist(unlang_result_t *p_result, sql_group_ctx_t *group_ctx, trunk_t *trunk, request_t *request)
Definition rlm_sql.c:1091
static const call_env_method_t xlat_method_env
Definition rlm_sql.c:127
sql_autz_status_t
Status of the authorization process.
Definition rlm_sql.c:149
@ SQL_AUTZ_PROFILE_REPLY
Running profile reply query.
Definition rlm_sql.c:163
@ SQL_AUTZ_CHECK
Running user check query.
Definition rlm_sql.c:150
@ SQL_AUTZ_GROUP_MEMB_RESUME
Completed group membership query.
Definition rlm_sql.c:155
@ SQL_AUTZ_REPLY
Running user reply query.
Definition rlm_sql.c:152
@ SQL_AUTZ_GROUP_MEMB
Running group membership query.
Definition rlm_sql.c:154
@ SQL_AUTZ_PROFILE_REPLY_RESUME
Completed profile reply query.
Definition rlm_sql.c:164
@ SQL_AUTZ_PROFILE_CHECK_RESUME
Completed profile check query.
Definition rlm_sql.c:162
@ SQL_AUTZ_CHECK_RESUME
Completed user check query.
Definition rlm_sql.c:151
@ SQL_AUTZ_PROFILE_START
Starting processing user profiles.
Definition rlm_sql.c:160
@ SQL_AUTZ_GROUP_REPLY_RESUME
Completed group reply query.
Definition rlm_sql.c:159
@ SQL_AUTZ_REPLY_RESUME
Completed user reply query.
Definition rlm_sql.c:153
@ SQL_AUTZ_GROUP_CHECK
Running group check query.
Definition rlm_sql.c:156
@ SQL_AUTZ_PROFILE_CHECK
Running profile check query.
Definition rlm_sql.c:161
@ SQL_AUTZ_GROUP_REPLY
Running group reply query.
Definition rlm_sql.c:158
@ SQL_AUTZ_GROUP_CHECK_RESUME
Completed group check query.
Definition rlm_sql.c:157
static int sql_xlat_escape(request_t *request, fr_value_box_t *vb, void *uctx)
Escape a tainted VB used as an xlat argument.
Definition rlm_sql.c:328
rlm_sql_t const * inst
Module instance.
Definition rlm_sql.c:183
#define SQL_AUTZ_STAGE_GROUP
Definition rlm_sql.c:167
tmpl_t * group_reply_query
Tmpl to expand to form authorize_group_reply_query.
Definition rlm_sql.c:114
tmpl_t * group_check_query
Tmpl to expand to form authorize_group_check_query.
Definition rlm_sql.c:113
int num_groups
How many groups have been retrieved.
Definition rlm_sql.c:177
static int sql_autz_ctx_free(sql_autz_ctx_t *to_free)
Definition rlm_sql.c:1268
trunk_t * trunk
Trunk connection for current authorization.
Definition rlm_sql.c:186
fr_value_box_t * query_vb
Current query string.
Definition rlm_sql.c:235
fr_value_box_list_t query
Where expanded query tmpl will be written.
Definition rlm_sql.c:234
map_list_t reply_tmp
List to store reply items before processing.
Definition rlm_sql.c:189
sql_autz_status_t status
Current status of the authorization.
Definition rlm_sql.c:190
request_t * request
Request being processed.
Definition rlm_sql.c:184
fr_pair_t * profile
Current profile being processed.
Definition rlm_sql.c:195
#define MAX_SQL_FIELD_INDEX
Definition rlm_sql.c:724
fr_dict_attr_autoload_t rlm_sql_dict_attr[]
Definition rlm_sql.c:100
fr_value_box_list_t query
Definition rlm_sql.c:1119
static int mod_thread_instantiate(module_thread_inst_ctx_t const *mctx)
Initialise thread specific data structure.
Definition rlm_sql.c:2385
static void * sql_escape_uctx_alloc(UNUSED request_t *request, void const *uctx)
Definition rlm_sql.c:276
static unlang_action_t mod_sql_redundant(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Generic module call for failing between a bunch of queries.
Definition rlm_sql.c:1891
fr_sql_query_t * query_ctx
Query context for current query.
Definition rlm_sql.c:236
static unlang_action_t mod_sql_redundant_query_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Resume function called after executing an SQL query in a redundant list of queries.
Definition rlm_sql.c:1772
rlm_rcode_t rcode
Module return code.
Definition rlm_sql.c:185
tmpl_t ** query
Array of tmpls for list of queries to run.
Definition rlm_sql.c:203
rlm_sql_grouplist_t * next
Definition rlm_sql.c:1048
static int sql_escape_func(UNUSED request_t *request, fr_value_box_t *vb, void *arg)
Default escape function for drivers which do not provide their own.
Definition rlm_sql.c:926
static const call_env_method_t accounting_method_env
Definition rlm_sql.c:206
static int sql_redundant_ctx_free(sql_redundant_ctx_t *to_free)
Tidy up when freeing an SQL redundant context.
Definition rlm_sql.c:1755
static const call_env_method_t group_xlat_method_env
Definition rlm_sql.c:244
sql_group_ctx_t * group_ctx
Context used for retrieving user group membership.
Definition rlm_sql.c:197
tmpl_t * membership_query
Tmpl to expand to form group_membership_query.
Definition rlm_sql.c:112
static int sql_box_escape(fr_value_box_t *vb, void *uctx)
Definition rlm_sql.c:413
static const conf_parser_t module_config[]
Definition rlm_sql.c:54
fr_value_box_list_t query
Where expanded query tmpls will be written.
Definition rlm_sql.c:191
bool user_found
Has the user been found anywhere?
Definition rlm_sql.c:192
static fr_dict_attr_t const * attr_user_profile
Definition rlm_sql.c:96
static const call_env_method_t send_method_env
Definition rlm_sql.c:216
fr_dict_autoload_t rlm_sql_dict[]
Definition rlm_sql.c:89
fr_dict_attr_t const * group_da
Definition rlm_sql.c:50
static int mod_thread_detach(module_thread_inst_ctx_t const *mctx)
Definition rlm_sql.c:2404
static unlang_action_t mod_map_resume(unlang_result_t *p_result, map_ctx_t const *mpctx, request_t *request, UNUSED fr_value_box_list_t *query, map_list_t const *maps)
Process the results of an SQL map query.
Definition rlm_sql.c:738
static int mod_instantiate(module_inst_ctx_t const *mctx)
Definition rlm_sql.c:2107
fr_value_box_t user
Expansion of sql_user_name.
Definition rlm_sql.c:201
static int query_call_env_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *cc, call_env_ctx_t const *cec, call_env_parser_t const *rule)
static unlang_action_t mod_map_proc(unlang_result_t *p_result, map_ctx_t const *mpctx, request_t *request, fr_value_box_list_t *query, UNUSED map_list_t const *maps)
Executes a SELECT query and maps the result to server attributes.
Definition rlm_sql.c:876
static int sql_call_env_parse(TALLOC_CTX *ctx, void *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
Custom parser for sql call env queries.
Definition rlm_sql.c:2418
static unlang_action_t mod_sql_redundant_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Resume function called after expansion of next query in a redundant list of queries.
Definition rlm_sql.c:1860
Context for SQL authorization.
Definition rlm_sql.c:182
Context for group membership query evaluation.
Definition rlm_sql.c:172
Context for tracking redundant SQL query sets.
Definition rlm_sql.c:228
Prototypes and functions for the SQL module.
fr_sql_query_t * fr_sql_query_alloc(TALLOC_CTX *ctx, rlm_sql_t const *inst, request_t *request, trunk_t *trunk, char const *query_str, fr_sql_query_type_t type)
Allocate an sql query structure.
Definition sql.c:183
trunk_t * trunk
Trunk connection for this thread.
Definition rlm_sql.h:114
rlm_sql_t const * inst
Module instance data.
Definition rlm_sql.h:115
#define RLM_SQL_MULTI_QUERY_CONN
Can support multiple queries on a single connection.
Definition rlm_sql.h:173
fr_sql_query_type_t type
Type of query.
Definition rlm_sql.h:143
unlang_action_t sql_get_map_list(unlang_result_t *p_result, request_t *request, fr_sql_map_ctx_t *map_ctx, trunk_t *trunk)
Submit the query to get any user / group check or reply pairs.
Definition sql.c:357
unlang_action_t rlm_sql_fetch_row(unlang_result_t *p_result, request_t *request, void *uctx)
Call the driver's sql_fetch_row function.
Definition sql.c:79
void rlm_sql_query_log(rlm_sql_t const *inst, char const *filename, char const *query)
Definition sql.c:387
rlm_sql_t const * inst
Module instance for this query.
Definition rlm_sql.h:137
sql_rcode_t
Action to take at end of an SQL query.
Definition rlm_sql.h:44
@ RLM_SQL_QUERY_INVALID
Query syntax error.
Definition rlm_sql.h:45
@ RLM_SQL_ALT_QUERY
Key constraint violation, use an alternative query.
Definition rlm_sql.h:49
@ RLM_SQL_RECONNECT
Stale connection, should reconnect.
Definition rlm_sql.h:48
@ RLM_SQL_ERROR
General connection/server error.
Definition rlm_sql.h:46
@ RLM_SQL_OK
Success.
Definition rlm_sql.h:47
@ RLM_SQL_NO_MORE_ROWS
No more rows available.
Definition rlm_sql.h:50
@ SQL_QUERY_SELECT
Definition rlm_sql.h:120
@ SQL_QUERY_OTHER
Definition rlm_sql.h:121
TALLOC_CTX * ctx
To allocate map entries in.
Definition rlm_sql.h:153
void * sql_escape_arg
Thread specific argument to be passed to escape function.
Definition rlm_sql.h:116
sql_fall_through_t
Definition rlm_sql.h:53
@ FALL_THROUGH_DEFAULT
Definition rlm_sql.h:56
@ FALL_THROUGH_YES
Definition rlm_sql.h:55
char ** rlm_sql_row_t
Definition rlm_sql.h:59
void rlm_sql_print_error(rlm_sql_t const *inst, request_t *request, fr_sql_query_t *query_ctx, bool force_debug)
Retrieve any errors from the SQL driver.
Definition sql.c:122
rlm_sql_row_t row
Row data from the last query.
Definition rlm_sql.h:146
sql_rcode_t rcode
Result code.
Definition rlm_sql.h:145
rlm_sql_t const * sql
Definition rlm_sql.h:197
fr_table_num_sorted_t const sql_rcode_description_table[]
Definition sql.c:45
unlang_action_t rlm_sql_trunk_query(unlang_result_t *p_result, request_t *request, void *uctx)
Submit an SQL query using a trunk connection.
Definition sql.c:243
Context used when fetching attribute value pairs as a map list.
Definition rlm_sql.h:152
#define FR_SBUFF_IN(_start, _len_or_end)
static char const * section_name_str(char const *name)
Return a printable string for the section name.
Definition section.h:97
#define SECTION_NAME(_name1, _name2)
Define a section name consisting of a verb and a noun.
Definition section.h:39
char const * name2
Second section name. Usually a packet type like 'access-request', 'access-accept',...
Definition section.h:45
char const * name1
First section name. Usually a verb like 'recv', 'send', etc...
Definition section.h:44
char const * name
Instance name e.g. user_database.
Definition module.h:357
CONF_SECTION * conf
Module's instance configuration.
Definition module.h:351
void * data
Module's instance data.
Definition module.h:293
void * boot
Data allocated during the boostrap phase.
Definition module.h:296
void * data
Thread specific instance data.
Definition module.h:374
static module_thread_instance_t * module_thread(module_instance_t const *mi)
Retrieve module/thread specific instance for a module.
Definition module.h:503
#define MODULE_BINDING_TERMINATOR
Terminate a module binding list.
Definition module.h:152
size_t boot_size
Size of the module's bootstrap data.
Definition module.h:209
module_t * exported
Public module structure.
Definition module.h:298
Module instance data.
Definition module.h:287
Named methods exported by a module.
Definition module.h:174
#define pair_append_control(_attr, _da)
Allocate and append a fr_pair_t to the control list.
Definition pair.h:57
#define pair_delete_request(_pair_or_da)
Delete a fr_pair_t in the request list.
Definition pair.h:172
#define pair_update_control(_attr, _da)
Return or allocate a fr_pair_t in the control list.
Definition pair.h:140
tmpl_escape_t escape
How escaping should be handled during evaluation.
Definition tmpl.h:353
int tmpl_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules))
Attempt to resolve functions and attributes in xlats and attribute references.
#define tmpl_value(_tmpl)
Definition tmpl.h:937
fr_value_box_safe_for_t literals_safe_for
safe_for value assigned to literal values in xlats, execs, and data.
Definition tmpl.h:351
#define tmpl_is_attr(vpt)
Definition tmpl.h:208
ssize_t tmpl_afrom_substr(TALLOC_CTX *ctx, tmpl_t **out, fr_sbuff_t *in, fr_token_t quote, fr_sbuff_parse_rules_t const *p_rules, tmpl_rules_t const *t_rules))
Convert an arbitrary string into a tmpl_t.
#define tmpl_is_data(vpt)
Definition tmpl.h:206
#define tmpl_expand(_out, _buff, _buff_len, _request, _vpt)
Expand a tmpl to a C type, using existing storage to hold variably sized types.
Definition tmpl.h:1054
#define tmpl_value_type(_tmpl)
Definition tmpl.h:939
tmpl_attr_rules_t attr
Rules/data for parsing attribute references.
Definition tmpl.h:339
static fr_dict_attr_t const * tmpl_attr_tail_da(tmpl_t const *vpt)
Return the last attribute reference da.
Definition tmpl.h:801
#define tmpl_needs_resolving(vpt)
Definition tmpl.h:223
Similar to tmpl_rules_t, but used to specify parameters that may change during subsequent resolution ...
Definition tmpl.h:368
Optional arguments passed to vp_tmpl functions.
Definition tmpl.h:336
#define fr_skip_whitespace(_p)
Skip whitespace ('\t', '\n', '\v', '\f', '\r', ' ')
Definition skip.h:36
PUBLIC int snprintf(char *string, size_t length, char *format, va_alist)
Definition snprintf.c:689
return count
Definition module.c:155
int module_instantiate(module_instance_t *instance)
Manually complete module setup by calling its instantiate function.
Definition module.c:1224
unlang_action_t unlang_module_yield(request_t *request, module_method_t resume, unlang_module_signal_t signal, fr_signal_t sigmask, void *rctx)
Yield a request back to the interpreter from within a module.
Definition module.c:431
unlang_action_t unlang_module_yield_to_tmpl(TALLOC_CTX *ctx, fr_value_box_list_t *out, request_t *request, tmpl_t const *vpt, unlang_tmpl_args_t *args, module_method_t resume, unlang_module_signal_t signal, fr_signal_t sigmask, void *rctx)
Push a pre-compiled tmpl and resumption state onto the stack for evaluation.
Definition module.c:216
eap_aka_sim_process_conf_t * inst
fr_pair_value_bstrdup_buffer(vp, eap_session->identity, true)
fr_pair_t * vp
eap_type_t type
The preferred EAP-Type of this instance of the EAP-SIM/AKA/AKA' state machine.
Value pair map.
Definition map.h:77
fr_token_t op
The operator that controls insertion of the dst attribute.
Definition map.h:82
tmpl_t * lhs
Typically describes the attribute to add, modify or compare.
Definition map.h:78
tmpl_t * rhs
Typically describes a literal value or a src attribute to copy or compare.
Definition map.h:79
void * sql_escape_arg
Instance specific argument to be passed to escape function.
Definition rlm_sql.h:239
fr_dict_t const * dict_def
Default dictionary to use with unqualified attribute references.
Definition tmpl.h:273
Stores an attribute, a value and various bits of other data.
Definition pair.h:68
fr_dict_attr_t const *_CONST da
Dictionary attribute defines the attribute number, vendor and type of the pair.
Definition pair.h:69
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:804
#define talloc_get_type_abort_const
Definition talloc.h:117
#define talloc_strdup(_ctx, _str)
Definition talloc.h:149
static size_t talloc_strlen(char const *s)
Returns the length of a talloc array containing a string.
Definition talloc.h:143
static fr_time_delta_t fr_time_delta_from_sec(int64_t sec)
Definition time.h:590
int unlang_tmpl_push(TALLOC_CTX *ctx, unlang_result_t *p_result, fr_value_box_list_t *out, request_t *request, tmpl_t const *tmpl, unlang_tmpl_args_t *args, bool top_frame)
Push a tmpl onto the stack for evaluation.
Definition tmpl.c:276
@ TMPL_ESCAPE_UCTX_ALLOC_FUNC
A new uctx of the specified size and type is allocated and pre-populated by memcpying uctx....
Definition tmpl_escape.h:35
fr_value_box_escape_t box_escape
How to escape when returned from evaluation.
Definition tmpl_escape.h:81
@ TMPL_ESCAPE_PRE_CONCAT
Pre-concatenation escaping is useful for DSLs where elements of the expansion are static,...
Definition tmpl_escape.h:61
struct tmpl_escape_t::@75 uctx
tmpl_escape_mode_t mode
Whether to apply escape function after concatenation, i.e.
Definition tmpl_escape.h:83
Escaping rules for tmpls.
Definition tmpl_escape.h:80
const bool fr_assignment_op[T_TOKEN_LAST]
Definition token.c:236
char const * fr_tokens[T_TOKEN_LAST]
Definition token.c:146
const bool fr_comparison_op[T_TOKEN_LAST]
Definition token.c:266
@ T_OP_CMP_TRUE
Definition token.h:102
@ T_OP_CMP_FALSE
Definition token.h:103
int module_trigger_args_build(TALLOC_CTX *ctx, fr_pair_list_t *list, CONF_SECTION const *cs, module_trigger_args_t *args)
Build trigger args pair list for modules.
Definition trigger.c:497
Common values used by modules when building trigger args.
Definition trigger.h:42
trunk_t * trunk_alloc(TALLOC_CTX *ctx, fr_event_list_t *el, trunk_io_funcs_t const *funcs, trunk_conf_t const *conf, char const *log_prefix, void const *uctx, bool delay_start, fr_pair_list_t *trigger_args)
Allocate a new collection of connections.
Definition trunk.c:5001
conf_parser_t const trunk_config[]
Config parser definitions to populate a trunk_conf_t.
Definition trunk.c:341
Main trunk management handle.
Definition trunk.c:215
static int expand_rhs(request_t *request, unlang_frame_state_edit_t *state, edit_map_t *current)
Definition edit.c:1193
xlat_action_t unlang_xlat_yield(request_t *request, xlat_func_t resume, xlat_func_signal_t signal, fr_signal_t sigmask, void *rctx)
Yield a request back to the interpreter from within a module.
Definition xlat.c:543
fr_type_t type
Type to cast argument to.
Definition xlat.h:155
xlat_action_t xlat_transparent(UNUSED TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *args)
#define XLAT_ARG_PARSER_TERMINATOR
Definition xlat.h:170
xlat_action_t
Definition xlat.h:37
@ XLAT_ACTION_FAIL
An xlat function failed.
Definition xlat.h:44
@ XLAT_ACTION_YIELD
An xlat function pushed a resume frame onto the stack.
Definition xlat.h:42
@ XLAT_ACTION_PUSH_UNLANG
An xlat function pushed an unlang frame onto the unlang stack.
Definition xlat.h:39
@ XLAT_ACTION_DONE
We're done evaluating this level of nesting.
Definition xlat.h:43
Definition for a single argument consumed by an xlat function.
Definition xlat.h:145
static fr_slen_t parent
Definition pair.h:858
#define fr_type_is_structural(_x)
Definition types.h:392
#define FR_TYPE_IP
Definition types.h:308
static char const * fr_type_to_str(fr_type_t type)
Return a static string containing the type name.
Definition types.h:454
#define FR_TYPE_NUMERIC
Definition types.h:306
fr_sbuff_parse_rules_t const * value_parse_rules_quoted[T_TOKEN_LAST]
Parse rules for quoted strings.
Definition value.c:611
int fr_value_box_cast_in_place(TALLOC_CTX *ctx, fr_value_box_t *vb, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv)
Convert one type of fr_value_box_t to another in place.
Definition value.c:4196
void fr_value_box_clear_value(fr_value_box_t *data)
Clear/free any existing value.
Definition value.c:4331
int fr_value_box_strdup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Copy a nul terminated string to a fr_value_box_t.
Definition value.c:4619
void fr_value_box_strdup_shallow_replace(fr_value_box_t *vb, char const *src, ssize_t len)
Free the existing buffer (if talloced) associated with the valuebox, and replace it with a new one.
Definition value.c:4745
int fr_value_box_list_concat_in_place(TALLOC_CTX *ctx, fr_value_box_t *out, fr_value_box_list_t *list, fr_type_t type, fr_value_box_list_action_t proc_action, bool flatten, size_t max_size)
Concatenate a list of value boxes.
Definition value.c:6604
@ FR_VALUE_BOX_LIST_FREE
Definition value.h:238
#define fr_value_box_alloc(_ctx, _type, _enumv)
Allocate a value box of a specific type.
Definition value.h:644
#define fr_value_box_mark_safe_for(_box, _safe_for)
Definition value.h:1093
#define fr_box_strvalue_buffer(_val)
Definition value.h:312
#define fr_value_box_is_safe_for(_box, _safe_for)
Definition value.h:1100
fr_value_box_safe_for_t safe_for
Definition value.h:678
uintptr_t fr_value_box_safe_for_t
Escaping that's been applied to a value box.
Definition value.h:162
int nonnull(2, 5))
#define fr_value_box_alloc_null(_ctx)
Allocate a value box for later use with a value assignment function.
Definition value.h:655
fr_value_box_escape_func_t func
Definition value.h:677
static size_t char ** out
Definition value.h:1030
static TALLOC_CTX * xlat_ctx
void * rctx
Resume context.
Definition xlat_ctx.h:54
void * env_data
Expanded call env data.
Definition xlat_ctx.h:53
module_ctx_t const * mctx
Synthesised module calling ctx.
Definition xlat_ctx.h:52
An xlat calling ctx.
Definition xlat_ctx.h:49
void xlat_func_flags_set(xlat_t *x, xlat_func_flags_t flags)
Specify flags that alter the xlat's behaviour.
Definition xlat_func.c:390
int xlat_func_args_set(xlat_t *x, xlat_arg_parser_t const args[])
Register the arguments of an xlat.
Definition xlat_func.c:363
void xlat_func_call_env_set(xlat_t *x, call_env_method_t const *env_method)
Register call environment of an xlat.
Definition xlat_func.c:380
#define xlat_func_safe_for_set(_xlat, _escaped)
Set the escaped values for output boxes.
Definition xlat_func.h:82
@ XLAT_FUNC_FLAG_PURE
Definition xlat_func.h:38