1 /* ldap-int.h - defines & prototypes internal to the LDAP library */
4 * Copyright 1998-2000 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 #include <ldap_queue.h>
27 #ifdef HAVE_CYRUS_SASL
28 /* the need for this should be removed */
31 #define SASL_MAX_BUFF_SIZE 65536
32 #define SASL_MIN_BUFF_SIZE 4096
36 * Support needed if the library is running in the kernel
38 #if LDAP_INT_IN_KERNEL
40 * Platform specific function to return a pointer to the
41 * process-specific global options.
43 * This function should perform the following functions:
44 * Allocate and initialize a global options struct on a per process basis
45 * Use callers process identifier to return its global options struct
46 * Note: Deallocate structure when the process exits
48 # define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
49 struct ldapoptions *ldap_int_global_opt(void);
51 # define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
54 #define ldap_debug ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
59 #define Debug( level, fmt, arg1, arg2, arg3 ) \
60 do { if ( ldap_debug & level ) \
61 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
64 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
65 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
73 #define LDAP_URL_PREFIX "ldap://"
74 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
75 #define LDAPS_URL_PREFIX "ldaps://"
76 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
77 #define LDAPI_URL_PREFIX "ldapi://"
78 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
79 #ifdef LDAP_CONNECTIONLESS
80 #define LDAPC_URL_PREFIX "cldap://"
81 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
83 #define LDAP_URL_URLCOLON "URL:"
84 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
86 #define LDAP_REF_STR "Referral:\n"
87 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
88 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
89 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
91 #define LDAP_DEFAULT_REFHOPLIMIT 5
93 #define LDAP_BOOL_REFERRALS 0
94 #define LDAP_BOOL_RESTART 1
95 #define LDAP_BOOL_TLS 3
97 #define LDAP_BOOLEANS unsigned long
98 #define LDAP_BOOL(n) (1 << (n))
99 #define LDAP_BOOL_GET(lo, bool) \
100 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
101 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
102 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
103 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
106 * This structure represents both ldap messages and ldap responses.
107 * These are really the same, except in the case of search responses,
108 * where a response has multiple messages.
112 ber_int_t lm_msgid; /* the message id */
113 ber_tag_t lm_msgtype; /* the message type */
114 BerElement *lm_ber; /* the ber encoded message contents */
115 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
116 struct ldapmsg *lm_next; /* next response */
117 time_t lm_time; /* used to maintain cache */
121 * structure representing get/set'able options
122 * which have global defaults.
126 #define LDAP_UNINITIALIZED 0x0
127 #define LDAP_INITIALIZED 0x1
128 #define LDAP_VALID_SESSION 0x2
129 #ifdef LDAP_CONNECTIONLESS
130 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
131 void* ldo_peer; /* struct sockaddr* */
137 /* per API call timeout */
138 struct timeval *ldo_tm_api;
139 struct timeval *ldo_tm_net;
141 ber_int_t ldo_version;
143 ber_int_t ldo_timelimit;
144 ber_int_t ldo_sizelimit;
150 LDAPURLDesc *ldo_defludp;
153 char* ldo_defbinddn; /* bind dn */
155 #ifdef HAVE_CYRUS_SASL
156 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
157 char* ldo_def_sasl_realm; /* SASL realm */
158 char* ldo_def_sasl_authcid; /* SASL authentication identity */
159 char* ldo_def_sasl_authzid; /* SASL authorization identity */
161 /* SASL Security Properties */
162 struct sasl_security_properties ldo_sasl_secprops;
165 int ldo_refhoplimit; /* limit on referral nesting */
167 /* LDAPv3 server and client controls */
168 LDAPControl **ldo_sctrls;
169 LDAPControl **ldo_cctrls;
171 /* LDAP rebind callback function */
172 LDAP_REBIND_PROC *ldo_rebind_proc;
173 void *ldo_rebind_params;
175 LDAP_BOOLEANS ldo_booleans; /* boolean options */
180 * structure for representing an LDAP server connection
182 typedef struct ldap_conn {
188 #ifdef HAVE_CYRUS_SASL
189 void *lconn_sasl_ctx;
192 time_t lconn_lastused; /* time */
193 int lconn_rebind_inprogress; /* set if rebind in progress */
194 char ***lconn_rebind_queue; /* used if rebind in progress */
196 #define LDAP_CONNST_NEEDSOCKET 1
197 #define LDAP_CONNST_CONNECTING 2
198 #define LDAP_CONNST_CONNECTED 3
199 LDAPURLDesc *lconn_server;
200 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
201 char *lconn_krbinstance;
203 BerElement *lconn_ber; /* ber receiving on this conn. */
205 struct ldap_conn *lconn_next;
210 * structure used to track outstanding requests
212 typedef struct ldapreq {
213 ber_int_t lr_msgid; /* the message id */
214 int lr_status; /* status of request */
215 #define LDAP_REQST_COMPLETED 0
216 #define LDAP_REQST_INPROGRESS 1
217 #define LDAP_REQST_CHASINGREFS 2
218 #define LDAP_REQST_NOTCONNECTED 3
219 #define LDAP_REQST_WRITING 4
220 int lr_outrefcnt; /* count of outstanding referrals */
221 ber_int_t lr_origid; /* original request's message id */
222 int lr_parentcnt; /* count of parent requests */
223 ber_tag_t lr_res_msgtype; /* result message type */
224 ber_int_t lr_res_errno; /* result LDAP errno */
225 char *lr_res_error; /* result error string */
226 char *lr_res_matched;/* result matched DN string */
227 BerElement *lr_ber; /* ber encoded request contents */
228 LDAPConn *lr_conn; /* connection used to send request */
229 struct ldapreq *lr_parent; /* request that spawned this referral */
230 struct ldapreq *lr_child; /* first child request */
231 struct ldapreq *lr_refnext; /* next referral spawned */
232 struct ldapreq *lr_prev; /* previous request */
233 struct ldapreq *lr_next; /* next request */
237 * structure for client cache
239 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
240 typedef struct ldapcache {
241 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
242 LDAPMessage *lc_requests; /* unfulfilled reqs */
243 long lc_timeout; /* request timeout */
244 ber_len_t lc_maxmem; /* memory to use */
245 ber_len_t lc_memused; /* memory in use */
246 int lc_enabled; /* enabled? */
247 unsigned long lc_options; /* options */
248 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
249 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
253 * structure containing referral request info for rebind procedure
255 typedef struct ldapreqinfo {
262 * structure representing an ldap connection
266 Sockbuf *ld_sb; /* socket descriptor & buffer */
268 struct ldapoptions ld_options;
270 #define ld_valid ld_options.ldo_valid
271 #define ld_debug ld_options.ldo_debug
273 #define ld_deref ld_options.ldo_deref
274 #define ld_timelimit ld_options.ldo_timelimit
275 #define ld_sizelimit ld_options.ldo_sizelimit
277 #define ld_defbinddn ld_options.ldo_defbinddn
278 #define ld_defbase ld_options.ldo_defbase
279 #define ld_defhost ld_options.ldo_defhost
280 #define ld_defport ld_options.ldo_defport
282 #define ld_refhoplimit ld_options.ldo_refhoplimit
284 #define ld_sctrls ld_options.ldo_sctrls
285 #define ld_cctrls ld_options.ldo_cctrls
286 #define ld_rebind_proc ld_options.ldo_rebind_proc
287 #define ld_rebind_params ld_options.ldo_rebind_params
289 #define ld_version ld_options.ldo_version
291 unsigned short ld_lberoptions;
298 /* do not mess with these */
299 LDAPRequest *ld_requests; /* list of outstanding requests */
300 LDAPMessage *ld_responses; /* list of outstanding responses */
302 ber_int_t *ld_abandoned; /* array of abandoned requests */
304 LDAPCache *ld_cache; /* non-null if cache is initialized */
306 /* do not mess with the rest though */
308 LDAPConn *ld_defconn; /* default connection */
309 LDAPConn *ld_conns; /* list of server connections */
310 void *ld_selectinfo; /* platform specifics for select */
312 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
314 #ifdef LDAP_R_COMPILE
315 #ifdef HAVE_RES_QUERY
316 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
319 #ifdef HAVE_CYRUS_SASL
320 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
328 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
330 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
331 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
332 struct ldapoptions *, int *));
335 /* simple macros to realloc for now */
336 #define LDAP_INT_MALLOC(s) (LBER_MALLOC((s)))
337 #define LDAP_INT_CALLOC(n,s) (LBER_CALLOC((n),(s)))
338 #define LDAP_INT_REALLOC(p,s) (LBER_REALLOC((p),(s)))
339 #define LDAP_INT_FREE(p) (LBER_FREE((p)))
340 #define LDAP_INT_VFREE(v) (LBER_VFREE((void **)(v)))
341 #define LDAP_INT_STRDUP(s) (LBER_STRDUP((s)))
343 #define LDAP_MALLOC(s) (LBER_MALLOC((s)))
344 #define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s)))
345 #define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s)))
346 #define LDAP_FREE(p) (LBER_FREE((p)))
347 #define LDAP_VFREE(v) (LBER_VFREE((void **)(v)))
348 #define LDAP_STRDUP(s) (LBER_STRDUP((s)))
349 #define LDAP_STRNDUP(s,l) (LBER_STRNDUP((s),(l)))
354 LDAP_F (void) ldap_int_error_init( void );
359 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
365 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
370 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
371 BerElement *request ));
372 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
373 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
378 LDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
379 const LDAPControl *ctrl ));
381 LDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
382 LDAPControl *const *ctrls ));
384 LDAP_F (int) ldap_int_get_controls LDAP_P((
386 LDAPControl ***ctrlsp));
388 LDAP_F (int) ldap_int_put_controls LDAP_P((
390 LDAPControl *const *ctrls,
393 LDAP_F (int) ldap_int_client_controls LDAP_P((
395 LDAPControl **ctrlp ));
400 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
402 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
406 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
408 LDAP_CONST char *who,
409 LDAP_CONST char *service,
412 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
418 LDAP_F (int) ldap_open_defconn( LDAP *ld );
419 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
420 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
425 LDAP_V (int) ldap_int_tblsize;
426 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
427 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
428 int proto, const char *host, unsigned long address, int port,
431 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
432 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
433 LDAP_V (char *) ldap_int_hostname;
434 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
437 LDAP_F (void) ldap_int_ip_init( void );
438 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
439 LDAP_F (void *) ldap_new_select_info( void );
440 LDAP_F (void) ldap_free_select_info( void *sip );
441 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
442 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
443 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
444 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
445 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
451 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
452 const char *path, int async );
453 #endif /* LDAP_PF_LOCAL */
458 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
459 const char *dn, BerElement *ber );
460 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
461 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
463 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
464 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
465 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
466 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
467 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
468 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
469 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
470 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
471 char **errstrp, int sref, int *hadrefp );
472 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
473 char **refs, int sref, char **referralsp, int *hadrefp );
474 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
479 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
484 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
491 LDAPControl **sctrls,
492 LDAPControl **cctrls,
494 ber_int_t sizelimit ));
496 LDAP_F( int ) ldap_int_put_filter LDAP_P((
503 LDAP_F (int) ldap_ld_free LDAP_P((
506 LDAPControl **sctrls,
507 LDAPControl **cctrls ));
509 LDAP_F (int) ldap_send_unbind LDAP_P((
512 LDAPControl **sctrls,
513 LDAPControl **cctrls ));
518 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
519 LDAPURLDesc *ludp ));
521 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
522 LDAPURLDesc *ludlist ));
524 LDAP_F (int) ldap_url_parselist LDAP_P((
525 LDAPURLDesc **ludlist,
528 LDAP_F (int) ldap_url_parsehosts LDAP_P((
529 LDAPURLDesc **ludlist,
533 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
534 LDAPURLDesc *ludlist ));
536 LDAP_F (char *) ldap_url_list2urls LDAP_P((
537 LDAPURLDesc *ludlist ));
539 LDAP_F (void) ldap_free_urllist LDAP_P((
540 LDAPURLDesc *ludlist ));
546 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
548 LDAP_F (int) ldap_int_sasl_open LDAP_P((
549 LDAP *ld, LDAPConn *conn,
550 const char* host, ber_len_t ssf ));
551 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
553 LDAP_F (int) ldap_int_sasl_external LDAP_P((
554 LDAP *ld, LDAPConn *conn,
555 const char* authid, ber_len_t ssf ));
557 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
558 int option, void *arg ));
559 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
560 int option, void *arg ));
561 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
562 int option, const char *arg ));
564 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
568 LDAPControl **, LDAPControl **,
570 /* should be passed in client controls */
572 LDAP_SASL_INTERACT_PROC *interact,
576 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
584 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
585 int option, const char *arg ));
587 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
588 LDAPConn *conn, LDAPURLDesc *srv ));
592 #endif /* _LDAP_INT_H */