2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2014 The OpenLDAP Foundation.
5 * Portions Copyright 2001-2003 Pierangelo Masarati.
6 * Portions Copyright 1999-2003 Howard Chu.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by the Howard Chu for inclusion
19 * in OpenLDAP Software and subsequently enhanced by Pierangelo
24 #error "include servers/slapd/back-ldap/back-ldap.h before this file!"
25 #endif /* SLAPD_LDAP_H */
30 #define SLAPD_META_CLIENT_PR 1
32 #include "proto-meta.h"
34 /* String rewrite library */
40 * Set META_BACK_PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
42 #ifndef META_BACK_PRINT_CONNTREE
43 #define META_BACK_PRINT_CONNTREE 0
44 #endif /* !META_BACK_PRINT_CONNTREE */
46 /* from back-ldap.h before rwm removal */
64 struct rewrite_info *rwm_rw;
65 #else /* !ENABLE_REWRITE */
66 /* some time the suffix massaging without librewrite
68 BerVarray rwm_suffix_massage;
69 #endif /* !ENABLE_REWRITE */
70 BerVarray rwm_bva_rewrite;
73 * Attribute/objectClass mapping
75 struct ldapmap rwm_oc;
76 struct ldapmap rwm_at;
77 BerVarray rwm_bva_map;
80 /* Whatever context ldap_back_dn_massage needs... */
81 typedef struct dncookie {
82 struct metatarget_t *target;
94 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
97 extern int ldap_back_conn_cmp( const void *c1, const void *c2);
98 extern int ldap_back_conn_dup( void *c1, void *c2 );
99 extern void ldap_back_conn_free( void *c );
101 /* attributeType/objectClass mapping */
102 int mapping_cmp (const void *, const void *);
103 int mapping_dup (void *, void *);
105 void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
106 int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
107 struct ldapmapping **m, int remap );
108 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
110 #define BACKLDAP_MAP 0
111 #define BACKLDAP_REMAP 1
113 ldap_back_map_filter(
114 struct ldapmap *at_map,
115 struct ldapmap *oc_map,
122 struct ldapmap *at_map,
125 char ***mapped_attrs );
128 ldap_back_filter_map_rewrite(
135 /* suffix massaging by means of librewrite */
136 #ifdef ENABLE_REWRITE
138 suffix_massage_config( struct rewrite_info *info,
142 struct berval *nrnc );
143 #endif /* ENABLE_REWRITE */
145 ldap_back_referral_result_rewrite(
154 ldap_dnattr_result_rewrite(
158 /* (end of) from back-ldap.h before rwm removal */
161 * A metasingleconn_t can be in the following, mutually exclusive states:
164 * - creating META_BACK_FCONN_CREATING
165 * - initialized META_BACK_FCONN_INITED
166 * - binding LDAP_BACK_FCONN_BINDING
167 * - bound/anonymous LDAP_BACK_FCONN_ISBOUND/LDAP_BACK_FCONN_ISANON
169 * possible modifiers are:
171 * - privileged LDAP_BACK_FCONN_ISPRIV
172 * - privileged, TLS LDAP_BACK_FCONN_ISTLS
173 * - subjected to idassert LDAP_BACK_FCONN_ISIDASR
174 * - tainted LDAP_BACK_FCONN_TAINTED
177 #define META_BACK_FCONN_INITED (0x00100000U)
178 #define META_BACK_FCONN_CREATING (0x00200000U)
180 #define META_BACK_CONN_INITED(lc) LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_INITED)
181 #define META_BACK_CONN_INITED_SET(lc) LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_INITED)
182 #define META_BACK_CONN_INITED_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_INITED)
183 #define META_BACK_CONN_INITED_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_INITED, (mlc))
184 #define META_BACK_CONN_CREATING(lc) LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_CREATING)
185 #define META_BACK_CONN_CREATING_SET(lc) LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_CREATING)
186 #define META_BACK_CONN_CREATING_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_CREATING)
187 #define META_BACK_CONN_CREATING_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_CREATING, (mlc))
191 #define META_NOT_CANDIDATE ((ber_tag_t)0x0)
192 #define META_CANDIDATE ((ber_tag_t)0x1)
193 #define META_BINDING ((ber_tag_t)0x2)
194 #define META_RETRYING ((ber_tag_t)0x4)
196 typedef struct metasingleconn_t {
197 #define META_CND_ISSET(rs,f) ( ( (rs)->sr_tag & (f) ) == (f) )
198 #define META_CND_SET(rs,f) ( (rs)->sr_tag |= (f) )
199 #define META_CND_CLEAR(rs,f) ( (rs)->sr_tag &= ~(f) )
201 #define META_CANDIDATE_RESET(rs) ( (rs)->sr_tag = 0 )
202 #define META_IS_CANDIDATE(rs) META_CND_ISSET( (rs), META_CANDIDATE )
203 #define META_CANDIDATE_SET(rs) META_CND_SET( (rs), META_CANDIDATE )
204 #define META_CANDIDATE_CLEAR(rs) META_CND_CLEAR( (rs), META_CANDIDATE )
205 #define META_IS_BINDING(rs) META_CND_ISSET( (rs), META_BINDING )
206 #define META_BINDING_SET(rs) META_CND_SET( (rs), META_BINDING )
207 #define META_BINDING_CLEAR(rs) META_CND_CLEAR( (rs), META_BINDING )
208 #define META_IS_RETRYING(rs) META_CND_ISSET( (rs), META_RETRYING )
209 #define META_RETRYING_SET(rs) META_CND_SET( (rs), META_RETRYING )
210 #define META_RETRYING_CLEAR(rs) META_CND_CLEAR( (rs), META_RETRYING )
214 struct berval msc_bound_ndn;
215 struct berval msc_cred;
216 unsigned msc_mscflags;
217 /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
218 * defined for back-ldap */
219 #define lc_lcflags msc_mscflags
222 typedef struct metaconn_t {
223 ldapconn_base_t lc_base;
224 #define mc_base lc_base
225 #define mc_conn mc_base.lcb_conn
226 #define mc_local_ndn mc_base.lcb_local_ndn
227 #define mc_refcnt mc_base.lcb_refcnt
228 #define mc_create_time mc_base.lcb_create_time
229 #define mc_time mc_base.lcb_time
231 LDAP_TAILQ_ENTRY(metaconn_t) mc_q;
233 /* NOTE: msc_mscflags is used to recycle the #define
234 * in metasingleconn_t */
235 unsigned msc_mscflags;
238 * means that the connection is bound;
239 * of course only one target actually is ...
242 #define META_BOUND_NONE (-1)
243 #define META_BOUND_ALL (-2)
245 struct metainfo_t *mc_info;
247 /* supersedes the connection stuff */
248 metasingleconn_t mc_conns[ 1 ];
249 /* NOTE: mc_conns must be last, because
250 * the required number of conns is malloc'ed
251 * in one block with the metaconn_t structure */
254 typedef enum meta_st_t {
256 META_ST_EXACT = LDAP_SCOPE_BASE,
258 META_ST_SUBTREE = LDAP_SCOPE_SUBTREE,
259 META_ST_SUBORDINATE = LDAP_SCOPE_SUBORDINATE,
260 META_ST_REGEX /* last + 1 */
263 typedef struct metasubtree_t {
266 struct berval msu_dn;
268 struct berval msr_regex_pattern;
272 #define ms_dn ms_un.msu_dn
273 #define ms_regex ms_un.msu_regex.msr_regex
274 #define ms_regex_pattern ms_un.msu_regex.msr_regex_pattern
276 struct metasubtree_t *ms_next;
279 typedef struct metafilter_t {
280 struct metafilter_t *mf_next;
281 struct berval mf_regex_pattern;
285 typedef struct metacommon_t {
288 #define META_RETRY_UNDEFINED (-2)
289 #define META_RETRY_FOREVER (-1)
290 #define META_RETRY_NEVER (0)
291 #define META_RETRY_DEFAULT (10)
294 #define META_BACK_CMN_ISSET(mc,f) ( ( (mc)->mc_flags & (f) ) == (f) )
295 #define META_BACK_CMN_QUARANTINE(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_QUARANTINE )
296 #define META_BACK_CMN_CHASE_REFERRALS(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_CHASE_REFERRALS )
297 #define META_BACK_CMN_NOREFS(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_NOREFS )
298 #define META_BACK_CMN_NOUNDEFFILTER(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_NOUNDEFFILTER )
299 #define META_BACK_CMN_SAVECRED(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_SAVECRED )
300 #define META_BACK_CMN_ST_REQUEST(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_ST_REQUEST )
302 #ifdef SLAPD_META_CLIENT_PR
304 * client-side paged results:
305 * -1: accept unsolicited paged results responses
307 * >0: always request paged results with size == mt_ps
309 #define META_CLIENT_PR_DISABLE (0)
310 #define META_CLIENT_PR_ACCEPT_UNSOLICITED (-1)
312 #endif /* SLAPD_META_CLIENT_PR */
314 slap_retry_info_t mc_quarantine;
315 time_t mc_network_timeout;
316 struct timeval mc_bind_timeout;
317 #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT
318 time_t mc_timeout[ SLAP_OP_LAST ];
321 typedef struct metatarget_t {
323 ldap_pvt_thread_mutex_t mt_uri_mutex;
325 /* TODO: we might want to enable different strategies
326 * for different targets */
327 LDAP_REBIND_PROC *mt_rebind_f;
328 LDAP_URLLIST_PROC *mt_urllist_f;
331 metafilter_t *mt_filter;
332 metasubtree_t *mt_subtree;
333 /* F: subtree-include; T: subtree-exclude */
334 int mt_subtree_exclude;
338 struct berval mt_psuffix; /* pretty suffix */
339 struct berval mt_nsuffix; /* normalized suffix */
341 struct berval mt_binddn;
342 struct berval mt_bindpw;
344 /* we only care about the TLS options here */
345 slap_bindconf mt_tls;
347 slap_idassert_t mt_idassert;
348 #define mt_idassert_mode mt_idassert.si_mode
349 #define mt_idassert_authcID mt_idassert.si_bc.sb_authcId
350 #define mt_idassert_authcDN mt_idassert.si_bc.sb_binddn
351 #define mt_idassert_passwd mt_idassert.si_bc.sb_cred
352 #define mt_idassert_authzID mt_idassert.si_bc.sb_authzId
353 #define mt_idassert_authmethod mt_idassert.si_bc.sb_method
354 #define mt_idassert_sasl_mech mt_idassert.si_bc.sb_saslmech
355 #define mt_idassert_sasl_realm mt_idassert.si_bc.sb_realm
356 #define mt_idassert_secprops mt_idassert.si_bc.sb_secprops
357 #define mt_idassert_tls mt_idassert.si_bc.sb_tls
358 #define mt_idassert_flags mt_idassert.si_flags
359 #define mt_idassert_authz mt_idassert.si_authz
361 struct ldaprwmap mt_rwmap;
363 sig_atomic_t mt_isquarantined;
364 ldap_pvt_thread_mutex_t mt_quarantine_mutex;
367 #define mt_nretries mt_mc.mc_nretries
368 #define mt_flags mt_mc.mc_flags
369 #define mt_version mt_mc.mc_version
370 #define mt_ps mt_mc.mc_ps
371 #define mt_network_timeout mt_mc.mc_network_timeout
372 #define mt_bind_timeout mt_mc.mc_bind_timeout
373 #define mt_timeout mt_mc.mc_timeout
374 #define mt_quarantine mt_mc.mc_quarantine
376 #define META_BACK_TGT_ISSET(mt,f) ( ( (mt)->mt_flags & (f) ) == (f) )
377 #define META_BACK_TGT_ISMASK(mt,m,f) ( ( (mt)->mt_flags & (m) ) == (f) )
379 #define META_BACK_TGT_SAVECRED(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_SAVECRED )
381 #define META_BACK_TGT_USE_TLS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_USE_TLS )
382 #define META_BACK_TGT_PROPAGATE_TLS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_PROPAGATE_TLS )
383 #define META_BACK_TGT_TLS_CRITICAL(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_TLS_CRITICAL )
385 #define META_BACK_TGT_CHASE_REFERRALS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_CHASE_REFERRALS )
387 #define META_BACK_TGT_T_F(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
388 #define META_BACK_TGT_T_F_DISCOVER(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
390 #define META_BACK_TGT_ABANDON(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
391 #define META_BACK_TGT_IGNORE(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
392 #define META_BACK_TGT_CANCEL(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
393 #define META_BACK_TGT_CANCEL_DISCOVER(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
394 #define META_BACK_TGT_QUARANTINE(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_QUARANTINE )
396 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
397 #define META_BACK_TGT_ST_REQUEST(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_REQUEST )
398 #define META_BACK_TGT_ST_RESPONSE(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_RESPONSE )
399 #endif /* SLAP_CONTROL_X_SESSION_TRACKING */
401 #define META_BACK_TGT_NOREFS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOREFS )
402 #define META_BACK_TGT_NOUNDEFFILTER(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOUNDEFFILTER )
404 slap_mask_t mt_rep_flags;
408 typedef struct metadncache_t {
409 ldap_pvt_thread_mutex_t mutex;
412 #define META_DNCACHE_DISABLED (0)
413 #define META_DNCACHE_FOREVER ((time_t)(-1))
414 time_t ttl; /* seconds; 0: no cache, -1: no expiry */
417 typedef struct metacandidates_t {
419 SlapReply *mc_candidates;
423 * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
425 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
427 typedef struct metainfo_t {
429 int mi_defaulttarget;
430 #define META_DEFAULT_TARGET_NONE (-1)
432 #define mi_nretries mi_mc.mc_nretries
433 #define mi_flags mi_mc.mc_flags
434 #define mi_version mi_mc.mc_version
435 #define mi_ps mi_mc.mc_ps
436 #define mi_network_timeout mi_mc.mc_network_timeout
437 #define mi_bind_timeout mi_mc.mc_bind_timeout
438 #define mi_timeout mi_mc.mc_timeout
439 #define mi_quarantine mi_mc.mc_quarantine
441 metatarget_t **mi_targets;
442 metacandidates_t *mi_candidates;
444 LDAP_REBIND_PROC *mi_rebind_f;
445 LDAP_URLLIST_PROC *mi_urllist_f;
447 metadncache_t mi_cache;
449 /* cached connections;
450 * special conns are in tailq rather than in tree */
451 ldap_avl_info_t mi_conninfo;
454 LDAP_TAILQ_HEAD(mc_conn_priv_q, metaconn_t) mic_priv;
455 } mi_conn_priv[ LDAP_BACK_PCONN_LAST ];
456 int mi_conn_priv_max;
458 /* NOTE: quarantine uses the connection mutex */
459 meta_back_quarantine_f mi_quarantine_f;
460 void *mi_quarantine_p;
462 #define li_flags mi_flags
463 /* uses flags as defined in <back-ldap/back-ldap.h> */
464 #define META_BACK_F_ONERR_STOP LDAP_BACK_F_ONERR_STOP
465 #define META_BACK_F_ONERR_REPORT (0x02000000U)
466 #define META_BACK_F_ONERR_MASK (META_BACK_F_ONERR_STOP|META_BACK_F_ONERR_REPORT)
467 #define META_BACK_F_DEFER_ROOTDN_BIND (0x04000000U)
468 #define META_BACK_F_PROXYAUTHZ_ALWAYS (0x08000000U) /* users always proxyauthz */
469 #define META_BACK_F_PROXYAUTHZ_ANON (0x10000000U) /* anonymous always proxyauthz */
470 #define META_BACK_F_PROXYAUTHZ_NOANON (0x20000000U) /* anonymous remains anonymous */
472 #define META_BACK_ONERR_STOP(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_STOP )
473 #define META_BACK_ONERR_REPORT(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_REPORT )
474 #define META_BACK_ONERR_CONTINUE(mi) ( !LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_MASK ) )
476 #define META_BACK_DEFER_ROOTDN_BIND(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_DEFER_ROOTDN_BIND )
477 #define META_BACK_PROXYAUTHZ_ALWAYS(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ALWAYS )
478 #define META_BACK_PROXYAUTHZ_ANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ANON )
479 #define META_BACK_PROXYAUTHZ_NOANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_NOANON )
481 #define META_BACK_QUARANTINE(mi) LDAP_BACK_ISSET( (mi), LDAP_BACK_F_QUARANTINE )
484 time_t mi_idle_timeout;
487 ldap_extra_t *mi_ldap_extra;
491 typedef enum meta_op_type {
492 META_OP_ALLOW_MULTIPLE = 0,
493 META_OP_REQUIRE_SINGLE,
498 meta_back_candidates_get( Operation *op );
505 ldap_back_send_t sendok );
508 meta_back_release_conn_lock(
512 #define meta_back_release_conn(mi, mc) meta_back_release_conn_lock( (mi), (mc), 1 )
520 ldap_back_send_t sendok );
526 #if META_BACK_PRINT_CONNTREE > 0
528 meta_back_print_conntree(
534 meta_back_init_one_conn(
540 ldap_back_send_t sendok,
544 meta_back_quarantine(
554 ldap_back_send_t sendok );
557 meta_back_single_dobind(
562 ldap_back_send_t sendok,
567 meta_back_proxy_authz_cred(
572 ldap_back_send_t sendok,
573 struct berval *binddn,
574 struct berval *bindcred,
584 ldap_back_send_t sendok );
594 ldap_back_send_t sendok );
597 meta_back_controls_add(
602 LDAPControl ***pctrls );
605 back_meta_LTX_init_module(
615 meta_back_conndn_cmp(
620 meta_back_conndn_dup(
628 meta_back_is_candidate(
634 meta_back_select_unique_candidate(
636 struct berval *ndn );
639 meta_clear_unused_candidates(
644 meta_clear_one_candidate(
650 * Dn cache stuff (experimental)
662 #define META_TARGET_NONE (-1)
663 #define META_TARGET_MULTIPLE (-2)
665 meta_dncache_get_target(
666 metadncache_t *cache,
667 struct berval *ndn );
670 meta_dncache_update_entry(
671 metadncache_t *cache,
676 meta_dncache_delete_entry(
677 metadncache_t *cache,
678 struct berval *ndn );
681 meta_dncache_free( void *entry );
684 meta_back_map_free( struct ldapmap *lm );
687 meta_subtree_destroy( metasubtree_t *ms );
690 meta_filter_destroy( metafilter_t *mf );
693 meta_target_finish( metainfo_t *mi, metatarget_t *mt,
694 const char *log, char *msg, size_t msize
697 extern LDAP_REBIND_PROC meta_back_default_rebind;
698 extern LDAP_URLLIST_PROC meta_back_default_urllist;
702 #endif /* SLAPD_META_H */