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