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(lc,f) ((lc)->lc_lcflags & (f))
48 #define LDAP_BACK_CONN_SET(lc,f) ((lc)->lc_lcflags |= (f))
49 #define LDAP_BACK_CONN_CLEAR(lc,f) ((lc)->lc_lcflags &= ~(f))
50 #define LDAP_BACK_CONN_CPY(lc,f,mlc) \
52 if ( ((f) & (mlc)->lc_lcflags) == (f) ) { \
53 (lc)->lc_lcflags |= (f); \
55 (lc)->lc_lcflags &= ~(f); \
59 #define LDAP_BACK_FCONN_ISBOUND (0x00000001U)
60 #define LDAP_BACK_FCONN_ISANON (0x00000002U)
61 #define LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
62 #define LDAP_BACK_FCONN_ISPRIV (0x00000004U)
63 #define LDAP_BACK_FCONN_ISTLS (0x00000008U)
64 #define LDAP_BACK_FCONN_BINDING (0x00000010U)
65 #define LDAP_BACK_FCONN_TAINTED (0x00000020U)
67 /* 0x00FF0000 are reserved for back-meta */
69 #define LDAP_BACK_CONN_ISBOUND(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
70 #define LDAP_BACK_CONN_ISBOUND_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
71 #define LDAP_BACK_CONN_ISBOUND_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISBMASK)
72 #define LDAP_BACK_CONN_ISBOUND_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISBOUND, (mlc))
73 #define LDAP_BACK_CONN_ISANON(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISANON)
74 #define LDAP_BACK_CONN_ISANON_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISANON)
75 #define LDAP_BACK_CONN_ISANON_CLEAR(lc) LDAP_BACK_CONN_ISBOUND_CLEAR((lc))
76 #define LDAP_BACK_CONN_ISANON_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISANON, (mlc))
77 #define LDAP_BACK_CONN_ISPRIV(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISPRIV)
78 #define LDAP_BACK_CONN_ISPRIV_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISPRIV)
79 #define LDAP_BACK_CONN_ISPRIV_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISPRIV)
80 #define LDAP_BACK_CONN_ISPRIV_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISPRIV, (mlc))
81 #define LDAP_BACK_CONN_ISTLS(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISTLS)
82 #define LDAP_BACK_CONN_ISTLS_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISTLS)
83 #define LDAP_BACK_CONN_ISTLS_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISTLS)
84 #define LDAP_BACK_CONN_ISTLS_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISTLS, (mlc))
85 #define LDAP_BACK_CONN_BINDING(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_BINDING)
86 #define LDAP_BACK_CONN_BINDING_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_BINDING)
87 #define LDAP_BACK_CONN_BINDING_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_BINDING)
88 #define LDAP_BACK_CONN_TAINTED(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_TAINTED)
89 #define LDAP_BACK_CONN_TAINTED_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_TAINTED)
90 #define LDAP_BACK_CONN_TAINTED_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_TAINTED)
95 time_t lc_create_time;
100 * identity assertion modes
103 LDAP_BACK_IDASSERT_LEGACY = 1,
104 LDAP_BACK_IDASSERT_NOASSERT,
105 LDAP_BACK_IDASSERT_ANONYMOUS,
106 LDAP_BACK_IDASSERT_SELF,
107 LDAP_BACK_IDASSERT_OTHERDN,
108 LDAP_BACK_IDASSERT_OTHERID
112 * operation enumeration for timeouts
115 LDAP_BACK_OP_ADD = 0,
122 typedef struct ldap_avl_info_t {
123 ldap_pvt_thread_mutex_t lai_mutex;
127 typedef struct slap_retry_info_t {
134 #define SLAP_RETRYNUM_FOREVER (-1) /* retry forever */
135 #define SLAP_RETRYNUM_TAIL (-2) /* end of retrynum array */
136 #define SLAP_RETRYNUM_VALID(n) ((n) >= SLAP_RETRYNUM_FOREVER) /* valid retrynum */
137 #define SLAP_RETRYNUM_FINITE(n) ((n) > SLAP_RETRYNUM_FOREVER) /* not forever */
141 * Hook to allow mucking with ldapinfo_t when quarantine is over
143 typedef int (*ldap_back_quarantine_f)(struct ldapinfo_t *, void *);
145 typedef struct ldapinfo_t {
146 /* li_uri: the string that goes into ldap_initialize()
147 * TODO: use li_acl.sb_uri instead */
149 /* li_bvuri: an array of each single URI that is equivalent;
150 * to be checked for the presence of a certain item */
152 ldap_pvt_thread_mutex_t li_uri_mutex;
154 LDAP_REBIND_PROC *li_rebind_f;
155 LDAP_URLLIST_PROC *li_urllist_f;
158 slap_bindconf li_acl;
159 #define li_acl_authcID li_acl.sb_authcId
160 #define li_acl_authcDN li_acl.sb_binddn
161 #define li_acl_passwd li_acl.sb_cred
162 #define li_acl_authzID li_acl.sb_authzId
163 #define li_acl_authmethod li_acl.sb_method
164 #define li_acl_sasl_mech li_acl.sb_saslmech
165 #define li_acl_sasl_realm li_acl.sb_realm
166 #define li_acl_secprops li_acl.sb_secprops
168 /* ID assert stuff */
169 int li_idassert_mode;
171 slap_bindconf li_idassert;
172 #define li_idassert_authcID li_idassert.sb_authcId
173 #define li_idassert_authcDN li_idassert.sb_binddn
174 #define li_idassert_passwd li_idassert.sb_cred
175 #define li_idassert_authzID li_idassert.sb_authzId
176 #define li_idassert_authmethod li_idassert.sb_method
177 #define li_idassert_sasl_mech li_idassert.sb_saslmech
178 #define li_idassert_sasl_realm li_idassert.sb_realm
179 #define li_idassert_secprops li_idassert.sb_secprops
181 unsigned li_idassert_flags;
182 #define LDAP_BACK_AUTH_NONE 0x00U
183 #define LDAP_BACK_AUTH_NATIVE_AUTHZ 0x01U
184 #define LDAP_BACK_AUTH_OVERRIDE 0x02U
185 #define LDAP_BACK_AUTH_PRESCRIPTIVE 0x04U
186 #define LDAP_BACK_AUTH_OBSOLETE_PROXY_AUTHZ 0x08U
187 #define LDAP_BACK_AUTH_OBSOLETE_ENCODING_WORKAROUND 0x10U
189 BerVarray li_idassert_authz;
190 /* end of ID assert stuff */
193 #define LDAP_BACK_RETRY_UNDEFINED (-2)
194 #define LDAP_BACK_RETRY_FOREVER (-1)
195 #define LDAP_BACK_RETRY_NEVER (0)
196 #define LDAP_BACK_RETRY_DEFAULT (3)
199 #define LDAP_BACK_F_NONE (0x0000U)
200 #define LDAP_BACK_F_SAVECRED (0x0001U)
201 #define LDAP_BACK_F_USE_TLS (0x0002U)
202 #define LDAP_BACK_F_PROPAGATE_TLS (0x0004U)
203 #define LDAP_BACK_F_TLS_CRITICAL (0x0008U)
204 #define LDAP_BACK_F_TLS_USE_MASK (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
205 #define LDAP_BACK_F_TLS_PROPAGATE_MASK (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
206 #define LDAP_BACK_F_TLS_MASK (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
207 #define LDAP_BACK_F_CHASE_REFERRALS (0x0010U)
208 #define LDAP_BACK_F_PROXY_WHOAMI (0x0020U)
210 #define LDAP_BACK_F_T_F (0x0040U)
211 #define LDAP_BACK_F_T_F_DISCOVER (0x0080U)
212 #define LDAP_BACK_F_T_F_MASK (LDAP_BACK_F_T_F)
213 #define LDAP_BACK_F_T_F_MASK2 (LDAP_BACK_F_T_F_MASK|LDAP_BACK_F_T_F_DISCOVER)
215 #define LDAP_BACK_F_MONITOR (0x0100U)
216 #define LDAP_BACK_F_SINGLECONN (0x0200U)
218 #define LDAP_BACK_F_ISOPEN (0x0400U)
220 #define LDAP_BACK_F_CANCEL_ABANDON (0x0000U)
221 #define LDAP_BACK_F_CANCEL_IGNORE (0x1000U)
222 #define LDAP_BACK_F_CANCEL_EXOP (0x2000U)
223 #define LDAP_BACK_F_CANCEL_EXOP_DISCOVER (0x4000U)
224 #define LDAP_BACK_F_CANCEL_MASK (LDAP_BACK_F_CANCEL_IGNORE|LDAP_BACK_F_CANCEL_EXOP)
225 #define LDAP_BACK_F_CANCEL_MASK2 (LDAP_BACK_F_CANCEL_MASK|LDAP_BACK_F_CANCEL_EXOP_DISCOVER)
227 #define LDAP_BACK_ISSET(li,f) ( ( (li)->li_flags & (f) ) == (f) )
228 #define LDAP_BACK_ISMASK(li,m,f) ( ( (li)->li_flags & (m) ) == (f) )
230 #define LDAP_BACK_SAVECRED(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_SAVECRED )
231 #define LDAP_BACK_USE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_USE_TLS )
232 #define LDAP_BACK_PROPAGATE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROPAGATE_TLS )
233 #define LDAP_BACK_TLS_CRITICAL(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_TLS_CRITICAL )
234 #define LDAP_BACK_CHASE_REFERRALS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_CHASE_REFERRALS )
235 #define LDAP_BACK_PROXY_WHOAMI(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROXY_WHOAMI )
237 #define LDAP_BACK_T_F(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
238 #define LDAP_BACK_T_F_DISCOVER(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
240 #define LDAP_BACK_MONITOR(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_MONITOR )
241 #define LDAP_BACK_SINGLECONN(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_SINGLECONN )
243 #define LDAP_BACK_ISOPEN(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_ISOPEN )
245 #define LDAP_BACK_ABANDON(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
246 #define LDAP_BACK_IGNORE(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
247 #define LDAP_BACK_CANCEL(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
248 #define LDAP_BACK_CANCEL_DISCOVER(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
252 ldap_avl_info_t li_conninfo;
254 slap_retry_info_t li_quarantine;
255 /* NOTE: quarantine uses the connection mutex */
256 sig_atomic_t li_isquarantined;
257 #define LDAP_BACK_FQ_NO (0)
258 #define LDAP_BACK_FQ_YES (1)
259 #define LDAP_BACK_FQ_RETRYING (2)
261 #define LDAP_BACK_QUARANTINE(li) ( (li)->li_quarantine.ri_num != NULL )
262 ldap_back_quarantine_f li_quarantine_func;
263 void *li_quarantine_arg;
265 time_t li_network_timeout;
267 time_t li_idle_timeout;
268 time_t li_timeout[ LDAP_BACK_OP_LAST ];
271 typedef enum ldap_back_send_t {
272 LDAP_BACK_DONTSEND = 0x00,
273 LDAP_BACK_SENDOK = 0x01,
274 LDAP_BACK_SENDERR = 0x02,
275 LDAP_BACK_SENDRESULT = (LDAP_BACK_SENDOK|LDAP_BACK_SENDERR),
276 LDAP_BACK_BINDING = 0x04,
277 LDAP_BACK_BIND_DONTSEND = (LDAP_BACK_BINDING),
278 LDAP_BACK_BIND_SOK = (LDAP_BACK_BINDING|LDAP_BACK_SENDOK),
279 LDAP_BACK_BIND_SERR = (LDAP_BACK_BINDING|LDAP_BACK_SENDERR),
280 LDAP_BACK_BIND_SRES = (LDAP_BACK_BINDING|LDAP_BACK_SENDRESULT)
283 /* define to use asynchronous StartTLS */
284 #define SLAP_STARTTLS_ASYNCHRONOUS
286 /* timeout to use when calling ldap_result() */
287 #define LDAP_BACK_RESULT_TIMEOUT (0)
288 #define LDAP_BACK_RESULT_UTIMEOUT (100000)
289 #define LDAP_BACK_TV_SET(tv) \
291 (tv)->tv_sec = LDAP_BACK_RESULT_TIMEOUT; \
292 (tv)->tv_usec = LDAP_BACK_RESULT_UTIMEOUT; \
297 #include "proto-ldap.h"
299 #endif /* SLAPD_LDAP_H */