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


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