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


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