]> git.sur5r.net Git - openldap/blob - include/ldap.h
projects / openldap / blob
? search:


05468f43c82df654d5ae4a1aa1826b8ef4f2804d
[openldap] / include / ldap.h
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998-2002 The OpenLDAP Foundation, Redwood City, California, USA
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted only as authorized by the OpenLDAP
8  * Public License.  A copy of this license is available at
9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10  * top-level directory of the distribution.
11  */
12 /* Portions
13  * Copyright (c) 1990 Regents of the University of Michigan.
14  * All rights reserved.
15  *
16  * Redistribution and use in source and binary forms are permitted
17  * provided that this notice is preserved and that due credit is given
18  * to the University of Michigan at Ann Arbor. The name of the University
19  * may not be used to endorse or promote products derived from this
20  * software without specific prior written permission. This software
21  * is provided ``as is'' without express or implied warranty.
22  */
23
24 #ifndef _LDAP_H
25 #define _LDAP_H
26
27 /* pull in lber */
28 #include <lber.h>
29
30 /* include version and API feature defines */
31 #include <ldap_features.h>
32
33 LDAP_BEGIN_DECL
34
35 #define LDAP_VERSION1   1
36 #define LDAP_VERSION2   2
37 #define LDAP_VERSION3   3
38
39 #define LDAP_VERSION_MIN        LDAP_VERSION2
40 #define LDAP_VERSION            LDAP_VERSION2
41 #define LDAP_VERSION_MAX        LDAP_VERSION3
42
43 /*
44  * We'll use 2000+draft revision for our API version number
45  * As such, the number will be above the old RFC but below
46  * whatever number does finally get assigned
47  */
48 #define LDAP_API_VERSION        2004
49 #define LDAP_VENDOR_NAME        "OpenLDAP"
50
51 /* OpenLDAP API Features */
52 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
53
54 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
55         ( defined( LDAP_THREAD_SAFE ) && \
56                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
57         /* -lldap may or may not be thread safe */
58         /* -lldap_r, if available, is always thread safe */
59 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
60 #endif
61 #if defined( LDAP_THREAD_SAFE ) && \
62         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
63 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
64 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
65 #endif
66
67 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
68 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
69
70 #define LDAP_ROOT_DSE                           ""
71 #define LDAP_NO_ATTRS                           "1.1"
72 #define LDAP_ALL_USER_ATTRIBUTES        "*"
73 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
74
75 /*
76  * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
77  * 0x0000 - 0x0fff reserved for api options
78  * 0x1000 - 0x3fff reserved for api extended options
79  * 0x4000 - 0x7fff reserved for private and experimental options
80  */
81 #define LDAP_OPT_API_INFO                       0x0000
82 #define LDAP_OPT_DESC                           0x0001 /* deprecated */
83 #define LDAP_OPT_DEREF                          0x0002
84 #define LDAP_OPT_SIZELIMIT                      0x0003
85 #define LDAP_OPT_TIMELIMIT                      0x0004
86 /* 0x05 - 0x07 not defined by current draft */
87 #define LDAP_OPT_REFERRALS                      0x0008
88 #define LDAP_OPT_RESTART                        0x0009
89 /* 0x0a - 0x10 not defined by current draft */
90 #define LDAP_OPT_PROTOCOL_VERSION       0x0011
91 #define LDAP_OPT_SERVER_CONTROLS        0x0012
92 #define LDAP_OPT_CLIENT_CONTROLS        0x0013
93 /* 0x14 not defined by current draft */
94 #define LDAP_OPT_API_FEATURE_INFO       0x0015
95
96 /* 0x16 - 0x2f not defined by current draft */
97 #define LDAP_OPT_HOST_NAME                      0x0030
98 #define LDAP_OPT_ERROR_NUMBER           0x0031
99 #define LDAP_OPT_ERROR_STRING           0x0032
100 #define LDAP_OPT_MATCHED_DN                     0x0033
101
102 /* 0x34 - 0x0fff not defined by current draft */
103
104 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000  /* to 0x7FFF inclusive */
105
106 /* private and experimental options */
107 /* OpenLDAP specific options */
108 #define LDAP_OPT_DEBUG_LEVEL            0x5001  /* debug level */
109 #define LDAP_OPT_TIMEOUT                        0x5002  /* default timeout */
110 #define LDAP_OPT_REFHOPLIMIT            0x5003  /* ref hop limit */
111 #define LDAP_OPT_NETWORK_TIMEOUT        0x5005  /* socket level timeout */
112 #define LDAP_OPT_URI                            0x5006
113 #define LDAP_OPT_REFERRAL_URLS      0x5007  /* Referral URLs */
114
115 /* OpenLDAP TLS options */
116 #define LDAP_OPT_X_TLS                          0x6000
117 #define LDAP_OPT_X_TLS_CTX                      0x6001  /* SSL CTX */
118 #define LDAP_OPT_X_TLS_CACERTFILE       0x6002
119 #define LDAP_OPT_X_TLS_CACERTDIR        0x6003
120 #define LDAP_OPT_X_TLS_CERTFILE         0x6004
121 #define LDAP_OPT_X_TLS_KEYFILE          0x6005
122 #define LDAP_OPT_X_TLS_REQUIRE_CERT     0x6006
123 /* #define LDAP_OPT_X_TLS_PROTOCOL              0x6007 */
124 #define LDAP_OPT_X_TLS_CIPHER_SUITE     0x6008
125 #define LDAP_OPT_X_TLS_RANDOM_FILE      0x6009
126 #define LDAP_OPT_X_TLS_SSL_CTX          0x600a
127
128 #define LDAP_OPT_X_TLS_NEVER            0
129 #define LDAP_OPT_X_TLS_HARD             1
130 #define LDAP_OPT_X_TLS_DEMAND           2
131 #define LDAP_OPT_X_TLS_ALLOW            3
132 #define LDAP_OPT_X_TLS_TRY              4
133
134 /* OpenLDAP SASL options */
135 #define LDAP_OPT_X_SASL_MECH                    0x6100
136 #define LDAP_OPT_X_SASL_REALM                   0x6101
137 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
138 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
139 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
140 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
141 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
142 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
143 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
144 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
145
146 /* on/off values */
147 #define LDAP_OPT_ON             ((void *) 1)
148 #define LDAP_OPT_OFF    ((void *) 0)
149
150 /*
151  * ldap_get_option() and ldap_set_option() return values.
152  * As later versions may return other values indicating
153  * failure, current applications should only compare returned
154  * value against LDAP_OPT_SUCCESS.
155  */
156 #define LDAP_OPT_SUCCESS        0
157 #define LDAP_OPT_ERROR          (-1)
158
159 #define LDAP_API_INFO_VERSION   (1)
160 typedef struct ldapapiinfo {
161         int             ldapai_info_version;            /* version of LDAPAPIInfo (1) */
162         int             ldapai_api_version;                     /* revision of API supported */
163         int             ldapai_protocol_version;        /* highest LDAP version supported */
164         char    **ldapai_extensions;            /* names of API extensions */
165         char    *ldapai_vendor_name;            /* name of supplier */
166         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
167 } LDAPAPIInfo;
168
169 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
170 typedef struct ldap_apifeature_info {
171         int             ldapaif_info_version; /* version of this struct (1) */
172         char*   ldapaif_name;    /* matches LDAP_API_FEATURE_... less the prefix */
173         int             ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
174 } LDAPAPIFeatureInfo;
175
176 typedef struct ldapcontrol {
177         char *                  ldctl_oid;
178         struct berval   ldctl_value;
179         char                    ldctl_iscritical;
180 } LDAPControl;
181
182 /* LDAP Controls */
183 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
184 #define LDAP_CONTROL_SUBENTRIES         "1.3.6.1.4.1.4203.1.10.1"
185 #define LDAP_CONTROL_NOOP                       "1.3.6.1.4.1.4203.1.10.2"
186 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"
187 #define LDAP_CONTROL_PROXY_AUTHZ        "2.16.840.1.113730.3.4.18"
188
189 #if 0
190 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
191 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
192 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
193 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
194 #endif
195
196 #ifdef LDAP_DEVEL
197 #define LDAP_CONTROL_PAGEDRESULTS       "1.2.840.113556.1.4.319"
198 #endif
199
200 #ifdef LDAP_DEVEL
201 #define LDAP_CLIENT_UPDATE 1
202 #define LDAP_SYNC 2
203 #endif
204
205 #ifdef LDAP_CLIENT_UPDATE
206 #define LDAP_CONTROL_CLIENT_UPDATE              "1.3.6.1.4.1.4203.666.5.3"
207 #define LDAP_CONTROL_ENTRY_UPDATE               "1.3.6.1.4.1.4203.666.5.4"
208 #define LDAP_CONTROL_CLIENT_UPDATE_DONE         "1.3.6.1.4.1.4203.666.5.5"
209 #define LDAP_LCUP_COOKIE_OID                    "1.3.6.1.4.1.4203.666.10.1"
210 #endif
211
212 #ifdef LDAP_SYNC
213 #define LDAP_CONTROL_SYNC                       "1.3.6.1.4.1.4203.666.5.6"
214 #define LDAP_CONTROL_SYNC_STATE                 "1.3.6.1.4.1.4203.666.5.7"
215 #define LDAP_CONTROL_SYNC_DONE                  "1.3.6.1.4.1.4203.666.5.8"
216 #define LDAP_SYNC_INFO                          "1.3.6.1.4.1.4203.666.10.2"
217
218 #define LDAP_SYNC_REFRESH_DONE          0
219 #define LDAP_SYNC_NEW_COOKIE            1
220
221 #define LDAP_SYNC_PRESENT               0
222 #define LDAP_SYNC_ADD                   1
223 #define LDAP_SYNC_MODIFY                2
224 #define LDAP_SYNC_DELETE                3
225 #endif
226
227 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
228 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474"
229 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
230 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
231
232 #ifdef LDAP_DEVEL
233 #define LDAP_CONTROL_PERMITMODIFY "1.2.840.113556.1.4.1413"
234 #define LDAP_CONTROL_NOREFERRALS "1.2.840.113556.1.4.1339"
235 #endif
236
237 /* LDAP Unsolicited Notifications */
238 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036"
239 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
240
241 /* LDAP Extended Operations */
242 #define LDAP_EXOP_START_TLS     "1.3.6.1.4.1.1466.20037"
243
244 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
245 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
246 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
247 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
248 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
249
250 #ifdef LDAP_DEVEL
251 #define LDAP_EXOP_X_CANCEL              "1.3.6.1.4.1.4203.666.6.3"
252 #endif
253 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
254
255 /* LDAP Features */
256 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1"  /* + */
257 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
258 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
259 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
260 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
261
262 /*
263  * specific LDAP instantiations of BER types we know about
264  */
265
266 /* Overview of LBER tag construction
267  *
268  *      Bits
269  *      ______
270  *      8 7 | CLASS
271  *      0 0 = UNIVERSAL
272  *      0 1 = APPLICATION
273  *      1 0 = CONTEXT-SPECIFIC
274  *      1 1 = PRIVATE
275  *              _____
276  *              | 6 | DATA-TYPE
277  *                0 = PRIMITIVE
278  *                1 = CONSTRUCTED
279  *                      ___________
280  *                      | 5 ... 1 | TAG-NUMBER
281  */
282
283 /* general stuff */
284 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
285 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
286
287 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
288 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
289
290 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
291 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
292
293 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
294
295 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
296 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
297 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
298 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
299
300 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
301
302 #ifdef LDAP_CLIENT_UPDATE
303 #define LDAP_TAG_INTERVAL       ((ber_tag_t) 0x02U)     /* integer */
304 #define LDAP_LCUP_TAG_COOKIE    ((ber_tag_t) 0x30U)     /* sequence */
305 #endif
306
307 #ifdef LDAP_SYNC
308 #define LDAP_SYNC_TAG_COOKIE    ((ber_tag_t) 0x04U)     /* octet string */
309 #endif
310
311
312 /* possible operations a client can invoke */
313 #define LDAP_REQ_BIND                   ((ber_tag_t) 0x60U)     /* application + constructed */
314 #define LDAP_REQ_UNBIND                 ((ber_tag_t) 0x42U)     /* application + primitive   */
315 #define LDAP_REQ_SEARCH                 ((ber_tag_t) 0x63U)     /* application + constructed */
316 #define LDAP_REQ_MODIFY                 ((ber_tag_t) 0x66U)     /* application + constructed */
317 #define LDAP_REQ_ADD                    ((ber_tag_t) 0x68U)     /* application + constructed */
318 #define LDAP_REQ_DELETE                 ((ber_tag_t) 0x4aU)     /* application + primitive   */
319 #define LDAP_REQ_MODDN                  ((ber_tag_t) 0x6cU)     /* application + constructed */
320 #define LDAP_REQ_MODRDN                 LDAP_REQ_MODDN
321 #define LDAP_REQ_RENAME                 LDAP_REQ_MODDN
322 #define LDAP_REQ_COMPARE                ((ber_tag_t) 0x6eU)     /* application + constructed */
323 #define LDAP_REQ_ABANDON                ((ber_tag_t) 0x50U)     /* application + primitive   */
324 #define LDAP_REQ_EXTENDED               ((ber_tag_t) 0x77U)     /* application + constructed */
325
326 /* possible result types a server can return */
327 #define LDAP_RES_BIND                   ((ber_tag_t) 0x61U)     /* application + constructed */
328 #define LDAP_RES_SEARCH_ENTRY           ((ber_tag_t) 0x64U)     /* application + constructed */
329 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
330 #define LDAP_RES_SEARCH_RESULT          ((ber_tag_t) 0x65U)     /* application + constructed */
331 #define LDAP_RES_MODIFY                 ((ber_tag_t) 0x67U)     /* application + constructed */
332 #define LDAP_RES_ADD                    ((ber_tag_t) 0x69U)     /* application + constructed */
333 #define LDAP_RES_DELETE                 ((ber_tag_t) 0x6bU)     /* application + constructed */
334 #define LDAP_RES_MODDN                  ((ber_tag_t) 0x6dU)     /* application + constructed */
335 #define LDAP_RES_MODRDN                 LDAP_RES_MODDN  /* application + constructed */
336 #define LDAP_RES_RENAME                 LDAP_RES_MODDN  /* application + constructed */
337 #define LDAP_RES_COMPARE                ((ber_tag_t) 0x6fU)     /* application + constructed */
338 #define LDAP_RES_EXTENDED               ((ber_tag_t) 0x78U)     /* V3: application + constructed */
339 #define LDAP_RES_EXTENDED_PARTIAL       ((ber_tag_t) 0x79U)     /* V3+: application + constructed */
340 #ifdef LDAP_DEVEL
341 #define LDAP_RES_INTERMEDIATE_RESP      ((ber_tag_t) 0x7aU)
342 #endif
343
344 #define LDAP_RES_ANY                    (-1)
345 #define LDAP_RES_UNSOLICITED    (0)
346
347
348 /* sasl methods */
349 #define LDAP_SASL_SIMPLE                ((char*)0)
350 #define LDAP_SASL_NULL                  ("")
351
352
353 /* authentication methods available */
354 #define LDAP_AUTH_NONE          ((ber_tag_t) 0x00U)     /* no authentication              */
355 #define LDAP_AUTH_SIMPLE        ((ber_tag_t) 0x80U)     /* context specific + primitive   */
356 #define LDAP_AUTH_SASL          ((ber_tag_t) 0xa3U)     /* context specific + constructed */
357 #define LDAP_AUTH_KRBV4         ((ber_tag_t) 0xffU)     /* means do both of the following */
358 #define LDAP_AUTH_KRBV41        ((ber_tag_t) 0x81U)     /* context specific + primitive   */
359 #define LDAP_AUTH_KRBV42        ((ber_tag_t) 0x82U)     /* context specific + primitive   */
360
361
362 /* filter types */
363 #define LDAP_FILTER_AND         ((ber_tag_t) 0xa0U)     /* context specific + constructed */
364 #define LDAP_FILTER_OR          ((ber_tag_t) 0xa1U)     /* context specific + constructed */
365 #define LDAP_FILTER_NOT         ((ber_tag_t) 0xa2U)     /* context specific + constructed */
366 #define LDAP_FILTER_EQUALITY    ((ber_tag_t) 0xa3U)     /* context specific + constructed */
367 #define LDAP_FILTER_SUBSTRINGS  ((ber_tag_t) 0xa4U)     /* context specific + constructed */
368 #define LDAP_FILTER_GE          ((ber_tag_t) 0xa5U)     /* context specific + constructed */
369 #define LDAP_FILTER_LE          ((ber_tag_t) 0xa6U)     /* context specific + constructed */
370 #define LDAP_FILTER_PRESENT     ((ber_tag_t) 0x87U)     /* context specific + primitive   */
371 #define LDAP_FILTER_APPROX      ((ber_tag_t) 0xa8U)     /* context specific + constructed */
372 #define LDAP_FILTER_EXT         ((ber_tag_t) 0xa9U)     /* context specific + constructed */
373
374 /* extended filter component types */
375 #define LDAP_FILTER_EXT_OID     ((ber_tag_t) 0x81U)     /* context specific */
376 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
377 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
378 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
379
380 /* substring filter component types */
381 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
382 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
383 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
384
385 /* search scopes */
386 #define LDAP_SCOPE_DEFAULT      ((ber_int_t) -1)
387 #define LDAP_SCOPE_BASE         ((ber_int_t) 0x0000)
388 #define LDAP_SCOPE_ONELEVEL     ((ber_int_t) 0x0001)
389 #define LDAP_SCOPE_SUBTREE      ((ber_int_t) 0x0002)
390
391 /* substring filter component types */
392 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
393 #define LDAP_SUBSTRING_ANY      ((ber_tag_t) 0x81U)     /* context specific */
394 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
395
396 /*
397  * possible error codes we can return
398  */
399
400 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
401
402 #define LDAP_SUCCESS                    0x00
403 #define LDAP_OPERATIONS_ERROR           0x01
404 #define LDAP_PROTOCOL_ERROR             0x02
405 #define LDAP_TIMELIMIT_EXCEEDED         0x03
406 #define LDAP_SIZELIMIT_EXCEEDED         0x04
407 #define LDAP_COMPARE_FALSE              0x05
408 #define LDAP_COMPARE_TRUE               0x06
409 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
410 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
411 #define LDAP_STRONG_AUTH_REQUIRED       0x08
412 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
413
414 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
415 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
416 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
417 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
418 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
419
420 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
421
422 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
423 #define LDAP_UNDEFINED_TYPE             0x11
424 #define LDAP_INAPPROPRIATE_MATCHING     0x12
425 #define LDAP_CONSTRAINT_VIOLATION       0x13
426 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
427 #define LDAP_INVALID_SYNTAX             0x15
428
429 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
430
431 #define LDAP_NO_SUCH_OBJECT             0x20
432 #define LDAP_ALIAS_PROBLEM              0x21
433 #define LDAP_INVALID_DN_SYNTAX          0x22
434 #define LDAP_IS_LEAF                    0x23 /* not LDAPv3 */
435 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
436
437 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x30,0x32) /* 48-50 */
438
439 #define LDAP_INAPPROPRIATE_AUTH         0x30
440 #define LDAP_INVALID_CREDENTIALS        0x31
441 #define LDAP_INSUFFICIENT_ACCESS        0x32
442
443 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
444
445 #define LDAP_BUSY                       0x33
446 #define LDAP_UNAVAILABLE                0x34
447 #define LDAP_UNWILLING_TO_PERFORM       0x35
448 #define LDAP_LOOP_DETECT                0x36
449
450 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
451
452 #define LDAP_NAMING_VIOLATION           0x40
453 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
454 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
455 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
456 #define LDAP_ALREADY_EXISTS             0x44
457 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
458 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
459 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
460
461 #define LDAP_OTHER                      0x50
462
463 #define LDAP_API_ERROR(n)               LDAP_RANGE((n),0x51,0x61) /* 81-97 */
464 #define LDAP_API_RESULT(n)              (((n) == LDAP_SUCCESS) || \
465                                                                         LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
466
467 /* reserved for APIs */
468 #define LDAP_SERVER_DOWN                0x51
469 #define LDAP_LOCAL_ERROR                0x52
470 #define LDAP_ENCODING_ERROR             0x53
471 #define LDAP_DECODING_ERROR             0x54
472 #define LDAP_TIMEOUT                    0x55
473 #define LDAP_AUTH_UNKNOWN               0x56
474 #define LDAP_FILTER_ERROR               0x57
475 #define LDAP_USER_CANCELLED             0x58
476 #define LDAP_PARAM_ERROR                0x59
477 #define LDAP_NO_MEMORY                  0x5a
478
479 /* used but not reserved for APIs */
480 #define LDAP_CONNECT_ERROR                              0x5b    /* draft-ietf-ldap-c-api-xx */
481 #define LDAP_NOT_SUPPORTED                              0x5c    /* draft-ietf-ldap-c-api-xx */
482 #define LDAP_CONTROL_NOT_FOUND                  0x5d    /* draft-ietf-ldap-c-api-xx */
483 #define LDAP_NO_RESULTS_RETURNED                0x5e    /* draft-ietf-ldap-c-api-xx */
484 #define LDAP_MORE_RESULTS_TO_RETURN             0x5f    /* draft-ietf-ldap-c-api-xx */
485 #define LDAP_CLIENT_LOOP                                0x60    /* draft-ietf-ldap-c-api-xx */
486 #define LDAP_REFERRAL_LIMIT_EXCEEDED    0x61    /* draft-ietf-ldap-c-api-xx */
487
488 #ifdef LDAP_CLIENT_UPDATE
489 /* resultCode for LCUP */
490 #define LDAP_CUP_RESOURCES_EXHAUSTED    0x100
491 #define LDAP_CUP_SECURITY_VIOLATION             0x101
492 #define LDAP_CUP_INVALID_COOKIE                 0x102
493 #define LDAP_CUP_UNSUPPORTED_SCHEME             0x103
494 #define LDAP_CUP_CLIENT_DISCONNECT              0x104
495 #define LDAP_CUP_RELOAD_REQUIRED                0x105
496 #endif
497
498 #ifdef LDAP_EXOP_X_CANCEL
499 /* resultCode for Cancel Response */
500 #define LDAP_CANCELLED                                  0x110
501 #define LDAP_NO_SUCH_OPERATION                  0x111
502 #define LDAP_TOO_LATE                                   0x112
503 #define LDAP_CANNOT_CANCEL                              0x113
504
505 #define LDAP_CANCEL_NONE                                0x00
506 #define LDAP_CANCEL_REQ                                 0x01
507 #define LDAP_CANCEL_ACK                                 0x02
508 #define LDAP_CANCEL_DONE                                0x03
509 #endif
510
511 #ifdef LDAP_CLIENT_UPDATE
512 /* LCUP update type */
513 #define LDAP_CUP_NONE                                   0x00
514 #define LDAP_CUP_SYNC_ONLY                              0x01
515 #define LDAP_CUP_PERSIST_ONLY                   0x02
516 #define LDAP_CUP_SYNC_AND_PERSIST               0x03
517
518 /* LCUP default cookie interval */
519 #define LDAP_CUP_DEFAULT_SEND_COOKIE_INTERVAL   0x01
520 #endif /* LDAP_CLIENT_UPDATE */
521
522 /* LDAP SYNC request type */
523 #ifdef LDAP_SYNC
524 #define LDAP_SYNC_NONE                                  0x00
525 #define LDAP_SYNC_REFRESH_ONLY                  0x01
526 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
527 #endif
528
529 /*
530  * This structure represents both ldap messages and ldap responses.
531  * These are really the same, except in the case of search responses,
532  * where a response has multiple messages.
533  */
534
535 typedef struct ldapmsg LDAPMessage;
536
537 /* for modifications */
538 typedef struct ldapmod {
539         int             mod_op;
540
541 #define LDAP_MOD_ADD            ((ber_int_t) 0x0000)
542 #define LDAP_MOD_DELETE         ((ber_int_t) 0x0001)
543 #define LDAP_MOD_REPLACE        ((ber_int_t) 0x0002)
544 #define LDAP_MOD_BVALUES        ((ber_int_t) 0x0080)
545 /* IMPORTANT: do not use code 0x1000 (or above),
546  * it is used internally by the backends!
547  * (see ldap/servers/slapd/slap.h)
548  */
549
550         char            *mod_type;
551         union mod_vals_u {
552                 char            **modv_strvals;
553                 struct berval   **modv_bvals;
554         } mod_vals;
555 #define mod_values      mod_vals.modv_strvals
556 #define mod_bvalues     mod_vals.modv_bvals
557 } LDAPMod;
558
559 /*
560  * structure representing an ldap session which can
561  * encompass connections to multiple servers (in the
562  * face of referrals).
563  */
564 typedef struct ldap LDAP;
565
566 #define LDAP_DEREF_NEVER        0x00
567 #define LDAP_DEREF_SEARCHING    0x01
568 #define LDAP_DEREF_FINDING      0x02
569 #define LDAP_DEREF_ALWAYS       0x03
570
571 #define LDAP_NO_LIMIT           0
572
573 /* how many messages to retrieve results for */
574 #define LDAP_MSG_ONE            0x00
575 #define LDAP_MSG_ALL            0x01
576 #define LDAP_MSG_RECEIVED       0x02
577
578 /*
579  * types for ldap URL handling
580  */
581 typedef struct ldap_url_desc {
582         struct ldap_url_desc *lud_next;
583         char    *lud_scheme;
584         char    *lud_host;
585         int             lud_port;
586         char    *lud_dn;
587         char    **lud_attrs;
588         int             lud_scope;
589         char    *lud_filter;
590         char    **lud_exts;
591         int             lud_crit_exts;
592 } LDAPURLDesc;
593
594 #define LDAP_URL_SUCCESS                0x00    /* Success */
595 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
596 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
597
598 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
599 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
600 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
601 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
602 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
603 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
604 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
605 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
606
607 /*
608  * The API draft spec says we should declare (or cause to be declared)
609  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
610  */
611 struct timeval;
612
613 /*
614  * in options.c:
615  */
616 LDAP_F( int )
617 ldap_get_option LDAP_P((
618         LDAP *ld,
619         int option,
620         void *outvalue));
621
622 LDAP_F( int )
623 ldap_set_option LDAP_P((
624         LDAP *ld,
625         int option,
626         LDAP_CONST void *invalue));
627
628 /* V3 REBIND Function Callback Prototype */
629 typedef int (LDAP_REBIND_PROC) LDAP_P((
630         LDAP *ld, LDAP_CONST char *url,
631         ber_tag_t request, ber_int_t msgid,
632         void *params ));
633
634 LDAP_F( int )
635 ldap_set_rebind_proc LDAP_P((
636         LDAP *ld,
637         LDAP_REBIND_PROC *rebind_proc,
638         void *params ));
639
640 /*
641  * in controls.c:
642  */
643 LDAP_F( int )
644 ldap_create_control LDAP_P((
645         LDAP_CONST char *requestOID,
646         BerElement *ber,
647         int iscritical,
648         LDAPControl **ctrlp ));
649
650 LDAP_F( void )
651 ldap_control_free LDAP_P((
652         LDAPControl *ctrl ));
653
654 LDAP_F( void )
655 ldap_controls_free LDAP_P((
656         LDAPControl **ctrls ));
657
658 /*
659  * in dnssrv.c:
660  */
661 LDAP_F( int )
662 ldap_domain2dn LDAP_P((
663         LDAP_CONST char* domain,
664         char** dn ));
665
666 LDAP_F( int )
667 ldap_dn2domain LDAP_P((
668         LDAP_CONST char* dn,
669         char** domain ));
670
671 LDAP_F( int )
672 ldap_domain2hostlist LDAP_P((
673         LDAP_CONST char *domain,
674         char** hostlist ));
675
676 /*
677  * in extended.c:
678  */
679 LDAP_F( int )
680 ldap_extended_operation LDAP_P((
681         LDAP                    *ld,
682         LDAP_CONST char *reqoid,
683         struct berval   *reqdata,
684         LDAPControl             **serverctrls,
685         LDAPControl             **clientctrls,
686         int                             *msgidp ));
687
688 LDAP_F( int )
689 ldap_extended_operation_s LDAP_P((
690         LDAP                    *ld,
691         LDAP_CONST char *reqoid,
692         struct berval   *reqdata,
693         LDAPControl             **serverctrls,
694         LDAPControl             **clientctrls,
695         char                    **retoidp,
696         struct berval   **retdatap ));
697
698 LDAP_F( int )
699 ldap_parse_extended_result LDAP_P((
700         LDAP                    *ld,
701         LDAPMessage             *res,
702         char                    **retoidp,
703         struct berval   **retdatap,
704         int                             freeit ));
705
706 LDAP_F( int )
707 ldap_parse_extended_partial LDAP_P((
708         LDAP                    *ld,
709         LDAPMessage             *res,
710         char                    **retoidp,
711         struct berval   **retdatap,
712         LDAPControl             ***serverctrls,
713         int                             freeit ));
714
715 /*
716  * in abandon.c:
717  */
718 LDAP_F( int )
719 ldap_abandon_ext LDAP_P((
720         LDAP                    *ld,
721         int                             msgid,
722         LDAPControl             **serverctrls,
723         LDAPControl             **clientctrls ));
724
725 LDAP_F( int )
726 ldap_abandon LDAP_P((   /* deprecated */
727         LDAP *ld,
728         int msgid ));
729
730
731 /*
732  * in add.c:
733  */
734 LDAP_F( int )
735 ldap_add_ext LDAP_P((
736         LDAP                    *ld,
737         LDAP_CONST char *dn,
738         LDAPMod                 **attrs,
739         LDAPControl             **serverctrls,
740         LDAPControl             **clientctrls,
741         int                     *msgidp ));
742
743 LDAP_F( int )
744 ldap_add_ext_s LDAP_P((
745         LDAP                    *ld,
746         LDAP_CONST char *dn,
747         LDAPMod                 **attrs,
748         LDAPControl             **serverctrls,
749         LDAPControl             **clientctrls ));
750
751 LDAP_F( int )
752 ldap_add LDAP_P((       /* deprecated */
753         LDAP *ld,
754         LDAP_CONST char *dn,
755         LDAPMod **attrs ));
756
757 LDAP_F( int )
758 ldap_add_s LDAP_P((     /* deprecated */
759         LDAP *ld,
760         LDAP_CONST char *dn,
761         LDAPMod **attrs ));
762
763
764 /*
765  * in sasl.c:
766  */
767 LDAP_F( int )
768 ldap_sasl_bind LDAP_P((
769         LDAP                    *ld,
770         LDAP_CONST char *dn,
771         LDAP_CONST char *mechanism,
772         struct berval   *cred,
773         LDAPControl             **serverctrls,
774         LDAPControl             **clientctrls,
775         int                             *msgidp ));
776
777 /* Interaction flags (should be passed about in a control)
778  *  Automatic (default): use defaults, prompt otherwise
779  *  Interactive: prompt always
780  *  Quiet: never prompt
781  */
782 #define LDAP_SASL_AUTOMATIC             0U
783 #define LDAP_SASL_INTERACTIVE   1U
784 #define LDAP_SASL_QUIET                 2U
785
786 /*
787  * V3 SASL Interaction Function Callback Prototype
788  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
789  *  should likely passed in a control (and provided controls)
790  */
791 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
792         LDAP *ld, unsigned flags, void* defaults, void *interact ));
793
794 LDAP_F( int )
795 ldap_sasl_interactive_bind_s LDAP_P((
796         LDAP *ld,
797         LDAP_CONST char *dn, /* usually NULL */
798         LDAP_CONST char *saslMechanism,
799         LDAPControl **serverControls,
800         LDAPControl **clientControls,
801
802         /* should be client controls */
803         unsigned flags,
804         LDAP_SASL_INTERACT_PROC *proc,
805         void *defaults ));
806
807 LDAP_F( int )
808 ldap_sasl_bind_s LDAP_P((
809         LDAP                    *ld,
810         LDAP_CONST char *dn,
811         LDAP_CONST char *mechanism,
812         struct berval   *cred,
813         LDAPControl             **serverctrls,
814         LDAPControl             **clientctrls,
815         struct berval   **servercredp ));
816
817 LDAP_F( int )
818 ldap_parse_sasl_bind_result LDAP_P((
819         LDAP                    *ld,
820         LDAPMessage             *res,
821         struct berval   **servercredp,
822         int                             freeit ));
823
824 /*
825  * in bind.c:
826  *      (deprecated)
827  */
828 LDAP_F( int )
829 ldap_bind LDAP_P((      /* deprecated */
830         LDAP *ld,
831         LDAP_CONST char *who,
832         LDAP_CONST char *passwd,
833         int authmethod ));
834
835 LDAP_F( int )
836 ldap_bind_s LDAP_P((    /* deprecated */
837         LDAP *ld,
838         LDAP_CONST char *who,
839         LDAP_CONST char *cred,
840         int authmethod ));
841
842 /*
843  * in sbind.c:
844  */
845 LDAP_F( int )
846 ldap_simple_bind LDAP_P((
847         LDAP *ld,
848         LDAP_CONST char *who,
849         LDAP_CONST char *passwd ));
850
851 LDAP_F( int )
852 ldap_simple_bind_s LDAP_P((
853         LDAP *ld,
854         LDAP_CONST char *who,
855         LDAP_CONST char *passwd ));
856
857
858 /*
859  * in kbind.c:
860  *      (deprecated)
861  */
862 LDAP_F( int )
863 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
864         LDAP *ld,
865         LDAP_CONST char *who ));
866
867 LDAP_F( int )
868 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
869         LDAP *ld,
870         LDAP_CONST char *who ));
871
872 LDAP_F( int )
873 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
874         LDAP *ld,
875         LDAP_CONST char *who ));
876
877 LDAP_F( int )
878 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
879         LDAP *ld,
880         LDAP_CONST char *who ));
881
882 LDAP_F( int )
883 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
884         LDAP *ld,
885         LDAP_CONST char *who ));
886
887 /*
888  * in cache.c
889  * (deprecated)
890  */
891 LDAP_F( int )
892 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
893
894 LDAP_F( void )
895 ldap_disable_cache LDAP_P(( LDAP *ld ));
896
897 LDAP_F( void )
898 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
899
900 LDAP_F( void )
901 ldap_destroy_cache LDAP_P(( LDAP *ld ));
902
903 LDAP_F( void )
904 ldap_flush_cache LDAP_P(( LDAP *ld ));
905
906 LDAP_F( void )
907 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
908
909 LDAP_F( void )
910 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
911
912
913 /*
914  * in compare.c:
915  */
916 LDAP_F( int )
917 ldap_compare_ext LDAP_P((
918         LDAP                    *ld,
919         LDAP_CONST char *dn,
920         LDAP_CONST char *attr,
921         struct berval   *bvalue,
922         LDAPControl             **serverctrls,
923         LDAPControl             **clientctrls,
924         int                     *msgidp ));
925
926 LDAP_F( int )
927 ldap_compare_ext_s LDAP_P((
928         LDAP                    *ld,
929         LDAP_CONST char *dn,
930         LDAP_CONST char *attr,
931         struct berval   *bvalue,
932         LDAPControl             **serverctrls,
933         LDAPControl             **clientctrls ));
934
935 LDAP_F( int )
936 ldap_compare LDAP_P((   /* deprecated */
937         LDAP *ld,
938         LDAP_CONST char *dn,
939         LDAP_CONST char *attr,
940         LDAP_CONST char *value ));
941
942 LDAP_F( int )
943 ldap_compare_s LDAP_P(( /* deprecated */
944         LDAP *ld,
945         LDAP_CONST char *dn,
946         LDAP_CONST char *attr,
947         LDAP_CONST char *value ));
948
949
950 /*
951  * in delete.c:
952  */
953 LDAP_F( int )
954 ldap_delete_ext LDAP_P((
955         LDAP                    *ld,
956         LDAP_CONST char *dn,
957         LDAPControl             **serverctrls,
958         LDAPControl             **clientctrls,
959         int                     *msgidp ));
960
961 LDAP_F( int )
962 ldap_delete_ext_s LDAP_P((
963         LDAP                    *ld,
964         LDAP_CONST char *dn,
965         LDAPControl             **serverctrls,
966         LDAPControl             **clientctrls ));
967
968 LDAP_F( int )
969 ldap_delete LDAP_P((    /* deprecated */
970         LDAP *ld,
971         LDAP_CONST char *dn ));
972
973 LDAP_F( int )
974 ldap_delete_s LDAP_P((  /* deprecated */
975         LDAP *ld,
976         LDAP_CONST char *dn ));
977
978
979 /*
980  * in error.c:
981  */
982 LDAP_F( int )
983 ldap_parse_result LDAP_P((
984         LDAP                    *ld,
985         LDAPMessage             *res,
986         int                             *errcodep,
987         char                    **matcheddnp,
988         char                    **errmsgp,
989         char                    ***referralsp,
990         LDAPControl             ***serverctrls,
991         int                             freeit ));
992
993 LDAP_F( char * )
994 ldap_err2string LDAP_P((
995         int err ));
996
997 LDAP_F( int )
998 ldap_result2error LDAP_P((      /* deprecated */
999         LDAP *ld,
1000         LDAPMessage *r,
1001         int freeit ));
1002
1003 LDAP_F( void )
1004 ldap_perror LDAP_P((    /* deprecated */
1005         LDAP *ld,
1006         LDAP_CONST char *s ));
1007
1008
1009 /*
1010  * in modify.c:
1011  */
1012 LDAP_F( int )
1013 ldap_modify_ext LDAP_P((
1014         LDAP                    *ld,
1015         LDAP_CONST char *dn,
1016         LDAPMod                 **mods,
1017         LDAPControl             **serverctrls,
1018         LDAPControl             **clientctrls,
1019         int                     *msgidp ));
1020
1021 LDAP_F( int )
1022 ldap_modify_ext_s LDAP_P((
1023         LDAP                    *ld,
1024         LDAP_CONST char *dn,
1025         LDAPMod                 **mods,
1026         LDAPControl             **serverctrls,
1027         LDAPControl             **clientctrls ));
1028
1029 LDAP_F( int )
1030 ldap_modify LDAP_P((    /* deprecated */
1031         LDAP *ld,
1032         LDAP_CONST char *dn,
1033         LDAPMod **mods ));
1034
1035 LDAP_F( int )
1036 ldap_modify_s LDAP_P((  /* deprecated */
1037         LDAP *ld,
1038         LDAP_CONST char *dn,
1039         LDAPMod **mods ));
1040
1041
1042 /*
1043  * in modrdn.c:
1044  */
1045 LDAP_F( int )
1046 ldap_rename LDAP_P((
1047         LDAP *ld,
1048         LDAP_CONST char *dn,
1049         LDAP_CONST char *newrdn,
1050         LDAP_CONST char *newSuperior,
1051         int deleteoldrdn,
1052         LDAPControl **sctrls,
1053         LDAPControl **cctrls,
1054         int *msgidp ));
1055
1056 LDAP_F( int )
1057 ldap_rename_s LDAP_P((
1058         LDAP *ld,
1059         LDAP_CONST char *dn,
1060         LDAP_CONST char *newrdn,
1061         LDAP_CONST char *newSuperior,
1062         int deleteoldrdn,
1063         LDAPControl **sctrls,
1064         LDAPControl **cctrls ));
1065
1066 LDAP_F( int )
1067 ldap_rename2 LDAP_P((   /* deprecated */
1068         LDAP *ld,
1069         LDAP_CONST char *dn,
1070         LDAP_CONST char *newrdn,
1071         LDAP_CONST char *newSuperior,
1072         int deleteoldrdn ));
1073
1074 LDAP_F( int )
1075 ldap_rename2_s LDAP_P(( /* deprecated */
1076         LDAP *ld,
1077         LDAP_CONST char *dn,
1078         LDAP_CONST char *newrdn,
1079         LDAP_CONST char *newSuperior,
1080         int deleteoldrdn ));
1081
1082 LDAP_F( int )
1083 ldap_modrdn LDAP_P((    /* deprecated */
1084         LDAP *ld,
1085         LDAP_CONST char *dn,
1086         LDAP_CONST char *newrdn ));
1087
1088 LDAP_F( int )
1089 ldap_modrdn_s LDAP_P((  /* deprecated */
1090         LDAP *ld,
1091         LDAP_CONST char *dn,
1092         LDAP_CONST char *newrdn ));
1093
1094 LDAP_F( int )
1095 ldap_modrdn2 LDAP_P((   /* deprecated */
1096         LDAP *ld,
1097         LDAP_CONST char *dn,
1098         LDAP_CONST char *newrdn,
1099         int deleteoldrdn ));
1100
1101 LDAP_F( int )
1102 ldap_modrdn2_s LDAP_P(( /* deprecated */
1103         LDAP *ld,
1104         LDAP_CONST char *dn,
1105         LDAP_CONST char *newrdn,
1106         int deleteoldrdn));
1107
1108
1109 /*
1110  * in open.c:
1111  */
1112 LDAP_F( LDAP * )
1113 ldap_init LDAP_P((
1114         LDAP_CONST char *host,
1115         int port ));
1116
1117 LDAP_F( LDAP * )
1118 ldap_open LDAP_P((      /* deprecated */
1119         LDAP_CONST char *host,
1120         int port ));
1121
1122 LDAP_F( int )
1123 ldap_create LDAP_P((
1124         LDAP **ldp ));
1125
1126 LDAP_F( int )
1127 ldap_initialize LDAP_P((
1128         LDAP **ldp,
1129         LDAP_CONST char *url ));
1130
1131 LDAP_F( int )
1132 ldap_start_tls_s LDAP_P((
1133         LDAP *ld,
1134         LDAPControl **serverctrls,
1135         LDAPControl **clientctrls ));
1136
1137 /*
1138  * in messages.c:
1139  */
1140 LDAP_F( LDAPMessage * )
1141 ldap_first_message LDAP_P((
1142         LDAP *ld,
1143         LDAPMessage *chain ));
1144
1145 LDAP_F( LDAPMessage * )
1146 ldap_next_message LDAP_P((
1147         LDAP *ld,
1148         LDAPMessage *msg ));
1149
1150 LDAP_F( int )
1151 ldap_count_messages LDAP_P((
1152         LDAP *ld,
1153         LDAPMessage *chain ));
1154
1155
1156 /*
1157  * in references.c:
1158  */
1159 LDAP_F( LDAPMessage * )
1160 ldap_first_reference LDAP_P((
1161         LDAP *ld,
1162         LDAPMessage *chain ));
1163
1164 LDAP_F( LDAPMessage * )
1165 ldap_next_reference LDAP_P((
1166         LDAP *ld,
1167         LDAPMessage *ref ));
1168
1169 LDAP_F( int )
1170 ldap_count_references LDAP_P((
1171         LDAP *ld,
1172         LDAPMessage *chain ));
1173
1174 LDAP_F( int )
1175 ldap_parse_reference LDAP_P((
1176         LDAP                    *ld,
1177         LDAPMessage             *ref,
1178         char                    ***referralsp,
1179         LDAPControl             ***serverctrls,
1180         int                             freeit));
1181
1182
1183 /*
1184  * in getentry.c:
1185  */
1186 LDAP_F( LDAPMessage * )
1187 ldap_first_entry LDAP_P((
1188         LDAP *ld,
1189         LDAPMessage *chain ));
1190
1191 LDAP_F( LDAPMessage * )
1192 ldap_next_entry LDAP_P((
1193         LDAP *ld,
1194         LDAPMessage *entry ));
1195
1196 LDAP_F( int )
1197 ldap_count_entries LDAP_P((
1198         LDAP *ld,
1199         LDAPMessage *chain ));
1200
1201 LDAP_F( int )
1202 ldap_get_entry_controls LDAP_P((
1203         LDAP                    *ld,
1204         LDAPMessage             *entry,
1205         LDAPControl             ***serverctrls));
1206
1207
1208 /*
1209  * in addentry.c
1210  */
1211 LDAP_F( LDAPMessage * )
1212 ldap_delete_result_entry LDAP_P((
1213         LDAPMessage **list,
1214         LDAPMessage *e ));
1215
1216 LDAP_F( void )
1217 ldap_add_result_entry LDAP_P((
1218         LDAPMessage **list,
1219         LDAPMessage *e ));
1220
1221
1222 /*
1223  * in getdn.c
1224  */
1225 LDAP_F( char * )
1226 ldap_get_dn LDAP_P((
1227         LDAP *ld,
1228         LDAPMessage *entry ));
1229
1230 typedef struct ldap_ava {
1231         struct berval la_attr;
1232         struct berval la_value;
1233         unsigned la_flags;
1234 #define LDAP_AVA_STRING                         0x0000U
1235 #define LDAP_AVA_BINARY                         0x0001U
1236 #define LDAP_AVA_NONPRINTABLE           0x0002U
1237
1238         void *la_private;
1239 } LDAPAVA;
1240
1241 typedef LDAPAVA** LDAPRDN;
1242 typedef LDAPRDN** LDAPDN;
1243
1244 /* DN formats */
1245 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1246 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1247 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1248 #define LDAP_DN_FORMAT_DCE                      0x0030U
1249 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1250 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1251 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1252 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1253
1254 /* DN flags */
1255 #define LDAP_DN_PRETTY                          0x0100U
1256 #define LDAP_DN_SKIP                            0x0200U
1257 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1258 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1259 #define LDAP_DN_PEDANTIC                        0xF000U
1260
1261 LDAP_F( void ) ldap_avafree LDAP_P(( LDAPAVA *ava ));
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 ));
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_END_DECL
1691 #endif /* _LDAP_H */
Cloned from git://git.openldap.org/openldap.git