3 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1995 Regents of the University of Michigan.
10 * ldap-int.h - defines & prototypes internal to the LDAP library
17 #define LDAP_THREAD_SAFE 1
20 #include "../liblber/lber-int.h"
22 #define ldap_debug (ldap_int_global_options.ldo_debug)
27 #define Debug( level, fmt, arg1, arg2, arg3 ) \
28 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
36 #define LDAP_URL_PREFIX "ldap://"
37 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
38 #define LDAPS_URL_PREFIX "ldaps://"
39 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
40 #define LDAPI_URL_PREFIX "ldapi://"
41 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
42 #define LDAPIS_URL_PREFIX "ldapis://"
43 #define LDAPIS_URL_PREFIX_LEN (sizeof(LDAPIS_URL_PREFIX)-1)
44 #define LDAP_URL_URLCOLON "URL:"
45 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
46 #define NULLLDAPURLDESC ((LDAPURLDesc *)NULL)
48 #define LDAP_REF_STR "Referral:\n"
49 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
50 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
51 #define LDAP_LDAP_REF_STR_LEN (sizeof(LDAP_LDAP_REF_STR)-1)
54 #define LDAP_DEFAULT_REFHOPLIMIT 5
56 #define LDAP_BOOL_REFERRALS 0
57 #define LDAP_BOOL_RESTART 1
58 #define LDAP_BOOL_TLS 3
60 #define LDAP_BOOLEANS unsigned long
61 #define LDAP_BOOL(n) (1 << (n))
62 #define LDAP_BOOL_GET(lo, bool) ((lo)->ldo_booleans & LDAP_BOOL(bool) \
64 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
65 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
66 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
69 * This structure represents both ldap messages and ldap responses.
70 * These are really the same, except in the case of search responses,
71 * where a response has multiple messages.
75 ber_int_t lm_msgid; /* the message id */
76 ber_tag_t lm_msgtype; /* the message type */
77 BerElement *lm_ber; /* the ber encoded message contents */
78 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
79 struct ldapmsg *lm_next; /* next response */
80 time_t lm_time; /* used to maintain cache */
84 * structure representing get/set'able options
85 * which have global defaults.
89 #define LDAP_UNINITIALIZED 0x0
90 #define LDAP_INITIALIZED 0x1
91 #define LDAP_VALID_SESSION 0x2
94 /* per API call timeout */
95 struct timeval *ldo_tm_api;
96 struct timeval *ldo_tm_net;
98 ber_int_t ldo_version;
100 ber_int_t ldo_timelimit;
101 ber_int_t ldo_sizelimit;
103 LDAPURLDesc *ldo_defludp;
106 char* ldo_defbinddn; /* simple bind dn */
108 #ifdef LDAP_CONNECTIONLESS
109 int ldo_cldaptries; /* connectionless search retry count */
110 int ldo_cldaptimeout;/* time between retries */
113 int ldo_refhoplimit; /* limit on referral nesting */
115 /* LDAPv3 server and client controls */
116 LDAPControl **ldo_sctrls;
117 LDAPControl **ldo_cctrls;
118 /* LDAPV3 rebind callback function
120 LDAP_REBIND_PROC *ldo_rebindproc;
127 #ifdef HAVE_CYRUS_SASL
128 sasl_ssf_t ldo_sasl_minssf;
129 sasl_ssf_t ldo_sasl_maxssf;
131 LDAP_BOOLEANS ldo_booleans; /* boolean options */
136 * structure for tracking LDAP server host, ports, DNs, etc.
138 typedef struct ldap_server {
140 char *lsrv_dn; /* if NULL, use default */
142 /* int lsrv_protocol; */
143 struct ldap_server *lsrv_next;
148 * structure for representing an LDAP server connection
150 typedef struct ldap_conn {
153 time_t lconn_lastused; /* time */
154 int lconn_rebind_inprogress; /* set if rebind in progress */
155 char ***lconn_rebind_queue; /* used if rebind in progress */
157 #define LDAP_CONNST_NEEDSOCKET 1
158 #define LDAP_CONNST_CONNECTING 2
159 #define LDAP_CONNST_CONNECTED 3
160 LDAPURLDesc *lconn_server;
161 char *lconn_krbinstance;
162 struct ldap_conn *lconn_next;
163 BerElement *lconn_ber;/* ber receiving on this conn. */
168 * structure used to track outstanding requests
170 typedef struct ldapreq {
171 ber_int_t lr_msgid; /* the message id */
172 int lr_status; /* status of request */
173 #define LDAP_REQST_COMPLETED 0
174 #define LDAP_REQST_INPROGRESS 1
175 #define LDAP_REQST_CHASINGREFS 2
176 #define LDAP_REQST_NOTCONNECTED 3
177 #define LDAP_REQST_WRITING 4
178 int lr_outrefcnt; /* count of outstanding referrals */
179 ber_int_t lr_origid; /* original request's message id */
180 int lr_parentcnt; /* count of parent requests */
181 ber_tag_t lr_res_msgtype; /* result message type */
182 ber_int_t lr_res_errno; /* result LDAP errno */
183 char *lr_res_error; /* result error string */
184 char *lr_res_matched;/* result matched DN string */
185 BerElement *lr_ber; /* ber encoded request contents */
186 LDAPConn *lr_conn; /* connection used to send request */
187 struct ldapreq *lr_parent; /* request that spawned this referral */
188 struct ldapreq *lr_refnext; /* next referral spawned */
189 struct ldapreq *lr_prev; /* previous request */
190 struct ldapreq *lr_next; /* next request */
194 * structure for client cache
196 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
197 typedef struct ldapcache {
198 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
199 LDAPMessage *lc_requests; /* unfulfilled reqs */
200 long lc_timeout; /* request timeout */
201 ber_len_t lc_maxmem; /* memory to use */
202 ber_len_t lc_memused; /* memory in use */
203 int lc_enabled; /* enabled? */
204 unsigned long lc_options; /* options */
205 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
206 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
210 * structure containing referral request info for rebind procedure
212 typedef struct ldapreqinfo {
219 * handy macro for checking if handle is connectionless
222 #define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0)
225 * structure representing an ldap connection
229 Sockbuf *ld_sb; /* socket descriptor & buffer */
231 struct ldapoptions ld_options;
233 #define ld_valid ld_options.ldo_valid
234 #define ld_debug ld_options.ldo_debug
236 #define ld_deref ld_options.ldo_deref
237 #define ld_timelimit ld_options.ldo_timelimit
238 #define ld_sizelimit ld_options.ldo_sizelimit
240 #define ld_defbinddn ld_options.ldo_defbinddn
241 #define ld_defbase ld_options.ldo_defbase
242 #define ld_defhost ld_options.ldo_defhost
243 #define ld_defport ld_options.ldo_defport
245 #define ld_cldaptries ld_options.ldo_cldaptries
246 #define ld_cldaptimeout ld_options.ldo_cldaptimeout
247 #define ld_refhoplimit ld_options.ldo_refhoplimit
249 #define ld_sctrls ld_options.ldo_sctrls
250 #define ld_cctrls ld_options.ldo_cctrls
251 #define ld_rebindproc ld_options.ldo_rebindproc
253 #define ld_version ld_options.ldo_version
257 unsigned short ld_lberoptions;
259 LDAPFiltDesc *ld_filtd; /* from getfilter for ufn searches */
260 char *ld_ufnprefix; /* for incomplete ufn's */
267 /* do not mess with these */
268 LDAPRequest *ld_requests; /* list of outstanding requests */
269 LDAPMessage *ld_responses; /* list of outstanding responses */
271 ber_int_t *ld_abandoned; /* array of abandoned requests */
273 LDAPCache *ld_cache; /* non-null if cache is initialized */
274 /* stuff used by connectionless searches. */
276 char *ld_cldapdn; /* DN used in connectionless search */
277 int ld_cldapnaddr; /* number of addresses */
278 void **ld_cldapaddrs;/* addresses to send request to */
280 /* do not mess with the rest though */
282 LDAPConn *ld_defconn; /* default connection */
283 LDAPConn *ld_conns; /* list of server connections */
284 void *ld_selectinfo; /* platform specifics for select */
285 #ifdef HAVE_CYRUS_SASL
286 sasl_conn_t *ld_sasl_context;
287 #endif /* HAVE_CYRUS_SASL */
289 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
291 #if defined(HAVE_RES_QUERY) && defined(LDAP_R_COMPILE)
292 #include <ldap_pvt_thread.h>
293 extern ldap_pvt_thread_mutex_t ldap_int_resolv_mutex;
294 #endif /* HAVE_RES_QUERY && LDAP_R_COMPILE */
300 LIBLDAP_F ( struct ldapoptions ) ldap_int_global_options;
301 LIBLDAP_F ( void ) ldap_int_initialize LDAP_P((int *));
304 /* simple macros to realloc for now */
305 #define LDAP_INT_MALLOC(s) (LBER_MALLOC((s)))
306 #define LDAP_INT_CALLOC(n,s) (LBER_CALLOC((n),(s)))
307 #define LDAP_INT_REALLOC(p,s) (LBER_REALLOC((p),(s)))
308 #define LDAP_INT_FREE(p) (LBER_FREE((p)))
309 #define LDAP_INT_VFREE(v) (LBER_VFREE((void **)(v)))
310 #define LDAP_INT_STRDUP(s) (LBER_STRDUP((s)))
312 #define LDAP_MALLOC(s) (LBER_MALLOC((s)))
313 #define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s)))
314 #define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s)))
315 #define LDAP_FREE(p) (LBER_FREE((p)))
316 #define LDAP_VFREE(v) (LBER_VFREE((void **)(v)))
317 #define LDAP_STRDUP(s) (LBER_STRDUP((s)))
322 LIBLDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
328 LIBLDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
333 LIBLDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
334 BerElement *request ));
335 LIBLDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
336 LIBLDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
341 LIBLDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
342 const LDAPControl *ctrl ));
344 LIBLDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
345 LDAPControl *const *ctrls ));
347 LIBLDAP_F (int) ldap_int_get_controls LDAP_P((
349 LDAPControl ***ctrlsp));
351 LIBLDAP_F (int) ldap_int_put_controls LDAP_P((
353 LDAPControl *const *ctrls,
359 LIBLDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
361 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
365 LIBLDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
367 LDAP_CONST char *who,
368 LDAP_CONST char *service,
371 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
377 LIBLDAP_F (int) ldap_open_defconn( LDAP *ld );
378 LIBLDAP_F (int) open_ldap_connection( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srvlist, char **krbinstancep, int async );
383 LIBLDAP_F (int) ldap_int_tblsize;
384 LIBLDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
385 LIBLDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb, const char *host, unsigned long address, int port, int async );
387 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
388 LIBLDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
389 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
391 LIBLDAP_F (void) ldap_int_ip_init( void );
392 LIBLDAP_F (int) do_ldap_select( LDAP *ld, struct timeval *timeout );
393 LIBLDAP_F (void *) ldap_new_select_info( void );
394 LIBLDAP_F (void) ldap_free_select_info( void *sip );
395 LIBLDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
396 LIBLDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
397 LIBLDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
398 LIBLDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
399 LIBLDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
405 LIBLDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb, const char *path, int async );
406 #endif /* LDAP_PF_LOCAL */
411 LIBLDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
412 const char *dn, BerElement *ber );
413 LIBLDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
414 LIBLDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
416 LIBLDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
417 LIBLDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
418 LIBLDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
419 LIBLDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
420 LIBLDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
421 LIBLDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
422 LIBLDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
423 LIBLDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp );
424 LIBLDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, char **referralsp, int *hadrefp );
425 LIBLDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
430 #ifdef LDAP_CONNECTIONLESS
431 LIBLDAP_F (int) cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber );
437 LIBLDAP_F (BerElement *) ldap_build_search_req LDAP_P((
444 LDAPControl **sctrls,
445 LDAPControl **cctrls,
447 ber_int_t sizelimit ));
452 /* see <ac/string.h> */
457 LIBLDAP_F (int) ldap_ld_free LDAP_P((
460 LDAPControl **sctrls,
461 LDAPControl **cctrls ));
463 LIBLDAP_F (int) ldap_send_unbind LDAP_P((
466 LDAPControl **sctrls,
467 LDAPControl **cctrls ));
472 LIBLDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
473 LDAPURLDesc *ludp ));
475 LIBLDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
476 LDAPURLDesc *ludlist ));
478 LIBLDAP_F (int) ldap_url_parselist LDAP_P((
479 LDAPURLDesc **ludlist,
482 LIBLDAP_F (int) ldap_url_parsehosts LDAP_P((
483 LDAPURLDesc **ludlist,
484 const char *hosts ));
486 LIBLDAP_F (char *) ldap_url_list2hosts LDAP_P((
487 LDAPURLDesc *ludlist ));
489 LIBLDAP_F (char *) ldap_url_list2urls LDAP_P((
490 LDAPURLDesc *ludlist ));
492 LIBLDAP_F (void) ldap_free_urllist LDAP_P((
493 LDAPURLDesc *ludlist ));
498 #endif /* _LDAP_INT_H */