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 )
178 struct berval msc_bound_ndn;
179 struct berval msc_cred;
180 unsigned msc_mscflags;
181 /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
182 * defined for back-ldap */
183 #define lc_lcflags msc_mscflags
185 struct metainfo_t *msc_info;
188 typedef struct metaconn_t {
189 struct slap_conn *mc_conn;
192 time_t mc_create_time;
195 struct berval mc_local_ndn;
196 /* NOTE: msc_mscflags is used to recycle the #define
197 * in metasingleconn_t */
198 unsigned msc_mscflags;
201 * means that the connection is bound;
202 * of course only one target actually is ...
205 #define META_BOUND_NONE (-1)
206 #define META_BOUND_ALL (-2)
207 /* supersedes the connection stuff */
208 metasingleconn_t mc_conns[ 1 ];
209 /* NOTE: mc_conns must be last, because
210 * the required number of conns is malloc'ed
211 * in one block with the metaconn_t structure */
214 typedef struct metatarget_t {
216 ldap_pvt_thread_mutex_t mt_uri_mutex;
218 /* TODO: we might want to enable different strategies
219 * for different targets */
220 LDAP_REBIND_PROC *mt_rebind_f;
221 LDAP_URLLIST_PROC *mt_urllist_f;
224 BerVarray mt_subtree_exclude;
227 struct berval mt_psuffix; /* pretty suffix */
228 struct berval mt_nsuffix; /* normalized suffix */
230 struct berval mt_binddn;
231 struct berval mt_bindpw;
233 slap_idassert_t mt_idassert;
234 #define mt_idassert_mode mt_idassert.si_mode
235 #define mt_idassert_authcID mt_idassert.si_bc.sb_authcId
236 #define mt_idassert_authcDN mt_idassert.si_bc.sb_binddn
237 #define mt_idassert_passwd mt_idassert.si_bc.sb_cred
238 #define mt_idassert_authzID mt_idassert.si_bc.sb_authzId
239 #define mt_idassert_authmethod mt_idassert.si_bc.sb_method
240 #define mt_idassert_sasl_mech mt_idassert.si_bc.sb_saslmech
241 #define mt_idassert_sasl_realm mt_idassert.si_bc.sb_realm
242 #define mt_idassert_secprops mt_idassert.si_bc.sb_secprops
243 #define mt_idassert_tls mt_idassert.si_bc.sb_tls
244 #define mt_idassert_flags mt_idassert.si_flags
245 #define mt_idassert_authz mt_idassert.si_authz
248 #define META_RETRY_UNDEFINED (-2)
249 #define META_RETRY_FOREVER (-1)
250 #define META_RETRY_NEVER (0)
251 #define META_RETRY_DEFAULT (10)
253 struct ldaprwmap mt_rwmap;
255 sig_atomic_t mt_isquarantined;
256 slap_retry_info_t mt_quarantine;
257 ldap_pvt_thread_mutex_t mt_quarantine_mutex;
258 #define META_BACK_TGT_QUARANTINE(mt) ( (mt)->mt_quarantine.ri_num != NULL )
261 #define META_BACK_TGT_ISSET(mt,f) ( ( (mt)->mt_flags & (f) ) == (f) )
262 #define META_BACK_TGT_ISMASK(mt,m,f) ( ( (mt)->mt_flags & (m) ) == (f) )
264 #define META_BACK_TGT_T_F(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
265 #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 )
267 #define META_BACK_TGT_ABANDON(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
268 #define META_BACK_TGT_IGNORE(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
269 #define META_BACK_TGT_CANCEL(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
270 #define META_BACK_TGT_CANCEL_DISCOVER(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
273 time_t mt_network_timeout;
274 struct timeval mt_bind_timeout;
275 #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT
276 time_t mt_timeout[ LDAP_BACK_OP_LAST ];
279 typedef struct metadncache_t {
280 ldap_pvt_thread_mutex_t mutex;
283 #define META_DNCACHE_DISABLED (0)
284 #define META_DNCACHE_FOREVER ((time_t)(-1))
285 time_t ttl; /* seconds; 0: no cache, -1: no expiry */
288 typedef struct metacandidates_t {
290 SlapReply *mc_candidates;
294 * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over
296 typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * );
298 typedef struct metainfo_t {
300 int mi_defaulttarget;
301 #define META_DEFAULT_TARGET_NONE (-1)
304 metatarget_t **mi_targets;
305 metacandidates_t *mi_candidates;
307 LDAP_REBIND_PROC *mi_rebind_f;
308 LDAP_URLLIST_PROC *mi_urllist_f;
310 metadncache_t mi_cache;
312 ldap_avl_info_t mi_conninfo;
314 /* NOTE: quarantine uses the connection mutex */
315 slap_retry_info_t mi_quarantine;
317 #define META_BACK_QUARANTINE(mi) ( (mi)->mi_quarantine.ri_num != NULL )
318 meta_back_quarantine_f mi_quarantine_f;
319 void *mi_quarantine_p;
322 #define li_flags mi_flags
323 /* uses flags as defined in <back-ldap/back-ldap.h> */
324 #define META_BACK_F_ONERR_STOP (0x00010000U)
325 #define META_BACK_F_DEFER_ROOTDN_BIND (0x00020000U)
327 #define META_BACK_ONERR_STOP(mi) ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
328 #define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
330 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
333 time_t mi_network_timeout;
335 time_t mi_idle_timeout;
336 struct timeval mi_bind_timeout;
337 time_t mi_timeout[ LDAP_BACK_OP_LAST ];
340 typedef enum meta_op_type {
341 META_OP_ALLOW_MULTIPLE = 0,
342 META_OP_REQUIRE_SINGLE,
347 meta_back_candidates_get( Operation *op );
354 ldap_back_send_t sendok );
357 meta_back_release_conn_lock(
361 #define meta_back_release_conn(op, mc) meta_back_release_conn_lock( (op), (mc), 1 )
369 ldap_back_send_t sendok );
376 meta_back_init_one_conn(
382 ldap_back_send_t sendok );
385 meta_back_quarantine(
395 ldap_back_send_t sendok );
398 meta_back_single_dobind(
403 ldap_back_send_t sendok,
408 meta_back_proxy_authz_cred(
413 ldap_back_send_t sendok,
414 struct berval *binddn,
415 struct berval *bindcred,
425 ldap_back_send_t sendok );
435 ldap_back_send_t sendok );
438 back_meta_LTX_init_module(
448 meta_back_conndn_cmp(
453 meta_back_conndn_dup(
461 meta_back_is_candidate(
467 meta_back_select_unique_candidate(
469 struct berval *ndn );
472 meta_clear_unused_candidates(
477 meta_clear_one_candidate(
478 metasingleconn_t *mc );
481 meta_clear_candidates(
486 * Dn cache stuff (experimental)
498 #define META_TARGET_NONE (-1)
499 #define META_TARGET_MULTIPLE (-2)
501 meta_dncache_get_target(
502 metadncache_t *cache,
503 struct berval *ndn );
506 meta_dncache_update_entry(
507 metadncache_t *cache,
512 meta_dncache_delete_entry(
513 metadncache_t *cache,
514 struct berval *ndn );
517 meta_dncache_free( void *entry );
519 extern LDAP_REBIND_PROC meta_back_default_rebind;
520 extern LDAP_URLLIST_PROC meta_back_default_urllist;
524 #endif /* SLAPD_META_H */