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