1 /* ldap-int.h - defines & prototypes internal to the LDAP library */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
8 * Copyright (c) 1995 Regents of the University of Michigan.
16 #define LDAP_THREAD_SAFE 1
19 #include "../liblber/lber-int.h"
22 #include <ldap_pvt_thread.h>
25 #ifdef HAVE_CYRUS_SASL
26 /* the need for this should be removed */
27 #ifdef HAVE_SASL_SASL_H
28 #include <sasl/sasl.h>
33 #define SASL_MAX_BUFF_SIZE 65536
34 #define SASL_MIN_BUFF_SIZE 4096
38 * Support needed if the library is running in the kernel
40 #if LDAP_INT_IN_KERNEL
42 * Platform specific function to return a pointer to the
43 * process-specific global options.
45 * This function should perform the following functions:
46 * Allocate and initialize a global options struct on a per process basis
47 * Use callers process identifier to return its global options struct
48 * Note: Deallocate structure when the process exits
50 # define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
51 struct ldapoptions *ldap_int_global_opt(void);
53 # define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
56 #define ldap_debug ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
64 #define Debug( level, fmt, arg1, arg2, arg3 ) \
65 do { if ( ldap_debug & level ) \
66 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
69 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
70 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
74 #define Debug( level, fmt, arg1, arg2, arg3 ) ((void)0)
75 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 ) ((void)0)
77 #endif /* LDAP_DEBUG */
85 #define LDAP_URL_PREFIX "ldap://"
86 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
87 #define LDAPS_URL_PREFIX "ldaps://"
88 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
89 #define LDAPI_URL_PREFIX "ldapi://"
90 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
91 #ifdef LDAP_CONNECTIONLESS
92 #define LDAPC_URL_PREFIX "cldap://"
93 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
95 #define LDAP_URL_URLCOLON "URL:"
96 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
98 #define LDAP_REF_STR "Referral:\n"
99 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
100 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
101 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
103 #define LDAP_DEFAULT_REFHOPLIMIT 5
105 #define LDAP_BOOL_REFERRALS 0
106 #define LDAP_BOOL_RESTART 1
107 #define LDAP_BOOL_TLS 3
109 #define LDAP_BOOLEANS unsigned long
110 #define LDAP_BOOL(n) (1 << (n))
111 #define LDAP_BOOL_GET(lo, bool) \
112 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
113 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
114 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
115 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
118 * This structure represents both ldap messages and ldap responses.
119 * These are really the same, except in the case of search responses,
120 * where a response has multiple messages.
124 ber_int_t lm_msgid; /* the message id */
125 ber_tag_t lm_msgtype; /* the message type */
126 BerElement *lm_ber; /* the ber encoded message contents */
127 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
128 struct ldapmsg *lm_next; /* next response */
129 time_t lm_time; /* used to maintain cache */
133 * structure representing get/set'able options
134 * which have global defaults.
138 #define LDAP_UNINITIALIZED 0x0
139 #define LDAP_INITIALIZED 0x1
140 #define LDAP_VALID_SESSION 0x2
142 #ifdef LDAP_CONNECTIONLESS
143 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
144 void* ldo_peer; /* struct sockaddr* */
149 /* per API call timeout */
150 struct timeval *ldo_tm_api;
151 struct timeval *ldo_tm_net;
153 ber_int_t ldo_version;
155 ber_int_t ldo_timelimit;
156 ber_int_t ldo_sizelimit;
162 LDAPURLDesc *ldo_defludp;
165 char* ldo_defbinddn; /* bind dn */
167 #ifdef HAVE_CYRUS_SASL
168 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
169 char* ldo_def_sasl_realm; /* SASL realm */
170 char* ldo_def_sasl_authcid; /* SASL authentication identity */
171 char* ldo_def_sasl_authzid; /* SASL authorization identity */
173 /* SASL Security Properties */
174 struct sasl_security_properties ldo_sasl_secprops;
177 int ldo_refhoplimit; /* limit on referral nesting */
179 /* LDAPv3 server and client controls */
180 LDAPControl **ldo_sctrls;
181 LDAPControl **ldo_cctrls;
183 /* LDAP rebind callback function */
184 LDAP_REBIND_PROC *ldo_rebind_proc;
185 void *ldo_rebind_params;
187 LDAP_BOOLEANS ldo_booleans; /* boolean options */
192 * structure for representing an LDAP server connection
194 typedef struct ldap_conn {
200 #ifdef HAVE_CYRUS_SASL
201 void *lconn_sasl_authctx; /* context for bind */
202 void *lconn_sasl_sockctx; /* for security layer */
205 time_t lconn_lastused; /* time */
206 int lconn_rebind_inprogress; /* set if rebind in progress */
207 char ***lconn_rebind_queue; /* used if rebind in progress */
209 #define LDAP_CONNST_NEEDSOCKET 1
210 #define LDAP_CONNST_CONNECTING 2
211 #define LDAP_CONNST_CONNECTED 3
212 LDAPURLDesc *lconn_server;
213 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
214 char *lconn_krbinstance;
216 BerElement *lconn_ber; /* ber receiving on this conn. */
218 struct ldap_conn *lconn_next;
223 * structure used to track outstanding requests
225 typedef struct ldapreq {
226 ber_int_t lr_msgid; /* the message id */
227 int lr_status; /* status of request */
228 #define LDAP_REQST_COMPLETED 0
229 #define LDAP_REQST_INPROGRESS 1
230 #define LDAP_REQST_CHASINGREFS 2
231 #define LDAP_REQST_NOTCONNECTED 3
232 #define LDAP_REQST_WRITING 4
233 int lr_outrefcnt; /* count of outstanding referrals */
234 ber_int_t lr_origid; /* original request's message id */
235 int lr_parentcnt; /* count of parent requests */
236 ber_tag_t lr_res_msgtype; /* result message type */
237 ber_int_t lr_res_errno; /* result LDAP errno */
238 char *lr_res_error; /* result error string */
239 char *lr_res_matched;/* result matched DN string */
240 BerElement *lr_ber; /* ber encoded request contents */
241 LDAPConn *lr_conn; /* connection used to send request */
242 struct ldapreq *lr_parent; /* request that spawned this referral */
243 struct ldapreq *lr_child; /* first child request */
244 struct ldapreq *lr_refnext; /* next referral spawned */
245 struct ldapreq *lr_prev; /* previous request */
246 struct ldapreq *lr_next; /* next request */
250 * structure for client cache
252 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
253 typedef struct ldapcache {
254 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
255 LDAPMessage *lc_requests; /* unfulfilled reqs */
256 long lc_timeout; /* request timeout */
257 ber_len_t lc_maxmem; /* memory to use */
258 ber_len_t lc_memused; /* memory in use */
259 int lc_enabled; /* enabled? */
260 unsigned long lc_options; /* options */
261 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
262 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
266 * structure containing referral request info for rebind procedure
268 typedef struct ldapreqinfo {
275 * structure representing an ldap connection
279 Sockbuf *ld_sb; /* socket descriptor & buffer */
281 struct ldapoptions ld_options;
283 #define ld_valid ld_options.ldo_valid
284 #define ld_debug ld_options.ldo_debug
286 #define ld_deref ld_options.ldo_deref
287 #define ld_timelimit ld_options.ldo_timelimit
288 #define ld_sizelimit ld_options.ldo_sizelimit
290 #define ld_defbinddn ld_options.ldo_defbinddn
291 #define ld_defbase ld_options.ldo_defbase
292 #define ld_defhost ld_options.ldo_defhost
293 #define ld_defport ld_options.ldo_defport
295 #define ld_refhoplimit ld_options.ldo_refhoplimit
297 #define ld_sctrls ld_options.ldo_sctrls
298 #define ld_cctrls ld_options.ldo_cctrls
299 #define ld_rebind_proc ld_options.ldo_rebind_proc
300 #define ld_rebind_params ld_options.ldo_rebind_params
302 #define ld_version ld_options.ldo_version
304 unsigned short ld_lberoptions;
312 /* do not mess with these */
313 LDAPRequest *ld_requests; /* list of outstanding requests */
314 LDAPMessage *ld_responses; /* list of outstanding responses */
316 #ifdef LDAP_R_COMPILE
317 ldap_pvt_thread_mutex_t ld_req_mutex;
318 ldap_pvt_thread_mutex_t ld_res_mutex;
321 ber_int_t *ld_abandoned; /* array of abandoned requests */
323 LDAPCache *ld_cache; /* non-null if cache is initialized */
325 /* do not mess with the rest though */
327 LDAPConn *ld_defconn; /* default connection */
328 LDAPConn *ld_conns; /* list of server connections */
329 void *ld_selectinfo; /* platform specifics for select */
331 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
333 #ifdef LDAP_R_COMPILE
334 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
336 #ifdef HAVE_CYRUS_SASL
337 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
341 #ifdef LDAP_R_COMPILE
342 #define LDAP_NEXT_MSGID(ld, id) \
343 ldap_pvt_thread_mutex_lock( &(ld)->ld_req_mutex ); \
344 id = ++(ld)->ld_msgid; \
345 ldap_pvt_thread_mutex_unlock( &(ld)->ld_req_mutex )
347 #define LDAP_NEXT_MSGID(ld, id) id = ++(ld)->ld_msgid
354 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
356 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
357 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
358 struct ldapoptions *, int *));
361 /* simple macros to realloc for now */
362 #define LDAP_MALLOC(s) (ber_memalloc_x((s),NULL))
363 #define LDAP_CALLOC(n,s) (ber_memcalloc_x((n),(s),NULL))
364 #define LDAP_REALLOC(p,s) (ber_memrealloc_x((p),(s),NULL))
365 #define LDAP_FREE(p) (ber_memfree_x((p),NULL))
366 #define LDAP_VFREE(v) (ber_memvfree_x((void **)(v),NULL))
367 #define LDAP_STRDUP(s) (ber_strdup_x((s),NULL))
368 #define LDAP_STRNDUP(s,l) (ber_strndup_x((s),(l),NULL))
370 #define LDAP_MALLOCX(s,x) (ber_memalloc_x((s),(x)))
371 #define LDAP_CALLOCX(n,s,x) (ber_memcalloc_x((n),(s),(x)))
372 #define LDAP_REALLOCX(p,s,x) (ber_memrealloc_x((p),(s),(x)))
373 #define LDAP_FREEX(p,x) (ber_memfree_x((p),(x)))
374 #define LDAP_VFREEX(v,x) (ber_memvfree_x((void **)(v),(x)))
375 #define LDAP_STRDUPX(s,x) (ber_strdup_x((s),(x)))
376 #define LDAP_STRNDUPX(s,l,x) (ber_strndup_x((s),(l),(x)))
381 LDAP_F (void) ldap_int_error_init( void );
386 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
392 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
397 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
398 BerElement *request ));
399 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
400 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
405 LDAP_F (int) ldap_int_get_controls LDAP_P((
407 LDAPControl ***ctrlsp));
409 LDAP_F (int) ldap_int_put_controls LDAP_P((
411 LDAPControl *const *ctrls,
414 LDAP_F (int) ldap_int_client_controls LDAP_P((
416 LDAPControl **ctrlp ));
421 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
423 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
427 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
429 LDAP_CONST char *who,
430 LDAP_CONST char *service,
433 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
439 LDAP_F (int) ldap_open_defconn( LDAP *ld );
440 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
441 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
446 LDAP_V (int) ldap_int_tblsize;
447 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
448 const struct timeval *tm );
449 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
450 int proto, const char *host, int port, int async );
452 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
453 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
454 LDAP_V (char *) ldap_int_hostname;
455 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
459 LDAP_F (void) ldap_int_ip_init( void );
460 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
461 LDAP_F (void *) ldap_new_select_info( void );
462 LDAP_F (void) ldap_free_select_info( void *sip );
463 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
464 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
465 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
466 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
467 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
473 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
474 const char *path, int async );
475 #endif /* LDAP_PF_LOCAL */
480 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
481 const char *dn, BerElement *ber, ber_int_t msgid );
482 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
483 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
485 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
486 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
487 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
488 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
489 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
490 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
491 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
492 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
493 char **errstrp, int sref, int *hadrefp );
494 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
495 char **refs, int sref, char **referralsp, int *hadrefp );
496 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
497 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
502 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
507 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
514 LDAPControl **sctrls,
515 LDAPControl **cctrls,
524 LDAP_F (int) ldap_ld_free LDAP_P((
527 LDAPControl **sctrls,
528 LDAPControl **cctrls ));
530 LDAP_F (int) ldap_send_unbind LDAP_P((
533 LDAPControl **sctrls,
534 LDAPControl **cctrls ));
539 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
540 LDAPURLDesc *ludp ));
542 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
543 LDAPURLDesc *ludlist ));
545 LDAP_F (int) ldap_url_parselist LDAP_P((
546 LDAPURLDesc **ludlist,
549 LDAP_F (int) ldap_url_parselist_ext LDAP_P((
550 LDAPURLDesc **ludlist,
554 LDAP_F (int) ldap_url_parsehosts LDAP_P((
555 LDAPURLDesc **ludlist,
559 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
560 LDAPURLDesc *ludlist ));
562 LDAP_F (char *) ldap_url_list2urls LDAP_P((
563 LDAPURLDesc *ludlist ));
565 LDAP_F (void) ldap_free_urllist LDAP_P((
566 LDAPURLDesc *ludlist ));
572 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
574 LDAP_F (int) ldap_int_sasl_open LDAP_P((
575 LDAP *ld, LDAPConn *conn,
577 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
579 LDAP_F (int) ldap_int_sasl_external LDAP_P((
580 LDAP *ld, LDAPConn *conn,
581 const char* authid, ber_len_t ssf ));
583 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
584 int option, void *arg ));
585 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
586 int option, void *arg ));
587 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
588 int option, const char *arg ));
590 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
594 LDAPControl **, LDAPControl **,
596 /* should be passed in client controls */
598 LDAP_SASL_INTERACT_PROC *interact,
602 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
610 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
611 int option, const char *arg ));
613 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
614 LDAPConn *conn, LDAPURLDesc *srv ));
619 LDAP_F (char **) ldap_value_dup LDAP_P((
620 char *const *vals ));
624 #endif /* _LDAP_INT_H */