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