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