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


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