]> git.sur5r.net Git - openldap/blob - include/ldap.h
3ba432e10926abbc36bdd9199184e7e2da4168c8
[openldap] / include / ldap.h
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms are permitted only
7  * as authorized by the OpenLDAP Public License.  A copy of this
8  * license is available at http://www.OpenLDAP.org/license.html or
9  * in file LICENSE in the top-level directory of the distribution.
10  */
11 /* Portions
12  * Copyright (c) 1990 Regents of the University of Michigan.
13  * All rights reserved.
14  *
15  * Redistribution and use in source and binary forms are permitted
16  * provided that this notice is preserved and that due credit is given
17  * to the University of Michigan at Ann Arbor. The name of the University
18  * may not be used to endorse or promote products derived from this
19  * software without specific prior written permission. This software
20  * is provided ``as is'' without express or implied warranty.
21  */
22
23 #ifndef _LDAP_H
24 #define _LDAP_H
25
26 #include <ldap_cdefs.h>
27
28 /* draft spec requires ldap.h include lber declarations */
29 #include <lber.h>
30
31 LDAP_BEGIN_DECL
32
33 #define LDAP_VERSION1   1
34 #define LDAP_VERSION2   2
35 #define LDAP_VERSION3   3
36
37 #define LDAP_VERSION_MIN        LDAP_VERSION2
38 #define LDAP_VERSION            LDAP_VERSION2
39 #define LDAP_VERSION_MAX        LDAP_VERSION3
40
41 /*
42  * We'll use 2000+draft revision for our API version number
43  * As such, the number will be above the old RFC but below 
44  * whatever number does finally get assigned
45  */
46 #define LDAP_API_VERSION        2004
47 #define LDAP_VENDOR_NAME        "OpenLDAP"
48 /* We'll eventually release as 200 */
49 #define LDAP_VENDOR_VERSION     194
50
51 /* OpenLDAP API Features */
52 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
53
54 /* include LDAP_API_FEATURE defines */
55 #include <ldap_features.h>
56
57 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
58         ( defined( LDAP_THREAD_SAFE ) && \
59                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
60         /* -lldap may or may not be thread safe */
61         /* -lldap_r, if available, is always thread safe */
62 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
63 #endif
64 #if defined( LDAP_THREAD_SAFE ) && \
65         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
66 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
67 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
68 #endif
69
70 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
71 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
72
73 #define LDAP_ROOT_DSE                           ""
74 #define LDAP_NO_ATTRS                           "1.1"
75 #define LDAP_ALL_USER_ATTRIBUTES        "*"
76 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
77
78 /*
79  * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
80  * 0x0000 - 0x0fff reserved for api options
81  * 0x1000 - 0x3fff reserved for api extended options
82  * 0x4000 - 0x7fff reserved for private and experimental options
83  */
84 #define LDAP_OPT_API_INFO                       0x0000
85 #define LDAP_OPT_DESC                           0x0001 /* deprecated */
86 #define LDAP_OPT_DEREF                          0x0002
87 #define LDAP_OPT_SIZELIMIT                      0x0003
88 #define LDAP_OPT_TIMELIMIT                      0x0004
89 /* 0x05 - 0x07 not defined by current draft */
90 #define LDAP_OPT_REFERRALS                      0x0008
91 #define LDAP_OPT_RESTART                        0x0009
92 /* 0x0a - 0x10 not defined by current draft */
93 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
94 #define LDAP_OPT_SERVER_CONTROLS        0x0012
95 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
96 /* 0x14 not defined by current draft */
97 #define LDAP_OPT_API_FEATURE_INFO       0x0015
98
99 /* 0x16 - 0x2f not defined by current draft */
100 #define LDAP_OPT_HOST_NAME                      0x0030
101 #define LDAP_OPT_ERROR_NUMBER           0x0031
102 #define LDAP_OPT_ERROR_STRING           0x0032
103 #define LDAP_OPT_MATCHED_DN                     0x0033
104
105 /* 0x34 - 0x0fff not defined by current draft */
106
107 /* private and experimental options */
108 #define LDAP_OPT_DNS                            0x4001  /* use DN & DNS */
109
110 /* OpenLDAP specific options */
111 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
112 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
113 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
114 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
115 #define LDAP_OPT_URI                            0x5006
116
117 /* TLS options */
118 #define LDAP_OPT_X_TLS_CACERTFILE       0x6001
119 #define LDAP_OPT_X_TLS_CACERTDIR        0x6002
120 #define LDAP_OPT_X_TLS_CERT             0x6003
121 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
122 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
123 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
124 #define LDAP_OPT_X_TLS                  0x6007
125 #define LDAP_OPT_X_TLS_PROTOCOL         0x6008
126 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6009
127
128 #define LDAP_OPT_X_TLS_NEVER            0
129 #define LDAP_OPT_X_TLS_HARD             1
130 #define LDAP_OPT_X_TLS_DEMAND           2
131 #define LDAP_OPT_X_TLS_ALLOW            3
132 #define LDAP_OPT_X_TLS_TRY              4
133
134 /* on/off values */
135 #define LDAP_OPT_ON             ((void *) 1)
136 #define LDAP_OPT_OFF    ((void *) 0)
137
138 #define LDAP_OPT_SUCCESS        0
139 #define LDAP_OPT_ERROR          (-1)
140
141 #define LDAP_API_INFO_VERSION   (1)
142 typedef struct ldapapiinfo {
143         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
144         int             ldapai_api_version;                     /* revision of API supported */
145         int             ldapai_protocol_version;        /* highest LDAP version supported */
146         char    **ldapai_extensions;            /* names of API extensions */
147         char    *ldapai_vendor_name;            /* name of supplier */
148         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
149 } LDAPAPIInfo;
150
151 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
152 typedef struct ldap_apifeature_info {
153         int             ldapaif_info_version; /* version of this struct (1) */
154         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
155         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
156 } LDAPAPIFeatureInfo;
157
158 typedef struct ldapcontrol {
159         char *                  ldctl_oid;
160         struct berval   ldctl_value;
161         char                    ldctl_iscritical;
162 } LDAPControl;
163
164 /* LDAP Controls */
165         /* chase referrals controls */
166 #define LDAP_CONTROL_REFERRALS  "1.2.840.113666.1.4.616"
167 #define LDAP_CHASE_SUBORDINATE_REFERRALS        0x0020U
168 #define LDAP_CHASE_EXTERNAL_REFERRALS   0x0040U
169
170 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
171
172 /* Experimental Controls */
173 #define LDAP_CONTROL_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.5.1"
174
175
176 /* LDAP Unsolicited Notifications */
177 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
178 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
179
180
181 /* LDAP Extended Operations */
182 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
183
184
185 /* 
186  * specific LDAP instantiations of BER types we know about
187  */
188
189 /* Overview of LBER tag construction
190  *
191  *      Bits
192  *      ______
193  *      8 7 | CLASS
194  *      0 0 = UNIVERSAL
195  *      0 1 = APPLICATION
196  *      1 0 = CONTEXT-SPECIFIC
197  *      1 1 = PRIVATE
198  *              _____
199  *              | 6 | DATA-TYPE
200  *                0 = PRIMITIVE
201  *                1 = CONSTRUCTED
202  *                      ___________
203  *                      | 5 ... 1 | TAG-NUMBER
204  */
205
206 /* general stuff */
207 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
208 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
209 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octect string */
210 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octect string */
211 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
212 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
213
214 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
215
216 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
217 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
218 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
219 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
220
221 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
222
223
224
225
226 /* possible operations a client can invoke */
227 #define LDAP_REQ_BIND                   ((ber_tag_t) 0x60U)     /* application + constructed */
228 #define LDAP_REQ_UNBIND                 ((ber_tag_t) 0x42U)     /* application + primitive   */
229 #define LDAP_REQ_SEARCH                 ((ber_tag_t) 0x63U)     /* application + constructed */
230 #define LDAP_REQ_MODIFY                 ((ber_tag_t) 0x66U)     /* application + constructed */
231 #define LDAP_REQ_ADD                    ((ber_tag_t) 0x68U)     /* application + constructed */
232 #define LDAP_REQ_DELETE                 ((ber_tag_t) 0x4aU)     /* application + primitive   */
233 #define LDAP_REQ_MODRDN                 ((ber_tag_t) 0x6cU)     /* application + constructed */
234 #define LDAP_REQ_MODDN                  LDAP_REQ_MODRDN 
235 #define LDAP_REQ_RENAME                 LDAP_REQ_MODRDN 
236 #define LDAP_REQ_COMPARE                ((ber_tag_t) 0x6eU)     /* application + constructed */
237 #define LDAP_REQ_ABANDON                ((ber_tag_t) 0x50U)     /* application + primitive   */
238 #define LDAP_REQ_EXTENDED               ((ber_tag_t) 0x77U)     /* application + constructed */
239
240 /* possible result types a server can return */
241 #define LDAP_RES_BIND                   ((ber_tag_t) 0x61U)     /* application + constructed */
242 #define LDAP_RES_SEARCH_ENTRY           ((ber_tag_t) 0x64U)     /* application + constructed */
243 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
244 #define LDAP_RES_SEARCH_RESULT          ((ber_tag_t) 0x65U)     /* application + constructed */
245 #define LDAP_RES_MODIFY                 ((ber_tag_t) 0x67U)     /* application + constructed */
246 #define LDAP_RES_ADD                    ((ber_tag_t) 0x69U)     /* application + constructed */
247 #define LDAP_RES_DELETE                 ((ber_tag_t) 0x6bU)     /* application + constructed */
248 #define LDAP_RES_MODRDN                 ((ber_tag_t) 0x6dU)     /* application + constructed */
249 #define LDAP_RES_MODDN                  LDAP_RES_MODRDN /* application + constructed */
250 #define LDAP_RES_RENAME                 LDAP_RES_MODRDN /* application + constructed */
251 #define LDAP_RES_COMPARE                ((ber_tag_t) 0x6fU)     /* application + constructed */
252 #define LDAP_RES_EXTENDED               ((ber_tag_t) 0x78U)     /* V3: application + constructed */
253
254 #define LDAP_RES_ANY                    ((ber_tag_t)(-1))
255 #define LDAP_RES_UNSOLICITED    ((ber_tag_t)(0))
256
257
258 /* sasl methods */
259 #define LDAP_SASL_SIMPLE                        NULL
260
261 /* authentication methods available */
262 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
263 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
264 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + primitive   */
265 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
266 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
267 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
268
269
270 /* filter types */
271 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
272 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
273 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
274 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
275 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
276 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
277 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
278 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
279 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
280 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
281
282 /* extended filter component types */
283 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
284 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
285 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
286 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
287
288 /* substring filter component types */
289 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
290 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
291 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
292
293 /* search scopes */
294 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
295 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
296 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
297
298 /* for modifications */
299 typedef struct ldapmod {
300         int             mod_op;
301
302 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
303 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
304 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
305 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
306 /* IMPORTANT: do not use code 0x1000 (or above),
307  * it is used internally by the backends!
308  * (see ldap/servers/slapd/slap.h)
309  */
310
311         char            *mod_type;
312         union mod_vals_u {
313                 char            **modv_strvals;
314                 struct berval   **modv_bvals;
315         } mod_vals;
316 #define mod_values      mod_vals.modv_strvals
317 #define mod_bvalues     mod_vals.modv_bvals
318 } LDAPMod;
319
320 /* 
321  * possible error codes we can return
322  */
323
324 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
325
326 #define LDAP_SUCCESS                    0x00
327 #define LDAP_OPERATIONS_ERROR           0x01
328 #define LDAP_PROTOCOL_ERROR             0x02
329 #define LDAP_TIMELIMIT_EXCEEDED         0x03
330 #define LDAP_SIZELIMIT_EXCEEDED         0x04
331 #define LDAP_COMPARE_FALSE              0x05
332 #define LDAP_COMPARE_TRUE               0x06
333 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
334 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
335 #define LDAP_STRONG_AUTH_REQUIRED       0x08
336 #define LDAP_PARTIAL_RESULTS            0x09    /* not listed in v3 */
337
338 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
339 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
340 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
341 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
342 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */       
343
344 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
345
346 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
347 #define LDAP_UNDEFINED_TYPE             0x11
348 #define LDAP_INAPPROPRIATE_MATCHING     0x12
349 #define LDAP_CONSTRAINT_VIOLATION       0x13
350 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
351 #define LDAP_INVALID_SYNTAX             0x15
352
353 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
354
355 #define LDAP_NO_SUCH_OBJECT             0x20
356 #define LDAP_ALIAS_PROBLEM              0x21
357 #define LDAP_INVALID_DN_SYNTAX          0x22
358 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
359 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
360
361 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x30,0x32) /* 48-50 */
362
363 #define LDAP_INAPPROPRIATE_AUTH         0x30
364 #define LDAP_INVALID_CREDENTIALS        0x31
365 #define LDAP_INSUFFICIENT_ACCESS        0x32
366
367 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
368
369 #define LDAP_BUSY                       0x33
370 #define LDAP_UNAVAILABLE                0x34
371 #define LDAP_UNWILLING_TO_PERFORM       0x35
372 #define LDAP_LOOP_DETECT                0x36
373
374 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
375
376 #define LDAP_NAMING_VIOLATION           0x40
377 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
378 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
379 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
380 #define LDAP_ALREADY_EXISTS             0x44
381 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
382 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
383 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
384
385 #define LDAP_OTHER                      0x50
386
387 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0xff) /* 81+ */
388
389 #define LDAP_SERVER_DOWN                0x51
390 #define LDAP_LOCAL_ERROR                0x52
391 #define LDAP_ENCODING_ERROR             0x53
392 #define LDAP_DECODING_ERROR             0x54
393 #define LDAP_TIMEOUT                    0x55
394 #define LDAP_AUTH_UNKNOWN               0x56
395 #define LDAP_FILTER_ERROR               0x57
396 #define LDAP_USER_CANCELLED             0x58
397 #define LDAP_PARAM_ERROR                0x59
398 #define LDAP_NO_MEMORY                  0x5a
399
400 #define LDAP_CONNECT_ERROR                              0x5b    /* new */
401 #define LDAP_NOT_SUPPORTED                              0x5c    /* new */
402 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* new */
403 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* new */
404 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* new */
405 #define LDAP_CLIENT_LOOP                                0x60    /* new */
406 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* new */
407
408 /*
409  * This structure represents both ldap messages and ldap responses.
410  * These are really the same, except in the case of search responses,
411  * where a response has multiple messages.
412  */
413
414 typedef struct ldapmsg LDAPMessage;
415
416 /*
417  * structures for ldap getfilter routines
418  */
419
420 typedef struct ldap_filt_info {
421         char                    *lfi_filter;
422         char                    *lfi_desc;
423         int                     lfi_scope;
424         int                     lfi_isexact;
425         struct ldap_filt_info   *lfi_next;
426 } LDAPFiltInfo;
427
428 typedef struct ldap_filt_list {
429     char                        *lfl_tag;
430     char                        *lfl_pattern;
431     char                        *lfl_delims;
432     LDAPFiltInfo                *lfl_ilist;
433     struct ldap_filt_list       *lfl_next;
434 } LDAPFiltList;
435
436
437 #define LDAP_FILT_MAXSIZ        1024
438
439 typedef struct ldap_filt_desc {
440         LDAPFiltList            *lfd_filtlist;
441         LDAPFiltInfo            *lfd_curfip;
442         LDAPFiltInfo            lfd_retfi;
443         char                    lfd_filter[ LDAP_FILT_MAXSIZ ];
444         char                    *lfd_curval;
445         char                    *lfd_curvalcopy;
446         char                    **lfd_curvalwords;
447         char                    *lfd_filtprefix;
448         char                    *lfd_filtsuffix;
449 } LDAPFiltDesc;
450
451
452 /*
453  * structure representing an ldap session which can
454  * encompass connections to multiple servers (in the
455  * face of referrals).
456  */
457 typedef struct ldap LDAP;
458
459 #define LDAP_DEREF_NEVER        0x00
460 #define LDAP_DEREF_SEARCHING    0x01
461 #define LDAP_DEREF_FINDING      0x02
462 #define LDAP_DEREF_ALWAYS       0x03
463
464 #define LDAP_NO_LIMIT           0
465
466 /* how many messages to retrieve results for */
467 #define LDAP_MSG_ONE            0x00
468 #define LDAP_MSG_ALL            0x01
469 #define LDAP_MSG_RECEIVED       0x02
470
471 /*
472  * structure for ldap friendly mapping routines
473  */
474
475 typedef struct ldap_friendly {
476         char    *lf_unfriendly;
477         char    *lf_friendly;
478 } LDAPFriendlyMap;
479
480 /*
481  * types for ldap URL handling
482  */
483 typedef struct ldap_url_desc {
484         struct ldap_url_desc *lud_next;
485         int             lud_ldaps;
486     char        *lud_host;
487     int         lud_port;
488     char        *lud_dn;
489     char        **lud_attrs;
490     int         lud_scope;
491     char        *lud_filter;
492         char    **lud_exts;
493 } LDAPURLDesc;
494
495 #define LDAP_URL_SUCCESS                0x00    /* Success */
496 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
497 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
498
499 #define LDAP_URL_ERR_NOTLDAP    0x03    /* URL doesn't begin with "ldap[s]://" */
500 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
501 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
502 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
503 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
504 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
505 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
506 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
507
508 /*
509  * The API draft spec says we should declare (or cause to be declared)
510  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
511  */
512 struct timeval;
513
514 /*
515  * in options.c:
516  */
517 LIBLDAP_F( int )
518 ldap_get_option LDAP_P((
519         LDAP *ld,
520         int option,
521         void *outvalue));
522
523 LIBLDAP_F( int )
524 ldap_set_option LDAP_P((
525         LDAP *ld,
526         int option,
527         LDAP_CONST void *invalue));
528
529
530 /*
531  * in controls.c:
532  */
533 LIBLDAP_F( void )
534 ldap_control_free LDAP_P((
535         LDAPControl *ctrl ));
536
537 LIBLDAP_F( void )
538 ldap_controls_free LDAP_P((
539         LDAPControl **ctrls ));
540
541   
542 /*
543  * in extended.c:
544  */
545 LIBLDAP_F( int )
546 ldap_extended_operation LDAP_P((
547         LDAP                    *ld,
548         LDAP_CONST char *reqoid,
549         struct berval   *reqdata,
550         LDAPControl             **serverctrls,
551         LDAPControl             **clientctrls,
552         int                             *msgidp ));
553
554 LIBLDAP_F( int )
555 ldap_extended_operation_s LDAP_P((
556         LDAP                    *ld,
557         LDAP_CONST char *reqoid,
558         struct berval   *reqdata,
559         LDAPControl             **serverctrls,
560         LDAPControl             **clientctrls,
561         char                    **retoidp,
562         struct berval   **retdatap ));
563
564 LIBLDAP_F( int )
565 ldap_parse_extended_result LDAP_P((
566         LDAP                    *ld,
567         LDAPMessage             *res,
568         char                    **retoidp,
569         struct berval   **retdatap,
570         int                             freeit ));
571
572 /*
573  * in abandon.c:
574  */
575 LIBLDAP_F( int )
576 ldap_abandon LDAP_P((
577         LDAP *ld,
578         int msgid ));
579
580 LIBLDAP_F( int )
581 ldap_abandon_ext LDAP_P((
582         LDAP                    *ld,
583         int                             msgid,
584         LDAPControl             **serverctrls,
585         LDAPControl             **clientctrls ));
586
587
588 /*
589  * in add.c:
590  */
591 LIBLDAP_F( int )
592 ldap_add_ext LDAP_P((
593         LDAP                    *ld,
594         LDAP_CONST char *dn,
595         LDAPMod                 **attrs,
596         LDAPControl             **serverctrls,
597         LDAPControl             **clientctrls,
598         int                     *msgidp ));
599
600 LIBLDAP_F( int )
601 ldap_add_ext_s LDAP_P((
602         LDAP                    *ld,
603         LDAP_CONST char *dn,
604         LDAPMod                 **attrs,
605         LDAPControl             **serverctrls,
606         LDAPControl             **clientctrls ));
607
608 LIBLDAP_F( int )
609 ldap_add LDAP_P((
610         LDAP *ld,
611         LDAP_CONST char *dn,
612         LDAPMod **attrs ));
613
614 LIBLDAP_F( int )
615 ldap_add_s LDAP_P((
616         LDAP *ld,
617         LDAP_CONST char *dn,
618         LDAPMod **attrs ));
619
620
621 /*
622  * in sasl.c:
623  */
624 LIBLDAP_F( int )
625 ldap_sasl_bind LDAP_P((
626         LDAP                    *ld,
627         LDAP_CONST char *dn,
628         LDAP_CONST char *mechanism,
629         struct berval   *cred,
630         LDAPControl             **serverctrls,
631         LDAPControl             **clientctrls,
632         int                             *msgidp ));
633
634 LIBLDAP_F( int )
635 ldap_sasl_bind_s LDAP_P((
636         LDAP                    *ld,
637         LDAP_CONST char *dn,
638         LDAP_CONST char *mechanism,
639         struct berval   *cred,
640         LDAPControl             **serverctrls,
641         LDAPControl             **clientctrls,
642         struct berval   **servercredp ));
643
644 LIBLDAP_F( int )
645 ldap_parse_sasl_bind_result LDAP_P((
646         LDAP                    *ld,
647         LDAPMessage             *res,
648         struct berval   **servercredp,
649         int                             freeit ));
650
651 /*
652  * in bind.c:
653  *      (deprecated)
654  */
655 LIBLDAP_F( int )
656 ldap_bind LDAP_P((
657         LDAP *ld,
658         LDAP_CONST char *who,
659         LDAP_CONST char *passwd,
660         int authmethod ));
661
662 LIBLDAP_F( int )
663 ldap_bind_s LDAP_P((
664         LDAP *ld,
665         LDAP_CONST char *who,
666         LDAP_CONST char *cred,
667         int authmethod ));
668
669 LIBLDAP_F( void )
670 ldap_set_rebind_proc LDAP_P((
671         LDAP *ld,
672         int (*rebindproc) LDAP_P((
673                 LDAP *ld,
674                 char **dnp,
675                 char **passwdp,
676                 int *authmethodp,
677                 int freeit ))));
678
679
680 /*
681  * in sbind.c:
682  */
683 LIBLDAP_F( int )
684 ldap_simple_bind LDAP_P((
685         LDAP *ld,
686         LDAP_CONST char *who,
687         LDAP_CONST char *passwd ));
688
689 LIBLDAP_F( int )
690 ldap_simple_bind_s LDAP_P((
691         LDAP *ld,
692         LDAP_CONST char *who,
693         LDAP_CONST char *passwd ));
694
695
696 /*
697  * in kbind.c:
698  *      (deprecated)
699  */
700 LIBLDAP_F( int )
701 ldap_kerberos_bind_s LDAP_P((
702         LDAP *ld,
703         LDAP_CONST char *who ));
704
705 LIBLDAP_F( int )
706 ldap_kerberos_bind1 LDAP_P((
707         LDAP *ld,
708         LDAP_CONST char *who ));
709
710 LIBLDAP_F( int )
711 ldap_kerberos_bind1_s LDAP_P((
712         LDAP *ld,
713         LDAP_CONST char *who ));
714
715 LIBLDAP_F( int )
716 ldap_kerberos_bind2 LDAP_P((
717         LDAP *ld,
718         LDAP_CONST char *who ));
719
720 LIBLDAP_F( int )
721 ldap_kerberos_bind2_s LDAP_P((
722         LDAP *ld,
723         LDAP_CONST char *who ));
724
725 /*
726  * in cache.c
727  * (deprecated)
728  */
729 LIBLDAP_F( int )
730 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
731
732 LIBLDAP_F( void )
733 ldap_disable_cache LDAP_P(( LDAP *ld ));
734
735 LIBLDAP_F( void )
736 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
737
738 LIBLDAP_F( void )
739 ldap_destroy_cache LDAP_P(( LDAP *ld ));
740
741 LIBLDAP_F( void )
742 ldap_flush_cache LDAP_P(( LDAP *ld ));
743
744 LIBLDAP_F( void )
745 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
746
747 LIBLDAP_F( void )
748 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
749
750
751 /*
752  * in compare.c:
753  */
754 LIBLDAP_F( int )
755 ldap_compare_ext LDAP_P((
756         LDAP                    *ld,
757         LDAP_CONST char *dn,
758         LDAP_CONST char *attr,
759         struct berval   *bvalue,
760         LDAPControl             **serverctrls,
761         LDAPControl             **clientctrls,
762         int                     *msgidp ));
763
764 LIBLDAP_F( int )
765 ldap_compare_ext_s LDAP_P((
766         LDAP                    *ld,
767         LDAP_CONST char *dn,
768         LDAP_CONST char *attr,
769         struct berval   *bvalue,
770         LDAPControl             **serverctrls,
771         LDAPControl             **clientctrls ));
772
773 LIBLDAP_F( int )
774 ldap_compare LDAP_P((
775         LDAP *ld,
776         LDAP_CONST char *dn,
777         LDAP_CONST char *attr,
778         LDAP_CONST char *value ));
779
780 LIBLDAP_F( int )
781 ldap_compare_s LDAP_P((
782         LDAP *ld,
783         LDAP_CONST char *dn,
784         LDAP_CONST char *attr,
785         LDAP_CONST char *value ));
786
787
788 /*
789  * in delete.c:
790  */
791 LIBLDAP_F( int )
792 ldap_delete_ext LDAP_P((
793         LDAP                    *ld,
794         LDAP_CONST char *dn,
795         LDAPControl             **serverctrls,
796         LDAPControl             **clientctrls,
797         int                     *msgidp ));
798
799 LIBLDAP_F( int )
800 ldap_delete_ext_s LDAP_P((
801         LDAP                    *ld,
802         LDAP_CONST char *dn,
803         LDAPControl             **serverctrls,
804         LDAPControl             **clientctrls ));
805
806 LIBLDAP_F( int )
807 ldap_delete LDAP_P((
808         LDAP *ld,
809         LDAP_CONST char *dn ));
810
811 LIBLDAP_F( int )
812 ldap_delete_s LDAP_P((
813         LDAP *ld,
814         LDAP_CONST char *dn ));
815
816
817 /*
818  * in error.c:
819  */
820 LIBLDAP_F( int )
821 ldap_parse_result LDAP_P((
822         LDAP                    *ld,
823         LDAPMessage             *res,
824         int                             *errcodep,
825         char                    **matcheddnp,
826         char                    **errmsgp,
827         char                    ***referralsp,
828         LDAPControl             ***serverctrls,
829         int                             freeit ));
830
831 LIBLDAP_F( char *)
832 ldap_err2string LDAP_P((
833         int err ));
834
835 LIBLDAP_F( int )
836 ldap_result2error LDAP_P((      /* deprecated */
837         LDAP *ld,
838         LDAPMessage *r,
839         int freeit ));
840
841 LIBLDAP_F( void )
842 ldap_perror LDAP_P((    /* deprecated */
843         LDAP *ld,
844         LDAP_CONST char *s ));
845
846
847 /*
848  * in modify.c:
849  */
850 LIBLDAP_F( int )
851 ldap_modify_ext LDAP_P((
852         LDAP                    *ld,
853         LDAP_CONST char *dn,
854         LDAPMod                 **mods,
855         LDAPControl             **serverctrls,
856         LDAPControl             **clientctrls,
857         int                     *msgidp ));
858
859 LIBLDAP_F( int )
860 ldap_modify_ext_s LDAP_P((
861         LDAP                    *ld,
862         LDAP_CONST char *dn,
863         LDAPMod                 **mods,
864         LDAPControl             **serverctrls,
865         LDAPControl             **clientctrls ));
866
867 LIBLDAP_F( int )
868 ldap_modify LDAP_P((
869         LDAP *ld,
870         LDAP_CONST char *dn,
871         LDAPMod **mods ));
872
873 LIBLDAP_F( int )
874 ldap_modify_s LDAP_P((
875         LDAP *ld,
876         LDAP_CONST char *dn,
877         LDAPMod **mods ));
878
879
880 /*
881  * in modrdn.c:
882  */
883 LIBLDAP_F( int )
884 ldap_rename LDAP_P((
885         LDAP *ld,
886         LDAP_CONST char *dn,
887         LDAP_CONST char *newrdn,
888         LDAP_CONST char *newSuperior,
889         int deleteoldrdn,
890         LDAPControl **sctrls,
891         LDAPControl **cctrls,
892         int *msgidp ));
893
894 LIBLDAP_F( int )
895 ldap_rename_s LDAP_P((
896         LDAP *ld,
897         LDAP_CONST char *dn,
898         LDAP_CONST char *newrdn,
899         LDAP_CONST char *newSuperior,
900         int deleteoldrdn,
901         LDAPControl **sctrls,
902         LDAPControl **cctrls ));
903
904 LIBLDAP_F( int )
905 ldap_rename_ext LDAP_P((
906         LDAP                    *ld,
907         LDAP_CONST char *dn,
908         LDAP_CONST char *newrdn,
909         LDAP_CONST char *newparent,
910         int                             deleteoldrdn,
911         LDAPControl             **serverctrls,
912         LDAPControl             **clientctrls,
913         int                     *msgidp ));
914
915 LIBLDAP_F( int )
916 ldap_rename_ext_s LDAP_P((
917         LDAP                    *ld,
918         LDAP_CONST char *dn,
919         LDAP_CONST char *newrdn,
920         LDAP_CONST char *newparent,
921         int                             deleteoldrdn,
922         LDAPControl             **serverctrls,
923         LDAPControl             **clientctrls ));
924
925 LIBLDAP_F( int )
926 ldap_rename2 LDAP_P((
927         LDAP *ld,
928         LDAP_CONST char *dn,
929         LDAP_CONST char *newrdn,
930         LDAP_CONST char *newSuperior,
931         int deleteoldrdn ));
932
933 LIBLDAP_F( int )
934 ldap_rename2_s LDAP_P((
935         LDAP *ld,
936         LDAP_CONST char *dn,
937         LDAP_CONST char *newrdn,
938         LDAP_CONST char *newSuperior,
939         int deleteoldrdn ));
940
941 LIBLDAP_F( int )
942 ldap_modrdn LDAP_P((
943         LDAP *ld,
944         LDAP_CONST char *dn,
945         LDAP_CONST char *newrdn ));
946
947 LIBLDAP_F( int )
948 ldap_modrdn_s LDAP_P((
949         LDAP *ld,
950         LDAP_CONST char *dn,
951         LDAP_CONST char *newrdn ));
952
953 LIBLDAP_F( int )
954 ldap_modrdn2 LDAP_P((
955         LDAP *ld,
956         LDAP_CONST char *dn,
957         LDAP_CONST char *newrdn,
958         int deleteoldrdn ));
959
960 LIBLDAP_F( int )
961 ldap_modrdn2_s LDAP_P((
962         LDAP *ld,
963         LDAP_CONST char *dn,
964         LDAP_CONST char *newrdn,
965         int deleteoldrdn));
966
967
968 /*
969  * in open.c:
970  */
971 LIBLDAP_F( LDAP *)
972 ldap_open LDAP_P((
973         LDAP_CONST char *host,
974         int port ));
975
976 LIBLDAP_F( LDAP *)
977 ldap_init LDAP_P((
978         LDAP_CONST char *host,
979         int port ));
980
981
982 /*
983  * in messages.c:
984  */
985 LIBLDAP_F( LDAPMessage *)
986 ldap_first_message LDAP_P((
987         LDAP *ld,
988         LDAPMessage *chain ));
989
990 LIBLDAP_F( LDAPMessage *)
991 ldap_next_message LDAP_P((
992         LDAP *ld,
993         LDAPMessage *msg ));
994
995 LIBLDAP_F( int )
996 ldap_count_messages LDAP_P((
997         LDAP *ld,
998         LDAPMessage *chain ));
999
1000
1001 /*
1002  * in references.c:
1003  */
1004 LIBLDAP_F( LDAPMessage *)
1005 ldap_first_reference LDAP_P((
1006         LDAP *ld,
1007         LDAPMessage *chain ));
1008
1009 LIBLDAP_F( LDAPMessage *)
1010 ldap_next_reference LDAP_P((
1011         LDAP *ld,
1012         LDAPMessage *ref ));
1013
1014 LIBLDAP_F( int )
1015 ldap_count_references LDAP_P((
1016         LDAP *ld,
1017         LDAPMessage *chain ));
1018
1019 LIBLDAP_F( int )
1020 ldap_parse_reference LDAP_P((
1021         LDAP                    *ld,
1022         LDAPMessage             *ref,
1023         char                    ***referralsp,
1024         LDAPControl             ***serverctrls,
1025         int                             freeit));
1026
1027
1028 /*
1029  * in getentry.c:
1030  */
1031 LIBLDAP_F( LDAPMessage *)
1032 ldap_first_entry LDAP_P((
1033         LDAP *ld,
1034         LDAPMessage *chain ));
1035
1036 LIBLDAP_F( LDAPMessage *)
1037 ldap_next_entry LDAP_P((
1038         LDAP *ld,
1039         LDAPMessage *entry ));
1040
1041 LIBLDAP_F( int )
1042 ldap_count_entries LDAP_P((
1043         LDAP *ld,
1044         LDAPMessage *chain ));
1045
1046 LIBLDAP_F( int )
1047 ldap_get_entry_controls LDAP_P((
1048         LDAP                    *ld,
1049         LDAPMessage             *entry,
1050         LDAPControl             ***serverctrls));
1051
1052
1053 /*
1054  * in addentry.c
1055  */
1056 LIBLDAP_F( LDAPMessage *)
1057 ldap_delete_result_entry LDAP_P((
1058         LDAPMessage **list,
1059         LDAPMessage *e ));
1060
1061 LIBLDAP_F( void )
1062 ldap_add_result_entry LDAP_P((
1063         LDAPMessage **list,
1064         LDAPMessage *e ));
1065
1066
1067 /*
1068  * in getdn.c
1069  */
1070 LIBLDAP_F( char * )
1071 ldap_get_dn LDAP_P((
1072         LDAP *ld,
1073         LDAPMessage *entry ));
1074
1075 LIBLDAP_F( char * )
1076 ldap_dn2ufn LDAP_P((
1077         LDAP_CONST char *dn ));
1078
1079 LIBLDAP_F( char ** )
1080 ldap_explode_dn LDAP_P((
1081         LDAP_CONST char *dn,
1082         int notypes ));
1083
1084 LIBLDAP_F( char ** )
1085 ldap_explode_rdn LDAP_P((
1086         LDAP_CONST char *rdn,
1087         int notypes ));
1088
1089 LIBLDAP_F( char * )
1090 ldap_parent_dn LDAP_P((
1091         LDAP_CONST char *dn ));
1092
1093 LIBLDAP_F( char * )
1094 ldap_relative_dn LDAP_P((
1095         LDAP_CONST char *dn ));
1096
1097 LIBLDAP_F( char * )
1098 ldap_normalize_dn LDAP_P((
1099         LDAP_CONST char *dn ));
1100
1101 LIBLDAP_F( char ** )
1102 ldap_explode_dns LDAP_P(( /* deprecated */
1103         LDAP_CONST char *dn ));
1104
1105 LIBLDAP_F( int )
1106 ldap_is_dns_dn LDAP_P(( /* deprecated */
1107         LDAP_CONST char *dn ));
1108
1109
1110 /*
1111  * in getattr.c
1112  */
1113 LIBLDAP_F( char *)
1114 ldap_first_attribute LDAP_P((                                                                    
1115         LDAP *ld,
1116         LDAPMessage *entry,
1117         BerElement **ber ));
1118
1119 LIBLDAP_F( char *)
1120 ldap_next_attribute LDAP_P((
1121         LDAP *ld,
1122         LDAPMessage *entry,
1123         BerElement *ber ));
1124
1125
1126 /*
1127  * in getvalues.c
1128  */
1129 LIBLDAP_F( char **)
1130 ldap_get_values LDAP_P((
1131         LDAP *ld,
1132         LDAPMessage *entry,
1133         LDAP_CONST char *target ));
1134
1135 LIBLDAP_F( struct berval **)
1136 ldap_get_values_len LDAP_P((
1137         LDAP *ld,
1138         LDAPMessage *entry,
1139         LDAP_CONST char *target ));
1140
1141 LIBLDAP_F( int )
1142 ldap_count_values LDAP_P((
1143         char **vals ));
1144
1145 LIBLDAP_F( int )
1146 ldap_count_values_len LDAP_P((
1147         struct berval **vals ));
1148
1149 LIBLDAP_F( void )
1150 ldap_value_free LDAP_P((
1151         char **vals ));
1152
1153 LIBLDAP_F( void )
1154 ldap_value_free_len LDAP_P((
1155         struct berval **vals ));
1156
1157 /*
1158  * in result.c:
1159  */
1160 LIBLDAP_F( int )
1161 ldap_result LDAP_P((
1162         LDAP *ld,
1163         int msgid,
1164         int all,
1165         struct timeval *timeout,
1166         LDAPMessage **result ));
1167
1168 LIBLDAP_F( int )
1169 ldap_msgtype LDAP_P((
1170         LDAPMessage *lm ));
1171
1172 LIBLDAP_F( int )
1173 ldap_msgid   LDAP_P((
1174         LDAPMessage *lm ));
1175
1176 LIBLDAP_F( int )
1177 ldap_msgfree LDAP_P((
1178         LDAPMessage *lm ));
1179
1180 LIBLDAP_F( int )
1181 ldap_msgdelete LDAP_P((
1182         LDAP *ld,
1183         int msgid ));
1184
1185
1186 /*
1187  * in search.c:
1188  */
1189 LIBLDAP_F( int )
1190 ldap_search_ext LDAP_P((
1191         LDAP                    *ld,
1192         LDAP_CONST char *base,
1193         int                             scope,
1194         LDAP_CONST char *filter,
1195         char                    **attrs,
1196         int                             attrsonly,
1197         LDAPControl             **serverctrls,
1198         LDAPControl             **clientctrls,
1199         struct timeval  *timeout,
1200         int                             sizelimit,
1201         int                             *msgidp ));
1202
1203 LIBLDAP_F( int )
1204 ldap_search_ext_s LDAP_P((
1205         LDAP                    *ld,
1206         LDAP_CONST char *base,
1207         int                             scope,
1208         LDAP_CONST char *filter,
1209         char                    **attrs,
1210         int                             attrsonly,
1211         LDAPControl             **serverctrls,
1212         LDAPControl             **clientctrls,
1213         struct timeval  *timeout,
1214         int                             sizelimit,
1215         LDAPMessage             **res ));
1216
1217 LIBLDAP_F( int )
1218 ldap_search LDAP_P((
1219         LDAP *ld,
1220         LDAP_CONST char *base,
1221         int scope,
1222         LDAP_CONST char *filter,
1223         char **attrs,
1224         int attrsonly ));
1225
1226 LIBLDAP_F( int )
1227 ldap_search_s LDAP_P((
1228         LDAP *ld,
1229         LDAP_CONST char *base,
1230         int scope,
1231         LDAP_CONST char *filter,
1232         char **attrs,
1233         int attrsonly,
1234         LDAPMessage **res ));
1235
1236 LIBLDAP_F( int )
1237 ldap_search_st LDAP_P((                                                  
1238         LDAP *ld,
1239         LDAP_CONST char *base,
1240         int scope,
1241         LDAP_CONST char *filter,
1242     char **attrs,
1243         int attrsonly,
1244         struct timeval *timeout,
1245         LDAPMessage **res ));
1246
1247
1248 /*
1249  * in ufn.c
1250  */
1251 LIBLDAP_F( int )
1252 ldap_ufn_search_c LDAP_P((
1253         LDAP *ld,
1254         LDAP_CONST char *ufn,
1255         char **attrs,
1256         int attrsonly,
1257         LDAPMessage **res,
1258         int (*cancelproc)( void *cl ),
1259         void *cancelparm ));
1260
1261 LIBLDAP_F( int )
1262 ldap_ufn_search_ct LDAP_P((
1263         LDAP *ld,
1264         LDAP_CONST char *ufn,
1265         char **attrs,
1266         int attrsonly,
1267         LDAPMessage **res,
1268         int (*cancelproc)( void *cl ),
1269         void *cancelparm,
1270         char *tag1,
1271         char *tag2,
1272         char *tag3 ));
1273
1274 LIBLDAP_F( int )
1275 ldap_ufn_search_s LDAP_P((
1276         LDAP *ld,
1277         LDAP_CONST char *ufn,
1278         char **attrs,
1279         int attrsonly,
1280         LDAPMessage **res ));
1281
1282 LIBLDAP_F( LDAPFiltDesc *)
1283 ldap_ufn_setfilter LDAP_P((
1284         LDAP *ld,
1285         LDAP_CONST char *fname ));
1286
1287 LIBLDAP_F( void )
1288 ldap_ufn_setprefix LDAP_P((
1289         LDAP *ld,
1290         LDAP_CONST char *prefix ));
1291
1292 LIBLDAP_F( int )
1293 ldap_ufn_timeout LDAP_P((
1294         void *tvparam ));
1295
1296
1297 /*
1298  * in unbind.c
1299  */
1300 LIBLDAP_F( int )
1301 ldap_unbind LDAP_P((
1302         LDAP *ld ));
1303
1304 LIBLDAP_F( int )
1305 ldap_unbind_s LDAP_P((
1306         LDAP *ld ));
1307
1308 LIBLDAP_F( int )
1309 ldap_unbind_ext LDAP_P((
1310         LDAP                    *ld,
1311         LDAPControl             **serverctrls,
1312         LDAPControl             **clientctrls));
1313
1314 LIBLDAP_F( int )
1315 ldap_unbind_ext_s LDAP_P((
1316         LDAP                    *ld,
1317         LDAPControl             **serverctrls,
1318         LDAPControl             **clientctrls));
1319
1320 /*
1321  * in getfilter.c
1322  */
1323 LIBLDAP_F( LDAPFiltDesc *)
1324 ldap_init_getfilter LDAP_P((
1325         LDAP_CONST char *fname ));
1326
1327 LIBLDAP_F( LDAPFiltDesc *)
1328 ldap_init_getfilter_buf LDAP_P((
1329         /* LDAP_CONST */ char *buf,
1330         ber_len_t buflen ));
1331
1332 LIBLDAP_F( LDAPFiltInfo *)
1333 ldap_getfirstfilter LDAP_P((
1334         LDAPFiltDesc *lfdp,
1335         /* LDAP_CONST */ char *tagpat,
1336         /* LDAP_CONST */ char *value ));
1337
1338 LIBLDAP_F( LDAPFiltInfo *)
1339 ldap_getnextfilter LDAP_P((
1340         LDAPFiltDesc *lfdp ));
1341
1342 LIBLDAP_F( void )
1343 ldap_setfilteraffixes LDAP_P((
1344         LDAPFiltDesc *lfdp,
1345         LDAP_CONST char *prefix,
1346         LDAP_CONST char *suffix ));
1347
1348 LIBLDAP_F( void )
1349 ldap_build_filter LDAP_P((
1350         char *buf,
1351         ber_len_t buflen,
1352         LDAP_CONST char *pattern,
1353         LDAP_CONST char *prefix,
1354         LDAP_CONST char *suffix,
1355         LDAP_CONST char *attr,
1356         LDAP_CONST char *value,
1357         char **valwords ));
1358
1359
1360 /*
1361  * in free.c
1362  */
1363
1364 LIBLDAP_F( void * )
1365 ldap_memalloc LDAP_P((
1366         ber_len_t s ));
1367
1368 LIBLDAP_F( void * )
1369 ldap_memrealloc LDAP_P((
1370         void* p,
1371         ber_len_t s ));
1372
1373 LIBLDAP_F( void * )
1374 ldap_memcalloc LDAP_P((
1375         ber_len_t n,
1376         ber_len_t s ));
1377
1378 LIBLDAP_F( void )
1379 ldap_memfree LDAP_P((
1380         void* p ));
1381
1382 LIBLDAP_F( void )
1383 ldap_memvfree LDAP_P((
1384         void** v ));
1385
1386 LIBLDAP_F( char * )
1387 ldap_strdup LDAP_P((
1388         LDAP_CONST char * ));
1389
1390 LIBLDAP_F( void )
1391 ldap_getfilter_free LDAP_P((
1392         LDAPFiltDesc *lfdp ));
1393
1394 LIBLDAP_F( void )
1395 ldap_mods_free LDAP_P((
1396         LDAPMod **mods,
1397         int freemods ));
1398
1399
1400 /*
1401  * in friendly.c
1402  */
1403 LIBLDAP_F( char * )
1404 ldap_friendly_name LDAP_P((
1405         LDAP_CONST char *filename,
1406         /* LDAP_CONST */ char *uname,
1407         LDAPFriendlyMap **map ));
1408
1409 LIBLDAP_F( void )
1410 ldap_free_friendlymap LDAP_P((
1411         LDAPFriendlyMap **map ));
1412
1413
1414 /*
1415  * in cldap.c
1416  */
1417 LIBLDAP_F( LDAP * )
1418 cldap_open LDAP_P((
1419         LDAP_CONST char *host,
1420         int port ));
1421
1422 LIBLDAP_F( void )
1423 cldap_close LDAP_P((
1424         LDAP *ld ));
1425
1426 LIBLDAP_F( int )
1427 cldap_search_s LDAP_P(( LDAP *ld,
1428         LDAP_CONST char *base,
1429         int scope,
1430         LDAP_CONST char *filter,
1431         char **attrs,
1432         int attrsonly,
1433         LDAPMessage **res,
1434         char *logdn ));
1435
1436 LIBLDAP_F( void )
1437 cldap_setretryinfo LDAP_P((
1438         LDAP *ld,
1439         int tries,
1440         int timeout ));
1441
1442
1443 /*
1444  * in sort.c
1445  */
1446 LIBLDAP_F( int )
1447 ldap_sort_entries LDAP_P(( LDAP *ld,
1448         LDAPMessage **chain,
1449         LDAP_CONST char *attr,
1450         int (*cmp) (LDAP_CONST char *, LDAP_CONST char *) ));
1451
1452 LIBLDAP_F( int )
1453 ldap_sort_values LDAP_P((
1454         LDAP *ld,
1455         char **vals,
1456         int (*cmp) (LDAP_CONST void *, LDAP_CONST void *) ));
1457
1458 LIBLDAP_F( int )
1459 ldap_sort_strcasecmp LDAP_P((
1460         LDAP_CONST void *a,
1461         LDAP_CONST void *b ));
1462
1463
1464 /*
1465  * in url.c
1466  *
1467  * need _ext varients
1468  */
1469 LIBLDAP_F( int )
1470 ldap_is_ldap_url LDAP_P((
1471         LDAP_CONST char *url ));
1472
1473 LIBLDAP_F( int )
1474 ldap_is_ldaps_url LDAP_P((
1475         LDAP_CONST char *url ));
1476
1477 LIBLDAP_F( int )
1478 ldap_url_parse LDAP_P((
1479         LDAP_CONST char *url,
1480         LDAPURLDesc **ludpp ));
1481
1482 LIBLDAP_F( void )
1483 ldap_free_urldesc LDAP_P((
1484         LDAPURLDesc *ludp ));
1485
1486 LIBLDAP_F( int )
1487 ldap_url_search LDAP_P((
1488         LDAP *ld,
1489         LDAP_CONST char *url,
1490         int attrsonly ));
1491
1492 LIBLDAP_F( int )
1493 ldap_url_search_s LDAP_P((
1494         LDAP *ld,
1495         LDAP_CONST char *url,
1496         int attrsonly,
1497         LDAPMessage **res ));
1498
1499 LIBLDAP_F( int )
1500 ldap_url_search_st LDAP_P((
1501         LDAP *ld,
1502         LDAP_CONST char *url,
1503         int attrsonly,
1504         struct timeval *timeout,
1505         LDAPMessage **res ));
1506
1507
1508 /*
1509  * in charset.c
1510  *      DEPRECATED
1511  */
1512 LIBLDAP_F( void )
1513 ldap_set_string_translators LDAP_P((
1514         LDAP *ld,
1515         BERTranslateProc encode_proc,
1516         BERTranslateProc decode_proc ));
1517
1518 LIBLDAP_F( int )
1519 ldap_translate_from_t61 LDAP_P((
1520         LDAP *ld,
1521         char **bufp,
1522         ber_len_t *lenp,
1523         int free_input ));
1524
1525 LIBLDAP_F( int )
1526 ldap_translate_to_t61 LDAP_P((
1527         LDAP *ld,
1528         char **bufp,
1529         ber_len_t *lenp,
1530         int free_input ));
1531
1532 LIBLDAP_F( void )
1533 ldap_enable_translation LDAP_P((
1534         LDAP *ld,
1535         LDAPMessage *entry,
1536         int enable ));
1537
1538 LIBLDAP_F( int )
1539 ldap_t61_to_8859 LDAP_P((
1540         char **bufp,
1541         ber_len_t *buflenp,
1542         int free_input ));
1543
1544 LIBLDAP_F( int )
1545 ldap_8859_to_t61 LDAP_P((
1546         char **bufp,
1547         ber_len_t *buflenp,
1548         int free_input ));
1549
1550 LDAP_END_DECL
1551
1552 #endif /* _LDAP_H */