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 struct metainfo_t *msc_info;
180 typedef struct metaconn_t {
181 struct slap_conn *mc_conn;
184 time_t mc_create_time;
187 struct berval mc_local_ndn;
188 /* NOTE: msc_mscflags is used to recycle the #define
189 * in metasingleconn_t */
190 unsigned msc_mscflags;
193 * means that the connection is bound;
194 * of course only one target actually is ...
197 #define META_BOUND_NONE (-1)
198 #define META_BOUND_ALL (-2)
199 /* supersedes the connection stuff */
200 metasingleconn_t mc_conns[ 1 ];
201 /* NOTE: mc_conns must be last, because
202 * the required number of conns is malloc'ed
203 * in one block with the metaconn_t structure */
206 typedef struct metatarget_t {
208 BerVarray mt_subtree_exclude;
211 struct berval mt_psuffix; /* pretty suffix */
212 struct berval mt_nsuffix; /* normalized suffix */
214 struct berval mt_binddn;
215 struct berval mt_bindpw;
217 struct berval mt_pseudorootdn;
218 struct berval mt_pseudorootpw;
221 #define META_RETRY_UNDEFINED (-2)
222 #define META_RETRY_FOREVER (-1)
223 #define META_RETRY_NEVER (0)
224 #define META_RETRY_DEFAULT (3)
226 struct ldaprwmap mt_rwmap;
230 time_t mt_network_timeout;
231 struct timeval mt_bind_timeout;
232 #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT
233 time_t mt_timeout[ LDAP_BACK_OP_LAST ];
236 typedef struct metadncache_t {
237 ldap_pvt_thread_mutex_t mutex;
240 #define META_DNCACHE_DISABLED (0)
241 #define META_DNCACHE_FOREVER ((time_t)(-1))
242 time_t ttl; /* seconds; 0: no cache, -1: no expiry */
245 typedef struct metacandidates_t {
247 SlapReply *mc_candidates;
250 typedef struct metainfo_t {
252 int mi_defaulttarget;
253 #define META_DEFAULT_TARGET_NONE (-1)
256 metatarget_t *mi_targets;
257 metacandidates_t *mi_candidates;
259 metadncache_t mi_cache;
261 ldap_avl_info_t mi_conninfo;
264 #define li_flags mi_flags
265 /* uses flags as defined in <back-ldap/back-ldap.h> */
266 #define META_BACK_F_ONERR_STOP 0x00010000U
267 #define META_BACK_F_DEFER_ROOTDN_BIND 0x00020000U
269 #define META_BACK_ONERR_STOP(mi) ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
270 #define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
272 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
275 time_t mi_network_timeout;
277 time_t mi_idle_timeout;
278 struct timeval mi_bind_timeout;
279 time_t mi_timeout[ LDAP_BACK_OP_LAST ];
282 typedef enum meta_op_type {
283 META_OP_ALLOW_MULTIPLE = 0,
284 META_OP_REQUIRE_SINGLE,
289 meta_back_candidates_get( Operation *op );
296 ldap_back_send_t sendok );
299 meta_back_release_conn_lock(
304 #define meta_back_release_conn(op, mc) meta_back_release_conn_lock( (op), (mc), 0, 1 )
312 ldap_back_send_t sendok );
319 meta_back_init_one_conn(
326 ldap_back_send_t sendok );
329 meta_back_single_bind(
341 ldap_back_send_t sendok );
344 meta_back_single_dobind(
349 ldap_back_send_t sendok,
361 back_meta_LTX_init_module(
371 meta_back_conndn_cmp(
376 meta_back_conndn_dup(
384 meta_back_is_candidate(
385 struct berval *nsuffix,
387 BerVarray subtree_exclude,
392 meta_back_select_unique_candidate(
394 struct berval *ndn );
397 meta_clear_unused_candidates(
402 meta_clear_one_candidate(
403 metasingleconn_t *mc );
406 meta_clear_candidates(
411 * Dn cache stuff (experimental)
423 #define META_TARGET_NONE (-1)
424 #define META_TARGET_MULTIPLE (-2)
426 meta_dncache_get_target(
427 metadncache_t *cache,
428 struct berval *ndn );
431 meta_dncache_update_entry(
432 metadncache_t *cache,
437 meta_dncache_delete_entry(
438 metadncache_t *cache,
439 struct berval *ndn );
442 meta_dncache_free( void *entry );
444 extern LDAP_REBIND_PROC *meta_back_rebind_f;
448 #endif /* SLAPD_META_H */