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 */
29 #define SASL_MAX_BUFF_SIZE 65536
30 #define SASL_MIN_BUFF_SIZE 4096
34 * Support needed if the library is running in the kernel
36 #if LDAP_INT_IN_KERNEL
38 * Platform specific function to return a pointer to the
39 * process-specific global options.
41 * This function should perform the following functions:
42 * Allocate and initialize a global options struct on a per process basis
43 * Use callers process identifier to return its global options struct
44 * Note: Deallocate structure when the process exits
46 # define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
47 struct ldapoptions *ldap_int_global_opt(void);
49 # define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
52 #define ldap_debug ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
57 #define Debug( level, fmt, arg1, arg2, arg3 ) \
58 do { if ( ldap_debug & level ) \
59 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
62 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
63 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
71 #define LDAP_URL_PREFIX "ldap://"
72 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
73 #define LDAPS_URL_PREFIX "ldaps://"
74 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
75 #define LDAPI_URL_PREFIX "ldapi://"
76 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
77 #ifdef LDAP_CONNECTIONLESS
78 #define LDAPC_URL_PREFIX "cldap://"
79 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
81 #define LDAP_URL_URLCOLON "URL:"
82 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
84 #define LDAP_REF_STR "Referral:\n"
85 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
86 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
87 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
89 #define LDAP_DEFAULT_REFHOPLIMIT 5
91 #define LDAP_BOOL_REFERRALS 0
92 #define LDAP_BOOL_RESTART 1
93 #define LDAP_BOOL_TLS 3
95 #define LDAP_BOOLEANS unsigned long
96 #define LDAP_BOOL(n) (1 << (n))
97 #define LDAP_BOOL_GET(lo, bool) \
98 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
99 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
100 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
101 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
104 * This structure represents both ldap messages and ldap responses.
105 * These are really the same, except in the case of search responses,
106 * where a response has multiple messages.
110 ber_int_t lm_msgid; /* the message id */
111 ber_tag_t lm_msgtype; /* the message type */
112 BerElement *lm_ber; /* the ber encoded message contents */
113 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
114 struct ldapmsg *lm_next; /* next response */
115 time_t lm_time; /* used to maintain cache */
119 * structure representing get/set'able options
120 * which have global defaults.
124 #define LDAP_UNINITIALIZED 0x0
125 #define LDAP_INITIALIZED 0x1
126 #define LDAP_VALID_SESSION 0x2
127 #ifdef LDAP_CONNECTIONLESS
128 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
129 void* ldo_peer; /* struct sockaddr* */
135 /* per API call timeout */
136 struct timeval *ldo_tm_api;
137 struct timeval *ldo_tm_net;
139 ber_int_t ldo_version;
141 ber_int_t ldo_timelimit;
142 ber_int_t ldo_sizelimit;
148 LDAPURLDesc *ldo_defludp;
151 char* ldo_defbinddn; /* bind dn */
153 #ifdef HAVE_CYRUS_SASL
154 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
155 char* ldo_def_sasl_realm; /* SASL realm */
156 char* ldo_def_sasl_authcid; /* SASL authentication identity */
157 char* ldo_def_sasl_authzid; /* SASL authorization identity */
159 /* SASL Security Properties */
160 struct sasl_security_properties ldo_sasl_secprops;
163 int ldo_refhoplimit; /* limit on referral nesting */
165 /* LDAPv3 server and client controls */
166 LDAPControl **ldo_sctrls;
167 LDAPControl **ldo_cctrls;
169 /* LDAP rebind callback function */
170 LDAP_REBIND_PROC *ldo_rebind_proc;
171 void *ldo_rebind_params;
173 LDAP_BOOLEANS ldo_booleans; /* boolean options */
178 * structure for representing an LDAP server connection
180 typedef struct ldap_conn {
186 #ifdef HAVE_CYRUS_SASL
187 void *lconn_sasl_ctx;
190 time_t lconn_lastused; /* time */
191 int lconn_rebind_inprogress; /* set if rebind in progress */
192 char ***lconn_rebind_queue; /* used if rebind in progress */
194 #define LDAP_CONNST_NEEDSOCKET 1
195 #define LDAP_CONNST_CONNECTING 2
196 #define LDAP_CONNST_CONNECTED 3
197 LDAPURLDesc *lconn_server;
198 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
199 char *lconn_krbinstance;
201 BerElement *lconn_ber; /* ber receiving on this conn. */
203 struct ldap_conn *lconn_next;
208 * structure used to track outstanding requests
210 typedef struct ldapreq {
211 ber_int_t lr_msgid; /* the message id */
212 int lr_status; /* status of request */
213 #define LDAP_REQST_COMPLETED 0
214 #define LDAP_REQST_INPROGRESS 1
215 #define LDAP_REQST_CHASINGREFS 2
216 #define LDAP_REQST_NOTCONNECTED 3
217 #define LDAP_REQST_WRITING 4
218 int lr_outrefcnt; /* count of outstanding referrals */
219 ber_int_t lr_origid; /* original request's message id */
220 int lr_parentcnt; /* count of parent requests */
221 ber_tag_t lr_res_msgtype; /* result message type */
222 ber_int_t lr_res_errno; /* result LDAP errno */
223 char *lr_res_error; /* result error string */
224 char *lr_res_matched;/* result matched DN string */
225 BerElement *lr_ber; /* ber encoded request contents */
226 LDAPConn *lr_conn; /* connection used to send request */
227 struct ldapreq *lr_parent; /* request that spawned this referral */
228 struct ldapreq *lr_child; /* first child request */
229 struct ldapreq *lr_refnext; /* next referral spawned */
230 struct ldapreq *lr_prev; /* previous request */
231 struct ldapreq *lr_next; /* next request */
235 * structure for client cache
237 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
238 typedef struct ldapcache {
239 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
240 LDAPMessage *lc_requests; /* unfulfilled reqs */
241 long lc_timeout; /* request timeout */
242 ber_len_t lc_maxmem; /* memory to use */
243 ber_len_t lc_memused; /* memory in use */
244 int lc_enabled; /* enabled? */
245 unsigned long lc_options; /* options */
246 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
247 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
251 * structure containing referral request info for rebind procedure
253 typedef struct ldapreqinfo {
260 * structure representing an ldap connection
264 Sockbuf *ld_sb; /* socket descriptor & buffer */
266 struct ldapoptions ld_options;
268 #define ld_valid ld_options.ldo_valid
269 #define ld_debug ld_options.ldo_debug
271 #define ld_deref ld_options.ldo_deref
272 #define ld_timelimit ld_options.ldo_timelimit
273 #define ld_sizelimit ld_options.ldo_sizelimit
275 #define ld_defbinddn ld_options.ldo_defbinddn
276 #define ld_defbase ld_options.ldo_defbase
277 #define ld_defhost ld_options.ldo_defhost
278 #define ld_defport ld_options.ldo_defport
280 #define ld_refhoplimit ld_options.ldo_refhoplimit
282 #define ld_sctrls ld_options.ldo_sctrls
283 #define ld_cctrls ld_options.ldo_cctrls
284 #define ld_rebind_proc ld_options.ldo_rebind_proc
285 #define ld_rebind_params ld_options.ldo_rebind_params
287 #define ld_version ld_options.ldo_version
289 unsigned short ld_lberoptions;
296 /* do not mess with these */
297 LDAPRequest *ld_requests; /* list of outstanding requests */
298 LDAPMessage *ld_responses; /* list of outstanding responses */
300 ber_int_t *ld_abandoned; /* array of abandoned requests */
302 LDAPCache *ld_cache; /* non-null if cache is initialized */
304 /* do not mess with the rest though */
306 LDAPConn *ld_defconn; /* default connection */
307 LDAPConn *ld_conns; /* list of server connections */
308 void *ld_selectinfo; /* platform specifics for select */
310 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
312 #ifdef LDAP_R_COMPILE
313 #ifdef HAVE_RES_QUERY
314 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
317 #ifdef HAVE_CYRUS_SASL
318 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
326 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
328 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
329 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
330 struct ldapoptions *, int *));
333 /* simple macros to realloc for now */
334 #define LDAP_MALLOC(s) (LBER_MALLOC((s)))
335 #define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s)))
336 #define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s)))
337 #define LDAP_FREE(p) (LBER_FREE((p)))
338 #define LDAP_VFREE(v) (LBER_VFREE((void **)(v)))
339 #define LDAP_STRDUP(s) (LBER_STRDUP((s)))
340 #define LDAP_STRNDUP(s,l) (LBER_STRNDUP((s),(l)))
345 LDAP_F (void) ldap_int_error_init( void );
350 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
356 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
361 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
362 BerElement *request ));
363 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
364 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
369 LDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
370 const LDAPControl *ctrl ));
372 LDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
373 LDAPControl *const *ctrls ));
375 LDAP_F (int) ldap_int_get_controls LDAP_P((
377 LDAPControl ***ctrlsp));
379 LDAP_F (int) ldap_int_put_controls LDAP_P((
381 LDAPControl *const *ctrls,
384 LDAP_F (int) ldap_int_client_controls LDAP_P((
386 LDAPControl **ctrlp ));
391 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
393 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
397 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
399 LDAP_CONST char *who,
400 LDAP_CONST char *service,
403 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
409 LDAP_F (int) ldap_open_defconn( LDAP *ld );
410 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
411 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
416 LDAP_V (int) ldap_int_tblsize;
417 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
418 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
419 int proto, const char *host, unsigned long address, int port,
422 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
423 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
424 LDAP_V (char *) ldap_int_hostname;
425 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
428 LDAP_F (void) ldap_int_ip_init( void );
429 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
430 LDAP_F (void *) ldap_new_select_info( void );
431 LDAP_F (void) ldap_free_select_info( void *sip );
432 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
433 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
434 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
435 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
436 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
442 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
443 const char *path, int async );
444 #endif /* LDAP_PF_LOCAL */
449 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
450 const char *dn, BerElement *ber );
451 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
452 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
454 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
455 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
456 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
457 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
458 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
459 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
460 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
461 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
462 char **errstrp, int sref, int *hadrefp );
463 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
464 char **refs, int sref, char **referralsp, int *hadrefp );
465 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
470 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
475 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
482 LDAPControl **sctrls,
483 LDAPControl **cctrls,
485 ber_int_t sizelimit ));
487 LDAP_F( int ) ldap_int_put_filter LDAP_P((
494 LDAP_F (int) ldap_ld_free LDAP_P((
497 LDAPControl **sctrls,
498 LDAPControl **cctrls ));
500 LDAP_F (int) ldap_send_unbind LDAP_P((
503 LDAPControl **sctrls,
504 LDAPControl **cctrls ));
509 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
510 LDAPURLDesc *ludp ));
512 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
513 LDAPURLDesc *ludlist ));
515 LDAP_F (int) ldap_url_parselist LDAP_P((
516 LDAPURLDesc **ludlist,
519 LDAP_F (int) ldap_url_parsehosts LDAP_P((
520 LDAPURLDesc **ludlist,
524 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
525 LDAPURLDesc *ludlist ));
527 LDAP_F (char *) ldap_url_list2urls LDAP_P((
528 LDAPURLDesc *ludlist ));
530 LDAP_F (void) ldap_free_urllist LDAP_P((
531 LDAPURLDesc *ludlist ));
537 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
539 LDAP_F (int) ldap_int_sasl_open LDAP_P((
540 LDAP *ld, LDAPConn *conn,
541 const char* host, ber_len_t ssf ));
542 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
544 LDAP_F (int) ldap_int_sasl_external LDAP_P((
545 LDAP *ld, LDAPConn *conn,
546 const char* authid, ber_len_t ssf ));
548 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
549 int option, void *arg ));
550 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
551 int option, void *arg ));
552 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
553 int option, const char *arg ));
555 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
559 LDAPControl **, LDAPControl **,
561 /* should be passed in client controls */
563 LDAP_SASL_INTERACT_PROC *interact,
567 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
575 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
576 int option, const char *arg ));
578 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
579 LDAPConn *conn, LDAPURLDesc *srv ));
583 #endif /* _LDAP_INT_H */