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


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