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