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


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