]> git.sur5r.net Git - openldap/blob - include/ldap.h
Switch to #if instead of #ifdef LDAP_DEPRECATED
[openldap] / include / ldap.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  * 
4  * Copyright 1998-2003 The OpenLDAP Foundation.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted only as authorized by the OpenLDAP
9  * Public License.
10  *
11  * A copy of this license is available in file LICENSE in the
12  * top-level directory of the distribution or, alternatively, at
13  * <http://www.OpenLDAP.org/license.html>.
14  */
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16  * All rights reserved.
17  *
18  * Redistribution and use in source and binary forms are permitted
19  * provided that this notice is preserved and that due credit is given
20  * to the University of Michigan at Ann Arbor. The name of the University
21  * may not be used to endorse or promote products derived from this
22  * software without specific prior written permission. This software
23  * is provided ``as is'' without express or implied warranty.
24  */
25
26 #ifndef _LDAP_H
27 #define _LDAP_H
28
29 /* pull in lber */
30 #include <lber.h>
31
32 /* include version and API feature defines */
33 #include <ldap_features.h>
34
35 LDAP_BEGIN_DECL
36
37 #define LDAP_VERSION1   1
38 #define LDAP_VERSION2   2
39 #define LDAP_VERSION3   3
40
41 #define LDAP_VERSION_MIN        LDAP_VERSION2
42 #define LDAP_VERSION            LDAP_VERSION2
43 #define LDAP_VERSION_MAX        LDAP_VERSION3
44
45 /*
46  * We use 3000+n here because it is above 1823 (for RFC 1823),
47  * above 2000+rev of IETF LDAPEXT draft (now quite dated),
48  * yet below allocations for new RFCs (just in case there is
49  * someday an RFC produced).
50  */
51 #define LDAP_API_VERSION        3001
52 #define LDAP_VENDOR_NAME        "OpenLDAP"
53
54 /* OpenLDAP API Features */
55 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
56
57 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
58         ( defined( LDAP_THREAD_SAFE ) && \
59                 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
60         /* -lldap may or may not be thread safe */
61         /* -lldap_r, if available, is always thread safe */
62 #       define  LDAP_API_FEATURE_THREAD_SAFE 1
63 #endif
64 #if defined( LDAP_THREAD_SAFE ) && \
65         defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
66 /* #define LDAP_API_FEATURE_SESSION_SAFE        1       */
67 /* #define LDAP_API_OPERATION_SESSION_SAFE      1       */
68 #endif
69
70
71 #define LDAP_PORT               389             /* ldap:///             default LDAP port */
72 #define LDAPS_PORT              636             /* ldaps:///    default LDAP over TLS port */
73
74 #define LDAP_ROOT_DSE                           ""
75 #define LDAP_NO_ATTRS                           "1.1"
76 #define LDAP_ALL_USER_ATTRIBUTES        "*"
77 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* 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
245 /* not implemented in slapd(8) */
246 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
247 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474" /* RFC 2891 */
248
249 /* not implemented in slapd(8) */
250 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
251 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
252
253 /* LDAP Unsolicited Notifications */
254 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
255 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
256
257 /* LDAP Extended Operations */
258 #define LDAP_EXOP_START_TLS             "1.3.6.1.4.1.1466.20037"        /* RFC 2830 */
259
260 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
261 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
262 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
263 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
264 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
265
266 #define LDAP_EXOP_X_WHO_AM_I    "1.3.6.1.4.1.4203.1.11.3"
267 #define LDAP_EXOP_X_CANCEL              "1.3.6.1.4.1.4203.666.6.3"
268
269 /* LDAP Features */
270 #define LDAP_FEATURE_ALL_OP_ATTRS       "1.3.6.1.4.1.4203.1.5.1"        /* RFC 3673 */
271 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
272         "1.3.6.1.4.1.4203.1.5.2" /*  @objectClass - new number to be assigned */
273 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
274 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
275 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
276
277 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
278         "1.3.6.1.4.1.4203.666.8.1" /* "children" */
279 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
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 /* possible operations a client can invoke */
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 /* possible result types a server can return */
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 #define LDAP_SCOPE_SUBORDINATE  ((ber_int_t) 0x0003) /* OpenLDAP extension */
401 #define LDAP_SCOPE_CHILDREN             LDAP_SCOPE_SUBORDINATE
402
403 /* substring filter component types */
404 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
405 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
406 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
407
408 /*
409  * possible error codes we can return
410  */
411
412 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
413
414 #define LDAP_SUCCESS                            0x00
415 #define LDAP_OPERATIONS_ERROR           0x01
416 #define LDAP_PROTOCOL_ERROR                     0x02
417 #define LDAP_TIMELIMIT_EXCEEDED         0x03
418 #define LDAP_SIZELIMIT_EXCEEDED         0x04
419 #define LDAP_COMPARE_FALSE                      0x05
420 #define LDAP_COMPARE_TRUE                       0x06
421 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
422 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
423 #define LDAP_STRONG_AUTH_REQUIRED       0x08
424 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
425
426 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
427 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
428 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
429 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
430 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
431
432 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
433
434 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
435 #define LDAP_UNDEFINED_TYPE                     0x11
436 #define LDAP_INAPPROPRIATE_MATCHING     0x12
437 #define LDAP_CONSTRAINT_VIOLATION       0x13
438 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
439 #define LDAP_INVALID_SYNTAX                     0x15
440
441 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
442
443 #define LDAP_NO_SUCH_OBJECT                     0x20
444 #define LDAP_ALIAS_PROBLEM                      0x21
445 #define LDAP_INVALID_DN_SYNTAX          0x22
446 #define LDAP_IS_LEAF                            0x23 /* not LDAPv3 */
447 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
448
449 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
450
451 #define LDAP_PROXY_AUTHZ_FAILURE        0x2F /* LDAPv3 proxy authorization */
452 #define LDAP_INAPPROPRIATE_AUTH         0x30
453 #define LDAP_INVALID_CREDENTIALS        0x31
454 #define LDAP_INSUFFICIENT_ACCESS        0x32
455
456 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
457
458 #define LDAP_BUSY                                       0x33
459 #define LDAP_UNAVAILABLE                        0x34
460 #define LDAP_UNWILLING_TO_PERFORM       0x35
461 #define LDAP_LOOP_DETECT                        0x36
462
463 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
464
465 #define LDAP_NAMING_VIOLATION           0x40
466 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
467 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
468 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
469 #define LDAP_ALREADY_EXISTS                     0x44
470 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
471 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
472 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47 /* LDAPv3 */
473
474 #define LDAP_OTHER                              0x50
475
476 /* Experimental result codes */
477 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
478 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
479
480 /* for the LDAP Sync operation */
481 #define LDAP_SYNC_REFRESH_REQUIRED              0x4100
482
483 /* for the Assertion control */
484 #define LDAP_ASSERTION_FAILED                   0x410f
485
486 /* for the Cancel operation */
487 #define LDAP_CANCELLED                                  0x4110
488 #define LDAP_NO_SUCH_OPERATION                  0x4111
489 #define LDAP_TOO_LATE                                   0x4112
490 #define LDAP_CANNOT_CANCEL                              0x4113
491
492 /* API Error Codes
493  *
494  * Based on draft-ietf-ldap-c-api-xx
495  * but with new negative code values
496  */
497 #define LDAP_API_ERROR(n)               ((n)<0)
498 #define LDAP_API_RESULT(n)              ((n)<=0)
499
500 #define LDAP_SERVER_DOWN                                (-1)
501 #define LDAP_LOCAL_ERROR                                (-2)
502 #define LDAP_ENCODING_ERROR                             (-3)
503 #define LDAP_DECODING_ERROR                             (-4)
504 #define LDAP_TIMEOUT                                    (-5)
505 #define LDAP_AUTH_UNKNOWN                               (-6)
506 #define LDAP_FILTER_ERROR                               (-7)
507 #define LDAP_USER_CANCELLED                             (-8)
508 #define LDAP_PARAM_ERROR                                (-9)
509 #define LDAP_NO_MEMORY                                  (-10)
510 #define LDAP_CONNECT_ERROR                              (-11)
511 #define LDAP_NOT_SUPPORTED                              (-12)
512 #define LDAP_CONTROL_NOT_FOUND                  (-13)
513 #define LDAP_NO_RESULTS_RETURNED                (-14)
514 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)
515 #define LDAP_CLIENT_LOOP                                (-16)
516 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
517
518
519 /*
520  * This structure represents both ldap messages and ldap responses.
521  * These are really the same, except in the case of search responses,
522  * where a response has multiple messages.
523  */
524
525 typedef struct ldapmsg LDAPMessage;
526
527 /* for modifications */
528 typedef struct ldapmod {
529         int             mod_op;
530
531 #define LDAP_MOD_OP                     (0x0007)
532 #define LDAP_MOD_ADD            (0x0000)
533 #define LDAP_MOD_DELETE         (0x0001)
534 #define LDAP_MOD_REPLACE        (0x0002)
535 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
536 #define LDAP_MOD_BVALUES        (0x0080)
537 /* IMPORTANT: do not use code 0x1000 (or above),
538  * it is used internally by the backends!
539  * (see ldap/servers/slapd/slap.h)
540  */
541
542         char            *mod_type;
543         union mod_vals_u {
544                 char            **modv_strvals;
545                 struct berval   **modv_bvals;
546         } mod_vals;
547 #define mod_values      mod_vals.modv_strvals
548 #define mod_bvalues     mod_vals.modv_bvals
549 } LDAPMod;
550
551 /*
552  * structure representing an ldap session which can
553  * encompass connections to multiple servers (in the
554  * face of referrals).
555  */
556 typedef struct ldap LDAP;
557
558 #define LDAP_DEREF_NEVER                0x00
559 #define LDAP_DEREF_SEARCHING    0x01
560 #define LDAP_DEREF_FINDING              0x02
561 #define LDAP_DEREF_ALWAYS               0x03
562
563 #define LDAP_NO_LIMIT                   0
564
565 /* how many messages to retrieve results for */
566 #define LDAP_MSG_ONE                    0x00
567 #define LDAP_MSG_ALL                    0x01
568 #define LDAP_MSG_RECEIVED               0x02
569
570 /*
571  * types for ldap URL handling
572  */
573 typedef struct ldap_url_desc {
574         struct ldap_url_desc *lud_next;
575         char    *lud_scheme;
576         char    *lud_host;
577         int             lud_port;
578         char    *lud_dn;
579         char    **lud_attrs;
580         int             lud_scope;
581         char    *lud_filter;
582         char    **lud_exts;
583         int             lud_crit_exts;
584 } LDAPURLDesc;
585
586 #define LDAP_URL_SUCCESS                0x00    /* Success */
587 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
588 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
589
590 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
591 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
592 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
593 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
594 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
595 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
596 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
597 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
598
599 /*
600  * The API draft spec says we should declare (or cause to be declared)
601  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
602  */
603 struct timeval;
604
605 /*
606  * in options.c:
607  */
608 LDAP_F( int )
609 ldap_get_option LDAP_P((
610         LDAP *ld,
611         int option,
612         void *outvalue));
613
614 LDAP_F( int )
615 ldap_set_option LDAP_P((
616         LDAP *ld,
617         int option,
618         LDAP_CONST void *invalue));
619
620 /* V3 REBIND Function Callback Prototype */
621 typedef int (LDAP_REBIND_PROC) LDAP_P((
622         LDAP *ld, LDAP_CONST char *url,
623         ber_tag_t request, ber_int_t msgid,
624         void *params ));
625
626 LDAP_F( int )
627 ldap_set_rebind_proc LDAP_P((
628         LDAP *ld,
629         LDAP_REBIND_PROC *rebind_proc,
630         void *params ));
631
632 /*
633  * in controls.c:
634  */
635 LDAP_F( int )
636 ldap_create_control LDAP_P((
637         LDAP_CONST char *requestOID,
638         BerElement *ber,
639         int iscritical,
640         LDAPControl **ctrlp ));
641
642 LDAP_F( void )
643 ldap_control_free LDAP_P((
644         LDAPControl *ctrl ));
645
646 LDAP_F( void )
647 ldap_controls_free LDAP_P((
648         LDAPControl **ctrls ));
649
650 /*
651  * in dnssrv.c:
652  */
653 LDAP_F( int )
654 ldap_domain2dn LDAP_P((
655         LDAP_CONST char* domain,
656         char** dn ));
657
658 LDAP_F( int )
659 ldap_dn2domain LDAP_P((
660         LDAP_CONST char* dn,
661         char** domain ));
662
663 LDAP_F( int )
664 ldap_domain2hostlist LDAP_P((
665         LDAP_CONST char *domain,
666         char** hostlist ));
667
668 /*
669  * in extended.c:
670  */
671 LDAP_F( int )
672 ldap_extended_operation LDAP_P((
673         LDAP                    *ld,
674         LDAP_CONST char *reqoid,
675         struct berval   *reqdata,
676         LDAPControl             **serverctrls,
677         LDAPControl             **clientctrls,
678         int                             *msgidp ));
679
680 LDAP_F( int )
681 ldap_extended_operation_s LDAP_P((
682         LDAP                    *ld,
683         LDAP_CONST char *reqoid,
684         struct berval   *reqdata,
685         LDAPControl             **serverctrls,
686         LDAPControl             **clientctrls,
687         char                    **retoidp,
688         struct berval   **retdatap ));
689
690 LDAP_F( int )
691 ldap_parse_extended_result LDAP_P((
692         LDAP                    *ld,
693         LDAPMessage             *res,
694         char                    **retoidp,
695         struct berval   **retdatap,
696         int                             freeit ));
697
698 LDAP_F( int )
699 ldap_parse_intermediate LDAP_P((
700         LDAP                    *ld,
701         LDAPMessage             *res,
702         char                    **retoidp,
703         struct berval   **retdatap,
704         LDAPControl             ***serverctrls,
705         int                             freeit ));
706
707 /*
708  * in abandon.c:
709  */
710 LDAP_F( int )
711 ldap_abandon_ext LDAP_P((
712         LDAP                    *ld,
713         int                             msgid,
714         LDAPControl             **serverctrls,
715         LDAPControl             **clientctrls ));
716
717 #if LDAP_DEPRECATED
718 LDAP_F( int )
719 ldap_abandon LDAP_P((   /* deprecated */
720         LDAP *ld,
721         int msgid ));
722 #endif
723
724
725 /*
726  * in add.c:
727  */
728 LDAP_F( int )
729 ldap_add_ext LDAP_P((
730         LDAP                    *ld,
731         LDAP_CONST char *dn,
732         LDAPMod                 **attrs,
733         LDAPControl             **serverctrls,
734         LDAPControl             **clientctrls,
735         int                     *msgidp ));
736
737 LDAP_F( int )
738 ldap_add_ext_s LDAP_P((
739         LDAP                    *ld,
740         LDAP_CONST char *dn,
741         LDAPMod                 **attrs,
742         LDAPControl             **serverctrls,
743         LDAPControl             **clientctrls ));
744
745 #if LDAP_DEPRECATED
746 LDAP_F( int )
747 ldap_add LDAP_P((       /* deprecated */
748         LDAP *ld,
749         LDAP_CONST char *dn,
750         LDAPMod **attrs ));
751
752 LDAP_F( int )
753 ldap_add_s LDAP_P((     /* deprecated */
754         LDAP *ld,
755         LDAP_CONST char *dn,
756         LDAPMod **attrs ));
757 #endif
758
759
760 /*
761  * in sasl.c:
762  */
763 LDAP_F( int )
764 ldap_sasl_bind LDAP_P((
765         LDAP                    *ld,
766         LDAP_CONST char *dn,
767         LDAP_CONST char *mechanism,
768         struct berval   *cred,
769         LDAPControl             **serverctrls,
770         LDAPControl             **clientctrls,
771         int                             *msgidp ));
772
773 /* Interaction flags (should be passed about in a control)
774  *  Automatic (default): use defaults, prompt otherwise
775  *  Interactive: prompt always
776  *  Quiet: never prompt
777  */
778 #define LDAP_SASL_AUTOMATIC             0U
779 #define LDAP_SASL_INTERACTIVE   1U
780 #define LDAP_SASL_QUIET                 2U
781
782 /*
783  * V3 SASL Interaction Function Callback Prototype
784  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
785  *  should likely passed in a control (and provided controls)
786  */
787 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
788         LDAP *ld, unsigned flags, void* defaults, void *interact ));
789
790 LDAP_F( int )
791 ldap_sasl_interactive_bind_s LDAP_P((
792         LDAP *ld,
793         LDAP_CONST char *dn, /* usually NULL */
794         LDAP_CONST char *saslMechanism,
795         LDAPControl **serverControls,
796         LDAPControl **clientControls,
797
798         /* should be client controls */
799         unsigned flags,
800         LDAP_SASL_INTERACT_PROC *proc,
801         void *defaults ));
802
803 LDAP_F( int )
804 ldap_sasl_bind_s LDAP_P((
805         LDAP                    *ld,
806         LDAP_CONST char *dn,
807         LDAP_CONST char *mechanism,
808         struct berval   *cred,
809         LDAPControl             **serverctrls,
810         LDAPControl             **clientctrls,
811         struct berval   **servercredp ));
812
813 LDAP_F( int )
814 ldap_parse_sasl_bind_result LDAP_P((
815         LDAP                    *ld,
816         LDAPMessage             *res,
817         struct berval   **servercredp,
818         int                             freeit ));
819
820 #if LDAP_DEPRECATED
821 /*
822  * in bind.c:
823  *      (deprecated)
824  */
825 LDAP_F( int )
826 ldap_bind LDAP_P((      /* deprecated */
827         LDAP *ld,
828         LDAP_CONST char *who,
829         LDAP_CONST char *passwd,
830         int authmethod ));
831
832 LDAP_F( int )
833 ldap_bind_s LDAP_P((    /* deprecated */
834         LDAP *ld,
835         LDAP_CONST char *who,
836         LDAP_CONST char *cred,
837         int authmethod ));
838
839 /*
840  * in sbind.c:
841  */
842 LDAP_F( int )
843 ldap_simple_bind LDAP_P(( /* deprecated */
844         LDAP *ld,
845         LDAP_CONST char *who,
846         LDAP_CONST char *passwd ));
847
848 LDAP_F( int )
849 ldap_simple_bind_s LDAP_P(( /* deprecated */
850         LDAP *ld,
851         LDAP_CONST char *who,
852         LDAP_CONST char *passwd ));
853
854
855 /*
856  * in kbind.c:
857  *      (deprecated)
858  */
859 LDAP_F( int )
860 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
861         LDAP *ld,
862         LDAP_CONST char *who ));
863
864 LDAP_F( int )
865 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
866         LDAP *ld,
867         LDAP_CONST char *who ));
868
869 LDAP_F( int )
870 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
871         LDAP *ld,
872         LDAP_CONST char *who ));
873
874 LDAP_F( int )
875 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
876         LDAP *ld,
877         LDAP_CONST char *who ));
878
879 LDAP_F( int )
880 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
881         LDAP *ld,
882         LDAP_CONST char *who ));
883 #endif
884
885
886 /*
887  * in compare.c:
888  */
889 LDAP_F( int )
890 ldap_compare_ext LDAP_P((
891         LDAP                    *ld,
892         LDAP_CONST char *dn,
893         LDAP_CONST char *attr,
894         struct berval   *bvalue,
895         LDAPControl             **serverctrls,
896         LDAPControl             **clientctrls,
897         int                     *msgidp ));
898
899 LDAP_F( int )
900 ldap_compare_ext_s LDAP_P((
901         LDAP                    *ld,
902         LDAP_CONST char *dn,
903         LDAP_CONST char *attr,
904         struct berval   *bvalue,
905         LDAPControl             **serverctrls,
906         LDAPControl             **clientctrls ));
907
908 #if LDAP_DEPRECATED
909 LDAP_F( int )
910 ldap_compare LDAP_P((   /* deprecated */
911         LDAP *ld,
912         LDAP_CONST char *dn,
913         LDAP_CONST char *attr,
914         LDAP_CONST char *value ));
915
916 LDAP_F( int )
917 ldap_compare_s LDAP_P(( /* deprecated */
918         LDAP *ld,
919         LDAP_CONST char *dn,
920         LDAP_CONST char *attr,
921         LDAP_CONST char *value ));
922 #endif
923
924
925 /*
926  * in delete.c:
927  */
928 LDAP_F( int )
929 ldap_delete_ext LDAP_P((
930         LDAP                    *ld,
931         LDAP_CONST char *dn,
932         LDAPControl             **serverctrls,
933         LDAPControl             **clientctrls,
934         int                     *msgidp ));
935
936 LDAP_F( int )
937 ldap_delete_ext_s LDAP_P((
938         LDAP                    *ld,
939         LDAP_CONST char *dn,
940         LDAPControl             **serverctrls,
941         LDAPControl             **clientctrls ));
942
943 #if LDAP_DEPRECATED
944 LDAP_F( int )
945 ldap_delete LDAP_P((    /* deprecated */
946         LDAP *ld,
947         LDAP_CONST char *dn ));
948
949 LDAP_F( int )
950 ldap_delete_s LDAP_P((  /* deprecated */
951         LDAP *ld,
952         LDAP_CONST char *dn ));
953 #endif
954
955
956 /*
957  * in error.c:
958  */
959 LDAP_F( int )
960 ldap_parse_result LDAP_P((
961         LDAP                    *ld,
962         LDAPMessage             *res,
963         int                             *errcodep,
964         char                    **matcheddnp,
965         char                    **errmsgp,
966         char                    ***referralsp,
967         LDAPControl             ***serverctrls,
968         int                             freeit ));
969
970 LDAP_F( char * )
971 ldap_err2string LDAP_P((
972         int err ));
973
974 #if LDAP_DEPRECATED
975 LDAP_F( int )
976 ldap_result2error LDAP_P((      /* deprecated */
977         LDAP *ld,
978         LDAPMessage *r,
979         int freeit ));
980
981 LDAP_F( void )
982 ldap_perror LDAP_P((    /* deprecated */
983         LDAP *ld,
984         LDAP_CONST char *s ));
985 #endif
986
987
988 /*
989  * in modify.c:
990  */
991 LDAP_F( int )
992 ldap_modify_ext LDAP_P((
993         LDAP                    *ld,
994         LDAP_CONST char *dn,
995         LDAPMod                 **mods,
996         LDAPControl             **serverctrls,
997         LDAPControl             **clientctrls,
998         int                     *msgidp ));
999
1000 LDAP_F( int )
1001 ldap_modify_ext_s LDAP_P((
1002         LDAP                    *ld,
1003         LDAP_CONST char *dn,
1004         LDAPMod                 **mods,
1005         LDAPControl             **serverctrls,
1006         LDAPControl             **clientctrls ));
1007
1008 #if LDAP_DEPRECATED
1009 LDAP_F( int )
1010 ldap_modify LDAP_P((    /* deprecated */
1011         LDAP *ld,
1012         LDAP_CONST char *dn,
1013         LDAPMod **mods ));
1014
1015 LDAP_F( int )
1016 ldap_modify_s LDAP_P((  /* deprecated */
1017         LDAP *ld,
1018         LDAP_CONST char *dn,
1019         LDAPMod **mods ));
1020 #endif
1021
1022
1023 /*
1024  * in modrdn.c:
1025  */
1026 LDAP_F( int )
1027 ldap_rename LDAP_P((
1028         LDAP *ld,
1029         LDAP_CONST char *dn,
1030         LDAP_CONST char *newrdn,
1031         LDAP_CONST char *newSuperior,
1032         int deleteoldrdn,
1033         LDAPControl **sctrls,
1034         LDAPControl **cctrls,
1035         int *msgidp ));
1036
1037 LDAP_F( int )
1038 ldap_rename_s LDAP_P((
1039         LDAP *ld,
1040         LDAP_CONST char *dn,
1041         LDAP_CONST char *newrdn,
1042         LDAP_CONST char *newSuperior,
1043         int deleteoldrdn,
1044         LDAPControl **sctrls,
1045         LDAPControl **cctrls ));
1046
1047 #if LDAP_DEPRECATED
1048 LDAP_F( int )
1049 ldap_rename2 LDAP_P((   /* deprecated */
1050         LDAP *ld,
1051         LDAP_CONST char *dn,
1052         LDAP_CONST char *newrdn,
1053         LDAP_CONST char *newSuperior,
1054         int deleteoldrdn ));
1055
1056 LDAP_F( int )
1057 ldap_rename2_s LDAP_P(( /* deprecated */
1058         LDAP *ld,
1059         LDAP_CONST char *dn,
1060         LDAP_CONST char *newrdn,
1061         LDAP_CONST char *newSuperior,
1062         int deleteoldrdn ));
1063
1064 LDAP_F( int )
1065 ldap_modrdn LDAP_P((    /* deprecated */
1066         LDAP *ld,
1067         LDAP_CONST char *dn,
1068         LDAP_CONST char *newrdn ));
1069
1070 LDAP_F( int )
1071 ldap_modrdn_s LDAP_P((  /* deprecated */
1072         LDAP *ld,
1073         LDAP_CONST char *dn,
1074         LDAP_CONST char *newrdn ));
1075
1076 LDAP_F( int )
1077 ldap_modrdn2 LDAP_P((   /* deprecated */
1078         LDAP *ld,
1079         LDAP_CONST char *dn,
1080         LDAP_CONST char *newrdn,
1081         int deleteoldrdn ));
1082
1083 LDAP_F( int )
1084 ldap_modrdn2_s LDAP_P(( /* deprecated */
1085         LDAP *ld,
1086         LDAP_CONST char *dn,
1087         LDAP_CONST char *newrdn,
1088         int deleteoldrdn));
1089 #endif
1090
1091
1092 /*
1093  * in open.c:
1094  */
1095 #if LDAP_DEPRECATED
1096 LDAP_F( LDAP * )
1097 ldap_init LDAP_P(( /* deprecated */
1098         LDAP_CONST char *host,
1099         int port ));
1100
1101 LDAP_F( LDAP * )
1102 ldap_open LDAP_P((      /* deprecated */
1103         LDAP_CONST char *host,
1104         int port ));
1105 #endif
1106
1107 LDAP_F( int )
1108 ldap_create LDAP_P((
1109         LDAP **ldp ));
1110
1111 LDAP_F( int )
1112 ldap_initialize LDAP_P((
1113         LDAP **ldp,
1114         LDAP_CONST char *url ));
1115
1116 LDAP_F( int )
1117 ldap_start_tls_s LDAP_P((
1118         LDAP *ld,
1119         LDAPControl **serverctrls,
1120         LDAPControl **clientctrls ));
1121
1122 /*
1123  * in messages.c:
1124  */
1125 LDAP_F( LDAPMessage * )
1126 ldap_first_message LDAP_P((
1127         LDAP *ld,
1128         LDAPMessage *chain ));
1129
1130 LDAP_F( LDAPMessage * )
1131 ldap_next_message LDAP_P((
1132         LDAP *ld,
1133         LDAPMessage *msg ));
1134
1135 LDAP_F( int )
1136 ldap_count_messages LDAP_P((
1137         LDAP *ld,
1138         LDAPMessage *chain ));
1139
1140 /*
1141  * in references.c:
1142  */
1143 LDAP_F( LDAPMessage * )
1144 ldap_first_reference LDAP_P((
1145         LDAP *ld,
1146         LDAPMessage *chain ));
1147
1148 LDAP_F( LDAPMessage * )
1149 ldap_next_reference LDAP_P((
1150         LDAP *ld,
1151         LDAPMessage *ref ));
1152
1153 LDAP_F( int )
1154 ldap_count_references LDAP_P((
1155         LDAP *ld,
1156         LDAPMessage *chain ));
1157
1158 LDAP_F( int )
1159 ldap_parse_reference LDAP_P((
1160         LDAP                    *ld,
1161         LDAPMessage             *ref,
1162         char                    ***referralsp,
1163         LDAPControl             ***serverctrls,
1164         int                             freeit));
1165
1166
1167 /*
1168  * in getentry.c:
1169  */
1170 LDAP_F( LDAPMessage * )
1171 ldap_first_entry LDAP_P((
1172         LDAP *ld,
1173         LDAPMessage *chain ));
1174
1175 LDAP_F( LDAPMessage * )
1176 ldap_next_entry LDAP_P((
1177         LDAP *ld,
1178         LDAPMessage *entry ));
1179
1180 LDAP_F( int )
1181 ldap_count_entries LDAP_P((
1182         LDAP *ld,
1183         LDAPMessage *chain ));
1184
1185 LDAP_F( int )
1186 ldap_get_entry_controls LDAP_P((
1187         LDAP                    *ld,
1188         LDAPMessage             *entry,
1189         LDAPControl             ***serverctrls));
1190
1191
1192 /*
1193  * in addentry.c
1194  */
1195 LDAP_F( LDAPMessage * )
1196 ldap_delete_result_entry LDAP_P((
1197         LDAPMessage **list,
1198         LDAPMessage *e ));
1199
1200 LDAP_F( void )
1201 ldap_add_result_entry LDAP_P((
1202         LDAPMessage **list,
1203         LDAPMessage *e ));
1204
1205
1206 /*
1207  * in getdn.c
1208  */
1209 LDAP_F( char * )
1210 ldap_get_dn LDAP_P((
1211         LDAP *ld,
1212         LDAPMessage *entry ));
1213
1214 typedef struct ldap_ava {
1215         struct berval la_attr;
1216         struct berval la_value;
1217         unsigned la_flags;
1218 #define LDAP_AVA_NULL                           0x0000U
1219 #define LDAP_AVA_STRING                         0x0001U
1220 #define LDAP_AVA_BINARY                         0x0002U
1221 #define LDAP_AVA_NONPRINTABLE           0x0004U
1222 #define LDAP_AVA_FREE_ATTR                      0x0010U
1223 #define LDAP_AVA_FREE_VALUE                     0x0020U
1224
1225         void *la_private;
1226 } LDAPAVA;
1227
1228 typedef LDAPAVA** LDAPRDN;
1229 typedef LDAPRDN* LDAPDN;
1230
1231 /* DN formats */
1232 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1233 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1234 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1235 #define LDAP_DN_FORMAT_DCE                      0x0030U
1236 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1237 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1238 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1239 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1240
1241 /* DN flags */
1242 #define LDAP_DN_PRETTY                          0x0100U
1243 #define LDAP_DN_SKIP                            0x0200U
1244 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1245 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1246 #define LDAP_DN_PEDANTIC                        0xF000U
1247
1248 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1249 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1250
1251 LDAP_F( int )
1252 ldap_bv2dn LDAP_P(( 
1253         struct berval *bv, 
1254         LDAPDN *dn, 
1255         unsigned flags ));
1256
1257 LDAP_F( int )
1258 ldap_str2dn LDAP_P((
1259         LDAP_CONST char *str,
1260         LDAPDN *dn,
1261         unsigned flags ));
1262
1263 LDAP_F( int )
1264 ldap_dn2bv LDAP_P((
1265         LDAPDN dn,
1266         struct berval *bv,
1267         unsigned flags ));
1268
1269 LDAP_F( int )
1270 ldap_dn2str LDAP_P((
1271         LDAPDN dn,
1272         char **str,
1273         unsigned flags ));
1274
1275 LDAP_F( int )
1276 ldap_bv2rdn LDAP_P((
1277         struct berval *bv,
1278         LDAPRDN *rdn,
1279         char **next,
1280         unsigned flags ));
1281
1282 LDAP_F( int )
1283 ldap_str2rdn LDAP_P((
1284         LDAP_CONST char *str,
1285         LDAPRDN *rdn,
1286         char **next,
1287         unsigned flags ));
1288
1289 LDAP_F( int )
1290 ldap_rdn2bv LDAP_P((
1291         LDAPRDN rdn,
1292         struct berval *bv,
1293         unsigned flags ));
1294
1295 LDAP_F( int )
1296 ldap_rdn2str LDAP_P((
1297         LDAPRDN rdn,
1298         char **str,
1299         unsigned flags ));
1300
1301 LDAP_F( int )
1302 ldap_dn_normalize LDAP_P((
1303         LDAP_CONST char *in, unsigned iflags,
1304         char **out, unsigned oflags ));
1305
1306 LDAP_F( char * )
1307 ldap_dn2ufn LDAP_P(( /* deprecated */
1308         LDAP_CONST char *dn ));
1309
1310 LDAP_F( char ** )
1311 ldap_explode_dn LDAP_P(( /* deprecated */
1312         LDAP_CONST char *dn,
1313         int notypes ));
1314
1315 LDAP_F( char ** )
1316 ldap_explode_rdn LDAP_P(( /* deprecated */
1317         LDAP_CONST char *rdn,
1318         int notypes ));
1319
1320 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1321
1322 LDAP_F( int )
1323 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1324         LDAPDN_rewrite_func *func, unsigned flags ));
1325
1326 LDAP_F( char * )
1327 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1328
1329 LDAP_F( char * )
1330 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1331
1332 LDAP_F( char * )
1333 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1334
1335 LDAP_F( int )
1336 ldap_get_dn_ber LDAP_P((
1337         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1338
1339 LDAP_F( int )
1340 ldap_get_attribute_ber LDAP_P((
1341         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1342         struct berval **vals ));
1343
1344 /*
1345  * in getattr.c
1346  */
1347 LDAP_F( char * )
1348 ldap_first_attribute LDAP_P((
1349         LDAP *ld,
1350         LDAPMessage *entry,
1351         BerElement **ber ));
1352
1353 LDAP_F( char * )
1354 ldap_next_attribute LDAP_P((
1355         LDAP *ld,
1356         LDAPMessage *entry,
1357         BerElement *ber ));
1358
1359
1360 /*
1361  * in getvalues.c
1362  */
1363 LDAP_F( struct berval ** )
1364 ldap_get_values_len LDAP_P((
1365         LDAP *ld,
1366         LDAPMessage *entry,
1367         LDAP_CONST char *target ));
1368
1369 LDAP_F( int )
1370 ldap_count_values_len LDAP_P((
1371         struct berval **vals ));
1372
1373 LDAP_F( void )
1374 ldap_value_free_len LDAP_P((
1375         struct berval **vals ));
1376
1377 #if LDAP_DEPRECATED
1378 LDAP_F( char ** )
1379 ldap_get_values LDAP_P((        /* deprecated */
1380         LDAP *ld,
1381         LDAPMessage *entry,
1382         LDAP_CONST char *target ));
1383
1384 LDAP_F( int )
1385 ldap_count_values LDAP_P((      /* deprecated */
1386         char **vals ));
1387
1388 LDAP_F( void )
1389 ldap_value_free LDAP_P((        /* deprecated */
1390         char **vals ));
1391 #endif
1392
1393 /*
1394  * in result.c:
1395  */
1396 LDAP_F( int )
1397 ldap_result LDAP_P((
1398         LDAP *ld,
1399         int msgid,
1400         int all,
1401         struct timeval *timeout,
1402         LDAPMessage **result ));
1403
1404 LDAP_F( int )
1405 ldap_msgtype LDAP_P((
1406         LDAPMessage *lm ));
1407
1408 LDAP_F( int )
1409 ldap_msgid   LDAP_P((
1410         LDAPMessage *lm ));
1411
1412 LDAP_F( int )
1413 ldap_msgfree LDAP_P((
1414         LDAPMessage *lm ));
1415
1416 LDAP_F( int )
1417 ldap_msgdelete LDAP_P((
1418         LDAP *ld,
1419         int msgid ));
1420
1421
1422 /*
1423  * in search.c:
1424  */
1425 LDAP_F( int )
1426 ldap_search_ext LDAP_P((
1427         LDAP                    *ld,
1428         LDAP_CONST char *base,
1429         int                             scope,
1430         LDAP_CONST char *filter,
1431         char                    **attrs,
1432         int                             attrsonly,
1433         LDAPControl             **serverctrls,
1434         LDAPControl             **clientctrls,
1435         struct timeval  *timeout,
1436         int                             sizelimit,
1437         int                             *msgidp ));
1438
1439 LDAP_F( int )
1440 ldap_search_ext_s LDAP_P((
1441         LDAP                    *ld,
1442         LDAP_CONST char *base,
1443         int                             scope,
1444         LDAP_CONST char *filter,
1445         char                    **attrs,
1446         int                             attrsonly,
1447         LDAPControl             **serverctrls,
1448         LDAPControl             **clientctrls,
1449         struct timeval  *timeout,
1450         int                             sizelimit,
1451         LDAPMessage             **res ));
1452
1453 #if LDAP_DEPRECATED
1454 LDAP_F( int )
1455 ldap_search LDAP_P((    /* deprecated */
1456         LDAP *ld,
1457         LDAP_CONST char *base,
1458         int scope,
1459         LDAP_CONST char *filter,
1460         char **attrs,
1461         int attrsonly ));
1462
1463 LDAP_F( int )
1464 ldap_search_s LDAP_P((  /* deprecated */
1465         LDAP *ld,
1466         LDAP_CONST char *base,
1467         int scope,
1468         LDAP_CONST char *filter,
1469         char **attrs,
1470         int attrsonly,
1471         LDAPMessage **res ));
1472
1473 LDAP_F( int )
1474 ldap_search_st LDAP_P(( /* deprecated */
1475         LDAP *ld,
1476         LDAP_CONST char *base,
1477         int scope,
1478         LDAP_CONST char *filter,
1479     char **attrs,
1480         int attrsonly,
1481         struct timeval *timeout,
1482         LDAPMessage **res ));
1483 #endif
1484
1485 /*
1486  * in unbind.c
1487  */
1488 LDAP_F( int )
1489 ldap_unbind_ext LDAP_P((
1490         LDAP                    *ld,
1491         LDAPControl             **serverctrls,
1492         LDAPControl             **clientctrls));
1493
1494 LDAP_F( int )
1495 ldap_unbind_ext_s LDAP_P((
1496         LDAP                    *ld,
1497         LDAPControl             **serverctrls,
1498         LDAPControl             **clientctrls));
1499
1500 #if LDAP_DEPRECATED
1501 LDAP_F( int )
1502 ldap_unbind LDAP_P(( /* deprecated */
1503         LDAP *ld ));
1504
1505 LDAP_F( int )
1506 ldap_unbind_s LDAP_P(( /* deprecated */
1507         LDAP *ld ));
1508 #endif
1509
1510 /*
1511  * in filter.c
1512  */
1513 LDAP_F( int )
1514 ldap_put_vrFilter LDAP_P((
1515         BerElement *ber,
1516         const char *vrf ));
1517
1518 /*
1519  * in free.c
1520  */
1521
1522 LDAP_F( void * )
1523 ldap_memalloc LDAP_P((
1524         ber_len_t s ));
1525
1526 LDAP_F( void * )
1527 ldap_memrealloc LDAP_P((
1528         void* p,
1529         ber_len_t s ));
1530
1531 LDAP_F( void * )
1532 ldap_memcalloc LDAP_P((
1533         ber_len_t n,
1534         ber_len_t s ));
1535
1536 LDAP_F( void )
1537 ldap_memfree LDAP_P((
1538         void* p ));
1539
1540 LDAP_F( void )
1541 ldap_memvfree LDAP_P((
1542         void** v ));
1543
1544 LDAP_F( char * )
1545 ldap_strdup LDAP_P((
1546         LDAP_CONST char * ));
1547
1548 LDAP_F( void )
1549 ldap_mods_free LDAP_P((
1550         LDAPMod **mods,
1551         int freemods ));
1552
1553
1554 #if LDAP_DEPRECATED
1555 /*
1556  * in sort.c (deprecated)
1557  */
1558 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1559         LDAP_CONST char *left,
1560         LDAP_CONST char *right ));
1561
1562 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1563         LDAP_CONST void *left,
1564         LDAP_CONST void *right ));
1565
1566 LDAP_F( int )   /* deprecated */
1567 ldap_sort_entries LDAP_P(( LDAP *ld,
1568         LDAPMessage **chain,
1569         LDAP_CONST char *attr,
1570         LDAP_SORT_AD_CMP_PROC *cmp ));
1571
1572 LDAP_F( int )   /* deprecated */
1573 ldap_sort_values LDAP_P((
1574         LDAP *ld,
1575         char **vals,
1576         LDAP_SORT_AV_CMP_PROC *cmp ));
1577
1578 LDAP_F( int ) /* deprecated */
1579 ldap_sort_strcasecmp LDAP_P((
1580         LDAP_CONST void *a,
1581         LDAP_CONST void *b ));
1582 #endif
1583
1584 /*
1585  * in url.c
1586  */
1587 LDAP_F( int )
1588 ldap_is_ldap_url LDAP_P((
1589         LDAP_CONST char *url ));
1590
1591 LDAP_F( int )
1592 ldap_is_ldaps_url LDAP_P((
1593         LDAP_CONST char *url ));
1594
1595 LDAP_F( int )
1596 ldap_is_ldapi_url LDAP_P((
1597         LDAP_CONST char *url ));
1598
1599 LDAP_F( int )
1600 ldap_url_parse LDAP_P((
1601         LDAP_CONST char *url,
1602         LDAPURLDesc **ludpp ));
1603
1604 LDAP_F( char * )
1605 ldap_url_desc2str LDAP_P((
1606         LDAPURLDesc *ludp ));
1607
1608 LDAP_F( void )
1609 ldap_free_urldesc LDAP_P((
1610         LDAPURLDesc *ludp ));
1611
1612
1613 /*
1614  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1615  *  in cancel.c
1616  */
1617 #define LDAP_API_FEATURE_CANCEL 1000
1618
1619 LDAP_F( int )
1620 ldap_cancel LDAP_P(( LDAP *ld,
1621         int cancelid,
1622         LDAPControl             **sctrls,
1623         LDAPControl             **cctrls,
1624         int                             *msgidp ));
1625
1626 LDAP_F( int )
1627 ldap_cancel_s LDAP_P((
1628         LDAP *ld,
1629         int cancelid,
1630         LDAPControl **sctrl,
1631         LDAPControl **cctrl ));
1632
1633 /*
1634  * LDAP Server Side Sort
1635  *      in sortctrl.c
1636  */
1637 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1638
1639 /* structure for a sort-key */
1640 typedef struct ldapsortkey {
1641         char *  attributeType;
1642         char *  orderingRule;
1643         int     reverseOrder;
1644 } LDAPSortKey;
1645
1646 LDAP_F( int )
1647 ldap_create_sort_keylist LDAP_P((
1648         LDAPSortKey ***sortKeyList,
1649         char        *keyString ));
1650
1651 LDAP_F( void )
1652 ldap_free_sort_keylist LDAP_P((
1653         LDAPSortKey **sortkeylist ));
1654
1655 LDAP_F( int )
1656 ldap_create_sort_control LDAP_P((
1657         LDAP *ld,
1658         LDAPSortKey **keyList,
1659         int ctl_iscritical,
1660         LDAPControl **ctrlp ));
1661
1662 LDAP_F( int )
1663 ldap_parse_sort_control LDAP_P((
1664         LDAP           *ld,
1665         LDAPControl    **ctrlp,
1666         unsigned long  *result,
1667         char           **attribute ));
1668
1669
1670 /*
1671  * LDAP Virtual List View
1672  *      in vlvctrl.c
1673  */
1674 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1675
1676 /* structure for virtual list */
1677 typedef struct ldapvlvinfo {
1678         int             ldvlv_version;
1679     unsigned long   ldvlv_before_count;
1680     unsigned long   ldvlv_after_count;
1681     unsigned long   ldvlv_offset;
1682     unsigned long   ldvlv_count;
1683     struct berval *     ldvlv_attrvalue;
1684     struct berval *     ldvlv_context;
1685     void *                      ldvlv_extradata;
1686 } LDAPVLVInfo;
1687
1688 LDAP_F( int )
1689 ldap_create_vlv_control LDAP_P((
1690         LDAP *ld,
1691         LDAPVLVInfo *ldvlistp,
1692         LDAPControl **ctrlp ));
1693
1694 LDAP_F( int )
1695 ldap_parse_vlv_control LDAP_P((
1696         LDAP          *ld,
1697         LDAPControl   **ctrls,
1698         unsigned long *target_posp,
1699         unsigned long *list_countp,
1700         struct berval **contextp,
1701         int           *errcodep ));
1702
1703 /*
1704  * LDAP Who Am I?
1705  *      in whoami.c
1706  */
1707 #define LDAP_API_FEATURE_WHOAMI 1000
1708
1709 LDAP_F( int )
1710 ldap_parse_whoami LDAP_P((
1711         LDAP *ld,
1712         LDAPMessage *res,
1713         struct berval **authzid ));
1714
1715 LDAP_F( int )
1716 ldap_whoami LDAP_P(( LDAP *ld,
1717         LDAPControl             **sctrls,
1718         LDAPControl             **cctrls,
1719         int                             *msgidp ));
1720
1721 LDAP_F( int )
1722 ldap_whoami_s LDAP_P((
1723         LDAP *ld,
1724         struct berval **authzid,
1725         LDAPControl **sctrls,
1726         LDAPControl **cctrls ));
1727
1728 /*
1729  * LDAP Password Modify
1730  *      in passwd.c
1731  */
1732 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1733
1734 LDAP_F( int )
1735 ldap_parse_passwd LDAP_P((
1736         LDAP *ld,
1737         LDAPMessage *res,
1738         struct berval *newpasswd ));
1739
1740 LDAP_F( int )
1741 ldap_passwd LDAP_P(( LDAP *ld,
1742         struct berval   *user,
1743         struct berval   *oldpw,
1744         struct berval   *newpw,
1745         LDAPControl             **sctrls,
1746         LDAPControl             **cctrls,
1747         int                             *msgidp ));
1748
1749 LDAP_F( int )
1750 ldap_passwd_s LDAP_P((
1751         LDAP *ld,
1752         struct berval   *user,
1753         struct berval   *oldpw,
1754         struct berval   *newpw,
1755         struct berval *newpasswd,
1756         LDAPControl **sctrls,
1757         LDAPControl **cctrls ));
1758
1759
1760 LDAP_END_DECL
1761 #endif /* _LDAP_H */