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;
182 * means that the connection is bound;
183 * of course only one target actually is ...
186 #define META_BOUND_NONE (-1)
187 #define META_BOUND_ALL (-2)
188 /* supersedes the connection stuff */
189 metasingleconn_t *mc_conns;
192 typedef struct metatarget_t {
195 struct berval mt_psuffix; /* pretty suffix */
196 struct berval mt_nsuffix; /* normalized suffix */
198 struct berval mt_binddn;
199 struct berval mt_bindpw;
201 struct berval mt_pseudorootdn;
202 struct berval mt_pseudorootpw;
205 #define META_RETRY_UNDEFINED (-2)
206 #define META_RETRY_FOREVER (-1)
207 #define META_RETRY_NEVER (0)
208 #define META_RETRY_DEFAULT (3)
210 struct ldaprwmap mt_rwmap;
216 typedef struct metadncache_t {
217 ldap_pvt_thread_mutex_t mutex;
220 #define META_DNCACHE_DISABLED (0)
221 #define META_DNCACHE_FOREVER (-1)
222 long int ttl; /* seconds; 0: no cache, -1: no expiry */
225 typedef struct metacandidates_t {
227 SlapReply *mc_candidates;
230 typedef struct metainfo_t {
232 int mi_defaulttarget;
233 int mi_network_timeout;
234 #define META_DEFAULT_TARGET_NONE (-1)
237 metatarget_t *mi_targets;
238 metacandidates_t *mi_candidates;
240 metadncache_t mi_cache;
242 ldap_pvt_thread_mutex_t mi_conn_mutex;
243 Avlnode *mi_conntree;
247 /* defined in <back-ldap/back-ldap.h> */
248 #define LDAP_BACK_F_NONE 0x00U
249 #define LDAP_BACK_F_SAVECRED 0x01U
250 #define LDAP_BACK_F_USE_TLS 0x02U
251 #define LDAP_BACK_F_PROPAGATE_TLS 0x04U
252 #define LDAP_BACK_F_TLS_CRITICAL 0x08U
253 #define LDAP_BACK_F_TLS_MASK (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
254 #define LDAP_BACK_F_CHASE_REFERRALS 0x10U
260 typedef enum meta_op_type {
261 META_OP_ALLOW_MULTIPLE = 0,
262 META_OP_REQUIRE_SINGLE,
267 meta_back_candidates_get( Operation *op );
274 ldap_back_send_t sendok );
282 ldap_back_send_t sendok );
285 meta_back_conn_free( metaconn_t *mc );
288 meta_back_init_one_conn(
292 metasingleconn_t *msc,
293 ldap_back_send_t sendok );
300 ldap_back_send_t sendok );
303 meta_back_single_dobind(
308 ldap_back_send_t sendok,
319 back_meta_LTX_init_module(
337 meta_back_is_candidate(
338 struct berval *nsuffix,
343 meta_back_select_unique_candidate(
345 struct berval *ndn );
348 meta_clear_unused_candidates(
353 meta_clear_one_candidate(
354 metasingleconn_t *mc );
357 * Dn cache stuff (experimental)
369 #define META_TARGET_NONE (-1)
370 #define META_TARGET_MULTIPLE (-2)
372 meta_dncache_get_target(
373 metadncache_t *cache,
374 struct berval *ndn );
377 meta_dncache_update_entry(
378 metadncache_t *cache,
383 meta_dncache_delete_entry(
384 metadncache_t *cache,
385 struct berval *ndn );
388 meta_dncache_free( void *entry );
392 #endif /* SLAPD_META_H */