The FreeRADIUS server $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
Loading...
Searching...
No Matches
rlm_ldap.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: 238019feee0452afdfcac87b9d5225baa6232f6f $
19 * @file rlm_ldap.c
20 * @brief LDAP authorization and authentication module.
21 *
22 * @author Arran Cudbard-Bell (a.cudbardb@freeradius.org)
23 * @author Alan DeKok (aland@freeradius.org)
24 *
25 * @copyright 2012,2015 Arran Cudbard-Bell (a.cudbardb@freeradius.org)
26 * @copyright 2013,2015 Network RADIUS SAS (legal@networkradius.com)
27 * @copyright 2012 Alan DeKok (aland@freeradius.org)
28 * @copyright 1999-2013 The FreeRADIUS Server Project.
29 */
30RCSID("$Id: 238019feee0452afdfcac87b9d5225baa6232f6f $")
31
33
34#include <freeradius-devel/util/debug.h>
35#include <freeradius-devel/util/table.h>
36#include <freeradius-devel/util/uri.h>
37#include <freeradius-devel/util/value.h>
38
39#include <freeradius-devel/ldap/conf.h>
40#include <freeradius-devel/ldap/base.h>
41
42#include <freeradius-devel/server/map_proc.h>
43#include <freeradius-devel/server/module_rlm.h>
44#include <freeradius-devel/server/rcode.h>
45
46#include <freeradius-devel/unlang/xlat_func.h>
47#include <freeradius-devel/unlang/action.h>
48#include <freeradius-devel/unlang/map.h>
49
50#include <ldap.h>
51#include "rlm_ldap.h"
52
57
66
67typedef struct {
68 char const *attr;
70 tmpl_t const *tmpl;
77
78/** Call environment used in the profile xlat
79 */
80typedef struct {
81 fr_value_box_t profile_filter; //!< Filter to use when searching for users.
82 map_list_t *profile_map; //!< List of maps to apply to the profile.
84
85static int ldap_update_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, call_env_ctx_t const *cec, call_env_parser_t const *rule);
86static int ldap_mod_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, call_env_ctx_t const *cec, call_env_parser_t const *rule);
87
88static int ldap_group_filter_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);
89
97
99 { FR_CONF_OFFSET("scope", rlm_ldap_t, profile.obj_scope), .dflt = "base",
100 .func = cf_table_parse_int, .uctx = &(cf_table_parse_ctx_t){ .table = fr_ldap_scope, .len = &fr_ldap_scope_len } },
101 { FR_CONF_OFFSET("attribute", rlm_ldap_t, profile.attr) },
102 { FR_CONF_OFFSET("attribute_suspend", rlm_ldap_t, profile.attr_suspend) },
103 { FR_CONF_OFFSET("check_attribute", rlm_ldap_t, profile.check_attr) },
104 { FR_CONF_OFFSET("sort_by", rlm_ldap_t, profile.obj_sort_by) },
105 { FR_CONF_OFFSET("fallthrough_attribute", rlm_ldap_t, profile.fallthrough_attr) },
106 { FR_CONF_OFFSET("fallthrough_default", rlm_ldap_t, profile.fallthrough_def), .dflt = "yes" },
108};
109
110/*
111 * User configuration
112 */
114 { FR_CONF_OFFSET("scope", rlm_ldap_t, user.obj_scope), .dflt = "sub",
115 .func = cf_table_parse_int, .uctx = &(cf_table_parse_ctx_t){ .table = fr_ldap_scope, .len = &fr_ldap_scope_len } },
116 { FR_CONF_OFFSET("sort_by", rlm_ldap_t, user.obj_sort_by) },
117
118 { FR_CONF_OFFSET("access_attribute", rlm_ldap_t, user.obj_access_attr) },
119 { FR_CONF_OFFSET("access_positive", rlm_ldap_t, user.access_positive), .dflt = "yes" },
120 { FR_CONF_OFFSET("access_value_negate", rlm_ldap_t, user.access_value_negate), .dflt = "false" },
121 { FR_CONF_OFFSET("access_value_suspend", rlm_ldap_t, user.access_value_suspend), .dflt = "suspended" },
122 { FR_CONF_OFFSET_IS_SET("expect_password", FR_TYPE_BOOL, 0, rlm_ldap_t, user.expect_password) },
124};
125
126/*
127 * Group configuration
128 */
130 { FR_CONF_OFFSET("filter", rlm_ldap_t, group.obj_filter) },
131 { FR_CONF_OFFSET("scope", rlm_ldap_t, group.obj_scope), .dflt = "sub",
132 .func = cf_table_parse_int, .uctx = &(cf_table_parse_ctx_t){ .table = fr_ldap_scope, .len = &fr_ldap_scope_len } },
133
134 { FR_CONF_OFFSET("name_attribute", rlm_ldap_t, group.obj_name_attr), .dflt = "cn" },
135 { FR_CONF_OFFSET("membership_attribute", rlm_ldap_t, group.userobj_membership_attr) },
136 { FR_CONF_OFFSET_FLAGS("membership_filter", CONF_FLAG_XLAT, rlm_ldap_t, group.obj_membership_filter) },
137 { FR_CONF_OFFSET("cacheable_name", rlm_ldap_t, group.cacheable_name), .dflt = "no" },
138 { FR_CONF_OFFSET("cacheable_dn", rlm_ldap_t, group.cacheable_dn), .dflt = "no" },
139 { FR_CONF_OFFSET("cache_attribute", rlm_ldap_t, group.cache_attribute) },
140 { FR_CONF_OFFSET("group_attribute", rlm_ldap_t, group.attribute) },
141 { FR_CONF_OFFSET("allow_dangling_group_ref", rlm_ldap_t, group.allow_dangling_refs), .dflt = "no" },
142 { FR_CONF_OFFSET("skip_on_suspend", rlm_ldap_t, group.skip_on_suspend), .dflt = "yes"},
144};
145
146static const conf_parser_t module_config[] = {
147 /*
148 * Pool config items
149 */
150 { FR_CONF_OFFSET_FLAGS("server", CONF_FLAG_MULTI, rlm_ldap_t, handle_config.server_str) }, /* Do not set to required */
151
152 /*
153 * Common LDAP conf parsers
154 */
156
157 { FR_CONF_OFFSET("valuepair_attribute", rlm_ldap_t, valuepair_attr) },
158
159#ifdef LDAP_CONTROL_X_SESSION_TRACKING
160 { FR_CONF_OFFSET("session_tracking", rlm_ldap_t, session_tracking), .dflt = "no" },
161#endif
162
163#ifdef WITH_EDIR
164 /* support for eDirectory Universal Password */
165 { FR_CONF_OFFSET("edir", rlm_ldap_t, edir) }, /* NULL defaults to "no" */
166
167 /*
168 * Attempt to bind with the cleartext password we got from eDirectory
169 * Universal password for additional authorization checks.
170 */
171 { FR_CONF_OFFSET("edir_autz", rlm_ldap_t, edir_autz) }, /* NULL defaults to "no" */
172#endif
173
174 { FR_CONF_POINTER("user", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) user_config },
175
176 { FR_CONF_POINTER("group", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) group_config },
177
178 { FR_CONF_POINTER("profile", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) profile_config },
179
180 { FR_CONF_OFFSET_SUBSECTION("pool", 0, rlm_ldap_t, trunk_conf, trunk_config ) },
181
182 { FR_CONF_OFFSET_SUBSECTION("bind_pool", 0, rlm_ldap_t, bind_trunk_conf, trunk_config ) },
183
185};
186
187#define USER_CALL_ENV_COMMON(_struct) \
188 { FR_CALL_ENV_OFFSET("base_dn", FR_TYPE_STRING, CALL_ENV_FLAG_REQUIRED | CALL_ENV_FLAG_CONCAT, _struct, user_base), .pair.dflt = "", .pair.dflt_quote = T_SINGLE_QUOTED_STRING }, \
189 { FR_CALL_ENV_OFFSET("filter", FR_TYPE_STRING, CALL_ENV_FLAG_NULLABLE | CALL_ENV_FLAG_CONCAT, _struct, user_filter), .pair.dflt = "(&)", .pair.dflt_quote = T_SINGLE_QUOTED_STRING }
190
206
207/** Parameters to allow ldap_update_section_parse to be reused
208 */
213
216 .env = (call_env_parser_t[]) {
219 .map_offset = offsetof(ldap_autz_call_env_t, user_map),
220 .expect_password_offset = offsetof(ldap_autz_call_env_t, expect_password)
221 } },
223 ((call_env_parser_t[]) {
226 })) },
228 ((call_env_parser_t[]) {
231 .pair.func = ldap_group_filter_parse,
232 .pair.escape = {
233 .box_escape = {
234 .func = fr_ldap_box_escape,
236 .always_escape = false,
237 },
239 },
240 .pair.literals_safe_for = (fr_value_box_safe_for_t)fr_ldap_box_escape,
241 },
243 })) },
245 ((call_env_parser_t[]) {
248 .pair.dflt = "(&)", .pair.dflt_quote = T_SINGLE_QUOTED_STRING }, //!< Correct filter for when the DN is known.
250 } )) },
252 }
253};
254
255#define USERMOD_ENV(_section) static const call_env_method_t _section ## _usermod_method_env = { \
256 FR_CALL_ENV_METHOD_OUT(ldap_usermod_call_env_t), \
257 .env = (call_env_parser_t[]) { \
258 { FR_CALL_ENV_SUBSECTION("user", NULL, CALL_ENV_FLAG_REQUIRED, \
259 ((call_env_parser_t[]) { \
260 USER_CALL_ENV_COMMON(ldap_usermod_call_env_t), CALL_ENV_TERMINATOR \
261 })) }, \
262 { FR_CALL_ENV_SUBSECTION_FUNC(STRINGIFY(_section), CF_IDENT_ANY, CALL_ENV_FLAG_SUBSECTION | CALL_ENV_FLAG_PARSE_MISSING, ldap_mod_section_parse) }, \
263 CALL_ENV_TERMINATOR \
264 } \
265}
266
267USERMOD_ENV(accounting);
269
272 .env = (call_env_parser_t[]) {
274 ((call_env_parser_t[]) {
277 })) },
279 ((call_env_parser_t[]) {
282 .pair.func = ldap_group_filter_parse,
283 .pair.escape = {
284 .box_escape = {
285 .func = fr_ldap_box_escape,
287 .always_escape = false,
288 },
290 },
291 .pair.literals_safe_for = (fr_value_box_safe_for_t)fr_ldap_box_escape,
292 },
294 })) },
296 }
297};
298
301 .env = (call_env_parser_t[]) {
304 .map_offset = offsetof(ldap_xlat_profile_call_env_t, profile_map),
305 .expect_password_offset = -1
306 } },
308 ((call_env_parser_t[]) {
310 .pair.dflt = "(&)", .pair.dflt_quote = T_SINGLE_QUOTED_STRING }, //!< Correct filter for when the DN is known.
312 })) },
314 }
315};
316
318
321 { .out = &dict_freeradius, .proto = "freeradius" },
322 { NULL }
323};
324
332
335 { .out = &attr_password, .name = "Password", .type = FR_TYPE_TLV, .dict = &dict_freeradius },
336 { .out = &attr_cleartext_password, .name = "Password.Cleartext", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
337 { .out = &attr_crypt_password, .name = "Password.Crypt", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
338 { .out = &attr_ldap_userdn, .name = "LDAP-UserDN", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
339 { .out = &attr_nt_password, .name = "Password.NT", .type = FR_TYPE_OCTETS, .dict = &dict_freeradius },
340 { .out = &attr_password_with_header, .name = "Password.With-Header", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
341 { .out = &attr_expr_bool_enum, .name = "Expr-Bool-Enum", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
342
343 { NULL }
344};
345
346extern global_lib_autoinst_t const *rlm_ldap_lib[];
351
352/** Holds state of in progress async authentication
353 *
354 */
362
363/** Holds state of in progress ldap user modifications
364 *
365 */
379
380/** Holds state of in progress LDAP map
381 *
382 */
383typedef struct {
384 map_list_t const *maps;
385 LDAPURLDesc *ldap_url;
388 LDAPControl *serverctrls[LDAP_MAX_CONTROLS];
390
396
398 { L("ldap://"), LDAP_SCHEME_UNIX },
399 { L("ldapi://"), LDAP_SCHEME_TCP },
400 { L("ldaps://"), LDAP_SCHEME_TCP_SSL },
401};
403
404/** This is the common function that actually ends up doing all the URI escaping
405 */
406#define LDAP_URI_SAFE_FOR (fr_value_box_safe_for_t)fr_ldap_uri_escape_func
407
409 { .required = true, .concat = true, .type = FR_TYPE_STRING },
411};
412
414 { .required = true, .concat = true, .type = FR_TYPE_STRING },
416};
417
418/** Escape LDAP string
419 *
420 * @ingroup xlat_functions
421 */
423 UNUSED xlat_ctx_t const *xctx,
424 request_t *request, fr_value_box_list_t *in)
425{
426 fr_value_box_t *vb, *in_vb = fr_value_box_list_head(in);
427 fr_sbuff_t sbuff;
428 fr_sbuff_uctx_talloc_t sbuff_ctx;
429 size_t len;
430
431 MEM(vb = fr_value_box_alloc_null(ctx));
432
433 /*
434 * If it's already safe, just copy it over.
435 */
437 fr_value_box_copy(vb, vb, in_vb);
438
440 return XLAT_ACTION_DONE;
441 }
442
443 /*
444 * Maximum space needed for output would be 3 times the input if every
445 * char needed escaping
446 */
447 if (!fr_sbuff_init_talloc(vb, &sbuff, &sbuff_ctx, in_vb->vb_length * 3, in_vb->vb_length * 3)) {
448 REDEBUG("Failed to allocate buffer for escaped string");
449 talloc_free(vb);
450 return XLAT_ACTION_FAIL;
451 }
452
453 /*
454 * Call the escape function, including the space for the trailing NULL
455 */
456 len = fr_ldap_uri_escape_func(request, fr_sbuff_buff(&sbuff), in_vb->vb_length * 3 + 1, in_vb->vb_strvalue, NULL);
457
458 /*
459 * Trim buffer to fit used space and assign to box
460 */
461 fr_sbuff_trim_talloc(&sbuff, len);
462 fr_value_box_strdup_shallow(vb, NULL, fr_sbuff_buff(&sbuff), in_vb->tainted);
463
465 return XLAT_ACTION_DONE;
466}
467
469 { .required = true, .concat = true, .type = FR_TYPE_STRING },
471};
472
473/** Unescape LDAP string
474 *
475 * @ingroup xlat_functions
476 */
478 UNUSED xlat_ctx_t const *xctx,
479 request_t *request, fr_value_box_list_t *in)
480{
481 fr_value_box_t *vb, *in_vb = fr_value_box_list_head(in);
482 fr_sbuff_t sbuff;
483 fr_sbuff_uctx_talloc_t sbuff_ctx;
484 size_t len;
485
486 MEM(vb = fr_value_box_alloc_null(ctx));
487 /*
488 * Maximum space needed for output will be the same as the input
489 */
490 if (!fr_sbuff_init_talloc(vb, &sbuff, &sbuff_ctx, in_vb->vb_length, in_vb->vb_length)) {
491 REDEBUG("Failed to allocate buffer for unescaped string");
492 talloc_free(vb);
493 return XLAT_ACTION_FAIL;
494 }
495
496 /*
497 * Call the unescape function, including the space for the trailing NULL
498 */
499 len = fr_ldap_uri_unescape_func(request, fr_sbuff_buff(&sbuff), in_vb->vb_length + 1, in_vb->vb_strvalue, NULL);
500
501 /*
502 * Trim buffer to fit used space and assign to box
503 */
504 fr_sbuff_trim_talloc(&sbuff, len);
505 fr_value_box_strdup_shallow(vb, NULL, fr_sbuff_buff(&sbuff), in_vb->tainted);
507
508 return XLAT_ACTION_DONE;
509}
510
511/** Escape function for a part of an LDAP URI
512 *
513 */
514static int ldap_uri_part_escape(fr_value_box_t *vb, UNUSED void *uctx)
515{
516 fr_sbuff_t sbuff;
517 fr_sbuff_uctx_talloc_t sbuff_ctx;
518 size_t len;
519
520 /*
521 * Maximum space needed for output would be 3 times the input if every
522 * char needed escaping
523 */
524 if (!fr_sbuff_init_talloc(vb, &sbuff, &sbuff_ctx, vb->vb_length * 3, vb->vb_length * 3)) {
525 fr_strerror_printf_push("Failed to allocate buffer for escaped argument");
526 return -1;
527 }
528
529 /*
530 * Call the escape function, including the space for the trailing NULL
531 */
532 len = fr_ldap_uri_escape_func(NULL, fr_sbuff_buff(&sbuff), vb->vb_length * 3 + 1, vb->vb_strvalue, NULL);
533
534 fr_sbuff_trim_talloc(&sbuff, len);
536
537 return 0;
538}
539
540/** Callback when LDAP query times out
541 *
542 */
544{
545 fr_ldap_query_t *query = talloc_get_type_abort(uctx, fr_ldap_query_t);
546 trunk_request_t *treq;
547 request_t *request;
548
549 /*
550 * If the trunk request has completed but the query
551 * has not yet resumed, query->treq will be NULL
552 */
553 if (!query->treq) return;
554
555 treq = talloc_get_type_abort(query->treq, trunk_request_t);
556 request = treq->request;
557
558 ROPTIONAL(RERROR, ERROR, "Timeout waiting for LDAP query");
559
561
562 query->ret = LDAP_RESULT_TIMEOUT;
564}
565
567 { .required = true, .concat = true, .type = FR_TYPE_STRING },
568 { .required = true, .concat = true, .type = FR_TYPE_STRING },
570};
571
572/** Modify an LDAP URI to append an option to all attributes
573 *
574 * This is for the corner case where a URI is provided by a third party system
575 * and needs amending before being used. e.g. a CRL distribution point extracted
576 * from a certificate may need the "binary" option appending to the attribute
577 * being requested.
578 *
579 * @ingroup xlat_functions
580 */
582 request_t *request, fr_value_box_list_t *in)
583{
584 fr_value_box_t *uri, *option_vb;
585 char *attrs_fixed, **attr, port[6];
586 char const *option;
587 LDAPURLDesc *ldap_url;
588 fr_value_box_t *vb;
589 int ret;
590
591 XLAT_ARGS(in, &uri, &option_vb);
592
593#ifdef STATIC_ANALYZER
594 if (!option_vb) return XLAT_ACTION_FAIL;
595#endif
596
597 if (option_vb->vb_length < 1) {
598 RERROR("LDAP attriubte option must not be blank");
599 return XLAT_ACTION_FAIL;
600 }
601
602 if (!ldap_is_ldap_url(uri->vb_strvalue)) {
603 REDEBUG("String passed does not look like an LDAP URL");
604 return XLAT_ACTION_FAIL;
605 }
606
607 ret = ldap_url_parse(uri->vb_strvalue, &ldap_url);
608 if (ret != LDAP_URL_SUCCESS){
609 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ret));
610 return XLAT_ACTION_FAIL;
611 }
612
613 /*
614 * No attributes, just return what was presented.
615 */
616 if (!ldap_url->lud_attrs || !ldap_url->lud_attrs[0] || !*ldap_url->lud_attrs[0]) {
617 fr_value_box_list_remove(in, uri);
618 talloc_steal(ctx, uri);
620 goto done;
621 }
622
623 if (option_vb->vb_strvalue[0] != ';') {
624 option = talloc_asprintf(option_vb, ";%s", option_vb->vb_strvalue);
625 } else {
626 option = option_vb->vb_strvalue;
627 }
628
629 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL));
630 attrs_fixed = talloc_strdup(vb, "");
631
632 attr = ldap_url->lud_attrs;
633 while (*attr) {
634 attrs_fixed = talloc_strdup_append(attrs_fixed, *attr);
635 if (!strstr(*attr, option)) attrs_fixed = talloc_strdup_append(attrs_fixed, option);
636 attr++;
637 if (*attr) attrs_fixed = talloc_strdup_append(attrs_fixed, ",");
638 }
639
640 snprintf(port, sizeof(port), "%d", ldap_url->lud_port);
641 fr_value_box_asprintf(vb, vb, NULL, uri->tainted, "%s://%s%s%s/%s?%s?%s?%s",
642 ldap_url->lud_scheme,
643 ldap_url->lud_host ? ldap_url->lud_host : "",
644 ldap_url->lud_host ? ":" : "",
645 ldap_url->lud_host ? port : "",
646 ldap_url->lud_dn, attrs_fixed,
647 fr_table_str_by_value(fr_ldap_scope, ldap_url->lud_scope, ""),
648 ldap_url->lud_filter ? ldap_url->lud_filter : "");
649
651done:
652 ldap_free_urldesc(ldap_url);
653 return XLAT_ACTION_DONE;
654}
655
656/** Callback when resuming after async ldap query is completed
657 *
658 */
660 xlat_ctx_t const *xctx,
661 request_t *request, UNUSED fr_value_box_list_t *in)
662{
663 fr_ldap_query_t *query = talloc_get_type_abort(xctx->rctx, fr_ldap_query_t);
664 fr_ldap_connection_t *ldap_conn = query->ldap_conn;
665 fr_value_box_t *vb = NULL;
666 LDAPMessage *msg;
667 struct berval **values;
668 char const **attr;
669 int count, i;
670
671 if (query->ret != LDAP_RESULT_SUCCESS) return XLAT_ACTION_FAIL;
672
673 /*
674 * We only parse "entries"
675 */
676 for (msg = ldap_first_entry(ldap_conn->handle, query->result); msg; msg = ldap_next_entry(ldap_conn->handle, msg)) {
677 for (attr = query->search.attrs; *attr; attr++) {
678 values = ldap_get_values_len(ldap_conn->handle, msg, *attr);
679 if (!values) {
680 RDEBUG2("No \"%s\" attributes found in specified object", *attr);
681 continue;
682 }
683
684 count = ldap_count_values_len(values);
685 for (i = 0; i < count; i++) {
686 MEM(vb = fr_value_box_alloc_null(ctx));
687 if (fr_value_box_bstrndup(vb, vb, NULL, values[i]->bv_val, values[i]->bv_len, true) < 0) {
688 talloc_free(vb);
689 RPERROR("Failed creating value from LDAP response");
690 break;
691 }
693 }
694 ldap_value_free_len(values);
695 }
696 }
697
698 talloc_free(query);
699
700 return XLAT_ACTION_DONE;
701}
702
703/** Callback for signalling async ldap query
704 *
705 */
706static void ldap_xlat_signal(xlat_ctx_t const *xctx, request_t *request, UNUSED fr_signal_t action)
707{
708 fr_ldap_query_t *query = talloc_get_type_abort(xctx->rctx, fr_ldap_query_t);
709
710 if (!query->treq) return;
711
712 RDEBUG2("Forcefully cancelling pending LDAP query");
713
715}
716
717/*
718 * If a part doesn't have an escaping function, parsing will fail unless the input
719 * was marked up with a safe_for value by the ldap arg parsing, i.e. was a literal
720 * input argument to the xlat.
721 *
722 * This is equivalent to the old "tainted_allowed" flag.
723 */
725 { .name = "scheme", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L(":")), .part_adv = { [':'] = 1 }, .extra_skip = 2 },
726 { .name = "host", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L(":"), L("/")), .part_adv = { [':'] = 1, ['/'] = 2 } },
727 { .name = "port", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("/")), .part_adv = { ['/'] = 1 } },
728 { .name = "dn", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1 }, .func = ldap_uri_part_escape },
729 { .name = "attrs", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1 }},
730 { .name = "scope", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1 }, .func = ldap_uri_part_escape },
731 { .name = "filter", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1}, .func = ldap_uri_part_escape },
732 { .name = "exts", .safe_for = LDAP_URI_SAFE_FOR, .func = ldap_uri_part_escape },
734};
735
736static fr_uri_part_t const ldap_dn_parts[] = {
737 { .name = "dn", .safe_for = LDAP_URI_SAFE_FOR , .func = ldap_uri_part_escape },
739};
740
742 { .required = true, .type = FR_TYPE_STRING, .safe_for = LDAP_URI_SAFE_FOR, .will_escape = true, },
744};
745
746/** Produce canonical LDAP host URI for finding trunks
747 *
748 */
749static inline CC_HINT(always_inline)
750char *host_uri_canonify(request_t *request, LDAPURLDesc *url_parsed, fr_value_box_t *url_in)
751{
752 char *host;
753
754 LDAPURLDesc tmp_desc = {
755 .lud_scheme = url_parsed->lud_scheme,
756 .lud_host = url_parsed->lud_host,
757 .lud_port = url_parsed->lud_port,
758 .lud_scope = -1
759 };
760 host = ldap_url_desc2str(&tmp_desc);
761 if (unlikely(host == NULL)) REDEBUG("Invalid LDAP URL - %pV", url_in); \
762
763 return host;
764}
765
766/** Utility function for parsing LDAP URLs
767 *
768 * All LDAP xlat functions that work with LDAP URLs should call this function to parse the URL.
769 *
770 * @param[out] uri_parsed LDAP URL parsed. Must be freed with ldap_url_desc_free.
771 * @param[out] host_out host name to use for the query. Must be freed with ldap_mem_free
772 * if free_host_out is true.
773 * @param[out] free_host_out True if host_out should be freed.
774 * @param[in] request Request being processed.
775 * @param[in] host_default Default host to use if the URL does not specify a host.
776 * @param[in] uri_in URI to parse.
777 * @return
778 * - 0 on success.
779 * - -1 on failure.
780 */
781static int ldap_xlat_uri_parse(LDAPURLDesc **uri_parsed, char **host_out, bool *free_host_out,
782 request_t *request, char *host_default, fr_value_box_t *uri_in)
783{
784 fr_value_box_t *uri;
785 int ldap_url_ret;
786
787 *free_host_out = false;
788
789 if (fr_uri_escape_list(&uri_in->vb_group, ldap_uri_parts, NULL) < 0){
790 RPERROR("Failed to escape LDAP URI");
791 error:
792 *uri_parsed = NULL;
793 return -1;
794 }
795
796 /*
797 * Smush everything into the first URI box
798 */
799 uri = fr_value_box_list_head(&uri_in->vb_group);
800
801 if (fr_value_box_list_concat_in_place(uri, uri, &uri_in->vb_group,
802 FR_TYPE_STRING, FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
803 RPEDEBUG("Failed concatenating input");
804 goto error;
805 }
806
807 if (!ldap_is_ldap_url(uri->vb_strvalue)) {
808 REDEBUG("String passed does not look like an LDAP URL");
809 goto error;
810 }
811
812 ldap_url_ret = ldap_url_parse(uri->vb_strvalue, uri_parsed);
813 if (ldap_url_ret != LDAP_URL_SUCCESS){
814 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ldap_url_ret));
815 goto error;
816 }
817
818 /*
819 * If the URL is <scheme>:/// the parsed host will be NULL - use config default
820 */
821 if (!(*uri_parsed)->lud_host) {
822 *host_out = host_default;
823 } else {
824 *host_out = host_uri_canonify(request, *uri_parsed, uri);
825 if (unlikely(*host_out == NULL)) {
826 ldap_free_urldesc(*uri_parsed);
827 *uri_parsed = NULL;
828 return -1;
829 }
830 *free_host_out = true;
831 }
832
833 return 0;
834}
835
836/** Expand an LDAP URL into a query, and return a string result from that query.
837 *
838 * @ingroup xlat_functions
839 */
841 xlat_ctx_t const *xctx,
842 request_t *request, fr_value_box_list_t *in)
843{
844 fr_ldap_thread_t *t = talloc_get_type_abort(xctx->mctx->thread, fr_ldap_thread_t);
845 fr_value_box_t *uri;
846 char *host;
847 bool free_host = false;
848 fr_ldap_config_t const *handle_config = t->config;
850 fr_ldap_query_t *query = NULL;
851
852 LDAPURLDesc *ldap_url;
853
854 XLAT_ARGS(in, &uri);
855
856 if (ldap_xlat_uri_parse(&ldap_url, &host, &free_host, request, handle_config->server, uri) < 0) return XLAT_ACTION_FAIL;
857
858 /*
859 * Nothing, empty string, "*" string, or got 2 things, die.
860 */
861 if (!ldap_url->lud_attrs || !ldap_url->lud_attrs[0] || !*ldap_url->lud_attrs[0] ||
862 (strcmp(ldap_url->lud_attrs[0], "*") == 0) || ldap_url->lud_attrs[1]) {
863 REDEBUG("Bad attributes list in LDAP URL. URL must specify exactly one attribute to retrieve");
864 ldap_free_urldesc(ldap_url);
865 return XLAT_ACTION_FAIL;
866 }
867
869 ldap_url->lud_dn, ldap_url->lud_scope, ldap_url->lud_filter,
870 (char const * const*)ldap_url->lud_attrs, NULL, NULL);
871 query->ldap_url = ldap_url; /* query destructor will free URL */
872
873 if (ldap_url->lud_exts) {
874 LDAPControl *serverctrls[LDAP_MAX_CONTROLS];
875 int i;
876
877 serverctrls[0] = NULL;
878
879 if (fr_ldap_parse_url_extensions(serverctrls, NUM_ELEMENTS(serverctrls),
880 query->ldap_url->lud_exts) < 0) {
881 RPERROR("Parsing URL extensions failed");
882 if (free_host) ldap_memfree(host);
883
884 query_error:
885 talloc_free(query);
886 return XLAT_ACTION_FAIL;
887 }
888
889 for (i = 0; i < LDAP_MAX_CONTROLS; i++) {
890 if (!serverctrls[i]) break;
891 query->serverctrls[i].control = serverctrls[i];
892 query->serverctrls[i].freeit = true;
893 }
894 }
895
896 /*
897 * Figure out what trunked connection we can use
898 * to communicate with the host.
899 *
900 * If free_host is true, we must free the host
901 * after deciding on a trunk connection as it
902 * was allocated by host_uri_canonify.
903 */
904 ttrunk = fr_thread_ldap_trunk_get(t, host, handle_config->admin_identity,
905 handle_config->admin_password, request, handle_config);
906 if (free_host) ldap_memfree(host);
907 if (!ttrunk) {
908 REDEBUG("Unable to get LDAP query for xlat");
909 goto query_error;
910 }
911
912 switch (trunk_request_enqueue(&query->treq, ttrunk->trunk, request, query, NULL)) {
913 case TRUNK_ENQUEUE_OK:
915 break;
916
917 default:
918 REDEBUG("Unable to enqueue LDAP query for xlat");
919 goto query_error;
920 }
921
922 if (fr_timer_in(query, unlang_interpret_event_list(request)->tl, &query->ev, handle_config->res_timeout,
923 false, ldap_query_timeout, query) < 0) {
924 REDEBUG("Unable to set timeout for LDAP query");
926 goto query_error;
927 }
928
930}
931
932/** User object lookup as part of group membership xlat
933 *
934 * Called if the ldap membership xlat is used and the user DN is not already known
935 */
937{
938 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(uctx, ldap_group_xlat_ctx_t);
939
940 if (xlat_ctx->env_data->user_filter.type == FR_TYPE_STRING) xlat_ctx->filter = &xlat_ctx->env_data->user_filter;
941
942 xlat_ctx->basedn = &xlat_ctx->env_data->user_base;
943
945 /* discard, this function is only used by xlats */NULL,
946 xlat_ctx->inst, request,
947 xlat_ctx->basedn, xlat_ctx->filter,
948 xlat_ctx->ttrunk, xlat_ctx->attrs, &xlat_ctx->query);
949}
950
951/** Cancel an in-progress query for the LDAP group membership xlat
952 *
953 */
954static void ldap_group_xlat_cancel(UNUSED request_t *request, UNUSED fr_signal_t action, void *uctx)
955{
956 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(uctx, ldap_group_xlat_ctx_t);
957
958 if (!xlat_ctx->query || !xlat_ctx->query->treq) return;
959
961}
962
963#define REPEAT_LDAP_MEMBEROF_XLAT_RESULTS \
964 if (unlang_function_repeat_set(request, ldap_group_xlat_results) < 0) do { \
965 RETURN_UNLANG_FAIL; \
966 } while (0)
967
968/** Run the state machine for the LDAP membership xlat
969 *
970 * This is called after each async lookup is completed
971 *
972 * Will stop early, and set p_result to unlang_result
973 */
975{
976 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(uctx, ldap_group_xlat_ctx_t);
977 rlm_ldap_t const *inst = xlat_ctx->inst;
978
979 /*
980 * Check to see if rlm_ldap_check_groupobj_dynamic or rlm_ldap_check_userobj_dynamic failed
981 */
983
984 switch (xlat_ctx->status) {
986 if (!xlat_ctx->dn) xlat_ctx->dn = rlm_find_user_dn_cached(request);
988
989 RDEBUG3("Entered GROUP_XLAT_FIND_USER with user DN \"%s\"", xlat_ctx->dn);
990 if (inst->group.obj_membership_filter) {
992 RDEBUG3("Checking for user in group objects");
996 }
997 }
999
1001 if (xlat_ctx->found) RETURN_UNLANG_OK;
1002
1003 RDEBUG3("Entered GROUP_XLAT_MEMB_FILTER with user DN \"%s\"", xlat_ctx->dn);
1004 if (inst->group.userobj_membership_attr) {
1009 }
1010 }
1012
1014 RDEBUG3("Entered GROUP_XLAT_MEMB_ATTR with user DN \"%s\"", xlat_ctx->dn);
1015 if (xlat_ctx->found) RETURN_UNLANG_OK;
1016 break;
1017 }
1018
1020}
1021
1022/** Process the results of evaluating LDAP group membership
1023 *
1024 */
1026 UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
1027{
1028 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(xctx->rctx, ldap_group_xlat_ctx_t);
1029 fr_value_box_t *vb;
1030
1032 vb->vb_bool = xlat_ctx->found;
1034
1035 return XLAT_ACTION_DONE;
1036}
1037
1039 { .required = true, .concat = true, .type = FR_TYPE_STRING, .safe_for = LDAP_URI_SAFE_FOR },
1041};
1042
1043/** Check for a user being in a LDAP group
1044 *
1045 * @ingroup xlat_functions
1046 */
1047static xlat_action_t ldap_group_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx,
1048 request_t *request, fr_value_box_list_t *in)
1049{
1050 fr_value_box_t *vb = NULL, *group_vb = fr_value_box_list_pop_head(in);
1052 fr_ldap_thread_t *t = talloc_get_type_abort(xctx->mctx->thread, fr_ldap_thread_t);
1053 ldap_xlat_memberof_call_env_t *env_data = talloc_get_type_abort(xctx->env_data, ldap_xlat_memberof_call_env_t);
1054 bool group_is_dn;
1056
1057 RDEBUG2("Searching for user in group \"%pV\"", group_vb);
1058
1059 if (group_vb->vb_length == 0) {
1060 REDEBUG("Cannot do comparison (group name is empty)");
1061 return XLAT_ACTION_FAIL;
1062 }
1063
1064 group_is_dn = fr_ldap_util_is_dn(group_vb->vb_strvalue, group_vb->vb_length);
1065 if (group_is_dn) {
1066 char *norm;
1067 size_t len;
1068
1069 MEM(norm = talloc_array(group_vb, char, talloc_array_length(group_vb->vb_strvalue)));
1070 len = fr_ldap_util_normalise_dn(norm, group_vb->vb_strvalue);
1071
1072 /*
1073 * Will clear existing buffer (i.e. group_vb->vb_strvalue)
1074 */
1075 fr_value_box_bstrdup_buffer_shallow(group_vb, group_vb, NULL, norm, group_vb->tainted);
1076
1077 /*
1078 * Trim buffer to match normalised DN
1079 */
1080 fr_value_box_bstr_realloc(group_vb, NULL, group_vb, len);
1081 }
1082
1083 if ((group_is_dn && inst->group.cacheable_dn) || (!group_is_dn && inst->group.cacheable_name)) {
1084 unlang_result_t our_result;
1085
1086 rlm_ldap_check_cached(&our_result, inst, request, group_vb);
1087 switch (our_result.rcode) {
1089 RDEBUG2("User is not a member of \"%pV\"", group_vb);
1090 return XLAT_ACTION_DONE;
1091
1092 case RLM_MODULE_OK:
1093 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
1094 vb->vb_bool = true;
1096 return XLAT_ACTION_DONE;
1097
1098 /*
1099 * Fallback to dynamic search
1100 */
1101 default:
1102 break;
1103 }
1104 }
1105
1107
1109 .inst = inst,
1110 .group = group_vb,
1111 .dn = rlm_find_user_dn_cached(request),
1112 .attrs = { inst->group.userobj_membership_attr, NULL },
1113 .group_is_dn = group_is_dn,
1114 .env_data = env_data
1115 };
1116
1117 xlat_ctx->ttrunk = fr_thread_ldap_trunk_get(t, inst->handle_config.server, inst->handle_config.admin_identity,
1118 inst->handle_config.admin_password, request, &inst->handle_config);
1119
1120 if (!xlat_ctx->ttrunk) {
1121 REDEBUG("Unable to get LDAP trunk for group membership check");
1122 error:
1124 return XLAT_ACTION_FAIL;
1125 }
1126
1127 if (unlang_xlat_yield(request, ldap_group_xlat_resume, NULL, 0, xlat_ctx) != XLAT_ACTION_YIELD) goto error;
1128
1130 request,
1133 ldap_group_xlat_cancel, ~FR_SIGNAL_CANCEL,
1135 xlat_ctx) < 0) goto error;
1136
1138}
1139
1146
1147/** Return whether evaluating the profile was successful
1148 *
1149 */
1151 UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
1152{
1153 ldap_xlat_profile_ctx_t *xlat_ctx = talloc_get_type_abort(xctx->rctx, ldap_xlat_profile_ctx_t);
1154 fr_value_box_t *vb;
1155
1157 vb->vb_bool = (xlat_ctx->ret == LDAP_RESULT_SUCCESS) && (xlat_ctx->applied > 0);
1159
1160 return XLAT_ACTION_DONE;
1161}
1162
1164{
1165 if (to_free->url) {
1166 ldap_free_urldesc(to_free->url);
1167 to_free->url = NULL;
1168 }
1169 return 0;
1170}
1171
1172/** Expand an LDAP URL into a query, applying the results using the user update map.
1173 *
1174 * For fetching profiles by DN.
1175 *
1176 * @ingroup xlat_functions
1177 */
1179 xlat_ctx_t const *xctx,
1180 request_t *request, fr_value_box_list_t *in)
1181{
1183 fr_ldap_thread_t *t = talloc_get_type_abort(xctx->mctx->thread, fr_ldap_thread_t);
1184 ldap_xlat_profile_call_env_t *env_data = talloc_get_type_abort(xctx->env_data, ldap_xlat_profile_call_env_t);
1185 fr_value_box_t *uri_components, *uri;
1186 char *host_url, *host = NULL;
1187 fr_ldap_config_t const *handle_config = t->config;
1188 fr_ldap_thread_trunk_t *ttrunk;
1190
1191 int ldap_url_ret;
1192
1193 char const *dn;
1194 char const *filter;
1195 int scope;
1196
1197 bool is_dn;
1198
1199 XLAT_ARGS(in, &uri_components);
1200
1201 is_dn = (fr_uri_has_scheme(&uri_components->vb_group, ldap_uri_scheme_table, ldap_uri_scheme_table_len, -1) < 0);
1202
1203 /*
1204 * Apply different escaping rules based on whether the first
1205 * arg lookgs like a URI or a DN.
1206 */
1207 if (is_dn) {
1208 if (fr_uri_escape_list(&uri_components->vb_group, ldap_dn_parts, NULL) < 0) {
1209 RPERROR("Failed to escape LDAP profile DN");
1210 return XLAT_ACTION_FAIL;
1211 }
1212 } else {
1213 if (fr_uri_escape_list(&uri_components->vb_group, ldap_uri_parts, NULL) < 0) {
1214 RPERROR("Failed to escape LDAP profile URI");
1215 return XLAT_ACTION_FAIL;
1216 }
1217 }
1218
1219 /*
1220 * Smush everything into the first URI box
1221 */
1222 uri = fr_value_box_list_head(&uri_components->vb_group);
1223 if (fr_value_box_list_concat_in_place(uri, uri, &uri_components->vb_group,
1224 FR_TYPE_STRING, FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
1225 RPEDEBUG("Failed concatenating input");
1226 return XLAT_ACTION_FAIL;
1227 }
1228
1229 /*
1230 * Allocate a resumption context to store temporary resource and results
1231 */
1233 talloc_set_destructor(xlat_ctx, ldap_xlat_profile_ctx_free);
1234
1235 if (is_dn) {
1236 host_url = handle_config->server;
1237 dn = talloc_typed_strdup_buffer(xlat_ctx, uri->vb_strvalue);
1238 filter = env_data->profile_filter.vb_strvalue;
1239 scope = inst->profile.obj_scope;
1240 } else {
1241 ldap_url_ret = ldap_url_parse(uri->vb_strvalue, &xlat_ctx->url);
1242 if (ldap_url_ret != LDAP_URL_SUCCESS){
1243 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ldap_url_ret));
1244 error:
1246 return XLAT_ACTION_FAIL;
1247 }
1248
1249 /*
1250 * The URL must specify a DN
1251 */
1252 if (!xlat_ctx->url->lud_dn) {
1253 REDEBUG("LDAP URI must specify a profile DN");
1254 goto error;
1255 }
1256
1257 dn = xlat_ctx->url->lud_dn;
1258 /*
1259 * Either we use the filter from the URL or we use the default filter
1260 * configured for profiles.
1261 */
1262 filter = xlat_ctx->url->lud_filter ? xlat_ctx->url->lud_filter : env_data->profile_filter.vb_strvalue;
1263
1264 /*
1265 * Determine if the URL includes a scope.
1266 */
1267 scope = xlat_ctx->url->lud_scope == LDAP_SCOPE_DEFAULT ? inst->profile.obj_scope : xlat_ctx->url->lud_scope;
1268
1269 /*
1270 * If the URL is <scheme>:/// the parsed host will be NULL - use config default
1271 */
1272 if (!xlat_ctx->url->lud_host) {
1273 host_url = handle_config->server;
1274 } else {
1275 host_url = host = host_uri_canonify(request, xlat_ctx->url, uri);
1276 if (unlikely(host_url == NULL)) goto error;
1277 }
1278 }
1279
1280 /*
1281 * Synchronous expansion of maps (fixme!)
1282 */
1283 if (fr_ldap_map_expand(xlat_ctx, &xlat_ctx->expanded, request, env_data->profile_map,
1284 inst->valuepair_attr, inst->profile.check_attr, inst->profile.fallthrough_attr) < 0) goto error;
1285 ttrunk = fr_thread_ldap_trunk_get(t, host_url, handle_config->admin_identity,
1286 handle_config->admin_password, request, handle_config);
1287 if (host) ldap_memfree(host);
1288 if (!ttrunk) {
1289 REDEBUG("Unable to get LDAP query for xlat");
1290 goto error;
1291 }
1292
1293 if (unlang_xlat_yield(request, ldap_profile_xlat_resume, NULL, 0, xlat_ctx) != XLAT_ACTION_YIELD) goto error;
1294
1295 /*
1296 * Pushes a frame onto the stack to retrieve and evaluate a profile
1297 */
1298 if (rlm_ldap_map_profile(&xlat_ctx->ret, &xlat_ctx->applied, inst, request, ttrunk, dn,
1299 scope, filter, &xlat_ctx->expanded) < 0) goto error;
1300
1302}
1303
1304/*
1305 * Verify the result of the map.
1306 */
1307static int ldap_map_verify(CONF_SECTION *cs, UNUSED void const *mod_inst, UNUSED void *proc_inst,
1308 tmpl_t const *src, UNUSED map_list_t const *maps)
1309{
1310 if (!src) {
1311 cf_log_err(cs, "Missing LDAP URI");
1312
1313 return -1;
1314 }
1315
1316 return 0;
1317}
1318
1319/** Process the results of an LDAP map query
1320 *
1321 * @param[out] p_result Result of map expansion:
1322 * - #RLM_MODULE_NOOP no rows were returned.
1323 * - #RLM_MODULE_UPDATED if one or more #fr_pair_t were added to the #request_t.
1324 * - #RLM_MODULE_FAIL if an error occurred.
1325 * @param[in] mpctx module map ctx.
1326 * @param[in,out] request The current request.
1327 * @param[in] url LDAP url specifying base DN and filter.
1328 * @param[in] maps Head of the map list.
1329 * @return One of UNLANG_ACTION_*
1330 */
1331static unlang_action_t mod_map_resume(unlang_result_t *p_result, map_ctx_t const *mpctx, request_t *request,
1332 UNUSED fr_value_box_list_t *url, UNUSED map_list_t const *maps)
1333{
1334 ldap_map_ctx_t *map_ctx = talloc_get_type_abort(mpctx->rctx, ldap_map_ctx_t);
1335 fr_ldap_query_t *query = map_ctx->query;
1336 fr_ldap_map_exp_t *expanded = &map_ctx->expanded;
1338 LDAPMessage *entry;
1339 map_t const *map;
1340
1341 switch (query->ret) {
1343 rcode = RLM_MODULE_UPDATED;
1344 break;
1345
1347 case LDAP_RESULT_BAD_DN:
1348 goto finish;
1349
1351 goto finish;
1352
1353 default:
1354 rcode = RLM_MODULE_FAIL;
1355 goto finish;
1356 }
1357
1358 for (entry = ldap_first_entry(query->ldap_conn->handle, query->result);
1359 entry;
1360 entry = ldap_next_entry(query->ldap_conn->handle, entry)) {
1361 char *dn = NULL;
1362 int i;
1363
1364 if (RDEBUG_ENABLED2) {
1365 dn = ldap_get_dn(query->ldap_conn->handle, entry);
1366 RDEBUG2("Processing \"%s\"", dn);
1367 }
1368
1369 RINDENT();
1370 for (map = map_list_head(map_ctx->maps), i = 0;
1371 map != NULL;
1372 map = map_list_next(map_ctx->maps, map), i++) {
1373 int ret;
1374 fr_ldap_result_t attr;
1375
1376 attr.values = ldap_get_values_len(query->ldap_conn->handle, entry, expanded->attrs[i]);
1377 if (!attr.values) {
1378 /*
1379 * Many LDAP directories don't expose the DN of
1380 * the object as an attribute, so we need this
1381 * hack, to allow the user to retrieve it.
1382 */
1383 if (strcmp(LDAP_VIRTUAL_DN_ATTR, expanded->attrs[i]) == 0) {
1384 struct berval value;
1385 struct berval *values[2] = { &value, NULL };
1386
1387 if (!dn) dn = ldap_get_dn(query->ldap_conn->handle, entry);
1388 value.bv_val = dn;
1389 value.bv_len = strlen(dn);
1390
1391 attr.values = values;
1392 attr.count = 1;
1393
1394 ret = map_to_request(request, map, fr_ldap_map_getvalue, &attr);
1395 if (ret == -1) {
1396 rcode = RLM_MODULE_FAIL;
1397 ldap_memfree(dn);
1398 goto finish;
1399 }
1400 continue;
1401 }
1402
1403 RDEBUG3("Attribute \"%s\" not found in LDAP object", expanded->attrs[i]);
1404
1405 continue;
1406 }
1407 attr.count = ldap_count_values_len(attr.values);
1408
1409 ret = map_to_request(request, map, fr_ldap_map_getvalue, &attr);
1410 ldap_value_free_len(attr.values);
1411 if (ret == -1) {
1412 rcode = RLM_MODULE_FAIL;
1413 ldap_memfree(dn);
1414 goto finish;
1415 }
1416 }
1417 ldap_memfree(dn);
1418 REXDENT();
1419 }
1420
1421finish:
1422 RETURN_UNLANG_RCODE(rcode);
1423}
1424
1425/** Ensure map context is properly cleared up
1426 *
1427 */
1428static int map_ctx_free(ldap_map_ctx_t *map_ctx)
1429{
1430 int i = 0;
1431 talloc_free(map_ctx->expanded.ctx);
1432 ldap_free_urldesc(map_ctx->ldap_url);
1433 while ((i < LDAP_MAX_CONTROLS) && map_ctx->serverctrls[i]) {
1434 ldap_control_free(map_ctx->serverctrls[i]);
1435 i++;
1436 }
1437 return (0);
1438}
1439
1440/** Perform a search and map the result of the search to server attributes
1441 *
1442 * Unlike LDAP xlat, this can be used to process attributes from multiple entries.
1443 *
1444 * @todo For xlat expansions we need to parse the raw URL first, and then apply
1445 * different escape functions to the different parts.
1446 *
1447 * @param[out] p_result Result of map expansion:
1448 * - #RLM_MODULE_NOOP no rows were returned.
1449 * - #RLM_MODULE_UPDATED if one or more #fr_pair_t were added to the #request_t.
1450 * - #RLM_MODULE_FAIL if an error occurred.
1451 * @param[in] mpctx module map ctx.
1452 * @param[in,out] request The current request.
1453 * @param[in] url LDAP url specifying base DN and filter.
1454 * @param[in] maps Head of the map list.
1455 * @return UNLANG_ACTION_CALCULATE_RESULT
1456 */
1457static unlang_action_t mod_map_proc(unlang_result_t *p_result, map_ctx_t const *mpctx, request_t *request,
1458 fr_value_box_list_t *url, map_list_t const *maps)
1459{
1461 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
1462
1463 LDAPURLDesc *ldap_url;
1464 int ldap_url_ret;
1465 fr_ldap_thread_trunk_t *ttrunk;
1466
1467 fr_value_box_t *url_head;
1468 ldap_map_ctx_t *map_ctx;
1469 char *host_url, *host = NULL;
1470
1471 if (fr_uri_escape_list(url, ldap_uri_parts, NULL) < 0) {
1472 RPERROR("Failed to escape LDAP map URI");
1474 }
1475
1476 url_head = fr_value_box_list_head(url);
1477 if (!url_head) {
1478 REDEBUG("LDAP URL cannot be empty");
1480 }
1481
1482 if (fr_value_box_list_concat_in_place(url_head, url_head, url, FR_TYPE_STRING,
1483 FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
1484 RPEDEBUG("Failed concatenating input");
1486 }
1487
1488 if (!ldap_is_ldap_url(url_head->vb_strvalue)) {
1489 REDEBUG("Map query string does not look like a valid LDAP URI");
1491 }
1492
1493 MEM(map_ctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), ldap_map_ctx_t));
1494 talloc_set_destructor(map_ctx, map_ctx_free);
1495 map_ctx->maps = maps;
1496
1497 ldap_url_ret = ldap_url_parse(url_head->vb_strvalue, &map_ctx->ldap_url);
1498 if (ldap_url_ret != LDAP_URL_SUCCESS){
1499 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ldap_url_ret));
1500 fail:
1501 talloc_free(map_ctx);
1503 }
1504 ldap_url = map_ctx->ldap_url;
1505
1506 if (ldap_url->lud_exts) {
1508 ldap_url->lud_exts) < 0) {
1509 RPERROR("Parsing URL extensions failed");
1510 goto fail;
1511 }
1512 }
1513
1514 /*
1515 * Expand the RHS of the maps to get the name of the attributes.
1516 */
1517 if (fr_ldap_map_expand(map_ctx, &map_ctx->expanded, request, maps, NULL, NULL, NULL) < 0) goto fail;
1518
1519 /*
1520 * If the URL is <scheme>:/// the parsed host will be NULL - use config default
1521 */
1522 if (!ldap_url->lud_host) {
1523 host_url = inst->handle_config.server;
1524 } else {
1525 host_url = host = host_uri_canonify(request, ldap_url, url_head);
1526 if (unlikely(host_url == NULL)) goto fail;
1527 }
1528
1529 ttrunk = fr_thread_ldap_trunk_get(thread, host_url, inst->handle_config.admin_identity,
1530 inst->handle_config.admin_password, request, &inst->handle_config);
1531 if (host) ldap_memfree(host);
1532 if (!ttrunk) goto fail;
1533
1534 if (unlikely(unlang_map_yield(request, mod_map_resume, NULL, 0, map_ctx) != UNLANG_ACTION_YIELD)) goto fail;
1535
1536 return fr_ldap_trunk_search(map_ctx, &map_ctx->query, request, ttrunk, ldap_url->lud_dn,
1537 ldap_url->lud_scope, ldap_url->lud_filter, map_ctx->expanded.attrs,
1538 map_ctx->serverctrls, NULL);
1539}
1540
1541static unlang_action_t CC_HINT(nonnull) mod_authenticate(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
1542{
1544 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
1545 ldap_auth_ctx_t *auth_ctx;
1546 ldap_auth_call_env_t *call_env = talloc_get_type_abort(mctx->env_data, ldap_auth_call_env_t);
1547
1548 if (call_env->password.type != FR_TYPE_STRING) {
1549 RWDEBUG("You have set \"Auth-Type := LDAP\" somewhere");
1550 RWDEBUG("without checking if %s is present", call_env->password_tmpl->name);
1551 RWDEBUG("*********************************************");
1552 RWDEBUG("* THAT CONFIGURATION IS WRONG. DELETE IT. ");
1553 RWDEBUG("* YOU ARE PREVENTING THE SERVER FROM WORKING");
1554 RWDEBUG("*********************************************");
1555
1556 REDEBUG("Attribute \"%s\" is required for authentication", call_env->password_tmpl->name);
1558 }
1559
1560 auth_ctx = talloc(unlang_interpret_frame_talloc_ctx(request), ldap_auth_ctx_t);
1561 *auth_ctx = (ldap_auth_ctx_t){
1562 .password = call_env->password.vb_strvalue,
1563 .thread = thread,
1564 .inst = inst,
1565 .call_env = call_env
1566 };
1567
1568 /*
1569 * Find the user's DN
1570 */
1571 auth_ctx->dn = rlm_find_user_dn_cached(request);
1572
1573 /*
1574 * The DN is required for non-SASL auth
1575 */
1576 if (!auth_ctx->dn && (call_env->user_sasl_mech.type != FR_TYPE_STRING)) {
1577 REDEBUG("No DN found for authentication. Populate control.%s with the DN to use in authentication.",
1578 attr_ldap_userdn->name);
1579 REDEBUG("You should call %s in the recv section and check its return.", inst->mi->name);
1580 talloc_free(auth_ctx);
1582 }
1583
1584 /*
1585 * Log the password
1586 */
1587 if (RDEBUG_ENABLED3) {
1588 RDEBUG("Login attempt with password \"%pV\"", &call_env->password);
1589 } else {
1590 RDEBUG2("Login attempt with password");
1591 }
1592
1593 /*
1594 * SASL bind auth will have the mech set.
1595 */
1596 if (auth_ctx->call_env->user_sasl_mech.type == FR_TYPE_STRING) {
1597#ifdef WITH_SASL
1598 RDEBUG2("Login attempt using identity \"%pV\"", &call_env->user_sasl_authname);
1599
1600 return fr_ldap_sasl_bind_auth_async(p_result, request, auth_ctx->thread, call_env->user_sasl_mech.vb_strvalue,
1601 call_env->user_sasl_authname.vb_strvalue,
1602 auth_ctx->password, call_env->user_sasl_proxy.vb_strvalue,
1603 call_env->user_sasl_realm.vb_strvalue);
1604#else
1605 RDEBUG("Configuration item 'sasl.mech' is not supported. "
1606 "The linked version of libldap does not provide ldap_sasl_bind( function");
1608#endif
1609 }
1610
1611 RDEBUG2("Login attempt as \"%s\"", auth_ctx->dn);
1612
1613 return fr_ldap_bind_auth_async(p_result, request, auth_ctx->thread, auth_ctx->dn, auth_ctx->password);
1614}
1615
1616#define REPEAT_MOD_AUTHORIZE_RESUME \
1617 if (unlang_module_yield(request, mod_authorize_resume, NULL, 0, autz_ctx) == UNLANG_ACTION_FAIL) do { \
1618 p_result->rcode = RLM_MODULE_FAIL; \
1619 goto finish; \
1620 } while (0)
1621
1622/** Resume function called after each potential yield in LDAP authorization
1623 *
1624 * Some operations may or may not yield. E.g. if group membership is
1625 * read from an attribute returned with the user object and is already
1626 * in the correct form, that will not yield.
1627 * Hence, each state may fall through to the next.
1628 *
1629 * @param p_result Result of current authorization.
1630 * @param mctx Module context.
1631 * @param request Current request.
1632 * @return An rcode.
1633 */
1635{
1636 ldap_autz_ctx_t *autz_ctx = talloc_get_type_abort(mctx->rctx, ldap_autz_ctx_t);
1638 ldap_autz_call_env_t *call_env = talloc_get_type_abort(autz_ctx->call_env, ldap_autz_call_env_t);
1639 int ldap_errno;
1640 LDAP *handle = fr_ldap_handle_thread_local();
1641
1642 /*
1643 * If a previous async call returned one of the "failure" results just return.
1644 */
1645 switch (p_result->rcode) {
1646 case RLM_MODULE_REJECT:
1647 case RLM_MODULE_FAIL:
1648 case RLM_MODULE_HANDLED:
1649 case RLM_MODULE_INVALID:
1651 goto finish;
1652
1653 default:
1654 break;
1655 }
1656
1657 switch (autz_ctx->status) {
1658 case LDAP_AUTZ_FIND:
1659 /*
1660 * If a user entry has been found the current rcode will be OK
1661 */
1662 if (p_result->rcode != RLM_MODULE_OK) return UNLANG_ACTION_CALCULATE_RESULT;
1663
1664 autz_ctx->entry = ldap_first_entry(handle, autz_ctx->query->result);
1665 if (!autz_ctx->entry) {
1666 ldap_get_option(handle, LDAP_OPT_RESULT_CODE, &ldap_errno);
1667 REDEBUG("Failed retrieving entry: %s", ldap_err2string(ldap_errno));
1668
1669 goto finish;
1670 }
1671
1672 /*
1673 * Check for access.
1674 */
1675 if (inst->user.obj_access_attr) {
1676 autz_ctx->access_state = rlm_ldap_check_access(inst, request, autz_ctx->entry);
1677 switch (autz_ctx->access_state) {
1679 break;
1680
1682 if (inst->group.skip_on_suspend) goto post_group;
1683 break;
1684
1686 p_result->rcode = RLM_MODULE_DISALLOW;
1687 goto finish;
1688 }
1689 }
1690
1691 /*
1692 * Check if we need to cache group memberships
1693 */
1694 if ((inst->group.cacheable_dn || inst->group.cacheable_name) && (inst->group.userobj_membership_attr)) {
1696 if (rlm_ldap_cacheable_userobj(p_result, request, autz_ctx,
1697 inst->group.userobj_membership_attr) == UNLANG_ACTION_PUSHED_CHILD) {
1698 autz_ctx->status = LDAP_AUTZ_GROUP;
1700 }
1701 if (p_result->rcode != RLM_MODULE_OK) goto finish;
1702 }
1704
1705 case LDAP_AUTZ_GROUP:
1706 if (inst->group.cacheable_dn || inst->group.cacheable_name) {
1708 if (rlm_ldap_cacheable_groupobj(p_result, request, autz_ctx) == UNLANG_ACTION_PUSHED_CHILD) {
1709 autz_ctx->status = LDAP_AUTZ_POST_GROUP;
1711 }
1712 if (p_result->rcode != RLM_MODULE_OK) goto finish;
1713 }
1715
1717 post_group:
1718#ifdef WITH_EDIR
1719 /*
1720 * We already have a Password.Cleartext. Skip edir.
1721 */
1722 if (fr_pair_find_by_da_nested(&request->control_pairs, NULL, attr_cleartext_password)) goto skip_edir;
1723
1724 /*
1725 * Retrieve Universal Password if we use eDirectory
1726 */
1727 if (inst->edir) {
1728 autz_ctx->dn = rlm_find_user_dn_cached(request);
1729
1730 /*
1731 * Retrieve universal password
1732 */
1734 autz_ctx->status = LDAP_AUTZ_EDIR_BIND;
1735 return fr_ldap_edir_get_password(p_result, request, autz_ctx->dn, autz_ctx->ttrunk,
1737 }
1739
1740 case LDAP_AUTZ_EDIR_BIND:
1741 if (inst->edir && inst->edir_autz) {
1742 fr_pair_t *password = fr_pair_find_by_da(&request->control_pairs,
1744 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data,
1746
1747 if (!password) {
1748 REDEBUG("Failed to find control.Password.Cleartext");
1749 p_result->rcode = RLM_MODULE_FAIL;
1750 goto finish;
1751 }
1752
1753 RDEBUG2("Binding as %s for eDirectory authorization checks", autz_ctx->dn);
1754
1755 /*
1756 * Bind as the user
1757 */
1759 autz_ctx->status = LDAP_AUTZ_POST_EDIR;
1760 return fr_ldap_bind_auth_async(p_result, request, thread, autz_ctx->dn, password->vp_strvalue);
1761 }
1762 goto skip_edir;
1763
1764 case LDAP_AUTZ_POST_EDIR:
1765 {
1766 /*
1767 * The result of the eDirectory user bind will be in p_result.
1768 * Anything other than RLM_MODULE_OK is a failure.
1769 */
1770 break;
1771
1772 }
1774
1775#endif
1776 case LDAP_AUTZ_MAP:
1777#ifdef WITH_EDIR
1778 skip_edir:
1779#endif
1780 if (!map_list_empty(call_env->user_map) || inst->valuepair_attr) {
1781 RDEBUG2("Processing user attributes");
1782 RINDENT();
1783 if (fr_ldap_map_do(request, NULL, inst->valuepair_attr,
1784 &autz_ctx->expanded, autz_ctx->entry) > 0) autz_ctx->rcode = RLM_MODULE_UPDATED;
1785 REXDENT();
1786 rlm_ldap_check_reply(request, inst, autz_ctx->dlinst->name, call_env->expect_password->vb_bool, autz_ctx->ttrunk);
1787 }
1789
1791 /*
1792 * Apply ONE user profile, or a default user profile.
1793 */
1794 if (call_env->default_profile.type == FR_TYPE_STRING) {
1795 unlang_action_t ret;
1796
1798 ret = rlm_ldap_map_profile(NULL, NULL, inst, request, autz_ctx->ttrunk,
1799 call_env->default_profile.vb_strvalue,
1800 inst->profile.obj_scope, NULL, &autz_ctx->expanded);
1801 switch (ret) {
1802 case UNLANG_ACTION_FAIL:
1803 p_result->rcode = RLM_MODULE_FAIL;
1804 goto finish;
1805
1809
1810 default:
1811 break;
1812 }
1813 }
1815
1817 /*
1818 * Did we jump back her after applying the default profile?
1819 */
1820 if (autz_ctx->status == LDAP_AUTZ_POST_DEFAULT_PROFILE) autz_ctx->rcode = RLM_MODULE_UPDATED;
1821
1822 /*
1823 * Apply a SET of user profiles.
1824 */
1825 switch (autz_ctx->access_state) {
1827 if (inst->profile.attr) {
1828 int count;
1829
1830 autz_ctx->profile_values = ldap_get_values_len(handle, autz_ctx->entry, inst->profile.attr);
1831 count = ldap_count_values_len(autz_ctx->profile_values);
1832 if (count > 0) {
1833 RDEBUG2("Processing %i profile(s) found in attribute \"%s\"", count, inst->profile.attr);
1834 if (RDEBUG_ENABLED3) {
1835 for (struct berval **bv_p = autz_ctx->profile_values; *bv_p; bv_p++) {
1836 RDEBUG3("Will evaluate profile with DN \"%pV\"", fr_box_strvalue_len((*bv_p)->bv_val, (*bv_p)->bv_len));
1837 }
1838 }
1839 } else {
1840 RDEBUG2("No profile(s) found in attribute \"%s\"", inst->profile.attr);
1841 }
1842 }
1843 break;
1844
1846 if (inst->profile.attr_suspend) {
1847 int count;
1848
1849 autz_ctx->profile_values = ldap_get_values_len(handle, autz_ctx->entry, inst->profile.attr_suspend);
1850 count = ldap_count_values_len(autz_ctx->profile_values);
1851 if (count > 0) {
1852 RDEBUG2("Processing %i suspension profile(s) found in attribute \"%s\"", count, inst->profile.attr_suspend);
1853 if (RDEBUG_ENABLED3) {
1854 for (struct berval **bv_p = autz_ctx->profile_values; *bv_p; bv_p++) {
1855 RDEBUG3("Will evaluate suspenension profile with DN \"%pV\"",
1856 fr_box_strvalue_len((*bv_p)->bv_val, (*bv_p)->bv_len));
1857 }
1858 }
1859 } else {
1860 RDEBUG2("No suspension profile(s) found in attribute \"%s\"", inst->profile.attr_suspend);
1861 }
1862 }
1863 break;
1864
1866 break;
1867 }
1868
1870
1872 /*
1873 * After each profile has been applied, execution will restart here.
1874 * Start by clearing the previously used value.
1875 */
1876 if (autz_ctx->profile_value) {
1877 TALLOC_FREE(autz_ctx->profile_value);
1878 autz_ctx->rcode = RLM_MODULE_UPDATED; /* We're back here after applying a profile successfully */
1879 }
1880
1881 if (autz_ctx->profile_values && autz_ctx->profile_values[autz_ctx->value_idx]) {
1882 unlang_action_t ret;
1883
1884 autz_ctx->profile_value = fr_ldap_berval_to_string(autz_ctx, autz_ctx->profile_values[autz_ctx->value_idx++]);
1886 ret = rlm_ldap_map_profile(NULL, NULL, inst, request, autz_ctx->ttrunk, autz_ctx->profile_value,
1887 inst->profile.obj_scope, autz_ctx->call_env->profile_filter.vb_strvalue, &autz_ctx->expanded);
1888 switch (ret) {
1889 case UNLANG_ACTION_FAIL:
1890 p_result->rcode = RLM_MODULE_FAIL;
1891 goto finish;
1892
1894 autz_ctx->status = LDAP_AUTZ_USER_PROFILE;
1896
1897 default:
1898 break;
1899 }
1900 }
1901 break;
1902 }
1903
1904 p_result->rcode = autz_ctx->rcode;
1905
1906finish:
1907 talloc_free(autz_ctx);
1908
1910}
1911
1912/** Clear up when cancelling a mod_authorize call
1913 *
1914 */
1915static void mod_authorize_cancel(module_ctx_t const *mctx, UNUSED request_t *request, UNUSED fr_signal_t action)
1916{
1917 ldap_autz_ctx_t *autz_ctx = talloc_get_type_abort(mctx->rctx, ldap_autz_ctx_t);
1918
1919 if (autz_ctx->query && autz_ctx->query->treq) trunk_request_signal_cancel(autz_ctx->query->treq);
1920}
1921
1922/** Ensure authorization context is properly cleared up
1923 *
1924 */
1925static int autz_ctx_free(ldap_autz_ctx_t *autz_ctx)
1926{
1927 talloc_free(autz_ctx->expanded.ctx);
1928 if (autz_ctx->profile_values) ldap_value_free_len(autz_ctx->profile_values);
1929 return 0;
1930}
1931
1932static unlang_action_t CC_HINT(nonnull) mod_authorize(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
1933{
1935 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
1936 ldap_autz_ctx_t *autz_ctx;
1937 fr_ldap_map_exp_t *expanded;
1938 ldap_autz_call_env_t *call_env = talloc_get_type_abort(mctx->env_data, ldap_autz_call_env_t);
1939
1940 MEM(autz_ctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), ldap_autz_ctx_t));
1941 talloc_set_destructor(autz_ctx, autz_ctx_free);
1942 expanded = &autz_ctx->expanded;
1943
1944 /*
1945 * Don't be tempted to add a check for User-Name or
1946 * User-Password here. LDAP authorization can be used
1947 * for many things besides searching for users.
1948 */
1949 if (fr_ldap_map_expand(autz_ctx, expanded, request, call_env->user_map, inst->valuepair_attr,
1950 inst->profile.check_attr, inst->profile.fallthrough_attr) < 0) {
1951 fail:
1952 talloc_free(autz_ctx);
1954 }
1955
1956 autz_ctx->ttrunk = fr_thread_ldap_trunk_get(thread, inst->handle_config.server, inst->handle_config.admin_identity,
1957 inst->handle_config.admin_password, request, &inst->handle_config);
1958 if (!autz_ctx->ttrunk) goto fail;
1959
1960#define CHECK_EXPANDED_SPACE(_expanded) fr_assert((size_t)_expanded->count < (NUM_ELEMENTS(_expanded->attrs) - 1));
1961
1962 /*
1963 * Add any additional attributes we need for checking access, memberships, and profiles
1964 */
1965 if (inst->user.obj_access_attr) {
1966 CHECK_EXPANDED_SPACE(expanded);
1967 expanded->attrs[expanded->count++] = inst->user.obj_access_attr;
1968 }
1969
1970 if (inst->group.userobj_membership_attr && (inst->group.cacheable_dn || inst->group.cacheable_name)) {
1971 CHECK_EXPANDED_SPACE(expanded);
1972 expanded->attrs[expanded->count++] = inst->group.userobj_membership_attr;
1973 }
1974
1975 if (inst->profile.attr) {
1976 CHECK_EXPANDED_SPACE(expanded);
1977 expanded->attrs[expanded->count++] = inst->profile.attr;
1978 }
1979
1980 if (inst->profile.attr_suspend) {
1981 CHECK_EXPANDED_SPACE(expanded);
1982 expanded->attrs[expanded->count++] = inst->profile.attr_suspend;
1983 }
1984 expanded->attrs[expanded->count] = NULL;
1985
1986 autz_ctx->dlinst = mctx->mi;
1987 autz_ctx->inst = inst;
1988 autz_ctx->call_env = call_env;
1989 autz_ctx->status = LDAP_AUTZ_FIND;
1990 autz_ctx->rcode = RLM_MODULE_OK;
1991
1992 if (unlikely(unlang_module_yield(request,
1995 autz_ctx) == UNLANG_ACTION_FAIL)) {
1996 talloc_free(autz_ctx);
1998 }
1999
2000 return rlm_ldap_find_user_async(autz_ctx, p_result,
2001 autz_ctx->inst, request, &autz_ctx->call_env->user_base,
2002 &autz_ctx->call_env->user_filter, autz_ctx->ttrunk, autz_ctx->expanded.attrs,
2003 &autz_ctx->query);
2004}
2005
2006/** Cancel an in progress user modification.
2007 *
2008 */
2009static void user_modify_cancel(module_ctx_t const *mctx, UNUSED request_t *request, UNUSED fr_signal_t action)
2010{
2011 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(mctx->rctx, ldap_user_modify_ctx_t);
2012
2013 if (!usermod_ctx->query || !usermod_ctx->query->treq) return;
2014
2015 trunk_request_signal_cancel(usermod_ctx->query->treq);
2016}
2017
2018/** Handle results of user modification.
2019 *
2020 */
2021static unlang_action_t CC_HINT(nonnull) user_modify_final(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
2022{
2023 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(mctx->rctx, ldap_user_modify_ctx_t);
2024 fr_ldap_query_t *query = usermod_ctx->query;
2025 rlm_rcode_t rcode = RLM_MODULE_OK;
2026
2027 switch (query->ret) {
2029 break;
2030
2032 case LDAP_RESULT_BAD_DN:
2033 RDEBUG2("User object \"%s\" not modified", usermod_ctx->dn);
2034 rcode = RLM_MODULE_INVALID;
2035 break;
2036
2038 rcode = RLM_MODULE_TIMEOUT;
2039 break;
2040
2041 default:
2042 rcode = RLM_MODULE_FAIL;
2043 break;
2044 }
2045
2046 talloc_free(usermod_ctx);
2047 RETURN_UNLANG_RCODE(rcode);
2048}
2049
2051{
2052 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(mctx->rctx, ldap_user_modify_ctx_t);
2053 ldap_usermod_call_env_t *call_env = usermod_ctx->call_env;
2054 LDAPMod **modify;
2055 ldap_mod_tmpl_t *mod;
2056 fr_value_box_t *vb = NULL;
2057 int mod_no = usermod_ctx->expanded_mods, i = 0;
2058 struct berval **value_refs;
2059 struct berval *values;
2060
2061 mod = call_env->mod[usermod_ctx->current_mod];
2062
2063 /*
2064 * If the tmpl produced no boxes, skip
2065 */
2066 if ((mod->op != T_OP_CMP_FALSE) && (fr_value_box_list_num_elements(&usermod_ctx->expanded) == 0)) {
2067 RDEBUG2("Expansion \"%s\" produced no value, skipping attribute \"%s\"", mod->tmpl->name, mod->attr);
2068 goto next;
2069 }
2070
2071 switch (mod->op) {
2072 /*
2073 * T_OP_EQ is *NOT* supported, it is impossible to
2074 * support because of the lack of transactions in LDAP
2075 *
2076 * To allow for binary data, all data is provided as berval which
2077 * requires the operation to be logical ORed with LDAP_MOD_BVALUES
2078 */
2079 case T_OP_ADD_EQ:
2080 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_ADD | LDAP_MOD_BVALUES;
2081 break;
2082
2083 case T_OP_SET:
2084 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_REPLACE | LDAP_MOD_BVALUES;
2085 break;
2086
2087 case T_OP_SUB_EQ:
2088 case T_OP_CMP_FALSE:
2089 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_DELETE | LDAP_MOD_BVALUES;
2090 break;
2091
2092 case T_OP_INCRM:
2093 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_INCREMENT | LDAP_MOD_BVALUES;
2094 break;
2095
2096 default:
2097 REDEBUG("Operator '%s' is not supported for LDAP modify operations",
2098 fr_table_str_by_value(fr_tokens_table, mod->op, "<INVALID>"));
2099
2101 }
2102
2103 if (mod->op == T_OP_CMP_FALSE) {
2104 MEM(value_refs = talloc_zero_array(usermod_ctx, struct berval *, 1));
2105 } else {
2106 MEM(value_refs = talloc_zero_array(usermod_ctx, struct berval *,
2107 fr_value_box_list_num_elements(&usermod_ctx->expanded) + 1));
2108 MEM(values = talloc_zero_array(usermod_ctx, struct berval,
2109 fr_value_box_list_num_elements(&usermod_ctx->expanded)));
2110 while ((vb = fr_value_box_list_pop_head(&usermod_ctx->expanded))) {
2111 switch (vb->type) {
2112 case FR_TYPE_OCTETS:
2113 if (vb->vb_length == 0) continue;
2114 memcpy(&values[i].bv_val, &vb->vb_octets, sizeof(values[i].bv_val));
2115 values[i].bv_len = vb->vb_length;
2116 break;
2117
2118 case FR_TYPE_STRING:
2119 populate_string:
2120 if (vb->vb_length == 0) continue;
2121 memcpy(&values[i].bv_val, &vb->vb_strvalue, sizeof(values[i].bv_val));
2122 values[i].bv_len = vb->vb_length;
2123 break;
2124
2125 case FR_TYPE_GROUP:
2126 {
2127 fr_value_box_t *vb_head = fr_value_box_list_head(&vb->vb_group);
2128 if (fr_value_box_list_concat_in_place(vb_head, vb_head, &vb->vb_group, FR_TYPE_STRING,
2129 FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
2130 RPEDEBUG("Failed concatenating update value");
2132 }
2133 vb = vb_head;
2134 goto populate_string;
2135 }
2136
2137 case FR_TYPE_FIXED_SIZE:
2138 if (fr_value_box_cast_in_place(vb, vb, FR_TYPE_STRING, NULL) < 0) {
2139 RPEDEBUG("Failed casting update value");
2141 }
2142 goto populate_string;
2143
2144 default:
2145 fr_assert(0);
2146
2147 }
2148 value_refs[i] = &values[i];
2149 i++;
2150 }
2151 if (i == 0) {
2152 RDEBUG2("Expansion \"%s\" produced zero length value, skipping attribute \"%s\"", mod->tmpl->name, mod->attr);
2153 goto next;
2154 }
2155 }
2156
2157 /*
2158 * Now everything is evaluated, set up the pointers for the LDAPMod
2159 */
2160 memcpy(&(usermod_ctx->mod_s[mod_no].mod_type), &mod->attr, sizeof(usermod_ctx->mod_s[mod_no].mod_type));
2161 usermod_ctx->mod_s[mod_no].mod_bvalues = value_refs;
2162 usermod_ctx->mod_p[mod_no] = &usermod_ctx->mod_s[mod_no];
2163
2164 usermod_ctx->expanded_mods++;
2165 usermod_ctx->mod_p[usermod_ctx->expanded_mods] = NULL;
2166
2167next:
2168 usermod_ctx->current_mod++;
2169
2170 /*
2171 * Keep calling until we've completed all the modifications
2172 */
2173 if (usermod_ctx->current_mod < usermod_ctx->num_mods) {
2175 if (unlang_tmpl_push(usermod_ctx, &usermod_ctx->expanded, request,
2176 usermod_ctx->call_env->mod[usermod_ctx->current_mod]->tmpl, NULL) < 0) RETURN_UNLANG_FAIL;
2178 }
2179
2180 modify = usermod_ctx->mod_p;
2181
2183
2184 return fr_ldap_trunk_modify(usermod_ctx, &usermod_ctx->query, request, usermod_ctx->ttrunk,
2185 usermod_ctx->dn, modify, NULL, NULL);
2186}
2187
2188/** Take the retrieved user DN and launch the async tmpl expansion of mod_values.
2189 *
2190 */
2191static unlang_action_t CC_HINT(nonnull) user_modify_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
2192{
2193 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(mctx->rctx, ldap_user_modify_ctx_t);
2194
2195 /*
2196 * If an LDAP search was used to find the user DN
2197 * usermod_ctx->dn will be NULL.
2198 */
2199 if (!usermod_ctx->dn) usermod_ctx->dn = rlm_find_user_dn_cached(request);
2200
2201 if (!usermod_ctx->dn) {
2202 fail:
2203 talloc_free(usermod_ctx);
2205 }
2206
2207 /*
2208 * Allocate arrays to hold mods. mod_p is one element longer to hold a terminating NULL entry
2209 */
2210 MEM(usermod_ctx->mod_p = talloc_zero_array(usermod_ctx, LDAPMod *, usermod_ctx->num_mods + 1));
2211 MEM(usermod_ctx->mod_s = talloc_array(usermod_ctx, LDAPMod, usermod_ctx->num_mods));
2212 fr_value_box_list_init(&usermod_ctx->expanded);
2213
2214 if (unlang_module_yield(request, user_modify_mod_build_resume, NULL, 0, usermod_ctx) == UNLANG_ACTION_FAIL) goto fail;
2215;
2216 if (unlang_tmpl_push(usermod_ctx, &usermod_ctx->expanded, request,
2217 usermod_ctx->call_env->mod[0]->tmpl, NULL) < 0) goto fail;
2218
2220}
2221
2222/** Modify user's object in LDAP
2223 *
2224 * Process a modification map to update a user object in the LDAP directory.
2225 *
2226 * The module method called in "accouting" and "send" sections.
2227 */
2228static unlang_action_t CC_HINT(nonnull) mod_modify(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
2229{
2231 ldap_usermod_call_env_t *call_env = talloc_get_type_abort(mctx->env_data, ldap_usermod_call_env_t);
2232 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
2233 ldap_user_modify_ctx_t *usermod_ctx = NULL;
2234
2235 size_t num_mods = talloc_array_length(call_env->mod);
2236
2237 if (num_mods == 0) RETURN_UNLANG_NOOP;
2238
2239 /*
2240 * Include a talloc pool allowing for one value per modification
2241 */
2243 2 * num_mods + 2,
2244 (sizeof(struct berval) + (sizeof(struct berval *) * 2) +
2245 (sizeof(LDAPMod) + sizeof(LDAPMod *))) * num_mods));
2246 *usermod_ctx = (ldap_user_modify_ctx_t) {
2247 .inst = inst,
2248 .call_env = call_env,
2249 .num_mods = num_mods
2250 };
2251
2252 usermod_ctx->ttrunk = fr_thread_ldap_trunk_get(thread, inst->handle_config.server,
2253 inst->handle_config.admin_identity,
2254 inst->handle_config.admin_password,
2255 request, &inst->handle_config);
2256 if (!usermod_ctx->ttrunk) {
2257 REDEBUG("Unable to get LDAP trunk for update");
2258 talloc_free(usermod_ctx);
2260 }
2261
2262 usermod_ctx->dn = rlm_find_user_dn_cached(request);
2263 /*
2264 * Find the user first
2265 */
2266 if (!usermod_ctx->dn) {
2267 if (unlang_module_yield(request, user_modify_resume, NULL, 0, usermod_ctx) == UNLANG_ACTION_FAIL) {
2268 talloc_free(usermod_ctx);
2270 }
2271
2272 /* Pushes a frame for user resolution */
2273 if (rlm_ldap_find_user_async(usermod_ctx,
2274 p_result,
2275 usermod_ctx->inst, request,
2276 &usermod_ctx->call_env->user_base,
2277 &usermod_ctx->call_env->user_filter,
2278 usermod_ctx->ttrunk, NULL, NULL) == UNLANG_ACTION_FAIL) {
2280 }
2281
2283 }
2284
2285 {
2286 module_ctx_t our_mctx = *mctx;
2287 our_mctx.rctx = usermod_ctx;
2288
2289 return user_modify_resume(p_result, &our_mctx, request);
2290 }
2291}
2292
2293/** Detach from the LDAP server and cleanup internal state.
2294 *
2295 */
2296static int mod_detach(module_detach_ctx_t const *mctx)
2297{
2298 rlm_ldap_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2299
2300 if (inst->user.obj_sort_ctrl) ldap_control_free(inst->user.obj_sort_ctrl);
2301 if (inst->profile.obj_sort_ctrl) ldap_control_free(inst->profile.obj_sort_ctrl);
2302
2303 return 0;
2304}
2305
2306static int ldap_update_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules,
2307 CONF_ITEM *ci,
2308 UNUSED call_env_ctx_t const *cec, call_env_parser_t const *rule)
2309{
2310 map_list_t *maps;
2311 CONF_SECTION *update = cf_item_to_section(ci);
2312 ldap_update_rules_t const *ur = rule->uctx;
2313
2314 bool expect_password = false;
2315
2316 /*
2317 * Build the attribute map
2318 */
2319 {
2320 map_t const *map = NULL;
2321 tmpl_attr_t const *ar;
2322 call_env_parsed_t *parsed;
2323
2324 MEM(parsed = call_env_parsed_add(ctx, out,
2326 .name = "update",
2327 .flags = CALL_ENV_FLAG_PARSE_ONLY,
2328 .pair = {
2329 .parsed = {
2330 .offset = ur->map_offset,
2332 }
2333 }
2334 }));
2335
2336 MEM(maps = talloc(parsed, map_list_t));
2337 map_list_init(maps);
2338
2339 if (update && (map_afrom_cs(maps, maps, update, t_rules, t_rules, fr_ldap_map_verify,
2340 NULL, LDAP_MAX_ATTRMAP)) < 0) {
2341 call_env_parsed_free(out, parsed);
2342 return -1;
2343 }
2344 /*
2345 * Check map to see if a password is being retrieved.
2346 * fr_ldap_map_verify ensures that all maps have attributes on the LHS.
2347 * All passwords have a common parent attribute of attr_password
2348 */
2349 while ((map = map_list_next(maps, map))) {
2350 ar = tmpl_attr_tail(map->lhs);
2351 if (ar->da->parent == attr_password) {
2352 expect_password = true;
2353 break;
2354 }
2355 }
2356 call_env_parsed_set_data(parsed, maps);
2357 }
2358
2359 /*
2360 * Write out whether we expect a password to be returned from the ldap data
2361 */
2362 if (ur->expect_password_offset >= 0) {
2363 call_env_parsed_t *parsed;
2364 fr_value_box_t *vb;
2365
2366 MEM(parsed = call_env_parsed_add(ctx, out,
2368 .name = "expect_password",
2369 .flags = CALL_ENV_FLAG_PARSE_ONLY,
2370 .pair = {
2371 .parsed = {
2372 .offset = ur->expect_password_offset,
2374 }
2375 }
2376 }));
2377 MEM(vb = fr_value_box_alloc(parsed, FR_TYPE_BOOL, NULL));
2378 vb->vb_bool = expect_password;
2379 call_env_parsed_set_value(parsed, vb);
2380 }
2381
2382 return 0;
2383}
2384
2385static int ldap_mod_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules,
2386 CONF_ITEM *ci, call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
2387{
2388 CONF_SECTION const *subcs = NULL;
2389 CONF_PAIR const *to_parse = NULL;
2390 tmpl_t *parsed_tmpl;
2391 call_env_parsed_t *parsed_env;
2392 char *section2, *p;
2393 ssize_t count, slen, multi_index = 0;
2394 ldap_mod_tmpl_t *mod;
2395
2397
2398 section2 = talloc_strdup(NULL, section_name_str(cec->asked->name2));
2399 p = section2;
2400 while (*p != '\0') {
2401 *(p) = tolower((uint8_t)*p);
2402 p++;
2403 }
2404
2405 if (!ci) {
2406 not_found:
2407 cf_log_warn(ci, "No section found for \"%s.%s\" in module \"%s\", this call will have no effect.",
2408 section_name_str(cec->asked->name1), section2, cec->mi->name);
2409 free:
2410 talloc_free(section2);
2411 return 0;
2412 }
2413
2414 subcs = cf_section_find(cf_item_to_section(ci), section2, CF_IDENT_ANY);
2415 if (!subcs) goto not_found;
2416
2417 subcs = cf_section_find(subcs, "update", CF_IDENT_ANY);
2418 if (!subcs) {
2419 cf_log_warn(ci, "No update found inside \"%s -> %s\" in module \"%s\"",
2420 section_name_str(cec->asked->name1), section2, cec->mi->name);
2421 goto free;
2422 }
2423
2425 if (count == 0) {
2426 cf_log_warn(ci, "No modifications found for \"%s.%s\" in module \"%s\"",
2427 section_name_str(cec->asked->name1), section2, cec->mi->name);
2428 goto free;
2429 }
2430 talloc_free(section2);
2431
2432 while ((to_parse = cf_pair_next(subcs, to_parse))) {
2433 switch (cf_pair_operator(to_parse)) {
2434 case T_OP_SET:
2435 case T_OP_ADD_EQ:
2436 case T_OP_SUB_EQ:
2437 case T_OP_CMP_FALSE:
2438 case T_OP_INCRM:
2439 break;
2440
2441 default:
2442 cf_log_perr(to_parse, "Invalid operator for LDAP modification");
2443 return -1;
2444 }
2445
2446 MEM(parsed_env = call_env_parsed_add(ctx, out,
2451 }));
2452
2453 slen = tmpl_afrom_substr(parsed_env, &parsed_tmpl,
2454 &FR_SBUFF_IN(cf_pair_value(to_parse), talloc_array_length(cf_pair_value(to_parse)) - 1),
2456 t_rules);
2457
2458 if (slen <= 0) {
2459 cf_canonicalize_error(to_parse, slen, "Failed parsing LDAP modification \"%s\"", cf_pair_value(to_parse));
2460 error:
2461 call_env_parsed_free(out, parsed_env);
2462 return -1;
2463 }
2464 if (tmpl_needs_resolving(parsed_tmpl) &&
2465 (tmpl_resolve(parsed_tmpl, &(tmpl_res_rules_t){ .dict_def = t_rules->attr.dict_def }) <0)) {
2466 cf_log_perr(to_parse, "Failed resolving LDAP modification \"%s\"", cf_pair_value(to_parse));
2467 goto error;
2468 }
2469
2470 MEM(mod = talloc(parsed_env, ldap_mod_tmpl_t));
2471 mod->attr = cf_pair_attr(to_parse);
2472 mod->tmpl = parsed_tmpl;
2473 mod->op = cf_pair_operator(to_parse);
2474
2475 call_env_parsed_set_multi_index(parsed_env, count, multi_index++);
2476 call_env_parsed_set_data(parsed_env, mod);
2477 }
2478
2479 return 0;
2480}
2481
2482static int ldap_group_filter_parse(TALLOC_CTX *ctx, void *out, tmpl_rules_t const *t_rules, UNUSED CONF_ITEM *ci,
2483 call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
2484{
2486 char const *filters[] = { inst->group.obj_filter, inst->group.obj_membership_filter };
2487 tmpl_t *parsed;
2488
2489 if (fr_ldap_filter_to_tmpl(ctx, t_rules, filters, NUM_ELEMENTS(filters), &parsed) < 0) return -1;
2490
2491 *(void **)out = parsed;
2492 return 0;
2493}
2494
2495/** Clean up thread specific data structure
2496 *
2497 */
2499{
2500 fr_ldap_thread_t *t = talloc_get_type_abort(mctx->thread, fr_ldap_thread_t);
2501 void **trunks_to_free;
2502 int i;
2503
2504 if (fr_rb_flatten_inorder(NULL, &trunks_to_free, t->trunks) < 0) return -1;
2505
2506 for (i = talloc_array_length(trunks_to_free) - 1; i >= 0; i--) talloc_free(trunks_to_free[i]);
2507 talloc_free(trunks_to_free);
2508 talloc_free(t->trunks);
2509
2510 return 0;
2511}
2512
2513/** Initialise thread specific data structure
2514 *
2515 */
2517{
2518 rlm_ldap_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2519 fr_ldap_thread_t *t = talloc_get_type_abort(mctx->thread, fr_ldap_thread_t);
2520 fr_ldap_thread_trunk_t *ttrunk;
2521
2522 /*
2523 * Initialise tree for connection trunks used by this thread
2524 */
2526
2527 t->config = &inst->handle_config;
2528 t->trunk_conf = &inst->trunk_conf;
2529 t->bind_trunk_conf = &inst->bind_trunk_conf;
2530 t->el = mctx->el;
2531
2532 /*
2533 * Launch trunk for module default connection
2534 */
2535 ttrunk = fr_thread_ldap_trunk_get(t, inst->handle_config.server, inst->handle_config.admin_identity,
2536 inst->handle_config.admin_password, NULL, &inst->handle_config);
2537 if (!ttrunk) {
2538 ERROR("Unable to launch LDAP trunk");
2539 return -1;
2540 }
2541
2542 /*
2543 * Set up a per-thread LDAP trunk to use for bind auths
2544 */
2546
2548
2549 return 0;
2550}
2551
2552/** Instantiate the module
2553 *
2554 * Creates a new instance of the module reading parameters from a configuration section.
2555 *
2556 * @param [in] mctx configuration data.
2557 * @return
2558 * - 0 on success.
2559 * - < 0 on failure.
2560 */
2561static int mod_instantiate(module_inst_ctx_t const *mctx)
2562{
2563 size_t i;
2564
2565 CONF_SECTION *options;
2566 rlm_ldap_boot_t const *boot = talloc_get_type_abort(mctx->mi->boot, rlm_ldap_boot_t);
2567 rlm_ldap_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2568 CONF_SECTION *conf = mctx->mi->conf;
2569
2570 inst->mi = mctx->mi; /* Cached for IO callbacks */
2571 inst->group.da = boot->group_da;
2572 inst->group.cache_da = boot->cache_da;
2573
2574 inst->handle_config.name = talloc_typed_asprintf(inst, "rlm_ldap (%s)", mctx->mi->name);
2575
2576 /*
2577 * Trunks used for bind auth can only have one request in flight per connection.
2578 */
2579 inst->bind_trunk_conf.target_req_per_conn = 1;
2580 inst->bind_trunk_conf.max_req_per_conn = 1;
2581
2582 /*
2583 * Set sizes for trunk request pool.
2584 */
2585 inst->bind_trunk_conf.req_pool_headers = 2;
2586 inst->bind_trunk_conf.req_pool_size = sizeof(fr_ldap_bind_auth_ctx_t) + sizeof(fr_ldap_sasl_ctx_t);
2587
2588 options = cf_section_find(conf, "options", NULL);
2589 if (!options || !cf_pair_find(options, "chase_referrals")) {
2590 inst->handle_config.chase_referrals_unset = true; /* use OpenLDAP defaults */
2591 }
2592
2593 /*
2594 * Sanity checks for cacheable groups code.
2595 */
2596 if (inst->group.cacheable_name && inst->group.obj_membership_filter) {
2597 if (!inst->group.obj_name_attr) {
2598 cf_log_err(conf, "Configuration item 'group.name_attribute' must be set if cacheable "
2599 "group names are enabled");
2600
2601 goto error;
2602 }
2603 }
2604
2605 /*
2606 * If we have a *pair* as opposed to a *section*
2607 * then the module is referencing another ldap module's
2608 * connection pool.
2609 */
2610 if (!cf_pair_find(conf, "pool")) {
2611 if (!inst->handle_config.server_str) {
2612 cf_log_err(conf, "Configuration item 'server' must have a value");
2613 goto error;
2614 }
2615 }
2616
2617#ifndef WITH_SASL
2618 if (inst->handle_config.admin_sasl.mech) {
2619 cf_log_err(conf, "Configuration item 'sasl.mech' not supported. "
2620 "Linked libldap does not provide ldap_sasl_interactive_bind function");
2621 goto error;
2622 }
2623#endif
2624
2625 /*
2626 * Initialise server with zero length string to
2627 * make code below simpler.
2628 */
2629 inst->handle_config.server = talloc_strdup(inst, "");
2630
2631 /*
2632 * Now iterate over all the 'server' config items
2633 */
2634 for (i = 0; i < talloc_array_length(inst->handle_config.server_str); i++) {
2635 char const *value = inst->handle_config.server_str[i];
2636 size_t j;
2637
2638 /*
2639 * Explicitly prevent multiple server definitions
2640 * being used in the same string.
2641 */
2642 for (j = 0; j < talloc_array_length(value) - 1; j++) {
2643 switch (value[j]) {
2644 case ' ':
2645 case ',':
2646 case ';':
2647 cf_log_err(conf, "Invalid character '%c' found in 'server' configuration item",
2648 value[j]);
2649 goto error;
2650
2651 default:
2652 continue;
2653 }
2654 }
2655
2656 /*
2657 * Split original server value out into URI, server and port
2658 * so whatever initialization function we use later will have
2659 * the server information in the format it needs.
2660 */
2661 if (ldap_is_ldap_url(value)) {
2662 if (fr_ldap_server_url_check(&inst->handle_config, value, conf) < 0) return -1;
2663 } else
2664 /*
2665 * If it's not an URL, then just treat server as a hostname.
2666 */
2667 {
2668 if (fr_ldap_server_config_check(&inst->handle_config, value, conf) < 0) return -1;
2669 }
2670 }
2671
2672 /*
2673 * inst->handle_config.server be unset if connection pool sharing is used.
2674 */
2675 if (inst->handle_config.server) {
2676 inst->handle_config.server[talloc_array_length(inst->handle_config.server) - 2] = '\0';
2677 DEBUG4("rlm_ldap (%s) - LDAP server string: %s", mctx->mi->name, inst->handle_config.server);
2678 }
2679
2680 /*
2681 * Workaround for servers which support LDAPS but not START TLS
2682 */
2683 if (inst->handle_config.port == LDAPS_PORT || inst->handle_config.tls_mode) {
2684 inst->handle_config.tls_mode = LDAP_OPT_X_TLS_HARD;
2685 } else {
2686 inst->handle_config.tls_mode = 0;
2687 }
2688
2689 /*
2690 * Convert dereference strings to enumerated constants
2691 */
2692 if (inst->handle_config.dereference_str) {
2693 inst->handle_config.dereference = fr_table_value_by_str(fr_ldap_dereference,
2694 inst->handle_config.dereference_str, -1);
2695 if (inst->handle_config.dereference < 0) {
2696 cf_log_err(conf, "Invalid 'dereference' value \"%s\", expected 'never', 'searching', "
2697 "'finding' or 'always'", inst->handle_config.dereference_str);
2698 goto error;
2699 }
2700 }
2701
2702 /*
2703 * Build the server side sort control for user / profile objects
2704 */
2705#define SSS_CONTROL_BUILD(_obj) if (inst->_obj.obj_sort_by) { \
2706 LDAPSortKey **keys; \
2707 int ret; \
2708 ret = ldap_create_sort_keylist(&keys, UNCONST(char *, inst->_obj.obj_sort_by)); \
2709 if (ret != LDAP_SUCCESS) { \
2710 cf_log_err(conf, "Invalid " STRINGIFY(_obj) ".sort_by value \"%s\": %s", \
2711 inst->_obj.obj_sort_by, ldap_err2string(ret)); \
2712 goto error; \
2713 } \
2714 /* \
2715 * Always set the control as critical, if it's not needed \
2716 * the user can comment it out... \
2717 */ \
2718 ret = ldap_create_sort_control(ldap_global_handle, keys, 1, &inst->_obj.obj_sort_ctrl); \
2719 ldap_free_sort_keylist(keys); \
2720 if (ret != LDAP_SUCCESS) { \
2721 ERROR("Failed creating server sort control: %s", ldap_err2string(ret)); \
2722 goto error; \
2723 } \
2724 }
2725
2726 SSS_CONTROL_BUILD(user)
2727 SSS_CONTROL_BUILD(profile)
2728
2729 if (inst->handle_config.tls_require_cert_str) {
2730 /*
2731 * Convert cert strictness to enumerated constants
2732 */
2733 inst->handle_config.tls_require_cert = fr_table_value_by_str(fr_ldap_tls_require_cert,
2734 inst->handle_config.tls_require_cert_str, -1);
2735 if (inst->handle_config.tls_require_cert < 0) {
2736 cf_log_err(conf, "Invalid 'tls.require_cert' value \"%s\", expected 'never', "
2737 "'demand', 'allow', 'try' or 'hard'", inst->handle_config.tls_require_cert_str);
2738 goto error;
2739 }
2740 }
2741
2742 if (inst->handle_config.tls_min_version_str) {
2743#ifdef LDAP_OPT_X_TLS_PROTOCOL_TLS1_3
2744 if (strcmp(inst->handle_config.tls_min_version_str, "1.3") == 0) {
2745 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_3;
2746
2747 } else
2748#endif
2749 if (strcmp(inst->handle_config.tls_min_version_str, "1.2") == 0) {
2750 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_2;
2751
2752 } else if (strcmp(inst->handle_config.tls_min_version_str, "1.1") == 0) {
2753 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_1;
2754
2755 } else if (strcmp(inst->handle_config.tls_min_version_str, "1.0") == 0) {
2756 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_0;
2757
2758 } else {
2759 cf_log_err(conf, "Invalid 'tls.tls_min_version' value \"%s\"", inst->handle_config.tls_min_version_str);
2760 goto error;
2761 }
2762 }
2763
2764 return 0;
2765
2766error:
2767 return -1;
2768}
2769
2770/** Bootstrap the module
2771 *
2772 * Define attributes.
2773 *
2774 * @param[in] mctx configuration data.
2775 * @return
2776 * - 0 on success.
2777 * - < 0 on failure.
2778 */
2779static int mod_bootstrap(module_inst_ctx_t const *mctx)
2780{
2781 rlm_ldap_boot_t *boot = talloc_get_type_abort(mctx->mi->boot, rlm_ldap_boot_t);
2782 rlm_ldap_t const *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2783 CONF_SECTION *conf = mctx->mi->conf;
2784 char buffer[256];
2785 char const *group_attribute;
2786 xlat_t *xlat;
2787
2788 if (inst->group.attribute) {
2789 group_attribute = inst->group.attribute;
2790 } else if (cf_section_name2(conf)) {
2791 snprintf(buffer, sizeof(buffer), "%s-LDAP-Group", mctx->mi->name);
2792 group_attribute = buffer;
2793 } else {
2794 group_attribute = "LDAP-Group";
2795 }
2796
2797 boot->group_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), group_attribute);
2798
2799 /*
2800 * If the group attribute was not in the dictionary, create it
2801 */
2802 if (!boot->group_da) {
2804 group_attribute, FR_TYPE_STRING, NULL) < 0) {
2805 PERROR("Error creating group attribute");
2806 return -1;
2807
2808 }
2809 boot->group_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), group_attribute);
2810 }
2811
2812 /*
2813 * Setup the cache attribute
2814 */
2815
2816 if (inst->group.cache_attribute) {
2817 boot->cache_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), inst->group.cache_attribute);
2818 if (!boot->cache_da) {
2820 inst->group.cache_attribute, FR_TYPE_STRING, NULL) < 0) {
2821 PERROR("Error creating cache attribute");
2822 return -1;
2823 }
2824 boot->cache_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), inst->group.cache_attribute);
2825 }
2826 } else {
2827 boot->cache_da = boot->group_da; /* Default to the group_da */
2828 }
2829
2830 xlat = module_rlm_xlat_register(mctx->mi->boot, mctx, NULL, ldap_xlat, FR_TYPE_STRING);
2832
2833 if (unlikely(!(xlat = module_rlm_xlat_register(mctx->mi->boot, mctx, "group", ldap_group_xlat,
2834 FR_TYPE_BOOL)))) return -1;
2837
2838 if (unlikely(!(xlat = module_rlm_xlat_register(mctx->mi->boot, mctx, "profile", ldap_profile_xlat,
2839 FR_TYPE_BOOL)))) return -1;
2842
2844
2845 return 0;
2846}
2847
2848static int mod_load(void)
2849{
2850 xlat_t *xlat;
2851
2852 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.escape", ldap_uri_escape_xlat, FR_TYPE_STRING)))) return -1;
2855 xlat_func_safe_for_set(xlat, LDAP_URI_SAFE_FOR); /* Used for all LDAP escaping */
2856
2857 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.safe", xlat_transparent, FR_TYPE_STRING)))) return -1;
2861
2862 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.unescape", ldap_uri_unescape_xlat, FR_TYPE_STRING)))) return -1;
2865
2866 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.attr_option", ldap_xlat_uri_attr_option, FR_TYPE_STRING)))) return -1;
2869
2870 return 0;
2871}
2872
2873static void mod_unload(void)
2874{
2875 xlat_func_unregister("ldap.uri.escape");
2876 xlat_func_unregister("ldap.uri.safe");
2877 xlat_func_unregister("ldap.uri.unescape");
2878}
2880/* globally exported name */
2881extern module_rlm_t rlm_ldap;
2883 .common = {
2884 .magic = MODULE_MAGIC_INIT,
2885 .name = "ldap",
2886 .flags = 0,
2889 .config = module_config,
2890 .onload = mod_load,
2891 .unload = mod_unload,
2892 .bootstrap = mod_bootstrap,
2893 .instantiate = mod_instantiate,
2894 .detach = mod_detach,
2896 .thread_instantiate = mod_thread_instantiate,
2897 .thread_detach = mod_thread_detach,
2898 },
2899 .method_group = {
2900 .bindings = (module_method_binding_t[]){
2901 /*
2902 * Hack to support old configurations
2903 */
2904 { .section = SECTION_NAME("accounting", CF_IDENT_ANY), .method = mod_modify, .method_env = &accounting_usermod_method_env },
2905 { .section = SECTION_NAME("authenticate", CF_IDENT_ANY), .method = mod_authenticate, .method_env = &authenticate_method_env },
2906 { .section = SECTION_NAME("authorize", CF_IDENT_ANY), .method = mod_authorize, .method_env = &authorize_method_env },
2907
2908 { .section = SECTION_NAME("recv", CF_IDENT_ANY), .method = mod_authorize, .method_env = &authorize_method_env },
2909 { .section = SECTION_NAME("send", CF_IDENT_ANY), .method = mod_modify, .method_env = &send_usermod_method_env },
2911 }
2912 }
2913};
unlang_action_t
Returned by unlang_op_t calls, determine the next action of the interpreter.
Definition action.h:35
@ UNLANG_ACTION_PUSHED_CHILD
unlang_t pushed a new child onto the stack, execute it instead of continuing.
Definition action.h:39
@ UNLANG_ACTION_FAIL
Encountered an unexpected error.
Definition action.h:36
@ UNLANG_ACTION_CALCULATE_RESULT
Calculate a new section rlm_rcode_t value.
Definition action.h:37
@ UNLANG_ACTION_YIELD
Temporarily pause execution until an event occurs.
Definition action.h:41
static int const char char buffer[256]
Definition acutest.h:576
log_entry msg
Definition acutest.h:794
#define USES_APPLE_DEPRECATED_API
Definition build.h:472
#define RCSID(id)
Definition build.h:485
#define L(_str)
Helper for initialising arrays of string literals.
Definition build.h:209
#define FALL_THROUGH
clang 10 doesn't recognised the FALL-THROUGH comment anymore
Definition build.h:324
#define unlikely(_x)
Definition build.h:383
#define UNUSED
Definition build.h:317
#define NUM_ELEMENTS(_t)
Definition build.h:339
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:754
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:667
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:739
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:724
void call_env_parsed_set_value(call_env_parsed_t *parsed, fr_value_box_t const *vb)
Assign a value box to a call_env_parsed_t.
Definition call_env.c:710
#define CALL_ENV_TERMINATOR
Definition call_env.h:236
call_env_ctx_type_t type
Type of callenv ctx.
Definition call_env.h:227
@ CALL_ENV_CTX_TYPE_MODULE
The callenv is registered to a module method.
Definition call_env.h:222
#define FR_CALL_ENV_PARSE_OFFSET(_name, _cast_type, _flags, _struct, _field, _parse_field)
Specify a call_env_parser_t which writes out runtime results and the result of the parsing phase to t...
Definition call_env.h:365
#define FR_CALL_ENV_METHOD_OUT(_inst)
Helper macro for populating the size/type fields of a call_env_method_t from the output structure typ...
Definition call_env.h:240
call_env_parser_t const * env
Parsing rules for call method env.
Definition call_env.h:247
section_name_t const * asked
The actual name1/name2 that resolved to a module_method_binding_t.
Definition call_env.h:232
void const * uctx
User context for callback functions.
Definition call_env.h:218
#define FR_CALL_ENV_SUBSECTION(_name, _name2, _flags, _subcs)
Specify a call_env_parser_t which defines a nested subsection.
Definition call_env.h:402
@ CALL_ENV_FLAG_CONCAT
If the tmpl produced multiple boxes they should be concatenated.
Definition call_env.h:76
@ CALL_ENV_FLAG_ATTRIBUTE
Tmpl MUST contain an attribute reference.
Definition call_env.h:86
@ CALL_ENV_FLAG_PARSE_ONLY
The result of parsing will not be evaluated at runtime.
Definition call_env.h:85
@ CALL_ENV_FLAG_NONE
Definition call_env.h:74
@ CALL_ENV_FLAG_MULTI
Multiple instances of the conf pairs are allowed.
Definition call_env.h:78
@ CALL_ENV_FLAG_REQUIRED
Associated conf pair or section is required.
Definition call_env.h:75
@ CALL_ENV_FLAG_PARSE_MISSING
If this subsection is missing, still parse it.
Definition call_env.h:88
@ CALL_ENV_FLAG_BARE_WORD_ATTRIBUTE
bare words are treated as an attribute, but strings may be xlats.
Definition call_env.h:92
@ CALL_ENV_FLAG_NULLABLE
Tmpl expansions are allowed to produce no output.
Definition call_env.h:80
@ CALL_ENV_PARSE_TYPE_VALUE_BOX
Output of the parsing phase is a single value box (static data).
Definition call_env.h:61
@ CALL_ENV_PARSE_TYPE_VOID
Output of the parsing phase is undefined (a custom structure).
Definition call_env.h:62
module_instance_t const * mi
Module instance that the callenv is registered to.
Definition call_env.h:229
#define FR_CALL_ENV_SUBSECTION_FUNC(_name, _name2, _flags, _func)
Specify a call_env_parser_t which parses a subsection using a callback function.
Definition call_env.h:412
#define FR_CALL_ENV_OFFSET(_name, _cast_type, _flags, _struct, _field)
Specify a call_env_parser_t which writes out runtime results to the specified field.
Definition call_env.h:340
#define FR_CALL_ENV_PARSE_ONLY_OFFSET(_name, _cast_type, _flags, _struct, _parse_field)
Specify a call_env_parser_t which writes out the result of the parsing phase to the field specified.
Definition call_env.h:389
Per method call config.
Definition call_env.h:180
int cf_table_parse_int(UNUSED TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
Generic function for parsing conf pair values as int.
Definition cf_parse.c:1592
#define CONF_PARSER_TERMINATOR
Definition cf_parse.h:658
cf_parse_t func
Override default parsing behaviour for the specified type with a custom parsing function.
Definition cf_parse.h:612
#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
#define FR_CONF_POINTER(_name, _type, _flags, _res_p)
conf_parser_t which parses a single CONF_PAIR producing a single global result
Definition cf_parse.h:339
#define FR_CONF_OFFSET_IS_SET(_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:298
#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
#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_MULTI
CONF_PAIR can have multiple copies.
Definition cf_parse.h:448
@ CONF_FLAG_XLAT
string will be dynamically expanded.
Definition cf_parse.h:445
@ CONF_FLAG_SUBSECTION
Instead of putting the information into a configuration structure, the configuration file routines MA...
Definition cf_parse.h:428
Defines a CONF_PAIR to C data type mapping.
Definition cf_parse.h:595
Common header for all CONF_* types.
Definition cf_priv.h:49
Configuration AVP similar to a fr_pair_t.
Definition cf_priv.h:70
A section grouping multiple CONF_PAIR.
Definition cf_priv.h:101
unsigned int cf_pair_count_descendents(CONF_SECTION const *cs)
Count the number of conf pairs beneath a section.
Definition cf_util.c:1504
char const * cf_section_name2(CONF_SECTION const *cs)
Return the second identifier of a CONF_SECTION.
Definition cf_util.c:1184
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
CONF_SECTION * cf_item_to_section(CONF_ITEM const *ci)
Cast a CONF_ITEM to a CONF_SECTION.
Definition cf_util.c:683
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
fr_token_t cf_pair_operator(CONF_PAIR const *pair)
Return the operator of a pair.
Definition cf_util.c:1607
fr_token_t cf_pair_value_quote(CONF_PAIR const *pair)
Return the value (rhs) quoting of a pair.
Definition cf_util.c:1637
CONF_PAIR * cf_pair_next(CONF_SECTION const *cs, CONF_PAIR const *curr)
Return the next child that's a CONF_PAIR.
Definition cf_util.c:1412
char const * cf_pair_value(CONF_PAIR const *pair)
Return the value of a CONF_PAIR.
Definition cf_util.c:1593
char const * cf_pair_attr(CONF_PAIR const *pair)
Return the attr of a CONF_PAIR.
Definition cf_util.c:1577
#define cf_log_err(_cf, _fmt,...)
Definition cf_util.h:289
#define cf_canonicalize_error(_ci, _slen, _msg, _str)
Definition cf_util.h:367
#define cf_log_perr(_cf, _fmt,...)
Definition cf_util.h:296
#define cf_log_warn(_cf, _fmt,...)
Definition cf_util.h:290
#define CF_IDENT_ANY
Definition cf_util.h:78
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
#define MEM(x)
Definition debug.h:36
#define ERROR(fmt,...)
Definition dhcpclient.c:41
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_t * fr_dict_unconst(fr_dict_t const *dict)
Coerce to non-const.
Definition dict_util.c:4629
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_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_t const ** out
Where to write a pointer to the resolved fr_dict_attr_t.
Definition dict.h:274
fr_dict_t const ** out
Where to write a pointer to the loaded/resolved fr_dict_t.
Definition dict.h:287
static fr_slen_t in
Definition dict.h:841
Specifies an attribute which must be present for the module to function.
Definition dict.h:273
Specifies a dictionary which must be loaded/loadable for the module to function.
Definition dict.h:286
Test enumeration values.
Definition dict_test.h:92
#define MODULE_MAGIC_INIT
Stop people using different module/library/server versions together.
Definition dl_module.h:63
#define unlang_function_push_with_result(_result_p, _request, _func, _repeat, _signal, _sigmask, _top_frame, _uctx)
Push a generic function onto the unlang stack that produces a result.
Definition function.h:144
#define GLOBAL_LIB_TERMINATOR
Definition global_lib.h:51
Structure to define how to initialise libraries with global configuration.
Definition global_lib.h:38
static xlat_action_t ldap_uri_escape_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Escape LDAP string.
Definition rlm_ldap.c:422
static xlat_action_t ldap_xlat(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Expand an LDAP URL into a query, and return a string result from that query.
Definition rlm_ldap.c:840
static xlat_action_t ldap_group_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Check for a user being in a LDAP group.
Definition rlm_ldap.c:1047
static xlat_action_t ldap_profile_xlat(UNUSED TALLOC_CTX *ctx, UNUSED fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Expand an LDAP URL into a query, applying the results using the user update map.
Definition rlm_ldap.c:1178
static xlat_action_t ldap_xlat_uri_attr_option(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Modify an LDAP URI to append an option to all attributes.
Definition rlm_ldap.c:581
static xlat_action_t ldap_uri_unescape_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, UNUSED xlat_ctx_t const *xctx, request_t *request, fr_value_box_list_t *in)
Unescape LDAP string.
Definition rlm_ldap.c:477
unlang_action_t rlm_ldap_cacheable_groupobj(unlang_result_t *p_result, request_t *request, ldap_autz_ctx_t *autz_ctx)
Convert group membership information into attributes.
Definition groups.c:698
unlang_action_t rlm_ldap_check_groupobj_dynamic(unlang_result_t *p_result, request_t *request, ldap_group_xlat_ctx_t *xlat_ctx)
Initiate an LDAP search to determine group membership, querying group objects.
Definition groups.c:787
unlang_action_t rlm_ldap_cacheable_userobj(unlang_result_t *p_result, request_t *request, ldap_autz_ctx_t *autz_ctx, char const *attr)
Convert group membership information into attributes.
Definition groups.c:441
unlang_action_t rlm_ldap_check_userobj_dynamic(unlang_result_t *p_result, request_t *request, ldap_group_xlat_ctx_t *xlat_ctx)
Query the LDAP directory to check if a user object is a member of a group.
Definition groups.c:1138
unlang_action_t rlm_ldap_check_cached(unlang_result_t *p_result, rlm_ldap_t const *inst, request_t *request, fr_value_box_t const *check)
Check group membership attributes to see if a user is a member.
Definition groups.c:1181
free(array)
void unlang_interpret_mark_runnable(request_t *request)
Mark a request as resumable.
Definition interpret.c:1616
TALLOC_CTX * unlang_interpret_frame_talloc_ctx(request_t *request)
Get a talloc_ctx which is valid only for this frame.
Definition interpret.c:1661
fr_event_list_t * unlang_interpret_event_list(request_t *request)
Get the event list for the current interpreter.
Definition interpret.c:2013
#define UNLANG_SUB_FRAME
Definition interpret.h:37
rlm_rcode_t rcode
The current rcode, from executing the instruction or merging the result from a frame.
Definition interpret.h:134
char const * fr_ldap_url_err_to_str(int ldap_url_err)
Translate the error code emitted from ldap_url_parse and friends into something accessible with fr_st...
Definition util.c:795
int fr_ldap_map_verify(map_t *map, void *instance)
size_t fr_ldap_uri_unescape_func(UNUSED request_t *request, char *out, size_t outlen, char const *in, UNUSED void *arg))
Converts escaped DNs and filter strings into normal.
Definition util.c:159
size_t fr_ldap_util_normalise_dn(char *out, char const *in)
Normalise escape sequences in a DN.
Definition util.c:492
int fr_ldap_map_getvalue(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request, map_t const *map, void *uctx)
Callback for map_to_request.
Definition map.c:39
size_t fr_ldap_uri_escape_func(UNUSED request_t *request, char *out, size_t outlen, char const *in, UNUSED void *arg))
Converts "bad" strings into ones which are safe for LDAP.
Definition util.c:72
int fr_ldap_filter_to_tmpl(TALLOC_CTX *ctx, tmpl_rules_t const *t_rules, char const **sub, size_t sublen, tmpl_t **out))
Combine filters and tokenize to a tmpl.
Definition util.c:570
struct berval ** values
libldap struct containing bv_val (char *) and length bv_len.
Definition base.h:361
fr_ldap_control_t serverctrls[LDAP_MAX_CONTROLS]
Server controls specific to this query.
Definition base.h:450
int fr_ldap_map_do(request_t *request, char const *check_attr, char const *valuepair_attr, fr_ldap_map_exp_t const *expanded, LDAPMessage *entry)
Convert attribute map into valuepairs.
Definition map.c:335
fr_time_delta_t res_timeout
How long we wait for results.
Definition base.h:298
char const * admin_password
Password used in administrative bind.
Definition base.h:231
fr_ldap_config_t * config
Module instance config.
Definition base.h:383
int count
Index on next free element.
Definition base.h:375
bool fr_ldap_util_is_dn(char const *in, size_t inlen)
Check whether a string looks like a DN.
Definition util.c:206
char * server
Initial server to bind to.
Definition base.h:224
static int8_t fr_ldap_bind_auth_cmp(void const *one, void const *two)
Compare two ldap bind auth structures on msgid.
Definition base.h:724
LDAP * handle
libldap handle.
Definition base.h:333
char const * admin_identity
Identity we bind as when we need to query the LDAP directory.
Definition base.h:229
fr_ldap_result_code_t ret
Result code.
Definition base.h:470
bool freeit
Whether the control should be freed after we've finished using it.
Definition base.h:136
fr_rb_tree_t * trunks
Tree of LDAP trunks used by this thread.
Definition base.h:382
trunk_conf_t * trunk_conf
Module trunk config.
Definition base.h:384
trunk_request_t * treq
Trunk request this query is associated with.
Definition base.h:456
fr_ldap_thread_trunk_t * fr_thread_ldap_trunk_get(fr_ldap_thread_t *thread, char const *uri, char const *bind_dn, char const *bind_password, request_t *request, fr_ldap_config_t const *config)
Find a thread specific LDAP connection for a specific URI / bind DN.
Definition connection.c:917
int fr_ldap_server_url_check(fr_ldap_config_t *handle_config, char const *server, CONF_SECTION const *cs)
Check an LDAP server entry in URL format is valid.
Definition util.c:658
char * fr_ldap_berval_to_string(TALLOC_CTX *ctx, struct berval const *in)
Convert a berval to a talloced string.
Definition util.c:443
int count
Number of values.
Definition base.h:363
#define LDAP_MAX_ATTRMAP
Maximum number of mappings between LDAP and FreeRADIUS attributes.
Definition base.h:96
int fr_ldap_box_escape(fr_value_box_t *vb, UNUSED void *uctx)
Definition util.c:112
static int8_t fr_ldap_trunk_cmp(void const *one, void const *two)
Compare two ldap trunk structures on connection URI / DN.
Definition base.h:695
int fr_ldap_server_config_check(fr_ldap_config_t *handle_config, char const *server, CONF_SECTION *cs)
Check an LDAP server config in server:port format is valid.
Definition util.c:754
unlang_action_t fr_ldap_edir_get_password(unlang_result_t *p_result, request_t *request, char const *dn, fr_ldap_thread_trunk_t *ttrunk, fr_dict_attr_t const *password_da)
Initiate retrieval of the universal password from Novell eDirectory.
Definition edir.c:292
fr_ldap_connection_t * ldap_conn
LDAP connection this query is running on.
Definition base.h:457
fr_ldap_result_code_t
LDAP query result codes.
Definition base.h:188
@ LDAP_RESULT_TIMEOUT
The query timed out.
Definition base.h:192
@ LDAP_RESULT_SUCCESS
Successfully got LDAP results.
Definition base.h:190
@ LDAP_RESULT_NO_RESULT
No results returned.
Definition base.h:194
@ LDAP_RESULT_BAD_DN
The requested DN does not exist.
Definition base.h:193
fr_ldap_thread_trunk_t * fr_thread_ldap_bind_trunk_get(fr_ldap_thread_t *thread)
Find the thread specific trunk to use for LDAP bind auths.
int fr_ldap_map_expand(TALLOC_CTX *ctx, fr_ldap_map_exp_t *expanded, request_t *request, map_list_t const *maps, char const *generic_attr, char const *check_attr, char const *fallthrough_attr)
Expand values in an attribute map where needed.
Definition map.c:279
#define LDAP_MAX_CONTROLS
Maximum number of client/server controls.
Definition base.h:94
trunk_conf_t * bind_trunk_conf
Trunk config for bind auth trunk.
Definition base.h:385
#define LDAP_VIRTUAL_DN_ATTR
'Virtual' attribute which maps to the DN of the object.
Definition base.h:113
int fr_ldap_parse_url_extensions(LDAPControl **sss, size_t sss_len, char *extensions[])
Parse a subset (just server side sort and virtual list view for now) of LDAP URL extensions.
Definition util.c:304
LDAPMessage * result
Head of LDAP results list.
Definition base.h:468
fr_event_list_t * el
Thread event list for callbacks / timeouts.
Definition base.h:386
LDAPControl * control
LDAP control.
Definition base.h:135
char const * attrs[LDAP_MAX_ATTRMAP+LDAP_MAP_RESERVED+1]
Reserve some space for access attributes.
Definition base.h:372
fr_ldap_thread_trunk_t * bind_trunk
LDAP trunk used for bind auths.
Definition base.h:387
trunk_t * trunk
Connection trunk.
Definition base.h:405
unlang_action_t fr_ldap_bind_auth_async(unlang_result_t *p_result, request_t *request, fr_ldap_thread_t *thread, char const *bind_dn, char const *password)
Initiate an async LDAP bind for authentication.
Definition bind.c:326
fr_timer_t * ev
Event for timing out the query.
Definition base.h:459
TALLOC_CTX * ctx
Context to allocate new attributes in.
Definition base.h:374
fr_rb_tree_t * binds
Tree of outstanding bind auths.
Definition base.h:388
LDAPURLDesc * ldap_url
parsed URL for current query if the source of the query was a URL.
Definition base.h:426
Holds arguments for async bind auth requests.
Definition base.h:613
Connection configuration.
Definition base.h:221
Tracks the state of a libldap connection handle.
Definition base.h:332
Result of expanding the RHS of a set of maps.
Definition base.h:370
LDAP query structure.
Definition base.h:422
Contains a collection of values.
Definition base.h:360
Holds arguments for the async SASL bind operation.
Definition base.h:506
Thread specific structure to manage LDAP trunk connections.
Definition base.h:381
Thread LDAP trunk structure.
Definition base.h:399
#define FR_LDAP_COMMON_CONF(_conf)
Definition conf.h:19
size_t fr_ldap_scope_len
Definition base.c:77
LDAP * fr_ldap_handle_thread_local(void)
Get a thread local dummy LDAP handle.
Definition base.c:1132
global_lib_autoinst_t fr_libldap_global_config
Definition base.c:136
unlang_action_t fr_ldap_trunk_modify(TALLOC_CTX *ctx, fr_ldap_query_t **out, request_t *request, fr_ldap_thread_trunk_t *ttrunk, char const *dn, LDAPMod *mods[], LDAPControl **serverctrls, LDAPControl **clientctrls)
Run an async modification LDAP query on a trunk connection.
Definition base.c:772
fr_table_num_sorted_t const fr_ldap_tls_require_cert[]
Definition base.c:79
fr_table_num_sorted_t const fr_ldap_dereference[]
Definition base.c:88
fr_ldap_query_t * fr_ldap_search_alloc(TALLOC_CTX *ctx, char const *base_dn, int scope, char const *filter, char const *const *attrs, LDAPControl **serverctrls, LDAPControl **clientctrls)
Allocate a new search object.
Definition base.c:1053
unlang_action_t fr_ldap_trunk_search(TALLOC_CTX *ctx, fr_ldap_query_t **out, request_t *request, fr_ldap_thread_trunk_t *ttrunk, char const *base_dn, int scope, char const *filter, char const *const *attrs, LDAPControl **serverctrls, LDAPControl **clientctrls)
Run an async search LDAP query on a trunk connection.
Definition base.c:720
fr_table_num_sorted_t const fr_ldap_scope[]
Definition base.c:71
#define PERROR(_fmt,...)
Definition log.h:228
#define REXDENT()
Exdent (unindent) R* messages by one level.
Definition log.h:443
#define ROPTIONAL(_l_request, _l_global, _fmt,...)
Use different logging functions depending on whether request is NULL or not.
Definition log.h:528
#define RWDEBUG(fmt,...)
Definition log.h:361
#define RDEBUG_ENABLED3
True if request debug level 1-3 messages are enabled.
Definition log.h:335
#define RDEBUG3(fmt,...)
Definition log.h:343
#define RERROR(fmt,...)
Definition log.h:298
#define DEBUG4(_fmt,...)
Definition log.h:267
#define RPERROR(fmt,...)
Definition log.h:302
#define RPEDEBUG(fmt,...)
Definition log.h:376
#define RINDENT()
Indent R* messages by one level.
Definition log.h:430
int map_afrom_cs(TALLOC_CTX *ctx, map_list_t *out, CONF_SECTION *cs, tmpl_rules_t const *lhs_rules, tmpl_rules_t const *rhs_rules, map_validate_t validate, void *uctx, unsigned int max)
Convert a config section into an attribute map.
Definition map.c:1131
int map_to_request(request_t *request, map_t const *map, radius_map_getvalue_t func, void *ctx)
Convert map_t to fr_pair_t (s) and add them to a request_t.
Definition map.c:1869
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(reap)
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
void * rctx
Resume ctx that a module previously set.
Definition map_proc.h:53
void const * moi
Map module instance.
Definition map_proc.h:54
Temporary structure to hold arguments for map calls.
Definition map_proc.h:52
@ FR_TYPE_TLV
Contains nested attributes.
@ FR_TYPE_STRING
String of printable characters.
@ FR_TYPE_VOID
User data.
@ FR_TYPE_BOOL
A truth value.
@ FR_TYPE_OCTETS
Raw octets.
@ FR_TYPE_GROUP
A grouping of other attributes.
long int ssize_t
unsigned char uint8_t
void * env_data
Per call environment data.
Definition module_ctx.h:44
module_instance_t const * mi
Instance of the module being instantiated.
Definition module_ctx.h:42
void * thread
Thread specific instance data.
Definition module_ctx.h:43
void * rctx
Resume ctx that a module previously set.
Definition module_ctx.h:45
fr_event_list_t * el
Event list to register any IO handlers and timers against.
Definition module_ctx.h:68
module_instance_t * mi
Module instance to detach.
Definition module_ctx.h:57
void * thread
Thread instance data.
Definition module_ctx.h:67
module_instance_t const * mi
Instance of the module being instantiated.
Definition module_ctx.h:64
module_instance_t * mi
Instance of the module being instantiated.
Definition module_ctx.h:51
Temporary structure to hold arguments for module calls.
Definition module_ctx.h:41
Temporary structure to hold arguments for detach calls.
Definition module_ctx.h:56
Temporary structure to hold arguments for instantiation calls.
Definition module_ctx.h:50
Temporary structure to hold arguments for thread_instantiation calls.
Definition module_ctx.h:63
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_t common
Common fields presented by all modules.
Definition module_rlm.h:39
fr_pair_t * fr_pair_find_by_da_nested(fr_pair_list_t const *list, fr_pair_t const *prev, fr_dict_attr_t const *da)
Find a pair with a matching fr_dict_attr_t, by walking the nested fr_dict_attr_t tree.
Definition pair.c:774
fr_pair_t * fr_pair_find_by_da(fr_pair_list_t const *list, fr_pair_t const *prev, fr_dict_attr_t const *da)
Find the first pair with a matching da.
Definition pair.c:697
unlang_action_t rlm_ldap_map_profile(fr_ldap_result_code_t *ret, int *applied, rlm_ldap_t const *inst, request_t *request, fr_ldap_thread_trunk_t *ttrunk, char const *dn, int scope, char const *filter, fr_ldap_map_exp_t const *expanded)
Search for and apply an LDAP profile.
Definition profile.c:212
#define fr_assert(_expr)
Definition rad_assert.h:38
static bool done
Definition radclient.c:81
#define REDEBUG(fmt,...)
Definition radclient.h:52
#define RDEBUG_ENABLED2()
Definition radclient.h:50
#define RDEBUG2(fmt,...)
Definition radclient.h:54
#define RDEBUG(fmt,...)
Definition radclient.h:53
static rs_t * conf
Definition radsniff.c:53
#define fr_rb_inline_talloc_alloc(_ctx, _type, _field, _data_cmp, _data_free)
Allocs a red black that verifies elements are of a specific talloc type.
Definition rb.h:246
int fr_rb_flatten_inorder(TALLOC_CTX *ctx, void **out[], fr_rb_tree_t *tree)
#define RETURN_UNLANG_INVALID
Definition rcode.h:60
#define RETURN_UNLANG_RCODE(_rcode)
Definition rcode.h:66
#define RETURN_UNLANG_NOTFOUND
Definition rcode.h:62
#define RETURN_UNLANG_FAIL
Definition rcode.h:57
#define RETURN_UNLANG_OK
Definition rcode.h:58
rlm_rcode_t
Return codes indicating the result of the module call.
Definition rcode.h:40
@ RLM_MODULE_INVALID
The module considers the request invalid.
Definition rcode.h:45
@ RLM_MODULE_OK
The module is OK, continue.
Definition rcode.h:43
@ RLM_MODULE_FAIL
Module failed, don't reply.
Definition rcode.h:42
@ RLM_MODULE_DISALLOW
Reject the request (user is locked out).
Definition rcode.h:46
@ RLM_MODULE_REJECT
Immediately reject the request.
Definition rcode.h:41
@ RLM_MODULE_TIMEOUT
Module (or section) timed out.
Definition rcode.h:50
@ RLM_MODULE_NOTFOUND
User not found.
Definition rcode.h:47
@ RLM_MODULE_UPDATED
OK (pairs modified).
Definition rcode.h:49
@ RLM_MODULE_HANDLED
The module handled the request, so stop.
Definition rcode.h:44
#define RETURN_UNLANG_NOOP
Definition rcode.h:63
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 *url, map_list_t const *maps)
Perform a search and map the result of the search to server attributes.
Definition rlm_ldap.c:1457
tmpl_t const * tmpl
Definition rlm_ldap.c:70
static void mod_authorize_cancel(module_ctx_t const *mctx, UNUSED request_t *request, UNUSED fr_signal_t action)
Clear up when cancelling a mod_authorize call.
Definition rlm_ldap.c:1915
static const call_env_method_t xlat_memberof_method_env
Definition rlm_ldap.c:270
static int mod_detach(module_detach_ctx_t const *mctx)
Detach from the LDAP server and cleanup internal state.
Definition rlm_ldap.c:2296
static int mod_load(void)
Definition rlm_ldap.c:2845
static xlat_action_t ldap_profile_xlat_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
Return whether evaluating the profile was successful.
Definition rlm_ldap.c:1150
map_list_t * profile_map
List of maps to apply to the profile.
Definition rlm_ldap.c:82
#define REPEAT_LDAP_MEMBEROF_XLAT_RESULTS
Definition rlm_ldap.c:963
static conf_parser_t profile_config[]
Definition rlm_ldap.c:98
static int ldap_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_ldap.c:1307
fr_dict_attr_t const * attr_nt_password
Definition rlm_ldap.c:329
static xlat_arg_parser_t const ldap_safe_xlat_arg[]
Definition rlm_ldap.c:413
ldap_auth_call_env_t * call_env
Definition rlm_ldap.c:360
static const call_env_method_t authenticate_method_env
Definition rlm_ldap.c:191
static xlat_arg_parser_t const ldap_uri_escape_xlat_arg[]
Definition rlm_ldap.c:408
fr_ldap_result_code_t ret
Definition rlm_ldap.c:1141
fr_dict_attr_t const * attr_ldap_userdn
Definition rlm_ldap.c:328
global_lib_autoinst_t const * rlm_ldap_lib[]
Definition rlm_ldap.c:347
static const call_env_method_t authorize_method_env
Definition rlm_ldap.c:214
#define USERMOD_ENV(_section)
Definition rlm_ldap.c:255
fr_value_box_t password
Definition rlm_ldap.c:59
LDAPControl * serverctrls[LDAP_MAX_CONTROLS]
Definition rlm_ldap.c:388
#define SSS_CONTROL_BUILD(_obj)
static xlat_arg_parser_t const ldap_uri_unescape_xlat_arg[]
Definition rlm_ldap.c:468
static const call_env_method_t xlat_profile_method_env
Definition rlm_ldap.c:299
static xlat_arg_parser_t const ldap_uri_attr_option_xlat_arg[]
Definition rlm_ldap.c:566
static int ldap_mod_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, call_env_ctx_t const *cec, call_env_parser_t const *rule)
#define CHECK_EXPANDED_SPACE(_expanded)
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 *url, UNUSED map_list_t const *maps)
Process the results of an LDAP map query.
Definition rlm_ldap.c:1331
static unlang_action_t mod_authorize_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Resume function called after each potential yield in LDAP authorization.
Definition rlm_ldap.c:1634
map_list_t const * maps
Definition rlm_ldap.c:384
fr_dict_attr_t const * attr_crypt_password
Definition rlm_ldap.c:327
fr_value_box_t user_filter
Definition rlm_ldap.c:74
static int ldap_group_filter_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)
static fr_dict_t const * dict_freeradius
Definition rlm_ldap.c:317
static int map_ctx_free(ldap_map_ctx_t *map_ctx)
Ensure map context is properly cleared up.
Definition rlm_ldap.c:1428
fr_dict_attr_t const * cache_da
Definition rlm_ldap.c:55
static void ldap_query_timeout(UNUSED fr_timer_list_t *tl, UNUSED fr_time_t now, void *uctx)
Callback when LDAP query times out.
Definition rlm_ldap.c:543
static unlang_action_t user_modify_mod_build_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Definition rlm_ldap.c:2050
static conf_parser_t user_config[]
Definition rlm_ldap.c:113
static fr_dict_attr_t const * attr_expr_bool_enum
Definition rlm_ldap.c:331
static fr_table_num_sorted_t const ldap_uri_scheme_table[]
Definition rlm_ldap.c:397
static xlat_arg_parser_t const ldap_xlat_arg[]
Definition rlm_ldap.c:741
static unlang_action_t mod_modify(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Modify user's object in LDAP.
Definition rlm_ldap.c:2228
static int ldap_uri_part_escape(fr_value_box_t *vb, UNUSED void *uctx)
Escape function for a part of an LDAP URI.
Definition rlm_ldap.c:514
fr_dict_attr_t const * group_da
Definition rlm_ldap.c:54
static unlang_action_t ldap_group_xlat_user_find(UNUSED unlang_result_t *p_result, request_t *request, void *uctx)
User object lookup as part of group membership xlat.
Definition rlm_ldap.c:936
fr_dict_attr_t const * attr_password
Definition rlm_ldap.c:325
static int mod_bootstrap(module_inst_ctx_t const *mctx)
Bootstrap the module.
Definition rlm_ldap.c:2776
#define REPEAT_MOD_AUTHORIZE_RESUME
Definition rlm_ldap.c:1616
fr_value_box_t user_sasl_proxy
Definition rlm_ldap.c:63
fr_ldap_thread_trunk_t * ttrunk
Definition rlm_ldap.c:372
fr_value_box_t user_sasl_authname
Definition rlm_ldap.c:62
fr_dict_attr_t const * attr_password_with_header
Definition rlm_ldap.c:330
static int ldap_update_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules, CONF_ITEM *ci, call_env_ctx_t const *cec, call_env_parser_t const *rule)
static unlang_action_t mod_authorize(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Definition rlm_ldap.c:1932
rlm_ldap_t const * inst
Definition rlm_ldap.c:367
static conf_parser_t group_config[]
Definition rlm_ldap.c:129
fr_ldap_query_t * query
Definition rlm_ldap.c:386
static void mod_unload(void)
Definition rlm_ldap.c:2870
fr_dict_attr_autoload_t rlm_ldap_dict_attr[]
Definition rlm_ldap.c:334
ldap_mod_tmpl_t ** mod
Definition rlm_ldap.c:75
static xlat_action_t ldap_group_xlat_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
Process the results of evaluating LDAP group membership.
Definition rlm_ldap.c:1025
char const * attr
Definition rlm_ldap.c:68
static unlang_action_t ldap_group_xlat_results(unlang_result_t *p_result, request_t *request, void *uctx)
Run the state machine for the LDAP membership xlat.
Definition rlm_ldap.c:974
static void ldap_group_xlat_cancel(UNUSED request_t *request, UNUSED fr_signal_t action, void *uctx)
Cancel an in-progress query for the LDAP group membership xlat.
Definition rlm_ldap.c:954
ssize_t expect_password_offset
Definition rlm_ldap.c:211
static int ldap_xlat_uri_parse(LDAPURLDesc **uri_parsed, char **host_out, bool *free_host_out, request_t *request, char *host_default, fr_value_box_t *uri_in)
Utility function for parsing LDAP URLs.
Definition rlm_ldap.c:781
static unlang_action_t user_modify_final(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Handle results of user modification.
Definition rlm_ldap.c:2021
static int ldap_xlat_profile_ctx_free(ldap_xlat_profile_ctx_t *to_free)
Definition rlm_ldap.c:1163
static char * host_uri_canonify(request_t *request, LDAPURLDesc *url_parsed, fr_value_box_t *url_in)
Produce canonical LDAP host URI for finding trunks.
Definition rlm_ldap.c:750
fr_dict_attr_t const * attr_cleartext_password
Definition rlm_ldap.c:326
tmpl_t const * password_tmpl
Definition rlm_ldap.c:60
static xlat_action_t ldap_xlat_resume(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx, request_t *request, UNUSED fr_value_box_list_t *in)
Callback when resuming after async ldap query is completed.
Definition rlm_ldap.c:659
fr_value_box_t user_sasl_mech
Definition rlm_ldap.c:61
fr_dict_autoload_t rlm_ldap_dict[]
Definition rlm_ldap.c:320
static int mod_thread_instantiate(module_thread_inst_ctx_t const *mctx)
Initialise thread specific data structure.
Definition rlm_ldap.c:2516
module_rlm_t rlm_ldap
Definition rlm_ldap.c:2879
char const * password
Definition rlm_ldap.c:357
static unlang_action_t mod_authenticate(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Definition rlm_ldap.c:1541
static int autz_ctx_free(ldap_autz_ctx_t *autz_ctx)
Ensure authorization context is properly cleared up.
Definition rlm_ldap.c:1925
ldap_schemes_t
Definition rlm_ldap.c:391
@ LDAP_SCHEME_UNIX
Definition rlm_ldap.c:392
@ LDAP_SCHEME_TCP_SSL
Definition rlm_ldap.c:394
@ LDAP_SCHEME_TCP
Definition rlm_ldap.c:393
fr_token_t op
Definition rlm_ldap.c:69
fr_value_box_t user_base
Definition rlm_ldap.c:73
fr_ldap_map_exp_t expanded
Definition rlm_ldap.c:1144
static void ldap_xlat_signal(xlat_ctx_t const *xctx, request_t *request, UNUSED fr_signal_t action)
Callback for signalling async ldap query.
Definition rlm_ldap.c:706
fr_ldap_query_t * query
Definition rlm_ldap.c:373
fr_ldap_thread_t * thread
Definition rlm_ldap.c:359
static size_t ldap_uri_scheme_table_len
Definition rlm_ldap.c:402
#define LDAP_URI_SAFE_FOR
This is the common function that actually ends up doing all the URI escaping.
Definition rlm_ldap.c:406
static fr_uri_part_t const ldap_dn_parts[]
Definition rlm_ldap.c:736
static const conf_parser_t module_config[]
Definition rlm_ldap.c:146
#define USER_CALL_ENV_COMMON(_struct)
Definition rlm_ldap.c:187
ldap_usermod_call_env_t * call_env
Definition rlm_ldap.c:368
fr_value_box_t profile_filter
Filter to use when searching for users.
Definition rlm_ldap.c:81
static void user_modify_cancel(module_ctx_t const *mctx, UNUSED request_t *request, UNUSED fr_signal_t action)
Cancel an in progress user modification.
Definition rlm_ldap.c:2009
static int mod_thread_detach(module_thread_inst_ctx_t const *mctx)
Clean up thread specific data structure.
Definition rlm_ldap.c:2498
static int mod_instantiate(module_inst_ctx_t const *mctx)
Instantiate the module.
Definition rlm_ldap.c:2561
fr_ldap_map_exp_t expanded
Definition rlm_ldap.c:387
LDAPURLDesc * ldap_url
Definition rlm_ldap.c:385
static const call_env_parser_t sasl_call_env[]
Definition rlm_ldap.c:90
fr_value_box_t user_sasl_realm
Definition rlm_ldap.c:64
fr_value_box_list_t expanded
Definition rlm_ldap.c:374
static fr_uri_part_t const ldap_uri_parts[]
Definition rlm_ldap.c:724
static unlang_action_t user_modify_resume(unlang_result_t *p_result, module_ctx_t const *mctx, request_t *request)
Take the retrieved user DN and launch the async tmpl expansion of mod_values.
Definition rlm_ldap.c:2191
char const * dn
Definition rlm_ldap.c:356
static xlat_arg_parser_t const ldap_group_xlat_arg[]
Definition rlm_ldap.c:1038
rlm_ldap_t const * inst
Definition rlm_ldap.c:358
Holds state of in progress async authentication.
Definition rlm_ldap.c:355
Holds state of in progress LDAP map.
Definition rlm_ldap.c:383
Parameters to allow ldap_update_section_parse to be reused.
Definition rlm_ldap.c:209
Holds state of in progress ldap user modifications.
Definition rlm_ldap.c:366
Call environment used in the profile xlat.
Definition rlm_ldap.c:80
LDAP authorization and authentication module headers.
fr_ldap_map_exp_t expanded
Definition rlm_ldap.h:194
ldap_autz_call_env_t * call_env
Definition rlm_ldap.h:197
struct berval ** profile_values
Definition rlm_ldap.h:200
@ LDAP_ACCESS_SUSPENDED
User account has been suspended.
Definition rlm_ldap.h:185
@ LDAP_ACCESS_ALLOWED
User is allowed to login.
Definition rlm_ldap.h:183
@ LDAP_ACCESS_DISALLOWED
User it not allow to login (disabled)
Definition rlm_ldap.h:184
fr_ldap_thread_trunk_t * ttrunk
Definition rlm_ldap.h:196
rlm_ldap_t const * inst
Definition rlm_ldap.h:193
fr_value_box_t profile_filter
Filter to use when searching for profiles.
Definition rlm_ldap.h:144
fr_value_box_t user_filter
Filter to use when searching for users.
Definition rlm_ldap.h:137
LDAPMessage * entry
Definition rlm_ldap.h:198
@ LDAP_AUTZ_GROUP
Definition rlm_ldap.h:167
@ LDAP_AUTZ_FIND
Definition rlm_ldap.h:166
@ LDAP_AUTZ_DEFAULT_PROFILE
Definition rlm_ldap.h:174
@ LDAP_AUTZ_USER_PROFILE
Definition rlm_ldap.h:176
@ LDAP_AUTZ_MAP
Definition rlm_ldap.h:173
@ LDAP_AUTZ_POST_DEFAULT_PROFILE
Definition rlm_ldap.h:175
@ LDAP_AUTZ_POST_GROUP
Definition rlm_ldap.h:168
ldap_autz_status_t status
Definition rlm_ldap.h:199
fr_ldap_query_t * query
Definition rlm_ldap.h:195
char * profile_value
Definition rlm_ldap.h:202
ldap_access_state_t access_state
What state a user's account is in.
Definition rlm_ldap.h:204
unlang_action_t rlm_ldap_find_user_async(TALLOC_CTX *ctx, unlang_result_t *p_result, rlm_ldap_t const *inst, request_t *request, fr_value_box_t *base, fr_value_box_t *filter_box, fr_ldap_thread_trunk_t *ttrunk, char const *attrs[], fr_ldap_query_t **query_out)
Initiate asynchronous retrieval of the DN of a user object.
Definition user.c:163
fr_value_box_t user_base
Base DN in which to search for users.
Definition rlm_ldap.h:136
char const * dn
Definition rlm_ldap.h:203
map_list_t * user_map
Attribute map applied to users and profiles.
Definition rlm_ldap.h:146
rlm_rcode_t rcode
What rcode we'll finally respond with.
Definition rlm_ldap.h:205
static char const * rlm_find_user_dn_cached(request_t *request)
Definition rlm_ldap.h:248
void rlm_ldap_check_reply(request_t *request, rlm_ldap_t const *inst, char const *inst_name, bool expect_password, fr_ldap_thread_trunk_t const *ttrunk)
Verify we got a password from the search.
Definition user.c:261
fr_value_box_t const * expect_password
True if the user_map included a mapping between an LDAP attribute and one of our password reference a...
Definition rlm_ldap.h:148
fr_value_box_t default_profile
If this is set, we will search for a profile object with this name, and map any attributes it contain...
Definition rlm_ldap.h:140
@ GROUP_XLAT_MEMB_FILTER
Definition rlm_ldap.h:212
@ GROUP_XLAT_MEMB_ATTR
Definition rlm_ldap.h:213
@ GROUP_XLAT_FIND_USER
Definition rlm_ldap.h:211
module_instance_t const * dlinst
Definition rlm_ldap.h:192
ldap_access_state_t rlm_ldap_check_access(rlm_ldap_t const *inst, request_t *request, LDAPMessage *entry)
Check for presence of access attribute in result.
Definition user.c:209
Call environment used in LDAP authorization.
Definition rlm_ldap.h:135
Holds state of in progress async authorization.
Definition rlm_ldap.h:191
Holds state of in progress group membership check xlat.
Definition rlm_ldap.h:219
Call environment used in group membership xlat.
Definition rlm_ldap.h:155
unlang_action_t fr_ldap_sasl_bind_auth_async(unlang_result_t *p_result, request_t *request, fr_ldap_thread_t *thread, char const *mechs, char const *identity, char const *password, char const *proxy, char const *realm)
Initiate an async SASL LDAP bind for authentication.
Definition sasl.c:504
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
#define FR_SBUFF_IN(_start, _len_or_end)
#define FR_SBUFF_TERMS(...)
Initialise a terminal structure with a list of sorted strings.
Definition sbuff.h:192
#define fr_sbuff_buff(_sbuff_or_marker)
Talloc sbuff extension structure.
Definition sbuff.h:139
static char const * section_name_str(char const *name)
Return a printable string for the section name.
Definition section.h:98
#define SECTION_NAME(_name1, _name2)
Define a section name consisting of a verb and a noun.
Definition section.h:40
char const * name2
Second section name. Usually a packet type like 'access-request', 'access-accept',...
Definition section.h:46
char const * name1
First section name. Usually a verb like 'recv', 'send', etc...
Definition section.h:45
#define MODULE_THREAD_INST(_ctype)
Definition module.h:256
char const * name
Instance name e.g. user_database.
Definition module.h:355
module_flags_t flags
Flags that control how a module starts up and how a module is called.
Definition module.h:236
CONF_SECTION * conf
Module's instance configuration.
Definition module.h:349
void * data
Module's instance data.
Definition module.h:291
#define MODULE_BOOT(_ctype)
Definition module.h:254
void * boot
Data allocated during the boostrap phase.
Definition module.h:294
void * data
Thread specific instance data.
Definition module.h:372
static module_thread_instance_t * module_thread(module_instance_t const *mi)
Retrieve module/thread specific instance for a module.
Definition module.h:501
#define MODULE_BINDING_TERMINATOR
Terminate a module binding list.
Definition module.h:152
#define MODULE_INST(_ctype)
Definition module.h:255
Named methods exported by a module.
Definition module.h:174
static tmpl_attr_t const * tmpl_attr_tail(tmpl_t const *vpt)
Return the last attribute reference.
Definition tmpl.h:790
int tmpl_resolve(tmpl_t *vpt, tmpl_res_rules_t const *tr_rules))
Attempt to resolve functions and attributes in xlats and attribute references.
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.
tmpl_attr_rules_t attr
Rules/data for parsing attribute references.
Definition tmpl.h:335
#define tmpl_needs_resolving(vpt)
Definition tmpl.h:223
Similar to tmpl_rules_t, but used to specify parameters that may change during subsequent resolution ...
Definition tmpl.h:364
Optional arguments passed to vp_tmpl functions.
Definition tmpl.h:332
fr_signal_t
Signals that can be generated/processed by request signal handlers.
Definition signal.h:38
@ FR_SIGNAL_CANCEL
Request has been cancelled.
Definition signal.h:40
PUBLIC int snprintf(char *string, size_t length, char *format, va_alist)
Definition snprintf.c:689
return count
Definition module.c:155
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:434
eap_aka_sim_process_conf_t * inst
Value pair map.
Definition map.h:77
tmpl_t * lhs
Typically describes the attribute to add, modify or compare.
Definition map.h:78
fr_dict_t const * dict_def
Default dictionary to use with unqualified attribute references.
Definition tmpl.h:273
An element in a list of nested attribute references.
Definition tmpl.h:430
fr_dict_attr_t const *_CONST da
Resolved dictionary attribute.
Definition tmpl.h:434
Stores an attribute, a value and various bits of other data.
Definition pair.h:68
#define fr_table_value_by_str(_table, _name, _def)
Convert a string to a value using a sorted or ordered table.
Definition table.h:653
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
Definition table.h:772
An element in a lexicographically sorted array of name to num mappings.
Definition table.h:49
char * talloc_typed_strdup_buffer(TALLOC_CTX *ctx, char const *p)
Call talloc_strndup, setting the type on the new chunk correctly.
Definition talloc.c:491
char * talloc_typed_asprintf(TALLOC_CTX *ctx, char const *fmt,...)
Call talloc vasprintf, setting the type on the new chunk correctly.
Definition talloc.c:514
#define talloc_get_type_abort_const
Definition talloc.h:287
#define talloc_pooled_object(_ctx, _type, _num_subobjects, _total_subobjects_size)
Definition talloc.h:180
"server local" time.
Definition time.h:69
An event timer list.
Definition timer.c:50
#define fr_timer_in(...)
Definition timer.h:87
int unlang_tmpl_push(TALLOC_CTX *ctx, fr_value_box_list_t *out, request_t *request, tmpl_t const *tmpl, unlang_tmpl_args_t *args)
Push a tmpl onto the stack for evaluation.
Definition tmpl.c:254
@ TMPL_ESCAPE_PRE_CONCAT
Pre-concatenation escaping is useful for DSLs where elements of the expansion are static,...
Definition tmpl_escape.h:61
fr_table_num_ordered_t const fr_tokens_table[]
Definition token.c:34
enum fr_token fr_token_t
@ T_OP_SUB_EQ
Definition token.h:70
@ T_SINGLE_QUOTED_STRING
Definition token.h:122
@ T_BARE_WORD
Definition token.h:120
@ T_OP_SET
Definition token.h:84
@ T_OP_ADD_EQ
Definition token.h:69
@ T_OP_CMP_FALSE
Definition token.h:105
@ T_OP_INCRM
Definition token.h:113
trunk_enqueue_t trunk_request_enqueue(trunk_request_t **treq_out, trunk_t *trunk, request_t *request, void *preq, void *rctx)
Enqueue a request that needs data written to the trunk.
Definition trunk.c:2586
void trunk_request_signal_cancel(trunk_request_t *treq)
Cancel a trunk request.
Definition trunk.c:2151
conf_parser_t const trunk_config[]
Config parser definitions to populate a trunk_conf_t.
Definition trunk.c:314
Wraps a normal request.
Definition trunk.c:99
@ TRUNK_ENQUEUE_OK
Operation was successful.
Definition trunk.h:150
@ TRUNK_ENQUEUE_IN_BACKLOG
Request should be enqueued in backlog.
Definition trunk.h:149
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:560
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)
uint8_t required
Argument must be present, and non-empty.
Definition xlat.h:146
#define XLAT_ARGS(_list,...)
Populate local variables with value boxes from the input list.
Definition xlat.h:383
#define XLAT_ARG_PARSER_TERMINATOR
Definition xlat.h:170
xlat_action_t
Definition xlat.h:37
@ XLAT_ACTION_FAIL
An xlat function failed.
Definition xlat.h:44
@ XLAT_ACTION_YIELD
An xlat function pushed a resume frame onto the stack.
Definition xlat.h:42
@ XLAT_ACTION_PUSH_UNLANG
An xlat function pushed an unlang frame onto the unlang stack.
Definition xlat.h:39
@ XLAT_ACTION_DONE
We're done evaluating this level of nesting.
Definition xlat.h:43
Definition for a single argument consumend by an xlat function.
Definition xlat.h:145
int fr_uri_escape_list(fr_value_box_list_t *uri, fr_uri_part_t const *uri_parts, void *uctx)
Parse a list of value boxes representing a URI.
Definition uri.c:140
int fr_uri_has_scheme(fr_value_box_list_t *uri, fr_table_num_sorted_t const *schemes, size_t schemes_len, int def)
Searches for a matching scheme in the table of schemes, using a list of value boxes representing the ...
Definition uri.c:167
#define XLAT_URI_PART_TERMINATOR
Definition uri.h:66
char const * name
Name of this part of the URI.
Definition uri.h:47
Definition for a single part of a URI.
Definition uri.h:46
#define fr_strerror_printf_push(_fmt,...)
Add a message to an existing stack of messages at the tail.
Definition strerror.h:84
#define FR_TYPE_FIXED_SIZE
Definition types.h:306
int fr_value_box_asprintf(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, bool tainted, char const *fmt,...)
Print a formatted string using our internal printf wrapper and assign it to a value box.
Definition value.c:4245
fr_sbuff_parse_rules_t const * value_parse_rules_quoted[T_TOKEN_LAST]
Parse rules for quoted strings.
Definition value.c:605
int fr_value_box_copy(TALLOC_CTX *ctx, fr_value_box_t *dst, const fr_value_box_t *src)
Copy value data verbatim duplicating any buffers.
Definition value.c:3962
int fr_value_box_cast_in_place(TALLOC_CTX *ctx, fr_value_box_t *vb, fr_type_t dst_type, fr_dict_attr_t const *dst_enumv)
Convert one type of fr_value_box_t to another in place.
Definition value.c:3790
void fr_value_box_strdup_shallow_replace(fr_value_box_t *vb, char const *src, ssize_t len)
Free the existing buffer (if talloced) associated with the valuebox, and replace it with a new one.
Definition value.c:4283
void fr_value_box_strdup_shallow(fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Assign a buffer containing a nul terminated string to a box, but don't copy it.
Definition value.c:4267
int fr_value_box_bstr_realloc(TALLOC_CTX *ctx, char **out, fr_value_box_t *dst, size_t len)
Change the length of a buffer already allocated to a value box.
Definition value.c:4335
int fr_value_box_bstrndup(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, size_t len, bool tainted)
Copy a string to to a fr_value_box_t.
Definition value.c:4379
int fr_value_box_bstrdup_buffer_shallow(TALLOC_CTX *ctx, fr_value_box_t *dst, fr_dict_attr_t const *enumv, char const *src, bool tainted)
Assign a talloced buffer containing a nul terminated string to a box, but don't copy it.
Definition value.c:4484
int fr_value_box_list_concat_in_place(TALLOC_CTX *ctx, fr_value_box_t *out, fr_value_box_list_t *list, fr_type_t type, fr_value_box_list_action_t proc_action, bool flatten, size_t max_size)
Concatenate a list of value boxes.
Definition value.c:5949
@ FR_VALUE_BOX_LIST_FREE
Definition value.h:237
#define fr_value_box_alloc(_ctx, _type, _enumv)
Allocate a value box of a specific type.
Definition value.h:640
#define fr_value_box_is_safe_for_only(_box, _safe_for)
Definition value.h:1079
#define fr_box_strvalue_len(_val, _len)
Definition value.h:305
uintptr_t fr_value_box_safe_for_t
Escaping that's been applied to a value box.
Definition value.h:160
int nonnull(2, 5))
#define fr_value_box_alloc_null(_ctx)
Allocate a value box for later use with a value assignment function.
Definition value.h:651
static size_t char ** out
Definition value.h:1020
static TALLOC_CTX * xlat_ctx
void * rctx
Resume context.
Definition xlat_ctx.h:54
void * env_data
Expanded call env data.
Definition xlat_ctx.h:53
module_ctx_t const * mctx
Synthesised module calling ctx.
Definition xlat_ctx.h:52
An xlat calling ctx.
Definition xlat_ctx.h:49
void xlat_func_flags_set(xlat_t *x, xlat_func_flags_t flags)
Specify flags that alter the xlat's behaviour.
Definition xlat_func.c:399
int xlat_func_args_set(xlat_t *x, xlat_arg_parser_t const args[])
Register the arguments of an xlat.
Definition xlat_func.c:363
void xlat_func_call_env_set(xlat_t *x, call_env_method_t const *env_method)
Register call environment of an xlat.
Definition xlat_func.c:389
xlat_t * xlat_func_register(TALLOC_CTX *ctx, char const *name, xlat_func_t func, fr_type_t return_type)
Register an xlat function.
Definition xlat_func.c:216
void xlat_func_unregister(char const *name)
Unregister an xlat function.
Definition xlat_func.c:516
#define xlat_func_safe_for_set(_xlat, _escaped)
Set the escaped values for output boxes.
Definition xlat_func.h:82
@ XLAT_FUNC_FLAG_PURE
Definition xlat_func.h:38