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