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 * Support needed if the library is running in the kernel
48 #if LDAP_INT_IN_KERNEL
50 * Platform specific function to return a pointer to the
51 * process-specific global options.
53 * This function should perform the following functions:
54 * Allocate and initialize a global options struct on a per process basis
55 * Use callers process identifier to return its global options struct
56 * Note: Deallocate structure when the process exits
58 # define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
59 struct ldapoptions *ldap_int_global_opt(void);
61 # define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
64 #define ldap_debug ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
72 #define Debug( level, fmt, arg1, arg2, arg3 ) \
73 do { if ( ldap_debug & level ) \
74 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
77 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
78 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
82 #define Debug( level, fmt, arg1, arg2, arg3 ) ((void)0)
83 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 ) ((void)0)
85 #endif /* LDAP_DEBUG */
87 #define LDAP_DEPRECATED 1
94 #define LDAP_URL_PREFIX "ldap://"
95 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
96 #define LDAPS_URL_PREFIX "ldaps://"
97 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
98 #define LDAPI_URL_PREFIX "ldapi://"
99 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
100 #ifdef LDAP_CONNECTIONLESS
101 #define LDAPC_URL_PREFIX "cldap://"
102 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
104 #define LDAP_URL_URLCOLON "URL:"
105 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
107 #define LDAP_REF_STR "Referral:\n"
108 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
109 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
110 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
112 #define LDAP_DEFAULT_REFHOPLIMIT 5
114 #define LDAP_BOOL_REFERRALS 0
115 #define LDAP_BOOL_RESTART 1
116 #define LDAP_BOOL_TLS 3
118 #define LDAP_BOOLEANS unsigned long
119 #define LDAP_BOOL(n) (1 << (n))
120 #define LDAP_BOOL_GET(lo, bool) \
121 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
122 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
123 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
124 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
127 * This structure represents both ldap messages and ldap responses.
128 * These are really the same, except in the case of search responses,
129 * where a response has multiple messages.
133 ber_int_t lm_msgid; /* the message id */
134 ber_tag_t lm_msgtype; /* the message type */
135 BerElement *lm_ber; /* the ber encoded message contents */
136 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
137 struct ldapmsg *lm_chain_tail;
138 struct ldapmsg *lm_next; /* next response */
139 time_t lm_time; /* used to maintain cache */
143 * structure representing get/set'able options
144 * which have global defaults.
148 #define LDAP_UNINITIALIZED 0x0
149 #define LDAP_INITIALIZED 0x1
150 #define LDAP_VALID_SESSION 0x2
152 #ifdef LDAP_CONNECTIONLESS
153 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
154 void* ldo_peer; /* struct sockaddr* */
159 /* per API call timeout */
160 struct timeval *ldo_tm_api;
161 struct timeval *ldo_tm_net;
163 ber_int_t ldo_version;
165 ber_int_t ldo_timelimit;
166 ber_int_t ldo_sizelimit;
172 LDAPURLDesc *ldo_defludp;
175 char* ldo_defbinddn; /* bind dn */
177 #ifdef HAVE_CYRUS_SASL
178 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
179 char* ldo_def_sasl_realm; /* SASL realm */
180 char* ldo_def_sasl_authcid; /* SASL authentication identity */
181 char* ldo_def_sasl_authzid; /* SASL authorization identity */
183 /* SASL Security Properties */
184 struct sasl_security_properties ldo_sasl_secprops;
187 int ldo_refhoplimit; /* limit on referral nesting */
189 /* LDAPv3 server and client controls */
190 LDAPControl **ldo_sctrls;
191 LDAPControl **ldo_cctrls;
193 /* LDAP rebind callback function */
194 LDAP_REBIND_PROC *ldo_rebind_proc;
195 void *ldo_rebind_params;
197 LDAP_BOOLEANS ldo_booleans; /* boolean options */
202 * structure for representing an LDAP server connection
204 typedef struct ldap_conn {
210 #ifdef HAVE_CYRUS_SASL
211 void *lconn_sasl_authctx; /* context for bind */
212 void *lconn_sasl_sockctx; /* for security layer */
215 time_t lconn_lastused; /* time */
216 int lconn_rebind_inprogress; /* set if rebind in progress */
217 char ***lconn_rebind_queue; /* used if rebind in progress */
219 #define LDAP_CONNST_NEEDSOCKET 1
220 #define LDAP_CONNST_CONNECTING 2
221 #define LDAP_CONNST_CONNECTED 3
222 LDAPURLDesc *lconn_server;
223 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
224 char *lconn_krbinstance;
226 BerElement *lconn_ber; /* ber receiving on this conn. */
228 struct ldap_conn *lconn_next;
233 * structure used to track outstanding requests
235 typedef struct ldapreq {
236 ber_int_t lr_msgid; /* the message id */
237 int lr_status; /* status of request */
238 #define LDAP_REQST_COMPLETED 0
239 #define LDAP_REQST_INPROGRESS 1
240 #define LDAP_REQST_CHASINGREFS 2
241 #define LDAP_REQST_NOTCONNECTED 3
242 #define LDAP_REQST_WRITING 4
243 int lr_outrefcnt; /* count of outstanding referrals */
244 ber_int_t lr_origid; /* original request's message id */
245 int lr_parentcnt; /* count of parent requests */
246 ber_tag_t lr_res_msgtype; /* result message type */
247 ber_int_t lr_res_errno; /* result LDAP errno */
248 char *lr_res_error; /* result error string */
249 char *lr_res_matched;/* result matched DN string */
250 BerElement *lr_ber; /* ber encoded request contents */
251 LDAPConn *lr_conn; /* connection used to send request */
252 struct ldapreq *lr_parent; /* request that spawned this referral */
253 struct ldapreq *lr_child; /* first child request */
254 struct ldapreq *lr_refnext; /* next referral spawned */
255 struct ldapreq *lr_prev; /* previous request */
256 struct ldapreq *lr_next; /* next request */
260 * structure for client cache
262 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
263 typedef struct ldapcache {
264 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
265 LDAPMessage *lc_requests; /* unfulfilled reqs */
266 long lc_timeout; /* request timeout */
267 ber_len_t lc_maxmem; /* memory to use */
268 ber_len_t lc_memused; /* memory in use */
269 int lc_enabled; /* enabled? */
270 unsigned long lc_options; /* options */
271 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
272 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
276 * structure containing referral request info for rebind procedure
278 typedef struct ldapreqinfo {
285 * structure representing an ldap connection
289 Sockbuf *ld_sb; /* socket descriptor & buffer */
291 struct ldapoptions ld_options;
293 #define ld_valid ld_options.ldo_valid
294 #define ld_debug ld_options.ldo_debug
296 #define ld_deref ld_options.ldo_deref
297 #define ld_timelimit ld_options.ldo_timelimit
298 #define ld_sizelimit ld_options.ldo_sizelimit
300 #define ld_defbinddn ld_options.ldo_defbinddn
301 #define ld_defbase ld_options.ldo_defbase
302 #define ld_defhost ld_options.ldo_defhost
303 #define ld_defport ld_options.ldo_defport
305 #define ld_refhoplimit ld_options.ldo_refhoplimit
307 #define ld_sctrls ld_options.ldo_sctrls
308 #define ld_cctrls ld_options.ldo_cctrls
309 #define ld_rebind_proc ld_options.ldo_rebind_proc
310 #define ld_rebind_params ld_options.ldo_rebind_params
312 #define ld_version ld_options.ldo_version
314 unsigned short ld_lberoptions;
322 /* do not mess with these */
323 LDAPRequest *ld_requests; /* list of outstanding requests */
324 LDAPMessage *ld_responses; /* list of outstanding responses */
326 #ifdef LDAP_R_COMPILE
327 ldap_pvt_thread_mutex_t ld_req_mutex;
328 ldap_pvt_thread_mutex_t ld_res_mutex;
331 ber_int_t *ld_abandoned; /* array of abandoned requests */
333 LDAPCache *ld_cache; /* non-null if cache is initialized */
335 /* do not mess with the rest though */
337 LDAPConn *ld_defconn; /* default connection */
338 LDAPConn *ld_conns; /* list of server connections */
339 void *ld_selectinfo; /* platform specifics for select */
341 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
343 #ifdef LDAP_R_COMPILE
344 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
346 #ifdef HAVE_CYRUS_SASL
347 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
351 #ifdef LDAP_R_COMPILE
352 #define LDAP_NEXT_MSGID(ld, id) \
353 ldap_pvt_thread_mutex_lock( &(ld)->ld_req_mutex ); \
354 id = ++(ld)->ld_msgid; \
355 ldap_pvt_thread_mutex_unlock( &(ld)->ld_req_mutex )
357 #define LDAP_NEXT_MSGID(ld, id) id = ++(ld)->ld_msgid
364 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
366 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
367 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
368 struct ldapoptions *, int *));
371 /* simple macros to realloc for now */
372 #define LDAP_MALLOC(s) (ber_memalloc_x((s),NULL))
373 #define LDAP_CALLOC(n,s) (ber_memcalloc_x((n),(s),NULL))
374 #define LDAP_REALLOC(p,s) (ber_memrealloc_x((p),(s),NULL))
375 #define LDAP_FREE(p) (ber_memfree_x((p),NULL))
376 #define LDAP_VFREE(v) (ber_memvfree_x((void **)(v),NULL))
377 #define LDAP_STRDUP(s) (ber_strdup_x((s),NULL))
378 #define LDAP_STRNDUP(s,l) (ber_strndup_x((s),(l),NULL))
380 #define LDAP_MALLOCX(s,x) (ber_memalloc_x((s),(x)))
381 #define LDAP_CALLOCX(n,s,x) (ber_memcalloc_x((n),(s),(x)))
382 #define LDAP_REALLOCX(p,s,x) (ber_memrealloc_x((p),(s),(x)))
383 #define LDAP_FREEX(p,x) (ber_memfree_x((p),(x)))
384 #define LDAP_VFREEX(v,x) (ber_memvfree_x((void **)(v),(x)))
385 #define LDAP_STRDUPX(s,x) (ber_strdup_x((s),(x)))
386 #define LDAP_STRNDUPX(s,l,x) (ber_strndup_x((s),(l),(x)))
391 LDAP_F (void) ldap_int_error_init( void );
396 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
402 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
407 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
408 BerElement *request ));
409 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
410 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
415 LDAP_F (int) ldap_int_put_controls LDAP_P((
417 LDAPControl *const *ctrls,
420 LDAP_F (int) ldap_int_client_controls LDAP_P((
422 LDAPControl **ctrlp ));
427 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
429 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
433 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
435 LDAP_CONST char *who,
436 LDAP_CONST char *service,
439 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
445 LDAP_F (int) ldap_open_defconn( LDAP *ld );
446 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
447 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
452 LDAP_V (int) ldap_int_tblsize;
453 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
454 const struct timeval *tm );
455 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
456 int proto, const char *host, int port, int async );
458 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
459 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
460 LDAP_V (char *) ldap_int_hostname;
461 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
465 LDAP_F (void) ldap_int_ip_init( void );
466 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
467 LDAP_F (void *) ldap_new_select_info( void );
468 LDAP_F (void) ldap_free_select_info( void *sip );
469 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
470 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
471 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
472 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
473 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
479 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
480 const char *path, int async );
481 #endif /* LDAP_PF_LOCAL */
486 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
487 const char *dn, BerElement *ber, ber_int_t msgid );
488 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
489 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
491 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
492 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
493 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
494 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
495 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
496 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
497 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
498 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
499 char **errstrp, int sref, int *hadrefp );
500 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
501 char **refs, int sref, char **referralsp, int *hadrefp );
502 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
503 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
508 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
513 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
520 LDAPControl **sctrls,
521 LDAPControl **cctrls,
530 LDAP_F (int) ldap_ld_free LDAP_P((
533 LDAPControl **sctrls,
534 LDAPControl **cctrls ));
536 LDAP_F (int) ldap_send_unbind LDAP_P((
539 LDAPControl **sctrls,
540 LDAPControl **cctrls ));
545 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
546 LDAPURLDesc *ludp ));
548 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
549 LDAPURLDesc *ludlist ));
551 LDAP_F (int) ldap_url_parselist LDAP_P((
552 LDAPURLDesc **ludlist,
555 LDAP_F (int) ldap_url_parselist_ext LDAP_P((
556 LDAPURLDesc **ludlist,
560 LDAP_F (int) ldap_url_parsehosts LDAP_P((
561 LDAPURLDesc **ludlist,
565 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
566 LDAPURLDesc *ludlist ));
568 LDAP_F (char *) ldap_url_list2urls LDAP_P((
569 LDAPURLDesc *ludlist ));
571 LDAP_F (void) ldap_free_urllist LDAP_P((
572 LDAPURLDesc *ludlist ));
578 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
580 LDAP_F (int) ldap_int_sasl_open LDAP_P((
581 LDAP *ld, LDAPConn *conn,
583 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
585 LDAP_F (int) ldap_int_sasl_external LDAP_P((
586 LDAP *ld, LDAPConn *conn,
587 const char* authid, ber_len_t ssf ));
589 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
590 int option, void *arg ));
591 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
592 int option, void *arg ));
593 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
594 int option, const char *arg ));
596 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
600 LDAPControl **, LDAPControl **,
602 /* should be passed in client controls */
604 LDAP_SASL_INTERACT_PROC *interact,
608 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
616 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
617 int option, const char *arg ));
619 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
620 LDAPConn *conn, LDAPURLDesc *srv ));
625 LDAP_F (char **) ldap_value_dup LDAP_P((
626 char *const *vals ));
630 #endif /* _LDAP_INT_H */