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