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