2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2006 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 #include "proto-meta.h"
32 /* String rewrite library */
39 /* from back-ldap.h before rwm removal */
57 struct rewrite_info *rwm_rw;
58 #else /* !ENABLE_REWRITE */
59 /* some time the suffix massaging without librewrite
61 BerVarray rwm_suffix_massage;
62 #endif /* !ENABLE_REWRITE */
65 * Attribute/objectClass mapping
67 struct ldapmap rwm_oc;
68 struct ldapmap rwm_at;
71 /* Whatever context ldap_back_dn_massage needs... */
72 typedef struct dncookie {
73 struct metatarget_t *target;
85 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
88 extern int ldap_back_conn_cmp( const void *c1, const void *c2);
89 extern int ldap_back_conn_dup( void *c1, void *c2 );
90 extern void ldap_back_conn_free( void *c );
92 /* attributeType/objectClass mapping */
93 int mapping_cmp (const void *, const void *);
94 int mapping_dup (void *, void *);
96 void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
97 int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
98 struct ldapmapping **m, int remap );
99 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
101 #define BACKLDAP_MAP 0
102 #define BACKLDAP_REMAP 1
104 ldap_back_map_filter(
105 struct ldapmap *at_map,
106 struct ldapmap *oc_map,
112 struct ldapmap *at_map,
115 char ***mapped_attrs );
117 extern int ldap_back_map_config(
118 struct ldapmap *oc_map,
119 struct ldapmap *at_map,
126 ldap_back_filter_map_rewrite(
132 /* suffix massaging by means of librewrite */
133 #ifdef ENABLE_REWRITE
135 suffix_massage_config( struct rewrite_info *info,
139 struct berval *nrnc );
140 #endif /* ENABLE_REWRITE */
142 ldap_back_referral_result_rewrite(
150 ldap_dnattr_result_rewrite(
154 /* (end of) from back-ldap.h before rwm removal */
158 typedef struct metasingleconn_t {
160 #define META_NOT_CANDIDATE ((ber_tag_t)0x0)
161 #define META_CANDIDATE ((ber_tag_t)0x1)
162 #define META_BINDING ((ber_tag_t)0x2)
164 #define META_CND_ISSET(rs,f) ( ( (rs)->sr_tag & (f) ) == (f) )
165 #define META_CND_SET(rs,f) ( (rs)->sr_tag |= (f) )
166 #define META_CND_CLEAR(rs,f) ( (rs)->sr_tag &= ~(f) )
168 #define META_CANDIDATE_RESET(rs) ( (rs)->sr_tag = 0 )
169 #define META_IS_CANDIDATE(rs) META_CND_ISSET( (rs), META_CANDIDATE )
170 #define META_CANDIDATE_SET(rs) META_CND_SET( (rs), META_CANDIDATE )
171 #define META_CANDIDATE_CLEAR(rs) META_CND_CLEAR( (rs), META_CANDIDATE )
172 #define META_IS_BINDING(rs) META_CND_ISSET( (rs), META_BINDING )
173 #define META_BINDING_SET(rs) META_CND_SET( (rs), META_BINDING )
174 #define META_BINDING_CLEAR(rs) META_CND_CLEAR( (rs), META_BINDING )
177 struct berval msc_bound_ndn;
178 struct berval msc_cred;
179 unsigned msc_mscflags;
180 /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
181 * defined for back-ldap */
182 #define lc_lcflags msc_mscflags
184 struct metainfo_t *msc_info;
187 typedef struct metaconn_t {
188 struct slap_conn *mc_conn;
191 time_t mc_create_time;
194 struct berval mc_local_ndn;
195 /* NOTE: msc_mscflags is used to recycle the #define
196 * in metasingleconn_t */
197 unsigned msc_mscflags;
200 * means that the connection is bound;
201 * of course only one target actually is ...
204 #define META_BOUND_NONE (-1)
205 #define META_BOUND_ALL (-2)
206 /* supersedes the connection stuff */
207 metasingleconn_t mc_conns[ 1 ];
208 /* NOTE: mc_conns must be last, because
209 * the required number of conns is malloc'ed
210 * in one block with the metaconn_t structure */
213 typedef struct metatarget_t {
215 ldap_pvt_thread_mutex_t mt_uri_mutex;
217 /* TODO: we might want to enable different strategies
218 * for different targets */
219 LDAP_REBIND_PROC *mt_rebind_f;
220 LDAP_URLLIST_PROC *mt_urllist_f;
223 BerVarray mt_subtree_exclude;
226 struct berval mt_psuffix; /* pretty suffix */
227 struct berval mt_nsuffix; /* normalized suffix */
229 struct berval mt_binddn;
230 struct berval mt_bindpw;
232 struct berval mt_pseudorootdn;
233 struct berval mt_pseudorootpw;
236 #define META_RETRY_UNDEFINED (-2)
237 #define META_RETRY_FOREVER (-1)
238 #define META_RETRY_NEVER (0)
239 #define META_RETRY_DEFAULT (3)
241 struct ldaprwmap mt_rwmap;
243 sig_atomic_t mt_isquarantined;
244 slap_retry_info_t mt_quarantine;
245 ldap_pvt_thread_mutex_t mt_quarantine_mutex;
246 #define META_BACK_TGT_QUARANTINE(mt) ( (mt)->mt_quarantine.ri_num != NULL )
249 #define META_BACK_TGT_ISSET(mt,f) ( ( (mt)->mt_flags & (f) ) == (f) )
250 #define META_BACK_TGT_ISMASK(mt,m,f) ( ( (mt)->mt_flags & (m) ) == (f) )
252 #define META_BACK_TGT_T_F(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
253 #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 )
255 #define META_BACK_TGT_ABANDON(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
256 #define META_BACK_TGT_IGNORE(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
257 #define META_BACK_TGT_CANCEL(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
258 #define META_BACK_TGT_CANCEL_DISCOVER(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
261 time_t mt_network_timeout;
262 struct timeval mt_bind_timeout;
263 #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT
264 time_t mt_timeout[ LDAP_BACK_OP_LAST ];
267 typedef struct metadncache_t {
268 ldap_pvt_thread_mutex_t mutex;
271 #define META_DNCACHE_DISABLED (0)
272 #define META_DNCACHE_FOREVER ((time_t)(-1))
273 time_t ttl; /* seconds; 0: no cache, -1: no expiry */
276 typedef struct metacandidates_t {
278 SlapReply *mc_candidates;
282 * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
284 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
286 typedef struct metainfo_t {
288 int mi_defaulttarget;
289 #define META_DEFAULT_TARGET_NONE (-1)
292 metatarget_t **mi_targets;
293 metacandidates_t *mi_candidates;
295 LDAP_REBIND_PROC *mi_rebind_f;
296 LDAP_URLLIST_PROC *mi_urllist_f;
298 metadncache_t mi_cache;
300 ldap_avl_info_t mi_conninfo;
302 /* NOTE: quarantine uses the connection mutex */
303 slap_retry_info_t mi_quarantine;
305 #define META_BACK_QUARANTINE(mi) ( (mi)->mi_quarantine.ri_num != NULL )
306 meta_back_quarantine_f mi_quarantine_f;
307 void *mi_quarantine_p;
310 #define li_flags mi_flags
311 /* uses flags as defined in <back-ldap/back-ldap.h> */
312 #define META_BACK_F_ONERR_STOP (0x00010000U)
313 #define META_BACK_F_DEFER_ROOTDN_BIND (0x00020000U)
315 #define META_BACK_ONERR_STOP(mi) ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
316 #define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
318 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
321 time_t mi_network_timeout;
323 time_t mi_idle_timeout;
324 struct timeval mi_bind_timeout;
325 time_t mi_timeout[ LDAP_BACK_OP_LAST ];
328 typedef enum meta_op_type {
329 META_OP_ALLOW_MULTIPLE = 0,
330 META_OP_REQUIRE_SINGLE,
335 meta_back_candidates_get( Operation *op );
342 ldap_back_send_t sendok );
345 meta_back_release_conn_lock(
349 #define meta_back_release_conn(op, mc) meta_back_release_conn_lock( (op), (mc), 1 )
357 ldap_back_send_t sendok );
364 meta_back_init_one_conn(
370 ldap_back_send_t sendok );
373 meta_back_quarantine(
379 meta_back_single_bind(
391 ldap_back_send_t sendok );
394 meta_back_single_dobind(
399 ldap_back_send_t sendok,
410 ldap_back_send_t sendok );
420 back_meta_LTX_init_module(
430 meta_back_conndn_cmp(
435 meta_back_conndn_dup(
443 meta_back_is_candidate(
449 meta_back_select_unique_candidate(
451 struct berval *ndn );
454 meta_clear_unused_candidates(
459 meta_clear_one_candidate(
460 metasingleconn_t *mc );
463 meta_clear_candidates(
468 * Dn cache stuff (experimental)
480 #define META_TARGET_NONE (-1)
481 #define META_TARGET_MULTIPLE (-2)
483 meta_dncache_get_target(
484 metadncache_t *cache,
485 struct berval *ndn );
488 meta_dncache_update_entry(
489 metadncache_t *cache,
494 meta_dncache_delete_entry(
495 metadncache_t *cache,
496 struct berval *ndn );
499 meta_dncache_free( void *entry );
501 extern LDAP_REBIND_PROC meta_back_default_rebind;
502 extern LDAP_URLLIST_PROC meta_back_default_urllist;
506 #endif /* SLAPD_META_H */