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


e9a8ef12a0e50eb8877faa86fb1362abcde60afe
[openldap] / include / ldap.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  * 
4  * Copyright 1998-2006 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 #define LDAP_OPT_X_TLS_DHFILE           0x600e
140
141 #define LDAP_OPT_X_TLS_NEVER    0
142 #define LDAP_OPT_X_TLS_HARD             1
143 #define LDAP_OPT_X_TLS_DEMAND   2
144 #define LDAP_OPT_X_TLS_ALLOW    3
145 #define LDAP_OPT_X_TLS_TRY              4
146
147 #define LDAP_OPT_X_TLS_CRL_NONE 0
148 #define LDAP_OPT_X_TLS_CRL_PEER 1
149 #define LDAP_OPT_X_TLS_CRL_ALL  2
150
151 /* OpenLDAP SASL options */
152 #define LDAP_OPT_X_SASL_MECH                    0x6100
153 #define LDAP_OPT_X_SASL_REALM                   0x6101
154 #define LDAP_OPT_X_SASL_AUTHCID                 0x6102
155 #define LDAP_OPT_X_SASL_AUTHZID                 0x6103
156 #define LDAP_OPT_X_SASL_SSF                             0x6104 /* read-only */
157 #define LDAP_OPT_X_SASL_SSF_EXTERNAL    0x6105 /* write-only */
158 #define LDAP_OPT_X_SASL_SECPROPS                0x6106 /* write-only */
159 #define LDAP_OPT_X_SASL_SSF_MIN                 0x6107
160 #define LDAP_OPT_X_SASL_SSF_MAX                 0x6108
161 #define LDAP_OPT_X_SASL_MAXBUFSIZE              0x6109
162
163 /* Private API Extensions -- reserved for application use */
164 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000  /* Private API inclusive */
165
166 /*
167  * ldap_get_option() and ldap_set_option() return values.
168  * As later versions may return other values indicating
169  * failure, current applications should only compare returned
170  * value against LDAP_OPT_SUCCESS.
171  */
172 #define LDAP_OPT_SUCCESS        0
173 #define LDAP_OPT_ERROR          (-1)
174
175 /* option on/off values */
176 #define LDAP_OPT_ON             ((void *) &ber_pvt_opt_on)
177 #define LDAP_OPT_OFF    ((void *) 0)
178
179 typedef struct ldapapiinfo {
180         int             ldapai_info_version;            /* version of LDAPAPIInfo */
181 #define LDAP_API_INFO_VERSION   (1)
182         int             ldapai_api_version;                     /* revision of API supported */
183         int             ldapai_protocol_version;        /* highest LDAP version supported */
184         char    **ldapai_extensions;            /* names of API extensions */
185         char    *ldapai_vendor_name;            /* name of supplier */
186         int             ldapai_vendor_version;          /* supplier-specific version * 100 */
187 } LDAPAPIInfo;
188
189 typedef struct ldap_apifeature_info {
190         int             ldapaif_info_version;           /* version of LDAPAPIFeatureInfo */
191 #define LDAP_FEATURE_INFO_VERSION (1)   /* apifeature_info struct version */
192         char*   ldapaif_name;                           /* LDAP_API_FEATURE_* (less prefix) */
193         int             ldapaif_version;                        /* value of LDAP_API_FEATURE_... */
194 } LDAPAPIFeatureInfo;
195
196 /*
197  * LDAP Control structure
198  */
199 typedef struct ldapcontrol {
200         char *                  ldctl_oid;                      /* numericoid of control */
201         struct berval   ldctl_value;            /* encoded value of control */
202         char                    ldctl_iscritical;       /* criticality */
203 } LDAPControl;
204
205 /* LDAP Controls */
206 /*      standard track controls */
207 #define LDAP_CONTROL_MANAGEDSAIT        "2.16.840.1.113730.3.4.2"  /* RFC 3296 */
208 #define LDAP_CONTROL_PROXY_AUTHZ        "2.16.840.1.113730.3.4.18" /* RFC 4370 */
209 #define LDAP_CONTROL_SUBENTRIES         "1.3.6.1.4.1.4203.1.10.1"  /* RFC 3672 */
210
211 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
212
213 #define LDAP_CONTROL_ASSERT                             "1.3.6.1.1.12"                  /* RFC TBD */
214 #define LDAP_CONTROL_PRE_READ                   "1.3.6.1.1.13.1"                /* RFC TBD */
215 #define LDAP_CONTROL_POST_READ                  "1.3.6.1.1.13.2"                /* RFC TBD */
216
217 /*  standard track - not implemented in slapd(8) */
218 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473" /* RFC 2891 */
219 #define LDAP_CONTROL_SORTRESPONSE       "1.2.840.113556.1.4.474" /* RFC 2891 */
220
221 /*      non-standard track controls */
222 #define LDAP_CONTROL_PAGEDRESULTS       "1.2.840.113556.1.4.319"   /* RFC 2696 */
223
224 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* RFC TBD */
225 #define LDAP_SYNC_OID                   "1.3.6.1.4.1.4203.1.9.1"
226 #define LDAP_CONTROL_SYNC               LDAP_SYNC_OID ".1"
227 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
228 #define LDAP_CONTROL_SYNC_DONE  LDAP_SYNC_OID ".3"
229 #define LDAP_SYNC_INFO                  LDAP_SYNC_OID ".4"
230
231 #define LDAP_SYNC_NONE                                  0x00
232 #define LDAP_SYNC_REFRESH_ONLY                  0x01
233 #define LDAP_SYNC_RESERVED                              0x02
234 #define LDAP_SYNC_REFRESH_AND_PERSIST   0x03
235
236 #define LDAP_SYNC_REFRESH_PRESENTS              0
237 #define LDAP_SYNC_REFRESH_DELETES               1
238
239 #define LDAP_TAG_SYNC_NEW_COOKIE                ((ber_tag_t) 0x80U)
240 #define LDAP_TAG_SYNC_REFRESH_DELETE    ((ber_tag_t) 0xa1U)
241 #define LDAP_TAG_SYNC_REFRESH_PRESENT   ((ber_tag_t) 0xa2U)
242 #define LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
243
244 #define LDAP_TAG_SYNC_COOKIE                    ((ber_tag_t) 0x04U)
245 #define LDAP_TAG_REFRESHDELETES                 ((ber_tag_t) 0x01U)
246 #define LDAP_TAG_REFRESHDONE                    ((ber_tag_t) 0x01U)
247 #define LDAP_TAG_RELOAD_HINT                    ((ber_tag_t) 0x01U)
248
249 #define LDAP_SYNC_PRESENT                               0
250 #define LDAP_SYNC_ADD                                   1
251 #define LDAP_SYNC_MODIFY                                2
252 #define LDAP_SYNC_DELETE                                3
253
254
255 /* Password policy Controls *//* work in progress */
256 /* ITS#3458: released; disabled by default */
257 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST      "1.3.6.1.4.1.42.2.27.8.5.1"
258 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE     "1.3.6.1.4.1.42.2.27.8.5.1"
259
260 /* various works in progress */
261 #define LDAP_CONTROL_NOOP                               "1.3.6.1.4.1.4203.666.5.2"
262 #define LDAP_CONTROL_NO_SUBORDINATES    "1.3.6.1.4.1.4203.666.5.11"
263 #define LDAP_CONTROL_MANAGEDIT                  "1.3.6.1.4.1.4203.666.5.12"
264 #define LDAP_CONTROL_SLURP                              "1.3.6.1.4.1.4203.666.5.13"
265 #define LDAP_CONTROL_VALSORT                    "1.3.6.1.4.1.4203.666.5.14"
266 #define LDAP_CONTROL_DONTUSECOPY                "1.3.6.1.4.1.4203.666.5.15"
267
268
269 /* LDAP Chaining Behavior Control *//* work in progress */
270 /* <draft-sermersheim-ldap-chaining>;
271  * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
272 #ifdef LDAP_DEVEL
273 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR        "1.3.6.1.4.1.4203.666.11.3"
274
275 #define LDAP_CHAINING_PREFERRED                         0
276 #define LDAP_CHAINING_REQUIRED                          1
277 #define LDAP_REFERRALS_PREFERRED                        2
278 #define LDAP_REFERRALS_REQUIRED                         3
279 #endif
280
281 /* MS Active Directory controls (for compatibility) */
282 #define LDAP_CONTROL_X_INCREMENTAL_VALUES       "1.2.840.113556.1.4.802"
283 #define LDAP_CONTROL_X_DOMAIN_SCOPE                     "1.2.840.113556.1.4.1339"
284 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY        "1.2.840.113556.1.4.1413"
285 #define LDAP_CONTROL_X_SEARCH_OPTIONS           "1.2.840.113556.1.4.1340"
286 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
287 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
288
289 /* MS Active Directory controls - not implemented in slapd(8) */
290 #define LDAP_CONTROL_X_TREE_DELETE              "1.2.840.113556.1.4.805"
291 #define LDAP_CONTROL_X_EXTENDED_DN              "1.2.840.113556.1.4.529"
292
293 /* various expired works */
294 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
295 #define LDAP_CONTROL_DUPENT_REQUEST             "2.16.840.1.113719.1.27.101.1"
296 #define LDAP_CONTROL_DUPENT_RESPONSE    "2.16.840.1.113719.1.27.101.2"
297 #define LDAP_CONTROL_DUPENT_ENTRY               "2.16.840.1.113719.1.27.101.3"
298 #define LDAP_CONTROL_DUPENT     LDAP_CONTROL_DUPENT_REQUEST
299
300 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
301 #define LDAP_CONTROL_PERSIST_REQUEST                            "2.16.840.1.113730.3.4.3"
302 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE        "2.16.840.1.113730.3.4.7"
303 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD           0x1
304 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE        0x2
305 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY        0x4
306 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME        0x8
307
308 /* LDAP VLV *//* not implemented in slapd(8) */
309 #define LDAP_CONTROL_VLVREQUEST         "2.16.840.1.113730.3.4.9"
310 #define LDAP_CONTROL_VLVRESPONSE    "2.16.840.1.113730.3.4.10"
311
312
313 /* LDAP Unsolicited Notifications */
314 #define LDAP_NOTICE_OF_DISCONNECTION    "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
315 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
316
317 /* LDAP Extended Operations */
318 #define LDAP_EXOP_START_TLS             "1.3.6.1.4.1.1466.20037"        /* RFC 2830 */
319
320 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"       /* RFC 3062 */
321 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID  ((ber_tag_t) 0x80U)
322 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
323 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
324 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
325
326 #define LDAP_EXOP_CANCEL                "1.3.6.1.1.8"                           /* RFC 3909 */
327 #define LDAP_EXOP_X_CANCEL              LDAP_EXOP_CANCEL
328
329 #define LDAP_EXOP_REFRESH               "1.3.6.1.4.1.1466.101.119.1"    /* RFC 2589 */
330 #define LDAP_TAG_EXOP_REFRESH_REQ_DN    ((ber_tag_t) 0x80U)
331 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL   ((ber_tag_t) 0x81U)
332 #define LDAP_TAG_EXOP_REFRESH_RES_TTL   ((ber_tag_t) 0x80U)
333
334 #define LDAP_EXOP_WHO_AM_I              "1.3.6.1.4.1.4203.1.11.3"
335 #define LDAP_EXOP_X_WHO_AM_I    LDAP_EXOP_WHO_AM_I
336
337 /* various works in progress */
338 #ifdef LDAP_DEVEL
339 #define LDAP_EXOP_X_TURN                "1.3.6.1.4.1.4203.666.6.4"
340 #endif
341
342 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
343 /* a work in progress */
344 #ifdef LDAP_DEVEL
345 #define LDAP_X_DISTPROC_BASE            "1.3.6.1.4.1.4203.666.11.6"
346 #define LDAP_EXOP_X_CHAINEDREQUEST      LDAP_X_DISTPROC_BASE ".1"
347 #define LDAP_FEATURE_X_CANCHAINOPS      LDAP_X_DISTPROC_BASE ".2"
348 #define LDAP_CONTROL_X_RETURNCONTREF    LDAP_X_DISTPROC_BASE ".3"
349 #define LDAP_URLEXT_X_LOCALREFOID       LDAP_X_DISTPROC_BASE ".4"
350 #define LDAP_URLEXT_X_REFTYPEOID        LDAP_X_DISTPROC_BASE ".5"
351 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
352                                         LDAP_X_DISTPROC_BASE ".6"
353 #define LDAP_URLEXT_X_FAILEDNAMEOID     LDAP_X_DISTPROC_BASE ".7"
354 #define LDAP_URLEXT_X_LOCALREF          "x-localReference"
355 #define LDAP_URLEXT_X_REFTYPE           "x-referenceType"
356 #define LDAP_URLEXT_X_SEARCHEDSUBTREE   "x-searchedSubtree"
357 #define LDAP_URLEXT_X_FAILEDNAME        "x-failedName"
358 #endif
359
360 #ifdef LDAP_DEVEL
361 #define LDAP_X_TXN                                              "1.3.6.1.4.1.4203.666.11.7" /* temp */
362 #define LDAP_EXOP_X_TXN_START                   LDAP_X_TXN ".1"
363 #define LDAP_CONTROL_X_TXN_SPEC                 LDAP_X_TXN ".2"
364 #define LDAP_EXOP_X_TXN_END                             LDAP_X_TXN ".3"
365 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE  LDAP_X_TXN ".4"
366 #endif
367
368 /* LDAP Features */
369 #define LDAP_FEATURE_ALL_OP_ATTRS       "1.3.6.1.4.1.4203.1.5.1"        /* RFC 3673 */
370 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
371         "1.3.6.1.4.1.4203.1.5.2" /*  @objectClass - new number to be assigned */
372 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3"  /* (&) (|) */
373 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
374 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
375 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
376
377 #ifdef LDAP_DEVEL
378 /* LDAP Experimental (works in progress) Features */
379 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
380         "1.3.6.1.4.1.4203.666.8.1" /* "children" */
381 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
382 #endif
383
384 /*
385  * specific LDAP instantiations of BER types we know about
386  */
387
388 /* Overview of LBER tag construction
389  *
390  *      Bits
391  *      ______
392  *      8 7 | CLASS
393  *      0 0 = UNIVERSAL
394  *      0 1 = APPLICATION
395  *      1 0 = CONTEXT-SPECIFIC
396  *      1 1 = PRIVATE
397  *              _____
398  *              | 6 | DATA-TYPE
399  *                0 = PRIMITIVE
400  *                1 = CONSTRUCTED
401  *                      ___________
402  *                      | 5 ... 1 | TAG-NUMBER
403  */
404
405 /* general stuff */
406 #define LDAP_TAG_MESSAGE        ((ber_tag_t) 0x30U)     /* constructed + 16 */
407 #define LDAP_TAG_MSGID          ((ber_tag_t) 0x02U)     /* integer */
408
409 #define LDAP_TAG_LDAPDN         ((ber_tag_t) 0x04U)     /* octet string */
410 #define LDAP_TAG_LDAPCRED       ((ber_tag_t) 0x04U)     /* octet string */
411
412 #define LDAP_TAG_CONTROLS       ((ber_tag_t) 0xa0U)     /* context specific + constructed + 0 */
413 #define LDAP_TAG_REFERRAL       ((ber_tag_t) 0xa3U)     /* context specific + constructed + 3 */
414
415 #define LDAP_TAG_NEWSUPERIOR    ((ber_tag_t) 0x80U)     /* context-specific + primitive + 0 */
416
417 #define LDAP_TAG_EXOP_REQ_OID   ((ber_tag_t) 0x80U)     /* context specific + primitive */
418 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U)     /* context specific + primitive */
419 #define LDAP_TAG_EXOP_RES_OID   ((ber_tag_t) 0x8aU)     /* context specific + primitive */
420 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU)     /* context specific + primitive */
421
422 #define LDAP_TAG_IM_RES_OID   ((ber_tag_t) 0x80U)       /* context specific + primitive */
423 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U)       /* context specific + primitive */
424
425 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U)     /* context specific + primitive */
426
427 /* LDAP Request Messages */
428 #define LDAP_REQ_BIND           ((ber_tag_t) 0x60U)     /* application + constructed */
429 #define LDAP_REQ_UNBIND         ((ber_tag_t) 0x42U)     /* application + primitive   */
430 #define LDAP_REQ_SEARCH         ((ber_tag_t) 0x63U)     /* application + constructed */
431 #define LDAP_REQ_MODIFY         ((ber_tag_t) 0x66U)     /* application + constructed */
432 #define LDAP_REQ_ADD            ((ber_tag_t) 0x68U)     /* application + constructed */
433 #define LDAP_REQ_DELETE         ((ber_tag_t) 0x4aU)     /* application + primitive   */
434 #define LDAP_REQ_MODDN          ((ber_tag_t) 0x6cU)     /* application + constructed */
435 #define LDAP_REQ_MODRDN         LDAP_REQ_MODDN
436 #define LDAP_REQ_RENAME         LDAP_REQ_MODDN
437 #define LDAP_REQ_COMPARE        ((ber_tag_t) 0x6eU)     /* application + constructed */
438 #define LDAP_REQ_ABANDON        ((ber_tag_t) 0x50U)     /* application + primitive   */
439 #define LDAP_REQ_EXTENDED       ((ber_tag_t) 0x77U)     /* application + constructed */
440
441 /* LDAP Response Messages */
442 #define LDAP_RES_BIND           ((ber_tag_t) 0x61U)     /* application + constructed */
443 #define LDAP_RES_SEARCH_ENTRY   ((ber_tag_t) 0x64U)     /* application + constructed */
444 #define LDAP_RES_SEARCH_REFERENCE       ((ber_tag_t) 0x73U)     /* V3: application + constructed */
445 #define LDAP_RES_SEARCH_RESULT  ((ber_tag_t) 0x65U)     /* application + constructed */
446 #define LDAP_RES_MODIFY         ((ber_tag_t) 0x67U)     /* application + constructed */
447 #define LDAP_RES_ADD            ((ber_tag_t) 0x69U)     /* application + constructed */
448 #define LDAP_RES_DELETE         ((ber_tag_t) 0x6bU)     /* application + constructed */
449 #define LDAP_RES_MODDN          ((ber_tag_t) 0x6dU)     /* application + constructed */
450 #define LDAP_RES_MODRDN         LDAP_RES_MODDN  /* application + constructed */
451 #define LDAP_RES_RENAME         LDAP_RES_MODDN  /* application + constructed */
452 #define LDAP_RES_COMPARE        ((ber_tag_t) 0x6fU)     /* application + constructed */
453 #define LDAP_RES_EXTENDED       ((ber_tag_t) 0x78U)     /* V3: application + constructed */
454 #define LDAP_RES_INTERMEDIATE   ((ber_tag_t) 0x79U) /* V3+: application + constructed */
455
456 #define LDAP_RES_ANY                    (-1)
457 #define LDAP_RES_UNSOLICITED    (0)
458
459
460 /* sasl methods */
461 #define LDAP_SASL_SIMPLE        ((char*)0)
462 #define LDAP_SASL_NULL          ("")
463
464
465 /* authentication methods available */
466 #define LDAP_AUTH_NONE   ((ber_tag_t) 0x00U) /* no authentication */
467 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
468 #define LDAP_AUTH_SASL   ((ber_tag_t) 0xa3U) /* context specific + constructed */
469 #define LDAP_AUTH_KRBV4  ((ber_tag_t) 0xffU) /* means do both of the following */
470 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
471 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
472
473
474 /* filter types */
475 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U)     /* context specific + constructed */
476 #define LDAP_FILTER_OR  ((ber_tag_t) 0xa1U)     /* context specific + constructed */
477 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U)     /* context specific + constructed */
478 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
479 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
480 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
481 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
482 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive   */
483 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U)  /* context specific + constructed */
484 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U)     /* context specific + constructed */
485
486 /* extended filter component types */
487 #define LDAP_FILTER_EXT_OID             ((ber_tag_t) 0x81U)     /* context specific */
488 #define LDAP_FILTER_EXT_TYPE    ((ber_tag_t) 0x82U)     /* context specific */
489 #define LDAP_FILTER_EXT_VALUE   ((ber_tag_t) 0x83U)     /* context specific */
490 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U)     /* context specific */
491
492 /* substring filter component types */
493 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
494 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
495 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
496
497 /* search scopes */
498 #define LDAP_SCOPE_BASE                 ((ber_int_t) 0x0000)
499 #define LDAP_SCOPE_BASEOBJECT   LDAP_SCOPE_BASE
500 #define LDAP_SCOPE_ONELEVEL             ((ber_int_t) 0x0001)
501 #define LDAP_SCOPE_ONE                  LDAP_SCOPE_ONELEVEL
502 #define LDAP_SCOPE_SUBTREE              ((ber_int_t) 0x0002)
503 #define LDAP_SCOPE_SUB                  LDAP_SCOPE_SUBTREE
504 #define LDAP_SCOPE_SUBORDINATE  ((ber_int_t) 0x0003) /* OpenLDAP extension */
505 #define LDAP_SCOPE_CHILDREN             LDAP_SCOPE_SUBORDINATE
506 #define LDAP_SCOPE_DEFAULT              ((ber_int_t) -1)         /* OpenLDAP extension */
507
508 /* substring filter component types */
509 #define LDAP_SUBSTRING_INITIAL  ((ber_tag_t) 0x80U)     /* context specific */
510 #define LDAP_SUBSTRING_ANY              ((ber_tag_t) 0x81U)     /* context specific */
511 #define LDAP_SUBSTRING_FINAL    ((ber_tag_t) 0x82U)     /* context specific */
512
513 /*
514  * LDAP Result Codes
515  */
516 #define LDAP_SUCCESS                            0x00
517
518 #define LDAP_RANGE(n,x,y)       (((x) <= (n)) && ((n) <= (y)))
519
520 #define LDAP_OPERATIONS_ERROR           0x01
521 #define LDAP_PROTOCOL_ERROR                     0x02
522 #define LDAP_TIMELIMIT_EXCEEDED         0x03
523 #define LDAP_SIZELIMIT_EXCEEDED         0x04
524 #define LDAP_COMPARE_FALSE                      0x05
525 #define LDAP_COMPARE_TRUE                       0x06
526 #define LDAP_AUTH_METHOD_NOT_SUPPORTED  0x07
527 #define LDAP_STRONG_AUTH_NOT_SUPPORTED  LDAP_AUTH_METHOD_NOT_SUPPORTED
528 #define LDAP_STRONG_AUTH_REQUIRED       0x08
529 #define LDAP_STRONGER_AUTH_REQUIRED     LDAP_STRONG_AUTH_REQUIRED
530 #define LDAP_PARTIAL_RESULTS            0x09    /* LDAPv2+ (not LDAPv3) */
531
532 #define LDAP_REFERRAL                           0x0a /* LDAPv3 */
533 #define LDAP_ADMINLIMIT_EXCEEDED        0x0b /* LDAPv3 */
534 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION     0x0c /* LDAPv3 */
535 #define LDAP_CONFIDENTIALITY_REQUIRED   0x0d /* LDAPv3 */
536 #define LDAP_SASL_BIND_IN_PROGRESS      0x0e /* LDAPv3 */
537
538 #define LDAP_ATTR_ERROR(n)      LDAP_RANGE((n),0x10,0x15) /* 16-21 */
539
540 #define LDAP_NO_SUCH_ATTRIBUTE          0x10
541 #define LDAP_UNDEFINED_TYPE                     0x11
542 #define LDAP_INAPPROPRIATE_MATCHING     0x12
543 #define LDAP_CONSTRAINT_VIOLATION       0x13
544 #define LDAP_TYPE_OR_VALUE_EXISTS       0x14
545 #define LDAP_INVALID_SYNTAX                     0x15
546
547 #define LDAP_NAME_ERROR(n)      LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
548
549 #define LDAP_NO_SUCH_OBJECT                     0x20
550 #define LDAP_ALIAS_PROBLEM                      0x21
551 #define LDAP_INVALID_DN_SYNTAX          0x22
552 #define LDAP_IS_LEAF                            0x23 /* not LDAPv3 */
553 #define LDAP_ALIAS_DEREF_PROBLEM        0x24
554
555 #define LDAP_SECURITY_ERROR(n)  LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
556
557 #define LDAP_X_PROXY_AUTHZ_FAILURE      0x2F /* LDAPv3 proxy authorization */
558 #define LDAP_INAPPROPRIATE_AUTH         0x30
559 #define LDAP_INVALID_CREDENTIALS        0x31
560 #define LDAP_INSUFFICIENT_ACCESS        0x32
561
562 #define LDAP_SERVICE_ERROR(n)   LDAP_RANGE((n),0x33,0x36) /* 51-54 */
563
564 #define LDAP_BUSY                                       0x33
565 #define LDAP_UNAVAILABLE                        0x34
566 #define LDAP_UNWILLING_TO_PERFORM       0x35
567 #define LDAP_LOOP_DETECT                        0x36
568
569 #define LDAP_UPDATE_ERROR(n)    LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
570
571 #define LDAP_NAMING_VIOLATION           0x40
572 #define LDAP_OBJECT_CLASS_VIOLATION     0x41
573 #define LDAP_NOT_ALLOWED_ON_NONLEAF     0x42
574 #define LDAP_NOT_ALLOWED_ON_RDN         0x43
575 #define LDAP_ALREADY_EXISTS                     0x44
576 #define LDAP_NO_OBJECT_CLASS_MODS       0x45
577 #define LDAP_RESULTS_TOO_LARGE          0x46 /* CLDAP */
578 #define LDAP_AFFECTS_MULTIPLE_DSAS      0x47
579
580 #define LDAP_OTHER                                      0x50
581
582 /* LCUP operation codes (113-117) - not implemented */
583 #define LDAP_CUP_RESOURCES_EXHAUSTED    0x71
584 #define LDAP_CUP_SECURITY_VIOLATION             0x72
585 #define LDAP_CUP_INVALID_DATA                   0x73
586 #define LDAP_CUP_UNSUPPORTED_SCHEME             0x74
587 #define LDAP_CUP_RELOAD_REQUIRED                0x75
588
589 /* Cancel operation codes (118-121) */
590 #define LDAP_CANCELLED                          0x76
591 #define LDAP_NO_SUCH_OPERATION          0x77
592 #define LDAP_TOO_LATE                           0x78
593 #define LDAP_CANNOT_CANCEL                      0x79
594
595 /* Assertion control (122) */ 
596 #define LDAP_ASSERTION_FAILED           0x7A
597
598 /* Proxied Authorization Denied (123) */ 
599 #define LDAP_PROXIED_AUTHORIZATION_DENIED               0x7B
600
601 /* Experimental result codes */
602 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
603
604 /* LDAP Sync (4096) */
605 #define LDAP_SYNC_REFRESH_REQUIRED              0x1000
606
607
608 /* Private Use result codes */
609 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
610
611 #define LDAP_X_SYNC_REFRESH_REQUIRED    0x4100 /* defunct */
612 #define LDAP_X_ASSERTION_FAILED                 0x410f /* defunct */
613
614 /* for the LDAP No-Op control */
615 #define LDAP_X_NO_OPERATION                             0x410e
616
617 /* for the Chaining Behavior control (consecutive result codes requested;
618  * see <draft-sermersheim-ldap-chaining> ) */
619 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
620 #define LDAP_X_NO_REFERRALS_FOUND               0x4110
621 #define LDAP_X_CANNOT_CHAIN                     0x4111
622 #endif
623
624 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
625 #ifdef LDAP_X_DISTPROC_BASE
626 #define LDAP_X_INVALIDREFERENCE                 0x4112
627 #endif
628
629 /* API Error Codes
630  *
631  * Based on draft-ietf-ldap-c-api-xx
632  * but with new negative code values
633  */
634 #define LDAP_API_ERROR(n)               ((n)<0)
635 #define LDAP_API_RESULT(n)              ((n)<=0)
636
637 #define LDAP_SERVER_DOWN                                (-1)
638 #define LDAP_LOCAL_ERROR                                (-2)
639 #define LDAP_ENCODING_ERROR                             (-3)
640 #define LDAP_DECODING_ERROR                             (-4)
641 #define LDAP_TIMEOUT                                    (-5)
642 #define LDAP_AUTH_UNKNOWN                               (-6)
643 #define LDAP_FILTER_ERROR                               (-7)
644 #define LDAP_USER_CANCELLED                             (-8)
645 #define LDAP_PARAM_ERROR                                (-9)
646 #define LDAP_NO_MEMORY                                  (-10)
647 #define LDAP_CONNECT_ERROR                              (-11)
648 #define LDAP_NOT_SUPPORTED                              (-12)
649 #define LDAP_CONTROL_NOT_FOUND                  (-13)
650 #define LDAP_NO_RESULTS_RETURNED                (-14)
651 #define LDAP_MORE_RESULTS_TO_RETURN             (-15)   /* Obsolete */
652 #define LDAP_CLIENT_LOOP                                (-16)
653 #define LDAP_REFERRAL_LIMIT_EXCEEDED    (-17)
654
655
656 /*
657  * This structure represents both ldap messages and ldap responses.
658  * These are really the same, except in the case of search responses,
659  * where a response has multiple messages.
660  */
661
662 typedef struct ldapmsg LDAPMessage;
663
664 /* for modifications */
665 typedef struct ldapmod {
666         int             mod_op;
667
668 #define LDAP_MOD_OP                     (0x0007)
669 #define LDAP_MOD_ADD            (0x0000)
670 #define LDAP_MOD_DELETE         (0x0001)
671 #define LDAP_MOD_REPLACE        (0x0002)
672 #define LDAP_MOD_INCREMENT      (0x0003) /* OpenLDAP extension */
673 #define LDAP_MOD_BVALUES        (0x0080)
674 /* IMPORTANT: do not use code 0x1000 (or above),
675  * it is used internally by the backends!
676  * (see ldap/servers/slapd/slap.h)
677  */
678
679         char            *mod_type;
680         union mod_vals_u {
681                 char            **modv_strvals;
682                 struct berval   **modv_bvals;
683         } mod_vals;
684 #define mod_values      mod_vals.modv_strvals
685 #define mod_bvalues     mod_vals.modv_bvals
686 } LDAPMod;
687
688 /*
689  * structure representing an ldap session which can
690  * encompass connections to multiple servers (in the
691  * face of referrals).
692  */
693 typedef struct ldap LDAP;
694
695 #define LDAP_DEREF_NEVER                0x00
696 #define LDAP_DEREF_SEARCHING    0x01
697 #define LDAP_DEREF_FINDING              0x02
698 #define LDAP_DEREF_ALWAYS               0x03
699
700 #define LDAP_NO_LIMIT                   0
701
702 /* how many messages to retrieve results for */
703 #define LDAP_MSG_ONE                    0x00
704 #define LDAP_MSG_ALL                    0x01
705 #define LDAP_MSG_RECEIVED               0x02
706
707 /*
708  * types for ldap URL handling
709  */
710 typedef struct ldap_url_desc {
711         struct ldap_url_desc *lud_next;
712         char    *lud_scheme;
713         char    *lud_host;
714         int             lud_port;
715         char    *lud_dn;
716         char    **lud_attrs;
717         int             lud_scope;
718         char    *lud_filter;
719         char    **lud_exts;
720         int             lud_crit_exts;
721 } LDAPURLDesc;
722
723 #define LDAP_URL_SUCCESS                0x00    /* Success */
724 #define LDAP_URL_ERR_MEM                0x01    /* can't allocate memory space */
725 #define LDAP_URL_ERR_PARAM              0x02    /* parameter is bad */
726
727 #define LDAP_URL_ERR_BADSCHEME  0x03    /* URL doesn't begin with "ldap[si]://" */
728 #define LDAP_URL_ERR_BADENCLOSURE 0x04  /* URL is missing trailing ">" */
729 #define LDAP_URL_ERR_BADURL             0x05    /* URL is bad */
730 #define LDAP_URL_ERR_BADHOST    0x06    /* host port is bad */
731 #define LDAP_URL_ERR_BADATTRS   0x07    /* bad (or missing) attributes */
732 #define LDAP_URL_ERR_BADSCOPE   0x08    /* scope string is invalid (or missing) */
733 #define LDAP_URL_ERR_BADFILTER  0x09    /* bad or missing filter */
734 #define LDAP_URL_ERR_BADEXTS    0x0a    /* bad or missing extensions */
735
736 /*
737  * The API draft spec says we should declare (or cause to be declared)
738  * 'struct timeval'.   We don't.  See IETF LDAPext discussions.
739  */
740 struct timeval;
741
742 /*
743  * in options.c:
744  */
745 LDAP_F( int )
746 ldap_get_option LDAP_P((
747         LDAP *ld,
748         int option,
749         void *outvalue));
750
751 LDAP_F( int )
752 ldap_set_option LDAP_P((
753         LDAP *ld,
754         int option,
755         LDAP_CONST void *invalue));
756
757 /* V3 REBIND Function Callback Prototype */
758 typedef int (LDAP_REBIND_PROC) LDAP_P((
759         LDAP *ld, LDAP_CONST char *url,
760         ber_tag_t request, ber_int_t msgid,
761         void *params ));
762
763 LDAP_F( int )
764 ldap_set_rebind_proc LDAP_P((
765         LDAP *ld,
766         LDAP_REBIND_PROC *rebind_proc,
767         void *params ));
768
769 /* V3 referral selection Function Callback Prototype */
770 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
771         LDAP *ld, char ***refsp, int *cntp,
772         void *params ));
773
774 LDAP_F( int )
775 ldap_set_nextref_proc LDAP_P((
776         LDAP *ld,
777         LDAP_NEXTREF_PROC *nextref_proc,
778         void *params ));
779
780 /*
781  * in controls.c:
782  */
783 LDAP_F( int )
784 ldap_create_control LDAP_P((
785         LDAP_CONST char *requestOID,
786         BerElement *ber,
787         int iscritical,
788         LDAPControl **ctrlp ));
789
790 LDAP_F( LDAPControl * )
791 ldap_find_control LDAP_P((
792         LDAP_CONST char *oid,
793         LDAPControl **ctrls ));
794
795 LDAP_F( void )
796 ldap_control_free LDAP_P((
797         LDAPControl *ctrl ));
798
799 LDAP_F( void )
800 ldap_controls_free LDAP_P((
801         LDAPControl **ctrls ));
802
803 /*
804  * in dnssrv.c:
805  */
806 LDAP_F( int )
807 ldap_domain2dn LDAP_P((
808         LDAP_CONST char* domain,
809         char** dn ));
810
811 LDAP_F( int )
812 ldap_dn2domain LDAP_P((
813         LDAP_CONST char* dn,
814         char** domain ));
815
816 LDAP_F( int )
817 ldap_domain2hostlist LDAP_P((
818         LDAP_CONST char *domain,
819         char** hostlist ));
820
821 /*
822  * in extended.c:
823  */
824 LDAP_F( int )
825 ldap_extended_operation LDAP_P((
826         LDAP                    *ld,
827         LDAP_CONST char *reqoid,
828         struct berval   *reqdata,
829         LDAPControl             **serverctrls,
830         LDAPControl             **clientctrls,
831         int                             *msgidp ));
832
833 LDAP_F( int )
834 ldap_extended_operation_s LDAP_P((
835         LDAP                    *ld,
836         LDAP_CONST char *reqoid,
837         struct berval   *reqdata,
838         LDAPControl             **serverctrls,
839         LDAPControl             **clientctrls,
840         char                    **retoidp,
841         struct berval   **retdatap ));
842
843 LDAP_F( int )
844 ldap_parse_extended_result LDAP_P((
845         LDAP                    *ld,
846         LDAPMessage             *res,
847         char                    **retoidp,
848         struct berval   **retdatap,
849         int                             freeit ));
850
851 LDAP_F( int )
852 ldap_parse_intermediate LDAP_P((
853         LDAP                    *ld,
854         LDAPMessage             *res,
855         char                    **retoidp,
856         struct berval   **retdatap,
857         LDAPControl             ***serverctrls,
858         int                             freeit ));
859
860
861 /*
862  * in abandon.c:
863  */
864 LDAP_F( int )
865 ldap_abandon_ext LDAP_P((
866         LDAP                    *ld,
867         int                             msgid,
868         LDAPControl             **serverctrls,
869         LDAPControl             **clientctrls ));
870
871 #if LDAP_DEPRECATED
872 LDAP_F( int )
873 ldap_abandon LDAP_P((   /* deprecated */
874         LDAP *ld,
875         int msgid ));
876 #endif
877
878 /*
879  * in add.c:
880  */
881 LDAP_F( int )
882 ldap_add_ext LDAP_P((
883         LDAP                    *ld,
884         LDAP_CONST char *dn,
885         LDAPMod                 **attrs,
886         LDAPControl             **serverctrls,
887         LDAPControl             **clientctrls,
888         int                     *msgidp ));
889
890 LDAP_F( int )
891 ldap_add_ext_s LDAP_P((
892         LDAP                    *ld,
893         LDAP_CONST char *dn,
894         LDAPMod                 **attrs,
895         LDAPControl             **serverctrls,
896         LDAPControl             **clientctrls ));
897
898 #if LDAP_DEPRECATED
899 LDAP_F( int )
900 ldap_add LDAP_P((       /* deprecated */
901         LDAP *ld,
902         LDAP_CONST char *dn,
903         LDAPMod **attrs ));
904
905 LDAP_F( int )
906 ldap_add_s LDAP_P((     /* deprecated */
907         LDAP *ld,
908         LDAP_CONST char *dn,
909         LDAPMod **attrs ));
910 #endif
911
912
913 /*
914  * in sasl.c:
915  */
916 LDAP_F( int )
917 ldap_sasl_bind LDAP_P((
918         LDAP                    *ld,
919         LDAP_CONST char *dn,
920         LDAP_CONST char *mechanism,
921         struct berval   *cred,
922         LDAPControl             **serverctrls,
923         LDAPControl             **clientctrls,
924         int                             *msgidp ));
925
926 /* Interaction flags (should be passed about in a control)
927  *  Automatic (default): use defaults, prompt otherwise
928  *  Interactive: prompt always
929  *  Quiet: never prompt
930  */
931 #define LDAP_SASL_AUTOMATIC             0U
932 #define LDAP_SASL_INTERACTIVE   1U
933 #define LDAP_SASL_QUIET                 2U
934
935 /*
936  * V3 SASL Interaction Function Callback Prototype
937  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
938  *  should likely passed in a control (and provided controls)
939  */
940 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
941         LDAP *ld, unsigned flags, void* defaults, void *interact ));
942
943 LDAP_F( int )
944 ldap_sasl_interactive_bind_s LDAP_P((
945         LDAP *ld,
946         LDAP_CONST char *dn, /* usually NULL */
947         LDAP_CONST char *saslMechanism,
948         LDAPControl **serverControls,
949         LDAPControl **clientControls,
950
951         /* should be client controls */
952         unsigned flags,
953         LDAP_SASL_INTERACT_PROC *proc,
954         void *defaults ));
955
956 LDAP_F( int )
957 ldap_sasl_bind_s LDAP_P((
958         LDAP                    *ld,
959         LDAP_CONST char *dn,
960         LDAP_CONST char *mechanism,
961         struct berval   *cred,
962         LDAPControl             **serverctrls,
963         LDAPControl             **clientctrls,
964         struct berval   **servercredp ));
965
966 LDAP_F( int )
967 ldap_parse_sasl_bind_result LDAP_P((
968         LDAP                    *ld,
969         LDAPMessage             *res,
970         struct berval   **servercredp,
971         int                             freeit ));
972
973 #if LDAP_DEPRECATED
974 /*
975  * in bind.c:
976  *      (deprecated)
977  */
978 LDAP_F( int )
979 ldap_bind LDAP_P((      /* deprecated */
980         LDAP *ld,
981         LDAP_CONST char *who,
982         LDAP_CONST char *passwd,
983         int authmethod ));
984
985 LDAP_F( int )
986 ldap_bind_s LDAP_P((    /* deprecated */
987         LDAP *ld,
988         LDAP_CONST char *who,
989         LDAP_CONST char *cred,
990         int authmethod ));
991
992 /*
993  * in sbind.c:
994  */
995 LDAP_F( int )
996 ldap_simple_bind LDAP_P(( /* deprecated */
997         LDAP *ld,
998         LDAP_CONST char *who,
999         LDAP_CONST char *passwd ));
1000
1001 LDAP_F( int )
1002 ldap_simple_bind_s LDAP_P(( /* deprecated */
1003         LDAP *ld,
1004         LDAP_CONST char *who,
1005         LDAP_CONST char *passwd ));
1006
1007
1008 /*
1009  * in kbind.c:
1010  *      (deprecated)
1011  */
1012 LDAP_F( int )
1013 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
1014         LDAP *ld,
1015         LDAP_CONST char *who ));
1016
1017 LDAP_F( int )
1018 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
1019         LDAP *ld,
1020         LDAP_CONST char *who ));
1021
1022 LDAP_F( int )
1023 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
1024         LDAP *ld,
1025         LDAP_CONST char *who ));
1026
1027 LDAP_F( int )
1028 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
1029         LDAP *ld,
1030         LDAP_CONST char *who ));
1031
1032 LDAP_F( int )
1033 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
1034         LDAP *ld,
1035         LDAP_CONST char *who ));
1036 #endif
1037
1038
1039 /*
1040  * in compare.c:
1041  */
1042 LDAP_F( int )
1043 ldap_compare_ext LDAP_P((
1044         LDAP                    *ld,
1045         LDAP_CONST char *dn,
1046         LDAP_CONST char *attr,
1047         struct berval   *bvalue,
1048         LDAPControl             **serverctrls,
1049         LDAPControl             **clientctrls,
1050         int                     *msgidp ));
1051
1052 LDAP_F( int )
1053 ldap_compare_ext_s LDAP_P((
1054         LDAP                    *ld,
1055         LDAP_CONST char *dn,
1056         LDAP_CONST char *attr,
1057         struct berval   *bvalue,
1058         LDAPControl             **serverctrls,
1059         LDAPControl             **clientctrls ));
1060
1061 #if LDAP_DEPRECATED
1062 LDAP_F( int )
1063 ldap_compare LDAP_P((   /* deprecated */
1064         LDAP *ld,
1065         LDAP_CONST char *dn,
1066         LDAP_CONST char *attr,
1067         LDAP_CONST char *value ));
1068
1069 LDAP_F( int )
1070 ldap_compare_s LDAP_P(( /* deprecated */
1071         LDAP *ld,
1072         LDAP_CONST char *dn,
1073         LDAP_CONST char *attr,
1074         LDAP_CONST char *value ));
1075 #endif
1076
1077
1078 /*
1079  * in delete.c:
1080  */
1081 LDAP_F( int )
1082 ldap_delete_ext LDAP_P((
1083         LDAP                    *ld,
1084         LDAP_CONST char *dn,
1085         LDAPControl             **serverctrls,
1086         LDAPControl             **clientctrls,
1087         int                     *msgidp ));
1088
1089 LDAP_F( int )
1090 ldap_delete_ext_s LDAP_P((
1091         LDAP                    *ld,
1092         LDAP_CONST char *dn,
1093         LDAPControl             **serverctrls,
1094         LDAPControl             **clientctrls ));
1095
1096 #if LDAP_DEPRECATED
1097 LDAP_F( int )
1098 ldap_delete LDAP_P((    /* deprecated */
1099         LDAP *ld,
1100         LDAP_CONST char *dn ));
1101
1102 LDAP_F( int )
1103 ldap_delete_s LDAP_P((  /* deprecated */
1104         LDAP *ld,
1105         LDAP_CONST char *dn ));
1106 #endif
1107
1108
1109 /*
1110  * in error.c:
1111  */
1112 LDAP_F( int )
1113 ldap_parse_result LDAP_P((
1114         LDAP                    *ld,
1115         LDAPMessage             *res,
1116         int                             *errcodep,
1117         char                    **matcheddnp,
1118         char                    **errmsgp,
1119         char                    ***referralsp,
1120         LDAPControl             ***serverctrls,
1121         int                             freeit ));
1122
1123 LDAP_F( char * )
1124 ldap_err2string LDAP_P((
1125         int err ));
1126
1127 #if LDAP_DEPRECATED
1128 LDAP_F( int )
1129 ldap_result2error LDAP_P((      /* deprecated */
1130         LDAP *ld,
1131         LDAPMessage *r,
1132         int freeit ));
1133
1134 LDAP_F( void )
1135 ldap_perror LDAP_P((    /* deprecated */
1136         LDAP *ld,
1137         LDAP_CONST char *s ));
1138 #endif
1139
1140
1141 /*
1142  * in modify.c:
1143  */
1144 LDAP_F( int )
1145 ldap_modify_ext LDAP_P((
1146         LDAP                    *ld,
1147         LDAP_CONST char *dn,
1148         LDAPMod                 **mods,
1149         LDAPControl             **serverctrls,
1150         LDAPControl             **clientctrls,
1151         int                     *msgidp ));
1152
1153 LDAP_F( int )
1154 ldap_modify_ext_s LDAP_P((
1155         LDAP                    *ld,
1156         LDAP_CONST char *dn,
1157         LDAPMod                 **mods,
1158         LDAPControl             **serverctrls,
1159         LDAPControl             **clientctrls ));
1160
1161 #if LDAP_DEPRECATED
1162 LDAP_F( int )
1163 ldap_modify LDAP_P((    /* deprecated */
1164         LDAP *ld,
1165         LDAP_CONST char *dn,
1166         LDAPMod **mods ));
1167
1168 LDAP_F( int )
1169 ldap_modify_s LDAP_P((  /* deprecated */
1170         LDAP *ld,
1171         LDAP_CONST char *dn,
1172         LDAPMod **mods ));
1173 #endif
1174
1175
1176 /*
1177  * in modrdn.c:
1178  */
1179 LDAP_F( int )
1180 ldap_rename LDAP_P((
1181         LDAP *ld,
1182         LDAP_CONST char *dn,
1183         LDAP_CONST char *newrdn,
1184         LDAP_CONST char *newSuperior,
1185         int deleteoldrdn,
1186         LDAPControl **sctrls,
1187         LDAPControl **cctrls,
1188         int *msgidp ));
1189
1190 LDAP_F( int )
1191 ldap_rename_s LDAP_P((
1192         LDAP *ld,
1193         LDAP_CONST char *dn,
1194         LDAP_CONST char *newrdn,
1195         LDAP_CONST char *newSuperior,
1196         int deleteoldrdn,
1197         LDAPControl **sctrls,
1198         LDAPControl **cctrls ));
1199
1200 #if LDAP_DEPRECATED
1201 LDAP_F( int )
1202 ldap_rename2 LDAP_P((   /* deprecated */
1203         LDAP *ld,
1204         LDAP_CONST char *dn,
1205         LDAP_CONST char *newrdn,
1206         LDAP_CONST char *newSuperior,
1207         int deleteoldrdn ));
1208
1209 LDAP_F( int )
1210 ldap_rename2_s LDAP_P(( /* deprecated */
1211         LDAP *ld,
1212         LDAP_CONST char *dn,
1213         LDAP_CONST char *newrdn,
1214         LDAP_CONST char *newSuperior,
1215         int deleteoldrdn ));
1216
1217 LDAP_F( int )
1218 ldap_modrdn LDAP_P((    /* deprecated */
1219         LDAP *ld,
1220         LDAP_CONST char *dn,
1221         LDAP_CONST char *newrdn ));
1222
1223 LDAP_F( int )
1224 ldap_modrdn_s LDAP_P((  /* deprecated */
1225         LDAP *ld,
1226         LDAP_CONST char *dn,
1227         LDAP_CONST char *newrdn ));
1228
1229 LDAP_F( int )
1230 ldap_modrdn2 LDAP_P((   /* deprecated */
1231         LDAP *ld,
1232         LDAP_CONST char *dn,
1233         LDAP_CONST char *newrdn,
1234         int deleteoldrdn ));
1235
1236 LDAP_F( int )
1237 ldap_modrdn2_s LDAP_P(( /* deprecated */
1238         LDAP *ld,
1239         LDAP_CONST char *dn,
1240         LDAP_CONST char *newrdn,
1241         int deleteoldrdn));
1242 #endif
1243
1244
1245 /*
1246  * in open.c:
1247  */
1248 #if LDAP_DEPRECATED
1249 LDAP_F( LDAP * )
1250 ldap_init LDAP_P(( /* deprecated */
1251         LDAP_CONST char *host,
1252         int port ));
1253
1254 LDAP_F( LDAP * )
1255 ldap_open LDAP_P((      /* deprecated */
1256         LDAP_CONST char *host,
1257         int port ));
1258 #endif
1259
1260 LDAP_F( int )
1261 ldap_create LDAP_P((
1262         LDAP **ldp ));
1263
1264 LDAP_F( int )
1265 ldap_initialize LDAP_P((
1266         LDAP **ldp,
1267         LDAP_CONST char *url ));
1268
1269 /*
1270  * in tls.c
1271  */
1272
1273 LDAP_F( int )
1274 ldap_tls_inplace LDAP_P((
1275         LDAP *ld ));
1276
1277 LDAP_F( int )
1278 ldap_start_tls LDAP_P((
1279         LDAP *ld,
1280         LDAPControl **serverctrls,
1281         LDAPControl **clientctrls,
1282         int *msgidp ));
1283
1284 LDAP_F( int )
1285 ldap_install_tls LDAP_P((
1286         LDAP *ld ));
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_bv2escaped_filter_value LDAP_P(( 
1600         struct berval *in, 
1601         struct berval *out ));
1602
1603 LDAP_F( int )
1604 ldap_search_ext LDAP_P((
1605         LDAP                    *ld,
1606         LDAP_CONST char *base,
1607         int                             scope,
1608         LDAP_CONST char *filter,
1609         char                    **attrs,
1610         int                             attrsonly,
1611         LDAPControl             **serverctrls,
1612         LDAPControl             **clientctrls,
1613         struct timeval  *timeout,
1614         int                             sizelimit,
1615         int                             *msgidp ));
1616
1617 LDAP_F( int )
1618 ldap_search_ext_s LDAP_P((
1619         LDAP                    *ld,
1620         LDAP_CONST char *base,
1621         int                             scope,
1622         LDAP_CONST char *filter,
1623         char                    **attrs,
1624         int                             attrsonly,
1625         LDAPControl             **serverctrls,
1626         LDAPControl             **clientctrls,
1627         struct timeval  *timeout,
1628         int                             sizelimit,
1629         LDAPMessage             **res ));
1630
1631 #if LDAP_DEPRECATED
1632 LDAP_F( int )
1633 ldap_search LDAP_P((    /* deprecated */
1634         LDAP *ld,
1635         LDAP_CONST char *base,
1636         int scope,
1637         LDAP_CONST char *filter,
1638         char **attrs,
1639         int attrsonly ));
1640
1641 LDAP_F( int )
1642 ldap_search_s LDAP_P((  /* deprecated */
1643         LDAP *ld,
1644         LDAP_CONST char *base,
1645         int scope,
1646         LDAP_CONST char *filter,
1647         char **attrs,
1648         int attrsonly,
1649         LDAPMessage **res ));
1650
1651 LDAP_F( int )
1652 ldap_search_st LDAP_P(( /* deprecated */
1653         LDAP *ld,
1654         LDAP_CONST char *base,
1655         int scope,
1656         LDAP_CONST char *filter,
1657     char **attrs,
1658         int attrsonly,
1659         struct timeval *timeout,
1660         LDAPMessage **res ));
1661 #endif
1662
1663 /*
1664  * in unbind.c
1665  */
1666 LDAP_F( int )
1667 ldap_unbind_ext LDAP_P((
1668         LDAP                    *ld,
1669         LDAPControl             **serverctrls,
1670         LDAPControl             **clientctrls));
1671
1672 LDAP_F( int )
1673 ldap_unbind_ext_s LDAP_P((
1674         LDAP                    *ld,
1675         LDAPControl             **serverctrls,
1676         LDAPControl             **clientctrls));
1677
1678 #if LDAP_DEPRECATED
1679 LDAP_F( int )
1680 ldap_unbind LDAP_P(( /* deprecated */
1681         LDAP *ld ));
1682
1683 LDAP_F( int )
1684 ldap_unbind_s LDAP_P(( /* deprecated */
1685         LDAP *ld ));
1686 #endif
1687
1688 /*
1689  * in filter.c
1690  */
1691 LDAP_F( int )
1692 ldap_put_vrFilter LDAP_P((
1693         BerElement *ber,
1694         const char *vrf ));
1695
1696 /*
1697  * in free.c
1698  */
1699
1700 LDAP_F( void * )
1701 ldap_memalloc LDAP_P((
1702         ber_len_t s ));
1703
1704 LDAP_F( void * )
1705 ldap_memrealloc LDAP_P((
1706         void* p,
1707         ber_len_t s ));
1708
1709 LDAP_F( void * )
1710 ldap_memcalloc LDAP_P((
1711         ber_len_t n,
1712         ber_len_t s ));
1713
1714 LDAP_F( void )
1715 ldap_memfree LDAP_P((
1716         void* p ));
1717
1718 LDAP_F( void )
1719 ldap_memvfree LDAP_P((
1720         void** v ));
1721
1722 LDAP_F( char * )
1723 ldap_strdup LDAP_P((
1724         LDAP_CONST char * ));
1725
1726 LDAP_F( void )
1727 ldap_mods_free LDAP_P((
1728         LDAPMod **mods,
1729         int freemods ));
1730
1731
1732 #if LDAP_DEPRECATED
1733 /*
1734  * in sort.c (deprecated)
1735  */
1736 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1737         LDAP_CONST char *left,
1738         LDAP_CONST char *right ));
1739
1740 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1741         LDAP_CONST void *left,
1742         LDAP_CONST void *right ));
1743
1744 LDAP_F( int )   /* deprecated */
1745 ldap_sort_entries LDAP_P(( LDAP *ld,
1746         LDAPMessage **chain,
1747         LDAP_CONST char *attr,
1748         LDAP_SORT_AD_CMP_PROC *cmp ));
1749
1750 LDAP_F( int )   /* deprecated */
1751 ldap_sort_values LDAP_P((
1752         LDAP *ld,
1753         char **vals,
1754         LDAP_SORT_AV_CMP_PROC *cmp ));
1755
1756 LDAP_F( int ) /* deprecated */
1757 ldap_sort_strcasecmp LDAP_P((
1758         LDAP_CONST void *a,
1759         LDAP_CONST void *b ));
1760 #endif
1761
1762 /*
1763  * in url.c
1764  */
1765 LDAP_F( int )
1766 ldap_is_ldap_url LDAP_P((
1767         LDAP_CONST char *url ));
1768
1769 LDAP_F( int )
1770 ldap_is_ldaps_url LDAP_P((
1771         LDAP_CONST char *url ));
1772
1773 LDAP_F( int )
1774 ldap_is_ldapi_url LDAP_P((
1775         LDAP_CONST char *url ));
1776
1777 LDAP_F( int )
1778 ldap_url_parse LDAP_P((
1779         LDAP_CONST char *url,
1780         LDAPURLDesc **ludpp ));
1781
1782 LDAP_F( char * )
1783 ldap_url_desc2str LDAP_P((
1784         LDAPURLDesc *ludp ));
1785
1786 LDAP_F( void )
1787 ldap_free_urldesc LDAP_P((
1788         LDAPURLDesc *ludp ));
1789
1790
1791 /*
1792  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1793  *  in cancel.c
1794  */
1795 #define LDAP_API_FEATURE_CANCEL 1000
1796
1797 LDAP_F( int )
1798 ldap_cancel LDAP_P(( LDAP *ld,
1799         int cancelid,
1800         LDAPControl             **sctrls,
1801         LDAPControl             **cctrls,
1802         int                             *msgidp ));
1803
1804 LDAP_F( int )
1805 ldap_cancel_s LDAP_P(( LDAP *ld,
1806         int cancelid,
1807         LDAPControl **sctrl,
1808         LDAPControl **cctrl ));
1809
1810 /*
1811  * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1812  *  in turn.c
1813  */
1814 #define LDAP_API_FEATURE_TURN 1000
1815
1816 LDAP_F( int )
1817 ldap_turn LDAP_P(( LDAP *ld,
1818         int mutual,
1819         LDAP_CONST char* identifier,
1820         LDAPControl             **sctrls,
1821         LDAPControl             **cctrls,
1822         int                             *msgidp ));
1823
1824 LDAP_F( int )
1825 ldap_turn_s LDAP_P(( LDAP *ld,
1826         int mutual,
1827         LDAP_CONST char* identifier,
1828         LDAPControl **sctrl,
1829         LDAPControl **cctrl ));
1830
1831 /*
1832  * LDAP Paged Results
1833  *      in pagectrl.c
1834  */
1835 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1836
1837 LDAP_F( int )
1838 ldap_create_page_control_value LDAP_P((
1839         LDAP *ld,
1840         ber_int_t pagesize,
1841         struct berval *cookie,
1842         struct berval *value ));
1843
1844 LDAP_F( int )
1845 ldap_create_page_control LDAP_P((
1846         LDAP *ld,
1847         ber_int_t pagesize,
1848         struct berval *cookie,
1849         int iscritical,
1850         LDAPControl **ctrlp ));
1851
1852 #if LDAP_DEPRECATED
1853 LDAP_F( int )
1854 ldap_parse_page_control LDAP_P((
1855         LDAP *ld,
1856         LDAPControl **ctrls,
1857         ber_int_t *count,
1858         struct berval **cookie ));
1859 #endif
1860
1861 LDAP_F( int )
1862 ldap_parse_pageresponse_control LDAP_P((
1863         LDAP *ld,
1864         LDAPControl *ctrl,
1865         ber_int_t *count,
1866         struct berval *cookie ));
1867
1868 /*
1869  * LDAP Server Side Sort
1870  *      in sortctrl.c
1871  */
1872 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1873
1874 /* structure for a sort-key */
1875 typedef struct ldapsortkey {
1876         char *attributeType;
1877         char *orderingRule;
1878         int reverseOrder;
1879 } LDAPSortKey;
1880
1881 LDAP_F( int )
1882 ldap_create_sort_keylist LDAP_P((
1883         LDAPSortKey ***sortKeyList,
1884         char *keyString ));
1885
1886 LDAP_F( void )
1887 ldap_free_sort_keylist LDAP_P((
1888         LDAPSortKey **sortkeylist ));
1889
1890 LDAP_F( int )
1891 ldap_create_sort_control_value LDAP_P((
1892         LDAP *ld,
1893         LDAPSortKey **keyList,
1894         struct berval *value ));
1895
1896 LDAP_F( int )
1897 ldap_create_sort_control LDAP_P((
1898         LDAP *ld,
1899         LDAPSortKey **keyList,
1900         int iscritical,
1901         LDAPControl **ctrlp ));
1902
1903 LDAP_F( int )
1904 ldap_parse_sortresponse_control LDAP_P((
1905         LDAP *ld,
1906         LDAPControl *ctrl,
1907         ber_int_t *result,
1908         char **attribute ));
1909
1910 /*
1911  * LDAP Virtual List View
1912  *      in vlvctrl.c
1913  */
1914 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1915
1916 /* structure for virtual list */
1917 typedef struct ldapvlvinfo {
1918         ber_int_t ldvlv_version;
1919     ber_int_t ldvlv_before_count;
1920     ber_int_t ldvlv_after_count;
1921     ber_int_t ldvlv_offset;
1922     ber_int_t ldvlv_count;
1923     struct berval *     ldvlv_attrvalue;
1924     struct berval *     ldvlv_context;
1925     void *                      ldvlv_extradata;
1926 } LDAPVLVInfo;
1927
1928 LDAP_F( int )
1929 ldap_create_vlv_control_value LDAP_P((
1930         LDAP *ld,
1931         LDAPVLVInfo *ldvlistp,
1932         struct berval *value));
1933
1934 LDAP_F( int )
1935 ldap_create_vlv_control LDAP_P((
1936         LDAP *ld,
1937         LDAPVLVInfo *ldvlistp,
1938         LDAPControl **ctrlp ));
1939
1940 LDAP_F( int )
1941 ldap_parse_vlvresponse_control LDAP_P((
1942         LDAP          *ld,
1943         LDAPControl   *ctrls,
1944         ber_int_t *target_posp,
1945         ber_int_t *list_countp,
1946         struct berval **contextp,
1947         int           *errcodep ));
1948
1949 /*
1950  * LDAP Who Am I?
1951  *      in whoami.c
1952  */
1953 #define LDAP_API_FEATURE_WHOAMI 1000
1954
1955 LDAP_F( int )
1956 ldap_parse_whoami LDAP_P((
1957         LDAP *ld,
1958         LDAPMessage *res,
1959         struct berval **authzid ));
1960
1961 LDAP_F( int )
1962 ldap_whoami LDAP_P(( LDAP *ld,
1963         LDAPControl             **sctrls,
1964         LDAPControl             **cctrls,
1965         int                             *msgidp ));
1966
1967 LDAP_F( int )
1968 ldap_whoami_s LDAP_P((
1969         LDAP *ld,
1970         struct berval **authzid,
1971         LDAPControl **sctrls,
1972         LDAPControl **cctrls ));
1973
1974 /*
1975  * LDAP Password Modify
1976  *      in passwd.c
1977  */
1978 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1979
1980 LDAP_F( int )
1981 ldap_parse_passwd LDAP_P((
1982         LDAP *ld,
1983         LDAPMessage *res,
1984         struct berval *newpasswd ));
1985
1986 LDAP_F( int )
1987 ldap_passwd LDAP_P(( LDAP *ld,
1988         struct berval   *user,
1989         struct berval   *oldpw,
1990         struct berval   *newpw,
1991         LDAPControl             **sctrls,
1992         LDAPControl             **cctrls,
1993         int                             *msgidp ));
1994
1995 LDAP_F( int )
1996 ldap_passwd_s LDAP_P((
1997         LDAP *ld,
1998         struct berval   *user,
1999         struct berval   *oldpw,
2000         struct berval   *newpw,
2001         struct berval *newpasswd,
2002         LDAPControl **sctrls,
2003         LDAPControl **cctrls ));
2004
2005 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2006 /*
2007  * LDAP Password Policy controls
2008  *      in ppolicy.c
2009  */
2010 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2011
2012 typedef enum passpolicyerror_enum {
2013        PP_passwordExpired = 0,
2014        PP_accountLocked = 1,
2015        PP_changeAfterReset = 2,
2016        PP_passwordModNotAllowed = 3,
2017        PP_mustSupplyOldPassword = 4,
2018        PP_insufficientPasswordQuality = 5,
2019        PP_passwordTooShort = 6,
2020        PP_passwordTooYoung = 7,
2021        PP_passwordInHistory = 8,
2022        PP_noError = 65535
2023 } LDAPPasswordPolicyError;
2024
2025 LDAP_F( int )
2026 ldap_create_passwordpolicy_control LDAP_P((
2027         LDAP *ld,
2028         LDAPControl **ctrlp ));
2029
2030 LDAP_F( int )
2031 ldap_parse_passwordpolicy_control LDAP_P((
2032         LDAP *ld,
2033         LDAPControl *ctrl,
2034         ber_int_t *expirep,
2035         ber_int_t *gracep,
2036         LDAPPasswordPolicyError *errorp ));
2037
2038 LDAP_F( const char * )
2039 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2040 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2041
2042 /*
2043  * LDAP Dynamic Directory Services Refresh RFC2589
2044  *      in dds.c
2045  */
2046 #define LDAP_API_FEATURE_REFRESH 1000
2047
2048 LDAP_F( int )
2049 ldap_parse_refresh LDAP_P((
2050         LDAP *ld,
2051         LDAPMessage *res,
2052         ber_int_t *newttl ));
2053
2054 LDAP_F( int )
2055 ldap_refresh LDAP_P(( LDAP *ld,
2056         struct berval   *dn,
2057         ber_int_t ttl,
2058         LDAPControl             **sctrls,
2059         LDAPControl             **cctrls,
2060         int                             *msgidp ));
2061
2062 LDAP_F( int )
2063 ldap_refresh_s LDAP_P((
2064         LDAP *ld,
2065         struct berval   *dn,
2066         ber_int_t ttl,
2067         ber_int_t *newttl,
2068         LDAPControl **sctrls,
2069         LDAPControl **cctrls ));
2070
2071 /*
2072  * LDAP Transactions
2073  */
2074 #ifdef LDAP_X_TXN
2075 LDAP_F( int )
2076 ldap_txn_start LDAP_P(( LDAP *ld,
2077         LDAPControl             **sctrls,
2078         LDAPControl             **cctrls,
2079         int                             *msgidp ));
2080
2081 LDAP_F( int )
2082 ldap_txn_start_s LDAP_P(( LDAP *ld,
2083         LDAPControl **sctrl,
2084         LDAPControl **cctrl,
2085         struct berval **rettxnid ));
2086
2087 LDAP_F( int )
2088 ldap_txn_end LDAP_P(( LDAP *ld,
2089         int     commit,
2090         struct berval   *txnid,
2091         LDAPControl             **sctrls,
2092         LDAPControl             **cctrls,
2093         int                             *msgidp ));
2094
2095 LDAP_F( int )
2096 ldap_txn_end_s LDAP_P(( LDAP *ld,
2097         int     commit,
2098         struct berval *txnid,
2099         LDAPControl **sctrl,
2100         LDAPControl **cctrl,
2101         int *retidp ));
2102 #endif
2103
2104 LDAP_END_DECL
2105 #endif /* _LDAP_H */
Cloned from git://git.openldap.org/openldap.git