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)0)
161 #define META_CANDIDATE ((ber_tag_t)1)
164 struct berval msc_bound_ndn;
165 struct berval msc_cred;
166 unsigned msc_mscflags;
167 /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
168 * defined for back-ldap */
169 #define lc_lcflags msc_mscflags
171 struct metainfo_t *msc_info;
174 typedef struct metaconn_t {
175 struct slap_conn *mc_conn;
178 time_t mc_create_time;
181 struct berval mc_local_ndn;
182 /* NOTE: msc_mscflags is used to recycle the #define
183 * in metasingleconn_t */
184 unsigned msc_mscflags;
187 * means that the connection is bound;
188 * of course only one target actually is ...
191 #define META_BOUND_NONE (-1)
192 #define META_BOUND_ALL (-2)
193 /* supersedes the connection stuff */
194 metasingleconn_t mc_conns[ 1 ];
195 /* NOTE: mc_conns must be last, because
196 * the required number of conns is malloc'ed
197 * in one block with the metaconn_t structure */
200 typedef struct metatarget_t {
202 ldap_pvt_thread_mutex_t mt_uri_mutex;
204 /* TODO: we might want to enable different strategies
205 * for different targets */
206 LDAP_REBIND_PROC *mt_rebind_f;
207 LDAP_URLLIST_PROC *mt_urllist_f;
210 BerVarray mt_subtree_exclude;
213 struct berval mt_psuffix; /* pretty suffix */
214 struct berval mt_nsuffix; /* normalized suffix */
216 struct berval mt_binddn;
217 struct berval mt_bindpw;
219 struct berval mt_pseudorootdn;
220 struct berval mt_pseudorootpw;
223 #define META_RETRY_UNDEFINED (-2)
224 #define META_RETRY_FOREVER (-1)
225 #define META_RETRY_NEVER (0)
226 #define META_RETRY_DEFAULT (3)
228 struct ldaprwmap mt_rwmap;
232 time_t mt_network_timeout;
233 struct timeval mt_bind_timeout;
234 #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT
235 time_t mt_timeout[ LDAP_BACK_OP_LAST ];
238 typedef struct metadncache_t {
239 ldap_pvt_thread_mutex_t mutex;
242 #define META_DNCACHE_DISABLED (0)
243 #define META_DNCACHE_FOREVER ((time_t)(-1))
244 time_t ttl; /* seconds; 0: no cache, -1: no expiry */
247 typedef struct metacandidates_t {
249 SlapReply *mc_candidates;
252 typedef struct metainfo_t {
254 int mi_defaulttarget;
255 #define META_DEFAULT_TARGET_NONE (-1)
258 metatarget_t **mi_targets;
259 metacandidates_t *mi_candidates;
261 LDAP_REBIND_PROC *mi_rebind_f;
262 LDAP_URLLIST_PROC *mi_urllist_f;
264 metadncache_t mi_cache;
266 ldap_avl_info_t mi_conninfo;
269 #define li_flags mi_flags
270 /* uses flags as defined in <back-ldap/back-ldap.h> */
271 #define META_BACK_F_ONERR_STOP (0x00010000U)
272 #define META_BACK_F_DEFER_ROOTDN_BIND (0x00020000U)
274 #define META_BACK_ONERR_STOP(mi) ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
275 #define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
277 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
280 time_t mi_network_timeout;
282 time_t mi_idle_timeout;
283 struct timeval mi_bind_timeout;
284 time_t mi_timeout[ LDAP_BACK_OP_LAST ];
287 typedef enum meta_op_type {
288 META_OP_ALLOW_MULTIPLE = 0,
289 META_OP_REQUIRE_SINGLE,
294 meta_back_candidates_get( Operation *op );
301 ldap_back_send_t sendok );
304 meta_back_release_conn_lock(
308 #define meta_back_release_conn(op, mc) meta_back_release_conn_lock( (op), (mc), 1 )
316 ldap_back_send_t sendok );
323 meta_back_init_one_conn(
330 ldap_back_send_t sendok );
333 meta_back_single_bind(
345 ldap_back_send_t sendok );
348 meta_back_single_dobind(
353 ldap_back_send_t sendok,
365 back_meta_LTX_init_module(
375 meta_back_conndn_cmp(
380 meta_back_conndn_dup(
388 meta_back_is_candidate(
389 struct berval *nsuffix,
391 BerVarray subtree_exclude,
396 meta_back_select_unique_candidate(
398 struct berval *ndn );
401 meta_clear_unused_candidates(
406 meta_clear_one_candidate(
407 metasingleconn_t *mc );
410 meta_clear_candidates(
415 * Dn cache stuff (experimental)
427 #define META_TARGET_NONE (-1)
428 #define META_TARGET_MULTIPLE (-2)
430 meta_dncache_get_target(
431 metadncache_t *cache,
432 struct berval *ndn );
435 meta_dncache_update_entry(
436 metadncache_t *cache,
441 meta_dncache_delete_entry(
442 metadncache_t *cache,
443 struct berval *ndn );
446 meta_dncache_free( void *entry );
448 extern LDAP_REBIND_PROC meta_back_default_rebind;
449 extern LDAP_URLLIST_PROC meta_back_default_urllist;
453 #endif /* SLAPD_META_H */