]> git.sur5r.net Git - openldap/blob - libraries/libldap/ldap-int.h
ITS#7182 allow for later monitor subsystem registration
[openldap] / libraries / libldap / ldap-int.h
1 /*  ldap-int.h - defines & prototypes internal to the LDAP library */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 1998-2012 The OpenLDAP Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
12  * A copy of this license is available in the file LICENSE in the
13  * top-level directory of the distribution or, alternatively, at
14  * <http://www.OpenLDAP.org/license.html>.
15  */
16 /*  Portions Copyright (c) 1995 Regents of the University of Michigan.
17  *  All rights reserved.
18  */
19
20 #ifndef _LDAP_INT_H
21 #define _LDAP_INT_H 1
22
23 #ifdef LDAP_R_COMPILE
24 #define LDAP_THREAD_SAFE 1
25 #endif
26
27 #include "../liblber/lber-int.h"
28 #include "lutil.h"
29
30 #ifdef LDAP_R_COMPILE
31 #include <ldap_pvt_thread.h>
32 #endif
33
34 #ifdef HAVE_CYRUS_SASL
35         /* the need for this should be removed */
36 #ifdef HAVE_SASL_SASL_H
37 #include <sasl/sasl.h>
38 #else
39 #include <sasl.h>
40 #endif
41
42 #define SASL_MAX_BUFF_SIZE      (0xffffff)
43 #define SASL_MIN_BUFF_SIZE      4096
44 #endif
45
46 /* for struct timeval */
47 #include <ac/time.h>
48 #ifdef _WIN32
49 #include <ac/socket.h>
50 #endif
51
52 #undef TV2MILLISEC
53 #define TV2MILLISEC(tv) (((tv)->tv_sec * 1000) + ((tv)->tv_usec/1000))
54
55 /* 
56  * Support needed if the library is running in the kernel
57  */
58 #if LDAP_INT_IN_KERNEL
59         /* 
60          * Platform specific function to return a pointer to the
61          * process-specific global options. 
62          *
63          * This function should perform the following functions:
64          *  Allocate and initialize a global options struct on a per process basis
65          *  Use callers process identifier to return its global options struct
66          *  Note: Deallocate structure when the process exits
67          */
68 #       define LDAP_INT_GLOBAL_OPT() ldap_int_global_opt()
69         struct ldapoptions *ldap_int_global_opt(void);
70 #else
71 #       define LDAP_INT_GLOBAL_OPT() (&ldap_int_global_options)
72 #endif
73
74 #define ldap_debug      ((LDAP_INT_GLOBAL_OPT())->ldo_debug)
75
76 #include "ldap_log.h"
77
78 #undef Debug
79
80 #ifdef LDAP_DEBUG
81
82 #define DebugTest( level ) \
83         ( ldap_debug & level )
84
85 #define Debug( level, fmt, arg1, arg2, arg3 ) \
86         do { if ( ldap_debug & level ) \
87         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) ); \
88         } while ( 0 )
89
90 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 )\
91         ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
92
93 #else
94
95 #define DebugTest( level )                                    (0 == 1)
96 #define Debug( level, fmt, arg1, arg2, arg3 )                 ((void)0)
97 #define LDAP_Debug( subsystem, level, fmt, arg1, arg2, arg3 ) ((void)0)
98
99 #endif /* LDAP_DEBUG */
100
101 #define LDAP_DEPRECATED 1
102 #include "ldap.h"
103
104 #include "ldap_pvt.h"
105
106 LDAP_BEGIN_DECL
107
108 #define LDAP_URL_PREFIX         "ldap://"
109 #define LDAP_URL_PREFIX_LEN     STRLENOF(LDAP_URL_PREFIX)
110 #define LDAPS_URL_PREFIX        "ldaps://"
111 #define LDAPS_URL_PREFIX_LEN    STRLENOF(LDAPS_URL_PREFIX)
112 #define LDAPI_URL_PREFIX        "ldapi://"
113 #define LDAPI_URL_PREFIX_LEN    STRLENOF(LDAPI_URL_PREFIX)
114 #ifdef LDAP_CONNECTIONLESS
115 #define LDAPC_URL_PREFIX        "cldap://"
116 #define LDAPC_URL_PREFIX_LEN    STRLENOF(LDAPC_URL_PREFIX)
117 #endif
118 #define LDAP_URL_URLCOLON       "URL:"
119 #define LDAP_URL_URLCOLON_LEN   STRLENOF(LDAP_URL_URLCOLON)
120
121 #define LDAP_REF_STR            "Referral:\n"
122 #define LDAP_REF_STR_LEN        STRLENOF(LDAP_REF_STR)
123 #define LDAP_LDAP_REF_STR       LDAP_URL_PREFIX
124 #define LDAP_LDAP_REF_STR_LEN   LDAP_URL_PREFIX_LEN
125
126 #define LDAP_DEFAULT_REFHOPLIMIT 5
127
128 #define LDAP_BOOL_REFERRALS             0
129 #define LDAP_BOOL_RESTART               1
130 #define LDAP_BOOL_TLS                   3
131 #define LDAP_BOOL_CONNECT_ASYNC         4
132 #define LDAP_BOOL_SASL_NOCANON          5
133
134 #define LDAP_BOOLEANS   unsigned long
135 #define LDAP_BOOL(n)    ((LDAP_BOOLEANS)1 << (n))
136 #define LDAP_BOOL_GET(lo, bool) \
137         ((lo)->ldo_booleans & LDAP_BOOL(bool) ? -1 : 0)
138 #define LDAP_BOOL_SET(lo, bool) ((lo)->ldo_booleans |= LDAP_BOOL(bool))
139 #define LDAP_BOOL_CLR(lo, bool) ((lo)->ldo_booleans &= ~LDAP_BOOL(bool))
140 #define LDAP_BOOL_ZERO(lo) ((lo)->ldo_booleans = 0)
141
142 /*
143  * This structure represents both ldap messages and ldap responses.
144  * These are really the same, except in the case of search responses,
145  * where a response has multiple messages.
146  */
147
148 struct ldapmsg {
149         ber_int_t               lm_msgid;       /* the message id */
150         ber_tag_t               lm_msgtype;     /* the message type */
151         BerElement      *lm_ber;        /* the ber encoded message contents */
152         struct ldapmsg  *lm_chain;      /* for search - next msg in the resp */
153         struct ldapmsg  *lm_chain_tail;
154         struct ldapmsg  *lm_next;       /* next response */
155         time_t  lm_time;        /* used to maintain cache */
156 };
157
158 #ifdef HAVE_TLS
159 struct ldaptls {
160         char            *lt_certfile;
161         char            *lt_keyfile;
162         char            *lt_dhfile;
163         char            *lt_cacertfile;
164         char            *lt_cacertdir;
165         char            *lt_ciphersuite;
166         char            *lt_crlfile;
167         char            *lt_randfile;   /* OpenSSL only */
168         int             lt_protocol_min;
169 };
170 #endif
171
172 typedef struct ldaplist {
173         struct ldaplist *ll_next;
174         void *ll_data;
175 } ldaplist;
176
177 /*
178  * structure representing get/set'able options
179  * which have global defaults.
180  * Protect access to this struct with ldo_mutex
181  * ldap_log.h:ldapoptions_prefix must match the head of this struct.
182  */
183 struct ldapoptions {
184         short ldo_valid;
185 #define LDAP_UNINITIALIZED      0x0
186 #define LDAP_INITIALIZED        0x1
187 #define LDAP_VALID_SESSION      0x2
188 #define LDAP_TRASHED_SESSION    0xFF
189         int   ldo_debug;
190
191 #ifdef LDAP_R_COMPILE
192         ldap_pvt_thread_mutex_t ldo_mutex;
193 #define LDAP_LDO_MUTEX_NULLARG  , LDAP_PVT_MUTEX_NULL
194 #else
195 #define LDAP_LDO_MUTEX_NULLARG
196 #endif
197
198 #ifdef LDAP_CONNECTIONLESS
199 #define LDAP_IS_UDP(ld)         ((ld)->ld_options.ldo_is_udp)
200         void*                   ldo_peer;       /* struct sockaddr* */
201         char*                   ldo_cldapdn;
202         int                     ldo_is_udp;
203 #endif
204
205         /* per API call timeout */
206         struct timeval          ldo_tm_api;
207         struct timeval          ldo_tm_net;
208
209         ber_int_t               ldo_version;
210         ber_int_t               ldo_deref;
211         ber_int_t               ldo_timelimit;
212         ber_int_t               ldo_sizelimit;
213
214 #ifdef HAVE_TLS
215         /* tls context */
216         void            *ldo_tls_ctx;
217         LDAP_TLS_CONNECT_CB     *ldo_tls_connect_cb;
218         void*                   ldo_tls_connect_arg;
219         struct ldaptls ldo_tls_info;
220 #define ldo_tls_certfile        ldo_tls_info.lt_certfile
221 #define ldo_tls_keyfile ldo_tls_info.lt_keyfile
222 #define ldo_tls_dhfile  ldo_tls_info.lt_dhfile
223 #define ldo_tls_cacertfile      ldo_tls_info.lt_cacertfile
224 #define ldo_tls_cacertdir       ldo_tls_info.lt_cacertdir
225 #define ldo_tls_ciphersuite     ldo_tls_info.lt_ciphersuite
226 #define ldo_tls_protocol_min    ldo_tls_info.lt_protocol_min
227 #define ldo_tls_crlfile ldo_tls_info.lt_crlfile
228 #define ldo_tls_randfile        ldo_tls_info.lt_randfile
229         int                     ldo_tls_mode;
230         int                     ldo_tls_require_cert;
231         int                     ldo_tls_impl;
232 #ifdef HAVE_OPENSSL_CRL
233         int                     ldo_tls_crlcheck;
234 #endif
235 #endif
236
237         LDAPURLDesc *ldo_defludp;
238         int             ldo_defport;
239         char*   ldo_defbase;
240         char*   ldo_defbinddn;  /* bind dn */
241
242 #ifdef HAVE_CYRUS_SASL
243         char*   ldo_def_sasl_mech;              /* SASL Mechanism(s) */
244         char*   ldo_def_sasl_realm;             /* SASL realm */
245         char*   ldo_def_sasl_authcid;   /* SASL authentication identity */
246         char*   ldo_def_sasl_authzid;   /* SASL authorization identity */
247
248         /* SASL Security Properties */
249         struct sasl_security_properties ldo_sasl_secprops;
250 #endif
251
252 #ifdef HAVE_GSSAPI
253         unsigned gssapi_flags;
254
255         unsigned ldo_gssapi_flags;
256 #define LDAP_GSSAPI_OPT_DO_NOT_FREE_GSS_CONTEXT 0x0001
257 #define LDAP_GSSAPI_OPT_ALLOW_REMOTE_PRINCIPAL  0x0002
258         unsigned ldo_gssapi_options;
259 #endif
260
261         /*
262          * Per connection tcp-keepalive settings (Linux only,
263          * ignored where unsupported)
264          */
265         ber_int_t ldo_keepalive_idle;
266         ber_int_t ldo_keepalive_probes;
267         ber_int_t ldo_keepalive_interval;
268
269         int             ldo_refhoplimit;        /* limit on referral nesting */
270
271         /* LDAPv3 server and client controls */
272         LDAPControl     **ldo_sctrls;
273         LDAPControl **ldo_cctrls;
274
275         /* LDAP rebind callback function */
276         LDAP_REBIND_PROC *ldo_rebind_proc;
277         void *ldo_rebind_params;
278         LDAP_NEXTREF_PROC *ldo_nextref_proc;
279         void *ldo_nextref_params;
280         LDAP_URLLIST_PROC *ldo_urllist_proc;
281         void *ldo_urllist_params;
282
283         /* LDAP connection callback stack */
284         ldaplist *ldo_conn_cbs;
285
286         LDAP_BOOLEANS ldo_booleans;     /* boolean options */
287 };
288
289
290 /*
291  * structure for representing an LDAP server connection
292  */
293 typedef struct ldap_conn {
294         Sockbuf         *lconn_sb;
295 #ifdef HAVE_CYRUS_SASL
296         void            *lconn_sasl_authctx;    /* context for bind */
297         void            *lconn_sasl_sockctx;    /* for security layer */
298 #endif
299 #ifdef HAVE_GSSAPI
300         void            *lconn_gss_ctx;         /* gss_ctx_id_t */
301 #endif
302         int                     lconn_refcnt;
303         time_t          lconn_created;  /* time */
304         time_t          lconn_lastused; /* time */
305         int                     lconn_rebind_inprogress;        /* set if rebind in progress */
306         char            ***lconn_rebind_queue;          /* used if rebind in progress */
307         int                     lconn_status;
308 #define LDAP_CONNST_NEEDSOCKET          1
309 #define LDAP_CONNST_CONNECTING          2
310 #define LDAP_CONNST_CONNECTED           3
311         LDAPURLDesc             *lconn_server;
312         BerElement              *lconn_ber;     /* ber receiving on this conn. */
313
314         struct ldap_conn *lconn_next;
315 } LDAPConn;
316
317
318 /*
319  * structure used to track outstanding requests
320  */
321 typedef struct ldapreq {
322         ber_int_t       lr_msgid;       /* the message id */
323         int             lr_status;      /* status of request */
324 #define LDAP_REQST_COMPLETED    0
325 #define LDAP_REQST_INPROGRESS   1
326 #define LDAP_REQST_CHASINGREFS  2
327 #define LDAP_REQST_NOTCONNECTED 3
328 #define LDAP_REQST_WRITING      4
329         int             lr_refcnt;      /* count of references */
330         int             lr_outrefcnt;   /* count of outstanding referrals */
331         int             lr_abandoned;   /* the request has been abandoned */
332         ber_int_t       lr_origid;      /* original request's message id */
333         int             lr_parentcnt;   /* count of parent requests */
334         ber_tag_t       lr_res_msgtype; /* result message type */
335         ber_int_t       lr_res_errno;   /* result LDAP errno */
336         char            *lr_res_error;  /* result error string */
337         char            *lr_res_matched;/* result matched DN string */
338         BerElement      *lr_ber;        /* ber encoded request contents */
339         LDAPConn        *lr_conn;       /* connection used to send request */
340         struct berval   lr_dn;          /* DN of request, in lr_ber */
341         struct ldapreq  *lr_parent;     /* request that spawned this referral */
342         struct ldapreq  *lr_child;      /* first child request */
343         struct ldapreq  *lr_refnext;    /* next referral spawned */
344         struct ldapreq  *lr_prev;       /* previous request */
345         struct ldapreq  *lr_next;       /* next request */
346 } LDAPRequest;
347
348 /*
349  * structure for client cache
350  */
351 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
352 typedef struct ldapcache {
353         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
354         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
355         long            lc_timeout;                     /* request timeout */
356         ber_len_t               lc_maxmem;                      /* memory to use */
357         ber_len_t               lc_memused;                     /* memory in use */
358         int             lc_enabled;                     /* enabled? */
359         unsigned long   lc_options;                     /* options */
360 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
361 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
362 }  LDAPCache;
363
364 /*
365  * structure containing referral request info for rebind procedure
366  */
367 typedef struct ldapreqinfo {
368         ber_len_t       ri_msgid;
369         int                     ri_request;
370         char            *ri_url;
371 } LDAPreqinfo;
372
373 /*
374  * structure representing an ldap connection
375  */
376
377 struct ldap_common {
378         Sockbuf         *ldc_sb;        /* socket descriptor & buffer */
379 #define ld_sb                   ldc->ldc_sb
380
381         /* protected by ldo_mutex */
382         struct ldapoptions ldc_options;
383 #define ld_options              ldc->ldc_options
384
385 #define ld_valid                ld_options.ldo_valid
386 #define ld_debug                ld_options.ldo_debug
387
388 #define ld_deref                ld_options.ldo_deref
389 #define ld_timelimit            ld_options.ldo_timelimit
390 #define ld_sizelimit            ld_options.ldo_sizelimit
391
392 #define ld_defbinddn            ld_options.ldo_defbinddn
393 #define ld_defbase              ld_options.ldo_defbase
394 #define ld_defhost              ld_options.ldo_defhost
395 #define ld_defport              ld_options.ldo_defport
396
397 #define ld_refhoplimit          ld_options.ldo_refhoplimit
398
399 #define ld_sctrls               ld_options.ldo_sctrls
400 #define ld_cctrls               ld_options.ldo_cctrls
401 #define ld_rebind_proc          ld_options.ldo_rebind_proc
402 #define ld_rebind_params        ld_options.ldo_rebind_params
403 #define ld_nextref_proc         ld_options.ldo_nextref_proc
404 #define ld_nextref_params       ld_options.ldo_nextref_params
405 #define ld_urllist_proc         ld_options.ldo_urllist_proc
406 #define ld_urllist_params       ld_options.ldo_urllist_params
407
408 #define ld_version              ld_options.ldo_version
409 #ifdef LDAP_R_COMPILE
410 #define ld_ldopts_mutex         ld_options.ldo_mutex
411 #endif
412
413         unsigned short  ldc_lberoptions;
414 #define ld_lberoptions          ldc->ldc_lberoptions
415
416         /* protected by msgid_mutex */
417         ber_len_t               ldc_msgid;
418 #define ld_msgid                ldc->ldc_msgid
419
420         /* do not mess with these */
421         /* protected by req_mutex */
422         LDAPRequest     *ldc_requests;  /* list of outstanding requests */
423         /* protected by res_mutex */
424         LDAPMessage     *ldc_responses; /* list of outstanding responses */
425 #define ld_requests             ldc->ldc_requests
426 #define ld_responses            ldc->ldc_responses
427
428 #ifdef LDAP_R_COMPILE
429         ldap_pvt_thread_mutex_t ldc_msgid_mutex;
430         ldap_pvt_thread_mutex_t ldc_conn_mutex;
431         ldap_pvt_thread_mutex_t ldc_req_mutex;
432         ldap_pvt_thread_mutex_t ldc_res_mutex;
433         ldap_pvt_thread_mutex_t ldc_abandon_mutex;
434 #define ld_msgid_mutex          ldc->ldc_msgid_mutex
435 #define ld_conn_mutex           ldc->ldc_conn_mutex
436 #define ld_req_mutex            ldc->ldc_req_mutex
437 #define ld_res_mutex            ldc->ldc_res_mutex
438 #define ld_abandon_mutex        ldc->ldc_abandon_mutex
439 #endif
440
441         /* protected by abandon_mutex */
442         ber_len_t       ldc_nabandoned;
443         ber_int_t       *ldc_abandoned; /* array of abandoned requests */
444 #define ld_nabandoned           ldc->ldc_nabandoned
445 #define ld_abandoned            ldc->ldc_abandoned
446
447         /* unused by libldap */
448         LDAPCache       *ldc_cache;     /* non-null if cache is initialized */
449 #define ld_cache                ldc->ldc_cache
450
451         /* do not mess with the rest though */
452
453         /* protected by conn_mutex */
454         LDAPConn        *ldc_defconn;   /* default connection */
455 #define ld_defconn              ldc->ldc_defconn
456         LDAPConn        *ldc_conns;     /* list of server connections */
457 #define ld_conns                ldc->ldc_conns
458         void            *ldc_selectinfo;/* platform specifics for select */
459 #define ld_selectinfo           ldc->ldc_selectinfo
460
461         /* ldap_common refcnt - free only if 0 */
462 #ifdef LDAP_R_COMPILE
463         ldap_pvt_thread_mutex_t ldc_mutex;
464 #define ld_ldcmutex             ldc->ldc_mutex
465 #endif
466         /* protected by ldc_mutex */
467         unsigned int            ldc_refcnt;
468 #define ld_ldcrefcnt            ldc->ldc_refcnt
469 };
470
471 struct ldap {
472         /* thread shared */
473         struct ldap_common      *ldc;
474
475         /* thread specific */
476         ber_int_t               ld_errno;
477         char                    *ld_error;
478         char                    *ld_matched;
479         char                    **ld_referrals;
480 };
481
482 #define LDAP_VALID(ld)          ( (ld)->ld_valid == LDAP_VALID_SESSION )
483 #define LDAP_TRASHED(ld)        ( (ld)->ld_valid == LDAP_TRASHED_SESSION )
484 #define LDAP_TRASH(ld)          ( (ld)->ld_valid = LDAP_TRASHED_SESSION )
485
486 #ifdef LDAP_R_COMPILE
487 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
488 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_hostname_mutex;
489
490 #ifdef HAVE_CYRUS_SASL
491 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_sasl_mutex;
492 #endif
493 #ifdef HAVE_GSSAPI
494 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_gssapi_mutex;
495 #endif
496 #endif
497
498 #ifdef LDAP_R_COMPILE
499 #define LDAP_MUTEX_LOCK(mutex)    ldap_pvt_thread_mutex_lock( mutex )
500 #define LDAP_MUTEX_UNLOCK(mutex)  ldap_pvt_thread_mutex_unlock( mutex )
501 #define LDAP_ASSERT_MUTEX_OWNER(mutex) \
502         LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex)
503 #else
504 #define LDAP_MUTEX_LOCK(mutex)    ((void) 0)
505 #define LDAP_MUTEX_UNLOCK(mutex)  ((void) 0)
506 #define LDAP_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
507 #endif
508
509 #define LDAP_NEXT_MSGID(ld, id) do { \
510         LDAP_MUTEX_LOCK( &(ld)->ld_msgid_mutex ); \
511         (id) = ++(ld)->ld_msgid; \
512         LDAP_MUTEX_UNLOCK( &(ld)->ld_msgid_mutex ); \
513 } while (0)
514
515 /*
516  * in abandon.c
517  */
518
519 LDAP_F (int)
520 ldap_int_bisect_find( ber_int_t *v, ber_len_t n, ber_int_t id, int *idxp );
521 LDAP_F (int)
522 ldap_int_bisect_insert( ber_int_t **vp, ber_len_t *np, int id, int idx );
523 LDAP_F (int)
524 ldap_int_bisect_delete( ber_int_t **vp, ber_len_t *np, int id, int idx );
525
526 /*
527  * in init.c
528  */
529
530 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
531
532 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
533 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
534         struct ldapoptions *, int *));
535
536 /* memory.c */
537         /* simple macros to realloc for now */
538 #define LDAP_MALLOC(s)          (ber_memalloc_x((s),NULL))
539 #define LDAP_CALLOC(n,s)        (ber_memcalloc_x((n),(s),NULL))
540 #define LDAP_REALLOC(p,s)       (ber_memrealloc_x((p),(s),NULL))
541 #define LDAP_FREE(p)            (ber_memfree_x((p),NULL))
542 #define LDAP_VFREE(v)           (ber_memvfree_x((void **)(v),NULL))
543 #define LDAP_STRDUP(s)          (ber_strdup_x((s),NULL))
544 #define LDAP_STRNDUP(s,l)       (ber_strndup_x((s),(l),NULL))
545
546 #define LDAP_MALLOCX(s,x)       (ber_memalloc_x((s),(x)))
547 #define LDAP_CALLOCX(n,s,x)     (ber_memcalloc_x((n),(s),(x)))
548 #define LDAP_REALLOCX(p,s,x)    (ber_memrealloc_x((p),(s),(x)))
549 #define LDAP_FREEX(p,x)         (ber_memfree_x((p),(x)))
550 #define LDAP_VFREEX(v,x)        (ber_memvfree_x((void **)(v),(x)))
551 #define LDAP_STRDUPX(s,x)       (ber_strdup_x((s),(x)))
552 #define LDAP_STRNDUPX(s,l,x)    (ber_strndup_x((s),(l),(x)))
553
554 /*
555  * in error.c
556  */
557 LDAP_F (void) ldap_int_error_init( void );
558
559 /*
560  * in unit-int.c
561  */
562 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
563
564
565 /*
566  * in print.c
567  */
568 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
569
570 /*
571  * in cache.c
572  */
573 LDAP_F (void) ldap_add_request_to_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype,
574         BerElement *request ));
575 LDAP_F (void) ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
576 LDAP_F (int) ldap_check_cache LDAP_P(( LDAP *ld, ber_tag_t msgtype, BerElement *request ));
577
578 /*
579  * in controls.c
580  */
581 LDAP_F (int) ldap_int_put_controls LDAP_P((
582         LDAP *ld,
583         LDAPControl *const *ctrls,
584         BerElement *ber ));
585
586 LDAP_F (int) ldap_int_client_controls LDAP_P((
587         LDAP *ld,
588         LDAPControl **ctrlp ));
589
590 /*
591  * in dsparse.c
592  */
593 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
594
595
596 /*
597  * in open.c
598  */
599 LDAP_F (int) ldap_open_defconn( LDAP *ld );
600 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
601         LDAPConn *conn, LDAPURLDesc *srvlist, int async );
602 LDAP_F (int) ldap_int_check_async_open( LDAP *ld, ber_socket_t sd );
603
604 /*
605  * in os-ip.c
606  */
607 #ifndef HAVE_POLL
608 LDAP_V (int) ldap_int_tblsize;
609 LDAP_F (void) ldap_int_ip_init( void );
610 #endif
611
612 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
613         const struct timeval *tm );
614 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
615         int proto, LDAPURLDesc *srv, int async );
616 LDAP_F (int) ldap_int_poll( LDAP *ld, ber_socket_t s,
617         struct timeval *tvp );
618
619 #if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
620 LDAP_V (char *) ldap_int_hostname;
621 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
622         const char *host );
623 #endif
624
625 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
626 LDAP_F (void *) ldap_new_select_info( void );
627 LDAP_F (void) ldap_free_select_info( void *sip );
628 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
629 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
630 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
631 LDAP_F (void) ldap_clear_select_write( LDAP *ld, Sockbuf *sb );
632 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
633 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
634
635 LDAP_F (int) ldap_int_connect_cbs( LDAP *ld, Sockbuf *sb,
636         ber_socket_t *s, LDAPURLDesc *srv, struct sockaddr *addr );
637
638 /*
639  * in os-local.c
640  */
641 #ifdef LDAP_PF_LOCAL
642 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
643         LDAPURLDesc *srv, int async );
644 #endif /* LDAP_PF_LOCAL */
645
646 /*
647  * in request.c
648  */
649 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
650         const char *dn, BerElement *ber, ber_int_t msgid );
651 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
652 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
653
654 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber,
655         ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc **srvlist,
656         LDAPConn *lc, LDAPreqinfo *bind, int noconn, int m_res );
657 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist,
658         int use_ldsb, int connect, LDAPreqinfo *bind, int m_req, int m_res );
659 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
660 LDAP_F (void) ldap_return_request( LDAP *ld, LDAPRequest *lr, int freeit );
661 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
662 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
663 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
664 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
665 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
666         char **errstrp, int sref, int *hadrefp );
667 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
668         char **refs, int sref, char **referralsp, int *hadrefp );
669 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
670 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
671
672 /*
673  * in result.c:
674  */
675 LDAP_F (const char *) ldap_int_msgtype2str( ber_tag_t tag );
676
677 /*
678  * in search.c
679  */
680 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
681         LDAP *ld,
682         const char *base,
683         ber_int_t scope,
684         const char *filter,
685         char **attrs,
686         ber_int_t attrsonly,
687         LDAPControl **sctrls,
688         LDAPControl **cctrls,
689         ber_int_t timelimit,
690         ber_int_t sizelimit,
691         ber_int_t deref,
692         ber_int_t *msgidp));
693
694
695 /*
696  * in unbind.c
697  */
698 LDAP_F (int) ldap_ld_free LDAP_P((
699         LDAP *ld,
700         int close,
701         LDAPControl **sctrls,
702         LDAPControl **cctrls ));
703
704 LDAP_F (int) ldap_send_unbind LDAP_P((
705         LDAP *ld,
706         Sockbuf *sb,
707         LDAPControl **sctrls,
708         LDAPControl **cctrls ));
709
710 /*
711  * in url.c
712  */
713 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
714         LDAPURLDesc *ludp ));
715
716 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
717         LDAPURLDesc *ludlist ));
718
719 LDAP_F (int) ldap_url_parsehosts LDAP_P((
720         LDAPURLDesc **ludlist,
721         const char *hosts,
722         int port ));
723
724 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
725         LDAPURLDesc *ludlist ));
726
727 /*
728  * in cyrus.c
729  */
730
731 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
732
733 LDAP_F (int) ldap_int_sasl_open LDAP_P((
734         LDAP *ld, LDAPConn *conn,
735         const char* host ));
736 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
737
738 LDAP_F (int) ldap_int_sasl_external LDAP_P((
739         LDAP *ld, LDAPConn *conn,
740         const char* authid, ber_len_t ssf ));
741
742 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
743         int option, void *arg ));
744 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
745         int option, void *arg ));
746 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
747         int option, const char *arg ));
748
749 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
750         LDAP *ld,
751         const char *,
752         const char *,
753         LDAPControl **, LDAPControl **,
754
755         /* should be passed in client controls */
756         unsigned flags,
757         LDAP_SASL_INTERACT_PROC *interact,
758         void *defaults,
759         LDAPMessage *result,
760         const char **rmech,
761         int *msgid ));
762
763 /* in schema.c */
764 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
765         const char **sp,
766         int *code,
767         const int flags ));
768
769 /*
770  * in tls.c
771  */
772 LDAP_F (int) ldap_int_tls_config LDAP_P(( LDAP *ld,
773         int option, const char *arg ));
774
775 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
776         LDAPConn *conn, LDAPURLDesc *srv ));
777
778 LDAP_F (void) ldap_int_tls_destroy LDAP_P(( struct ldapoptions *lo ));
779
780 /*
781  *      in getvalues.c
782  */
783 LDAP_F (char **) ldap_value_dup LDAP_P((
784         char *const *vals ));
785
786 /*
787  *      in gssapi.c
788  */
789 #ifdef HAVE_GSSAPI
790 LDAP_F(int) ldap_int_gssapi_get_option LDAP_P(( LDAP *ld, int option, void *arg ));
791 LDAP_F(int) ldap_int_gssapi_set_option LDAP_P(( LDAP *ld, int option, void *arg ));
792 LDAP_F(int) ldap_int_gssapi_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg ));
793 LDAP_F(void) ldap_int_gssapi_close LDAP_P(( LDAP *ld, LDAPConn *lc ));
794 #endif 
795
796 LDAP_END_DECL
797
798 #endif /* _LDAP_INT_H */