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


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