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-2005 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)->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) ((LDAP_BOOLEANS)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_chain_tail;
141 struct ldapmsg *lm_next; /* next response */
142 time_t lm_time; /* used to maintain cache */
146 * structure representing get/set'able options
147 * which have global defaults.
151 #define LDAP_UNINITIALIZED 0x0
152 #define LDAP_INITIALIZED 0x1
153 #define LDAP_VALID_SESSION 0x2
154 #define LDAP_TRASHED_SESSION 0xFF
156 #ifdef LDAP_CONNECTIONLESS
157 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
158 void* ldo_peer; /* struct sockaddr* */
163 /* per API call timeout */
164 struct timeval *ldo_tm_api;
165 struct timeval *ldo_tm_net;
167 ber_int_t ldo_version;
169 ber_int_t ldo_timelimit;
170 ber_int_t ldo_sizelimit;
176 LDAP_TLS_CONNECT_CB *ldo_tls_connect_cb;
177 void* ldo_tls_connect_arg;
180 LDAPURLDesc *ldo_defludp;
183 char* ldo_defbinddn; /* bind dn */
185 #ifdef HAVE_CYRUS_SASL
186 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
187 char* ldo_def_sasl_realm; /* SASL realm */
188 char* ldo_def_sasl_authcid; /* SASL authentication identity */
189 char* ldo_def_sasl_authzid; /* SASL authorization identity */
191 /* SASL Security Properties */
192 struct sasl_security_properties ldo_sasl_secprops;
195 int ldo_refhoplimit; /* limit on referral nesting */
197 /* LDAPv3 server and client controls */
198 LDAPControl **ldo_sctrls;
199 LDAPControl **ldo_cctrls;
201 /* LDAP rebind callback function */
202 LDAP_REBIND_PROC *ldo_rebind_proc;
203 void *ldo_rebind_params;
204 LDAP_NEXTREF_PROC *ldo_nextref_proc;
205 void *ldo_nextref_params;
207 LDAP_BOOLEANS ldo_booleans; /* boolean options */
212 * structure for representing an LDAP server connection
214 typedef struct ldap_conn {
216 #ifdef HAVE_CYRUS_SASL
217 void *lconn_sasl_authctx; /* context for bind */
218 void *lconn_sasl_sockctx; /* for security layer */
221 time_t lconn_lastused; /* time */
222 int lconn_rebind_inprogress; /* set if rebind in progress */
223 char ***lconn_rebind_queue; /* used if rebind in progress */
225 #define LDAP_CONNST_NEEDSOCKET 1
226 #define LDAP_CONNST_CONNECTING 2
227 #define LDAP_CONNST_CONNECTED 3
228 LDAPURLDesc *lconn_server;
229 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
230 char *lconn_krbinstance;
232 BerElement *lconn_ber; /* ber receiving on this conn. */
234 struct ldap_conn *lconn_next;
239 * structure used to track outstanding requests
241 typedef struct ldapreq {
242 ber_int_t lr_msgid; /* the message id */
243 int lr_status; /* status of request */
244 #define LDAP_REQST_COMPLETED 0
245 #define LDAP_REQST_INPROGRESS 1
246 #define LDAP_REQST_CHASINGREFS 2
247 #define LDAP_REQST_NOTCONNECTED 3
248 #define LDAP_REQST_WRITING 4
249 int lr_outrefcnt; /* count of outstanding referrals */
250 ber_int_t lr_origid; /* original request's message id */
251 int lr_parentcnt; /* count of parent requests */
252 ber_tag_t lr_res_msgtype; /* result message type */
253 ber_int_t lr_res_errno; /* result LDAP errno */
254 char *lr_res_error; /* result error string */
255 char *lr_res_matched;/* result matched DN string */
256 BerElement *lr_ber; /* ber encoded request contents */
257 LDAPConn *lr_conn; /* connection used to send request */
258 struct berval lr_dn; /* DN of request, in lr_ber */
259 struct ldapreq *lr_parent; /* request that spawned this referral */
260 struct ldapreq *lr_child; /* first child request */
261 struct ldapreq *lr_refnext; /* next referral spawned */
262 struct ldapreq *lr_prev; /* previous request */
263 struct ldapreq *lr_next; /* next request */
267 * structure for client cache
269 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
270 typedef struct ldapcache {
271 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
272 LDAPMessage *lc_requests; /* unfulfilled reqs */
273 long lc_timeout; /* request timeout */
274 ber_len_t lc_maxmem; /* memory to use */
275 ber_len_t lc_memused; /* memory in use */
276 int lc_enabled; /* enabled? */
277 unsigned long lc_options; /* options */
278 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
279 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
283 * structure containing referral request info for rebind procedure
285 typedef struct ldapreqinfo {
292 * structure representing an ldap connection
296 Sockbuf *ld_sb; /* socket descriptor & buffer */
298 struct ldapoptions ld_options;
300 #define ld_valid ld_options.ldo_valid
301 #define ld_debug ld_options.ldo_debug
303 #define ld_deref ld_options.ldo_deref
304 #define ld_timelimit ld_options.ldo_timelimit
305 #define ld_sizelimit ld_options.ldo_sizelimit
307 #define ld_defbinddn ld_options.ldo_defbinddn
308 #define ld_defbase ld_options.ldo_defbase
309 #define ld_defhost ld_options.ldo_defhost
310 #define ld_defport ld_options.ldo_defport
312 #define ld_refhoplimit ld_options.ldo_refhoplimit
314 #define ld_sctrls ld_options.ldo_sctrls
315 #define ld_cctrls ld_options.ldo_cctrls
316 #define ld_rebind_proc ld_options.ldo_rebind_proc
317 #define ld_rebind_params ld_options.ldo_rebind_params
318 #define ld_nextref_proc ld_options.ldo_nextref_proc
319 #define ld_nextref_params ld_options.ldo_nextref_params
321 #define ld_version ld_options.ldo_version
323 unsigned short ld_lberoptions;
331 /* do not mess with these */
332 LDAPRequest *ld_requests; /* list of outstanding requests */
333 LDAPMessage *ld_responses; /* list of outstanding responses */
335 #ifdef LDAP_R_COMPILE
336 ldap_pvt_thread_mutex_t ld_conn_mutex;
337 ldap_pvt_thread_mutex_t ld_req_mutex;
338 ldap_pvt_thread_mutex_t ld_res_mutex;
341 ber_int_t *ld_abandoned; /* array of abandoned requests */
343 LDAPCache *ld_cache; /* non-null if cache is initialized */
345 /* do not mess with the rest though */
347 LDAPConn *ld_defconn; /* default connection */
348 LDAPConn *ld_conns; /* list of server connections */
349 void *ld_selectinfo; /* platform specifics for select */
351 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
352 #define LDAP_TRASHED(ld) ( (ld)->ld_valid == LDAP_TRASHED_SESSION )
353 #define LDAP_TRASH(ld) ( (ld)->ld_valid = LDAP_TRASHED_SESSION )
355 #ifdef LDAP_R_COMPILE
356 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
358 #ifdef HAVE_CYRUS_SASL
359 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
363 #ifdef LDAP_R_COMPILE
364 #define LDAP_NEXT_MSGID(ld, id) \
365 ldap_pvt_thread_mutex_lock( &(ld)->ld_req_mutex ); \
366 id = ++(ld)->ld_msgid; \
367 ldap_pvt_thread_mutex_unlock( &(ld)->ld_req_mutex )
369 #define LDAP_NEXT_MSGID(ld, id) id = ++(ld)->ld_msgid
376 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
378 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
379 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
380 struct ldapoptions *, int *));
383 /* simple macros to realloc for now */
384 #define LDAP_MALLOC(s) (ber_memalloc_x((s),NULL))
385 #define LDAP_CALLOC(n,s) (ber_memcalloc_x((n),(s),NULL))
386 #define LDAP_REALLOC(p,s) (ber_memrealloc_x((p),(s),NULL))
387 #define LDAP_FREE(p) (ber_memfree_x((p),NULL))
388 #define LDAP_VFREE(v) (ber_memvfree_x((void **)(v),NULL))
389 #define LDAP_STRDUP(s) (ber_strdup_x((s),NULL))
390 #define LDAP_STRNDUP(s,l) (ber_strndup_x((s),(l),NULL))
392 #define LDAP_MALLOCX(s,x) (ber_memalloc_x((s),(x)))
393 #define LDAP_CALLOCX(n,s,x) (ber_memcalloc_x((n),(s),(x)))
394 #define LDAP_REALLOCX(p,s,x) (ber_memrealloc_x((p),(s),(x)))
395 #define LDAP_FREEX(p,x) (ber_memfree_x((p),(x)))
396 #define LDAP_VFREEX(v,x) (ber_memvfree_x((void **)(v),(x)))
397 #define LDAP_STRDUPX(s,x) (ber_strdup_x((s),(x)))
398 #define LDAP_STRNDUPX(s,l,x) (ber_strndup_x((s),(l),(x)))
403 LDAP_F (void) ldap_int_error_init( void );
408 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
414 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
419 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
420 BerElement *request ));
421 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
422 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
427 LDAP_F (int) ldap_int_put_controls LDAP_P((
429 LDAPControl *const *ctrls,
432 LDAP_F (int) ldap_int_client_controls LDAP_P((
434 LDAPControl **ctrlp ));
439 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
441 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
445 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
447 LDAP_CONST char *who,
448 LDAP_CONST char *service,
451 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
457 LDAP_F (int) ldap_open_defconn( LDAP *ld );
458 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
459 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
465 LDAP_V (int) ldap_int_tblsize;
466 LDAP_F (void) ldap_int_ip_init( void );
469 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
470 const struct timeval *tm );
471 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
472 int proto, const char *host, int port, int async );
474 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
475 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
476 LDAP_V (char *) ldap_int_hostname;
477 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
481 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
482 LDAP_F (void *) ldap_new_select_info( void );
483 LDAP_F (void) ldap_free_select_info( void *sip );
484 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
485 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
486 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
487 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
488 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
494 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
495 const char *path, int async );
496 #endif /* LDAP_PF_LOCAL */
501 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
502 const char *dn, BerElement *ber, ber_int_t msgid );
503 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
504 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
506 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
507 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
508 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
509 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
510 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
511 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
512 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
513 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
514 char **errstrp, int sref, int *hadrefp );
515 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
516 char **refs, int sref, char **referralsp, int *hadrefp );
517 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
518 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
523 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
528 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
535 LDAPControl **sctrls,
536 LDAPControl **cctrls,
545 LDAP_F (int) ldap_ld_free LDAP_P((
548 LDAPControl **sctrls,
549 LDAPControl **cctrls ));
551 LDAP_F (int) ldap_send_unbind LDAP_P((
554 LDAPControl **sctrls,
555 LDAPControl **cctrls ));
560 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
561 LDAPURLDesc *ludp ));
563 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
564 LDAPURLDesc *ludlist ));
566 LDAP_F (int) ldap_url_parselist LDAP_P((
567 LDAPURLDesc **ludlist,
570 LDAP_F (int) ldap_url_parselist_ext LDAP_P((
571 LDAPURLDesc **ludlist,
575 LDAP_F (int) ldap_url_parsehosts LDAP_P((
576 LDAPURLDesc **ludlist,
580 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
581 LDAPURLDesc *ludlist ));
583 LDAP_F (char *) ldap_url_list2urls LDAP_P((
584 LDAPURLDesc *ludlist ));
586 LDAP_F (void) ldap_free_urllist LDAP_P((
587 LDAPURLDesc *ludlist ));
593 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
595 LDAP_F (int) ldap_int_sasl_open LDAP_P((
596 LDAP *ld, LDAPConn *conn,
598 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
600 LDAP_F (int) ldap_int_sasl_external LDAP_P((
601 LDAP *ld, LDAPConn *conn,
602 const char* authid, ber_len_t ssf ));
604 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
605 int option, void *arg ));
606 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
607 int option, void *arg ));
608 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
609 int option, const char *arg ));
611 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
615 LDAPControl **, LDAPControl **,
617 /* should be passed in client controls */
619 LDAP_SASL_INTERACT_PROC *interact,
623 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
631 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
632 int option, const char *arg ));
634 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
635 LDAPConn *conn, LDAPURLDesc *srv ));
640 LDAP_F (char **) ldap_value_dup LDAP_P((
641 char *const *vals ));
645 #endif /* _LDAP_INT_H */