1 /* back-ldap.h - ldap backend header file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1999-2006 The OpenLDAP Foundation.
6 * Portions Copyright 2000-2003 Pierangelo Masarati.
7 * Portions Copyright 1999-2003 Howard Chu.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted only as authorized by the OpenLDAP
14 * A copy of this license is available in the file LICENSE in the
15 * top-level directory of the distribution or, alternatively, at
16 * <http://www.OpenLDAP.org/license.html>.
19 * This work was initially developed by the Howard Chu for inclusion
20 * in OpenLDAP Software and subsequently enhanced by Pierangelo
31 typedef struct ldapconn_t {
33 #define LDAP_BACK_PCONN ((void *)0x0)
34 #define LDAP_BACK_PCONN_TLS ((void *)0x1)
35 #define LDAP_BACK_PCONN_ID(c) ((void *)(c) > LDAP_BACK_PCONN_TLS ? (c)->c_connid : -1)
37 #define LDAP_BACK_PCONN_SET(op) ((op)->o_conn->c_is_tls ? LDAP_BACK_PCONN_TLS : LDAP_BACK_PCONN)
38 #else /* ! HAVE_TLS */
39 #define LDAP_BACK_PCONN_SET(op) (LDAP_BACK_PCONN)
40 #endif /* ! HAVE_TLS */
43 struct berval lc_cred;
44 struct berval lc_bound_ndn;
45 struct berval lc_local_ndn;
47 #define LDAP_BACK_CONN_ISSET_F(fp,f) (*(fp) & (f))
48 #define LDAP_BACK_CONN_SET_F(fp,f) (*(fp) |= (f))
49 #define LDAP_BACK_CONN_CLEAR_F(fp,f) (*(fp) &= ~(f))
50 #define LDAP_BACK_CONN_CPY_F(fp,f,mfp) \
52 if ( ((f) & *(mfp)) == (f) ) { \
59 #define LDAP_BACK_CONN_ISSET(lc,f) LDAP_BACK_CONN_ISSET_F(&(lc)->lc_lcflags, (f))
60 #define LDAP_BACK_CONN_SET(lc,f) LDAP_BACK_CONN_SET_F(&(lc)->lc_lcflags, (f))
61 #define LDAP_BACK_CONN_CLEAR(lc,f) LDAP_BACK_CONN_CLEAR_F(&(lc)->lc_lcflags, (f))
62 #define LDAP_BACK_CONN_CPY(lc,f,mlc) LDAP_BACK_CONN_CPY_F(&(lc)->lc_lcflags, (f), &(mlc)->lc_lcflags)
64 #define LDAP_BACK_FCONN_ISBOUND (0x00000001U)
65 #define LDAP_BACK_FCONN_ISANON (0x00000002U)
66 #define LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
67 #define LDAP_BACK_FCONN_ISPRIV (0x00000004U)
68 #define LDAP_BACK_FCONN_ISTLS (0x00000008U)
69 #define LDAP_BACK_FCONN_BINDING (0x00000010U)
70 #define LDAP_BACK_FCONN_TAINTED (0x00000020U)
72 /* 0x00FF0000 are reserved for back-meta */
74 #define LDAP_BACK_CONN_ISBOUND(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
75 #define LDAP_BACK_CONN_ISBOUND_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
76 #define LDAP_BACK_CONN_ISBOUND_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISBMASK)
77 #define LDAP_BACK_CONN_ISBOUND_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISBOUND, (mlc))
78 #define LDAP_BACK_CONN_ISANON(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISANON)
79 #define LDAP_BACK_CONN_ISANON_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISANON)
80 #define LDAP_BACK_CONN_ISANON_CLEAR(lc) LDAP_BACK_CONN_ISBOUND_CLEAR((lc))
81 #define LDAP_BACK_CONN_ISANON_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISANON, (mlc))
82 #define LDAP_BACK_CONN_ISPRIV(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISPRIV)
83 #define LDAP_BACK_CONN_ISPRIV_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISPRIV)
84 #define LDAP_BACK_CONN_ISPRIV_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISPRIV)
85 #define LDAP_BACK_CONN_ISPRIV_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISPRIV, (mlc))
86 #define LDAP_BACK_CONN_ISTLS(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISTLS)
87 #define LDAP_BACK_CONN_ISTLS_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISTLS)
88 #define LDAP_BACK_CONN_ISTLS_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISTLS)
89 #define LDAP_BACK_CONN_ISTLS_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISTLS, (mlc))
90 #define LDAP_BACK_CONN_BINDING(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_BINDING)
91 #define LDAP_BACK_CONN_BINDING_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_BINDING)
92 #define LDAP_BACK_CONN_BINDING_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_BINDING)
93 #define LDAP_BACK_CONN_TAINTED(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_TAINTED)
94 #define LDAP_BACK_CONN_TAINTED_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_TAINTED)
95 #define LDAP_BACK_CONN_TAINTED_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_TAINTED)
100 time_t lc_create_time;
105 * operation enumeration for timeouts
108 LDAP_BACK_OP_ADD = 0,
115 typedef struct ldap_avl_info_t {
116 ldap_pvt_thread_mutex_t lai_mutex;
120 typedef struct slap_retry_info_t {
127 #define SLAP_RETRYNUM_FOREVER (-1) /* retry forever */
128 #define SLAP_RETRYNUM_TAIL (-2) /* end of retrynum array */
129 #define SLAP_RETRYNUM_VALID(n) ((n) >= SLAP_RETRYNUM_FOREVER) /* valid retrynum */
130 #define SLAP_RETRYNUM_FINITE(n) ((n) > SLAP_RETRYNUM_FOREVER) /* not forever */
134 * identity assertion modes
137 LDAP_BACK_IDASSERT_LEGACY = 1,
138 LDAP_BACK_IDASSERT_NOASSERT,
139 LDAP_BACK_IDASSERT_ANONYMOUS,
140 LDAP_BACK_IDASSERT_SELF,
141 LDAP_BACK_IDASSERT_OTHERDN,
142 LDAP_BACK_IDASSERT_OTHERID
143 } slap_idassert_mode_t;
145 /* ID assert stuff */
146 typedef struct slap_idassert_t {
147 slap_idassert_mode_t si_mode;
148 #define li_idassert_mode li_idassert.si_mode
151 #define li_idassert_authcID li_idassert.si_bc.sb_authcId
152 #define li_idassert_authcDN li_idassert.si_bc.sb_binddn
153 #define li_idassert_passwd li_idassert.si_bc.sb_cred
154 #define li_idassert_authzID li_idassert.si_bc.sb_authzId
155 #define li_idassert_authmethod li_idassert.si_bc.sb_method
156 #define li_idassert_sasl_mech li_idassert.si_bc.sb_saslmech
157 #define li_idassert_sasl_realm li_idassert.si_bc.sb_realm
158 #define li_idassert_secprops li_idassert.si_bc.sb_secprops
159 #define li_idassert_tls li_idassert.si_bc.sb_tls
162 #define LDAP_BACK_AUTH_NONE 0x00U
163 #define LDAP_BACK_AUTH_NATIVE_AUTHZ 0x01U
164 #define LDAP_BACK_AUTH_OVERRIDE 0x02U
165 #define LDAP_BACK_AUTH_PRESCRIPTIVE 0x04U
166 #define LDAP_BACK_AUTH_OBSOLETE_PROXY_AUTHZ 0x08U
167 #define LDAP_BACK_AUTH_OBSOLETE_ENCODING_WORKAROUND 0x10U
168 #define li_idassert_flags li_idassert.si_flags
171 #define li_idassert_authz li_idassert.si_authz
175 * Hook to allow mucking with ldapinfo_t when quarantine is over
177 typedef int (*ldap_back_quarantine_f)( struct ldapinfo_t *, void * );
179 typedef struct ldapinfo_t {
180 /* li_uri: the string that goes into ldap_initialize()
181 * TODO: use li_acl.sb_uri instead */
183 /* li_bvuri: an array of each single URI that is equivalent;
184 * to be checked for the presence of a certain item */
186 ldap_pvt_thread_mutex_t li_uri_mutex;
188 LDAP_REBIND_PROC *li_rebind_f;
189 LDAP_URLLIST_PROC *li_urllist_f;
192 slap_bindconf li_acl;
193 #define li_acl_authcID li_acl.sb_authcId
194 #define li_acl_authcDN li_acl.sb_binddn
195 #define li_acl_passwd li_acl.sb_cred
196 #define li_acl_authzID li_acl.sb_authzId
197 #define li_acl_authmethod li_acl.sb_method
198 #define li_acl_sasl_mech li_acl.sb_saslmech
199 #define li_acl_sasl_realm li_acl.sb_realm
200 #define li_acl_secprops li_acl.sb_secprops
202 /* ID assert stuff */
203 slap_idassert_t li_idassert;
204 /* end of ID assert stuff */
207 #define LDAP_BACK_RETRY_UNDEFINED (-2)
208 #define LDAP_BACK_RETRY_FOREVER (-1)
209 #define LDAP_BACK_RETRY_NEVER (0)
210 #define LDAP_BACK_RETRY_DEFAULT (3)
213 #define LDAP_BACK_F_NONE (0x0000U)
214 #define LDAP_BACK_F_SAVECRED (0x0001U)
215 #define LDAP_BACK_F_USE_TLS (0x0002U)
216 #define LDAP_BACK_F_PROPAGATE_TLS (0x0004U)
217 #define LDAP_BACK_F_TLS_CRITICAL (0x0008U)
218 #define LDAP_BACK_F_TLS_USE_MASK (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
219 #define LDAP_BACK_F_TLS_PROPAGATE_MASK (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
220 #define LDAP_BACK_F_TLS_MASK (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
221 #define LDAP_BACK_F_CHASE_REFERRALS (0x0010U)
222 #define LDAP_BACK_F_PROXY_WHOAMI (0x0020U)
224 #define LDAP_BACK_F_T_F (0x0040U)
225 #define LDAP_BACK_F_T_F_DISCOVER (0x0080U)
226 #define LDAP_BACK_F_T_F_MASK (LDAP_BACK_F_T_F)
227 #define LDAP_BACK_F_T_F_MASK2 (LDAP_BACK_F_T_F_MASK|LDAP_BACK_F_T_F_DISCOVER)
229 #define LDAP_BACK_F_MONITOR (0x0100U)
230 #define LDAP_BACK_F_SINGLECONN (0x0200U)
232 #define LDAP_BACK_F_ISOPEN (0x0400U)
234 #define LDAP_BACK_F_CANCEL_ABANDON (0x0000U)
235 #define LDAP_BACK_F_CANCEL_IGNORE (0x1000U)
236 #define LDAP_BACK_F_CANCEL_EXOP (0x2000U)
237 #define LDAP_BACK_F_CANCEL_EXOP_DISCOVER (0x4000U)
238 #define LDAP_BACK_F_CANCEL_MASK (LDAP_BACK_F_CANCEL_IGNORE|LDAP_BACK_F_CANCEL_EXOP)
239 #define LDAP_BACK_F_CANCEL_MASK2 (LDAP_BACK_F_CANCEL_MASK|LDAP_BACK_F_CANCEL_EXOP_DISCOVER)
241 #define LDAP_BACK_ISSET(li,f) ( ( (li)->li_flags & (f) ) == (f) )
242 #define LDAP_BACK_ISMASK(li,m,f) ( ( (li)->li_flags & (m) ) == (f) )
244 #define LDAP_BACK_SAVECRED(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_SAVECRED )
245 #define LDAP_BACK_USE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_USE_TLS )
246 #define LDAP_BACK_PROPAGATE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROPAGATE_TLS )
247 #define LDAP_BACK_TLS_CRITICAL(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_TLS_CRITICAL )
248 #define LDAP_BACK_CHASE_REFERRALS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_CHASE_REFERRALS )
249 #define LDAP_BACK_PROXY_WHOAMI(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROXY_WHOAMI )
251 #define LDAP_BACK_T_F(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
252 #define LDAP_BACK_T_F_DISCOVER(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
254 #define LDAP_BACK_MONITOR(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_MONITOR )
255 #define LDAP_BACK_SINGLECONN(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_SINGLECONN )
257 #define LDAP_BACK_ISOPEN(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_ISOPEN )
259 #define LDAP_BACK_ABANDON(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
260 #define LDAP_BACK_IGNORE(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
261 #define LDAP_BACK_CANCEL(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
262 #define LDAP_BACK_CANCEL_DISCOVER(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
266 ldap_avl_info_t li_conninfo;
268 sig_atomic_t li_isquarantined;
269 #define LDAP_BACK_FQ_NO (0)
270 #define LDAP_BACK_FQ_YES (1)
271 #define LDAP_BACK_FQ_RETRYING (2)
273 slap_retry_info_t li_quarantine;
274 #define LDAP_BACK_QUARANTINE(li) ( (li)->li_quarantine.ri_num != NULL )
275 ldap_pvt_thread_mutex_t li_quarantine_mutex;
276 ldap_back_quarantine_f li_quarantine_f;
277 void *li_quarantine_p;
279 time_t li_network_timeout;
281 time_t li_idle_timeout;
282 time_t li_timeout[ LDAP_BACK_OP_LAST ];
285 typedef enum ldap_back_send_t {
286 LDAP_BACK_DONTSEND = 0x00,
287 LDAP_BACK_SENDOK = 0x01,
288 LDAP_BACK_SENDERR = 0x02,
289 LDAP_BACK_SENDRESULT = (LDAP_BACK_SENDOK|LDAP_BACK_SENDERR),
290 LDAP_BACK_BINDING = 0x04,
292 LDAP_BACK_BIND_DONTSEND = (LDAP_BACK_BINDING),
293 LDAP_BACK_BIND_SOK = (LDAP_BACK_BINDING|LDAP_BACK_SENDOK),
294 LDAP_BACK_BIND_SERR = (LDAP_BACK_BINDING|LDAP_BACK_SENDERR),
295 LDAP_BACK_BIND_SRES = (LDAP_BACK_BINDING|LDAP_BACK_SENDRESULT),
297 LDAP_BACK_RETRYING = 0x08,
298 LDAP_BACK_RETRY_DONTSEND = (LDAP_BACK_RETRYING),
299 LDAP_BACK_RETRY_SOK = (LDAP_BACK_RETRYING|LDAP_BACK_SENDOK),
300 LDAP_BACK_RETRY_SERR = (LDAP_BACK_RETRYING|LDAP_BACK_SENDERR),
301 LDAP_BACK_RETRY_SRES = (LDAP_BACK_RETRYING|LDAP_BACK_SENDRESULT)
304 /* define to use asynchronous StartTLS */
305 #define SLAP_STARTTLS_ASYNCHRONOUS
307 /* timeout to use when calling ldap_result() */
308 #define LDAP_BACK_RESULT_TIMEOUT (0)
309 #define LDAP_BACK_RESULT_UTIMEOUT (100000)
310 #define LDAP_BACK_TV_SET(tv) \
312 (tv)->tv_sec = LDAP_BACK_RESULT_TIMEOUT; \
313 (tv)->tv_usec = LDAP_BACK_RESULT_UTIMEOUT; \
318 #include "proto-ldap.h"
320 #endif /* SLAPD_LDAP_H */