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"
23 #ifdef HAVE_CYRUS_SASL
24 /* the need for this should be removed */
27 #define SASL_MAX_BUFF_SIZE 65536
28 #define SASL_MIN_BUFF_SIZE 4096
32 * Support needed if the library is running in the kernel
34 #if LDAP_INT_IN_KERNEL
36 * Platform specific function to return a pointer to the
37 * process-specific global options.
39 * This function should perform the following functions:
40 * Allocate and initialize a global options struct on a per process basis
41 * Use callers process identifier to return its global options struct
42 * Note: Deallocate structure when the process exits
44 # define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
45 struct ldapoptions *ldap_int_global_opt(void);
47 # define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
50 #define ldap_debug ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
55 #define Debug( level, fmt, arg1, arg2, arg3 ) \
56 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
58 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
59 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
67 #define LDAP_URL_PREFIX "ldap://"
68 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
69 #define LDAPS_URL_PREFIX "ldaps://"
70 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
71 #define LDAPI_URL_PREFIX "ldapi://"
72 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
73 #ifdef LDAP_CONNECTIONLESS
74 #define LDAPC_URL_PREFIX "cldap://"
75 #define LDAPC_URL_PREFIX_LEN (sizeof(LDAPC_URL_PREFIX)-1)
77 #define LDAP_URL_URLCOLON "URL:"
78 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
80 #define LDAP_REF_STR "Referral:\n"
81 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
82 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
83 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
85 #define LDAP_DEFAULT_REFHOPLIMIT 5
87 #define LDAP_BOOL_REFERRALS 0
88 #define LDAP_BOOL_RESTART 1
89 #define LDAP_BOOL_TLS 3
91 #define LDAP_BOOLEANS unsigned long
92 #define LDAP_BOOL(n) (1 << (n))
93 #define LDAP_BOOL_GET(lo, bool) \
94 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
95 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
96 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
97 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
100 * This structure represents both ldap messages and ldap responses.
101 * These are really the same, except in the case of search responses,
102 * where a response has multiple messages.
106 ber_int_t lm_msgid; /* the message id */
107 ber_tag_t lm_msgtype; /* the message type */
108 BerElement *lm_ber; /* the ber encoded message contents */
109 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
110 struct ldapmsg *lm_next; /* next response */
111 time_t lm_time; /* used to maintain cache */
115 * structure representing get/set'able options
116 * which have global defaults.
120 #define LDAP_UNINITIALIZED 0x0
121 #define LDAP_INITIALIZED 0x1
122 #define LDAP_VALID_SESSION 0x2
123 #ifdef LDAP_CONNECTIONLESS
124 #define LDAP_IS_UDP(ld) ((ld)->ld_options.ldo_is_udp)
125 void* ldo_peer; /* struct sockaddr* */
131 /* per API call timeout */
132 struct timeval *ldo_tm_api;
133 struct timeval *ldo_tm_net;
135 ber_int_t ldo_version;
137 ber_int_t ldo_timelimit;
138 ber_int_t ldo_sizelimit;
144 LDAPURLDesc *ldo_defludp;
147 char* ldo_defbinddn; /* bind dn */
149 #ifdef HAVE_CYRUS_SASL
150 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
151 char* ldo_def_sasl_realm; /* SASL realm */
152 char* ldo_def_sasl_authcid; /* SASL authentication identity */
153 char* ldo_def_sasl_authzid; /* SASL authorization identity */
155 /* SASL Security Properties */
156 struct sasl_security_properties ldo_sasl_secprops;
159 int ldo_refhoplimit; /* limit on referral nesting */
161 /* LDAPv3 server and client controls */
162 LDAPControl **ldo_sctrls;
163 LDAPControl **ldo_cctrls;
165 /* LDAP rebind callback function */
166 LDAP_REBIND_PROC *ldo_rebind_proc;
167 void *ldo_rebind_params;
169 LDAP_BOOLEANS ldo_booleans; /* boolean options */
174 * structure for representing an LDAP server connection
176 typedef struct ldap_conn {
182 #ifdef HAVE_CYRUS_SASL
183 void *lconn_sasl_ctx;
186 time_t lconn_lastused; /* time */
187 int lconn_rebind_inprogress; /* set if rebind in progress */
188 char ***lconn_rebind_queue; /* used if rebind in progress */
190 #define LDAP_CONNST_NEEDSOCKET 1
191 #define LDAP_CONNST_CONNECTING 2
192 #define LDAP_CONNST_CONNECTED 3
193 LDAPURLDesc *lconn_server;
194 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
195 char *lconn_krbinstance;
197 BerElement *lconn_ber; /* ber receiving on this conn. */
199 struct ldap_conn *lconn_next;
204 * structure used to track outstanding requests
206 typedef struct ldapreq {
207 ber_int_t lr_msgid; /* the message id */
208 int lr_status; /* status of request */
209 #define LDAP_REQST_COMPLETED 0
210 #define LDAP_REQST_INPROGRESS 1
211 #define LDAP_REQST_CHASINGREFS 2
212 #define LDAP_REQST_NOTCONNECTED 3
213 #define LDAP_REQST_WRITING 4
214 int lr_outrefcnt; /* count of outstanding referrals */
215 ber_int_t lr_origid; /* original request's message id */
216 int lr_parentcnt; /* count of parent requests */
217 ber_tag_t lr_res_msgtype; /* result message type */
218 ber_int_t lr_res_errno; /* result LDAP errno */
219 char *lr_res_error; /* result error string */
220 char *lr_res_matched;/* result matched DN string */
221 BerElement *lr_ber; /* ber encoded request contents */
222 LDAPConn *lr_conn; /* connection used to send request */
223 struct ldapreq *lr_parent; /* request that spawned this referral */
224 struct ldapreq *lr_child; /* first child request */
225 struct ldapreq *lr_refnext; /* next referral spawned */
226 struct ldapreq *lr_prev; /* previous request */
227 struct ldapreq *lr_next; /* next request */
231 * structure for client cache
233 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
234 typedef struct ldapcache {
235 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
236 LDAPMessage *lc_requests; /* unfulfilled reqs */
237 long lc_timeout; /* request timeout */
238 ber_len_t lc_maxmem; /* memory to use */
239 ber_len_t lc_memused; /* memory in use */
240 int lc_enabled; /* enabled? */
241 unsigned long lc_options; /* options */
242 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
243 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
247 * structure containing referral request info for rebind procedure
249 typedef struct ldapreqinfo {
256 * structure representing an ldap connection
260 Sockbuf *ld_sb; /* socket descriptor & buffer */
262 struct ldapoptions ld_options;
264 #define ld_valid ld_options.ldo_valid
265 #define ld_debug ld_options.ldo_debug
267 #define ld_deref ld_options.ldo_deref
268 #define ld_timelimit ld_options.ldo_timelimit
269 #define ld_sizelimit ld_options.ldo_sizelimit
271 #define ld_defbinddn ld_options.ldo_defbinddn
272 #define ld_defbase ld_options.ldo_defbase
273 #define ld_defhost ld_options.ldo_defhost
274 #define ld_defport ld_options.ldo_defport
276 #define ld_refhoplimit ld_options.ldo_refhoplimit
278 #define ld_sctrls ld_options.ldo_sctrls
279 #define ld_cctrls ld_options.ldo_cctrls
280 #define ld_rebind_proc ld_options.ldo_rebind_proc
281 #define ld_rebind_params ld_options.ldo_rebind_params
283 #define ld_version ld_options.ldo_version
285 unsigned short ld_lberoptions;
292 /* do not mess with these */
293 LDAPRequest *ld_requests; /* list of outstanding requests */
294 LDAPMessage *ld_responses; /* list of outstanding responses */
296 ber_int_t *ld_abandoned; /* array of abandoned requests */
298 LDAPCache *ld_cache; /* non-null if cache is initialized */
300 /* do not mess with the rest though */
302 LDAPConn *ld_defconn; /* default connection */
303 LDAPConn *ld_conns; /* list of server connections */
304 void *ld_selectinfo; /* platform specifics for select */
306 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
308 #ifdef LDAP_R_COMPILE
309 #include <ldap_pvt_thread.h>
311 #ifdef HAVE_RES_QUERY
312 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
315 #ifdef HAVE_CYRUS_SASL
316 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
324 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
326 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
327 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
328 struct ldapoptions *, int *));
331 /* simple macros to realloc for now */
332 #define LDAP_INT_MALLOC(s) (LBER_MALLOC((s)))
333 #define LDAP_INT_CALLOC(n,s) (LBER_CALLOC((n),(s)))
334 #define LDAP_INT_REALLOC(p,s) (LBER_REALLOC((p),(s)))
335 #define LDAP_INT_FREE(p) (LBER_FREE((p)))
336 #define LDAP_INT_VFREE(v) (LBER_VFREE((void **)(v)))
337 #define LDAP_INT_STRDUP(s) (LBER_STRDUP((s)))
339 #define LDAP_MALLOC(s) (LBER_MALLOC((s)))
340 #define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s)))
341 #define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s)))
342 #define LDAP_FREE(p) (LBER_FREE((p)))
343 #define LDAP_VFREE(v) (LBER_VFREE((void **)(v)))
344 #define LDAP_STRDUP(s) (LBER_STRDUP((s)))
345 #define LDAP_STRNDUP(s,l) (LBER_STRNDUP((s),(l)))
350 LDAP_F (void) ldap_int_error_init( void );
355 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
361 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
366 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
367 BerElement *request ));
368 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
369 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
374 LDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
375 const LDAPControl *ctrl ));
377 LDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
378 LDAPControl *const *ctrls ));
380 LDAP_F (int) ldap_int_get_controls LDAP_P((
382 LDAPControl ***ctrlsp));
384 LDAP_F (int) ldap_int_put_controls LDAP_P((
386 LDAPControl *const *ctrls,
389 LDAP_F (int) ldap_int_client_controls LDAP_P((
391 LDAPControl **ctrlp ));
396 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
398 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
402 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
404 LDAP_CONST char *who,
405 LDAP_CONST char *service,
408 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
414 LDAP_F (int) ldap_open_defconn( LDAP *ld );
415 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
416 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
421 LDAP_V (int) ldap_int_tblsize;
422 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
423 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
424 int proto, const char *host, unsigned long address, int port,
427 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || \
428 defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
429 LDAP_V (char *) ldap_int_hostname;
430 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
433 LDAP_F (void) ldap_int_ip_init( void );
434 LDAP_F (int) do_ldap_select( LDAP *ld, struct timeval *timeout );
435 LDAP_F (void *) ldap_new_select_info( void );
436 LDAP_F (void) ldap_free_select_info( void *sip );
437 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
438 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
439 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
440 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
441 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
447 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
448 const char *path, int async );
449 #endif /* LDAP_PF_LOCAL */
454 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
455 const char *dn, BerElement *ber );
456 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
457 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
459 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
460 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
461 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
462 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
463 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
464 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
465 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
466 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
467 char **errstrp, int sref, int *hadrefp );
468 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
469 char **refs, int sref, char **referralsp, int *hadrefp );
470 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
475 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
480 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
487 LDAPControl **sctrls,
488 LDAPControl **cctrls,
490 ber_int_t sizelimit ));
495 /* see <ac/string.h> */
500 LDAP_F (int) ldap_ld_free LDAP_P((
503 LDAPControl **sctrls,
504 LDAPControl **cctrls ));
506 LDAP_F (int) ldap_send_unbind LDAP_P((
509 LDAPControl **sctrls,
510 LDAPControl **cctrls ));
515 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
516 LDAPURLDesc *ludp ));
518 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
519 LDAPURLDesc *ludlist ));
521 LDAP_F (int) ldap_url_parselist LDAP_P((
522 LDAPURLDesc **ludlist,
525 LDAP_F (int) ldap_url_parsehosts LDAP_P((
526 LDAPURLDesc **ludlist,
530 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
531 LDAPURLDesc *ludlist ));
533 LDAP_F (char *) ldap_url_list2urls LDAP_P((
534 LDAPURLDesc *ludlist ));
536 LDAP_F (void) ldap_free_urllist LDAP_P((
537 LDAPURLDesc *ludlist ));
543 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
545 LDAP_F (int) ldap_int_sasl_open LDAP_P((
546 LDAP *ld, LDAPConn *conn,
547 const char* host, ber_len_t ssf ));
548 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
550 LDAP_F (int) ldap_int_sasl_external LDAP_P((
551 LDAP *ld, LDAPConn *conn,
552 const char* authid, ber_len_t ssf ));
554 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
555 int option, void *arg ));
556 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
557 int option, void *arg ));
558 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
559 int option, const char *arg ));
561 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
565 LDAPControl **, LDAPControl **,
567 /* should be passed in client controls */
569 LDAP_SASL_INTERACT_PROC *interact,
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 */