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