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;
169 unsigned msc_mscflags;
170 /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros
171 * defined for back-ldap */
172 #define lc_lcflags msc_mscflags
175 #define META_UNBOUND 0
177 #define META_ANONYMOUS 2
182 struct metainfo_t *msc_info;
185 typedef struct metaconn_t {
186 struct slap_conn *mc_conn;
187 ldap_pvt_thread_mutex_t mc_mutex;
191 struct berval mc_local_ndn;
192 /* NOTE: msc_mscflags is used to recycle the #define
193 * in metasingleconn_t */
194 unsigned msc_mscflags;
197 * means that the connection is bound;
198 * of course only one target actually is ...
201 #define META_BOUND_NONE (-1)
202 #define META_BOUND_ALL (-2)
203 /* supersedes the connection stuff */
204 metasingleconn_t mc_conns[ 1 ];
205 /* NOTE: mc_conns must be last, because
206 * the required number of conns is malloc'ed
207 * in one block with the metaconn_t structure */
210 typedef struct metatarget_t {
214 struct berval mt_psuffix; /* pretty suffix */
215 struct berval mt_nsuffix; /* normalized suffix */
217 struct berval mt_binddn;
218 struct berval mt_bindpw;
220 struct berval mt_pseudorootdn;
221 struct berval mt_pseudorootpw;
224 #define META_RETRY_UNDEFINED (-2)
225 #define META_RETRY_FOREVER (-1)
226 #define META_RETRY_NEVER (0)
227 #define META_RETRY_DEFAULT (3)
229 struct ldaprwmap mt_rwmap;
233 time_t mt_network_timeout;
234 time_t mt_idle_timeout;
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 metadncache_t mi_cache;
263 ldap_avl_info_t mi_conninfo;
266 #define li_flags mi_flags
267 /* uses flags as defined in <back-ldap/back-ldap.h> */
268 #define META_BACK_F_ONERR_STOP 0x00010000U
269 #define META_BACK_F_DEFER_ROOTDN_BIND 0x00020000U
271 #define META_BACK_ONERR_STOP(mi) ( (mi)->mi_flags & META_BACK_F_ONERR_STOP )
272 #define META_BACK_ONERR_CONTINUE(mi) ( !META_BACK_ONERR_CONTINUE( (mi) ) )
274 #define META_BACK_DEFER_ROOTDN_BIND(mi) ( (mi)->mi_flags & META_BACK_F_DEFER_ROOTDN_BIND )
277 time_t mi_network_timeout;
278 time_t mi_idle_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(
309 ldap_back_send_t sendok );
316 meta_back_init_one_conn(
323 ldap_back_send_t sendok );
330 ldap_back_send_t sendok );
333 meta_back_single_dobind(
338 ldap_back_send_t sendok,
350 back_meta_LTX_init_module(
368 meta_back_is_candidate(
369 struct berval *nsuffix,
375 meta_back_select_unique_candidate(
377 struct berval *ndn );
380 meta_clear_unused_candidates(
385 meta_clear_one_candidate(
386 metasingleconn_t *mc );
389 * Dn cache stuff (experimental)
401 #define META_TARGET_NONE (-1)
402 #define META_TARGET_MULTIPLE (-2)
404 meta_dncache_get_target(
405 metadncache_t *cache,
406 struct berval *ndn );
409 meta_dncache_update_entry(
410 metadncache_t *cache,
415 meta_dncache_delete_entry(
416 metadncache_t *cache,
417 struct berval *ndn );
420 meta_dncache_free( void *entry );
422 extern LDAP_REBIND_PROC *meta_back_rebind_f;
426 #endif /* SLAPD_META_H */