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


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