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"
21 #ifdef HAVE_CYRUS_SASL
22 /* the need for this should be removed */
27 * Support needed if the library is running in the kernel
29 #if LDAP_INT_IN_KERNEL
31 * Platform specific function to return a pointer to the
32 * process-specific global options.
34 * This function should perform the following functions:
35 * Allocate and initialize a global options struct on a per process basis
36 * Use callers process identifier to return its global options struct
37 * Note: Deallocate structure when the process exits
39 # define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
40 struct ldapoptions *ldap_int_global_opt(void);
42 # define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
45 #define ldap_debug ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
50 #define Debug( level, fmt, arg1, arg2, arg3 ) \
51 ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
59 #define LDAP_URL_PREFIX "ldap://"
60 #define LDAP_URL_PREFIX_LEN (sizeof(LDAP_URL_PREFIX)-1)
61 #define LDAPS_URL_PREFIX "ldaps://"
62 #define LDAPS_URL_PREFIX_LEN (sizeof(LDAPS_URL_PREFIX)-1)
63 #define LDAPI_URL_PREFIX "ldapi://"
64 #define LDAPI_URL_PREFIX_LEN (sizeof(LDAPI_URL_PREFIX)-1)
65 #define LDAP_URL_URLCOLON "URL:"
66 #define LDAP_URL_URLCOLON_LEN (sizeof(LDAP_URL_URLCOLON)-1)
68 #define CLDAP_URL_PREFIX "cldap://"
69 #define CLDAP_URL_PREFIX_LEN (sizeof(CLDAP_URL_PREFIX)-1)
71 #define LDAP_REF_STR "Referral:\n"
72 #define LDAP_REF_STR_LEN (sizeof(LDAP_REF_STR)-1)
73 #define LDAP_LDAP_REF_STR LDAP_URL_PREFIX
74 #define LDAP_LDAP_REF_STR_LEN LDAP_URL_PREFIX_LEN
76 #define LDAP_DEFAULT_REFHOPLIMIT 5
78 #define LDAP_BOOL_REFERRALS 0
79 #define LDAP_BOOL_RESTART 1
80 #define LDAP_BOOL_TLS 3
82 #define LDAP_BOOLEANS unsigned long
83 #define LDAP_BOOL(n) (1 << (n))
84 #define LDAP_BOOL_GET(lo, bool) \
85 ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
86 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
87 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
88 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
91 * This structure represents both ldap messages and ldap responses.
92 * These are really the same, except in the case of search responses,
93 * where a response has multiple messages.
97 ber_int_t lm_msgid; /* the message id */
98 ber_tag_t lm_msgtype; /* the message type */
99 BerElement *lm_ber; /* the ber encoded message contents */
100 struct ldapmsg *lm_chain; /* for search - next msg in the resp */
101 struct ldapmsg *lm_next; /* next response */
102 time_t lm_time; /* used to maintain cache */
106 * structure representing get/set'able options
107 * which have global defaults.
111 #define LDAP_UNINITIALIZED 0x0
112 #define LDAP_INITIALIZED 0x1
113 #define LDAP_VALID_SESSION 0x2
116 /* per API call timeout */
117 struct timeval *ldo_tm_api;
118 struct timeval *ldo_tm_net;
120 ber_int_t ldo_version;
122 ber_int_t ldo_timelimit;
123 ber_int_t ldo_sizelimit;
125 LDAPURLDesc *ldo_defludp;
128 char* ldo_defbinddn; /* bind dn */
130 #ifdef HAVE_CYRUS_SASL
131 char* ldo_def_sasl_mech; /* SASL Mechanism(s) */
132 char* ldo_def_sasl_realm; /* SASL realm */
133 char* ldo_def_sasl_authcid; /* SASL authentication identity */
134 char* ldo_def_sasl_authzid; /* SASL authorization identity */
136 /* SASL Security Properties */
137 struct sasl_security_properties ldo_sasl_secprops;
140 int ldo_refhoplimit; /* limit on referral nesting */
142 /* LDAPv3 server and client controls */
143 LDAPControl **ldo_sctrls;
144 LDAPControl **ldo_cctrls;
146 /* LDAP rebind callback function */
147 LDAP_REBIND_PROC *ldo_rebindproc;
154 LDAP_BOOLEANS ldo_booleans; /* boolean options */
159 * structure for tracking LDAP server host, ports, DNs, etc.
161 typedef struct ldap_server {
163 char *lsrv_dn; /* if NULL, use default */
165 struct ldap_server *lsrv_next;
170 * structure for representing an LDAP server connection
172 typedef struct ldap_conn {
174 void *lconn_sasl_ctx;
176 time_t lconn_lastused; /* time */
177 int lconn_rebind_inprogress; /* set if rebind in progress */
178 char ***lconn_rebind_queue; /* used if rebind in progress */
180 #define LDAP_CONNST_NEEDSOCKET 1
181 #define LDAP_CONNST_CONNECTING 2
182 #define LDAP_CONNST_CONNECTED 3
183 LDAPURLDesc *lconn_server;
184 char *lconn_krbinstance;
185 struct ldap_conn *lconn_next;
186 BerElement *lconn_ber;/* ber receiving on this conn. */
191 * structure used to track outstanding requests
193 typedef struct ldapreq {
194 ber_int_t lr_msgid; /* the message id */
195 int lr_status; /* status of request */
196 #define LDAP_REQST_COMPLETED 0
197 #define LDAP_REQST_INPROGRESS 1
198 #define LDAP_REQST_CHASINGREFS 2
199 #define LDAP_REQST_NOTCONNECTED 3
200 #define LDAP_REQST_WRITING 4
201 int lr_outrefcnt; /* count of outstanding referrals */
202 ber_int_t lr_origid; /* original request's message id */
203 int lr_parentcnt; /* count of parent requests */
204 ber_tag_t lr_res_msgtype; /* result message type */
205 ber_int_t lr_res_errno; /* result LDAP errno */
206 char *lr_res_error; /* result error string */
207 char *lr_res_matched;/* result matched DN string */
208 BerElement *lr_ber; /* ber encoded request contents */
209 LDAPConn *lr_conn; /* connection used to send request */
210 struct ldapreq *lr_parent; /* request that spawned this referral */
211 struct ldapreq *lr_refnext; /* next referral spawned */
212 struct ldapreq *lr_prev; /* previous request */
213 struct ldapreq *lr_next; /* next request */
217 * structure for client cache
219 #define LDAP_CACHE_BUCKETS 31 /* cache hash table size */
220 typedef struct ldapcache {
221 LDAPMessage *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
222 LDAPMessage *lc_requests; /* unfulfilled reqs */
223 long lc_timeout; /* request timeout */
224 ber_len_t lc_maxmem; /* memory to use */
225 ber_len_t lc_memused; /* memory in use */
226 int lc_enabled; /* enabled? */
227 unsigned long lc_options; /* options */
228 #define LDAP_CACHE_OPT_CACHENOERRS 0x00000001
229 #define LDAP_CACHE_OPT_CACHEALLERRS 0x00000002
233 * structure containing referral request info for rebind procedure
235 typedef struct ldapreqinfo {
242 * structure representing an ldap connection
246 Sockbuf *ld_sb; /* socket descriptor & buffer */
248 struct ldapoptions ld_options;
250 #define ld_valid ld_options.ldo_valid
251 #define ld_debug ld_options.ldo_debug
253 #define ld_deref ld_options.ldo_deref
254 #define ld_timelimit ld_options.ldo_timelimit
255 #define ld_sizelimit ld_options.ldo_sizelimit
257 #define ld_defbinddn ld_options.ldo_defbinddn
258 #define ld_defbase ld_options.ldo_defbase
259 #define ld_defhost ld_options.ldo_defhost
260 #define ld_defport ld_options.ldo_defport
262 #define ld_refhoplimit ld_options.ldo_refhoplimit
264 #define ld_sctrls ld_options.ldo_sctrls
265 #define ld_cctrls ld_options.ldo_cctrls
266 #define ld_rebindproc ld_options.ldo_rebindproc
268 #define ld_version ld_options.ldo_version
273 unsigned short ld_lberoptions;
275 LDAPFiltDesc *ld_filtd; /* from getfilter for ufn searches */
276 char *ld_ufnprefix; /* for incomplete ufn's */
283 /* do not mess with these */
284 LDAPRequest *ld_requests; /* list of outstanding requests */
285 LDAPMessage *ld_responses; /* list of outstanding responses */
287 ber_int_t *ld_abandoned; /* array of abandoned requests */
289 LDAPCache *ld_cache; /* non-null if cache is initialized */
291 /* do not mess with the rest though */
293 LDAPConn *ld_defconn; /* default connection */
294 LDAPConn *ld_conns; /* list of server connections */
295 void *ld_selectinfo; /* platform specifics for select */
297 #define LDAP_VALID(ld) ( (ld)->ld_valid == LDAP_VALID_SESSION )
299 #if defined(HAVE_RES_QUERY) && defined(LDAP_R_COMPILE)
300 #include <ldap_pvt_thread.h>
301 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
302 #endif /* HAVE_RES_QUERY && LDAP_R_COMPILE */
308 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
310 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
311 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
312 struct ldapoptions *, int *));
315 /* simple macros to realloc for now */
316 #define LDAP_INT_MALLOC(s) (LBER_MALLOC((s)))
317 #define LDAP_INT_CALLOC(n,s) (LBER_CALLOC((n),(s)))
318 #define LDAP_INT_REALLOC(p,s) (LBER_REALLOC((p),(s)))
319 #define LDAP_INT_FREE(p) (LBER_FREE((p)))
320 #define LDAP_INT_VFREE(v) (LBER_VFREE((void **)(v)))
321 #define LDAP_INT_STRDUP(s) (LBER_STRDUP((s)))
323 #define LDAP_MALLOC(s) (LBER_MALLOC((s)))
324 #define LDAP_CALLOC(n,s) (LBER_CALLOC((n),(s)))
325 #define LDAP_REALLOC(p,s) (LBER_REALLOC((p),(s)))
326 #define LDAP_FREE(p) (LBER_FREE((p)))
327 #define LDAP_VFREE(v) (LBER_VFREE((void **)(v)))
328 #define LDAP_STRDUP(s) (LBER_STRDUP((s)))
333 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
339 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
344 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
345 BerElement *request ));
346 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
347 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
352 LDAP_F (LDAPControl *) ldap_control_dup LDAP_P((
353 const LDAPControl *ctrl ));
355 LDAP_F (LDAPControl **) ldap_controls_dup LDAP_P((
356 LDAPControl *const *ctrls ));
358 LDAP_F (int) ldap_int_get_controls LDAP_P((
360 LDAPControl ***ctrlsp));
362 LDAP_F (int) ldap_int_put_controls LDAP_P((
364 LDAPControl *const *ctrls,
371 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
373 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
377 LDAP_F (char *) ldap_get_kerberosv4_credentials LDAP_P((
379 LDAP_CONST char *who,
380 LDAP_CONST char *service,
383 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
389 LDAP_F (int) ldap_open_defconn( LDAP *ld );
390 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
391 LDAPConn *conn, LDAPURLDesc *srvlist, int async );
396 LDAP_F (int) ldap_int_tblsize;
397 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest, const struct timeval *tm );
398 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
399 int proto, const char *host, unsigned long address, int port,
402 #if defined(LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND) || defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
403 LDAP_V (char *) ldap_int_hostname;
404 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb );
405 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND */
407 LDAP_F (void) ldap_int_ip_init( void );
408 LDAP_F (int) do_ldap_select( LDAP *ld, struct timeval *timeout );
409 LDAP_F (void *) ldap_new_select_info( void );
410 LDAP_F (void) ldap_free_select_info( void *sip );
411 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
412 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
413 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
414 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
415 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
421 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb, int proto,
422 const char *path, int async );
423 #endif /* LDAP_PF_UNIX */
428 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
429 const char *dn, BerElement *ber );
430 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
431 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
433 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber, ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc *srvlist, LDAPConn *lc, LDAPreqinfo *bind );
434 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb, int connect, LDAPreqinfo *bind );
435 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
436 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
437 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
438 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
439 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
440 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp );
441 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, char **referralsp, int *hadrefp );
442 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
447 LDAP_F (char *) ldap_int_msgtype2str( ber_tag_t tag );
452 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
459 LDAPControl **sctrls,
460 LDAPControl **cctrls,
462 ber_int_t sizelimit ));
467 /* see <ac/string.h> */
472 LDAP_F (int) ldap_ld_free LDAP_P((
475 LDAPControl **sctrls,
476 LDAPControl **cctrls ));
478 LDAP_F (int) ldap_send_unbind LDAP_P((
481 LDAPControl **sctrls,
482 LDAPControl **cctrls ));
487 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
488 LDAPURLDesc *ludp ));
490 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
491 LDAPURLDesc *ludlist ));
493 LDAP_F (int) ldap_url_parselist LDAP_P((
494 LDAPURLDesc **ludlist,
497 LDAP_F (int) ldap_url_parsehosts LDAP_P((
498 LDAPURLDesc **ludlist,
502 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
503 LDAPURLDesc *ludlist ));
505 LDAP_F (char *) ldap_url_list2urls LDAP_P((
506 LDAPURLDesc *ludlist ));
508 LDAP_F (void) ldap_free_urllist LDAP_P((
509 LDAPURLDesc *ludlist ));
514 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
516 LDAP_F (int) ldap_int_sasl_open LDAP_P((
517 LDAP *ld, LDAPConn *conn,
518 const char* host, ber_len_t ssf ));
519 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
521 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
522 int option, void *arg ));
523 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
524 int option, void *arg ));
525 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
526 int option, const char *arg ));
528 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
532 LDAPControl **, LDAPControl **,
534 /* should be passed in client controls */
536 LDAP_SASL_INTERACT_PROC *interact,
542 LDAP_F (int) ldap_int_tls_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg ));
546 #endif /* _LDAP_INT_H */