1 /* ldap-int.h - defines & prototypes internal to the LDAP library */
4 * Copyright 1998-2002 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)
61 #define Debug( level, fmt, arg1, arg2, arg3 ) \
62 do { if ( ldap_debug & level ) \
63 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
66 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
67 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
75 #define LDAP_URL_PREFIX "ldap://"
76 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
77 #define LDAPS_URL_PREFIX "ldaps://"
78 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
79 #define LDAPI_URL_PREFIX "ldapi://"
80 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
81 #ifdef LDAP_CONNECTIONLESS
82 #define LDAPC_URL_PREFIX "cldap://"
83 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
85 #define LDAP_URL_URLCOLON "URL:"
86 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
88 #define LDAP_REF_STR "Referral:\n"
89 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
90 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
91 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
93 #define LDAP_DEFAULT_REFHOPLIMIT 5
95 #define LDAP_BOOL_REFERRALS 0
96 #define LDAP_BOOL_RESTART 1
97 #define LDAP_BOOL_TLS 3
99 #define LDAP_BOOLEANS unsigned long
100 #define LDAP_BOOL(n) (1 << (n))
101 #define LDAP_BOOL_GET(lo, bool) \
102 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
103 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
104 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
105 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
108 * This structure represents both ldap messages and ldap responses.
109 * These are really the same, except in the case of search responses,
110 * where a response has multiple messages.
114 ber_int_t lm_msgid; /* the message id */
115 ber_tag_t lm_msgtype; /* the message type */
116 BerElement *lm_ber; /* the ber encoded message contents */
117 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
118 struct ldapmsg *lm_next; /* next response */
119 time_t lm_time; /* used to maintain cache */
123 * structure representing get/set'able options
124 * which have global defaults.
128 #define LDAP_UNINITIALIZED 0x0
129 #define LDAP_INITIALIZED 0x1
130 #define LDAP_VALID_SESSION 0x2
132 #ifdef LDAP_CONNECTIONLESS
133 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
134 void* ldo_peer; /* struct sockaddr* */
139 /* per API call timeout */
140 struct timeval *ldo_tm_api;
141 struct timeval *ldo_tm_net;
143 ber_int_t ldo_version;
145 ber_int_t ldo_timelimit;
146 ber_int_t ldo_sizelimit;
152 LDAPURLDesc *ldo_defludp;
155 char* ldo_defbinddn; /* bind dn */
157 #ifdef HAVE_CYRUS_SASL
158 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
159 char* ldo_def_sasl_realm; /* SASL realm */
160 char* ldo_def_sasl_authcid; /* SASL authentication identity */
161 char* ldo_def_sasl_authzid; /* SASL authorization identity */
163 /* SASL Security Properties */
164 struct sasl_security_properties ldo_sasl_secprops;
167 int ldo_refhoplimit; /* limit on referral nesting */
169 /* LDAPv3 server and client controls */
170 LDAPControl **ldo_sctrls;
171 LDAPControl **ldo_cctrls;
173 /* LDAP rebind callback function */
174 LDAP_REBIND_PROC *ldo_rebind_proc;
175 void *ldo_rebind_params;
177 LDAP_BOOLEANS ldo_booleans; /* boolean options */
182 * structure for representing an LDAP server connection
184 typedef struct ldap_conn {
190 #ifdef HAVE_CYRUS_SASL
191 void *lconn_sasl_ctx;
194 time_t lconn_lastused; /* time */
195 int lconn_rebind_inprogress; /* set if rebind in progress */
196 char ***lconn_rebind_queue; /* used if rebind in progress */
198 #define LDAP_CONNST_NEEDSOCKET 1
199 #define LDAP_CONNST_CONNECTING 2
200 #define LDAP_CONNST_CONNECTED 3
201 LDAPURLDesc *lconn_server;
202 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
203 char *lconn_krbinstance;
205 BerElement *lconn_ber; /* ber receiving on this conn. */
207 struct ldap_conn *lconn_next;
212 * structure used to track outstanding requests
214 typedef struct ldapreq {
215 ber_int_t lr_msgid; /* the message id */
216 int lr_status; /* status of request */
217 #define LDAP_REQST_COMPLETED 0
218 #define LDAP_REQST_INPROGRESS 1
219 #define LDAP_REQST_CHASINGREFS 2
220 #define LDAP_REQST_NOTCONNECTED 3
221 #define LDAP_REQST_WRITING 4
222 int lr_outrefcnt; /* count of outstanding referrals */
223 ber_int_t lr_origid; /* original request's message id */
224 int lr_parentcnt; /* count of parent requests */
225 ber_tag_t lr_res_msgtype; /* result message type */
226 ber_int_t lr_res_errno; /* result LDAP errno */
227 char *lr_res_error; /* result error string */
228 char *lr_res_matched;/* result matched DN string */
229 BerElement *lr_ber; /* ber encoded request contents */
230 LDAPConn *lr_conn; /* connection used to send request */
231 struct ldapreq *lr_parent; /* request that spawned this referral */
232 struct ldapreq *lr_child; /* first child request */
233 struct ldapreq *lr_refnext; /* next referral spawned */
234 struct ldapreq *lr_prev; /* previous request */
235 struct ldapreq *lr_next; /* next request */
239 * structure for client cache
241 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
242 typedef struct ldapcache {
243 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
244 LDAPMessage *lc_requests; /* unfulfilled reqs */
245 long lc_timeout; /* request timeout */
246 ber_len_t lc_maxmem; /* memory to use */
247 ber_len_t lc_memused; /* memory in use */
248 int lc_enabled; /* enabled? */
249 unsigned long lc_options; /* options */
250 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
251 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
255 * structure containing referral request info for rebind procedure
257 typedef struct ldapreqinfo {
264 * structure representing an ldap connection
268 Sockbuf *ld_sb; /* socket descriptor & buffer */
270 struct ldapoptions ld_options;
272 #define ld_valid ld_options.ldo_valid
273 #define ld_debug ld_options.ldo_debug
275 #define ld_deref ld_options.ldo_deref
276 #define ld_timelimit ld_options.ldo_timelimit
277 #define ld_sizelimit ld_options.ldo_sizelimit
279 #define ld_defbinddn ld_options.ldo_defbinddn
280 #define ld_defbase ld_options.ldo_defbase
281 #define ld_defhost ld_options.ldo_defhost
282 #define ld_defport ld_options.ldo_defport
284 #define ld_refhoplimit ld_options.ldo_refhoplimit
286 #define ld_sctrls ld_options.ldo_sctrls
287 #define ld_cctrls ld_options.ldo_cctrls
288 #define ld_rebind_proc ld_options.ldo_rebind_proc
289 #define ld_rebind_params ld_options.ldo_rebind_params
291 #define ld_version ld_options.ldo_version
293 unsigned short ld_lberoptions;
300 /* do not mess with these */
301 LDAPRequest *ld_requests; /* list of outstanding requests */
302 LDAPMessage *ld_responses; /* list of outstanding responses */
304 ber_int_t *ld_abandoned; /* array of abandoned requests */
306 LDAPCache *ld_cache; /* non-null if cache is initialized */
308 /* do not mess with the rest though */
310 LDAPConn *ld_defconn; /* default connection */
311 LDAPConn *ld_conns; /* list of server connections */
312 void *ld_selectinfo; /* platform specifics for select */
314 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
316 #ifdef LDAP_R_COMPILE
317 #ifdef HAVE_RES_QUERY
318 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
321 #ifdef HAVE_CYRUS_SASL
322 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
330 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
332 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
333 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
334 struct ldapoptions *, int *));
337 /* simple macros to realloc for now */
338 #define LDAP_MALLOC(s) (LBER_MALLOC((s)))
339 #define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s)))
340 #define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s)))
341 #define LDAP_FREE(p) (LBER_FREE((p)))
342 #define LDAP_VFREE(v) (LBER_VFREE((void **)(v)))
343 #define LDAP_STRDUP(s) (LBER_STRDUP((s)))
344 #define LDAP_STRNDUP(s,l) (LBER_STRNDUP((s),(l)))
349 LDAP_F (void) ldap_int_error_init( void );
354 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
360 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
365 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
366 BerElement *request ));
367 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
368 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
373 LDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
374 const LDAPControl *ctrl ));
376 LDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
377 LDAPControl *const *ctrls ));
379 LDAP_F (int) ldap_int_get_controls LDAP_P((
381 LDAPControl ***ctrlsp));
383 LDAP_F (int) ldap_int_put_controls LDAP_P((
385 LDAPControl *const *ctrls,
388 LDAP_F (int) ldap_int_client_controls LDAP_P((
390 LDAPControl **ctrlp ));
395 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
397 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
401 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
403 LDAP_CONST char *who,
404 LDAP_CONST char *service,
407 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
413 LDAP_F (int) ldap_open_defconn( LDAP *ld );
414 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
415 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
420 LDAP_V (int) ldap_int_tblsize;
421 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
422 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
423 int proto, const char *host, unsigned long address, int port,
426 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
427 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
428 LDAP_V (char *) ldap_int_hostname;
429 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
432 LDAP_F (void) ldap_int_ip_init( void );
433 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
434 LDAP_F (void *) ldap_new_select_info( void );
435 LDAP_F (void) ldap_free_select_info( void *sip );
436 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
437 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
438 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
439 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
440 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
446 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
447 const char *path, int async );
448 #endif /* LDAP_PF_LOCAL */
453 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
454 const char *dn, BerElement *ber );
455 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
456 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
458 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
459 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
460 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
461 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
462 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
463 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
464 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
465 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
466 char **errstrp, int sref, int *hadrefp );
467 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
468 char **refs, int sref, char **referralsp, int *hadrefp );
469 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
474 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
479 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
486 LDAPControl **sctrls,
487 LDAPControl **cctrls,
489 ber_int_t sizelimit ));
495 LDAP_F (int) ldap_ld_free LDAP_P((
498 LDAPControl **sctrls,
499 LDAPControl **cctrls ));
501 LDAP_F (int) ldap_send_unbind LDAP_P((
504 LDAPControl **sctrls,
505 LDAPControl **cctrls ));
510 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
511 LDAPURLDesc *ludp ));
513 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
514 LDAPURLDesc *ludlist ));
516 LDAP_F (int) ldap_url_parselist LDAP_P((
517 LDAPURLDesc **ludlist,
520 LDAP_F (int) ldap_url_parsehosts LDAP_P((
521 LDAPURLDesc **ludlist,
525 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
526 LDAPURLDesc *ludlist ));
528 LDAP_F (char *) ldap_url_list2urls LDAP_P((
529 LDAPURLDesc *ludlist ));
531 LDAP_F (void) ldap_free_urllist LDAP_P((
532 LDAPURLDesc *ludlist ));
538 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
540 LDAP_F (int) ldap_int_sasl_open LDAP_P((
541 LDAP *ld, LDAPConn *conn,
542 const char* host, ber_len_t ssf ));
543 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
545 LDAP_F (int) ldap_int_sasl_external LDAP_P((
546 LDAP *ld, LDAPConn *conn,
547 const char* authid, ber_len_t ssf ));
549 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
550 int option, void *arg ));
551 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
552 int option, void *arg ));
553 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
554 int option, const char *arg ));
556 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
560 LDAPControl **, LDAPControl **,
562 /* should be passed in client controls */
564 LDAP_SASL_INTERACT_PROC *interact,
568 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
576 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
577 int option, const char *arg ));
579 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
580 LDAPConn *conn, LDAPURLDesc *srv ));
584 #endif /* _LDAP_INT_H */