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