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