]> git.sur5r.net Git - openldap/blob - libraries/libldap/ldap-int.h
Add channel binding support
[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-2013 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         ber_int_t               ldo_version;
192         ber_int_t               ldo_deref;
193         ber_int_t               ldo_timelimit;
194         ber_int_t               ldo_sizelimit;
195
196         /* per API call timeout */
197         struct timeval          ldo_tm_api;
198         struct timeval          ldo_tm_net;
199
200         LDAPURLDesc *ldo_defludp;
201         int             ldo_defport;
202         char*   ldo_defbase;
203         char*   ldo_defbinddn;  /* bind dn */
204
205         /*
206          * Per connection tcp-keepalive settings (Linux only,
207          * ignored where unsupported)
208          */
209         ber_int_t ldo_keepalive_idle;
210         ber_int_t ldo_keepalive_probes;
211         ber_int_t ldo_keepalive_interval;
212
213         int             ldo_refhoplimit;        /* limit on referral nesting */
214
215         /* LDAPv3 server and client controls */
216         LDAPControl     **ldo_sctrls;
217         LDAPControl **ldo_cctrls;
218
219         /* LDAP rebind callback function */
220         LDAP_REBIND_PROC *ldo_rebind_proc;
221         void *ldo_rebind_params;
222         LDAP_NEXTREF_PROC *ldo_nextref_proc;
223         void *ldo_nextref_params;
224         LDAP_URLLIST_PROC *ldo_urllist_proc;
225         void *ldo_urllist_params;
226
227         /* LDAP connection callback stack */
228         ldaplist *ldo_conn_cbs;
229
230         LDAP_BOOLEANS ldo_booleans;     /* boolean options */
231
232 #define LDAP_LDO_NULLARG        ,0,0,0,0 ,{0},{0} ,0,0,0,0, 0,0,0,0, 0,0, 0,0,0,0,0,0, 0, 0
233
234 #ifdef LDAP_CONNECTIONLESS
235 #define LDAP_IS_UDP(ld)         ((ld)->ld_options.ldo_is_udp)
236         void*                   ldo_peer;       /* struct sockaddr* */
237         char*                   ldo_cldapdn;
238         int                     ldo_is_udp;
239 #define LDAP_LDO_CONNECTIONLESS_NULLARG ,0,0,0
240 #else
241 #define LDAP_LDO_CONNECTIONLESS_NULLARG
242 #endif
243
244 #ifdef HAVE_TLS
245         /* tls context */
246         void            *ldo_tls_ctx;
247         LDAP_TLS_CONNECT_CB     *ldo_tls_connect_cb;
248         void*                   ldo_tls_connect_arg;
249         struct ldaptls ldo_tls_info;
250 #define ldo_tls_certfile        ldo_tls_info.lt_certfile
251 #define ldo_tls_keyfile ldo_tls_info.lt_keyfile
252 #define ldo_tls_dhfile  ldo_tls_info.lt_dhfile
253 #define ldo_tls_cacertfile      ldo_tls_info.lt_cacertfile
254 #define ldo_tls_cacertdir       ldo_tls_info.lt_cacertdir
255 #define ldo_tls_ciphersuite     ldo_tls_info.lt_ciphersuite
256 #define ldo_tls_protocol_min    ldo_tls_info.lt_protocol_min
257 #define ldo_tls_crlfile ldo_tls_info.lt_crlfile
258 #define ldo_tls_randfile        ldo_tls_info.lt_randfile
259         int                     ldo_tls_mode;
260         int                     ldo_tls_require_cert;
261         int                     ldo_tls_impl;
262         int                     ldo_tls_crlcheck;
263 #define LDAP_LDO_TLS_NULLARG ,0,0,0,{0,0,0,0,0,0,0,0,0},0,0,0,0
264 #else
265 #define LDAP_LDO_TLS_NULLARG
266 #endif
267
268 #ifdef HAVE_CYRUS_SASL
269         char*   ldo_def_sasl_mech;              /* SASL Mechanism(s) */
270         char*   ldo_def_sasl_realm;             /* SASL realm */
271         char*   ldo_def_sasl_authcid;   /* SASL authentication identity */
272         char*   ldo_def_sasl_authzid;   /* SASL authorization identity */
273
274         /* SASL Security Properties */
275         struct sasl_security_properties ldo_sasl_secprops;
276 #define LDAP_LDO_SASL_NULLARG ,0,0,0,0,{0}
277 #else
278 #define LDAP_LDO_SASL_NULLARG
279 #endif
280
281 #ifdef HAVE_GSSAPI
282         unsigned ldo_gssapi_flags;
283 #define LDAP_GSSAPI_OPT_DO_NOT_FREE_GSS_CONTEXT 0x0001
284 #define LDAP_GSSAPI_OPT_ALLOW_REMOTE_PRINCIPAL  0x0002
285         unsigned ldo_gssapi_options;
286 #define LDAP_LDO_GSSAPI_NULLARG ,0,0
287 #else
288 #define LDAP_LDO_GSSAPI_NULLARG
289 #endif
290
291 #ifdef LDAP_R_COMPILE
292         ldap_pvt_thread_mutex_t ldo_mutex;
293 #define LDAP_LDO_MUTEX_NULLARG  , LDAP_PVT_MUTEX_NULL
294 #else
295 #define LDAP_LDO_MUTEX_NULLARG
296 #endif
297 };
298
299
300 /*
301  * structure for representing an LDAP server connection
302  */
303 typedef struct ldap_conn {
304         Sockbuf         *lconn_sb;
305 #ifdef HAVE_CYRUS_SASL
306         void            *lconn_sasl_authctx;    /* context for bind */
307         void            *lconn_sasl_sockctx;    /* for security layer */
308         void            *lconn_sasl_cbind;              /* for channel binding */
309 #endif
310 #ifdef HAVE_GSSAPI
311         void            *lconn_gss_ctx;         /* gss_ctx_id_t */
312 #endif
313         int                     lconn_refcnt;
314         time_t          lconn_created;  /* time */
315         time_t          lconn_lastused; /* time */
316         int                     lconn_rebind_inprogress;        /* set if rebind in progress */
317         char            ***lconn_rebind_queue;          /* used if rebind in progress */
318         int                     lconn_status;
319 #define LDAP_CONNST_NEEDSOCKET          1
320 #define LDAP_CONNST_CONNECTING          2
321 #define LDAP_CONNST_CONNECTED           3
322         LDAPURLDesc             *lconn_server;
323         BerElement              *lconn_ber;     /* ber receiving on this conn. */
324
325         struct ldap_conn *lconn_next;
326 } LDAPConn;
327
328
329 /*
330  * structure used to track outstanding requests
331  */
332 typedef struct ldapreq {
333         ber_int_t       lr_msgid;       /* the message id */
334         int             lr_status;      /* status of request */
335 #define LDAP_REQST_COMPLETED    0
336 #define LDAP_REQST_INPROGRESS   1
337 #define LDAP_REQST_CHASINGREFS  2
338 #define LDAP_REQST_NOTCONNECTED 3
339 #define LDAP_REQST_WRITING      4
340         int             lr_refcnt;      /* count of references */
341         int             lr_outrefcnt;   /* count of outstanding referrals */
342         int             lr_abandoned;   /* the request has been abandoned */
343         ber_int_t       lr_origid;      /* original request's message id */
344         int             lr_parentcnt;   /* count of parent requests */
345         ber_tag_t       lr_res_msgtype; /* result message type */
346         ber_int_t       lr_res_errno;   /* result LDAP errno */
347         char            *lr_res_error;  /* result error string */
348         char            *lr_res_matched;/* result matched DN string */
349         BerElement      *lr_ber;        /* ber encoded request contents */
350         LDAPConn        *lr_conn;       /* connection used to send request */
351         struct berval   lr_dn;          /* DN of request, in lr_ber */
352         struct ldapreq  *lr_parent;     /* request that spawned this referral */
353         struct ldapreq  *lr_child;      /* first child request */
354         struct ldapreq  *lr_refnext;    /* next referral spawned */
355         struct ldapreq  *lr_prev;       /* previous request */
356         struct ldapreq  *lr_next;       /* next request */
357 } LDAPRequest;
358
359 /*
360  * structure for client cache
361  */
362 #define LDAP_CACHE_BUCKETS      31      /* cache hash table size */
363 typedef struct ldapcache {
364         LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
365         LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
366         long            lc_timeout;                     /* request timeout */
367         ber_len_t               lc_maxmem;                      /* memory to use */
368         ber_len_t               lc_memused;                     /* memory in use */
369         int             lc_enabled;                     /* enabled? */
370         unsigned long   lc_options;                     /* options */
371 #define LDAP_CACHE_OPT_CACHENOERRS      0x00000001
372 #define LDAP_CACHE_OPT_CACHEALLERRS     0x00000002
373 }  LDAPCache;
374
375 /*
376  * structure containing referral request info for rebind procedure
377  */
378 typedef struct ldapreqinfo {
379         ber_len_t       ri_msgid;
380         int                     ri_request;
381         char            *ri_url;
382 } LDAPreqinfo;
383
384 /*
385  * structure representing an ldap connection
386  */
387
388 struct ldap_common {
389         Sockbuf         *ldc_sb;        /* socket descriptor & buffer */
390 #define ld_sb                   ldc->ldc_sb
391
392         unsigned short  ldc_lberoptions;
393 #define ld_lberoptions          ldc->ldc_lberoptions
394
395         /* protected by msgid_mutex */
396         ber_len_t               ldc_msgid;
397 #define ld_msgid                ldc->ldc_msgid
398
399         /* do not mess with these */
400         /* protected by req_mutex */
401         LDAPRequest     *ldc_requests;  /* list of outstanding requests */
402         /* protected by res_mutex */
403         LDAPMessage     *ldc_responses; /* list of outstanding responses */
404 #define ld_requests             ldc->ldc_requests
405 #define ld_responses            ldc->ldc_responses
406
407         /* protected by abandon_mutex */
408         ber_len_t       ldc_nabandoned;
409         ber_int_t       *ldc_abandoned; /* array of abandoned requests */
410 #define ld_nabandoned           ldc->ldc_nabandoned
411 #define ld_abandoned            ldc->ldc_abandoned
412
413         /* unused by libldap */
414         LDAPCache       *ldc_cache;     /* non-null if cache is initialized */
415 #define ld_cache                ldc->ldc_cache
416
417         /* do not mess with the rest though */
418
419         /* protected by conn_mutex */
420         LDAPConn        *ldc_defconn;   /* default connection */
421 #define ld_defconn              ldc->ldc_defconn
422         LDAPConn        *ldc_conns;     /* list of server connections */
423 #define ld_conns                ldc->ldc_conns
424         void            *ldc_selectinfo;/* platform specifics for select */
425 #define ld_selectinfo           ldc->ldc_selectinfo
426
427         /* ldap_common refcnt - free only if 0 */
428         /* protected by ldc_mutex */
429         unsigned int            ldc_refcnt;
430 #define ld_ldcrefcnt            ldc->ldc_refcnt
431
432         /* protected by ldo_mutex */
433         struct ldapoptions ldc_options;
434 #define ld_options              ldc->ldc_options
435
436 #define ld_valid                ld_options.ldo_valid
437 #define ld_debug                ld_options.ldo_debug
438
439 #define ld_deref                ld_options.ldo_deref
440 #define ld_timelimit            ld_options.ldo_timelimit
441 #define ld_sizelimit            ld_options.ldo_sizelimit
442
443 #define ld_defbinddn            ld_options.ldo_defbinddn
444 #define ld_defbase              ld_options.ldo_defbase
445 #define ld_defhost              ld_options.ldo_defhost
446 #define ld_defport              ld_options.ldo_defport
447
448 #define ld_refhoplimit          ld_options.ldo_refhoplimit
449
450 #define ld_sctrls               ld_options.ldo_sctrls
451 #define ld_cctrls               ld_options.ldo_cctrls
452 #define ld_rebind_proc          ld_options.ldo_rebind_proc
453 #define ld_rebind_params        ld_options.ldo_rebind_params
454 #define ld_nextref_proc         ld_options.ldo_nextref_proc
455 #define ld_nextref_params       ld_options.ldo_nextref_params
456 #define ld_urllist_proc         ld_options.ldo_urllist_proc
457 #define ld_urllist_params       ld_options.ldo_urllist_params
458
459 #define ld_version              ld_options.ldo_version
460
461 #ifdef LDAP_R_COMPILE
462         ldap_pvt_thread_mutex_t ldc_mutex;
463         ldap_pvt_thread_mutex_t ldc_msgid_mutex;
464         ldap_pvt_thread_mutex_t ldc_conn_mutex;
465         ldap_pvt_thread_mutex_t ldc_req_mutex;
466         ldap_pvt_thread_mutex_t ldc_res_mutex;
467         ldap_pvt_thread_mutex_t ldc_abandon_mutex;
468 #define ld_ldopts_mutex         ld_options.ldo_mutex
469 #define ld_ldcmutex             ldc->ldc_mutex
470 #define ld_msgid_mutex          ldc->ldc_msgid_mutex
471 #define ld_conn_mutex           ldc->ldc_conn_mutex
472 #define ld_req_mutex            ldc->ldc_req_mutex
473 #define ld_res_mutex            ldc->ldc_res_mutex
474 #define ld_abandon_mutex        ldc->ldc_abandon_mutex
475 #endif
476 };
477
478 struct ldap {
479         /* thread shared */
480         struct ldap_common      *ldc;
481
482         /* thread specific */
483         ber_int_t               ld_errno;
484         char                    *ld_error;
485         char                    *ld_matched;
486         char                    **ld_referrals;
487 };
488
489 #define LDAP_VALID(ld)          ( (ld)->ld_valid == LDAP_VALID_SESSION )
490 #define LDAP_TRASHED(ld)        ( (ld)->ld_valid == LDAP_TRASHED_SESSION )
491 #define LDAP_TRASH(ld)          ( (ld)->ld_valid = LDAP_TRASHED_SESSION )
492
493 #ifdef LDAP_R_COMPILE
494 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_resolv_mutex;
495 LDAP_V ( ldap_pvt_thread_mutex_t ) ldap_int_hostname_mutex;
496
497 #ifdef HAVE_GSSAPI
498 LDAP_V( ldap_pvt_thread_mutex_t ) ldap_int_gssapi_mutex;
499 #endif
500 #endif
501
502 #ifdef LDAP_R_COMPILE
503 #define LDAP_MUTEX_LOCK(mutex)    ldap_pvt_thread_mutex_lock( mutex )
504 #define LDAP_MUTEX_UNLOCK(mutex)  ldap_pvt_thread_mutex_unlock( mutex )
505 #define LDAP_ASSERT_MUTEX_OWNER(mutex) \
506         LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex)
507 #else
508 #define LDAP_MUTEX_LOCK(mutex)    ((void) 0)
509 #define LDAP_MUTEX_UNLOCK(mutex)  ((void) 0)
510 #define LDAP_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
511 #endif
512
513 #define LDAP_NEXT_MSGID(ld, id) do { \
514         LDAP_MUTEX_LOCK( &(ld)->ld_msgid_mutex ); \
515         (id) = ++(ld)->ld_msgid; \
516         LDAP_MUTEX_UNLOCK( &(ld)->ld_msgid_mutex ); \
517 } while (0)
518
519 /*
520  * in abandon.c
521  */
522
523 LDAP_F (int)
524 ldap_int_bisect_find( ber_int_t *v, ber_len_t n, ber_int_t id, int *idxp );
525 LDAP_F (int)
526 ldap_int_bisect_insert( ber_int_t **vp, ber_len_t *np, int id, int idx );
527 LDAP_F (int)
528 ldap_int_bisect_delete( ber_int_t **vp, ber_len_t *np, int id, int idx );
529
530 /*
531  * in init.c
532  */
533
534 LDAP_V ( struct ldapoptions ) ldap_int_global_options;
535
536 LDAP_F ( void ) ldap_int_initialize LDAP_P((struct ldapoptions *, int *));
537 LDAP_F ( void ) ldap_int_initialize_global_options LDAP_P((
538         struct ldapoptions *, int *));
539
540 /* memory.c */
541         /* simple macros to realloc for now */
542 #define LDAP_MALLOC(s)          (ber_memalloc_x((s),NULL))
543 #define LDAP_CALLOC(n,s)        (ber_memcalloc_x((n),(s),NULL))
544 #define LDAP_REALLOC(p,s)       (ber_memrealloc_x((p),(s),NULL))
545 #define LDAP_FREE(p)            (ber_memfree_x((p),NULL))
546 #define LDAP_VFREE(v)           (ber_memvfree_x((void **)(v),NULL))
547 #define LDAP_STRDUP(s)          (ber_strdup_x((s),NULL))
548 #define LDAP_STRNDUP(s,l)       (ber_strndup_x((s),(l),NULL))
549
550 #define LDAP_MALLOCX(s,x)       (ber_memalloc_x((s),(x)))
551 #define LDAP_CALLOCX(n,s,x)     (ber_memcalloc_x((n),(s),(x)))
552 #define LDAP_REALLOCX(p,s,x)    (ber_memrealloc_x((p),(s),(x)))
553 #define LDAP_FREEX(p,x)         (ber_memfree_x((p),(x)))
554 #define LDAP_VFREEX(v,x)        (ber_memvfree_x((void **)(v),(x)))
555 #define LDAP_STRDUPX(s,x)       (ber_strdup_x((s),(x)))
556 #define LDAP_STRNDUPX(s,l,x)    (ber_strndup_x((s),(l),(x)))
557
558 /*
559  * in error.c
560  */
561 LDAP_F (void) ldap_int_error_init( void );
562
563 /*
564  * in unit-int.c
565  */
566 LDAP_F (void) ldap_int_utils_init LDAP_P(( void ));
567
568
569 /*
570  * in print.c
571  */
572 LDAP_F (int) ldap_log_printf LDAP_P((LDAP *ld, int level, const char *fmt, ...)) LDAP_GCCATTR((format(printf, 3, 4)));
573
574 /*
575  * in controls.c
576  */
577 LDAP_F (int) ldap_int_put_controls LDAP_P((
578         LDAP *ld,
579         LDAPControl *const *ctrls,
580         BerElement *ber ));
581
582 LDAP_F (int) ldap_int_client_controls LDAP_P((
583         LDAP *ld,
584         LDAPControl **ctrlp ));
585
586 /*
587  * in dsparse.c
588  */
589 LDAP_F (int) ldap_int_next_line_tokens LDAP_P(( char **bufp, ber_len_t *blenp, char ***toksp ));
590
591
592 /*
593  * in open.c
594  */
595 LDAP_F (int) ldap_open_defconn( LDAP *ld );
596 LDAP_F (int) ldap_int_open_connection( LDAP *ld,
597         LDAPConn *conn, LDAPURLDesc *srvlist, int async );
598 LDAP_F (int) ldap_int_check_async_open( LDAP *ld, ber_socket_t sd );
599
600 /*
601  * in os-ip.c
602  */
603 #ifndef HAVE_POLL
604 LDAP_V (int) ldap_int_tblsize;
605 LDAP_F (void) ldap_int_ip_init( void );
606 #endif
607
608 LDAP_F (int) ldap_int_timeval_dup( struct timeval **dest,
609         const struct timeval *tm );
610 LDAP_F (int) ldap_connect_to_host( LDAP *ld, Sockbuf *sb,
611         int proto, LDAPURLDesc *srv, int async );
612 LDAP_F (int) ldap_int_poll( LDAP *ld, ber_socket_t s,
613         struct timeval *tvp, int wr );
614
615 #if defined(HAVE_TLS) || defined(HAVE_CYRUS_SASL)
616 LDAP_V (char *) ldap_int_hostname;
617 LDAP_F (char *) ldap_host_connected_to( Sockbuf *sb,
618         const char *host );
619 #endif
620
621 LDAP_F (int) ldap_int_select( LDAP *ld, struct timeval *timeout );
622 LDAP_F (void *) ldap_new_select_info( void );
623 LDAP_F (void) ldap_free_select_info( void *sip );
624 LDAP_F (void) ldap_mark_select_write( LDAP *ld, Sockbuf *sb );
625 LDAP_F (void) ldap_mark_select_read( LDAP *ld, Sockbuf *sb );
626 LDAP_F (void) ldap_mark_select_clear( LDAP *ld, Sockbuf *sb );
627 LDAP_F (void) ldap_clear_select_write( LDAP *ld, Sockbuf *sb );
628 LDAP_F (int) ldap_is_read_ready( LDAP *ld, Sockbuf *sb );
629 LDAP_F (int) ldap_is_write_ready( LDAP *ld, Sockbuf *sb );
630
631 LDAP_F (int) ldap_int_connect_cbs( LDAP *ld, Sockbuf *sb,
632         ber_socket_t *s, LDAPURLDesc *srv, struct sockaddr *addr );
633
634 /*
635  * in os-local.c
636  */
637 #ifdef LDAP_PF_LOCAL
638 LDAP_F (int) ldap_connect_to_path( LDAP *ld, Sockbuf *sb,
639         LDAPURLDesc *srv, int async );
640 #endif /* LDAP_PF_LOCAL */
641
642 /*
643  * in request.c
644  */
645 LDAP_F (ber_int_t) ldap_send_initial_request( LDAP *ld, ber_tag_t msgtype,
646         const char *dn, BerElement *ber, ber_int_t msgid );
647 LDAP_F (BerElement *) ldap_alloc_ber_with_options( LDAP *ld );
648 LDAP_F (void) ldap_set_ber_options( LDAP *ld, BerElement *ber );
649
650 LDAP_F (int) ldap_send_server_request( LDAP *ld, BerElement *ber,
651         ber_int_t msgid, LDAPRequest *parentreq, LDAPURLDesc **srvlist,
652         LDAPConn *lc, LDAPreqinfo *bind, int noconn, int m_res );
653 LDAP_F (LDAPConn *) ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist,
654         int use_ldsb, int connect, LDAPreqinfo *bind, int m_req, int m_res );
655 LDAP_F (LDAPRequest *) ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid );
656 LDAP_F (void) ldap_return_request( LDAP *ld, LDAPRequest *lr, int freeit );
657 LDAP_F (void) ldap_free_request( LDAP *ld, LDAPRequest *lr );
658 LDAP_F (void) ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind );
659 LDAP_F (void) ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all );
660 LDAP_F (void) ldap_dump_requests_and_responses( LDAP *ld );
661 LDAP_F (int) ldap_chase_referrals( LDAP *ld, LDAPRequest *lr,
662         char **errstrp, int sref, int *hadrefp );
663 LDAP_F (int) ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr,
664         char **refs, int sref, char **referralsp, int *hadrefp );
665 LDAP_F (int) ldap_append_referral( LDAP *ld, char **referralsp, char *s );
666 LDAP_F (int) ldap_int_flush_request( LDAP *ld, LDAPRequest *lr );
667
668 /*
669  * in result.c:
670  */
671 LDAP_F (const char *) ldap_int_msgtype2str( ber_tag_t tag );
672
673 /*
674  * in search.c
675  */
676 LDAP_F (BerElement *) ldap_build_search_req LDAP_P((
677         LDAP *ld,
678         const char *base,
679         ber_int_t scope,
680         const char *filter,
681         char **attrs,
682         ber_int_t attrsonly,
683         LDAPControl **sctrls,
684         LDAPControl **cctrls,
685         ber_int_t timelimit,
686         ber_int_t sizelimit,
687         ber_int_t deref,
688         ber_int_t *msgidp));
689
690
691 /*
692  * in unbind.c
693  */
694 LDAP_F (int) ldap_ld_free LDAP_P((
695         LDAP *ld,
696         int close,
697         LDAPControl **sctrls,
698         LDAPControl **cctrls ));
699
700 LDAP_F (int) ldap_send_unbind LDAP_P((
701         LDAP *ld,
702         Sockbuf *sb,
703         LDAPControl **sctrls,
704         LDAPControl **cctrls ));
705
706 /*
707  * in url.c
708  */
709 LDAP_F (LDAPURLDesc *) ldap_url_dup LDAP_P((
710         LDAPURLDesc *ludp ));
711
712 LDAP_F (LDAPURLDesc *) ldap_url_duplist LDAP_P((
713         LDAPURLDesc *ludlist ));
714
715 LDAP_F (int) ldap_url_parsehosts LDAP_P((
716         LDAPURLDesc **ludlist,
717         const char *hosts,
718         int port ));
719
720 LDAP_F (char *) ldap_url_list2hosts LDAP_P((
721         LDAPURLDesc *ludlist ));
722
723 /*
724  * in cyrus.c
725  */
726
727 LDAP_F (int) ldap_int_sasl_init LDAP_P(( void ));
728
729 LDAP_F (int) ldap_int_sasl_open LDAP_P((
730         LDAP *ld, LDAPConn *conn,
731         const char* host ));
732 LDAP_F (int) ldap_int_sasl_close LDAP_P(( LDAP *ld, LDAPConn *conn ));
733
734 LDAP_F (int) ldap_int_sasl_external LDAP_P((
735         LDAP *ld, LDAPConn *conn,
736         const char* authid, ber_len_t ssf ));
737
738 LDAP_F (int) ldap_int_sasl_get_option LDAP_P(( LDAP *ld,
739         int option, void *arg ));
740 LDAP_F (int) ldap_int_sasl_set_option LDAP_P(( LDAP *ld,
741         int option, void *arg ));
742 LDAP_F (int) ldap_int_sasl_config LDAP_P(( struct ldapoptions *lo,
743         int option, const char *arg ));
744
745 LDAP_F (int) ldap_int_sasl_bind LDAP_P((
746         LDAP *ld,
747         const char *,
748         const char *,
749         LDAPControl **, LDAPControl **,
750
751         /* should be passed in client controls */
752         unsigned flags,
753         LDAP_SASL_INTERACT_PROC *interact,
754         void *defaults,
755         LDAPMessage *result,
756         const char **rmech,
757         int *msgid ));
758
759 /* in schema.c */
760 LDAP_F (char *) ldap_int_parse_numericoid LDAP_P((
761         const char **sp,
762         int *code,
763         const int flags ));
764
765 /*
766  * in tls.c
767  */
768 LDAP_F (int) ldap_int_tls_start LDAP_P(( LDAP *ld,
769         LDAPConn *conn, LDAPURLDesc *srv ));
770
771 LDAP_F (void) ldap_int_tls_destroy LDAP_P(( struct ldapoptions *lo ));
772
773 /*
774  *      in getvalues.c
775  */
776 LDAP_F (char **) ldap_value_dup LDAP_P((
777         char *const *vals ));
778
779 /*
780  *      in gssapi.c
781  */
782 #ifdef HAVE_GSSAPI
783 LDAP_F(int) ldap_int_gssapi_get_option LDAP_P(( LDAP *ld, int option, void *arg ));
784 LDAP_F(int) ldap_int_gssapi_set_option LDAP_P(( LDAP *ld, int option, void *arg ));
785 LDAP_F(int) ldap_int_gssapi_config LDAP_P(( struct ldapoptions *lo, int option, const char *arg ));
786 LDAP_F(void) ldap_int_gssapi_close LDAP_P(( LDAP *ld, LDAPConn *lc ));
787 #endif 
788
789 LDAP_END_DECL
790
791 #endif /* _LDAP_INT_H */