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-2003 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 */
93 #define LDAP_URL_PREFIX "ldap://"
94 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
95 #define LDAPS_URL_PREFIX "ldaps://"
96 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
97 #define LDAPI_URL_PREFIX "ldapi://"
98 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
99 #ifdef LDAP_CONNECTIONLESS
100 #define LDAPC_URL_PREFIX "cldap://"
101 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
103 #define LDAP_URL_URLCOLON "URL:"
104 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
106 #define LDAP_REF_STR "Referral:\n"
107 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
108 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
109 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
111 #define LDAP_DEFAULT_REFHOPLIMIT 5
113 #define LDAP_BOOL_REFERRALS 0
114 #define LDAP_BOOL_RESTART 1
115 #define LDAP_BOOL_TLS 3
117 #define LDAP_BOOLEANS unsigned long
118 #define LDAP_BOOL(n) (1 << (n))
119 #define LDAP_BOOL_GET(lo, bool) \
120 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
121 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
122 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
123 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
126 * This structure represents both ldap messages and ldap responses.
127 * These are really the same, except in the case of search responses,
128 * where a response has multiple messages.
132 ber_int_t lm_msgid; /* the message id */
133 ber_tag_t lm_msgtype; /* the message type */
134 BerElement *lm_ber; /* the ber encoded message contents */
135 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
136 struct ldapmsg *lm_next; /* next response */
137 time_t lm_time; /* used to maintain cache */
141 * structure representing get/set'able options
142 * which have global defaults.
146 #define LDAP_UNINITIALIZED 0x0
147 #define LDAP_INITIALIZED 0x1
148 #define LDAP_VALID_SESSION 0x2
150 #ifdef LDAP_CONNECTIONLESS
151 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
152 void* ldo_peer; /* struct sockaddr* */
157 /* per API call timeout */
158 struct timeval *ldo_tm_api;
159 struct timeval *ldo_tm_net;
161 ber_int_t ldo_version;
163 ber_int_t ldo_timelimit;
164 ber_int_t ldo_sizelimit;
170 LDAPURLDesc *ldo_defludp;
173 char* ldo_defbinddn; /* bind dn */
175 #ifdef HAVE_CYRUS_SASL
176 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
177 char* ldo_def_sasl_realm; /* SASL realm */
178 char* ldo_def_sasl_authcid; /* SASL authentication identity */
179 char* ldo_def_sasl_authzid; /* SASL authorization identity */
181 /* SASL Security Properties */
182 struct sasl_security_properties ldo_sasl_secprops;
185 int ldo_refhoplimit; /* limit on referral nesting */
187 /* LDAPv3 server and client controls */
188 LDAPControl **ldo_sctrls;
189 LDAPControl **ldo_cctrls;
191 /* LDAP rebind callback function */
192 LDAP_REBIND_PROC *ldo_rebind_proc;
193 void *ldo_rebind_params;
195 LDAP_BOOLEANS ldo_booleans; /* boolean options */
200 * structure for representing an LDAP server connection
202 typedef struct ldap_conn {
208 #ifdef HAVE_CYRUS_SASL
209 void *lconn_sasl_authctx; /* context for bind */
210 void *lconn_sasl_sockctx; /* for security layer */
213 time_t lconn_lastused; /* time */
214 int lconn_rebind_inprogress; /* set if rebind in progress */
215 char ***lconn_rebind_queue; /* used if rebind in progress */
217 #define LDAP_CONNST_NEEDSOCKET 1
218 #define LDAP_CONNST_CONNECTING 2
219 #define LDAP_CONNST_CONNECTED 3
220 LDAPURLDesc *lconn_server;
221 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
222 char *lconn_krbinstance;
224 BerElement *lconn_ber; /* ber receiving on this conn. */
226 struct ldap_conn *lconn_next;
231 * structure used to track outstanding requests
233 typedef struct ldapreq {
234 ber_int_t lr_msgid; /* the message id */
235 int lr_status; /* status of request */
236 #define LDAP_REQST_COMPLETED 0
237 #define LDAP_REQST_INPROGRESS 1
238 #define LDAP_REQST_CHASINGREFS 2
239 #define LDAP_REQST_NOTCONNECTED 3
240 #define LDAP_REQST_WRITING 4
241 int lr_outrefcnt; /* count of outstanding referrals */
242 ber_int_t lr_origid; /* original request's message id */
243 int lr_parentcnt; /* count of parent requests */
244 ber_tag_t lr_res_msgtype; /* result message type */
245 ber_int_t lr_res_errno; /* result LDAP errno */
246 char *lr_res_error; /* result error string */
247 char *lr_res_matched;/* result matched DN string */
248 BerElement *lr_ber; /* ber encoded request contents */
249 LDAPConn *lr_conn; /* connection used to send request */
250 struct ldapreq *lr_parent; /* request that spawned this referral */
251 struct ldapreq *lr_child; /* first child request */
252 struct ldapreq *lr_refnext; /* next referral spawned */
253 struct ldapreq *lr_prev; /* previous request */
254 struct ldapreq *lr_next; /* next request */
258 * structure for client cache
260 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
261 typedef struct ldapcache {
262 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
263 LDAPMessage *lc_requests; /* unfulfilled reqs */
264 long lc_timeout; /* request timeout */
265 ber_len_t lc_maxmem; /* memory to use */
266 ber_len_t lc_memused; /* memory in use */
267 int lc_enabled; /* enabled? */
268 unsigned long lc_options; /* options */
269 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
270 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
274 * structure containing referral request info for rebind procedure
276 typedef struct ldapreqinfo {
283 * structure representing an ldap connection
287 Sockbuf *ld_sb; /* socket descriptor & buffer */
289 struct ldapoptions ld_options;
291 #define ld_valid ld_options.ldo_valid
292 #define ld_debug ld_options.ldo_debug
294 #define ld_deref ld_options.ldo_deref
295 #define ld_timelimit ld_options.ldo_timelimit
296 #define ld_sizelimit ld_options.ldo_sizelimit
298 #define ld_defbinddn ld_options.ldo_defbinddn
299 #define ld_defbase ld_options.ldo_defbase
300 #define ld_defhost ld_options.ldo_defhost
301 #define ld_defport ld_options.ldo_defport
303 #define ld_refhoplimit ld_options.ldo_refhoplimit
305 #define ld_sctrls ld_options.ldo_sctrls
306 #define ld_cctrls ld_options.ldo_cctrls
307 #define ld_rebind_proc ld_options.ldo_rebind_proc
308 #define ld_rebind_params ld_options.ldo_rebind_params
310 #define ld_version ld_options.ldo_version
312 unsigned short ld_lberoptions;
320 /* do not mess with these */
321 LDAPRequest *ld_requests; /* list of outstanding requests */
322 LDAPMessage *ld_responses; /* list of outstanding responses */
324 #ifdef LDAP_R_COMPILE
325 ldap_pvt_thread_mutex_t ld_req_mutex;
326 ldap_pvt_thread_mutex_t ld_res_mutex;
329 ber_int_t *ld_abandoned; /* array of abandoned requests */
331 LDAPCache *ld_cache; /* non-null if cache is initialized */
333 /* do not mess with the rest though */
335 LDAPConn *ld_defconn; /* default connection */
336 LDAPConn *ld_conns; /* list of server connections */
337 void *ld_selectinfo; /* platform specifics for select */
339 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
341 #ifdef LDAP_R_COMPILE
342 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
344 #ifdef HAVE_CYRUS_SASL
345 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
349 #ifdef LDAP_R_COMPILE
350 #define LDAP_NEXT_MSGID(ld, id) \
351 ldap_pvt_thread_mutex_lock( &(ld)->ld_req_mutex ); \
352 id = ++(ld)->ld_msgid; \
353 ldap_pvt_thread_mutex_unlock( &(ld)->ld_req_mutex )
355 #define LDAP_NEXT_MSGID(ld, id) id = ++(ld)->ld_msgid
362 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
364 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
365 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
366 struct ldapoptions *, int *));
369 /* simple macros to realloc for now */
370 #define LDAP_MALLOC(s) (ber_memalloc_x((s),NULL))
371 #define LDAP_CALLOC(n,s) (ber_memcalloc_x((n),(s),NULL))
372 #define LDAP_REALLOC(p,s) (ber_memrealloc_x((p),(s),NULL))
373 #define LDAP_FREE(p) (ber_memfree_x((p),NULL))
374 #define LDAP_VFREE(v) (ber_memvfree_x((void **)(v),NULL))
375 #define LDAP_STRDUP(s) (ber_strdup_x((s),NULL))
376 #define LDAP_STRNDUP(s,l) (ber_strndup_x((s),(l),NULL))
378 #define LDAP_MALLOCX(s,x) (ber_memalloc_x((s),(x)))
379 #define LDAP_CALLOCX(n,s,x) (ber_memcalloc_x((n),(s),(x)))
380 #define LDAP_REALLOCX(p,s,x) (ber_memrealloc_x((p),(s),(x)))
381 #define LDAP_FREEX(p,x) (ber_memfree_x((p),(x)))
382 #define LDAP_VFREEX(v,x) (ber_memvfree_x((void **)(v),(x)))
383 #define LDAP_STRDUPX(s,x) (ber_strdup_x((s),(x)))
384 #define LDAP_STRNDUPX(s,l,x) (ber_strndup_x((s),(l),(x)))
389 LDAP_F (void) ldap_int_error_init( void );
394 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
400 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
405 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
406 BerElement *request ));
407 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
408 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
413 LDAP_F (int) ldap_int_put_controls LDAP_P((
415 LDAPControl *const *ctrls,
418 LDAP_F (int) ldap_int_client_controls LDAP_P((
420 LDAPControl **ctrlp ));
425 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
427 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
431 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
433 LDAP_CONST char *who,
434 LDAP_CONST char *service,
437 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
443 LDAP_F (int) ldap_open_defconn( LDAP *ld );
444 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
445 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
450 LDAP_V (int) ldap_int_tblsize;
451 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
452 const struct timeval *tm );
453 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
454 int proto, const char *host, int port, int async );
456 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
457 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
458 LDAP_V (char *) ldap_int_hostname;
459 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
463 LDAP_F (void) ldap_int_ip_init( void );
464 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
465 LDAP_F (void *) ldap_new_select_info( void );
466 LDAP_F (void) ldap_free_select_info( void *sip );
467 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
468 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
469 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
470 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
471 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
477 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
478 const char *path, int async );
479 #endif /* LDAP_PF_LOCAL */
484 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
485 const char *dn, BerElement *ber, ber_int_t msgid );
486 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
487 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
489 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
490 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
491 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
492 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
493 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
494 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
495 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
496 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
497 char **errstrp, int sref, int *hadrefp );
498 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
499 char **refs, int sref, char **referralsp, int *hadrefp );
500 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
501 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
506 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
511 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
518 LDAPControl **sctrls,
519 LDAPControl **cctrls,
528 LDAP_F (int) ldap_ld_free LDAP_P((
531 LDAPControl **sctrls,
532 LDAPControl **cctrls ));
534 LDAP_F (int) ldap_send_unbind LDAP_P((
537 LDAPControl **sctrls,
538 LDAPControl **cctrls ));
543 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
544 LDAPURLDesc *ludp ));
546 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
547 LDAPURLDesc *ludlist ));
549 LDAP_F (int) ldap_url_parselist LDAP_P((
550 LDAPURLDesc **ludlist,
553 LDAP_F (int) ldap_url_parselist_ext LDAP_P((
554 LDAPURLDesc **ludlist,
558 LDAP_F (int) ldap_url_parsehosts LDAP_P((
559 LDAPURLDesc **ludlist,
563 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
564 LDAPURLDesc *ludlist ));
566 LDAP_F (char *) ldap_url_list2urls LDAP_P((
567 LDAPURLDesc *ludlist ));
569 LDAP_F (void) ldap_free_urllist LDAP_P((
570 LDAPURLDesc *ludlist ));
576 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
578 LDAP_F (int) ldap_int_sasl_open LDAP_P((
579 LDAP *ld, LDAPConn *conn,
581 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
583 LDAP_F (int) ldap_int_sasl_external LDAP_P((
584 LDAP *ld, LDAPConn *conn,
585 const char* authid, ber_len_t ssf ));
587 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
588 int option, void *arg ));
589 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
590 int option, void *arg ));
591 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
592 int option, const char *arg ));
594 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
598 LDAPControl **, LDAPControl **,
600 /* should be passed in client controls */
602 LDAP_SASL_INTERACT_PROC *interact,
606 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
614 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
615 int option, const char *arg ));
617 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
618 LDAPConn *conn, LDAPURLDesc *srv ));
623 LDAP_F (char **) ldap_value_dup LDAP_P((
624 char *const *vals ));
628 #endif /* _LDAP_INT_H */