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


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