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
29 typedef struct ldapconn_t {
31 #define LDAP_BACK_PCONN ((void *)0x0)
32 #define LDAP_BACK_PCONN_TLS ((void *)0x1)
33 #define LDAP_BACK_PCONN_ID(c) ((void *)(c) > LDAP_BACK_PCONN_TLS ? (c)->c_connid : -1)
35 #define LDAP_BACK_PCONN_SET(op) ((op)->o_conn->c_is_tls ? LDAP_BACK_PCONN_TLS : LDAP_BACK_PCONN)
36 #else /* ! HAVE_TLS */
37 #define LDAP_BACK_PCONN_SET(op) (LDAP_BACK_PCONN)
38 #endif /* ! HAVE_TLS */
41 struct berval lc_cred;
42 struct berval lc_bound_ndn;
43 struct berval lc_local_ndn;
45 #define LDAP_BACK_CONN_ISSET(lc,f) ((lc)->lc_lcflags & (f))
46 #define LDAP_BACK_CONN_SET(lc,f) ((lc)->lc_lcflags |= (f))
47 #define LDAP_BACK_CONN_CLEAR(lc,f) ((lc)->lc_lcflags &= ~(f))
48 #define LDAP_BACK_CONN_CPY(lc,f,mlc) \
50 if ( ((f) & (mlc)->lc_lcflags) == (f) ) { \
51 (lc)->lc_lcflags |= (f); \
53 (lc)->lc_lcflags &= ~(f); \
57 #define LDAP_BACK_FCONN_ISBOUND (0x00000001U)
58 #define LDAP_BACK_FCONN_ISANON (0x00000002U)
59 #define LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
60 #define LDAP_BACK_FCONN_ISPRIV (0x00000004U)
61 #define LDAP_BACK_FCONN_ISTLS (0x00000008U)
62 #define LDAP_BACK_FCONN_BINDING (0x00000010U)
63 #define LDAP_BACK_FCONN_TAINTED (0x00000020U)
65 /* 0x00FF0000 are reserved for back-meta */
67 #define LDAP_BACK_CONN_ISBOUND(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
68 #define LDAP_BACK_CONN_ISBOUND_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
69 #define LDAP_BACK_CONN_ISBOUND_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISBMASK)
70 #define LDAP_BACK_CONN_ISBOUND_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISBOUND, (mlc))
71 #define LDAP_BACK_CONN_ISANON(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISANON)
72 #define LDAP_BACK_CONN_ISANON_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISANON)
73 #define LDAP_BACK_CONN_ISANON_CLEAR(lc) LDAP_BACK_CONN_ISBOUND_CLEAR((lc))
74 #define LDAP_BACK_CONN_ISANON_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISANON, (mlc))
75 #define LDAP_BACK_CONN_ISPRIV(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISPRIV)
76 #define LDAP_BACK_CONN_ISPRIV_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISPRIV)
77 #define LDAP_BACK_CONN_ISPRIV_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISPRIV)
78 #define LDAP_BACK_CONN_ISPRIV_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISPRIV, (mlc))
79 #define LDAP_BACK_CONN_ISTLS(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISTLS)
80 #define LDAP_BACK_CONN_ISTLS_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISTLS)
81 #define LDAP_BACK_CONN_ISTLS_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISTLS)
82 #define LDAP_BACK_CONN_ISTLS_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISTLS, (mlc))
83 #define LDAP_BACK_CONN_BINDING(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_BINDING)
84 #define LDAP_BACK_CONN_BINDING_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_BINDING)
85 #define LDAP_BACK_CONN_BINDING_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_BINDING)
86 #define LDAP_BACK_CONN_TAINTED(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_TAINTED)
87 #define LDAP_BACK_CONN_TAINTED_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_TAINTED)
88 #define LDAP_BACK_CONN_TAINTED_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_TAINTED)
93 time_t lc_create_time;
98 * identity assertion modes
101 LDAP_BACK_IDASSERT_LEGACY = 1,
102 LDAP_BACK_IDASSERT_NOASSERT,
103 LDAP_BACK_IDASSERT_ANONYMOUS,
104 LDAP_BACK_IDASSERT_SELF,
105 LDAP_BACK_IDASSERT_OTHERDN,
106 LDAP_BACK_IDASSERT_OTHERID
110 * operation enumeration for timeouts
113 LDAP_BACK_OP_ADD = 0,
120 typedef struct ldap_avl_info_t {
121 ldap_pvt_thread_mutex_t lai_mutex;
125 typedef struct slap_retry_info_t {
132 #define SLAP_RETRYNUM_FOREVER (-1) /* retry forever */
133 #define SLAP_RETRYNUM_TAIL (-2) /* end of retrynum array */
134 #define SLAP_RETRYNUM_VALID(n) ((n) >= SLAP_RETRYNUM_FOREVER) /* valid retrynum */
135 #define SLAP_RETRYNUM_FINITE(n) ((n) > SLAP_RETRYNUM_FOREVER) /* not forever */
138 typedef struct ldapinfo_t {
139 /* li_uri: the string that goes into ldap_initialize()
140 * TODO: use li_acl.sb_uri instead */
142 /* li_bvuri: an array of each single URI that is equivalent;
143 * to be checked for the presence of a certain item */
145 ldap_pvt_thread_mutex_t li_uri_mutex;
147 LDAP_REBIND_PROC *li_rebind_f;
148 LDAP_URLLIST_PROC *li_urllist_f;
151 slap_bindconf li_acl;
152 #define li_acl_authcID li_acl.sb_authcId
153 #define li_acl_authcDN li_acl.sb_binddn
154 #define li_acl_passwd li_acl.sb_cred
155 #define li_acl_authzID li_acl.sb_authzId
156 #define li_acl_authmethod li_acl.sb_method
157 #define li_acl_sasl_mech li_acl.sb_saslmech
158 #define li_acl_sasl_realm li_acl.sb_realm
159 #define li_acl_secprops li_acl.sb_secprops
161 /* ID assert stuff */
162 int li_idassert_mode;
164 slap_bindconf li_idassert;
165 #define li_idassert_authcID li_idassert.sb_authcId
166 #define li_idassert_authcDN li_idassert.sb_binddn
167 #define li_idassert_passwd li_idassert.sb_cred
168 #define li_idassert_authzID li_idassert.sb_authzId
169 #define li_idassert_authmethod li_idassert.sb_method
170 #define li_idassert_sasl_mech li_idassert.sb_saslmech
171 #define li_idassert_sasl_realm li_idassert.sb_realm
172 #define li_idassert_secprops li_idassert.sb_secprops
174 unsigned li_idassert_flags;
175 #define LDAP_BACK_AUTH_NONE 0x00U
176 #define LDAP_BACK_AUTH_NATIVE_AUTHZ 0x01U
177 #define LDAP_BACK_AUTH_OVERRIDE 0x02U
178 #define LDAP_BACK_AUTH_PRESCRIPTIVE 0x04U
179 #define LDAP_BACK_AUTH_OBSOLETE_PROXY_AUTHZ 0x08U
180 #define LDAP_BACK_AUTH_OBSOLETE_ENCODING_WORKAROUND 0x10U
182 BerVarray li_idassert_authz;
183 /* end of ID assert stuff */
186 #define LDAP_BACK_RETRY_UNDEFINED (-2)
187 #define LDAP_BACK_RETRY_FOREVER (-1)
188 #define LDAP_BACK_RETRY_NEVER (0)
189 #define LDAP_BACK_RETRY_DEFAULT (3)
192 #define LDAP_BACK_F_NONE (0x0000U)
193 #define LDAP_BACK_F_SAVECRED (0x0001U)
194 #define LDAP_BACK_F_USE_TLS (0x0002U)
195 #define LDAP_BACK_F_PROPAGATE_TLS (0x0004U)
196 #define LDAP_BACK_F_TLS_CRITICAL (0x0008U)
197 #define LDAP_BACK_F_TLS_USE_MASK (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
198 #define LDAP_BACK_F_TLS_PROPAGATE_MASK (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
199 #define LDAP_BACK_F_TLS_MASK (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
200 #define LDAP_BACK_F_CHASE_REFERRALS (0x0010U)
201 #define LDAP_BACK_F_PROXY_WHOAMI (0x0020U)
203 #define LDAP_BACK_F_T_F (0x0040U)
204 #define LDAP_BACK_F_T_F_DISCOVER (0x0080U)
205 #define LDAP_BACK_F_T_F_MASK (LDAP_BACK_F_T_F)
206 #define LDAP_BACK_F_T_F_MASK2 (LDAP_BACK_F_T_F_MASK|LDAP_BACK_F_T_F_DISCOVER)
208 #define LDAP_BACK_F_MONITOR (0x0100U)
209 #define LDAP_BACK_F_SINGLECONN (0x0200U)
211 #define LDAP_BACK_F_ISOPEN (0x0400U)
213 #define LDAP_BACK_F_CANCEL_ABANDON (0x0000U)
214 #define LDAP_BACK_F_CANCEL_IGNORE (0x1000U)
215 #define LDAP_BACK_F_CANCEL_EXOP (0x2000U)
216 #define LDAP_BACK_F_CANCEL_EXOP_DISCOVER (0x4000U)
217 #define LDAP_BACK_F_CANCEL_MASK (LDAP_BACK_F_CANCEL_IGNORE|LDAP_BACK_F_CANCEL_EXOP)
218 #define LDAP_BACK_F_CANCEL_MASK2 (LDAP_BACK_F_CANCEL_MASK|LDAP_BACK_F_CANCEL_EXOP_DISCOVER)
220 #define LDAP_BACK_ISSET(li,f) ( ( (li)->li_flags & (f) ) == (f) )
221 #define LDAP_BACK_ISMASK(li,m,f) ( ( (li)->li_flags & (m) ) == (f) )
223 #define LDAP_BACK_SAVECRED(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_SAVECRED )
224 #define LDAP_BACK_USE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_USE_TLS )
225 #define LDAP_BACK_PROPAGATE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROPAGATE_TLS )
226 #define LDAP_BACK_TLS_CRITICAL(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_TLS_CRITICAL )
227 #define LDAP_BACK_CHASE_REFERRALS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_CHASE_REFERRALS )
228 #define LDAP_BACK_PROXY_WHOAMI(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROXY_WHOAMI )
230 #define LDAP_BACK_T_F(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F )
231 #define LDAP_BACK_T_F_DISCOVER(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER )
233 #define LDAP_BACK_MONITOR(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_MONITOR )
234 #define LDAP_BACK_SINGLECONN(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_SINGLECONN )
236 #define LDAP_BACK_ISOPEN(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_ISOPEN )
238 #define LDAP_BACK_ABANDON(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON )
239 #define LDAP_BACK_IGNORE(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE )
240 #define LDAP_BACK_CANCEL(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP )
241 #define LDAP_BACK_CANCEL_DISCOVER(li) LDAP_BACK_ISMASK( (li), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER )
245 ldap_avl_info_t li_conninfo;
247 slap_retry_info_t li_quarantine;
248 /* NOTE: quarantine uses the connection mutex */
249 sig_atomic_t li_isquarantined;
250 #define LDAP_BACK_FQ_NO (0)
251 #define LDAP_BACK_FQ_YES (1)
252 #define LDAP_BACK_FQ_RETRYING (2)
254 #define LDAP_BACK_QUARANTINE(li) ( (li)->li_quarantine.ri_num != NULL )
256 time_t li_network_timeout;
258 time_t li_idle_timeout;
259 time_t li_timeout[ LDAP_BACK_OP_LAST ];
262 typedef enum ldap_back_send_t {
263 LDAP_BACK_DONTSEND = 0x00,
264 LDAP_BACK_SENDOK = 0x01,
265 LDAP_BACK_SENDERR = 0x02,
266 LDAP_BACK_SENDRESULT = (LDAP_BACK_SENDOK|LDAP_BACK_SENDERR),
267 LDAP_BACK_BINDING = 0x04,
268 LDAP_BACK_BIND_DONTSEND = (LDAP_BACK_BINDING),
269 LDAP_BACK_BIND_SOK = (LDAP_BACK_BINDING|LDAP_BACK_SENDOK),
270 LDAP_BACK_BIND_SERR = (LDAP_BACK_BINDING|LDAP_BACK_SENDERR),
271 LDAP_BACK_BIND_SRES = (LDAP_BACK_BINDING|LDAP_BACK_SENDRESULT)
274 /* define to use asynchronous StartTLS */
275 #define SLAP_STARTTLS_ASYNCHRONOUS
277 /* timeout to use when calling ldap_result() */
278 #define LDAP_BACK_RESULT_TIMEOUT (0)
279 #define LDAP_BACK_RESULT_UTIMEOUT (100000)
280 #define LDAP_BACK_TV_SET(tv) \
282 (tv)->tv_sec = LDAP_BACK_RESULT_TIMEOUT; \
283 (tv)->tv_usec = LDAP_BACK_RESULT_UTIMEOUT; \
288 #include "proto-ldap.h"
290 #endif /* SLAPD_LDAP_H */