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