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 ldaprwmap *rwmap;
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 */
159 typedef struct metasingleconn_t {
161 #define META_NOT_CANDIDATE ((ber_tag_t)0)
162 #define META_CANDIDATE ((ber_tag_t)1)
163 #define META_LAST_CONN ((ber_tag_t)(-1))
166 struct berval msc_bound_ndn;
167 struct berval msc_cred;
169 #define META_UNBOUND 0
171 #define META_ANONYMOUS 2
174 #define META_LAST(msc) ((msc)->msc_candidate == META_LAST_CONN)
176 typedef struct metaconn_t {
177 struct slap_conn *mc_conn;
178 ldap_pvt_thread_mutex_t mc_mutex;
181 * means that the connection is bound;
182 * of course only one target actually is ...
185 #define META_BOUND_NONE (-1)
186 #define META_BOUND_ALL (-2)
187 /* supersedes the connection stuff */
188 metasingleconn_t *mc_conns;
191 typedef struct metatarget_t {
193 struct berval mt_psuffix; /* pretty suffix */
194 struct berval mt_nsuffix; /* normalized suffix */
195 struct berval mt_binddn;
196 struct berval mt_bindpw;
198 struct berval mt_pseudorootdn;
199 struct berval mt_pseudorootpw;
202 #define META_RETRY_UNDEFINED (-2)
203 #define META_RETRY_FOREVER (-1)
204 #define META_RETRY_NEVER (0)
206 struct ldaprwmap mt_rwmap;
209 typedef struct metadncache_t {
210 ldap_pvt_thread_mutex_t mutex;
213 #define META_DNCACHE_DISABLED (0)
214 #define META_DNCACHE_FOREVER (-1)
215 long int ttl; /* seconds; 0: no cache, -1: no expiry */
218 typedef struct metainfo_t {
220 int mi_defaulttarget;
221 int mi_network_timeout;
222 #define META_DEFAULT_TARGET_NONE (-1)
225 metatarget_t **mi_targets;
226 SlapReply *mi_candidates;
228 metadncache_t mi_cache;
230 ldap_pvt_thread_mutex_t mi_conn_mutex;
231 Avlnode *mi_conntree;
235 /* defined in <back-ldap/back-ldap.h> */
236 #define LDAP_BACK_F_NONE 0x00U
237 #define LDAP_BACK_F_SAVECRED 0x01U
238 #define LDAP_BACK_F_USE_TLS 0x02U
239 #define LDAP_BACK_F_TLS_CRITICAL ( 0x04U | LDAP_BACK_F_USE_TLS )
240 #define LDAP_BACK_F_CHASE_REFERRALS 0x8U
244 typedef enum meta_op_type {
245 META_OP_ALLOW_MULTIPLE = 0,
246 META_OP_REQUIRE_SINGLE,
251 meta_back_candidates_get( Operation *op );
258 ldap_back_send_t sendok );
266 ldap_back_send_t sendok );
269 meta_back_conn_free( metaconn_t *mc );
272 meta_back_init_one_conn(
276 metasingleconn_t *msc,
277 ldap_back_send_t sendok );
284 ldap_back_send_t sendok );
287 meta_back_single_dobind(
292 ldap_back_send_t sendok,
303 back_meta_LTX_init_module(
321 meta_back_is_candidate(
322 struct berval *nsuffix,
327 meta_back_select_unique_candidate(
329 struct berval *ndn );
332 meta_clear_unused_candidates(
337 meta_clear_one_candidate(
338 metasingleconn_t *mc );
341 * Dn cache stuff (experimental)
353 #define META_TARGET_NONE (-1)
354 #define META_TARGET_MULTIPLE (-2)
356 meta_dncache_get_target(
357 metadncache_t *cache,
358 struct berval *ndn );
361 meta_dncache_update_entry(
362 metadncache_t *cache,
367 meta_dncache_delete_entry(
368 metadncache_t *cache,
369 struct berval *ndn );
372 meta_dncache_free( void *entry );
376 #endif /* SLAPD_META_H */