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 (0x01)
58 #define LDAP_BACK_FCONN_ISANON (0x02)
59 #define LDAP_BACK_FCONN_ISBMASK (LDAP_BACK_FCONN_ISBOUND|LDAP_BACK_FCONN_ISANON)
60 #define LDAP_BACK_FCONN_ISPRIV (0x04)
61 #define LDAP_BACK_FCONN_ISTLS (0x08)
62 #define LDAP_BACK_FCONN_BINDING (0x10)
64 #define LDAP_BACK_CONN_ISBOUND(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISBOUND)
65 #define LDAP_BACK_CONN_ISBOUND_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISBOUND)
66 #define LDAP_BACK_CONN_ISBOUND_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISBMASK)
67 #define LDAP_BACK_CONN_ISBOUND_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISBOUND, (mlc))
68 #define LDAP_BACK_CONN_ISANON(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISANON)
69 #define LDAP_BACK_CONN_ISANON_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISANON)
70 #define LDAP_BACK_CONN_ISANON_CLEAR(lc) LDAP_BACK_CONN_ISBOUND_CLEAR((lc))
71 #define LDAP_BACK_CONN_ISANON_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISANON, (mlc))
72 #define LDAP_BACK_CONN_ISPRIV(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISPRIV)
73 #define LDAP_BACK_CONN_ISPRIV_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISPRIV)
74 #define LDAP_BACK_CONN_ISPRIV_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISPRIV)
75 #define LDAP_BACK_CONN_ISPRIV_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISPRIV, (mlc))
76 #define LDAP_BACK_CONN_ISTLS(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_ISTLS)
77 #define LDAP_BACK_CONN_ISTLS_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_ISTLS)
78 #define LDAP_BACK_CONN_ISTLS_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_ISTLS)
79 #define LDAP_BACK_CONN_ISTLS_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), LDAP_BACK_FCONN_ISTLS, (mlc))
80 #define LDAP_BACK_CONN_BINDING(lc) LDAP_BACK_CONN_ISSET((lc), LDAP_BACK_FCONN_BINDING)
81 #define LDAP_BACK_CONN_BINDING_SET(lc) LDAP_BACK_CONN_SET((lc), LDAP_BACK_FCONN_BINDING)
82 #define LDAP_BACK_CONN_BINDING_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), LDAP_BACK_FCONN_BINDING)
90 * identity assertion modes
93 LDAP_BACK_IDASSERT_LEGACY = 1,
94 LDAP_BACK_IDASSERT_NOASSERT,
95 LDAP_BACK_IDASSERT_ANONYMOUS,
96 LDAP_BACK_IDASSERT_SELF,
97 LDAP_BACK_IDASSERT_OTHERDN,
98 LDAP_BACK_IDASSERT_OTHERID
102 * operation enumeration for timeouts
105 LDAP_BACK_OP_ADD = 0,
112 typedef struct ldap_avl_info_t {
113 ldap_pvt_thread_mutex_t lai_mutex;
117 typedef struct ldapinfo_t {
118 /* li_uri: the string that goes into ldap_initialize()
119 * TODO: use li_acl.sb_uri instead */
121 /* li_bvuri: an array of each single URI that is equivalent;
122 * to be checked for the presence of a certain item */
125 slap_bindconf li_acl;
126 #define li_acl_authcID li_acl.sb_authcId
127 #define li_acl_authcDN li_acl.sb_binddn
128 #define li_acl_passwd li_acl.sb_cred
129 #define li_acl_authzID li_acl.sb_authzId
130 #define li_acl_authmethod li_acl.sb_method
131 #define li_acl_sasl_mech li_acl.sb_saslmech
132 #define li_acl_sasl_realm li_acl.sb_realm
133 #define li_acl_secprops li_acl.sb_secprops
135 /* ID assert stuff */
136 int li_idassert_mode;
138 slap_bindconf li_idassert;
139 #define li_idassert_authcID li_idassert.sb_authcId
140 #define li_idassert_authcDN li_idassert.sb_binddn
141 #define li_idassert_passwd li_idassert.sb_cred
142 #define li_idassert_authzID li_idassert.sb_authzId
143 #define li_idassert_authmethod li_idassert.sb_method
144 #define li_idassert_sasl_mech li_idassert.sb_saslmech
145 #define li_idassert_sasl_realm li_idassert.sb_realm
146 #define li_idassert_secprops li_idassert.sb_secprops
148 unsigned li_idassert_flags;
149 #define LDAP_BACK_AUTH_NONE 0x00U
150 #define LDAP_BACK_AUTH_NATIVE_AUTHZ 0x01U
151 #define LDAP_BACK_AUTH_OVERRIDE 0x02U
152 #define LDAP_BACK_AUTH_PRESCRIPTIVE 0x04U
154 BerVarray li_idassert_authz;
155 /* end of ID assert stuff */
158 #define LDAP_BACK_RETRY_UNDEFINED (-2)
159 #define LDAP_BACK_RETRY_FOREVER (-1)
160 #define LDAP_BACK_RETRY_NEVER (0)
161 #define LDAP_BACK_RETRY_DEFAULT (3)
164 #define LDAP_BACK_F_NONE 0x00U
165 #define LDAP_BACK_F_SAVECRED 0x01U
166 #define LDAP_BACK_F_USE_TLS 0x02U
167 #define LDAP_BACK_F_PROPAGATE_TLS 0x04U
168 #define LDAP_BACK_F_TLS_CRITICAL 0x08U
169 #define LDAP_BACK_F_TLS_USE_MASK (LDAP_BACK_F_USE_TLS|LDAP_BACK_F_TLS_CRITICAL)
170 #define LDAP_BACK_F_TLS_PROPAGATE_MASK (LDAP_BACK_F_PROPAGATE_TLS|LDAP_BACK_F_TLS_CRITICAL)
171 #define LDAP_BACK_F_TLS_MASK (LDAP_BACK_F_TLS_USE_MASK|LDAP_BACK_F_TLS_PROPAGATE_MASK)
172 #define LDAP_BACK_F_CHASE_REFERRALS 0x10U
173 #define LDAP_BACK_F_PROXY_WHOAMI 0x20U
175 #define LDAP_BACK_F_SUPPORT_T_F 0x80U
176 #define LDAP_BACK_F_SUPPORT_T_F_DISCOVER 0x40U
177 #define LDAP_BACK_F_SUPPORT_T_F_MASK (LDAP_BACK_F_SUPPORT_T_F|LDAP_BACK_F_SUPPORT_T_F_DISCOVER)
179 #define LDAP_BACK_ISSET(li,f) ( ( (li)->li_flags & (f) ) == (f) )
180 #define LDAP_BACK_SAVECRED(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_SAVECRED )
181 #define LDAP_BACK_USE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_USE_TLS )
182 #define LDAP_BACK_PROPAGATE_TLS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROPAGATE_TLS )
183 #define LDAP_BACK_TLS_CRITICAL(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_TLS_CRITICAL )
184 #define LDAP_BACK_CHASE_REFERRALS(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_CHASE_REFERRALS )
185 #define LDAP_BACK_PROXY_WHOAMI(li) LDAP_BACK_ISSET( (li), LDAP_BACK_F_PROXY_WHOAMI )
189 ldap_avl_info_t li_conninfo;
191 time_t li_network_timeout;
192 time_t li_idle_timeout;
193 time_t li_timeout[ LDAP_BACK_OP_LAST ];
196 typedef enum ldap_back_send_t {
197 LDAP_BACK_DONTSEND = 0x00,
198 LDAP_BACK_SENDOK = 0x01,
199 LDAP_BACK_SENDERR = 0x02,
200 LDAP_BACK_SENDRESULT = (LDAP_BACK_SENDOK|LDAP_BACK_SENDERR),
201 LDAP_BACK_BINDING = 0x04,
202 LDAP_BACK_BIND_DONTSEND = (LDAP_BACK_BINDING),
203 LDAP_BACK_BIND_SOK = (LDAP_BACK_BINDING|LDAP_BACK_SENDOK),
204 LDAP_BACK_BIND_SERR = (LDAP_BACK_BINDING|LDAP_BACK_SENDERR),
205 LDAP_BACK_BIND_SRES = (LDAP_BACK_BINDING|LDAP_BACK_SENDRESULT)
208 /* define to use asynchronous StartTLS */
209 #define SLAP_STARTTLS_ASYNCHRONOUS
211 /* timeout to use when calling ldap_result() */
212 #define LDAP_BACK_RESULT_TIMEOUT (0)
213 #define LDAP_BACK_RESULT_UTIMEOUT (100000)
214 #define LDAP_BACK_TV_SET(tv) \
216 (tv)->tv_sec = LDAP_BACK_RESULT_TIMEOUT; \
217 (tv)->tv_usec = LDAP_BACK_RESULT_UTIMEOUT; \
222 #include "proto-ldap.h"
224 #endif /* SLAPD_LDAP_H */