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