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