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


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