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