1 /* ldap-int.h - defines & prototypes internal to the LDAP library */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2004 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17 * All rights reserved.
24 #define LDAP_THREAD_SAFE 1
27 #include "../liblber/lber-int.h"
30 #include <ldap_pvt_thread.h>
33 #ifdef HAVE_CYRUS_SASL
34 /* the need for this should be removed */
35 #ifdef HAVE_SASL_SASL_H
36 #include <sasl/sasl.h>
41 #define SASL_MAX_BUFF_SIZE 65536
42 #define SASL_MIN_BUFF_SIZE 4096
46 #define TV2MILLISEC(tv) (((tv)->sec * 1000) + ((tv)->tv_usec/1000))
49 * Support needed if the library is running in the kernel
51 #if LDAP_INT_IN_KERNEL
53 * Platform specific function to return a pointer to the
54 * process-specific global options.
56 * This function should perform the following functions:
57 * Allocate and initialize a global options struct on a per process basis
58 * Use callers process identifier to return its global options struct
59 * Note: Deallocate structure when the process exits
61 # define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
62 struct ldapoptions *ldap_int_global_opt(void);
64 # define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
67 #define ldap_debug ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
75 #define Debug( level, fmt, arg1, arg2, arg3 ) \
76 do { if ( ldap_debug & level ) \
77 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
80 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
81 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
85 #define Debug( level, fmt, arg1, arg2, arg3 ) ((void)0)
86 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 ) ((void)0)
88 #endif /* LDAP_DEBUG */
90 #define LDAP_DEPRECATED 1
97 #define LDAP_URL_PREFIX "ldap://"
98 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
99 #define LDAPS_URL_PREFIX "ldaps://"
100 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
101 #define LDAPI_URL_PREFIX "ldapi://"
102 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
103 #ifdef LDAP_CONNECTIONLESS
104 #define LDAPC_URL_PREFIX "cldap://"
105 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
107 #define LDAP_URL_URLCOLON "URL:"
108 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
110 #define LDAP_REF_STR "Referral:\n"
111 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
112 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
113 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
115 #define LDAP_DEFAULT_REFHOPLIMIT 5
117 #define LDAP_BOOL_REFERRALS 0
118 #define LDAP_BOOL_RESTART 1
119 #define LDAP_BOOL_TLS 3
121 #define LDAP_BOOLEANS unsigned long
122 #define LDAP_BOOL(n) (1 << (n))
123 #define LDAP_BOOL_GET(lo, bool) \
124 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
125 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
126 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
127 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
130 * This structure represents both ldap messages and ldap responses.
131 * These are really the same, except in the case of search responses,
132 * where a response has multiple messages.
136 ber_int_t lm_msgid; /* the message id */
137 ber_tag_t lm_msgtype; /* the message type */
138 BerElement *lm_ber; /* the ber encoded message contents */
139 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
140 struct ldapmsg *lm_next; /* next response */
141 time_t lm_time; /* used to maintain cache */
145 * structure representing get/set'able options
146 * which have global defaults.
150 #define LDAP_UNINITIALIZED 0x0
151 #define LDAP_INITIALIZED 0x1
152 #define LDAP_VALID_SESSION 0x2
154 #ifdef LDAP_CONNECTIONLESS
155 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
156 void* ldo_peer; /* struct sockaddr* */
161 /* per API call timeout */
162 struct timeval *ldo_tm_api;
163 struct timeval *ldo_tm_net;
165 ber_int_t ldo_version;
167 ber_int_t ldo_timelimit;
168 ber_int_t ldo_sizelimit;
174 LDAPURLDesc *ldo_defludp;
177 char* ldo_defbinddn; /* bind dn */
179 #ifdef HAVE_CYRUS_SASL
180 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
181 char* ldo_def_sasl_realm; /* SASL realm */
182 char* ldo_def_sasl_authcid; /* SASL authentication identity */
183 char* ldo_def_sasl_authzid; /* SASL authorization identity */
185 /* SASL Security Properties */
186 struct sasl_security_properties ldo_sasl_secprops;
189 int ldo_refhoplimit; /* limit on referral nesting */
191 /* LDAPv3 server and client controls */
192 LDAPControl **ldo_sctrls;
193 LDAPControl **ldo_cctrls;
195 /* LDAP rebind callback function */
196 LDAP_REBIND_PROC *ldo_rebind_proc;
197 void *ldo_rebind_params;
199 LDAP_BOOLEANS ldo_booleans; /* boolean options */
204 * structure for representing an LDAP server connection
206 typedef struct ldap_conn {
212 #ifdef HAVE_CYRUS_SASL
213 void *lconn_sasl_authctx; /* context for bind */
214 void *lconn_sasl_sockctx; /* for security layer */
217 time_t lconn_lastused; /* time */
218 int lconn_rebind_inprogress; /* set if rebind in progress */
219 char ***lconn_rebind_queue; /* used if rebind in progress */
221 #define LDAP_CONNST_NEEDSOCKET 1
222 #define LDAP_CONNST_CONNECTING 2
223 #define LDAP_CONNST_CONNECTED 3
224 LDAPURLDesc *lconn_server;
225 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
226 char *lconn_krbinstance;
228 BerElement *lconn_ber; /* ber receiving on this conn. */
230 struct ldap_conn *lconn_next;
235 * structure used to track outstanding requests
237 typedef struct ldapreq {
238 ber_int_t lr_msgid; /* the message id */
239 int lr_status; /* status of request */
240 #define LDAP_REQST_COMPLETED 0
241 #define LDAP_REQST_INPROGRESS 1
242 #define LDAP_REQST_CHASINGREFS 2
243 #define LDAP_REQST_NOTCONNECTED 3
244 #define LDAP_REQST_WRITING 4
245 int lr_outrefcnt; /* count of outstanding referrals */
246 ber_int_t lr_origid; /* original request's message id */
247 int lr_parentcnt; /* count of parent requests */
248 ber_tag_t lr_res_msgtype; /* result message type */
249 ber_int_t lr_res_errno; /* result LDAP errno */
250 char *lr_res_error; /* result error string */
251 char *lr_res_matched;/* result matched DN string */
252 BerElement *lr_ber; /* ber encoded request contents */
253 LDAPConn *lr_conn; /* connection used to send request */
254 struct ldapreq *lr_parent; /* request that spawned this referral */
255 struct ldapreq *lr_child; /* first child request */
256 struct ldapreq *lr_refnext; /* next referral spawned */
257 struct ldapreq *lr_prev; /* previous request */
258 struct ldapreq *lr_next; /* next request */
262 * structure for client cache
264 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
265 typedef struct ldapcache {
266 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
267 LDAPMessage *lc_requests; /* unfulfilled reqs */
268 long lc_timeout; /* request timeout */
269 ber_len_t lc_maxmem; /* memory to use */
270 ber_len_t lc_memused; /* memory in use */
271 int lc_enabled; /* enabled? */
272 unsigned long lc_options; /* options */
273 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
274 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
278 * structure containing referral request info for rebind procedure
280 typedef struct ldapreqinfo {
287 * structure representing an ldap connection
291 Sockbuf *ld_sb; /* socket descriptor & buffer */
293 struct ldapoptions ld_options;
295 #define ld_valid ld_options.ldo_valid
296 #define ld_debug ld_options.ldo_debug
298 #define ld_deref ld_options.ldo_deref
299 #define ld_timelimit ld_options.ldo_timelimit
300 #define ld_sizelimit ld_options.ldo_sizelimit
302 #define ld_defbinddn ld_options.ldo_defbinddn
303 #define ld_defbase ld_options.ldo_defbase
304 #define ld_defhost ld_options.ldo_defhost
305 #define ld_defport ld_options.ldo_defport
307 #define ld_refhoplimit ld_options.ldo_refhoplimit
309 #define ld_sctrls ld_options.ldo_sctrls
310 #define ld_cctrls ld_options.ldo_cctrls
311 #define ld_rebind_proc ld_options.ldo_rebind_proc
312 #define ld_rebind_params ld_options.ldo_rebind_params
314 #define ld_version ld_options.ldo_version
316 unsigned short ld_lberoptions;
324 /* do not mess with these */
325 LDAPRequest *ld_requests; /* list of outstanding requests */
326 LDAPMessage *ld_responses; /* list of outstanding responses */
328 #ifdef LDAP_R_COMPILE
329 ldap_pvt_thread_mutex_t ld_req_mutex;
330 ldap_pvt_thread_mutex_t ld_res_mutex;
333 ber_int_t *ld_abandoned; /* array of abandoned requests */
335 LDAPCache *ld_cache; /* non-null if cache is initialized */
337 /* do not mess with the rest though */
339 LDAPConn *ld_defconn; /* default connection */
340 LDAPConn *ld_conns; /* list of server connections */
341 void *ld_selectinfo; /* platform specifics for select */
343 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
345 #ifdef LDAP_R_COMPILE
346 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
348 #ifdef HAVE_CYRUS_SASL
349 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
353 #ifdef LDAP_R_COMPILE
354 #define LDAP_NEXT_MSGID(ld, id) \
355 ldap_pvt_thread_mutex_lock( &(ld)->ld_req_mutex ); \
356 id = ++(ld)->ld_msgid; \
357 ldap_pvt_thread_mutex_unlock( &(ld)->ld_req_mutex )
359 #define LDAP_NEXT_MSGID(ld, id) id = ++(ld)->ld_msgid
366 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
368 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
369 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
370 struct ldapoptions *, int *));
373 /* simple macros to realloc for now */
374 #define LDAP_MALLOC(s) (ber_memalloc_x((s),NULL))
375 #define LDAP_CALLOC(n,s) (ber_memcalloc_x((n),(s),NULL))
376 #define LDAP_REALLOC(p,s) (ber_memrealloc_x((p),(s),NULL))
377 #define LDAP_FREE(p) (ber_memfree_x((p),NULL))
378 #define LDAP_VFREE(v) (ber_memvfree_x((void **)(v),NULL))
379 #define LDAP_STRDUP(s) (ber_strdup_x((s),NULL))
380 #define LDAP_STRNDUP(s,l) (ber_strndup_x((s),(l),NULL))
382 #define LDAP_MALLOCX(s,x) (ber_memalloc_x((s),(x)))
383 #define LDAP_CALLOCX(n,s,x) (ber_memcalloc_x((n),(s),(x)))
384 #define LDAP_REALLOCX(p,s,x) (ber_memrealloc_x((p),(s),(x)))
385 #define LDAP_FREEX(p,x) (ber_memfree_x((p),(x)))
386 #define LDAP_VFREEX(v,x) (ber_memvfree_x((void **)(v),(x)))
387 #define LDAP_STRDUPX(s,x) (ber_strdup_x((s),(x)))
388 #define LDAP_STRNDUPX(s,l,x) (ber_strndup_x((s),(l),(x)))
393 LDAP_F (void) ldap_int_error_init( void );
398 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
404 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
409 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
410 BerElement *request ));
411 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
412 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
417 LDAP_F (int) ldap_int_put_controls LDAP_P((
419 LDAPControl *const *ctrls,
422 LDAP_F (int) ldap_int_client_controls LDAP_P((
424 LDAPControl **ctrlp ));
429 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
431 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
435 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
437 LDAP_CONST char *who,
438 LDAP_CONST char *service,
441 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
447 LDAP_F (int) ldap_open_defconn( LDAP *ld );
448 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
449 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
455 LDAP_V (int) ldap_int_tblsize;
456 LDAP_F (void) ldap_int_ip_init( void );
459 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
460 const struct timeval *tm );
461 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
462 int proto, const char *host, int port, int async );
464 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
465 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
466 LDAP_V (char *) ldap_int_hostname;
467 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
471 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
472 LDAP_F (void *) ldap_new_select_info( void );
473 LDAP_F (void) ldap_free_select_info( void *sip );
474 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
475 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
476 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
477 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
478 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
484 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
485 const char *path, int async );
486 #endif /* LDAP_PF_LOCAL */
491 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
492 const char *dn, BerElement *ber, ber_int_t msgid );
493 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
494 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
496 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
497 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
498 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
499 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
500 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
501 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
502 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
503 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
504 char **errstrp, int sref, int *hadrefp );
505 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
506 char **refs, int sref, char **referralsp, int *hadrefp );
507 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
508 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
513 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
518 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
525 LDAPControl **sctrls,
526 LDAPControl **cctrls,
535 LDAP_F (int) ldap_ld_free LDAP_P((
538 LDAPControl **sctrls,
539 LDAPControl **cctrls ));
541 LDAP_F (int) ldap_send_unbind LDAP_P((
544 LDAPControl **sctrls,
545 LDAPControl **cctrls ));
550 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
551 LDAPURLDesc *ludp ));
553 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
554 LDAPURLDesc *ludlist ));
556 LDAP_F (int) ldap_url_parselist LDAP_P((
557 LDAPURLDesc **ludlist,
560 LDAP_F (int) ldap_url_parselist_ext LDAP_P((
561 LDAPURLDesc **ludlist,
565 LDAP_F (int) ldap_url_parsehosts LDAP_P((
566 LDAPURLDesc **ludlist,
570 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
571 LDAPURLDesc *ludlist ));
573 LDAP_F (char *) ldap_url_list2urls LDAP_P((
574 LDAPURLDesc *ludlist ));
576 LDAP_F (void) ldap_free_urllist LDAP_P((
577 LDAPURLDesc *ludlist ));
583 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
585 LDAP_F (int) ldap_int_sasl_open LDAP_P((
586 LDAP *ld, LDAPConn *conn,
588 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
590 LDAP_F (int) ldap_int_sasl_external LDAP_P((
591 LDAP *ld, LDAPConn *conn,
592 const char* authid, ber_len_t ssf ));
594 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
595 int option, void *arg ));
596 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
597 int option, void *arg ));
598 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
599 int option, const char *arg ));
601 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
605 LDAPControl **, LDAPControl **,
607 /* should be passed in client controls */
609 LDAP_SASL_INTERACT_PROC *interact,
613 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
621 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
622 int option, const char *arg ));
624 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
625 LDAPConn *conn, LDAPURLDesc *srv ));
630 LDAP_F (char **) ldap_value_dup LDAP_P((
631 char *const *vals ));
635 #endif /* _LDAP_INT_H */