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