2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2011 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 */
31 #define SLAPD_META_CLIENT_PR 1
32 #endif /* LDAP_DEVEL */
34 #include "proto-meta.h"
36 /* String rewrite library */
42 * Set META_BACK_PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
44 #ifndef META_BACK_PRINT_CONNTREE
45 #define META_BACK_PRINT_CONNTREE 0
46 #endif /* !META_BACK_PRINT_CONNTREE */
48 /* from back-ldap.h before rwm removal */
66 struct rewrite_info *rwm_rw;
67 #else /* !ENABLE_REWRITE */
68 /* some time the suffix massaging without librewrite
70 BerVarray rwm_suffix_massage;
71 #endif /* !ENABLE_REWRITE */
74 * Attribute/objectClass mapping
76 struct ldapmap rwm_oc;
77 struct ldapmap rwm_at;
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 );
127 extern int ldap_back_map_config(
128 struct ldapmap *oc_map,
129 struct ldapmap *at_map,
136 ldap_back_filter_map_rewrite(
143 /* suffix massaging by means of librewrite */
144 #ifdef ENABLE_REWRITE
146 suffix_massage_config( struct rewrite_info *info,
150 struct berval *nrnc );
151 #endif /* ENABLE_REWRITE */
153 ldap_back_referral_result_rewrite(
162 ldap_dnattr_result_rewrite(
166 /* (end of) from back-ldap.h before rwm removal */
169 * A metasingleconn_t can be in the following, mutually exclusive states:
172 * - creating META_BACK_FCONN_CREATING
173 * - initialized META_BACK_FCONN_INITED
174 * - binding LDAP_BACK_FCONN_BINDING
175 * - bound/anonymous LDAP_BACK_FCONN_ISBOUND/LDAP_BACK_FCONN_ISANON
177 * possible modifiers are:
179 * - privileged LDAP_BACK_FCONN_ISPRIV
180 * - privileged, TLS LDAP_BACK_FCONN_ISTLS
181 * - subjected to idassert LDAP_BACK_FCONN_ISIDASR
182 * - tainted LDAP_BACK_FCONN_TAINTED
185 #define META_BACK_FCONN_INITED (0x00100000U)
186 #define META_BACK_FCONN_CREATING (0x00200000U)
188 #define META_BACK_CONN_INITED(lc) LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_INITED)
189 #define META_BACK_CONN_INITED_SET(lc) LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_INITED)
190 #define META_BACK_CONN_INITED_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_INITED)
191 #define META_BACK_CONN_INITED_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_INITED, (mlc))
192 #define META_BACK_CONN_CREATING(lc) LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_CREATING)
193 #define META_BACK_CONN_CREATING_SET(lc) LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_CREATING)
194 #define META_BACK_CONN_CREATING_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_CREATING)
195 #define META_BACK_CONN_CREATING_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_CREATING, (mlc))
199 #define META_NOT_CANDIDATE ((ber_tag_t)0x0)
200 #define META_CANDIDATE ((ber_tag_t)0x1)
201 #define META_BINDING ((ber_tag_t)0x2)
202 #define META_RETRYING ((ber_tag_t)0x4)
204 typedef struct metasingleconn_t {
205 #define META_CND_ISSET(rs,f) ( ( (rs)->sr_tag & (f) ) == (f) )
206 #define META_CND_SET(rs,f) ( (rs)->sr_tag |= (f) )
207 #define META_CND_CLEAR(rs,f) ( (rs)->sr_tag &= ~(f) )
209 #define META_CANDIDATE_RESET(rs) ( (rs)->sr_tag = 0 )
210 #define META_IS_CANDIDATE(rs) META_CND_ISSET( (rs), META_CANDIDATE )
211 #define META_CANDIDATE_SET(rs) META_CND_SET( (rs), META_CANDIDATE )
212 #define META_CANDIDATE_CLEAR(rs) META_CND_CLEAR( (rs), META_CANDIDATE )
213 #define META_IS_BINDING(rs) META_CND_ISSET( (rs), META_BINDING )
214 #define META_BINDING_SET(rs) META_CND_SET( (rs), META_BINDING )
215 #define META_BINDING_CLEAR(rs) META_CND_CLEAR( (rs), META_BINDING )
216 #define META_IS_RETRYING(rs) META_CND_ISSET( (rs), META_RETRYING )
217 #define META_RETRYING_SET(rs) META_CND_SET( (rs), META_RETRYING )
218 #define META_RETRYING_CLEAR(rs) META_CND_CLEAR( (rs), META_RETRYING )
222 struct berval msc_bound_ndn;
223 struct berval msc_cred;
224 unsigned msc_mscflags;
225 /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
226 * defined for back-ldap */
227 #define lc_lcflags msc_mscflags
230 typedef struct metaconn_t {
231 ldapconn_base_t lc_base;
232 #define mc_base lc_base
233 #define mc_conn mc_base.lcb_conn
234 #define mc_local_ndn mc_base.lcb_local_ndn
235 #define mc_refcnt mc_base.lcb_refcnt
236 #define mc_create_time mc_base.lcb_create_time
237 #define mc_time mc_base.lcb_time
239 LDAP_TAILQ_ENTRY(metaconn_t) mc_q;
241 /* NOTE: msc_mscflags is used to recycle the #define
242 * in metasingleconn_t */
243 unsigned msc_mscflags;
246 * means that the connection is bound;
247 * of course only one target actually is ...
250 #define META_BOUND_NONE (-1)
251 #define META_BOUND_ALL (-2)
253 struct metainfo_t *mc_info;
255 /* supersedes the connection stuff */
256 metasingleconn_t mc_conns[ 1 ];
257 /* NOTE: mc_conns must be last, because
258 * the required number of conns is malloc'ed
259 * in one block with the metaconn_t structure */
262 typedef enum meta_st_t {
264 META_ST_EXACT = LDAP_SCOPE_BASE,
266 META_ST_SUBTREE = LDAP_SCOPE_SUBTREE,
267 META_ST_SUBORDINATE = LDAP_SCOPE_SUBORDINATE,
268 META_ST_REGEX /* last + 1 */
271 typedef struct metasubtree_t {
274 struct berval msu_dn;
277 char *msr_regex_pattern;
280 #define ms_dn ms_un.msu_dn
281 #define ms_regex ms_un.msu_regex.msr_regex
282 #define ms_regex_pattern ms_un.msu_regex.msr_regex_pattern
284 struct metasubtree_t *ms_next;
287 typedef struct metatarget_t {
289 ldap_pvt_thread_mutex_t mt_uri_mutex;
291 /* TODO: we might want to enable different strategies
292 * for different targets */
293 LDAP_REBIND_PROC *mt_rebind_f;
294 LDAP_URLLIST_PROC *mt_urllist_f;
297 metasubtree_t *mt_subtree;
298 /* F: subtree-include; T: subtree-exclude */
299 int mt_subtree_exclude;
303 struct berval mt_psuffix; /* pretty suffix */
304 struct berval mt_nsuffix; /* normalized suffix */
306 struct berval mt_binddn;
307 struct berval mt_bindpw;
309 /* we only care about the TLS options here */
310 slap_bindconf mt_tls;
312 slap_idassert_t mt_idassert;
313 #define mt_idassert_mode mt_idassert.si_mode
314 #define mt_idassert_authcID mt_idassert.si_bc.sb_authcId
315 #define mt_idassert_authcDN mt_idassert.si_bc.sb_binddn
316 #define mt_idassert_passwd mt_idassert.si_bc.sb_cred
317 #define mt_idassert_authzID mt_idassert.si_bc.sb_authzId
318 #define mt_idassert_authmethod mt_idassert.si_bc.sb_method
319 #define mt_idassert_sasl_mech mt_idassert.si_bc.sb_saslmech
320 #define mt_idassert_sasl_realm mt_idassert.si_bc.sb_realm
321 #define mt_idassert_secprops mt_idassert.si_bc.sb_secprops
322 #define mt_idassert_tls mt_idassert.si_bc.sb_tls
323 #define mt_idassert_flags mt_idassert.si_flags
324 #define mt_idassert_authz mt_idassert.si_authz
327 #define META_RETRY_UNDEFINED (-2)
328 #define META_RETRY_FOREVER (-1)
329 #define META_RETRY_NEVER (0)
330 #define META_RETRY_DEFAULT (10)
332 struct ldaprwmap mt_rwmap;
334 sig_atomic_t mt_isquarantined;
335 slap_retry_info_t mt_quarantine;
336 ldap_pvt_thread_mutex_t mt_quarantine_mutex;
339 #define META_BACK_TGT_ISSET(mt,f) ( ( (mt)->mt_flags & (f) ) == (f) )
340 #define META_BACK_TGT_ISMASK(mt,m,f) ( ( (mt)->mt_flags & (m) ) == (f) )
342 #define META_BACK_TGT_SAVECRED(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_SAVECRED )
344 #define META_BACK_TGT_USE_TLS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_USE_TLS )
345 #define META_BACK_TGT_PROPAGATE_TLS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_PROPAGATE_TLS )
346 #define META_BACK_TGT_TLS_CRITICAL(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_TLS_CRITICAL )
348 #define META_BACK_TGT_CHASE_REFERRALS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_CHASE_REFERRALS )
350 #define META_BACK_TGT_T_F(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
351 #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 )
353 #define META_BACK_TGT_ABANDON(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
354 #define META_BACK_TGT_IGNORE(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
355 #define META_BACK_TGT_CANCEL(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
356 #define META_BACK_TGT_CANCEL_DISCOVER(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
357 #define META_BACK_TGT_QUARANTINE(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_QUARANTINE )
359 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
360 #define META_BACK_TGT_ST_REQUEST(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_REQUEST )
361 #define META_BACK_TGT_ST_RESPONSE(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_RESPONSE )
362 #endif /* SLAP_CONTROL_X_SESSION_TRACKING */
364 #define META_BACK_TGT_NOREFS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOREFS )
365 #define META_BACK_TGT_NOUNDEFFILTER(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOUNDEFFILTER )
367 slap_mask_t mt_rep_flags;
371 #ifdef SLAPD_META_CLIENT_PR
373 * client-side paged results:
374 * -1: accept unsolicited paged results responses
376 * >0: always request paged results with size == mt_ps
378 #define META_CLIENT_PR_DISABLE (0)
379 #define META_CLIENT_PR_ACCEPT_UNSOLICITED (-1)
381 #endif /* SLAPD_META_CLIENT_PR */
383 time_t mt_network_timeout;
384 struct timeval mt_bind_timeout;
385 #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT
386 time_t mt_timeout[ SLAP_OP_LAST ];
389 typedef struct metadncache_t {
390 ldap_pvt_thread_mutex_t mutex;
393 #define META_DNCACHE_DISABLED (0)
394 #define META_DNCACHE_FOREVER ((time_t)(-1))
395 time_t ttl; /* seconds; 0: no cache, -1: no expiry */
398 typedef struct metacandidates_t {
400 SlapReply *mc_candidates;
404 * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
406 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
408 typedef struct metainfo_t {
410 int mi_defaulttarget;
411 #define META_DEFAULT_TARGET_NONE (-1)
414 metatarget_t **mi_targets;
415 metacandidates_t *mi_candidates;
417 LDAP_REBIND_PROC *mi_rebind_f;
418 LDAP_URLLIST_PROC *mi_urllist_f;
420 metadncache_t mi_cache;
422 /* cached connections;
423 * special conns are in tailq rather than in tree */
424 ldap_avl_info_t mi_conninfo;
427 LDAP_TAILQ_HEAD(mc_conn_priv_q, metaconn_t) mic_priv;
428 } mi_conn_priv[ LDAP_BACK_PCONN_LAST ];
429 int mi_conn_priv_max;
431 /* NOTE: quarantine uses the connection mutex */
432 slap_retry_info_t mi_quarantine;
433 meta_back_quarantine_f mi_quarantine_f;
434 void *mi_quarantine_p;
437 #define li_flags mi_flags
438 /* uses flags as defined in <back-ldap/back-ldap.h> */
439 #define META_BACK_F_ONERR_STOP (0x01000000U)
440 #define META_BACK_F_ONERR_REPORT (0x02000000U)
441 #define META_BACK_F_ONERR_MASK (META_BACK_F_ONERR_STOP|META_BACK_F_ONERR_REPORT)
442 #define META_BACK_F_DEFER_ROOTDN_BIND (0x04000000U)
443 #define META_BACK_F_PROXYAUTHZ_ALWAYS (0x08000000U) /* users always proxyauthz */
444 #define META_BACK_F_PROXYAUTHZ_ANON (0x10000000U) /* anonymous always proxyauthz */
445 #define META_BACK_F_PROXYAUTHZ_NOANON (0x20000000U) /* anonymous remains anonymous */
447 #define META_BACK_ONERR_STOP(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_STOP )
448 #define META_BACK_ONERR_REPORT(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_REPORT )
449 #define META_BACK_ONERR_CONTINUE(mi) ( !LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_MASK ) )
451 #define META_BACK_DEFER_ROOTDN_BIND(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_DEFER_ROOTDN_BIND )
452 #define META_BACK_PROXYAUTHZ_ALWAYS(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ALWAYS )
453 #define META_BACK_PROXYAUTHZ_ANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ANON )
454 #define META_BACK_PROXYAUTHZ_NOANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_NOANON )
456 #define META_BACK_QUARANTINE(mi) LDAP_BACK_ISSET( (mi), LDAP_BACK_F_QUARANTINE )
460 #ifdef SLAPD_META_CLIENT_PR
462 #endif /* SLAPD_META_CLIENT_PR */
465 time_t mi_network_timeout;
467 time_t mi_idle_timeout;
468 struct timeval mi_bind_timeout;
469 time_t mi_timeout[ SLAP_OP_LAST ];
471 ldap_extra_t *mi_ldap_extra;
475 typedef enum meta_op_type {
476 META_OP_ALLOW_MULTIPLE = 0,
477 META_OP_REQUIRE_SINGLE,
482 meta_back_candidates_get( Operation *op );
489 ldap_back_send_t sendok );
492 meta_back_release_conn_lock(
496 #define meta_back_release_conn(mi, mc) meta_back_release_conn_lock( (mi), (mc), 1 )
504 ldap_back_send_t sendok );
510 #if META_BACK_PRINT_CONNTREE > 0
512 meta_back_print_conntree(
518 meta_back_init_one_conn(
524 ldap_back_send_t sendok,
528 meta_back_quarantine(
538 ldap_back_send_t sendok );
541 meta_back_single_dobind(
546 ldap_back_send_t sendok,
551 meta_back_proxy_authz_cred(
556 ldap_back_send_t sendok,
557 struct berval *binddn,
558 struct berval *bindcred,
568 ldap_back_send_t sendok );
578 ldap_back_send_t sendok );
581 meta_back_controls_add(
586 LDAPControl ***pctrls );
589 back_meta_LTX_init_module(
599 meta_back_conndn_cmp(
604 meta_back_conndn_dup(
612 meta_back_is_candidate(
618 meta_back_select_unique_candidate(
620 struct berval *ndn );
623 meta_clear_unused_candidates(
628 meta_clear_one_candidate(
634 * Dn cache stuff (experimental)
646 #define META_TARGET_NONE (-1)
647 #define META_TARGET_MULTIPLE (-2)
649 meta_dncache_get_target(
650 metadncache_t *cache,
651 struct berval *ndn );
654 meta_dncache_update_entry(
655 metadncache_t *cache,
660 meta_dncache_delete_entry(
661 metadncache_t *cache,
662 struct berval *ndn );
665 meta_dncache_free( void *entry );
668 meta_subtree_destroy( metasubtree_t *ms );
670 extern LDAP_REBIND_PROC meta_back_default_rebind;
671 extern LDAP_URLLIST_PROC meta_back_default_urllist;
675 #endif /* SLAPD_META_H */