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