]> git.sur5r.net Git - openldap/blob - include/ldap.h
rename "permit modify" control to "permissive modify"
[openldap] / include / ldap.h
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted only as authorized by the OpenLDAP
8  * Public License.  A copy of this license is available at
9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10  * top-level directory of the distribution.
11  */
12 /* Portions
13  * Copyright (c) 1990 Regents of the University of Michigan.
14  * All rights reserved.
15  *
16  * Redistribution and use in source and binary forms are permitted
17  * provided that this notice is preserved and that due credit is given
18  * to the University of Michigan at Ann Arbor. The name of the University
19  * may not be used to endorse or promote products derived from this
20  * software without specific prior written permission. This software
21  * is provided ``as is'' without express or implied warranty.
22  */
23
24 #ifndef _LDAP_H
25 #define _LDAP_H
26
27 /* pull in lber */
28 #include <lber.h>
29
30 /* include version and API feature defines */
31 #include <ldap_features.h>
32
33 LDAP_BEGIN_DECL
34
35 #define LDAP_VERSION1   1
36 #define LDAP_VERSION2   2
37 #define LDAP_VERSION3   3
38
39 #define LDAP_VERSION_MIN        LDAP_VERSION2
40 #define LDAP_VERSION            LDAP_VERSION2
41 #define LDAP_VERSION_MAX        LDAP_VERSION3
42
43 /*
44  * We'll use 2000+draft revision for our API version number
45  * As such, the number will be above the old RFC but below
46  * whatever number does finally get assigned
47  */
48 #define LDAP_API_VERSION        2004
49 #define LDAP_VENDOR_NAME        "OpenLDAP"
50
51 /* OpenLDAP API Features */
52 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
53
54 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
55         ( defined( LDAP_THREAD_SAFE ) && \
56                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
57         /* -lldap may or may not be thread safe */
58         /* -lldap_r, if available, is always thread safe */
59 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
60 #endif
61 #if defined( LDAP_THREAD_SAFE ) && \
62         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
63 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
64 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
65 #endif
66
67 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
68 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
69
70 #define LDAP_ROOT_DSE                           ""
71 #define LDAP_NO_ATTRS                           "1.1"
72 #define LDAP_ALL_USER_ATTRIBUTES        "*"
73 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
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 /* deprecated */
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 #define LDAP_OPT_MATCHED_DN                     0x0033
101
102 /* 0x34 - 0x0fff not defined by current draft */
103
104 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000  /* to 0x7FFF inclusive */
105
106 /* private and experimental options */
107 /* OpenLDAP specific options */
108 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
109 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
110 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
111 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
112 #define LDAP_OPT_URI                            0x5006
113 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
114
115 /* OpenLDAP TLS options */
116 #define LDAP_OPT_X_TLS                          0x6000
117 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
118 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
119 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
120 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
121 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
122 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
123 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
124 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
125 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
126 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
127
128 #define LDAP_OPT_X_TLS_NEVER            0
129 #define LDAP_OPT_X_TLS_HARD             1
130 #define LDAP_OPT_X_TLS_DEMAND           2
131 #define LDAP_OPT_X_TLS_ALLOW            3
132 #define LDAP_OPT_X_TLS_TRY              4
133
134 /* OpenLDAP SASL options */
135 #define LDAP_OPT_X_SASL_MECH                    0x6100
136 #define LDAP_OPT_X_SASL_REALM                   0x6101
137 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
138 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
139 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
140 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
141 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
142 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
143 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
144 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
145
146 /* on/off values */
147 #define LDAP_OPT_ON             ((void *) 1)
148 #define LDAP_OPT_OFF    ((void *) 0)
149
150 /*
151  * ldap_get_option() and ldap_set_option() return values.
152  * As later versions may return other values indicating
153  * failure, current applications should only compare returned
154  * value against LDAP_OPT_SUCCESS.
155  */
156 #define LDAP_OPT_SUCCESS        0
157 #define LDAP_OPT_ERROR          (-1)
158
159 #define LDAP_API_INFO_VERSION   (1)
160 typedef struct ldapapiinfo {
161         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
162         int             ldapai_api_version;                     /* revision of API supported */
163         int             ldapai_protocol_version;        /* highest LDAP version supported */
164         char    **ldapai_extensions;            /* names of API extensions */
165         char    *ldapai_vendor_name;            /* name of supplier */
166         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
167 } LDAPAPIInfo;
168
169 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
170 typedef struct ldap_apifeature_info {
171         int             ldapaif_info_version; /* version of this struct (1) */
172         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
173         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
174 } LDAPAPIFeatureInfo;
175
176 typedef struct ldapcontrol {
177         char *                  ldctl_oid;
178         struct berval   ldctl_value;
179         char                    ldctl_iscritical;
180 } LDAPControl;
181
182 /* LDAP Controls */
183 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
184 #define LDAP_CONTROL_SUBENTRIES         "1.3.6.1.4.1.4203.1.10.1"
185 #define LDAP_CONTROL_NOOP                       "1.3.6.1.4.1.4203.1.10.2"
186 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"
187 #define LDAP_CONTROL_PROXY_AUTHZ        "2.16.840.1.113730.3.4.18"
188
189 #if 0
190 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
191 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
192 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
193 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
194 #endif
195
196 #ifdef LDAP_DEVEL
197 #define LDAP_CONTROL_PAGEDRESULTS       "1.2.840.113556.1.4.319"
198 #endif
199
200 #ifdef LDAP_DEVEL
201 #define LDAP_CLIENT_UPDATE 1
202 #define LDAP_SYNC 2
203 #endif
204
205 #ifdef LDAP_CLIENT_UPDATE
206 #define LDAP_CONTROL_CLIENT_UPDATE              "1.3.6.1.4.1.4203.666.5.3"
207 #define LDAP_CONTROL_ENTRY_UPDATE               "1.3.6.1.4.1.4203.666.5.4"
208 #define LDAP_CONTROL_CLIENT_UPDATE_DONE         "1.3.6.1.4.1.4203.666.5.5"
209 #define LDAP_LCUP_COOKIE_OID                    "1.3.6.1.4.1.4203.666.10.1"
210 #endif
211
212 #ifdef LDAP_SYNC
213 #define LDAP_CONTROL_SYNC                       "1.3.6.1.4.1.4203.666.5.6"
214 #define LDAP_CONTROL_SYNC_STATE                 "1.3.6.1.4.1.4203.666.5.7"
215 #define LDAP_CONTROL_SYNC_DONE                  "1.3.6.1.4.1.4203.666.5.8"
216 #define LDAP_SYNC_INFO                          "1.3.6.1.4.1.4203.666.10.2"
217
218 #define LDAP_SYNC_REFRESH_DONE          0
219 #define LDAP_SYNC_NEW_COOKIE            1
220
221 #define LDAP_SYNC_PRESENT               0
222 #define LDAP_SYNC_ADD                   1
223 #define LDAP_SYNC_MODIFY                2
224 #define LDAP_SYNC_DELETE                3
225 #endif
226
227 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
228 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
229 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
230 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
231
232 #ifdef LDAP_DEVEL
233 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
234 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
235 #endif
236
237 /* LDAP Unsolicited Notifications */
238 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
239 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
240
241 /* LDAP Extended Operations */
242 #define LDAP_EXOP_START_TLS     "1.3.6.1.4.1.1466.20037"
243
244 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
245 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
246 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
247 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
248 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
249
250 #ifdef LDAP_DEVEL
251 #define LDAP_EXOP_X_CANCEL              "1.3.6.1.4.1.4203.666.6.3"
252 #endif
253 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
254
255 /* LDAP Features */
256 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1"  /* + */
257 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
258 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
259 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
260 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
261
262 /*
263  * specific LDAP instantiations of BER types we know about
264  */
265
266 /* Overview of LBER tag construction
267  *
268  *      Bits
269  *      ______
270  *      8 7 | CLASS
271  *      0 0 = UNIVERSAL
272  *      0 1 = APPLICATION
273  *      1 0 = CONTEXT-SPECIFIC
274  *      1 1 = PRIVATE
275  *              _____
276  *              | 6 | DATA-TYPE
277  *                0 = PRIMITIVE
278  *                1 = CONSTRUCTED
279  *                      ___________
280  *                      | 5 ... 1 | TAG-NUMBER
281  */
282
283 /* general stuff */
284 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
285 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
286
287 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
288 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
289
290 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
291 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
292
293 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
294
295 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
296 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
297 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
298 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
299
300 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
301
302 #ifdef LDAP_CLIENT_UPDATE
303 #define LDAP_TAG_INTERVAL       ((ber_tag_t) 0x02U)     /* integer */
304 #define LDAP_LCUP_TAG_COOKIE    ((ber_tag_t) 0x30U)     /* sequence */
305 #endif
306
307 #ifdef LDAP_SYNC
308 #define LDAP_SYNC_TAG_COOKIE    ((ber_tag_t) 0x04U)     /* octet string */
309 #endif
310
311
312 /* possible operations a client can invoke */
313 #define LDAP_REQ_BIND                   ((ber_tag_t) 0x60U)     /* application + constructed */
314 #define LDAP_REQ_UNBIND                 ((ber_tag_t) 0x42U)     /* application + primitive   */
315 #define LDAP_REQ_SEARCH                 ((ber_tag_t) 0x63U)     /* application + constructed */
316 #define LDAP_REQ_MODIFY                 ((ber_tag_t) 0x66U)     /* application + constructed */
317 #define LDAP_REQ_ADD                    ((ber_tag_t) 0x68U)     /* application + constructed */
318 #define LDAP_REQ_DELETE                 ((ber_tag_t) 0x4aU)     /* application + primitive   */
319 #define LDAP_REQ_MODDN                  ((ber_tag_t) 0x6cU)     /* application + constructed */
320 #define LDAP_REQ_MODRDN                 LDAP_REQ_MODDN
321 #define LDAP_REQ_RENAME                 LDAP_REQ_MODDN
322 #define LDAP_REQ_COMPARE                ((ber_tag_t) 0x6eU)     /* application + constructed */
323 #define LDAP_REQ_ABANDON                ((ber_tag_t) 0x50U)     /* application + primitive   */
324 #define LDAP_REQ_EXTENDED               ((ber_tag_t) 0x77U)     /* application + constructed */
325
326 /* possible result types a server can return */
327 #define LDAP_RES_BIND                   ((ber_tag_t) 0x61U)     /* application + constructed */
328 #define LDAP_RES_SEARCH_ENTRY           ((ber_tag_t) 0x64U)     /* application + constructed */
329 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
330 #define LDAP_RES_SEARCH_RESULT          ((ber_tag_t) 0x65U)     /* application + constructed */
331 #define LDAP_RES_MODIFY                 ((ber_tag_t) 0x67U)     /* application + constructed */
332 #define LDAP_RES_ADD                    ((ber_tag_t) 0x69U)     /* application + constructed */
333 #define LDAP_RES_DELETE                 ((ber_tag_t) 0x6bU)     /* application + constructed */
334 #define LDAP_RES_MODDN                  ((ber_tag_t) 0x6dU)     /* application + constructed */
335 #define LDAP_RES_MODRDN                 LDAP_RES_MODDN  /* application + constructed */
336 #define LDAP_RES_RENAME                 LDAP_RES_MODDN  /* application + constructed */
337 #define LDAP_RES_COMPARE                ((ber_tag_t) 0x6fU)     /* application + constructed */
338 #define LDAP_RES_EXTENDED               ((ber_tag_t) 0x78U)     /* V3: application + constructed */
339 #define LDAP_RES_EXTENDED_PARTIAL       ((ber_tag_t) 0x79U)     /* V3+: application + constructed */
340 #ifdef LDAP_DEVEL
341 #define LDAP_RES_INTERMEDIATE_RESP      ((ber_tag_t) 0x7aU)
342 #endif
343
344 #define LDAP_RES_ANY                    (-1)
345 #define LDAP_RES_UNSOLICITED    (0)
346
347
348 /* sasl methods */
349 #define LDAP_SASL_SIMPLE                ((char*)0)
350 #define LDAP_SASL_NULL                  ("")
351
352
353 /* authentication methods available */
354 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
355 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
356 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + constructed */
357 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
358 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
359 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
360
361
362 /* filter types */
363 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
364 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
365 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
366 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
367 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
368 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
369 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
370 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
371 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
372 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
373
374 /* extended filter component types */
375 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
376 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
377 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
378 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
379
380 /* substring filter component types */
381 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
382 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
383 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
384
385 /* search scopes */
386 #define LDAP_SCOPE_DEFAULT      ((ber_int_t) -1)
387 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
388 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
389 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
390
391 /* substring filter component types */
392 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
393 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
394 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
395
396 /*
397  * possible error codes we can return
398  */
399
400 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
401
402 #define LDAP_SUCCESS                    0x00
403 #define LDAP_OPERATIONS_ERROR           0x01
404 #define LDAP_PROTOCOL_ERROR             0x02
405 #define LDAP_TIMELIMIT_EXCEEDED         0x03
406 #define LDAP_SIZELIMIT_EXCEEDED         0x04
407 #define LDAP_COMPARE_FALSE              0x05
408 #define LDAP_COMPARE_TRUE               0x06
409 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
410 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
411 #define LDAP_STRONG_AUTH_REQUIRED       0x08
412 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
413
414 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
415 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
416 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
417 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
418 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
419
420 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
421
422 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
423 #define LDAP_UNDEFINED_TYPE             0x11
424 #define LDAP_INAPPROPRIATE_MATCHING     0x12
425 #define LDAP_CONSTRAINT_VIOLATION       0x13
426 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
427 #define LDAP_INVALID_SYNTAX             0x15
428
429 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
430
431 #define LDAP_NO_SUCH_OBJECT             0x20
432 #define LDAP_ALIAS_PROBLEM              0x21
433 #define LDAP_INVALID_DN_SYNTAX          0x22
434 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
435 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
436
437 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
438
439 #define LDAP_PROXY_AUTHZ_FAILURE        0x2F /* LDAPv3 proxy authorization */
440 #define LDAP_INAPPROPRIATE_AUTH         0x30
441 #define LDAP_INVALID_CREDENTIALS        0x31
442 #define LDAP_INSUFFICIENT_ACCESS        0x32
443
444 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
445
446 #define LDAP_BUSY                       0x33
447 #define LDAP_UNAVAILABLE                0x34
448 #define LDAP_UNWILLING_TO_PERFORM       0x35
449 #define LDAP_LOOP_DETECT                0x36
450
451 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
452
453 #define LDAP_NAMING_VIOLATION           0x40
454 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
455 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
456 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
457 #define LDAP_ALREADY_EXISTS             0x44
458 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
459 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
460 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
461
462 #define LDAP_OTHER                      0x50
463
464 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0x61) /* 81-97 */
465 #define LDAP_API_RESULT(n)              (((n) == LDAP_SUCCESS) || \
466                                                                         LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
467
468 /* reserved for APIs */
469 #define LDAP_SERVER_DOWN                0x51
470 #define LDAP_LOCAL_ERROR                0x52
471 #define LDAP_ENCODING_ERROR             0x53
472 #define LDAP_DECODING_ERROR             0x54
473 #define LDAP_TIMEOUT                    0x55
474 #define LDAP_AUTH_UNKNOWN               0x56
475 #define LDAP_FILTER_ERROR               0x57
476 #define LDAP_USER_CANCELLED             0x58
477 #define LDAP_PARAM_ERROR                0x59
478 #define LDAP_NO_MEMORY                  0x5a
479
480 /* used but not reserved for APIs */
481 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
482 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
483 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
484 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
485 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
486 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
487 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
488
489 #ifdef LDAP_CLIENT_UPDATE
490 /* resultCode for LCUP */
491 #define LDAP_CUP_RESOURCES_EXHAUSTED    0x100
492 #define LDAP_CUP_SECURITY_VIOLATION             0x101
493 #define LDAP_CUP_INVALID_COOKIE                 0x102
494 #define LDAP_CUP_UNSUPPORTED_SCHEME             0x103
495 #define LDAP_CUP_CLIENT_DISCONNECT              0x104
496 #define LDAP_CUP_RELOAD_REQUIRED                0x105
497 #endif
498
499 #ifdef LDAP_EXOP_X_CANCEL
500 /* resultCode for Cancel Response */
501 #define LDAP_CANCELLED                                  0x110
502 #define LDAP_NO_SUCH_OPERATION                  0x111
503 #define LDAP_TOO_LATE                                   0x112
504 #define LDAP_CANNOT_CANCEL                              0x113
505
506 #define LDAP_CANCEL_NONE                                0x00
507 #define LDAP_CANCEL_REQ                                 0x01
508 #define LDAP_CANCEL_ACK                                 0x02
509 #define LDAP_CANCEL_DONE                                0x03
510 #endif
511
512 #ifdef LDAP_CLIENT_UPDATE
513 /* LCUP update type */
514 #define LDAP_CUP_NONE                                   0x00
515 #define LDAP_CUP_SYNC_ONLY                              0x01
516 #define LDAP_CUP_PERSIST_ONLY                   0x02
517 #define LDAP_CUP_SYNC_AND_PERSIST               0x03
518
519 /* LCUP default cookie interval */
520 #define LDAP_CUP_DEFAULT_SEND_COOKIE_INTERVAL   0x01
521 #endif /* LDAP_CLIENT_UPDATE */
522
523 /* LDAP SYNC request type */
524 #ifdef LDAP_SYNC
525 #define LDAP_SYNC_NONE                                  0x00
526 #define LDAP_SYNC_REFRESH_ONLY                  0x01
527 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
528 #endif
529
530 /*
531  * This structure represents both ldap messages and ldap responses.
532  * These are really the same, except in the case of search responses,
533  * where a response has multiple messages.
534  */
535
536 typedef struct ldapmsg LDAPMessage;
537
538 /* for modifications */
539 typedef struct ldapmod {
540         int             mod_op;
541
542 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
543 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
544 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
545 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
546 /* IMPORTANT: do not use code 0x1000 (or above),
547  * it is used internally by the backends!
548  * (see ldap/servers/slapd/slap.h)
549  */
550
551         char            *mod_type;
552         union mod_vals_u {
553                 char            **modv_strvals;
554                 struct berval   **modv_bvals;
555         } mod_vals;
556 #define mod_values      mod_vals.modv_strvals
557 #define mod_bvalues     mod_vals.modv_bvals
558 } LDAPMod;
559
560 /*
561  * structure representing an ldap session which can
562  * encompass connections to multiple servers (in the
563  * face of referrals).
564  */
565 typedef struct ldap LDAP;
566
567 #define LDAP_DEREF_NEVER        0x00
568 #define LDAP_DEREF_SEARCHING    0x01
569 #define LDAP_DEREF_FINDING      0x02
570 #define LDAP_DEREF_ALWAYS       0x03
571
572 #define LDAP_NO_LIMIT           0
573
574 /* how many messages to retrieve results for */
575 #define LDAP_MSG_ONE            0x00
576 #define LDAP_MSG_ALL            0x01
577 #define LDAP_MSG_RECEIVED       0x02
578
579 /*
580  * types for ldap URL handling
581  */
582 typedef struct ldap_url_desc {
583         struct ldap_url_desc *lud_next;
584         char    *lud_scheme;
585         char    *lud_host;
586         int             lud_port;
587         char    *lud_dn;
588         char    **lud_attrs;
589         int             lud_scope;
590         char    *lud_filter;
591         char    **lud_exts;
592         int             lud_crit_exts;
593 } LDAPURLDesc;
594
595 #define LDAP_URL_SUCCESS                0x00    /* Success */
596 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
597 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
598
599 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
600 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
601 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
602 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
603 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
604 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
605 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
606 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
607
608 /*
609  * The API draft spec says we should declare (or cause to be declared)
610  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
611  */
612 struct timeval;
613
614 /*
615  * in options.c:
616  */
617 LDAP_F( int )
618 ldap_get_option LDAP_P((
619         LDAP *ld,
620         int option,
621         void *outvalue));
622
623 LDAP_F( int )
624 ldap_set_option LDAP_P((
625         LDAP *ld,
626         int option,
627         LDAP_CONST void *invalue));
628
629 /* V3 REBIND Function Callback Prototype */
630 typedef int (LDAP_REBIND_PROC) LDAP_P((
631         LDAP *ld, LDAP_CONST char *url,
632         ber_tag_t request, ber_int_t msgid,
633         void *params ));
634
635 LDAP_F( int )
636 ldap_set_rebind_proc LDAP_P((
637         LDAP *ld,
638         LDAP_REBIND_PROC *rebind_proc,
639         void *params ));
640
641 /*
642  * in controls.c:
643  */
644 LDAP_F( int )
645 ldap_create_control LDAP_P((
646         LDAP_CONST char *requestOID,
647         BerElement *ber,
648         int iscritical,
649         LDAPControl **ctrlp ));
650
651 LDAP_F( void )
652 ldap_control_free LDAP_P((
653         LDAPControl *ctrl ));
654
655 LDAP_F( void )
656 ldap_controls_free LDAP_P((
657         LDAPControl **ctrls ));
658
659 /*
660  * in dnssrv.c:
661  */
662 LDAP_F( int )
663 ldap_domain2dn LDAP_P((
664         LDAP_CONST char* domain,
665         char** dn ));
666
667 LDAP_F( int )
668 ldap_dn2domain LDAP_P((
669         LDAP_CONST char* dn,
670         char** domain ));
671
672 LDAP_F( int )
673 ldap_domain2hostlist LDAP_P((
674         LDAP_CONST char *domain,
675         char** hostlist ));
676
677 /*
678  * in extended.c:
679  */
680 LDAP_F( int )
681 ldap_extended_operation LDAP_P((
682         LDAP                    *ld,
683         LDAP_CONST char *reqoid,
684         struct berval   *reqdata,
685         LDAPControl             **serverctrls,
686         LDAPControl             **clientctrls,
687         int                             *msgidp ));
688
689 LDAP_F( int )
690 ldap_extended_operation_s LDAP_P((
691         LDAP                    *ld,
692         LDAP_CONST char *reqoid,
693         struct berval   *reqdata,
694         LDAPControl             **serverctrls,
695         LDAPControl             **clientctrls,
696         char                    **retoidp,
697         struct berval   **retdatap ));
698
699 LDAP_F( int )
700 ldap_parse_extended_result LDAP_P((
701         LDAP                    *ld,
702         LDAPMessage             *res,
703         char                    **retoidp,
704         struct berval   **retdatap,
705         int                             freeit ));
706
707 LDAP_F( int )
708 ldap_parse_extended_partial LDAP_P((
709         LDAP                    *ld,
710         LDAPMessage             *res,
711         char                    **retoidp,
712         struct berval   **retdatap,
713         LDAPControl             ***serverctrls,
714         int                             freeit ));
715
716 LDAP_F( int )
717 ldap_parse_intermediate_resp_result LDAP_P((
718         LDAP                    *ld,
719         LDAPMessage             *res,
720         char                    **retoidp,
721         struct berval   **retdatap,
722         int                             freeit ));
723
724 /*
725  * in abandon.c:
726  */
727 LDAP_F( int )
728 ldap_abandon_ext LDAP_P((
729         LDAP                    *ld,
730         int                             msgid,
731         LDAPControl             **serverctrls,
732         LDAPControl             **clientctrls ));
733
734 LDAP_F( int )
735 ldap_abandon LDAP_P((   /* deprecated */
736         LDAP *ld,
737         int msgid ));
738
739
740 /*
741  * in add.c:
742  */
743 LDAP_F( int )
744 ldap_add_ext LDAP_P((
745         LDAP                    *ld,
746         LDAP_CONST char *dn,
747         LDAPMod                 **attrs,
748         LDAPControl             **serverctrls,
749         LDAPControl             **clientctrls,
750         int                     *msgidp ));
751
752 LDAP_F( int )
753 ldap_add_ext_s LDAP_P((
754         LDAP                    *ld,
755         LDAP_CONST char *dn,
756         LDAPMod                 **attrs,
757         LDAPControl             **serverctrls,
758         LDAPControl             **clientctrls ));
759
760 LDAP_F( int )
761 ldap_add LDAP_P((       /* deprecated */
762         LDAP *ld,
763         LDAP_CONST char *dn,
764         LDAPMod **attrs ));
765
766 LDAP_F( int )
767 ldap_add_s LDAP_P((     /* deprecated */
768         LDAP *ld,
769         LDAP_CONST char *dn,
770         LDAPMod **attrs ));
771
772
773 /*
774  * in sasl.c:
775  */
776 LDAP_F( int )
777 ldap_sasl_bind LDAP_P((
778         LDAP                    *ld,
779         LDAP_CONST char *dn,
780         LDAP_CONST char *mechanism,
781         struct berval   *cred,
782         LDAPControl             **serverctrls,
783         LDAPControl             **clientctrls,
784         int                             *msgidp ));
785
786 /* Interaction flags (should be passed about in a control)
787  *  Automatic (default): use defaults, prompt otherwise
788  *  Interactive: prompt always
789  *  Quiet: never prompt
790  */
791 #define LDAP_SASL_AUTOMATIC             0U
792 #define LDAP_SASL_INTERACTIVE   1U
793 #define LDAP_SASL_QUIET                 2U
794
795 /*
796  * V3 SASL Interaction Function Callback Prototype
797  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
798  *  should likely passed in a control (and provided controls)
799  */
800 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
801         LDAP *ld, unsigned flags, void* defaults, void *interact ));
802
803 LDAP_F( int )
804 ldap_sasl_interactive_bind_s LDAP_P((
805         LDAP *ld,
806         LDAP_CONST char *dn, /* usually NULL */
807         LDAP_CONST char *saslMechanism,
808         LDAPControl **serverControls,
809         LDAPControl **clientControls,
810
811         /* should be client controls */
812         unsigned flags,
813         LDAP_SASL_INTERACT_PROC *proc,
814         void *defaults ));
815
816 LDAP_F( int )
817 ldap_sasl_bind_s LDAP_P((
818         LDAP                    *ld,
819         LDAP_CONST char *dn,
820         LDAP_CONST char *mechanism,
821         struct berval   *cred,
822         LDAPControl             **serverctrls,
823         LDAPControl             **clientctrls,
824         struct berval   **servercredp ));
825
826 LDAP_F( int )
827 ldap_parse_sasl_bind_result LDAP_P((
828         LDAP                    *ld,
829         LDAPMessage             *res,
830         struct berval   **servercredp,
831         int                             freeit ));
832
833 /*
834  * in bind.c:
835  *      (deprecated)
836  */
837 LDAP_F( int )
838 ldap_bind LDAP_P((      /* deprecated */
839         LDAP *ld,
840         LDAP_CONST char *who,
841         LDAP_CONST char *passwd,
842         int authmethod ));
843
844 LDAP_F( int )
845 ldap_bind_s LDAP_P((    /* deprecated */
846         LDAP *ld,
847         LDAP_CONST char *who,
848         LDAP_CONST char *cred,
849         int authmethod ));
850
851 /*
852  * in sbind.c:
853  */
854 LDAP_F( int )
855 ldap_simple_bind LDAP_P((
856         LDAP *ld,
857         LDAP_CONST char *who,
858         LDAP_CONST char *passwd ));
859
860 LDAP_F( int )
861 ldap_simple_bind_s LDAP_P((
862         LDAP *ld,
863         LDAP_CONST char *who,
864         LDAP_CONST char *passwd ));
865
866
867 /*
868  * in kbind.c:
869  *      (deprecated)
870  */
871 LDAP_F( int )
872 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
873         LDAP *ld,
874         LDAP_CONST char *who ));
875
876 LDAP_F( int )
877 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
878         LDAP *ld,
879         LDAP_CONST char *who ));
880
881 LDAP_F( int )
882 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
883         LDAP *ld,
884         LDAP_CONST char *who ));
885
886 LDAP_F( int )
887 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
888         LDAP *ld,
889         LDAP_CONST char *who ));
890
891 LDAP_F( int )
892 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
893         LDAP *ld,
894         LDAP_CONST char *who ));
895
896 /*
897  * in cache.c
898  * (deprecated)
899  */
900 LDAP_F( int )
901 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
902
903 LDAP_F( void )
904 ldap_disable_cache LDAP_P(( LDAP *ld ));
905
906 LDAP_F( void )
907 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
908
909 LDAP_F( void )
910 ldap_destroy_cache LDAP_P(( LDAP *ld ));
911
912 LDAP_F( void )
913 ldap_flush_cache LDAP_P(( LDAP *ld ));
914
915 LDAP_F( void )
916 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
917
918 LDAP_F( void )
919 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
920
921
922 /*
923  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
924  */
925
926 LDAP_F( int )
927 ldap_cancel LDAP_P(( LDAP *ld,
928         int cancelid,
929         LDAPControl             **sctrls,
930         LDAPControl             **cctrls,
931         int                             *msgidp ));
932
933 LDAP_F( int )
934 ldap_cancel_s LDAP_P((
935         LDAP *ld,
936         int cancelid,
937         LDAPControl **sctrl,
938         LDAPControl **cctrl ));
939
940 /*
941  * in compare.c:
942  */
943 LDAP_F( int )
944 ldap_compare_ext LDAP_P((
945         LDAP                    *ld,
946         LDAP_CONST char *dn,
947         LDAP_CONST char *attr,
948         struct berval   *bvalue,
949         LDAPControl             **serverctrls,
950         LDAPControl             **clientctrls,
951         int                     *msgidp ));
952
953 LDAP_F( int )
954 ldap_compare_ext_s LDAP_P((
955         LDAP                    *ld,
956         LDAP_CONST char *dn,
957         LDAP_CONST char *attr,
958         struct berval   *bvalue,
959         LDAPControl             **serverctrls,
960         LDAPControl             **clientctrls ));
961
962 LDAP_F( int )
963 ldap_compare LDAP_P((   /* deprecated */
964         LDAP *ld,
965         LDAP_CONST char *dn,
966         LDAP_CONST char *attr,
967         LDAP_CONST char *value ));
968
969 LDAP_F( int )
970 ldap_compare_s LDAP_P(( /* deprecated */
971         LDAP *ld,
972         LDAP_CONST char *dn,
973         LDAP_CONST char *attr,
974         LDAP_CONST char *value ));
975
976
977 /*
978  * in delete.c:
979  */
980 LDAP_F( int )
981 ldap_delete_ext LDAP_P((
982         LDAP                    *ld,
983         LDAP_CONST char *dn,
984         LDAPControl             **serverctrls,
985         LDAPControl             **clientctrls,
986         int                     *msgidp ));
987
988 LDAP_F( int )
989 ldap_delete_ext_s LDAP_P((
990         LDAP                    *ld,
991         LDAP_CONST char *dn,
992         LDAPControl             **serverctrls,
993         LDAPControl             **clientctrls ));
994
995 LDAP_F( int )
996 ldap_delete LDAP_P((    /* deprecated */
997         LDAP *ld,
998         LDAP_CONST char *dn ));
999
1000 LDAP_F( int )
1001 ldap_delete_s LDAP_P((  /* deprecated */
1002         LDAP *ld,
1003         LDAP_CONST char *dn ));
1004
1005
1006 /*
1007  * in error.c:
1008  */
1009 LDAP_F( int )
1010 ldap_parse_result LDAP_P((
1011         LDAP                    *ld,
1012         LDAPMessage             *res,
1013         int                             *errcodep,
1014         char                    **matcheddnp,
1015         char                    **errmsgp,
1016         char                    ***referralsp,
1017         LDAPControl             ***serverctrls,
1018         int                             freeit ));
1019
1020 LDAP_F( char * )
1021 ldap_err2string LDAP_P((
1022         int err ));
1023
1024 LDAP_F( int )
1025 ldap_result2error LDAP_P((      /* deprecated */
1026         LDAP *ld,
1027         LDAPMessage *r,
1028         int freeit ));
1029
1030 LDAP_F( void )
1031 ldap_perror LDAP_P((    /* deprecated */
1032         LDAP *ld,
1033         LDAP_CONST char *s ));
1034
1035
1036 /*
1037  * in modify.c:
1038  */
1039 LDAP_F( int )
1040 ldap_modify_ext LDAP_P((
1041         LDAP                    *ld,
1042         LDAP_CONST char *dn,
1043         LDAPMod                 **mods,
1044         LDAPControl             **serverctrls,
1045         LDAPControl             **clientctrls,
1046         int                     *msgidp ));
1047
1048 LDAP_F( int )
1049 ldap_modify_ext_s LDAP_P((
1050         LDAP                    *ld,
1051         LDAP_CONST char *dn,
1052         LDAPMod                 **mods,
1053         LDAPControl             **serverctrls,
1054         LDAPControl             **clientctrls ));
1055
1056 LDAP_F( int )
1057 ldap_modify LDAP_P((    /* deprecated */
1058         LDAP *ld,
1059         LDAP_CONST char *dn,
1060         LDAPMod **mods ));
1061
1062 LDAP_F( int )
1063 ldap_modify_s LDAP_P((  /* deprecated */
1064         LDAP *ld,
1065         LDAP_CONST char *dn,
1066         LDAPMod **mods ));
1067
1068
1069 /*
1070  * in modrdn.c:
1071  */
1072 LDAP_F( int )
1073 ldap_rename LDAP_P((
1074         LDAP *ld,
1075         LDAP_CONST char *dn,
1076         LDAP_CONST char *newrdn,
1077         LDAP_CONST char *newSuperior,
1078         int deleteoldrdn,
1079         LDAPControl **sctrls,
1080         LDAPControl **cctrls,
1081         int *msgidp ));
1082
1083 LDAP_F( int )
1084 ldap_rename_s LDAP_P((
1085         LDAP *ld,
1086         LDAP_CONST char *dn,
1087         LDAP_CONST char *newrdn,
1088         LDAP_CONST char *newSuperior,
1089         int deleteoldrdn,
1090         LDAPControl **sctrls,
1091         LDAPControl **cctrls ));
1092
1093 LDAP_F( int )
1094 ldap_rename2 LDAP_P((   /* deprecated */
1095         LDAP *ld,
1096         LDAP_CONST char *dn,
1097         LDAP_CONST char *newrdn,
1098         LDAP_CONST char *newSuperior,
1099         int deleteoldrdn ));
1100
1101 LDAP_F( int )
1102 ldap_rename2_s LDAP_P(( /* deprecated */
1103         LDAP *ld,
1104         LDAP_CONST char *dn,
1105         LDAP_CONST char *newrdn,
1106         LDAP_CONST char *newSuperior,
1107         int deleteoldrdn ));
1108
1109 LDAP_F( int )
1110 ldap_modrdn LDAP_P((    /* deprecated */
1111         LDAP *ld,
1112         LDAP_CONST char *dn,
1113         LDAP_CONST char *newrdn ));
1114
1115 LDAP_F( int )
1116 ldap_modrdn_s LDAP_P((  /* deprecated */
1117         LDAP *ld,
1118         LDAP_CONST char *dn,
1119         LDAP_CONST char *newrdn ));
1120
1121 LDAP_F( int )
1122 ldap_modrdn2 LDAP_P((   /* deprecated */
1123         LDAP *ld,
1124         LDAP_CONST char *dn,
1125         LDAP_CONST char *newrdn,
1126         int deleteoldrdn ));
1127
1128 LDAP_F( int )
1129 ldap_modrdn2_s LDAP_P(( /* deprecated */
1130         LDAP *ld,
1131         LDAP_CONST char *dn,
1132         LDAP_CONST char *newrdn,
1133         int deleteoldrdn));
1134
1135
1136 /*
1137  * in open.c:
1138  */
1139 LDAP_F( LDAP * )
1140 ldap_init LDAP_P((
1141         LDAP_CONST char *host,
1142         int port ));
1143
1144 LDAP_F( LDAP * )
1145 ldap_open LDAP_P((      /* deprecated */
1146         LDAP_CONST char *host,
1147         int port ));
1148
1149 LDAP_F( int )
1150 ldap_create LDAP_P((
1151         LDAP **ldp ));
1152
1153 LDAP_F( int )
1154 ldap_initialize LDAP_P((
1155         LDAP **ldp,
1156         LDAP_CONST char *url ));
1157
1158 LDAP_F( int )
1159 ldap_start_tls_s LDAP_P((
1160         LDAP *ld,
1161         LDAPControl **serverctrls,
1162         LDAPControl **clientctrls ));
1163
1164 /*
1165  * in messages.c:
1166  */
1167 LDAP_F( LDAPMessage * )
1168 ldap_first_message LDAP_P((
1169         LDAP *ld,
1170         LDAPMessage *chain ));
1171
1172 LDAP_F( LDAPMessage * )
1173 ldap_next_message LDAP_P((
1174         LDAP *ld,
1175         LDAPMessage *msg ));
1176
1177 LDAP_F( int )
1178 ldap_count_messages LDAP_P((
1179         LDAP *ld,
1180         LDAPMessage *chain ));
1181
1182
1183 /*
1184  * in references.c:
1185  */
1186 LDAP_F( LDAPMessage * )
1187 ldap_first_reference LDAP_P((
1188         LDAP *ld,
1189         LDAPMessage *chain ));
1190
1191 LDAP_F( LDAPMessage * )
1192 ldap_next_reference LDAP_P((
1193         LDAP *ld,
1194         LDAPMessage *ref ));
1195
1196 LDAP_F( int )
1197 ldap_count_references LDAP_P((
1198         LDAP *ld,
1199         LDAPMessage *chain ));
1200
1201 LDAP_F( int )
1202 ldap_parse_reference LDAP_P((
1203         LDAP                    *ld,
1204         LDAPMessage             *ref,
1205         char                    ***referralsp,
1206         LDAPControl             ***serverctrls,
1207         int                             freeit));
1208
1209
1210 /*
1211  * in getentry.c:
1212  */
1213 LDAP_F( LDAPMessage * )
1214 ldap_first_entry LDAP_P((
1215         LDAP *ld,
1216         LDAPMessage *chain ));
1217
1218 LDAP_F( LDAPMessage * )
1219 ldap_next_entry LDAP_P((
1220         LDAP *ld,
1221         LDAPMessage *entry ));
1222
1223 LDAP_F( int )
1224 ldap_count_entries LDAP_P((
1225         LDAP *ld,
1226         LDAPMessage *chain ));
1227
1228 LDAP_F( int )
1229 ldap_get_entry_controls LDAP_P((
1230         LDAP                    *ld,
1231         LDAPMessage             *entry,
1232         LDAPControl             ***serverctrls));
1233
1234
1235 /*
1236  * in addentry.c
1237  */
1238 LDAP_F( LDAPMessage * )
1239 ldap_delete_result_entry LDAP_P((
1240         LDAPMessage **list,
1241         LDAPMessage *e ));
1242
1243 LDAP_F( void )
1244 ldap_add_result_entry LDAP_P((
1245         LDAPMessage **list,
1246         LDAPMessage *e ));
1247
1248
1249 /*
1250  * in getdn.c
1251  */
1252 LDAP_F( char * )
1253 ldap_get_dn LDAP_P((
1254         LDAP *ld,
1255         LDAPMessage *entry ));
1256
1257 typedef struct ldap_ava {
1258         struct berval la_attr;
1259         struct berval la_value;
1260         unsigned la_flags;
1261 #define LDAP_AVA_STRING                         0x0000U
1262 #define LDAP_AVA_BINARY                         0x0001U
1263 #define LDAP_AVA_NONPRINTABLE           0x0002U
1264
1265         void *la_private;
1266 } LDAPAVA;
1267
1268 typedef LDAPAVA** LDAPRDN;
1269 typedef LDAPRDN** LDAPDN;
1270
1271 /* DN formats */
1272 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1273 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1274 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1275 #define LDAP_DN_FORMAT_DCE                      0x0030U
1276 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1277 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1278 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1279 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1280
1281 /* DN flags */
1282 #define LDAP_DN_PRETTY                          0x0100U
1283 #define LDAP_DN_SKIP                            0x0200U
1284 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1285 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1286 #define LDAP_DN_PEDANTIC                        0xF000U
1287
1288 LDAP_F( void ) ldap_avafree LDAP_P(( LDAPAVA *ava ));
1289 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1290 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN *dn ));
1291
1292 LDAP_F( int )
1293 ldap_bv2dn LDAP_P(( 
1294         struct berval *bv, 
1295         LDAPDN **dn, 
1296         unsigned flags ));
1297
1298 LDAP_F( int )
1299 ldap_str2dn LDAP_P((
1300         LDAP_CONST char *str,
1301         LDAPDN **dn,
1302         unsigned flags ));
1303
1304 LDAP_F( int )
1305 ldap_dn2bv LDAP_P((
1306         LDAPDN *dn,
1307         struct berval *bv,
1308         unsigned flags ));
1309
1310 LDAP_F( int )
1311 ldap_dn2str LDAP_P((
1312         LDAPDN *dn,
1313         char **str,
1314         unsigned flags ));
1315
1316 LDAP_F( int )
1317 ldap_bv2rdn LDAP_P((
1318         struct berval *bv,
1319         LDAPRDN **rdn,
1320         char **next,
1321         unsigned flags ));
1322
1323 LDAP_F( int )
1324 ldap_str2rdn LDAP_P((
1325         LDAP_CONST char *str,
1326         LDAPRDN **rdn,
1327         char **next,
1328         unsigned flags ));
1329
1330 LDAP_F( int )
1331 ldap_rdn2bv LDAP_P((
1332         LDAPRDN *rdn,
1333         struct berval *bv,
1334         unsigned flags ));
1335
1336 LDAP_F( int )
1337 ldap_rdn2str LDAP_P((
1338         LDAPRDN *rdn,
1339         char **str,
1340         unsigned flags ));
1341
1342 LDAP_F( int )
1343 ldap_dn_normalize LDAP_P((
1344         LDAP_CONST char *in, unsigned iflags,
1345         char **out, unsigned oflags ));
1346
1347 LDAP_F( char * )
1348 ldap_dn2ufn LDAP_P(( /* deprecated */
1349         LDAP_CONST char *dn ));
1350
1351 LDAP_F( char ** )
1352 ldap_explode_dn LDAP_P(( /* deprecated */
1353         LDAP_CONST char *dn,
1354         int notypes ));
1355
1356 LDAP_F( char ** )
1357 ldap_explode_rdn LDAP_P(( /* deprecated */
1358         LDAP_CONST char *rdn,
1359         int notypes ));
1360
1361 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags ));
1362
1363 LDAP_F( int )
1364 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1365         LDAPDN_rewrite_func *func, unsigned flags ));
1366
1367 LDAP_F( char * )
1368 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1369
1370 LDAP_F( char * )
1371 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1372
1373 LDAP_F( char * )
1374 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1375
1376 LDAP_F( int )
1377 ldap_get_dn_ber LDAP_P((
1378         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1379
1380 LDAP_F( int )
1381 ldap_get_attribute_ber LDAP_P((
1382         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1383         struct berval **vals ));
1384
1385 /*
1386  * in getattr.c
1387  */
1388 LDAP_F( char * )
1389 ldap_first_attribute LDAP_P((
1390         LDAP *ld,
1391         LDAPMessage *entry,
1392         BerElement **ber ));
1393
1394 LDAP_F( char * )
1395 ldap_next_attribute LDAP_P((
1396         LDAP *ld,
1397         LDAPMessage *entry,
1398         BerElement *ber ));
1399
1400
1401 /*
1402  * in getvalues.c
1403  */
1404 LDAP_F( struct berval ** )
1405 ldap_get_values_len LDAP_P((
1406         LDAP *ld,
1407         LDAPMessage *entry,
1408         LDAP_CONST char *target ));
1409
1410 LDAP_F( int )
1411 ldap_count_values_len LDAP_P((
1412         struct berval **vals ));
1413
1414 LDAP_F( void )
1415 ldap_value_free_len LDAP_P((
1416         struct berval **vals ));
1417
1418 LDAP_F( char ** )
1419 ldap_get_values LDAP_P((        /* deprecated */
1420         LDAP *ld,
1421         LDAPMessage *entry,
1422         LDAP_CONST char *target ));
1423
1424 LDAP_F( int )
1425 ldap_count_values LDAP_P((      /* deprecated */
1426         char **vals ));
1427
1428 LDAP_F( void )
1429 ldap_value_free LDAP_P((        /* deprecated */
1430         char **vals ));
1431
1432 /*
1433  * in result.c:
1434  */
1435 LDAP_F( int )
1436 ldap_result LDAP_P((
1437         LDAP *ld,
1438         int msgid,
1439         int all,
1440         struct timeval *timeout,
1441         LDAPMessage **result ));
1442
1443 LDAP_F( int )
1444 ldap_msgtype LDAP_P((
1445         LDAPMessage *lm ));
1446
1447 LDAP_F( int )
1448 ldap_msgid   LDAP_P((
1449         LDAPMessage *lm ));
1450
1451 LDAP_F( int )
1452 ldap_msgfree LDAP_P((
1453         LDAPMessage *lm ));
1454
1455 LDAP_F( int )
1456 ldap_msgdelete LDAP_P((
1457         LDAP *ld,
1458         int msgid ));
1459
1460
1461 /*
1462  * in search.c:
1463  */
1464 LDAP_F( int )
1465 ldap_search_ext LDAP_P((
1466         LDAP                    *ld,
1467         LDAP_CONST char *base,
1468         int                             scope,
1469         LDAP_CONST char *filter,
1470         char                    **attrs,
1471         int                             attrsonly,
1472         LDAPControl             **serverctrls,
1473         LDAPControl             **clientctrls,
1474         struct timeval  *timeout,
1475         int                             sizelimit,
1476         int                             *msgidp ));
1477
1478 LDAP_F( int )
1479 ldap_search_ext_s LDAP_P((
1480         LDAP                    *ld,
1481         LDAP_CONST char *base,
1482         int                             scope,
1483         LDAP_CONST char *filter,
1484         char                    **attrs,
1485         int                             attrsonly,
1486         LDAPControl             **serverctrls,
1487         LDAPControl             **clientctrls,
1488         struct timeval  *timeout,
1489         int                             sizelimit,
1490         LDAPMessage             **res ));
1491
1492 LDAP_F( int )
1493 ldap_search LDAP_P((    /* deprecated */
1494         LDAP *ld,
1495         LDAP_CONST char *base,
1496         int scope,
1497         LDAP_CONST char *filter,
1498         char **attrs,
1499         int attrsonly ));
1500
1501 LDAP_F( int )
1502 ldap_search_s LDAP_P((  /* deprecated */
1503         LDAP *ld,
1504         LDAP_CONST char *base,
1505         int scope,
1506         LDAP_CONST char *filter,
1507         char **attrs,
1508         int attrsonly,
1509         LDAPMessage **res ));
1510
1511 LDAP_F( int )
1512 ldap_search_st LDAP_P(( /* deprecated */
1513         LDAP *ld,
1514         LDAP_CONST char *base,
1515         int scope,
1516         LDAP_CONST char *filter,
1517     char **attrs,
1518         int attrsonly,
1519         struct timeval *timeout,
1520         LDAPMessage **res ));
1521
1522 /*
1523  * in unbind.c
1524  */
1525 LDAP_F( int )
1526 ldap_unbind LDAP_P(( /* deprecated */
1527         LDAP *ld ));
1528
1529 LDAP_F( int )
1530 ldap_unbind_s LDAP_P(( /* deprecated */
1531         LDAP *ld ));
1532
1533 LDAP_F( int )
1534 ldap_unbind_ext LDAP_P((
1535         LDAP                    *ld,
1536         LDAPControl             **serverctrls,
1537         LDAPControl             **clientctrls));
1538
1539 LDAP_F( int )
1540 ldap_unbind_ext_s LDAP_P((
1541         LDAP                    *ld,
1542         LDAPControl             **serverctrls,
1543         LDAPControl             **clientctrls));
1544
1545 /*
1546  * in filter.c
1547  */
1548 LDAP_F( int )
1549 ldap_put_vrFilter LDAP_P((
1550         BerElement *ber,
1551         const char *vrf ));
1552
1553 /*
1554  * in free.c
1555  */
1556
1557 LDAP_F( void * )
1558 ldap_memalloc LDAP_P((
1559         ber_len_t s ));
1560
1561 LDAP_F( void * )
1562 ldap_memrealloc LDAP_P((
1563         void* p,
1564         ber_len_t s ));
1565
1566 LDAP_F( void * )
1567 ldap_memcalloc LDAP_P((
1568         ber_len_t n,
1569         ber_len_t s ));
1570
1571 LDAP_F( void )
1572 ldap_memfree LDAP_P((
1573         void* p ));
1574
1575 LDAP_F( void )
1576 ldap_memvfree LDAP_P((
1577         void** v ));
1578
1579 LDAP_F( char * )
1580 ldap_strdup LDAP_P((
1581         LDAP_CONST char * ));
1582
1583 LDAP_F( void )
1584 ldap_mods_free LDAP_P((
1585         LDAPMod **mods,
1586         int freemods ));
1587
1588
1589 /*
1590  * in sort.c
1591  *      (deprecated)
1592  */
1593 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1594         LDAP_CONST char *left,
1595         LDAP_CONST char *right ));
1596
1597 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1598         LDAP_CONST void *left,
1599         LDAP_CONST void *right ));
1600
1601 LDAP_F( int )   /* deprecated */
1602 ldap_sort_entries LDAP_P(( LDAP *ld,
1603         LDAPMessage **chain,
1604         LDAP_CONST char *attr,
1605         LDAP_SORT_AD_CMP_PROC *cmp ));
1606
1607 LDAP_F( int )   /* deprecated */
1608 ldap_sort_values LDAP_P((
1609         LDAP *ld,
1610         char **vals,
1611         LDAP_SORT_AV_CMP_PROC *cmp ));
1612
1613 LDAP_F( int ) /* deprecated */
1614 ldap_sort_strcasecmp LDAP_P((
1615         LDAP_CONST void *a,
1616         LDAP_CONST void *b ));
1617
1618
1619 /*
1620  * in url.c
1621  */
1622 LDAP_F( int )
1623 ldap_is_ldap_url LDAP_P((
1624         LDAP_CONST char *url ));
1625
1626 LDAP_F( int )
1627 ldap_is_ldaps_url LDAP_P((
1628         LDAP_CONST char *url ));
1629
1630 LDAP_F( int )
1631 ldap_is_ldapi_url LDAP_P((
1632         LDAP_CONST char *url ));
1633
1634 LDAP_F( int )
1635 ldap_url_parse LDAP_P((
1636         LDAP_CONST char *url,
1637         LDAPURLDesc **ludpp ));
1638
1639 LDAP_F( char * )
1640 ldap_url_desc2str LDAP_P((
1641         LDAPURLDesc *ludp ));
1642
1643 LDAP_F( void )
1644 ldap_free_urldesc LDAP_P((
1645         LDAPURLDesc *ludp ));
1646
1647 /*
1648  * in sortctrl.c
1649  */
1650 /*
1651  * structure for a sort-key
1652  */
1653 typedef struct ldapsortkey {
1654         char *  attributeType;
1655         char *  orderingRule;
1656         int     reverseOrder;
1657 } LDAPSortKey;
1658
1659 LDAP_F( int )
1660 ldap_create_sort_keylist LDAP_P((
1661         LDAPSortKey ***sortKeyList,
1662         char        *keyString ));
1663
1664 LDAP_F( void )
1665 ldap_free_sort_keylist LDAP_P((
1666         LDAPSortKey **sortkeylist ));
1667
1668 LDAP_F( int )
1669 ldap_create_sort_control LDAP_P((
1670         LDAP *ld,
1671         LDAPSortKey **keyList,
1672         int ctl_iscritical,
1673         LDAPControl **ctrlp ));
1674
1675 LDAP_F( int )
1676 ldap_parse_sort_control LDAP_P((
1677         LDAP           *ld,
1678         LDAPControl    **ctrlp,
1679         unsigned long  *result,
1680         char           **attribute ));
1681
1682
1683 /*
1684  * in vlvctrl.c
1685  */
1686
1687 /*
1688  * structure for virtual list.
1689  */
1690 typedef struct ldapvlvinfo {
1691         int             ldvlv_version;
1692     unsigned long   ldvlv_before_count;
1693     unsigned long   ldvlv_after_count;
1694     unsigned long   ldvlv_offset;
1695     unsigned long   ldvlv_count;
1696     struct berval  *ldvlv_attrvalue;
1697     struct berval  *ldvlv_context;
1698     void           *ldvlv_extradata;
1699 } LDAPVLVInfo;
1700
1701 LDAP_F( int )
1702 ldap_create_vlv_control LDAP_P((
1703         LDAP *ld,
1704         LDAPVLVInfo *ldvlistp,
1705         LDAPControl **ctrlp ));
1706
1707 LDAP_F( int )
1708 ldap_parse_vlv_control LDAP_P((
1709         LDAP          *ld,
1710         LDAPControl   **ctrls,
1711         unsigned long *target_posp,
1712         unsigned long *list_countp,
1713         struct berval **contextp,
1714         int           *errcodep ));
1715
1716 /*
1717  * LDAP Who Am I? (whoami.c)
1718  */
1719
1720 LDAP_F( int )
1721 ldap_parse_whoami LDAP_P((
1722         LDAP *ld,
1723         LDAPMessage *res,
1724         struct berval **authzid ));
1725
1726 LDAP_F( int )
1727 ldap_whoami LDAP_P(( LDAP *ld,
1728         LDAPControl             **sctrls,
1729         LDAPControl             **cctrls,
1730         int                             *msgidp ));
1731
1732 LDAP_F( int )
1733 ldap_whoami_s LDAP_P((
1734         LDAP *ld,
1735         struct berval **authzid,
1736         LDAPControl **sctrls,
1737         LDAPControl **cctrls ));
1738
1739 LDAP_END_DECL
1740 #endif /* _LDAP_H */