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