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
172 #define META_UNBOUND 0
174 #define META_ANONYMOUS 2
177 time_t msc_create_time;
180 struct metainfo_t *msc_info;
183 typedef struct metaconn_t {
184 struct slap_conn *mc_conn;
185 ldap_pvt_thread_mutex_t mc_mutex;
189 struct berval mc_local_ndn;
190 /* NOTE: msc_mscflags is used to recycle the #define
191 * in metasingleconn_t */
192 unsigned msc_mscflags;
195 * means that the connection is bound;
196 * of course only one target actually is ...
199 #define META_BOUND_NONE (-1)
200 #define META_BOUND_ALL (-2)
201 /* supersedes the connection stuff */
202 metasingleconn_t mc_conns[ 1 ];
203 /* NOTE: mc_conns must be last, because
204 * the required number of conns is malloc'ed
205 * in one block with the metaconn_t structure */
208 typedef struct metatarget_t {
212 struct berval mt_psuffix; /* pretty suffix */
213 struct berval mt_nsuffix; /* normalized suffix */
215 struct berval mt_binddn;
216 struct berval mt_bindpw;
218 struct berval mt_pseudorootdn;
219 struct berval mt_pseudorootpw;
222 #define META_RETRY_UNDEFINED (-2)
223 #define META_RETRY_FOREVER (-1)
224 #define META_RETRY_NEVER (0)
225 #define META_RETRY_DEFAULT (3)
227 struct ldaprwmap mt_rwmap;
231 time_t mt_network_timeout;
233 time_t mt_idle_timeout;
234 struct timeval mt_bind_timeout;
235 #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT
236 time_t mt_timeout[ LDAP_BACK_OP_LAST ];
239 typedef struct metadncache_t {
240 ldap_pvt_thread_mutex_t mutex;
243 #define META_DNCACHE_DISABLED (0)
244 #define META_DNCACHE_FOREVER ((time_t)(-1))
245 time_t ttl; /* seconds; 0: no cache, -1: no expiry */
248 typedef struct metacandidates_t {
250 SlapReply *mc_candidates;
253 typedef struct metainfo_t {
255 int mi_defaulttarget;
256 #define META_DEFAULT_TARGET_NONE (-1)
259 metatarget_t *mi_targets;
260 metacandidates_t *mi_candidates;
262 metadncache_t mi_cache;
264 ldap_avl_info_t mi_conninfo;
267 #define li_flags mi_flags
268 /* uses flags as defined in <back-ldap/back-ldap.h> */
269 #define META_BACK_F_ONERR_STOP 0x00010000U
270 #define META_BACK_F_DEFER_ROOTDN_BIND 0x00020000U
272 #define META_BACK_ONERR_STOP(mi) ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
273 #define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
275 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
278 time_t mi_network_timeout;
280 time_t mi_idle_timeout;
281 struct timeval mi_bind_timeout;
282 time_t mi_timeout[ LDAP_BACK_OP_LAST ];
285 typedef enum meta_op_type {
286 META_OP_ALLOW_MULTIPLE = 0,
287 META_OP_REQUIRE_SINGLE,
292 meta_back_candidates_get( Operation *op );
299 ldap_back_send_t sendok );
302 meta_back_release_conn(
307 meta_back_retry_lock(
312 ldap_back_send_t sendok,
314 #define meta_back_retry(op, rs, mc, candidate, sendok) \
315 meta_back_retry_lock((op), (rs), (mc), (candidate), (sendok), 1)
322 meta_back_init_one_conn(
329 ldap_back_send_t sendok );
332 meta_back_single_bind(
344 ldap_back_send_t sendok );
347 meta_back_single_dobind(
352 ldap_back_send_t sendok,
364 back_meta_LTX_init_module(
374 meta_back_dnconn_cmp(
379 meta_back_dnconn_dup(
387 meta_back_is_candidate(
388 struct berval *nsuffix,
394 meta_back_select_unique_candidate(
396 struct berval *ndn );
399 meta_clear_unused_candidates(
404 meta_clear_one_candidate(
405 metasingleconn_t *mc );
408 * Dn cache stuff (experimental)
420 #define META_TARGET_NONE (-1)
421 #define META_TARGET_MULTIPLE (-2)
423 meta_dncache_get_target(
424 metadncache_t *cache,
425 struct berval *ndn );
428 meta_dncache_update_entry(
429 metadncache_t *cache,
434 meta_dncache_delete_entry(
435 metadncache_t *cache,
436 struct berval *ndn );
439 meta_dncache_free( void *entry );
441 extern LDAP_REBIND_PROC *meta_back_rebind_f;
445 #endif /* SLAPD_META_H */