2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2005 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 /* TODO: allow to define it on a per-target basis */
86 #define META_BIND_TIMEOUT 10000
88 int ldap_back_dn_massage(dncookie *dc, struct berval *dn,
91 extern int ldap_back_conn_cmp( const void *c1, const void *c2);
92 extern int ldap_back_conn_dup( void *c1, void *c2 );
93 extern void ldap_back_conn_free( void *c );
95 /* attributeType/objectClass mapping */
96 int mapping_cmp (const void *, const void *);
97 int mapping_dup (void *, void *);
99 void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** );
100 int ldap_back_mapping ( struct ldapmap *map, struct berval *s,
101 struct ldapmapping **m, int remap );
102 void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m,
104 #define BACKLDAP_MAP 0
105 #define BACKLDAP_REMAP 1
107 ldap_back_map_filter(
108 struct ldapmap *at_map,
109 struct ldapmap *oc_map,
115 struct ldapmap *at_map,
118 char ***mapped_attrs );
120 extern int ldap_back_map_config(
121 struct ldapmap *oc_map,
122 struct ldapmap *at_map,
129 ldap_back_filter_map_rewrite(
135 /* suffix massaging by means of librewrite */
136 #ifdef ENABLE_REWRITE
138 suffix_massage_config( struct rewrite_info *info,
142 struct berval *nrnc );
143 #endif /* ENABLE_REWRITE */
145 ldap_back_referral_result_rewrite(
153 ldap_dnattr_result_rewrite(
157 /* (end of) from back-ldap.h before rwm removal */
161 typedef struct metasingleconn_t {
163 #define META_NOT_CANDIDATE ((ber_tag_t)0)
164 #define META_CANDIDATE ((ber_tag_t)1)
167 struct berval msc_bound_ndn;
168 struct berval msc_cred;
170 #define META_UNBOUND 0
172 #define META_ANONYMOUS 2
174 struct metainfo_t *msc_info;
177 typedef struct metaconn_t {
178 struct slap_conn *mc_conn;
179 ldap_pvt_thread_mutex_t mc_mutex;
183 * means that the connection is bound;
184 * of course only one target actually is ...
187 #define META_BOUND_NONE (-1)
188 #define META_BOUND_ALL (-2)
189 /* supersedes the connection stuff */
190 metasingleconn_t mc_conns[ 1 ];
191 /* NOTE: mc_conns must be last, because
192 * the required number of conns is malloc'ed
193 * in one block with the metaconn_t structure */
204 typedef struct metatarget_t {
208 struct berval mt_psuffix; /* pretty suffix */
209 struct berval mt_nsuffix; /* normalized suffix */
211 struct berval mt_binddn;
212 struct berval mt_bindpw;
214 struct berval mt_pseudorootdn;
215 struct berval mt_pseudorootpw;
218 #define META_RETRY_UNDEFINED (-2)
219 #define META_RETRY_FOREVER (-1)
220 #define META_RETRY_NEVER (0)
221 #define META_RETRY_DEFAULT (3)
223 struct ldaprwmap mt_rwmap;
227 time_t mt_timeout[ META_OP_LAST ];
230 typedef struct metadncache_t {
231 ldap_pvt_thread_mutex_t mutex;
234 #define META_DNCACHE_DISABLED (0)
235 #define META_DNCACHE_FOREVER (-1)
236 long int ttl; /* seconds; 0: no cache, -1: no expiry */
239 typedef struct metacandidates_t {
241 SlapReply *mc_candidates;
244 typedef struct metainfo_t {
246 int mi_defaulttarget;
247 int mi_network_timeout;
248 #define META_DEFAULT_TARGET_NONE (-1)
251 metatarget_t *mi_targets;
252 metacandidates_t *mi_candidates;
254 metadncache_t mi_cache;
256 ldap_pvt_thread_mutex_t mi_conn_mutex;
257 Avlnode *mi_conntree;
260 /* uses flags as defined in <back-ldap/back-ldap.h> */
261 #define META_BACK_F_ONERR_STOP 0x00010000U
262 #define META_BACK_ONERR_STOP(mi) ( (mi)->flags & META_BACK_F_ONERR_STOP )
263 #define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
266 time_t mi_timeout[ META_OP_LAST ];
269 typedef enum meta_op_type {
270 META_OP_ALLOW_MULTIPLE = 0,
271 META_OP_REQUIRE_SINGLE,
276 meta_back_candidates_get( Operation *op );
283 ldap_back_send_t sendok );
286 meta_back_release_conn(
296 ldap_back_send_t sendok );
303 meta_back_init_one_conn(
307 metasingleconn_t *msc,
308 ldap_back_send_t sendok );
315 ldap_back_send_t sendok );
318 meta_back_single_dobind(
323 ldap_back_send_t sendok,
335 back_meta_LTX_init_module(
353 meta_back_is_candidate(
354 struct berval *nsuffix,
360 meta_back_select_unique_candidate(
362 struct berval *ndn );
365 meta_clear_unused_candidates(
370 meta_clear_one_candidate(
371 metasingleconn_t *mc );
374 * Dn cache stuff (experimental)
386 #define META_TARGET_NONE (-1)
387 #define META_TARGET_MULTIPLE (-2)
389 meta_dncache_get_target(
390 metadncache_t *cache,
391 struct berval *ndn );
394 meta_dncache_update_entry(
395 metadncache_t *cache,
400 meta_dncache_delete_entry(
401 metadncache_t *cache,
402 struct berval *ndn );
405 meta_dncache_free( void *entry );
409 #endif /* SLAPD_META_H */