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: 2cb1110a0f57a52e22917c733da2d844cf89107a $
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: 2cb1110a0f57a52e22917c733da2d844cf89107a $")
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
49#include <ldap.h>
50#include "rlm_ldap.h"
51
56
65
66typedef struct {
67 char const *attr;
69 tmpl_t const *tmpl;
76
77/** Call environment used in the profile xlat
78 */
79typedef struct {
80 fr_value_box_t profile_filter; //!< Filter to use when searching for users.
81 map_list_t *profile_map; //!< List of maps to apply to the profile.
83
84static 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);
85static 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);
86
87static 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);
88
96
98 { FR_CONF_OFFSET("scope", rlm_ldap_t, profile.obj_scope), .dflt = "base",
100 { FR_CONF_OFFSET("attribute", rlm_ldap_t, profile.attr) },
101 { FR_CONF_OFFSET("attribute_suspend", rlm_ldap_t, profile.attr_suspend) },
102 { FR_CONF_OFFSET("check_attribute", rlm_ldap_t, profile.check_attr) },
103 { FR_CONF_OFFSET("sort_by", rlm_ldap_t, profile.obj_sort_by) },
104 { FR_CONF_OFFSET("fallthrough_attribute", rlm_ldap_t, profile.fallthrough_attr) },
105 { FR_CONF_OFFSET("fallthrough_default", rlm_ldap_t, profile.fallthrough_def), .dflt = "yes" },
107};
108
109/*
110 * User configuration
111 */
113 { FR_CONF_OFFSET("scope", rlm_ldap_t, user.obj_scope), .dflt = "sub",
114 .func = cf_table_parse_int, .uctx = &(cf_table_parse_ctx_t){ .table = fr_ldap_scope, .len = &fr_ldap_scope_len } },
115 { FR_CONF_OFFSET("sort_by", rlm_ldap_t, user.obj_sort_by) },
116
117 { FR_CONF_OFFSET("access_attribute", rlm_ldap_t, user.obj_access_attr) },
118 { FR_CONF_OFFSET("access_positive", rlm_ldap_t, user.access_positive), .dflt = "yes" },
119 { FR_CONF_OFFSET("access_value_negate", rlm_ldap_t, user.access_value_negate), .dflt = "false" },
120 { FR_CONF_OFFSET("access_value_suspend", rlm_ldap_t, user.access_value_suspend), .dflt = "suspended" },
121 { FR_CONF_OFFSET_IS_SET("expect_password", FR_TYPE_BOOL, 0, rlm_ldap_t, user.expect_password) },
123};
124
125/*
126 * Group configuration
127 */
129 { FR_CONF_OFFSET("filter", rlm_ldap_t, group.obj_filter) },
130 { FR_CONF_OFFSET("scope", rlm_ldap_t, group.obj_scope), .dflt = "sub",
131 .func = cf_table_parse_int, .uctx = &(cf_table_parse_ctx_t){ .table = fr_ldap_scope, .len = &fr_ldap_scope_len } },
132
133 { FR_CONF_OFFSET("name_attribute", rlm_ldap_t, group.obj_name_attr), .dflt = "cn" },
134 { FR_CONF_OFFSET("membership_attribute", rlm_ldap_t, group.userobj_membership_attr) },
135 { FR_CONF_OFFSET_FLAGS("membership_filter", CONF_FLAG_XLAT, rlm_ldap_t, group.obj_membership_filter) },
136 { FR_CONF_OFFSET("cacheable_name", rlm_ldap_t, group.cacheable_name), .dflt = "no" },
137 { FR_CONF_OFFSET("cacheable_dn", rlm_ldap_t, group.cacheable_dn), .dflt = "no" },
138 { FR_CONF_OFFSET("cache_attribute", rlm_ldap_t, group.cache_attribute) },
139 { FR_CONF_OFFSET("group_attribute", rlm_ldap_t, group.attribute) },
140 { FR_CONF_OFFSET("allow_dangling_group_ref", rlm_ldap_t, group.allow_dangling_refs), .dflt = "no" },
141 { FR_CONF_OFFSET("skip_on_suspend", rlm_ldap_t, group.skip_on_suspend), .dflt = "yes"},
143};
144
145static const conf_parser_t module_config[] = {
146 /*
147 * Pool config items
148 */
149 { FR_CONF_OFFSET_FLAGS("server", CONF_FLAG_MULTI, rlm_ldap_t, handle_config.server_str) }, /* Do not set to required */
150
151 /*
152 * Common LDAP conf parsers
153 */
155
156 { FR_CONF_OFFSET("valuepair_attribute", rlm_ldap_t, valuepair_attr) },
157
158#ifdef LDAP_CONTROL_X_SESSION_TRACKING
159 { FR_CONF_OFFSET("session_tracking", rlm_ldap_t, session_tracking), .dflt = "no" },
160#endif
161
162#ifdef WITH_EDIR
163 /* support for eDirectory Universal Password */
164 { FR_CONF_OFFSET("edir", rlm_ldap_t, edir) }, /* NULL defaults to "no" */
165
166 /*
167 * Attempt to bind with the cleartext password we got from eDirectory
168 * Universal password for additional authorization checks.
169 */
170 { FR_CONF_OFFSET("edir_autz", rlm_ldap_t, edir_autz) }, /* NULL defaults to "no" */
171#endif
172
173 { FR_CONF_POINTER("user", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) user_config },
174
175 { FR_CONF_POINTER("group", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) group_config },
176
177 { FR_CONF_POINTER("profile", 0, CONF_FLAG_SUBSECTION, NULL), .subcs = (void const *) profile_config },
178
179 { FR_CONF_OFFSET_SUBSECTION("pool", 0, rlm_ldap_t, trunk_conf, trunk_config ) },
180
181 { FR_CONF_OFFSET_SUBSECTION("bind_pool", 0, rlm_ldap_t, bind_trunk_conf, trunk_config ) },
182
184};
185
186#define USER_CALL_ENV_COMMON(_struct) \
187 { 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 }, \
188 { 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 }
189
205
206/** Parameters to allow ldap_update_section_parse to be reused
207 */
212
215 .env = (call_env_parser_t[]) {
218 .map_offset = offsetof(ldap_autz_call_env_t, user_map),
219 .expect_password_offset = offsetof(ldap_autz_call_env_t, expect_password)
220 } },
222 ((call_env_parser_t[]) {
225 })) },
227 ((call_env_parser_t[]) {
230 .pair.func = ldap_group_filter_parse,
231 .pair.escape = {
232 .box_escape = {
233 .func = fr_ldap_box_escape,
235 .always_escape = false,
236 },
238 },
239 .pair.literals_safe_for = (fr_value_box_safe_for_t)fr_ldap_box_escape,
240 },
242 })) },
244 ((call_env_parser_t[]) {
247 .pair.dflt = "(&)", .pair.dflt_quote = T_SINGLE_QUOTED_STRING }, //!< Correct filter for when the DN is known.
249 } )) },
251 }
252};
253
254#define USERMOD_ENV(_section) static const call_env_method_t _section ## _usermod_method_env = { \
255 FR_CALL_ENV_METHOD_OUT(ldap_usermod_call_env_t), \
256 .env = (call_env_parser_t[]) { \
257 { FR_CALL_ENV_SUBSECTION("user", NULL, CALL_ENV_FLAG_REQUIRED, \
258 ((call_env_parser_t[]) { \
259 USER_CALL_ENV_COMMON(ldap_usermod_call_env_t), CALL_ENV_TERMINATOR \
260 })) }, \
261 { FR_CALL_ENV_SUBSECTION_FUNC(STRINGIFY(_section), CF_IDENT_ANY, CALL_ENV_FLAG_SUBSECTION | CALL_ENV_FLAG_PARSE_MISSING, ldap_mod_section_parse) }, \
262 CALL_ENV_TERMINATOR \
263 } \
264}
265
266USERMOD_ENV(accounting);
268
271 .env = (call_env_parser_t[]) {
273 ((call_env_parser_t[]) {
276 })) },
278 ((call_env_parser_t[]) {
281 .pair.func = ldap_group_filter_parse,
282 .pair.escape = {
283 .box_escape = {
284 .func = fr_ldap_box_escape,
286 .always_escape = false,
287 },
289 },
290 .pair.literals_safe_for = (fr_value_box_safe_for_t)fr_ldap_box_escape,
291 },
293 })) },
295 }
296};
297
300 .env = (call_env_parser_t[]) {
303 .map_offset = offsetof(ldap_xlat_profile_call_env_t, profile_map),
304 .expect_password_offset = -1
305 } },
307 ((call_env_parser_t[]) {
309 .pair.dflt = "(&)", .pair.dflt_quote = T_SINGLE_QUOTED_STRING }, //!< Correct filter for when the DN is known.
311 })) },
313 }
314};
315
317
320 { .out = &dict_freeradius, .proto = "freeradius" },
321 { NULL }
322};
323
331
334 { .out = &attr_password, .name = "Password", .type = FR_TYPE_TLV, .dict = &dict_freeradius },
335 { .out = &attr_cleartext_password, .name = "Password.Cleartext", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
336 { .out = &attr_crypt_password, .name = "Password.Crypt", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
337 { .out = &attr_ldap_userdn, .name = "LDAP-UserDN", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
338 { .out = &attr_nt_password, .name = "Password.NT", .type = FR_TYPE_OCTETS, .dict = &dict_freeradius },
339 { .out = &attr_password_with_header, .name = "Password.With-Header", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
340 { .out = &attr_expr_bool_enum, .name = "Expr-Bool-Enum", .type = FR_TYPE_BOOL, .dict = &dict_freeradius },
341
342 { NULL }
343};
344
345extern global_lib_autoinst_t const *rlm_ldap_lib[];
350
351/** Holds state of in progress async authentication
352 *
353 */
361
362/** Holds state of in progress ldap user modifications
363 *
364 */
378
379/** Holds state of in progress LDAP map
380 *
381 */
382typedef struct {
383 map_list_t const *maps;
384 LDAPURLDesc *ldap_url;
387 LDAPControl *serverctrls[LDAP_MAX_CONTROLS];
389
395
397 { L("ldap://"), LDAP_SCHEME_UNIX },
398 { L("ldapi://"), LDAP_SCHEME_TCP },
399 { L("ldaps://"), LDAP_SCHEME_TCP_SSL },
400};
402
403/** This is the common function that actually ends up doing all the URI escaping
404 */
405#define LDAP_URI_SAFE_FOR (fr_value_box_safe_for_t)fr_ldap_uri_escape_func
406
408 { .required = true, .concat = true, .type = FR_TYPE_STRING },
410};
411
413 { .required = true, .concat = true, .type = FR_TYPE_STRING },
415};
416
417/** Escape LDAP string
418 *
419 * @ingroup xlat_functions
420 */
422 UNUSED xlat_ctx_t const *xctx,
423 request_t *request, fr_value_box_list_t *in)
424{
425 fr_value_box_t *vb, *in_vb = fr_value_box_list_head(in);
426 fr_sbuff_t sbuff;
427 fr_sbuff_uctx_talloc_t sbuff_ctx;
428 size_t len;
429
430 MEM(vb = fr_value_box_alloc_null(ctx));
431
432 /*
433 * If it's already safe, just copy it over.
434 */
436 fr_value_box_copy(vb, vb, in_vb);
437
439 return XLAT_ACTION_DONE;
440 }
441
442 /*
443 * Maximum space needed for output would be 3 times the input if every
444 * char needed escaping
445 */
446 if (!fr_sbuff_init_talloc(vb, &sbuff, &sbuff_ctx, in_vb->vb_length * 3, in_vb->vb_length * 3)) {
447 REDEBUG("Failed to allocate buffer for escaped string");
448 talloc_free(vb);
449 return XLAT_ACTION_FAIL;
450 }
451
452 /*
453 * Call the escape function, including the space for the trailing NULL
454 */
455 len = fr_ldap_uri_escape_func(request, fr_sbuff_buff(&sbuff), in_vb->vb_length * 3 + 1, in_vb->vb_strvalue, NULL);
456
457 /*
458 * Trim buffer to fit used space and assign to box
459 */
460 fr_sbuff_trim_talloc(&sbuff, len);
461 fr_value_box_strdup_shallow(vb, NULL, fr_sbuff_buff(&sbuff), in_vb->tainted);
462
464 return XLAT_ACTION_DONE;
465}
466
468 { .required = true, .concat = true, .type = FR_TYPE_STRING },
470};
471
472/** Unescape LDAP string
473 *
474 * @ingroup xlat_functions
475 */
477 UNUSED xlat_ctx_t const *xctx,
478 request_t *request, fr_value_box_list_t *in)
479{
480 fr_value_box_t *vb, *in_vb = fr_value_box_list_head(in);
481 fr_sbuff_t sbuff;
482 fr_sbuff_uctx_talloc_t sbuff_ctx;
483 size_t len;
484
485 MEM(vb = fr_value_box_alloc_null(ctx));
486 /*
487 * Maximum space needed for output will be the same as the input
488 */
489 if (!fr_sbuff_init_talloc(vb, &sbuff, &sbuff_ctx, in_vb->vb_length, in_vb->vb_length)) {
490 REDEBUG("Failed to allocate buffer for unescaped string");
491 talloc_free(vb);
492 return XLAT_ACTION_FAIL;
493 }
494
495 /*
496 * Call the unescape function, including the space for the trailing NULL
497 */
498 len = fr_ldap_uri_unescape_func(request, fr_sbuff_buff(&sbuff), in_vb->vb_length + 1, in_vb->vb_strvalue, NULL);
499
500 /*
501 * Trim buffer to fit used space and assign to box
502 */
503 fr_sbuff_trim_talloc(&sbuff, len);
504 fr_value_box_strdup_shallow(vb, NULL, fr_sbuff_buff(&sbuff), in_vb->tainted);
506
507 return XLAT_ACTION_DONE;
508}
509
510/** Escape function for a part of an LDAP URI
511 *
512 */
513static int ldap_uri_part_escape(fr_value_box_t *vb, UNUSED void *uctx)
514{
515 fr_sbuff_t sbuff;
516 fr_sbuff_uctx_talloc_t sbuff_ctx;
517 size_t len;
518
519 /*
520 * Maximum space needed for output would be 3 times the input if every
521 * char needed escaping
522 */
523 if (!fr_sbuff_init_talloc(vb, &sbuff, &sbuff_ctx, vb->vb_length * 3, vb->vb_length * 3)) {
524 fr_strerror_printf_push("Failed to allocate buffer for escaped argument");
525 return -1;
526 }
527
528 /*
529 * Call the escape function, including the space for the trailing NULL
530 */
531 len = fr_ldap_uri_escape_func(NULL, fr_sbuff_buff(&sbuff), vb->vb_length * 3 + 1, vb->vb_strvalue, NULL);
532
533 fr_sbuff_trim_talloc(&sbuff, len);
535
536 return 0;
537}
538
539/** Callback when LDAP query times out
540 *
541 */
543{
544 fr_ldap_query_t *query = talloc_get_type_abort(uctx, fr_ldap_query_t);
545 trunk_request_t *treq;
546 request_t *request;
547
548 /*
549 * If the trunk request has completed but the query
550 * has not yet resumed, query->treq will be NULL
551 */
552 if (!query->treq) return;
553
554 treq = talloc_get_type_abort(query->treq, trunk_request_t);
555 request = treq->request;
556
557 ROPTIONAL(RERROR, ERROR, "Timeout waiting for LDAP query");
558
560
561 query->ret = LDAP_RESULT_TIMEOUT;
563}
564
566 { .required = true, .concat = true, .type = FR_TYPE_STRING },
567 { .required = true, .concat = true, .type = FR_TYPE_STRING },
569};
570
571/** Modify an LDAP URI to append an option to all attributes
572 *
573 * This is for the corner case where a URI is provided by a third party system
574 * and needs amending before being used. e.g. a CRL distribution point extracted
575 * from a certificate may need the "binary" option appending to the attribute
576 * being requested.
577 *
578 * @ingroup xlat_functions
579 */
581 request_t *request, fr_value_box_list_t *in)
582{
583 fr_value_box_t *uri, *option_vb;
584 char *attrs_fixed, **attr, port[6];
585 char const *option;
586 LDAPURLDesc *ldap_url;
587 fr_value_box_t *vb;
588 int ret;
589
590 XLAT_ARGS(in, &uri, &option_vb);
591
592 if (option_vb->vb_length < 1) {
593 RERROR("LDAP attriubte option must not be blank");
594 return XLAT_ACTION_FAIL;
595 }
596
597 if (!ldap_is_ldap_url(uri->vb_strvalue)) {
598 REDEBUG("String passed does not look like an LDAP URL");
599 return XLAT_ACTION_FAIL;
600 }
601
602 ret = ldap_url_parse(uri->vb_strvalue, &ldap_url);
603 if (ret != LDAP_URL_SUCCESS){
604 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ret));
605 return XLAT_ACTION_FAIL;
606 }
607
608 /*
609 * No attributes, just return what was presented.
610 */
611 if (!ldap_url->lud_attrs || !ldap_url->lud_attrs[0] || !*ldap_url->lud_attrs[0]) {
612 fr_value_box_list_remove(in, uri);
613 talloc_steal(ctx, uri);
615 goto done;
616 }
617
618 if (option_vb->vb_strvalue[0] != ';') {
619 option = talloc_asprintf(option_vb, ";%s", option_vb->vb_strvalue);
620 } else {
621 option = option_vb->vb_strvalue;
622 }
623
624 vb = fr_value_box_alloc(ctx, FR_TYPE_STRING, NULL);
625 attrs_fixed = talloc_strdup(vb, "");
626
627 attr = ldap_url->lud_attrs;
628 while (*attr) {
629 attrs_fixed = talloc_strdup_append(attrs_fixed, *attr);
630 if (!strstr(*attr, option)) attrs_fixed = talloc_strdup_append(attrs_fixed, option);
631 attr++;
632 if (*attr) attrs_fixed = talloc_strdup_append(attrs_fixed, ",");
633 }
634
635 snprintf(port, sizeof(port), "%d", ldap_url->lud_port);
636 fr_value_box_asprintf(vb, vb, NULL, uri->tainted, "%s://%s%s%s/%s?%s?%s?%s",
637 ldap_url->lud_scheme,
638 ldap_url->lud_host ? ldap_url->lud_host : "",
639 ldap_url->lud_host ? ":" : "",
640 ldap_url->lud_host ? port : "",
641 ldap_url->lud_dn, attrs_fixed,
642 fr_table_str_by_value(fr_ldap_scope, ldap_url->lud_scope, ""),
643 ldap_url->lud_filter ? ldap_url->lud_filter : "");
644
646done:
647 ldap_free_urldesc(ldap_url);
648 return XLAT_ACTION_DONE;
649}
650
651/** Callback when resuming after async ldap query is completed
652 *
653 */
655 xlat_ctx_t const *xctx,
656 request_t *request, UNUSED fr_value_box_list_t *in)
657{
658 fr_ldap_query_t *query = talloc_get_type_abort(xctx->rctx, fr_ldap_query_t);
659 fr_ldap_connection_t *ldap_conn = query->ldap_conn;
660 fr_value_box_t *vb = NULL;
661 LDAPMessage *msg;
662 struct berval **values;
663 char const **attr;
664 int count, i;
665
666 if (query->ret != LDAP_RESULT_SUCCESS) return XLAT_ACTION_FAIL;
667
668 /*
669 * We only parse "entries"
670 */
671 for (msg = ldap_first_entry(ldap_conn->handle, query->result); msg; msg = ldap_next_entry(ldap_conn->handle, msg)) {
672 for (attr = query->search.attrs; *attr; attr++) {
673 values = ldap_get_values_len(ldap_conn->handle, msg, *attr);
674 if (!values) {
675 RDEBUG2("No \"%s\" attributes found in specified object", *attr);
676 continue;
677 }
678
679 count = ldap_count_values_len(values);
680 for (i = 0; i < count; i++) {
681 MEM(vb = fr_value_box_alloc_null(ctx));
682 if (fr_value_box_bstrndup(vb, vb, NULL, values[i]->bv_val, values[i]->bv_len, true) < 0) {
683 talloc_free(vb);
684 RPERROR("Failed creating value from LDAP response");
685 break;
686 }
688 }
689 ldap_value_free_len(values);
690 }
691 }
692
693 talloc_free(query);
694
695 return XLAT_ACTION_DONE;
696}
697
698/** Callback for signalling async ldap query
699 *
700 */
701static void ldap_xlat_signal(xlat_ctx_t const *xctx, request_t *request, UNUSED fr_signal_t action)
702{
703 fr_ldap_query_t *query = talloc_get_type_abort(xctx->rctx, fr_ldap_query_t);
704
705 if (!query->treq) return;
706
707 RDEBUG2("Forcefully cancelling pending LDAP query");
708
710}
711
712/*
713 * If a part doesn't have an escaping function, parsing will fail unless the input
714 * was marked up with a safe_for value by the ldap arg parsing, i.e. was a literal
715 * input argument to the xlat.
716 *
717 * This is equivalent to the old "tainted_allowed" flag.
718 */
720 { .name = "scheme", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L(":")), .part_adv = { [':'] = 1 }, .extra_skip = 2 },
721 { .name = "host", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L(":"), L("/")), .part_adv = { [':'] = 1, ['/'] = 2 } },
722 { .name = "port", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("/")), .part_adv = { ['/'] = 1 } },
723 { .name = "dn", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1 }, .func = ldap_uri_part_escape },
724 { .name = "attrs", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1 }},
725 { .name = "scope", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1 }, .func = ldap_uri_part_escape },
726 { .name = "filter", .safe_for = LDAP_URI_SAFE_FOR, .terminals = &FR_SBUFF_TERMS(L("?")), .part_adv = { ['?'] = 1}, .func = ldap_uri_part_escape },
727 { .name = "exts", .safe_for = LDAP_URI_SAFE_FOR, .func = ldap_uri_part_escape },
729};
730
731static fr_uri_part_t const ldap_dn_parts[] = {
732 { .name = "dn", .safe_for = LDAP_URI_SAFE_FOR , .func = ldap_uri_part_escape },
734};
735
737 { .required = true, .type = FR_TYPE_STRING, .safe_for = LDAP_URI_SAFE_FOR, .will_escape = true, },
739};
740
741/** Produce canonical LDAP host URI for finding trunks
742 *
743 */
744static inline CC_HINT(always_inline)
745char *host_uri_canonify(request_t *request, LDAPURLDesc *url_parsed, fr_value_box_t *url_in)
746{
747 char *host;
748
749 LDAPURLDesc tmp_desc = {
750 .lud_scheme = url_parsed->lud_scheme,
751 .lud_host = url_parsed->lud_host,
752 .lud_port = url_parsed->lud_port,
753 .lud_scope = -1
754 };
755 host = ldap_url_desc2str(&tmp_desc);
756 if (unlikely(host == NULL)) REDEBUG("Invalid LDAP URL - %pV", url_in); \
757
758 return host;
759}
760
761/** Utility function for parsing LDAP URLs
762 *
763 * All LDAP xlat functions that work with LDAP URLs should call this function to parse the URL.
764 *
765 * @param[out] uri_parsed LDAP URL parsed. Must be freed with ldap_url_desc_free.
766 * @param[out] host_out host name to use for the query. Must be freed with ldap_mem_free
767 * if free_host_out is true.
768 * @param[out] free_host_out True if host_out should be freed.
769 * @param[in] request Request being processed.
770 * @param[in] host_default Default host to use if the URL does not specify a host.
771 * @param[in] uri_in URI to parse.
772 * @return
773 * - 0 on success.
774 * - -1 on failure.
775 */
776static int ldap_xlat_uri_parse(LDAPURLDesc **uri_parsed, char **host_out, bool *free_host_out,
777 request_t *request, char *host_default, fr_value_box_t *uri_in)
778{
779 fr_value_box_t *uri;
780 int ldap_url_ret;
781
782 *free_host_out = false;
783
784 if (fr_uri_escape_list(&uri_in->vb_group, ldap_uri_parts, NULL) < 0){
785 RPERROR("Failed to escape LDAP URI");
786 error:
787 *uri_parsed = NULL;
788 return -1;
789 }
790
791 /*
792 * Smush everything into the first URI box
793 */
794 uri = fr_value_box_list_head(&uri_in->vb_group);
795
796 if (fr_value_box_list_concat_in_place(uri, uri, &uri_in->vb_group,
797 FR_TYPE_STRING, FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
798 RPEDEBUG("Failed concatenating input");
799 goto error;
800 }
801
802 if (!ldap_is_ldap_url(uri->vb_strvalue)) {
803 REDEBUG("String passed does not look like an LDAP URL");
804 goto error;
805 }
806
807 ldap_url_ret = ldap_url_parse(uri->vb_strvalue, uri_parsed);
808 if (ldap_url_ret != LDAP_URL_SUCCESS){
809 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ldap_url_ret));
810 goto error;
811 }
812
813 /*
814 * If the URL is <scheme>:/// the parsed host will be NULL - use config default
815 */
816 if (!(*uri_parsed)->lud_host) {
817 *host_out = host_default;
818 } else {
819 *host_out = host_uri_canonify(request, *uri_parsed, uri);
820 if (unlikely(*host_out == NULL)) {
821 ldap_free_urldesc(*uri_parsed);
822 *uri_parsed = NULL;
823 return -1;
824 }
825 *free_host_out = true;
826 }
827
828 return 0;
829}
830
831/** Expand an LDAP URL into a query, and return a string result from that query.
832 *
833 * @ingroup xlat_functions
834 */
836 xlat_ctx_t const *xctx,
837 request_t *request, fr_value_box_list_t *in)
838{
839 fr_ldap_thread_t *t = talloc_get_type_abort(xctx->mctx->thread, fr_ldap_thread_t);
840 fr_value_box_t *uri;
841 char *host;
842 bool free_host = false;
843 fr_ldap_config_t const *handle_config = t->config;
845 fr_ldap_query_t *query = NULL;
846
847 LDAPURLDesc *ldap_url;
848
849 XLAT_ARGS(in, &uri);
850
851 if (ldap_xlat_uri_parse(&ldap_url, &host, &free_host, request, handle_config->server, uri) < 0) return XLAT_ACTION_FAIL;
852
853 /*
854 * Nothing, empty string, "*" string, or got 2 things, die.
855 */
856 if (!ldap_url->lud_attrs || !ldap_url->lud_attrs[0] || !*ldap_url->lud_attrs[0] ||
857 (strcmp(ldap_url->lud_attrs[0], "*") == 0) || ldap_url->lud_attrs[1]) {
858 REDEBUG("Bad attributes list in LDAP URL. URL must specify exactly one attribute to retrieve");
859 ldap_free_urldesc(ldap_url);
860 return XLAT_ACTION_FAIL;
861 }
862
864 ldap_url->lud_dn, ldap_url->lud_scope, ldap_url->lud_filter,
865 (char const * const*)ldap_url->lud_attrs, NULL, NULL);
866 query->ldap_url = ldap_url; /* query destructor will free URL */
867
868 if (ldap_url->lud_exts) {
869 LDAPControl *serverctrls[LDAP_MAX_CONTROLS];
870 int i;
871
872 serverctrls[0] = NULL;
873
874 if (fr_ldap_parse_url_extensions(serverctrls, NUM_ELEMENTS(serverctrls),
875 query->ldap_url->lud_exts) < 0) {
876 RPERROR("Parsing URL extensions failed");
877 if (free_host) ldap_memfree(host);
878
879 query_error:
880 talloc_free(query);
881 return XLAT_ACTION_FAIL;
882 }
883
884 for (i = 0; i < LDAP_MAX_CONTROLS; i++) {
885 if (!serverctrls[i]) break;
886 query->serverctrls[i].control = serverctrls[i];
887 query->serverctrls[i].freeit = true;
888 }
889 }
890
891 /*
892 * Figure out what trunked connection we can use
893 * to communicate with the host.
894 *
895 * If free_host is true, we must free the host
896 * after deciding on a trunk connection as it
897 * was allocated by host_uri_canonify.
898 */
899 ttrunk = fr_thread_ldap_trunk_get(t, host, handle_config->admin_identity,
900 handle_config->admin_password, request, handle_config);
901 if (free_host) ldap_memfree(host);
902 if (!ttrunk) {
903 REDEBUG("Unable to get LDAP query for xlat");
904 goto query_error;
905 }
906
907 switch (trunk_request_enqueue(&query->treq, ttrunk->trunk, request, query, NULL)) {
908 case TRUNK_ENQUEUE_OK:
910 break;
911
912 default:
913 REDEBUG("Unable to enqueue LDAP query for xlat");
914 goto query_error;
915 }
916
917 if (fr_timer_in(query, unlang_interpret_event_list(request)->tl, &query->ev, handle_config->res_timeout,
918 false, ldap_query_timeout, query) < 0) {
919 REDEBUG("Unable to set timeout for LDAP query");
921 goto query_error;
922 }
923
925}
926
927/** User object lookup as part of group membership xlat
928 *
929 * Called if the ldap membership xlat is used and the user DN is not already known
930 */
932 request_t *request, void *uctx)
933{
934 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(uctx, ldap_group_xlat_ctx_t);
935
936 if (xlat_ctx->env_data->user_filter.type == FR_TYPE_STRING) xlat_ctx->filter = &xlat_ctx->env_data->user_filter;
937
938 xlat_ctx->basedn = &xlat_ctx->env_data->user_base;
939
940 return rlm_ldap_find_user_async(xlat_ctx, xlat_ctx->inst, request, xlat_ctx->basedn, xlat_ctx->filter,
941 xlat_ctx->ttrunk, xlat_ctx->attrs, &xlat_ctx->query);
942}
943
944/** Cancel an in-progress query for the LDAP group membership xlat
945 *
946 */
947static void ldap_group_xlat_cancel(UNUSED request_t *request, UNUSED fr_signal_t action, void *uctx)
948{
949 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(uctx, ldap_group_xlat_ctx_t);
950
951 if (!xlat_ctx->query || !xlat_ctx->query->treq) return;
952
954}
955
956#define REPEAT_LDAP_MEMBEROF_XLAT_RESULTS \
957 if (unlang_function_repeat_set(request, ldap_group_xlat_results) < 0) do { \
958 rcode = RLM_MODULE_FAIL; \
959 goto finish; \
960 } while (0)
961
962/** Run the state machine for the LDAP membership xlat
963 *
964 * This is called after each async lookup is completed
965 */
967 request_t *request, void *uctx)
968{
969 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(uctx, ldap_group_xlat_ctx_t);
970 rlm_ldap_t const *inst = xlat_ctx->inst;
972
973 switch (xlat_ctx->status) {
975 if (!xlat_ctx->dn) xlat_ctx->dn = rlm_find_user_dn_cached(request);
977
978 if (inst->group.obj_membership_filter) {
983 }
984 }
986
988 if (xlat_ctx->found) {
989 rcode = RLM_MODULE_OK;
990 goto finish;
991 }
992
993 if (inst->group.userobj_membership_attr) {
998 }
999 }
1001
1003 if (xlat_ctx->found) rcode = RLM_MODULE_OK;
1004 break;
1005 }
1006
1007finish:
1008 RETURN_MODULE_RCODE(rcode);
1009}
1010
1011/** Process the results of evaluating LDAP group membership
1012 *
1013 */
1015 UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
1016{
1017 ldap_group_xlat_ctx_t *xlat_ctx = talloc_get_type_abort(xctx->rctx, ldap_group_xlat_ctx_t);
1018 fr_value_box_t *vb;
1019
1021 vb->vb_bool = xlat_ctx->found;
1023
1024 return XLAT_ACTION_DONE;
1025}
1026
1028 { .required = true, .concat = true, .type = FR_TYPE_STRING, .safe_for = LDAP_URI_SAFE_FOR },
1030};
1031
1032/** Check for a user being in a LDAP group
1033 *
1034 * @ingroup xlat_functions
1035 */
1036static xlat_action_t ldap_group_xlat(TALLOC_CTX *ctx, fr_dcursor_t *out, xlat_ctx_t const *xctx,
1037 request_t *request, fr_value_box_list_t *in)
1038{
1039 fr_value_box_t *vb = NULL, *group_vb = fr_value_box_list_pop_head(in);
1041 fr_ldap_thread_t *t = talloc_get_type_abort(xctx->mctx->thread, fr_ldap_thread_t);
1042 ldap_xlat_memberof_call_env_t *env_data = talloc_get_type_abort(xctx->env_data, ldap_xlat_memberof_call_env_t);
1043 bool group_is_dn;
1045
1046 RDEBUG2("Searching for user in group \"%pV\"", group_vb);
1047
1048 if (group_vb->vb_length == 0) {
1049 REDEBUG("Cannot do comparison (group name is empty)");
1050 return XLAT_ACTION_FAIL;
1051 }
1052
1053 group_is_dn = fr_ldap_util_is_dn(group_vb->vb_strvalue, group_vb->vb_length);
1054 if (group_is_dn) {
1055 char *norm;
1056 size_t len;
1057
1058 MEM(norm = talloc_array(group_vb, char, talloc_array_length(group_vb->vb_strvalue)));
1059 len = fr_ldap_util_normalise_dn(norm, group_vb->vb_strvalue);
1060
1061 /*
1062 * Will clear existing buffer (i.e. group_vb->vb_strvalue)
1063 */
1064 fr_value_box_bstrdup_buffer_shallow(group_vb, group_vb, NULL, norm, group_vb->tainted);
1065
1066 /*
1067 * Trim buffer to match normalised DN
1068 */
1069 fr_value_box_bstr_realloc(group_vb, NULL, group_vb, len);
1070 }
1071
1072 if ((group_is_dn && inst->group.cacheable_dn) || (!group_is_dn && inst->group.cacheable_name)) {
1073 rlm_rcode_t our_rcode;
1074
1075 rlm_ldap_check_cached(&our_rcode, inst, request, group_vb);
1076 switch (our_rcode) {
1078 RDEBUG2("User is not a member of \"%pV\"", group_vb);
1079 return XLAT_ACTION_DONE;
1080
1081 case RLM_MODULE_OK:
1082 MEM(vb = fr_value_box_alloc(ctx, FR_TYPE_BOOL, NULL));
1083 vb->vb_bool = true;
1085 return XLAT_ACTION_DONE;
1086
1087 /*
1088 * Fallback to dynamic search
1089 */
1090 default:
1091 break;
1092 }
1093 }
1094
1096
1098 .inst = inst,
1099 .group = group_vb,
1100 .dn = rlm_find_user_dn_cached(request),
1101 .attrs = { inst->group.userobj_membership_attr, NULL },
1102 .group_is_dn = group_is_dn,
1103 .env_data = env_data
1104 };
1105
1106 xlat_ctx->ttrunk = fr_thread_ldap_trunk_get(t, inst->handle_config.server, inst->handle_config.admin_identity,
1107 inst->handle_config.admin_password, request, &inst->handle_config);
1108
1109 if (!xlat_ctx->ttrunk) {
1110 REDEBUG("Unable to get LDAP trunk for group membership check");
1111 error:
1113 return XLAT_ACTION_FAIL;
1114 }
1115
1116 if (unlang_xlat_yield(request, ldap_group_xlat_resume, NULL, 0, xlat_ctx) != XLAT_ACTION_YIELD) goto error;
1117
1120 UNLANG_SUB_FRAME, xlat_ctx) < 0) goto error;
1121
1123}
1124
1131
1132/** Return whether evaluating the profile was successful
1133 *
1134 */
1136 UNUSED request_t *request, UNUSED fr_value_box_list_t *in)
1137{
1138 ldap_xlat_profile_ctx_t *xlat_ctx = talloc_get_type_abort(xctx->rctx, ldap_xlat_profile_ctx_t);
1139 fr_value_box_t *vb;
1140
1142 vb->vb_bool = (xlat_ctx->ret == LDAP_RESULT_SUCCESS) && (xlat_ctx->applied > 0);
1144
1145 return XLAT_ACTION_DONE;
1146}
1147
1149{
1150 if (to_free->url) {
1151 ldap_free_urldesc(to_free->url);
1152 to_free->url = NULL;
1153 }
1154 return 0;
1155}
1156
1157/** Expand an LDAP URL into a query, applying the results using the user update map.
1158 *
1159 * For fetching profiles by DN.
1160 *
1161 * @ingroup xlat_functions
1162 */
1164 xlat_ctx_t const *xctx,
1165 request_t *request, fr_value_box_list_t *in)
1166{
1168 fr_ldap_thread_t *t = talloc_get_type_abort(xctx->mctx->thread, fr_ldap_thread_t);
1169 ldap_xlat_profile_call_env_t *env_data = talloc_get_type_abort(xctx->env_data, ldap_xlat_profile_call_env_t);
1170 fr_value_box_t *uri_components, *uri;
1171 char *host_url, *host = NULL;
1172 fr_ldap_config_t const *handle_config = t->config;
1173 fr_ldap_thread_trunk_t *ttrunk;
1175
1176 int ldap_url_ret;
1177
1178 char const *dn;
1179 char const *filter;
1180 int scope;
1181
1182 bool is_dn;
1183
1184 XLAT_ARGS(in, &uri_components);
1185
1186 is_dn = (fr_uri_has_scheme(&uri_components->vb_group, ldap_uri_scheme_table, ldap_uri_scheme_table_len, -1) < 0);
1187
1188 /*
1189 * Apply different escaping rules based on whether the first
1190 * arg lookgs like a URI or a DN.
1191 */
1192 if (is_dn) {
1193 if (fr_uri_escape_list(&uri_components->vb_group, ldap_dn_parts, NULL) < 0) {
1194 RPERROR("Failed to escape LDAP profile DN");
1195 return XLAT_ACTION_FAIL;
1196 }
1197 } else {
1198 if (fr_uri_escape_list(&uri_components->vb_group, ldap_uri_parts, NULL) < 0) {
1199 RPERROR("Failed to escape LDAP profile URI");
1200 return XLAT_ACTION_FAIL;
1201 }
1202 }
1203
1204 /*
1205 * Smush everything into the first URI box
1206 */
1207 uri = fr_value_box_list_head(&uri_components->vb_group);
1208 if (fr_value_box_list_concat_in_place(uri, uri, &uri_components->vb_group,
1209 FR_TYPE_STRING, FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
1210 RPEDEBUG("Failed concatenating input");
1211 return XLAT_ACTION_FAIL;
1212 }
1213
1214 /*
1215 * Allocate a resumption context to store temporary resource and results
1216 */
1218 talloc_set_destructor(xlat_ctx, ldap_xlat_profile_ctx_free);
1219
1220 if (is_dn) {
1221 host_url = handle_config->server;
1222 dn = talloc_typed_strdup_buffer(xlat_ctx, uri->vb_strvalue);
1223 filter = env_data->profile_filter.vb_strvalue;
1224 scope = inst->profile.obj_scope;
1225 } else {
1226 ldap_url_ret = ldap_url_parse(uri->vb_strvalue, &xlat_ctx->url);
1227 if (ldap_url_ret != LDAP_URL_SUCCESS){
1228 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ldap_url_ret));
1229 error:
1231 return XLAT_ACTION_FAIL;
1232 }
1233
1234 /*
1235 * The URL must specify a DN
1236 */
1237 if (!xlat_ctx->url->lud_dn) {
1238 REDEBUG("LDAP URI must specify a profile DN");
1239 goto error;
1240 }
1241
1242 dn = xlat_ctx->url->lud_dn;
1243 /*
1244 * Either we use the filter from the URL or we use the default filter
1245 * configured for profiles.
1246 */
1247 filter = xlat_ctx->url->lud_filter ? xlat_ctx->url->lud_filter : env_data->profile_filter.vb_strvalue;
1248
1249 /*
1250 * Determine if the URL includes a scope.
1251 */
1252 scope = xlat_ctx->url->lud_scope == LDAP_SCOPE_DEFAULT ? inst->profile.obj_scope : xlat_ctx->url->lud_scope;
1253
1254 /*
1255 * If the URL is <scheme>:/// the parsed host will be NULL - use config default
1256 */
1257 if (!xlat_ctx->url->lud_host) {
1258 host_url = handle_config->server;
1259 } else {
1260 host_url = host = host_uri_canonify(request, xlat_ctx->url, uri);
1261 if (unlikely(host_url == NULL)) goto error;
1262 }
1263 }
1264
1265 /*
1266 * Synchronous expansion of maps (fixme!)
1267 */
1268 if (fr_ldap_map_expand(xlat_ctx, &xlat_ctx->expanded, request, env_data->profile_map,
1269 inst->valuepair_attr, inst->profile.check_attr, inst->profile.fallthrough_attr) < 0) goto error;
1270 ttrunk = fr_thread_ldap_trunk_get(t, host_url, handle_config->admin_identity,
1271 handle_config->admin_password, request, handle_config);
1272 if (host) ldap_memfree(host);
1273 if (!ttrunk) {
1274 REDEBUG("Unable to get LDAP query for xlat");
1275 goto error;
1276 }
1277
1278 if (unlang_xlat_yield(request, ldap_profile_xlat_resume, NULL, 0, xlat_ctx) != XLAT_ACTION_YIELD) goto error;
1279
1280 /*
1281 * Pushes a frame onto the stack to retrieve and evaluate a profile
1282 */
1283 if (rlm_ldap_map_profile(&xlat_ctx->ret, &xlat_ctx->applied, inst, request, ttrunk, dn,
1284 scope, filter, &xlat_ctx->expanded) < 0) goto error;
1285
1287}
1288
1289/*
1290 * Verify the result of the map.
1291 */
1292static int ldap_map_verify(CONF_SECTION *cs, UNUSED void const *mod_inst, UNUSED void *proc_inst,
1293 tmpl_t const *src, UNUSED map_list_t const *maps)
1294{
1295 if (!src) {
1296 cf_log_err(cs, "Missing LDAP URI");
1297
1298 return -1;
1299 }
1300
1301 return 0;
1302}
1303
1304/** Process the results of an LDAP map query
1305 *
1306 * @param[out] p_result Result of applying the map.
1307 * @param[in] priority Unused.
1308 * @param[in] request Current request.
1309 * @param[in] uctx Map context.
1310 * @return One of UNLANG_ACTION_*
1311 */
1312static unlang_action_t mod_map_resume(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
1313{
1314 ldap_map_ctx_t *map_ctx = talloc_get_type_abort(uctx, ldap_map_ctx_t);
1315 fr_ldap_query_t *query = map_ctx->query;
1316 fr_ldap_map_exp_t *expanded = &map_ctx->expanded;
1318 LDAPMessage *entry;
1319 map_t const *map;
1320
1321 switch (query->ret) {
1323 rcode = RLM_MODULE_UPDATED;
1324 break;
1325
1327 case LDAP_RESULT_BAD_DN:
1328 goto finish;
1329
1331 goto finish;
1332
1333 default:
1334 rcode = RLM_MODULE_FAIL;
1335 goto finish;
1336 }
1337
1338 for (entry = ldap_first_entry(query->ldap_conn->handle, query->result);
1339 entry;
1340 entry = ldap_next_entry(query->ldap_conn->handle, entry)) {
1341 char *dn = NULL;
1342 int i;
1343
1344 if (RDEBUG_ENABLED2) {
1345 dn = ldap_get_dn(query->ldap_conn->handle, entry);
1346 RDEBUG2("Processing \"%s\"", dn);
1347 }
1348
1349 RINDENT();
1350 for (map = map_list_head(map_ctx->maps), i = 0;
1351 map != NULL;
1352 map = map_list_next(map_ctx->maps, map), i++) {
1353 int ret;
1354 fr_ldap_result_t attr;
1355
1356 attr.values = ldap_get_values_len(query->ldap_conn->handle, entry, expanded->attrs[i]);
1357 if (!attr.values) {
1358 /*
1359 * Many LDAP directories don't expose the DN of
1360 * the object as an attribute, so we need this
1361 * hack, to allow the user to retrieve it.
1362 */
1363 if (strcmp(LDAP_VIRTUAL_DN_ATTR, expanded->attrs[i]) == 0) {
1364 struct berval value;
1365 struct berval *values[2] = { &value, NULL };
1366
1367 if (!dn) dn = ldap_get_dn(query->ldap_conn->handle, entry);
1368 value.bv_val = dn;
1369 value.bv_len = strlen(dn);
1370
1371 attr.values = values;
1372 attr.count = 1;
1373
1374 ret = map_to_request(request, map, fr_ldap_map_getvalue, &attr);
1375 if (ret == -1) {
1376 rcode = RLM_MODULE_FAIL;
1377 ldap_memfree(dn);
1378 goto finish;
1379 }
1380 continue;
1381 }
1382
1383 RDEBUG3("Attribute \"%s\" not found in LDAP object", expanded->attrs[i]);
1384
1385 continue;
1386 }
1387 attr.count = ldap_count_values_len(attr.values);
1388
1389 ret = map_to_request(request, map, fr_ldap_map_getvalue, &attr);
1390 ldap_value_free_len(attr.values);
1391 if (ret == -1) {
1392 rcode = RLM_MODULE_FAIL;
1393 ldap_memfree(dn);
1394 goto finish;
1395 }
1396 }
1397 ldap_memfree(dn);
1398 REXDENT();
1399 }
1400
1401finish:
1402 RETURN_MODULE_RCODE(rcode);
1403}
1404
1405/** Ensure map context is properly cleared up
1406 *
1407 */
1408static int map_ctx_free(ldap_map_ctx_t *map_ctx)
1409{
1410 int i = 0;
1411 talloc_free(map_ctx->expanded.ctx);
1412 ldap_free_urldesc(map_ctx->ldap_url);
1413 while ((i < LDAP_MAX_CONTROLS) && map_ctx->serverctrls[i]) {
1414 ldap_control_free(map_ctx->serverctrls[i]);
1415 i++;
1416 }
1417 return (0);
1418}
1419
1420/** Perform a search and map the result of the search to server attributes
1421 *
1422 * Unlike LDAP xlat, this can be used to process attributes from multiple entries.
1423 *
1424 * @todo For xlat expansions we need to parse the raw URL first, and then apply
1425 * different escape functions to the different parts.
1426 *
1427 * @param[out] p_result Result of map expansion:
1428 * - #RLM_MODULE_NOOP no rows were returned.
1429 * - #RLM_MODULE_UPDATED if one or more #fr_pair_t were added to the #request_t.
1430 * - #RLM_MODULE_FAIL if an error occurred.
1431 * @param[in] mod_inst #rlm_ldap_t
1432 * @param[in] proc_inst unused.
1433 * @param[in,out] request The current request.
1434 * @param[in] url LDAP url specifying base DN and filter.
1435 * @param[in] maps Head of the map list.
1436 * @return UNLANG_ACTION_CALCULATE_RESULT
1437 */
1438static unlang_action_t mod_map_proc(rlm_rcode_t *p_result, void const *mod_inst, UNUSED void *proc_inst, request_t *request,
1439 fr_value_box_list_t *url, map_list_t const *maps)
1440{
1442 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
1443
1444 LDAPURLDesc *ldap_url;
1445 int ldap_url_ret;
1446 fr_ldap_thread_trunk_t *ttrunk;
1447
1448 fr_value_box_t *url_head;
1449 ldap_map_ctx_t *map_ctx;
1450 char *host_url, *host = NULL;
1451
1452 if (fr_uri_escape_list(url, ldap_uri_parts, NULL) < 0) {
1453 RPERROR("Failed to escape LDAP map URI");
1455 }
1456
1457 url_head = fr_value_box_list_head(url);
1458 if (!url_head) {
1459 REDEBUG("LDAP URL cannot be empty");
1461 }
1462
1463 if (fr_value_box_list_concat_in_place(url_head, url_head, url, FR_TYPE_STRING,
1464 FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
1465 RPEDEBUG("Failed concatenating input");
1467 }
1468
1469 if (!ldap_is_ldap_url(url_head->vb_strvalue)) {
1470 REDEBUG("Map query string does not look like a valid LDAP URI");
1472 }
1473
1474 MEM(map_ctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), ldap_map_ctx_t));
1475 talloc_set_destructor(map_ctx, map_ctx_free);
1476 map_ctx->maps = maps;
1477
1478 ldap_url_ret = ldap_url_parse(url_head->vb_strvalue, &map_ctx->ldap_url);
1479 if (ldap_url_ret != LDAP_URL_SUCCESS){
1480 RPEDEBUG("Parsing LDAP URL failed - %s", fr_ldap_url_err_to_str(ldap_url_ret));
1481 fail:
1482 talloc_free(map_ctx);
1484 }
1485 ldap_url = map_ctx->ldap_url;
1486
1487 if (ldap_url->lud_exts) {
1489 ldap_url->lud_exts) < 0) {
1490 RPERROR("Parsing URL extensions failed");
1491 goto fail;
1492 }
1493 }
1494
1495 /*
1496 * Expand the RHS of the maps to get the name of the attributes.
1497 */
1498 if (fr_ldap_map_expand(map_ctx, &map_ctx->expanded, request, maps, NULL, NULL, NULL) < 0) goto fail;
1499
1500 /*
1501 * If the URL is <scheme>:/// the parsed host will be NULL - use config default
1502 */
1503 if (!ldap_url->lud_host) {
1504 host_url = inst->handle_config.server;
1505 } else {
1506 host_url = host = host_uri_canonify(request, ldap_url, url_head);
1507 if (unlikely(host_url == NULL)) goto fail;
1508 }
1509
1510 ttrunk = fr_thread_ldap_trunk_get(thread, host_url, inst->handle_config.admin_identity,
1511 inst->handle_config.admin_password, request, &inst->handle_config);
1512 if (host) ldap_memfree(host);
1513 if (!ttrunk) goto fail;
1514
1515 if (unlang_function_push(request, NULL, mod_map_resume, NULL, 0,
1516 UNLANG_SUB_FRAME, map_ctx) != UNLANG_ACTION_PUSHED_CHILD) goto fail;
1517
1518 return fr_ldap_trunk_search(map_ctx, &map_ctx->query, request, ttrunk, ldap_url->lud_dn,
1519 ldap_url->lud_scope, ldap_url->lud_filter, map_ctx->expanded.attrs,
1520 map_ctx->serverctrls, NULL);
1521}
1522
1523static unlang_action_t CC_HINT(nonnull) mod_authenticate(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
1524{
1526 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
1527 ldap_auth_ctx_t *auth_ctx;
1528 ldap_auth_call_env_t *call_env = talloc_get_type_abort(mctx->env_data, ldap_auth_call_env_t);
1529
1530 if (call_env->password.type != FR_TYPE_STRING) {
1531 RWDEBUG("You have set \"Auth-Type := LDAP\" somewhere");
1532 RWDEBUG("without checking if %s is present", call_env->password_tmpl->name);
1533 RWDEBUG("*********************************************");
1534 RWDEBUG("* THAT CONFIGURATION IS WRONG. DELETE IT. ");
1535 RWDEBUG("* YOU ARE PREVENTING THE SERVER FROM WORKING");
1536 RWDEBUG("*********************************************");
1537
1538 REDEBUG("Attribute \"%s\" is required for authentication", call_env->password_tmpl->name);
1540 }
1541
1542 auth_ctx = talloc(unlang_interpret_frame_talloc_ctx(request), ldap_auth_ctx_t);
1543 *auth_ctx = (ldap_auth_ctx_t){
1544 .password = call_env->password.vb_strvalue,
1545 .thread = thread,
1546 .inst = inst,
1547 .call_env = call_env
1548 };
1549
1550 /*
1551 * Find the user's DN
1552 */
1553 auth_ctx->dn = rlm_find_user_dn_cached(request);
1554
1555 /*
1556 * The DN is required for non-SASL auth
1557 */
1558 if (!auth_ctx->dn && (call_env->user_sasl_mech.type != FR_TYPE_STRING)) {
1559 REDEBUG("No DN found for authentication. Populate control.%s with the DN to use in authentication.",
1560 attr_ldap_userdn->name);
1561 REDEBUG("You should call %s in the recv section and check its return.", inst->mi->name);
1562 talloc_free(auth_ctx);
1564 }
1565
1566 /*
1567 * Log the password
1568 */
1569 if (RDEBUG_ENABLED3) {
1570 RDEBUG("Login attempt with password \"%pV\"", &call_env->password);
1571 } else {
1572 RDEBUG2("Login attempt with password");
1573 }
1574
1575 /*
1576 * SASL bind auth will have the mech set.
1577 */
1578 if (auth_ctx->call_env->user_sasl_mech.type == FR_TYPE_STRING) {
1579#ifdef WITH_SASL
1580 RDEBUG2("Login attempt using identity \"%pV\"", &call_env->user_sasl_authname);
1581
1582 return fr_ldap_sasl_bind_auth_async(request, auth_ctx->thread, call_env->user_sasl_mech.vb_strvalue,
1583 call_env->user_sasl_authname.vb_strvalue,
1584 auth_ctx->password, call_env->user_sasl_proxy.vb_strvalue,
1585 call_env->user_sasl_realm.vb_strvalue);
1586#else
1587 RDEBUG("Configuration item 'sasl.mech' is not supported. "
1588 "The linked version of libldap does not provide ldap_sasl_bind( function");
1590#endif
1591 }
1592
1593 RDEBUG2("Login attempt as \"%s\"", auth_ctx->dn);
1594
1595 return fr_ldap_bind_auth_async(request, auth_ctx->thread, auth_ctx->dn, auth_ctx->password);
1596}
1597
1598/** Start LDAP authorization with async lookup of user DN
1599 *
1600 */
1602 request_t *request, void *uctx)
1603{
1604 ldap_autz_ctx_t *autz_ctx = talloc_get_type_abort(uctx, ldap_autz_ctx_t);
1605 return rlm_ldap_find_user_async(autz_ctx, autz_ctx->inst, request, &autz_ctx->call_env->user_base,
1606 &autz_ctx->call_env->user_filter, autz_ctx->ttrunk, autz_ctx->expanded.attrs,
1607 &autz_ctx->query);
1608}
1609
1610#define REPEAT_MOD_AUTHORIZE_RESUME \
1611 if (unlang_function_repeat_set(request, mod_authorize_resume) < 0) do { \
1612 rcode = RLM_MODULE_FAIL; \
1613 goto finish; \
1614 } while (0)
1615
1616/** Resume function called after each potential yield in LDAP authorization
1617 *
1618 * Some operations may or may not yield. E.g. if group membership is
1619 * read from an attribute returned with the user object and is already
1620 * in the correct form, that will not yield.
1621 * Hence, each state may fall through to the next.
1622 *
1623 * @param p_result Result of current authorization.
1624 * @param priority Unused.
1625 * @param request Current request.
1626 * @param uctx Current authorization context.
1627 * @return One of the RLM_MODULE_* values.
1628 */
1629static unlang_action_t mod_authorize_resume(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
1630{
1631 ldap_autz_ctx_t *autz_ctx = talloc_get_type_abort(uctx, ldap_autz_ctx_t);
1633 ldap_autz_call_env_t *call_env = talloc_get_type_abort(autz_ctx->call_env, ldap_autz_call_env_t);
1634 int ldap_errno;
1635 rlm_rcode_t rcode = RLM_MODULE_OK;
1636 LDAP *handle = fr_ldap_handle_thread_local();
1637
1638 /*
1639 * If a previous async call returned one of the "failure" results just return.
1640 */
1641 switch (*p_result) {
1642 case RLM_MODULE_REJECT:
1643 case RLM_MODULE_FAIL:
1644 case RLM_MODULE_HANDLED:
1645 case RLM_MODULE_INVALID:
1647 rcode = *p_result;
1648 goto finish;
1649
1650 default:
1651 break;
1652 }
1653
1654 switch (autz_ctx->status) {
1655 case LDAP_AUTZ_FIND:
1656 /*
1657 * If a user entry has been found the current rcode will be OK
1658 */
1659 if (*p_result != RLM_MODULE_OK) return UNLANG_ACTION_CALCULATE_RESULT;
1660
1661 autz_ctx->entry = ldap_first_entry(handle, autz_ctx->query->result);
1662 if (!autz_ctx->entry) {
1663 ldap_get_option(handle, LDAP_OPT_RESULT_CODE, &ldap_errno);
1664 REDEBUG("Failed retrieving entry: %s", ldap_err2string(ldap_errno));
1665
1666 goto finish;
1667 }
1668
1669 /*
1670 * Check for access.
1671 */
1672 if (inst->user.obj_access_attr) {
1673 autz_ctx->access_state = rlm_ldap_check_access(inst, request, autz_ctx->entry);
1674 switch (autz_ctx->access_state) {
1676 break;
1677
1679 if (inst->group.skip_on_suspend) goto post_group;
1680 break;
1681
1683 rcode = RLM_MODULE_DISALLOW;
1684 goto finish;
1685 }
1686 }
1687
1688 /*
1689 * Check if we need to cache group memberships
1690 */
1691 if ((inst->group.cacheable_dn || inst->group.cacheable_name) && (inst->group.userobj_membership_attr)) {
1693 if (rlm_ldap_cacheable_userobj(&rcode, request, autz_ctx,
1694 inst->group.userobj_membership_attr) == UNLANG_ACTION_PUSHED_CHILD) {
1695 autz_ctx->status = LDAP_AUTZ_GROUP;
1697 }
1698 if (rcode != RLM_MODULE_OK) goto finish;
1699 }
1701
1702 case LDAP_AUTZ_GROUP:
1703 if (inst->group.cacheable_dn || inst->group.cacheable_name) {
1705 if (rlm_ldap_cacheable_groupobj(&rcode, request, autz_ctx) == UNLANG_ACTION_PUSHED_CHILD) {
1706 autz_ctx->status = LDAP_AUTZ_POST_GROUP;
1708 }
1709 if (rcode != RLM_MODULE_OK) goto finish;
1710 }
1712
1714 post_group:
1715#ifdef WITH_EDIR
1716 /*
1717 * We already have a Password.Cleartext. Skip edir.
1718 */
1719 if (fr_pair_find_by_da_nested(&request->control_pairs, NULL, attr_cleartext_password)) goto skip_edir;
1720
1721 /*
1722 * Retrieve Universal Password if we use eDirectory
1723 */
1724 if (inst->edir) {
1725 autz_ctx->dn = rlm_find_user_dn_cached(request);
1726
1727 /*
1728 * Retrieve universal password
1729 */
1731 autz_ctx->status = LDAP_AUTZ_EDIR_BIND;
1732 return fr_ldap_edir_get_password(request, autz_ctx->dn, autz_ctx->ttrunk,
1734 }
1736
1737 case LDAP_AUTZ_EDIR_BIND:
1738 if (inst->edir && inst->edir_autz) {
1739 fr_pair_t *password = fr_pair_find_by_da(&request->control_pairs,
1741 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data,
1743
1744 if (!password) {
1745 REDEBUG("Failed to find control.Password.Cleartext");
1746 rcode = RLM_MODULE_FAIL;
1747 goto finish;
1748 }
1749
1750 RDEBUG2("Binding as %s for eDirectory authorization checks", autz_ctx->dn);
1751
1752 /*
1753 * Bind as the user
1754 */
1756 autz_ctx->status = LDAP_AUTZ_POST_EDIR;
1757 return fr_ldap_bind_auth_async(request, thread, autz_ctx->dn, password->vp_strvalue);
1758 }
1759 goto skip_edir;
1760
1761 case LDAP_AUTZ_POST_EDIR:
1762 {
1763 /*
1764 * The result of the eDirectory user bind will be in p_result.
1765 * Anything other than RLM_MODULE_OK is a failure.
1766 */
1767 if (*p_result != RLM_MODULE_OK) {
1768 rcode = *p_result;
1769 goto finish;
1770 }
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) 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, autz_ctx->profile_value,
1799 inst->profile.obj_scope, call_env->default_profile.vb_strvalue, &autz_ctx->expanded);
1800 switch (ret) {
1801 case UNLANG_ACTION_FAIL:
1802 rcode = RLM_MODULE_FAIL;
1803 goto finish;
1804
1808
1809 default:
1810 break;
1811 }
1812 }
1814
1816 /*
1817 * Did we jump back her after applying the default profile?
1818 */
1819 if (autz_ctx->status == LDAP_AUTZ_POST_DEFAULT_PROFILE) {
1820 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 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 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
1904finish:
1905 talloc_free(autz_ctx);
1906
1907 RETURN_MODULE_RCODE(rcode);
1908}
1909
1910/** Clear up when cancelling a mod_authorize call
1911 *
1912 */
1913static void mod_authorize_cancel(UNUSED request_t *request, UNUSED fr_signal_t action, void *uctx)
1914{
1915 ldap_autz_ctx_t *autz_ctx = talloc_get_type_abort(uctx, ldap_autz_ctx_t);
1916
1917 if (autz_ctx->query && autz_ctx->query->treq) trunk_request_signal_cancel(autz_ctx->query->treq);
1918}
1919
1920/** Ensure authorization context is properly cleared up
1921 *
1922 */
1923static int autz_ctx_free(ldap_autz_ctx_t *autz_ctx)
1924{
1925 talloc_free(autz_ctx->expanded.ctx);
1926 if (autz_ctx->profile_values) ldap_value_free_len(autz_ctx->profile_values);
1927 return 0;
1928}
1929
1930static unlang_action_t CC_HINT(nonnull) mod_authorize(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
1931{
1933 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
1934 ldap_autz_ctx_t *autz_ctx;
1935 fr_ldap_map_exp_t *expanded;
1936 ldap_autz_call_env_t *call_env = talloc_get_type_abort(mctx->env_data, ldap_autz_call_env_t);
1937
1938 MEM(autz_ctx = talloc_zero(unlang_interpret_frame_talloc_ctx(request), ldap_autz_ctx_t));
1939 talloc_set_destructor(autz_ctx, autz_ctx_free);
1940 expanded = &autz_ctx->expanded;
1941
1942 /*
1943 * Don't be tempted to add a check for User-Name or
1944 * User-Password here. LDAP authorization can be used
1945 * for many things besides searching for users.
1946 */
1947 if (fr_ldap_map_expand(autz_ctx, expanded, request, call_env->user_map, inst->valuepair_attr,
1948 inst->profile.check_attr, inst->profile.fallthrough_attr) < 0) {
1949 fail:
1950 talloc_free(autz_ctx);
1952 }
1953
1954 autz_ctx->ttrunk = fr_thread_ldap_trunk_get(thread, inst->handle_config.server, inst->handle_config.admin_identity,
1955 inst->handle_config.admin_password, request, &inst->handle_config);
1956 if (!autz_ctx->ttrunk) goto fail;
1957
1958#define CHECK_EXPANDED_SPACE(_expanded) fr_assert((size_t)_expanded->count < (NUM_ELEMENTS(_expanded->attrs) - 1));
1959
1960 /*
1961 * Add any additional attributes we need for checking access, memberships, and profiles
1962 */
1963 if (inst->user.obj_access_attr) {
1964 CHECK_EXPANDED_SPACE(expanded);
1965 expanded->attrs[expanded->count++] = inst->user.obj_access_attr;
1966 }
1967
1968 if (inst->group.userobj_membership_attr && (inst->group.cacheable_dn || inst->group.cacheable_name)) {
1969 CHECK_EXPANDED_SPACE(expanded);
1970 expanded->attrs[expanded->count++] = inst->group.userobj_membership_attr;
1971 }
1972
1973 if (inst->profile.attr) {
1974 CHECK_EXPANDED_SPACE(expanded);
1975 expanded->attrs[expanded->count++] = inst->profile.attr;
1976 }
1977
1978 if (inst->profile.attr_suspend) {
1979 CHECK_EXPANDED_SPACE(expanded);
1980 expanded->attrs[expanded->count++] = inst->profile.attr_suspend;
1981 }
1982 expanded->attrs[expanded->count] = NULL;
1983
1984 autz_ctx->dlinst = mctx->mi;
1985 autz_ctx->inst = inst;
1986 autz_ctx->call_env = call_env;
1987 autz_ctx->status = LDAP_AUTZ_FIND;
1988
1991
1993}
1994
1995/** Perform async lookup of user DN if required for user modification
1996 *
1997 */
1999 request_t *request, void *uctx)
2000{
2001 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(uctx, ldap_user_modify_ctx_t);
2002
2003 return rlm_ldap_find_user_async(usermod_ctx, usermod_ctx->inst, request, &usermod_ctx->call_env->user_base,
2004 &usermod_ctx->call_env->user_filter, usermod_ctx->ttrunk, NULL, NULL);
2005}
2006
2007/** Cancel an in progress user modification.
2008 *
2009 */
2010static void user_modify_cancel(UNUSED request_t *request, UNUSED fr_signal_t action, void *uctx)
2011{
2012 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(uctx, ldap_user_modify_ctx_t);
2013
2014 if (!usermod_ctx->query || !usermod_ctx->query->treq) return;
2015
2016 trunk_request_signal_cancel(usermod_ctx->query->treq);
2017}
2018
2019/** Handle results of user modification.
2020 *
2021 */
2022static unlang_action_t user_modify_final(rlm_rcode_t *p_result, UNUSED int *priority,
2023 request_t *request, void *uctx)
2024{
2025 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(uctx, ldap_user_modify_ctx_t);
2026 fr_ldap_query_t *query = usermod_ctx->query;
2027 rlm_rcode_t rcode = RLM_MODULE_OK;
2028
2029 switch (query->ret) {
2031 break;
2032
2034 case LDAP_RESULT_BAD_DN:
2035 RDEBUG2("User object \"%s\" not modified", usermod_ctx->dn);
2036 rcode = RLM_MODULE_INVALID;
2037 break;
2038
2040 rcode = RLM_MODULE_TIMEOUT;
2041 break;
2042
2043 default:
2044 rcode = RLM_MODULE_FAIL;
2045 break;
2046 }
2047
2048 talloc_free(usermod_ctx);
2049 RETURN_MODULE_RCODE(rcode);
2050}
2051
2053 request_t *request, void *uctx)
2054{
2055 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(uctx, ldap_user_modify_ctx_t);
2056 ldap_usermod_call_env_t *call_env = usermod_ctx->call_env;
2057 LDAPMod **modify;
2058 ldap_mod_tmpl_t *mod;
2059 fr_value_box_t *vb = NULL;
2060 int mod_no = usermod_ctx->expanded_mods, i = 0;
2061 struct berval **value_refs;
2062 struct berval *values;
2063
2064 mod = call_env->mod[usermod_ctx->current_mod];
2065
2066 /*
2067 * If the tmpl produced no boxes, skip
2068 */
2069 if ((mod->op != T_OP_CMP_FALSE) && (fr_value_box_list_num_elements(&usermod_ctx->expanded) == 0)) {
2070 RDEBUG2("Expansion \"%s\" produced no value, skipping attribute \"%s\"", mod->tmpl->name, mod->attr);
2071 goto next;
2072 }
2073
2074 switch (mod->op) {
2075 /*
2076 * T_OP_EQ is *NOT* supported, it is impossible to
2077 * support because of the lack of transactions in LDAP
2078 *
2079 * To allow for binary data, all data is provided as berval which
2080 * requires the operation to be logical ORed with LDAP_MOD_BVALUES
2081 */
2082 case T_OP_ADD_EQ:
2083 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_ADD | LDAP_MOD_BVALUES;
2084 break;
2085
2086 case T_OP_SET:
2087 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_REPLACE | LDAP_MOD_BVALUES;
2088 break;
2089
2090 case T_OP_SUB_EQ:
2091 case T_OP_CMP_FALSE:
2092 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_DELETE | LDAP_MOD_BVALUES;
2093 break;
2094
2095 case T_OP_INCRM:
2096 usermod_ctx->mod_s[mod_no].mod_op = LDAP_MOD_INCREMENT | LDAP_MOD_BVALUES;
2097 break;
2098
2099 default:
2100 REDEBUG("Operator '%s' is not supported for LDAP modify operations",
2101 fr_table_str_by_value(fr_tokens_table, mod->op, "<INVALID>"));
2102
2104 }
2105
2106 if (mod->op == T_OP_CMP_FALSE) {
2107 MEM(value_refs = talloc_zero_array(usermod_ctx, struct berval *, 1));
2108 } else {
2109 MEM(value_refs = talloc_zero_array(usermod_ctx, struct berval *,
2110 fr_value_box_list_num_elements(&usermod_ctx->expanded) + 1));
2111 MEM(values = talloc_zero_array(usermod_ctx, struct berval,
2112 fr_value_box_list_num_elements(&usermod_ctx->expanded)));
2113 while ((vb = fr_value_box_list_pop_head(&usermod_ctx->expanded))) {
2114 switch (vb->type) {
2115 case FR_TYPE_OCTETS:
2116 if (vb->vb_length == 0) continue;
2117 memcpy(&values[i].bv_val, &vb->vb_octets, sizeof(values[i].bv_val));
2118 values[i].bv_len = vb->vb_length;
2119 break;
2120
2121 case FR_TYPE_STRING:
2122 populate_string:
2123 if (vb->vb_length == 0) continue;
2124 memcpy(&values[i].bv_val, &vb->vb_strvalue, sizeof(values[i].bv_val));
2125 values[i].bv_len = vb->vb_length;
2126 break;
2127
2128 case FR_TYPE_GROUP:
2129 {
2130 fr_value_box_t *vb_head = fr_value_box_list_head(&vb->vb_group);
2131 if (fr_value_box_list_concat_in_place(vb_head, vb_head, &vb->vb_group, FR_TYPE_STRING,
2132 FR_VALUE_BOX_LIST_FREE, true, SIZE_MAX) < 0) {
2133 RPEDEBUG("Failed concatenating update value");
2135 }
2136 vb = vb_head;
2137 goto populate_string;
2138 }
2139
2140 case FR_TYPE_FIXED_SIZE:
2141 if (fr_value_box_cast_in_place(vb, vb, FR_TYPE_STRING, NULL) < 0) {
2142 RPEDEBUG("Failed casting update value");
2144 }
2145 goto populate_string;
2146
2147 default:
2148 fr_assert(0);
2149
2150 }
2151 value_refs[i] = &values[i];
2152 i++;
2153 }
2154 if (i == 0) {
2155 RDEBUG2("Expansion \"%s\" produced zero length value, skipping attribute \"%s\"", mod->tmpl->name, mod->attr);
2156 goto next;
2157 }
2158 }
2159
2160 /*
2161 * Now everything is evaluated, set up the pointers for the LDAPMod
2162 */
2163 memcpy(&(usermod_ctx->mod_s[mod_no].mod_type), &mod->attr, sizeof(usermod_ctx->mod_s[mod_no].mod_type));
2164 usermod_ctx->mod_s[mod_no].mod_bvalues = value_refs;
2165 usermod_ctx->mod_p[mod_no] = &usermod_ctx->mod_s[mod_no];
2166
2167 usermod_ctx->expanded_mods++;
2168 usermod_ctx->mod_p[usermod_ctx->expanded_mods] = NULL;
2169
2170next:
2171 usermod_ctx->current_mod++;
2172 if (usermod_ctx->current_mod < usermod_ctx->num_mods) {
2174 if (unlang_tmpl_push(usermod_ctx, &usermod_ctx->expanded, request,
2175 usermod_ctx->call_env->mod[usermod_ctx->current_mod]->tmpl, NULL) < 0) RETURN_MODULE_FAIL;
2177 }
2178
2179 modify = usermod_ctx->mod_p;
2180
2182 UNLANG_SUB_FRAME, usermod_ctx) < 0) RETURN_MODULE_FAIL;
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 */
2192 request_t *request, void *uctx)
2193{
2194 ldap_user_modify_ctx_t *usermod_ctx = talloc_get_type_abort(uctx, ldap_user_modify_ctx_t);
2195
2196 /*
2197 * If an LDAP search was used to find the user DN
2198 * usermod_ctx->dn will be NULL.
2199 */
2200 if (!usermod_ctx->dn) usermod_ctx->dn = rlm_find_user_dn_cached(request);
2201
2202 if (!usermod_ctx->dn) {
2203 fail:
2204 talloc_free(usermod_ctx);
2206 }
2207
2208 /*
2209 * Allocate arrays to hold mods. mod_p is one element longer to hold a terminating NULL entry
2210 */
2211 MEM(usermod_ctx->mod_p = talloc_zero_array(usermod_ctx, LDAPMod *, usermod_ctx->num_mods + 1));
2212 MEM(usermod_ctx->mod_s = talloc_array(usermod_ctx, LDAPMod, usermod_ctx->num_mods));
2213 fr_value_box_list_init(&usermod_ctx->expanded);
2214
2215 if (unlang_function_repeat_set(request, user_modify_mod_build_resume) < 0) goto fail;
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(rlm_rcode_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
2234 fr_ldap_thread_t *thread = talloc_get_type_abort(module_thread(inst->mi)->data, fr_ldap_thread_t);
2235 ldap_user_modify_ctx_t *usermod_ctx = NULL;
2236
2237 size_t num_mods = talloc_array_length(call_env->mod);
2238
2239 if (num_mods == 0) RETURN_MODULE_NOOP;
2240
2241 /*
2242 * Include a talloc pool allowing for one value per modification
2243 */
2245 2 * num_mods + 2,
2246 (sizeof(struct berval) + (sizeof(struct berval *) * 2) +
2247 (sizeof(LDAPMod) + sizeof(LDAPMod *))) * num_mods));
2248 *usermod_ctx = (ldap_user_modify_ctx_t) {
2249 .inst = inst,
2250 .call_env = call_env,
2251 .num_mods = num_mods
2252 };
2253
2254 usermod_ctx->ttrunk = fr_thread_ldap_trunk_get(thread, inst->handle_config.server,
2255 inst->handle_config.admin_identity,
2256 inst->handle_config.admin_password,
2257 request, &inst->handle_config);
2258 if (!usermod_ctx->ttrunk) {
2259 REDEBUG("Unable to get LDAP trunk for update");
2260 talloc_free(usermod_ctx);
2262 }
2263
2264 usermod_ctx->dn = rlm_find_user_dn_cached(request);
2265
2266 if (unlang_function_push(request, usermod_ctx->dn ? NULL : user_modify_start, user_modify_resume,
2267 NULL, 0, UNLANG_SUB_FRAME, usermod_ctx) < 0) goto error;
2268
2270
2271error:
2272 TALLOC_FREE(usermod_ctx);
2273 RETURN_MODULE_RCODE(rcode);
2274}
2275
2276/** Detach from the LDAP server and cleanup internal state.
2277 *
2278 */
2279static int mod_detach(module_detach_ctx_t const *mctx)
2280{
2281 rlm_ldap_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2282
2283 if (inst->user.obj_sort_ctrl) ldap_control_free(inst->user.obj_sort_ctrl);
2284 if (inst->profile.obj_sort_ctrl) ldap_control_free(inst->profile.obj_sort_ctrl);
2285
2286 return 0;
2287}
2288
2289static int ldap_update_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules,
2290 CONF_ITEM *ci,
2291 UNUSED call_env_ctx_t const *cec, call_env_parser_t const *rule)
2292{
2293 map_list_t *maps;
2294 CONF_SECTION *update = cf_item_to_section(ci);
2295 ldap_update_rules_t const *ur = rule->uctx;
2296
2297 bool expect_password = false;
2298
2299 /*
2300 * Build the attribute map
2301 */
2302 {
2303 map_t const *map = NULL;
2304 tmpl_attr_t const *ar;
2305 call_env_parsed_t *parsed;
2306
2307 MEM(parsed = call_env_parsed_add(ctx, out,
2309 .name = "update",
2310 .flags = CALL_ENV_FLAG_PARSE_ONLY,
2311 .pair = {
2312 .parsed = {
2313 .offset = ur->map_offset,
2315 }
2316 }
2317 }));
2318
2319 MEM(maps = talloc(parsed, map_list_t));
2320 map_list_init(maps);
2321
2322 if (update && (map_afrom_cs(maps, maps, update, t_rules, t_rules, fr_ldap_map_verify,
2323 NULL, LDAP_MAX_ATTRMAP)) < 0) {
2324 call_env_parsed_free(out, parsed);
2325 return -1;
2326 }
2327 /*
2328 * Check map to see if a password is being retrieved.
2329 * fr_ldap_map_verify ensures that all maps have attributes on the LHS.
2330 * All passwords have a common parent attribute of attr_password
2331 */
2332 while ((map = map_list_next(maps, map))) {
2333 ar = tmpl_attr_tail(map->lhs);
2334 if (ar->da->parent == attr_password) {
2335 expect_password = true;
2336 break;
2337 }
2338 }
2339 call_env_parsed_set_data(parsed, maps);
2340 }
2341
2342 /*
2343 * Write out whether we expect a password to be returned from the ldap data
2344 */
2345 if (ur->expect_password_offset >= 0) {
2346 call_env_parsed_t *parsed;
2347 fr_value_box_t *vb;
2348
2349 MEM(parsed = call_env_parsed_add(ctx, out,
2351 .name = "expect_password",
2352 .flags = CALL_ENV_FLAG_PARSE_ONLY,
2353 .pair = {
2354 .parsed = {
2355 .offset = ur->expect_password_offset,
2357 }
2358 }
2359 }));
2360 MEM(vb = fr_value_box_alloc(parsed, FR_TYPE_BOOL, NULL));
2361 vb->vb_bool = expect_password;
2362 call_env_parsed_set_value(parsed, vb);
2363 }
2364
2365 return 0;
2366}
2367
2368static int ldap_mod_section_parse(TALLOC_CTX *ctx, call_env_parsed_head_t *out, tmpl_rules_t const *t_rules,
2369 CONF_ITEM *ci, call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
2370{
2371 CONF_SECTION const *subcs = NULL;
2372 CONF_PAIR const *to_parse = NULL;
2373 tmpl_t *parsed_tmpl;
2374 call_env_parsed_t *parsed_env;
2375 char *section2, *p;
2376 ssize_t count, slen, multi_index = 0;
2377 ldap_mod_tmpl_t *mod;
2378
2380
2381 section2 = talloc_strdup(NULL, section_name_str(cec->asked->name2));
2382 p = section2;
2383 while (*p != '\0') {
2384 *(p) = tolower((uint8_t)*p);
2385 p++;
2386 }
2387
2388 if (!ci) {
2389 not_found:
2390 cf_log_warn(ci, "No section found for \"%s.%s\" in module \"%s\", this call will have no effect.",
2391 section_name_str(cec->asked->name1), section2, cec->mi->name);
2392 free:
2393 talloc_free(section2);
2394 return 0;
2395 }
2396
2397 subcs = cf_section_find(cf_item_to_section(ci), section2, CF_IDENT_ANY);
2398 if (!subcs) goto not_found;
2399
2400 subcs = cf_section_find(subcs, "update", CF_IDENT_ANY);
2401 if (!subcs) {
2402 cf_log_warn(ci, "No update found inside \"%s -> %s\" in module \"%s\"",
2403 section_name_str(cec->asked->name1), section2, cec->mi->name);
2404 goto free;
2405 }
2406
2408 if (count == 0) {
2409 cf_log_warn(ci, "No modifications found for \"%s.%s\" in module \"%s\"",
2410 section_name_str(cec->asked->name1), section2, cec->mi->name);
2411 goto free;
2412 }
2413 talloc_free(section2);
2414
2415 while ((to_parse = cf_pair_next(subcs, to_parse))) {
2416 switch (cf_pair_operator(to_parse)) {
2417 case T_OP_SET:
2418 case T_OP_ADD_EQ:
2419 case T_OP_SUB_EQ:
2420 case T_OP_CMP_FALSE:
2421 case T_OP_INCRM:
2422 break;
2423
2424 default:
2425 cf_log_perr(to_parse, "Invalid operator for LDAP modification");
2426 return -1;
2427 }
2428
2429 MEM(parsed_env = call_env_parsed_add(ctx, out,
2434 }));
2435
2436 slen = tmpl_afrom_substr(parsed_env, &parsed_tmpl,
2437 &FR_SBUFF_IN(cf_pair_value(to_parse), talloc_array_length(cf_pair_value(to_parse)) - 1),
2439 t_rules);
2440
2441 if (slen <= 0) {
2442 cf_canonicalize_error(to_parse, slen, "Failed parsing LDAP modification \"%s\"", cf_pair_value(to_parse));
2443 error:
2444 call_env_parsed_free(out, parsed_env);
2445 return -1;
2446 }
2447 if (tmpl_needs_resolving(parsed_tmpl) &&
2448 (tmpl_resolve(parsed_tmpl, &(tmpl_res_rules_t){ .dict_def = t_rules->attr.dict_def }) <0)) {
2449 cf_log_perr(to_parse, "Failed resolving LDAP modification \"%s\"", cf_pair_value(to_parse));
2450 goto error;
2451 }
2452
2453 MEM(mod = talloc(parsed_env, ldap_mod_tmpl_t));
2454 mod->attr = cf_pair_attr(to_parse);
2455 mod->tmpl = parsed_tmpl;
2456 mod->op = cf_pair_operator(to_parse);
2457
2458 call_env_parsed_set_multi_index(parsed_env, count, multi_index++);
2459 call_env_parsed_set_data(parsed_env, mod);
2460 }
2461
2462 return 0;
2463}
2464
2465static int ldap_group_filter_parse(TALLOC_CTX *ctx, void *out, tmpl_rules_t const *t_rules, UNUSED CONF_ITEM *ci,
2466 call_env_ctx_t const *cec, UNUSED call_env_parser_t const *rule)
2467{
2469 char const *filters[] = { inst->group.obj_filter, inst->group.obj_membership_filter };
2470 tmpl_t *parsed;
2471
2472 if (fr_ldap_filter_to_tmpl(ctx, t_rules, filters, NUM_ELEMENTS(filters), &parsed) < 0) return -1;
2473
2474 *(void **)out = parsed;
2475 return 0;
2476}
2477
2478/** Clean up thread specific data structure
2479 *
2480 */
2482{
2483 fr_ldap_thread_t *t = talloc_get_type_abort(mctx->thread, fr_ldap_thread_t);
2484 void **trunks_to_free;
2485 int i;
2486
2487 if (fr_rb_flatten_inorder(NULL, &trunks_to_free, t->trunks) < 0) return -1;
2488
2489 for (i = talloc_array_length(trunks_to_free) - 1; i >= 0; i--) talloc_free(trunks_to_free[i]);
2490 talloc_free(trunks_to_free);
2491 talloc_free(t->trunks);
2492
2493 return 0;
2494}
2495
2496/** Initialise thread specific data structure
2497 *
2498 */
2500{
2501 rlm_ldap_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2502 fr_ldap_thread_t *t = talloc_get_type_abort(mctx->thread, fr_ldap_thread_t);
2503 fr_ldap_thread_trunk_t *ttrunk;
2504
2505 /*
2506 * Initialise tree for connection trunks used by this thread
2507 */
2509
2510 t->config = &inst->handle_config;
2511 t->trunk_conf = &inst->trunk_conf;
2512 t->bind_trunk_conf = &inst->bind_trunk_conf;
2513 t->el = mctx->el;
2514
2515 /*
2516 * Launch trunk for module default connection
2517 */
2518 ttrunk = fr_thread_ldap_trunk_get(t, inst->handle_config.server, inst->handle_config.admin_identity,
2519 inst->handle_config.admin_password, NULL, &inst->handle_config);
2520 if (!ttrunk) {
2521 ERROR("Unable to launch LDAP trunk");
2522 return -1;
2523 }
2524
2525 /*
2526 * Set up a per-thread LDAP trunk to use for bind auths
2527 */
2529
2531
2532 return 0;
2533}
2534
2535/** Instantiate the module
2536 *
2537 * Creates a new instance of the module reading parameters from a configuration section.
2538 *
2539 * @param [in] mctx configuration data.
2540 * @return
2541 * - 0 on success.
2542 * - < 0 on failure.
2543 */
2544static int mod_instantiate(module_inst_ctx_t const *mctx)
2545{
2546 size_t i;
2547
2548 CONF_SECTION *options;
2549 rlm_ldap_boot_t const *boot = talloc_get_type_abort(mctx->mi->boot, rlm_ldap_boot_t);
2550 rlm_ldap_t *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2551 CONF_SECTION *conf = mctx->mi->conf;
2552
2553 inst->mi = mctx->mi; /* Cached for IO callbacks */
2554 inst->group.da = boot->group_da;
2555 inst->group.cache_da = boot->cache_da;
2556
2557 inst->handle_config.name = talloc_typed_asprintf(inst, "rlm_ldap (%s)", mctx->mi->name);
2558
2559 /*
2560 * Trunks used for bind auth can only have one request in flight per connection.
2561 */
2562 inst->bind_trunk_conf.target_req_per_conn = 1;
2563 inst->bind_trunk_conf.max_req_per_conn = 1;
2564
2565 /*
2566 * Set sizes for trunk request pool.
2567 */
2568 inst->bind_trunk_conf.req_pool_headers = 2;
2569 inst->bind_trunk_conf.req_pool_size = sizeof(fr_ldap_bind_auth_ctx_t) + sizeof(fr_ldap_sasl_ctx_t);
2570
2571 options = cf_section_find(conf, "options", NULL);
2572 if (!options || !cf_pair_find(options, "chase_referrals")) {
2573 inst->handle_config.chase_referrals_unset = true; /* use OpenLDAP defaults */
2574 }
2575
2576 /*
2577 * Sanity checks for cacheable groups code.
2578 */
2579 if (inst->group.cacheable_name && inst->group.obj_membership_filter) {
2580 if (!inst->group.obj_name_attr) {
2581 cf_log_err(conf, "Configuration item 'group.name_attribute' must be set if cacheable "
2582 "group names are enabled");
2583
2584 goto error;
2585 }
2586 }
2587
2588 /*
2589 * If we have a *pair* as opposed to a *section*
2590 * then the module is referencing another ldap module's
2591 * connection pool.
2592 */
2593 if (!cf_pair_find(conf, "pool")) {
2594 if (!inst->handle_config.server_str) {
2595 cf_log_err(conf, "Configuration item 'server' must have a value");
2596 goto error;
2597 }
2598 }
2599
2600#ifndef WITH_SASL
2601 if (inst->handle_config.admin_sasl.mech) {
2602 cf_log_err(conf, "Configuration item 'sasl.mech' not supported. "
2603 "Linked libldap does not provide ldap_sasl_interactive_bind function");
2604 goto error;
2605 }
2606#endif
2607
2608 /*
2609 * Initialise server with zero length string to
2610 * make code below simpler.
2611 */
2612 inst->handle_config.server = talloc_strdup(inst, "");
2613
2614 /*
2615 * Now iterate over all the 'server' config items
2616 */
2617 for (i = 0; i < talloc_array_length(inst->handle_config.server_str); i++) {
2618 char const *value = inst->handle_config.server_str[i];
2619 size_t j;
2620
2621 /*
2622 * Explicitly prevent multiple server definitions
2623 * being used in the same string.
2624 */
2625 for (j = 0; j < talloc_array_length(value) - 1; j++) {
2626 switch (value[j]) {
2627 case ' ':
2628 case ',':
2629 case ';':
2630 cf_log_err(conf, "Invalid character '%c' found in 'server' configuration item",
2631 value[j]);
2632 goto error;
2633
2634 default:
2635 continue;
2636 }
2637 }
2638
2639 /*
2640 * Split original server value out into URI, server and port
2641 * so whatever initialization function we use later will have
2642 * the server information in the format it needs.
2643 */
2644 if (ldap_is_ldap_url(value)) {
2645 if (fr_ldap_server_url_check(&inst->handle_config, value, conf) < 0) return -1;
2646 } else
2647 /*
2648 * If it's not an URL, then just treat server as a hostname.
2649 */
2650 {
2651 if (fr_ldap_server_config_check(&inst->handle_config, value, conf) < 0) return -1;
2652 }
2653 }
2654
2655 /*
2656 * inst->handle_config.server be unset if connection pool sharing is used.
2657 */
2658 if (inst->handle_config.server) {
2659 inst->handle_config.server[talloc_array_length(inst->handle_config.server) - 2] = '\0';
2660 DEBUG4("rlm_ldap (%s) - LDAP server string: %s", mctx->mi->name, inst->handle_config.server);
2661 }
2662
2663 /*
2664 * Workaround for servers which support LDAPS but not START TLS
2665 */
2666 if (inst->handle_config.port == LDAPS_PORT || inst->handle_config.tls_mode) {
2667 inst->handle_config.tls_mode = LDAP_OPT_X_TLS_HARD;
2668 } else {
2669 inst->handle_config.tls_mode = 0;
2670 }
2671
2672 /*
2673 * Convert dereference strings to enumerated constants
2674 */
2675 if (inst->handle_config.dereference_str) {
2676 inst->handle_config.dereference = fr_table_value_by_str(fr_ldap_dereference,
2677 inst->handle_config.dereference_str, -1);
2678 if (inst->handle_config.dereference < 0) {
2679 cf_log_err(conf, "Invalid 'dereference' value \"%s\", expected 'never', 'searching', "
2680 "'finding' or 'always'", inst->handle_config.dereference_str);
2681 goto error;
2682 }
2683 }
2684
2685 /*
2686 * Build the server side sort control for user / profile objects
2687 */
2688#define SSS_CONTROL_BUILD(_obj) if (inst->_obj.obj_sort_by) { \
2689 LDAPSortKey **keys; \
2690 int ret; \
2691 ret = ldap_create_sort_keylist(&keys, UNCONST(char *, inst->_obj.obj_sort_by)); \
2692 if (ret != LDAP_SUCCESS) { \
2693 cf_log_err(conf, "Invalid " STRINGIFY(_obj) ".sort_by value \"%s\": %s", \
2694 inst->_obj.obj_sort_by, ldap_err2string(ret)); \
2695 goto error; \
2696 } \
2697 /* \
2698 * Always set the control as critical, if it's not needed \
2699 * the user can comment it out... \
2700 */ \
2701 ret = ldap_create_sort_control(ldap_global_handle, keys, 1, &inst->_obj.obj_sort_ctrl); \
2702 ldap_free_sort_keylist(keys); \
2703 if (ret != LDAP_SUCCESS) { \
2704 ERROR("Failed creating server sort control: %s", ldap_err2string(ret)); \
2705 goto error; \
2706 } \
2707 }
2708
2709 SSS_CONTROL_BUILD(user)
2710 SSS_CONTROL_BUILD(profile)
2711
2712 if (inst->handle_config.tls_require_cert_str) {
2713 /*
2714 * Convert cert strictness to enumerated constants
2715 */
2716 inst->handle_config.tls_require_cert = fr_table_value_by_str(fr_ldap_tls_require_cert,
2717 inst->handle_config.tls_require_cert_str, -1);
2718 if (inst->handle_config.tls_require_cert < 0) {
2719 cf_log_err(conf, "Invalid 'tls.require_cert' value \"%s\", expected 'never', "
2720 "'demand', 'allow', 'try' or 'hard'", inst->handle_config.tls_require_cert_str);
2721 goto error;
2722 }
2723 }
2724
2725 if (inst->handle_config.tls_min_version_str) {
2726 if (strcmp(inst->handle_config.tls_min_version_str, "1.3") == 0) {
2727 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_3;
2728
2729 } else if (strcmp(inst->handle_config.tls_min_version_str, "1.2") == 0) {
2730 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_2;
2731
2732 } else if (strcmp(inst->handle_config.tls_min_version_str, "1.1") == 0) {
2733 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_1;
2734
2735 } else if (strcmp(inst->handle_config.tls_min_version_str, "1.0") == 0) {
2736 inst->handle_config.tls_min_version = LDAP_OPT_X_TLS_PROTOCOL_TLS1_0;
2737
2738 } else {
2739 cf_log_err(conf, "Invalid 'tls.tls_min_version' value \"%s\"", inst->handle_config.tls_min_version_str);
2740 goto error;
2741 }
2742 }
2743
2744 return 0;
2745
2746error:
2747 return -1;
2748}
2749
2750/** Bootstrap the module
2751 *
2752 * Define attributes.
2753 *
2754 * @param[in] mctx configuration data.
2755 * @return
2756 * - 0 on success.
2757 * - < 0 on failure.
2758 */
2759static int mod_bootstrap(module_inst_ctx_t const *mctx)
2760{
2761 rlm_ldap_boot_t *boot = talloc_get_type_abort(mctx->mi->boot, rlm_ldap_boot_t);
2762 rlm_ldap_t const *inst = talloc_get_type_abort(mctx->mi->data, rlm_ldap_t);
2763 CONF_SECTION *conf = mctx->mi->conf;
2764 char buffer[256];
2765 char const *group_attribute;
2766 xlat_t *xlat;
2767
2768 if (inst->group.attribute) {
2769 group_attribute = inst->group.attribute;
2770 } else if (cf_section_name2(conf)) {
2771 snprintf(buffer, sizeof(buffer), "%s-LDAP-Group", mctx->mi->name);
2772 group_attribute = buffer;
2773 } else {
2774 group_attribute = "LDAP-Group";
2775 }
2776
2777 boot->group_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), group_attribute);
2778
2779 /*
2780 * If the group attribute was not in the dictionary, create it
2781 */
2782 if (!boot->group_da) {
2784 group_attribute, FR_TYPE_STRING, NULL) < 0) {
2785 PERROR("Error creating group attribute");
2786 return -1;
2787
2788 }
2789 boot->group_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), group_attribute);
2790 }
2791
2792 /*
2793 * Setup the cache attribute
2794 */
2795
2796 if (inst->group.cache_attribute) {
2797 boot->cache_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), inst->group.cache_attribute);
2798 if (!boot->cache_da) {
2800 inst->group.cache_attribute, FR_TYPE_STRING, NULL) < 0) {
2801 PERROR("Error creating cache attribute");
2802 return -1;
2803 }
2804 boot->cache_da = fr_dict_attr_by_name(NULL, fr_dict_root(dict_freeradius), inst->group.cache_attribute);
2805 }
2806 } else {
2807 boot->cache_da = boot->group_da; /* Default to the group_da */
2808 }
2809
2810 xlat = module_rlm_xlat_register(mctx->mi->boot, mctx, NULL, ldap_xlat, FR_TYPE_STRING);
2812
2813 if (unlikely(!(xlat = module_rlm_xlat_register(mctx->mi->boot, mctx, "group", ldap_group_xlat,
2814 FR_TYPE_BOOL)))) return -1;
2817
2818 if (unlikely(!(xlat = module_rlm_xlat_register(mctx->mi->boot, mctx, "profile", ldap_profile_xlat,
2819 FR_TYPE_BOOL)))) return -1;
2822
2824
2825 return 0;
2826}
2827
2828static int mod_load(void)
2829{
2830 xlat_t *xlat;
2831
2832 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.escape", ldap_uri_escape_xlat, FR_TYPE_STRING)))) return -1;
2835 xlat_func_safe_for_set(xlat, LDAP_URI_SAFE_FOR); /* Used for all LDAP escaping */
2836
2837 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.safe", xlat_transparent, FR_TYPE_STRING)))) return -1;
2841
2842 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.unescape", ldap_uri_unescape_xlat, FR_TYPE_STRING)))) return -1;
2845
2846 if (unlikely(!(xlat = xlat_func_register(NULL, "ldap.uri.attr_option", ldap_xlat_uri_attr_option, FR_TYPE_STRING)))) return -1;
2849
2850 return 0;
2851}
2852
2853static void mod_unload(void)
2854{
2855 xlat_func_unregister("ldap.uri.escape");
2856 xlat_func_unregister("ldap.uri.safe");
2857 xlat_func_unregister("ldap.uri.unescape");
2858}
2860/* globally exported name */
2861extern module_rlm_t rlm_ldap;
2863 .common = {
2864 .magic = MODULE_MAGIC_INIT,
2865 .name = "ldap",
2866 .flags = 0,
2867 .boot_size = sizeof(rlm_ldap_boot_t),
2868 .boot_type = "rlm_ldap_boot_t",
2869 .inst_size = sizeof(rlm_ldap_t),
2870 .config = module_config,
2871 .onload = mod_load,
2872 .unload = mod_unload,
2873 .bootstrap = mod_bootstrap,
2874 .instantiate = mod_instantiate,
2875 .detach = mod_detach,
2876 .thread_inst_size = sizeof(fr_ldap_thread_t),
2877 .thread_inst_type = "fr_ldap_thread_t",
2880 },
2881 .method_group = {
2882 .bindings = (module_method_binding_t[]){
2883 /*
2884 * Hack to support old configurations
2885 */
2886 { .section = SECTION_NAME("accounting", CF_IDENT_ANY), .method = mod_modify, .method_env = &accounting_usermod_method_env },
2887 { .section = SECTION_NAME("authenticate", CF_IDENT_ANY), .method = mod_authenticate, .method_env = &authenticate_method_env },
2888 { .section = SECTION_NAME("authorize", CF_IDENT_ANY), .method = mod_authorize, .method_env = &authorize_method_env },
2889
2890 { .section = SECTION_NAME("recv", CF_IDENT_ANY), .method = mod_authorize, .method_env = &authorize_method_env },
2891 { .section = SECTION_NAME("send", CF_IDENT_ANY), .method = mod_modify, .method_env = &send_usermod_method_env },
2893 }
2894 }
2895};
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
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:734
call_env_parsed_t * call_env_parsed_add(TALLOC_CTX *ctx, call_env_parsed_head_t *head, call_env_parser_t const *rule)
Allocate a new call_env_parsed_t structure and add it to the list of parsed call envs.
Definition call_env.c:647
void call_env_parsed_set_multi_index(call_env_parsed_t *parsed, size_t count, size_t index)
Assign a count and index to a call_env_parsed_t.
Definition call_env.c:719
void call_env_parsed_set_data(call_env_parsed_t *parsed, void const *data)
Assign data to a call_env_parsed_t.
Definition call_env.c:704
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:690
#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:273
fr_dict_t const ** out
Where to write a pointer to the loaded/resolved fr_dict_t.
Definition dict.h:286
static fr_slen_t in
Definition dict.h:840
Specifies an attribute which must be present for the module to function.
Definition dict.h:272
Specifies a dictionary which must be loaded/loadable for the module to function.
Definition dict.h:285
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_repeat_set(_request, _repeat)
Set a new repeat function for an existing function frame.
Definition function.h:89
#define unlang_function_push(_request, _func, _repeat, _signal, _sigmask, _top_frame, _uctx)
Push a generic function onto the unlang stack.
Definition function.h:111
#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:421
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:835
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:1036
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:1163
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:580
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:476
unlang_action_t rlm_ldap_cacheable_userobj(rlm_rcode_t *p_result, request_t *request, ldap_autz_ctx_t *autz_ctx, char const *attr)
Convert group membership information into attributes.
Definition groups.c:443
unlang_action_t rlm_ldap_check_userobj_dynamic(rlm_rcode_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:1120
unlang_action_t rlm_ldap_check_cached(rlm_rcode_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:1158
unlang_action_t rlm_ldap_cacheable_groupobj(rlm_rcode_t *p_result, request_t *request, ldap_autz_ctx_t *autz_ctx)
Convert group membership information into attributes.
Definition groups.c:700
unlang_action_t rlm_ldap_check_groupobj_dynamic(rlm_rcode_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:786
free(array)
void unlang_interpret_mark_runnable(request_t *request)
Mark a request as resumable.
Definition interpret.c:1360
TALLOC_CTX * unlang_interpret_frame_talloc_ctx(request_t *request)
Get a talloc_ctx which is valid only for this frame.
Definition interpret.c:1405
fr_event_list_t * unlang_interpret_event_list(request_t *request)
Get the event list for the current interpreter.
Definition interpret.c:1757
#define UNLANG_SUB_FRAME
Definition interpret.h:36
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:793
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:157
size_t fr_ldap_util_normalise_dn(char *out, char const *in)
Normalise escape sequences in a DN.
Definition util.c:490
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:70
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:568
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:204
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:656
char * fr_ldap_berval_to_string(TALLOC_CTX *ctx, struct berval const *in)
Convert a berval to a talloced string.
Definition util.c:441
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:110
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:752
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:302
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
unlang_action_t fr_ldap_edir_get_password(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:295
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
unlang_action_t fr_ldap_bind_auth_async(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:319
trunk_t * trunk
Connection trunk.
Definition base.h:405
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:75
LDAP * fr_ldap_handle_thread_local(void)
Get a thread local dummy LDAP handle.
Definition base.c:1106
global_lib_autoinst_t fr_libldap_global_config
Definition base.c:134
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:755
fr_table_num_sorted_t const fr_ldap_tls_require_cert[]
Definition base.c:77
fr_table_num_sorted_t const fr_ldap_dereference[]
Definition base.c:86
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:1027
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:709
fr_table_num_sorted_t const fr_ldap_scope[]
Definition base.c:69
#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
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
@ 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
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:213
#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 void thread_detach(UNUSED void *uctx)
Explicitly cleanup module/xlat resources.
Definition radiusd.c:150
static int thread_instantiate(TALLOC_CTX *ctx, fr_event_list_t *el, UNUSED void *uctx)
Create module and xlat per-thread instances.
Definition radiusd.c:133
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_MODULE_NOOP
Definition rcode.h:63
#define RETURN_MODULE_RCODE(_rcode)
Definition rcode.h:66
#define RETURN_MODULE_INVALID
Definition rcode.h:60
#define RETURN_MODULE_FAIL
Definition rcode.h:57
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
tmpl_t const * tmpl
Definition rlm_ldap.c:69
static const call_env_method_t xlat_memberof_method_env
Definition rlm_ldap.c:269
static int mod_detach(module_detach_ctx_t const *mctx)
Detach from the LDAP server and cleanup internal state.
Definition rlm_ldap.c:2279
static int mod_load(void)
Definition rlm_ldap.c:2825
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:1135
map_list_t * profile_map
List of maps to apply to the profile.
Definition rlm_ldap.c:81
#define REPEAT_LDAP_MEMBEROF_XLAT_RESULTS
Definition rlm_ldap.c:956
static conf_parser_t profile_config[]
Definition rlm_ldap.c:97
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:1292
fr_dict_attr_t const * attr_nt_password
Definition rlm_ldap.c:328
static void user_modify_cancel(UNUSED request_t *request, UNUSED fr_signal_t action, void *uctx)
Cancel an in progress user modification.
Definition rlm_ldap.c:2010
static xlat_arg_parser_t const ldap_safe_xlat_arg[]
Definition rlm_ldap.c:412
static unlang_action_t mod_map_proc(rlm_rcode_t *p_result, void const *mod_inst, UNUSED void *proc_inst, request_t *request, fr_value_box_list_t *url, map_list_t const *maps)
Perform a search and map the result of the search to server attributes.
Definition rlm_ldap.c:1438
ldap_auth_call_env_t * call_env
Definition rlm_ldap.c:359
static unlang_action_t ldap_group_xlat_results(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Run the state machine for the LDAP membership xlat.
Definition rlm_ldap.c:966
static const call_env_method_t authenticate_method_env
Definition rlm_ldap.c:190
static unlang_action_t user_modify_mod_build_resume(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Definition rlm_ldap.c:2052
static xlat_arg_parser_t const ldap_uri_escape_xlat_arg[]
Definition rlm_ldap.c:407
fr_ldap_result_code_t ret
Definition rlm_ldap.c:1126
fr_dict_attr_t const * attr_ldap_userdn
Definition rlm_ldap.c:327
global_lib_autoinst_t const * rlm_ldap_lib[]
Definition rlm_ldap.c:346
static const call_env_method_t authorize_method_env
Definition rlm_ldap.c:213
#define USERMOD_ENV(_section)
Definition rlm_ldap.c:254
fr_value_box_t password
Definition rlm_ldap.c:58
static unlang_action_t mod_map_resume(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Process the results of an LDAP map query.
Definition rlm_ldap.c:1312
LDAPControl * serverctrls[LDAP_MAX_CONTROLS]
Definition rlm_ldap.c:387
#define SSS_CONTROL_BUILD(_obj)
static xlat_arg_parser_t const ldap_uri_unescape_xlat_arg[]
Definition rlm_ldap.c:467
static const call_env_method_t xlat_profile_method_env
Definition rlm_ldap.c:298
static xlat_arg_parser_t const ldap_uri_attr_option_xlat_arg[]
Definition rlm_ldap.c:565
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)
map_list_t const * maps
Definition rlm_ldap.c:383
static unlang_action_t user_modify_resume(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Take the retrieved user DN and launch the async tmpl expansion of mod_values.
Definition rlm_ldap.c:2191
fr_dict_attr_t const * attr_crypt_password
Definition rlm_ldap.c:326
fr_value_box_t user_filter
Definition rlm_ldap.c:73
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:316
static int map_ctx_free(ldap_map_ctx_t *map_ctx)
Ensure map context is properly cleared up.
Definition rlm_ldap.c:1408
fr_dict_attr_t const * cache_da
Definition rlm_ldap.c:54
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:542
static conf_parser_t user_config[]
Definition rlm_ldap.c:112
static fr_dict_attr_t const * attr_expr_bool_enum
Definition rlm_ldap.c:330
static fr_table_num_sorted_t const ldap_uri_scheme_table[]
Definition rlm_ldap.c:396
static xlat_arg_parser_t const ldap_xlat_arg[]
Definition rlm_ldap.c:736
static unlang_action_t mod_authorize_start(UNUSED rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Start LDAP authorization with async lookup of user DN.
Definition rlm_ldap.c:1601
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:513
fr_dict_attr_t const * group_da
Definition rlm_ldap.c:53
fr_dict_attr_t const * attr_password
Definition rlm_ldap.c:324
static unlang_action_t mod_authenticate(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
Definition rlm_ldap.c:1523
static int mod_bootstrap(module_inst_ctx_t const *mctx)
Bootstrap the module.
Definition rlm_ldap.c:2756
#define REPEAT_MOD_AUTHORIZE_RESUME
Definition rlm_ldap.c:1610
fr_value_box_t user_sasl_proxy
Definition rlm_ldap.c:62
fr_ldap_thread_trunk_t * ttrunk
Definition rlm_ldap.c:371
fr_value_box_t user_sasl_authname
Definition rlm_ldap.c:61
fr_dict_attr_t const * attr_password_with_header
Definition rlm_ldap.c:329
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)
rlm_ldap_t const * inst
Definition rlm_ldap.c:366
static conf_parser_t group_config[]
Definition rlm_ldap.c:128
fr_ldap_query_t * query
Definition rlm_ldap.c:385
static void mod_unload(void)
Definition rlm_ldap.c:2850
fr_dict_attr_autoload_t rlm_ldap_dict_attr[]
Definition rlm_ldap.c:333
ldap_mod_tmpl_t ** mod
Definition rlm_ldap.c:74
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:1014
char const * attr
Definition rlm_ldap.c:67
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:947
ssize_t expect_password_offset
Definition rlm_ldap.c:210
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:776
static int ldap_xlat_profile_ctx_free(ldap_xlat_profile_ctx_t *to_free)
Definition rlm_ldap.c:1148
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:745
fr_dict_attr_t const * attr_cleartext_password
Definition rlm_ldap.c:325
tmpl_t const * password_tmpl
Definition rlm_ldap.c:59
static unlang_action_t mod_authorize(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
Definition rlm_ldap.c:1930
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:654
fr_value_box_t user_sasl_mech
Definition rlm_ldap.c:60
static unlang_action_t user_modify_start(UNUSED rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Perform async lookup of user DN if required for user modification.
Definition rlm_ldap.c:1998
fr_dict_autoload_t rlm_ldap_dict[]
Definition rlm_ldap.c:319
static int mod_thread_instantiate(module_thread_inst_ctx_t const *mctx)
Initialise thread specific data structure.
Definition rlm_ldap.c:2499
module_rlm_t rlm_ldap
Definition rlm_ldap.c:2859
char const * password
Definition rlm_ldap.c:356
static int autz_ctx_free(ldap_autz_ctx_t *autz_ctx)
Ensure authorization context is properly cleared up.
Definition rlm_ldap.c:1923
ldap_schemes_t
Definition rlm_ldap.c:390
@ LDAP_SCHEME_UNIX
Definition rlm_ldap.c:391
@ LDAP_SCHEME_TCP_SSL
Definition rlm_ldap.c:393
@ LDAP_SCHEME_TCP
Definition rlm_ldap.c:392
fr_token_t op
Definition rlm_ldap.c:68
fr_value_box_t user_base
Definition rlm_ldap.c:72
fr_ldap_map_exp_t expanded
Definition rlm_ldap.c:1129
static unlang_action_t ldap_group_xlat_user_find(UNUSED rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
User object lookup as part of group membership xlat.
Definition rlm_ldap.c:931
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:701
fr_ldap_query_t * query
Definition rlm_ldap.c:372
static unlang_action_t mod_modify(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request)
Modify user's object in LDAP.
Definition rlm_ldap.c:2228
fr_ldap_thread_t * thread
Definition rlm_ldap.c:358
static size_t ldap_uri_scheme_table_len
Definition rlm_ldap.c:401
#define LDAP_URI_SAFE_FOR
This is the common function that actually ends up doing all the URI escaping.
Definition rlm_ldap.c:405
static fr_uri_part_t const ldap_dn_parts[]
Definition rlm_ldap.c:731
static unlang_action_t user_modify_final(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Handle results of user modification.
Definition rlm_ldap.c:2022
static const conf_parser_t module_config[]
Definition rlm_ldap.c:145
#define USER_CALL_ENV_COMMON(_struct)
Definition rlm_ldap.c:186
ldap_usermod_call_env_t * call_env
Definition rlm_ldap.c:367
static unlang_action_t mod_authorize_resume(rlm_rcode_t *p_result, UNUSED int *priority, request_t *request, void *uctx)
Resume function called after each potential yield in LDAP authorization.
Definition rlm_ldap.c:1629
static void mod_authorize_cancel(UNUSED request_t *request, UNUSED fr_signal_t action, void *uctx)
Clear up when cancelling a mod_authorize call.
Definition rlm_ldap.c:1913
fr_value_box_t profile_filter
Filter to use when searching for users.
Definition rlm_ldap.c:80
static int mod_thread_detach(module_thread_inst_ctx_t const *mctx)
Clean up thread specific data structure.
Definition rlm_ldap.c:2481
static int mod_instantiate(module_inst_ctx_t const *mctx)
Instantiate the module.
Definition rlm_ldap.c:2544
fr_ldap_map_exp_t expanded
Definition rlm_ldap.c:386
LDAPURLDesc * ldap_url
Definition rlm_ldap.c:384
static const call_env_parser_t sasl_call_env[]
Definition rlm_ldap.c:89
fr_value_box_t user_sasl_realm
Definition rlm_ldap.c:63
fr_value_box_list_t expanded
Definition rlm_ldap.c:373
static fr_uri_part_t const ldap_uri_parts[]
Definition rlm_ldap.c:719
char const * dn
Definition rlm_ldap.c:355
static xlat_arg_parser_t const ldap_group_xlat_arg[]
Definition rlm_ldap.c:1027
rlm_ldap_t const * inst
Definition rlm_ldap.c:357
Holds state of in progress async authentication.
Definition rlm_ldap.c:354
Holds state of in progress LDAP map.
Definition rlm_ldap.c:382
Parameters to allow ldap_update_section_parse to be reused.
Definition rlm_ldap.c:208
Holds state of in progress ldap user modifications.
Definition rlm_ldap.c:365
Call environment used in the profile xlat.
Definition rlm_ldap.c:79
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
fr_value_box_t user_base
Base DN in which to search for users.
Definition rlm_ldap.h:136
unlang_action_t rlm_ldap_find_user_async(TALLOC_CTX *ctx, 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:159
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
static char const * rlm_find_user_dn_cached(request_t *request)
Definition rlm_ldap.h:246
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:251
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:211
@ GROUP_XLAT_MEMB_ATTR
Definition rlm_ldap.h:212
@ GROUP_XLAT_FIND_USER
Definition rlm_ldap.h:210
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:199
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:218
Call environment used in group membership xlat.
Definition rlm_ldap.h:155
unlang_action_t fr_ldap_sasl_bind_auth_async(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
char const * name
Instance name e.g. user_database.
Definition module.h:336
module_flags_t flags
Flags that control how a module starts up and how a module is called.
Definition module.h:228
CONF_SECTION * conf
Module's instance configuration.
Definition module.h:330
void * data
Module's instance data.
Definition module.h:272
void * boot
Data allocated during the boostrap phase.
Definition module.h:275
void * data
Thread specific instance data.
Definition module.h:353
static module_thread_instance_t * module_thread(module_instance_t const *mi)
Retrieve module/thread specific instance for a module.
Definition module.h:482
#define MODULE_BINDING_TERMINATOR
Terminate a module binding list.
Definition module.h:151
Named methods exported by a module.
Definition module.h:173
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
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:260
@ 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:567
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:145
#define XLAT_ARGS(_list,...)
Populate local variables with value boxes from the input list.
Definition xlat.h:382
#define XLAT_ARG_PARSER_TERMINATOR
Definition xlat.h:169
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:144
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