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


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