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


ae4e9ae7f5a99446b21ae622aca2d146ff2340bf
[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 #define LDAP_X_TXN_ID_INVALID           0x4120
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 /*
864  * in abandon.c:
865  */
866 LDAP_F( int )
867 ldap_abandon_ext LDAP_P((
868         LDAP                    *ld,
869         int                             msgid,
870         LDAPControl             **serverctrls,
871         LDAPControl             **clientctrls ));
872
873 #if LDAP_DEPRECATED
874 LDAP_F( int )
875 ldap_abandon LDAP_P((   /* deprecated */
876         LDAP *ld,
877         int msgid ));
878 #endif
879
880 /*
881  * in add.c:
882  */
883 LDAP_F( int )
884 ldap_add_ext LDAP_P((
885         LDAP                    *ld,
886         LDAP_CONST char *dn,
887         LDAPMod                 **attrs,
888         LDAPControl             **serverctrls,
889         LDAPControl             **clientctrls,
890         int                     *msgidp ));
891
892 LDAP_F( int )
893 ldap_add_ext_s LDAP_P((
894         LDAP                    *ld,
895         LDAP_CONST char *dn,
896         LDAPMod                 **attrs,
897         LDAPControl             **serverctrls,
898         LDAPControl             **clientctrls ));
899
900 #if LDAP_DEPRECATED
901 LDAP_F( int )
902 ldap_add LDAP_P((       /* deprecated */
903         LDAP *ld,
904         LDAP_CONST char *dn,
905         LDAPMod **attrs ));
906
907 LDAP_F( int )
908 ldap_add_s LDAP_P((     /* deprecated */
909         LDAP *ld,
910         LDAP_CONST char *dn,
911         LDAPMod **attrs ));
912 #endif
913
914
915 /*
916  * in sasl.c:
917  */
918 LDAP_F( int )
919 ldap_sasl_bind LDAP_P((
920         LDAP                    *ld,
921         LDAP_CONST char *dn,
922         LDAP_CONST char *mechanism,
923         struct berval   *cred,
924         LDAPControl             **serverctrls,
925         LDAPControl             **clientctrls,
926         int                             *msgidp ));
927
928 /* Interaction flags (should be passed about in a control)
929  *  Automatic (default): use defaults, prompt otherwise
930  *  Interactive: prompt always
931  *  Quiet: never prompt
932  */
933 #define LDAP_SASL_AUTOMATIC             0U
934 #define LDAP_SASL_INTERACTIVE   1U
935 #define LDAP_SASL_QUIET                 2U
936
937 /*
938  * V3 SASL Interaction Function Callback Prototype
939  *      when using Cyrus SASL, interact is pointer to sasl_interact_t
940  *  should likely passed in a control (and provided controls)
941  */
942 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
943         LDAP *ld, unsigned flags, void* defaults, void *interact ));
944
945 LDAP_F( int )
946 ldap_sasl_interactive_bind_s LDAP_P((
947         LDAP *ld,
948         LDAP_CONST char *dn, /* usually NULL */
949         LDAP_CONST char *saslMechanism,
950         LDAPControl **serverControls,
951         LDAPControl **clientControls,
952
953         /* should be client controls */
954         unsigned flags,
955         LDAP_SASL_INTERACT_PROC *proc,
956         void *defaults ));
957
958 LDAP_F( int )
959 ldap_sasl_bind_s LDAP_P((
960         LDAP                    *ld,
961         LDAP_CONST char *dn,
962         LDAP_CONST char *mechanism,
963         struct berval   *cred,
964         LDAPControl             **serverctrls,
965         LDAPControl             **clientctrls,
966         struct berval   **servercredp ));
967
968 LDAP_F( int )
969 ldap_parse_sasl_bind_result LDAP_P((
970         LDAP                    *ld,
971         LDAPMessage             *res,
972         struct berval   **servercredp,
973         int                             freeit ));
974
975 #if LDAP_DEPRECATED
976 /*
977  * in bind.c:
978  *      (deprecated)
979  */
980 LDAP_F( int )
981 ldap_bind LDAP_P((      /* deprecated */
982         LDAP *ld,
983         LDAP_CONST char *who,
984         LDAP_CONST char *passwd,
985         int authmethod ));
986
987 LDAP_F( int )
988 ldap_bind_s LDAP_P((    /* deprecated */
989         LDAP *ld,
990         LDAP_CONST char *who,
991         LDAP_CONST char *cred,
992         int authmethod ));
993
994 /*
995  * in sbind.c:
996  */
997 LDAP_F( int )
998 ldap_simple_bind LDAP_P(( /* deprecated */
999         LDAP *ld,
1000         LDAP_CONST char *who,
1001         LDAP_CONST char *passwd ));
1002
1003 LDAP_F( int )
1004 ldap_simple_bind_s LDAP_P(( /* deprecated */
1005         LDAP *ld,
1006         LDAP_CONST char *who,
1007         LDAP_CONST char *passwd ));
1008
1009
1010 /*
1011  * in kbind.c:
1012  *      (deprecated)
1013  */
1014 LDAP_F( int )
1015 ldap_kerberos_bind_s LDAP_P((   /* deprecated */
1016         LDAP *ld,
1017         LDAP_CONST char *who ));
1018
1019 LDAP_F( int )
1020 ldap_kerberos_bind1 LDAP_P((    /* deprecated */
1021         LDAP *ld,
1022         LDAP_CONST char *who ));
1023
1024 LDAP_F( int )
1025 ldap_kerberos_bind1_s LDAP_P((  /* deprecated */
1026         LDAP *ld,
1027         LDAP_CONST char *who ));
1028
1029 LDAP_F( int )
1030 ldap_kerberos_bind2 LDAP_P((    /* deprecated */
1031         LDAP *ld,
1032         LDAP_CONST char *who ));
1033
1034 LDAP_F( int )
1035 ldap_kerberos_bind2_s LDAP_P((  /* deprecated */
1036         LDAP *ld,
1037         LDAP_CONST char *who ));
1038 #endif
1039
1040
1041 /*
1042  * in compare.c:
1043  */
1044 LDAP_F( int )
1045 ldap_compare_ext LDAP_P((
1046         LDAP                    *ld,
1047         LDAP_CONST char *dn,
1048         LDAP_CONST char *attr,
1049         struct berval   *bvalue,
1050         LDAPControl             **serverctrls,
1051         LDAPControl             **clientctrls,
1052         int                     *msgidp ));
1053
1054 LDAP_F( int )
1055 ldap_compare_ext_s LDAP_P((
1056         LDAP                    *ld,
1057         LDAP_CONST char *dn,
1058         LDAP_CONST char *attr,
1059         struct berval   *bvalue,
1060         LDAPControl             **serverctrls,
1061         LDAPControl             **clientctrls ));
1062
1063 #if LDAP_DEPRECATED
1064 LDAP_F( int )
1065 ldap_compare LDAP_P((   /* deprecated */
1066         LDAP *ld,
1067         LDAP_CONST char *dn,
1068         LDAP_CONST char *attr,
1069         LDAP_CONST char *value ));
1070
1071 LDAP_F( int )
1072 ldap_compare_s LDAP_P(( /* deprecated */
1073         LDAP *ld,
1074         LDAP_CONST char *dn,
1075         LDAP_CONST char *attr,
1076         LDAP_CONST char *value ));
1077 #endif
1078
1079
1080 /*
1081  * in delete.c:
1082  */
1083 LDAP_F( int )
1084 ldap_delete_ext LDAP_P((
1085         LDAP                    *ld,
1086         LDAP_CONST char *dn,
1087         LDAPControl             **serverctrls,
1088         LDAPControl             **clientctrls,
1089         int                     *msgidp ));
1090
1091 LDAP_F( int )
1092 ldap_delete_ext_s LDAP_P((
1093         LDAP                    *ld,
1094         LDAP_CONST char *dn,
1095         LDAPControl             **serverctrls,
1096         LDAPControl             **clientctrls ));
1097
1098 #if LDAP_DEPRECATED
1099 LDAP_F( int )
1100 ldap_delete LDAP_P((    /* deprecated */
1101         LDAP *ld,
1102         LDAP_CONST char *dn ));
1103
1104 LDAP_F( int )
1105 ldap_delete_s LDAP_P((  /* deprecated */
1106         LDAP *ld,
1107         LDAP_CONST char *dn ));
1108 #endif
1109
1110
1111 /*
1112  * in error.c:
1113  */
1114 LDAP_F( int )
1115 ldap_parse_result LDAP_P((
1116         LDAP                    *ld,
1117         LDAPMessage             *res,
1118         int                             *errcodep,
1119         char                    **matcheddnp,
1120         char                    **errmsgp,
1121         char                    ***referralsp,
1122         LDAPControl             ***serverctrls,
1123         int                             freeit ));
1124
1125 LDAP_F( char * )
1126 ldap_err2string LDAP_P((
1127         int err ));
1128
1129 #if LDAP_DEPRECATED
1130 LDAP_F( int )
1131 ldap_result2error LDAP_P((      /* deprecated */
1132         LDAP *ld,
1133         LDAPMessage *r,
1134         int freeit ));
1135
1136 LDAP_F( void )
1137 ldap_perror LDAP_P((    /* deprecated */
1138         LDAP *ld,
1139         LDAP_CONST char *s ));
1140 #endif
1141
1142
1143 /*
1144  * in modify.c:
1145  */
1146 LDAP_F( int )
1147 ldap_modify_ext LDAP_P((
1148         LDAP                    *ld,
1149         LDAP_CONST char *dn,
1150         LDAPMod                 **mods,
1151         LDAPControl             **serverctrls,
1152         LDAPControl             **clientctrls,
1153         int                     *msgidp ));
1154
1155 LDAP_F( int )
1156 ldap_modify_ext_s LDAP_P((
1157         LDAP                    *ld,
1158         LDAP_CONST char *dn,
1159         LDAPMod                 **mods,
1160         LDAPControl             **serverctrls,
1161         LDAPControl             **clientctrls ));
1162
1163 #if LDAP_DEPRECATED
1164 LDAP_F( int )
1165 ldap_modify LDAP_P((    /* deprecated */
1166         LDAP *ld,
1167         LDAP_CONST char *dn,
1168         LDAPMod **mods ));
1169
1170 LDAP_F( int )
1171 ldap_modify_s LDAP_P((  /* deprecated */
1172         LDAP *ld,
1173         LDAP_CONST char *dn,
1174         LDAPMod **mods ));
1175 #endif
1176
1177
1178 /*
1179  * in modrdn.c:
1180  */
1181 LDAP_F( int )
1182 ldap_rename LDAP_P((
1183         LDAP *ld,
1184         LDAP_CONST char *dn,
1185         LDAP_CONST char *newrdn,
1186         LDAP_CONST char *newSuperior,
1187         int deleteoldrdn,
1188         LDAPControl **sctrls,
1189         LDAPControl **cctrls,
1190         int *msgidp ));
1191
1192 LDAP_F( int )
1193 ldap_rename_s LDAP_P((
1194         LDAP *ld,
1195         LDAP_CONST char *dn,
1196         LDAP_CONST char *newrdn,
1197         LDAP_CONST char *newSuperior,
1198         int deleteoldrdn,
1199         LDAPControl **sctrls,
1200         LDAPControl **cctrls ));
1201
1202 #if LDAP_DEPRECATED
1203 LDAP_F( int )
1204 ldap_rename2 LDAP_P((   /* deprecated */
1205         LDAP *ld,
1206         LDAP_CONST char *dn,
1207         LDAP_CONST char *newrdn,
1208         LDAP_CONST char *newSuperior,
1209         int deleteoldrdn ));
1210
1211 LDAP_F( int )
1212 ldap_rename2_s LDAP_P(( /* deprecated */
1213         LDAP *ld,
1214         LDAP_CONST char *dn,
1215         LDAP_CONST char *newrdn,
1216         LDAP_CONST char *newSuperior,
1217         int deleteoldrdn ));
1218
1219 LDAP_F( int )
1220 ldap_modrdn LDAP_P((    /* deprecated */
1221         LDAP *ld,
1222         LDAP_CONST char *dn,
1223         LDAP_CONST char *newrdn ));
1224
1225 LDAP_F( int )
1226 ldap_modrdn_s LDAP_P((  /* deprecated */
1227         LDAP *ld,
1228         LDAP_CONST char *dn,
1229         LDAP_CONST char *newrdn ));
1230
1231 LDAP_F( int )
1232 ldap_modrdn2 LDAP_P((   /* deprecated */
1233         LDAP *ld,
1234         LDAP_CONST char *dn,
1235         LDAP_CONST char *newrdn,
1236         int deleteoldrdn ));
1237
1238 LDAP_F( int )
1239 ldap_modrdn2_s LDAP_P(( /* deprecated */
1240         LDAP *ld,
1241         LDAP_CONST char *dn,
1242         LDAP_CONST char *newrdn,
1243         int deleteoldrdn));
1244 #endif
1245
1246
1247 /*
1248  * in open.c:
1249  */
1250 #if LDAP_DEPRECATED
1251 LDAP_F( LDAP * )
1252 ldap_init LDAP_P(( /* deprecated */
1253         LDAP_CONST char *host,
1254         int port ));
1255
1256 LDAP_F( LDAP * )
1257 ldap_open LDAP_P((      /* deprecated */
1258         LDAP_CONST char *host,
1259         int port ));
1260 #endif
1261
1262 LDAP_F( int )
1263 ldap_create LDAP_P((
1264         LDAP **ldp ));
1265
1266 LDAP_F( int )
1267 ldap_initialize LDAP_P((
1268         LDAP **ldp,
1269         LDAP_CONST char *url ));
1270
1271 /*
1272  * in tls.c
1273  */
1274
1275 LDAP_F( int )
1276 ldap_tls_inplace LDAP_P((
1277         LDAP *ld ));
1278
1279 LDAP_F( int )
1280 ldap_start_tls LDAP_P((
1281         LDAP *ld,
1282         LDAPControl **serverctrls,
1283         LDAPControl **clientctrls,
1284         int *msgidp ));
1285
1286 LDAP_F( int )
1287 ldap_install_tls LDAP_P((
1288         LDAP *ld ));
1289
1290 LDAP_F( int )
1291 ldap_start_tls_s LDAP_P((
1292         LDAP *ld,
1293         LDAPControl **serverctrls,
1294         LDAPControl **clientctrls ));
1295
1296 /*
1297  * in messages.c:
1298  */
1299 LDAP_F( LDAPMessage * )
1300 ldap_first_message LDAP_P((
1301         LDAP *ld,
1302         LDAPMessage *chain ));
1303
1304 LDAP_F( LDAPMessage * )
1305 ldap_next_message LDAP_P((
1306         LDAP *ld,
1307         LDAPMessage *msg ));
1308
1309 LDAP_F( int )
1310 ldap_count_messages LDAP_P((
1311         LDAP *ld,
1312         LDAPMessage *chain ));
1313
1314 /*
1315  * in references.c:
1316  */
1317 LDAP_F( LDAPMessage * )
1318 ldap_first_reference LDAP_P((
1319         LDAP *ld,
1320         LDAPMessage *chain ));
1321
1322 LDAP_F( LDAPMessage * )
1323 ldap_next_reference LDAP_P((
1324         LDAP *ld,
1325         LDAPMessage *ref ));
1326
1327 LDAP_F( int )
1328 ldap_count_references LDAP_P((
1329         LDAP *ld,
1330         LDAPMessage *chain ));
1331
1332 LDAP_F( int )
1333 ldap_parse_reference LDAP_P((
1334         LDAP                    *ld,
1335         LDAPMessage             *ref,
1336         char                    ***referralsp,
1337         LDAPControl             ***serverctrls,
1338         int                             freeit));
1339
1340
1341 /*
1342  * in getentry.c:
1343  */
1344 LDAP_F( LDAPMessage * )
1345 ldap_first_entry LDAP_P((
1346         LDAP *ld,
1347         LDAPMessage *chain ));
1348
1349 LDAP_F( LDAPMessage * )
1350 ldap_next_entry LDAP_P((
1351         LDAP *ld,
1352         LDAPMessage *entry ));
1353
1354 LDAP_F( int )
1355 ldap_count_entries LDAP_P((
1356         LDAP *ld,
1357         LDAPMessage *chain ));
1358
1359 LDAP_F( int )
1360 ldap_get_entry_controls LDAP_P((
1361         LDAP                    *ld,
1362         LDAPMessage             *entry,
1363         LDAPControl             ***serverctrls));
1364
1365
1366 /*
1367  * in addentry.c
1368  */
1369 LDAP_F( LDAPMessage * )
1370 ldap_delete_result_entry LDAP_P((
1371         LDAPMessage **list,
1372         LDAPMessage *e ));
1373
1374 LDAP_F( void )
1375 ldap_add_result_entry LDAP_P((
1376         LDAPMessage **list,
1377         LDAPMessage *e ));
1378
1379
1380 /*
1381  * in getdn.c
1382  */
1383 LDAP_F( char * )
1384 ldap_get_dn LDAP_P((
1385         LDAP *ld,
1386         LDAPMessage *entry ));
1387
1388 typedef struct ldap_ava {
1389         struct berval la_attr;
1390         struct berval la_value;
1391         unsigned la_flags;
1392 #define LDAP_AVA_NULL                           0x0000U
1393 #define LDAP_AVA_STRING                         0x0001U
1394 #define LDAP_AVA_BINARY                         0x0002U
1395 #define LDAP_AVA_NONPRINTABLE           0x0004U
1396 #define LDAP_AVA_FREE_ATTR                      0x0010U
1397 #define LDAP_AVA_FREE_VALUE                     0x0020U
1398
1399         void *la_private;
1400 } LDAPAVA;
1401
1402 typedef LDAPAVA** LDAPRDN;
1403 typedef LDAPRDN* LDAPDN;
1404
1405 /* DN formats */
1406 #define LDAP_DN_FORMAT_LDAP                     0x0000U
1407 #define LDAP_DN_FORMAT_LDAPV3           0x0010U
1408 #define LDAP_DN_FORMAT_LDAPV2           0x0020U
1409 #define LDAP_DN_FORMAT_DCE                      0x0030U
1410 #define LDAP_DN_FORMAT_UFN                      0x0040U /* dn2str only */
1411 #define LDAP_DN_FORMAT_AD_CANONICAL     0x0050U /* dn2str only */
1412 #define LDAP_DN_FORMAT_LBER                     0x00F0U /* for testing only */
1413 #define LDAP_DN_FORMAT_MASK                     0x00F0U
1414
1415 /* DN flags */
1416 #define LDAP_DN_PRETTY                          0x0100U
1417 #define LDAP_DN_SKIP                            0x0200U
1418 #define LDAP_DN_P_NOLEADTRAILSPACES     0x1000U
1419 #define LDAP_DN_P_NOSPACEAFTERRDN       0x2000U
1420 #define LDAP_DN_PEDANTIC                        0xF000U
1421
1422 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1423 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1424
1425 LDAP_F( int )
1426 ldap_bv2dn LDAP_P(( 
1427         struct berval *bv, 
1428         LDAPDN *dn, 
1429         unsigned flags ));
1430
1431 LDAP_F( int )
1432 ldap_str2dn LDAP_P((
1433         LDAP_CONST char *str,
1434         LDAPDN *dn,
1435         unsigned flags ));
1436
1437 LDAP_F( int )
1438 ldap_dn2bv LDAP_P((
1439         LDAPDN dn,
1440         struct berval *bv,
1441         unsigned flags ));
1442
1443 LDAP_F( int )
1444 ldap_dn2str LDAP_P((
1445         LDAPDN dn,
1446         char **str,
1447         unsigned flags ));
1448
1449 LDAP_F( int )
1450 ldap_bv2rdn LDAP_P((
1451         struct berval *bv,
1452         LDAPRDN *rdn,
1453         char **next,
1454         unsigned flags ));
1455
1456 LDAP_F( int )
1457 ldap_str2rdn LDAP_P((
1458         LDAP_CONST char *str,
1459         LDAPRDN *rdn,
1460         char **next,
1461         unsigned flags ));
1462
1463 LDAP_F( int )
1464 ldap_rdn2bv LDAP_P((
1465         LDAPRDN rdn,
1466         struct berval *bv,
1467         unsigned flags ));
1468
1469 LDAP_F( int )
1470 ldap_rdn2str LDAP_P((
1471         LDAPRDN rdn,
1472         char **str,
1473         unsigned flags ));
1474
1475 LDAP_F( int )
1476 ldap_dn_normalize LDAP_P((
1477         LDAP_CONST char *in, unsigned iflags,
1478         char **out, unsigned oflags ));
1479
1480 LDAP_F( char * )
1481 ldap_dn2ufn LDAP_P(( /* deprecated */
1482         LDAP_CONST char *dn ));
1483
1484 LDAP_F( char ** )
1485 ldap_explode_dn LDAP_P(( /* deprecated */
1486         LDAP_CONST char *dn,
1487         int notypes ));
1488
1489 LDAP_F( char ** )
1490 ldap_explode_rdn LDAP_P(( /* deprecated */
1491         LDAP_CONST char *rdn,
1492         int notypes ));
1493
1494 typedef int LDAPDN_rewrite_func
1495         LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1496
1497 LDAP_F( int )
1498 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1499         LDAPDN_rewrite_func *func, unsigned flags ));
1500
1501 LDAP_F( char * )
1502 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));  /* deprecated */
1503
1504 LDAP_F( char * )
1505 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1506
1507 LDAP_F( char * )
1508 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn ));   /* deprecated */
1509
1510 LDAP_F( int )
1511 ldap_get_dn_ber LDAP_P((
1512         LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1513
1514 LDAP_F( int )
1515 ldap_get_attribute_ber LDAP_P((
1516         LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1517         struct berval **vals ));
1518
1519 /*
1520  * in getattr.c
1521  */
1522 LDAP_F( char * )
1523 ldap_first_attribute LDAP_P((
1524         LDAP *ld,
1525         LDAPMessage *entry,
1526         BerElement **ber ));
1527
1528 LDAP_F( char * )
1529 ldap_next_attribute LDAP_P((
1530         LDAP *ld,
1531         LDAPMessage *entry,
1532         BerElement *ber ));
1533
1534
1535 /*
1536  * in getvalues.c
1537  */
1538 LDAP_F( struct berval ** )
1539 ldap_get_values_len LDAP_P((
1540         LDAP *ld,
1541         LDAPMessage *entry,
1542         LDAP_CONST char *target ));
1543
1544 LDAP_F( int )
1545 ldap_count_values_len LDAP_P((
1546         struct berval **vals ));
1547
1548 LDAP_F( void )
1549 ldap_value_free_len LDAP_P((
1550         struct berval **vals ));
1551
1552 #if LDAP_DEPRECATED
1553 LDAP_F( char ** )
1554 ldap_get_values LDAP_P((        /* deprecated */
1555         LDAP *ld,
1556         LDAPMessage *entry,
1557         LDAP_CONST char *target ));
1558
1559 LDAP_F( int )
1560 ldap_count_values LDAP_P((      /* deprecated */
1561         char **vals ));
1562
1563 LDAP_F( void )
1564 ldap_value_free LDAP_P((        /* deprecated */
1565         char **vals ));
1566 #endif
1567
1568 /*
1569  * in result.c:
1570  */
1571 LDAP_F( int )
1572 ldap_result LDAP_P((
1573         LDAP *ld,
1574         int msgid,
1575         int all,
1576         struct timeval *timeout,
1577         LDAPMessage **result ));
1578
1579 LDAP_F( int )
1580 ldap_msgtype LDAP_P((
1581         LDAPMessage *lm ));
1582
1583 LDAP_F( int )
1584 ldap_msgid   LDAP_P((
1585         LDAPMessage *lm ));
1586
1587 LDAP_F( int )
1588 ldap_msgfree LDAP_P((
1589         LDAPMessage *lm ));
1590
1591 LDAP_F( int )
1592 ldap_msgdelete LDAP_P((
1593         LDAP *ld,
1594         int msgid ));
1595
1596
1597 /*
1598  * in search.c:
1599  */
1600 LDAP_F( int )
1601 ldap_bv2escaped_filter_value LDAP_P(( 
1602         struct berval *in, 
1603         struct berval *out ));
1604
1605 LDAP_F( int )
1606 ldap_search_ext LDAP_P((
1607         LDAP                    *ld,
1608         LDAP_CONST char *base,
1609         int                             scope,
1610         LDAP_CONST char *filter,
1611         char                    **attrs,
1612         int                             attrsonly,
1613         LDAPControl             **serverctrls,
1614         LDAPControl             **clientctrls,
1615         struct timeval  *timeout,
1616         int                             sizelimit,
1617         int                             *msgidp ));
1618
1619 LDAP_F( int )
1620 ldap_search_ext_s LDAP_P((
1621         LDAP                    *ld,
1622         LDAP_CONST char *base,
1623         int                             scope,
1624         LDAP_CONST char *filter,
1625         char                    **attrs,
1626         int                             attrsonly,
1627         LDAPControl             **serverctrls,
1628         LDAPControl             **clientctrls,
1629         struct timeval  *timeout,
1630         int                             sizelimit,
1631         LDAPMessage             **res ));
1632
1633 #if LDAP_DEPRECATED
1634 LDAP_F( int )
1635 ldap_search LDAP_P((    /* deprecated */
1636         LDAP *ld,
1637         LDAP_CONST char *base,
1638         int scope,
1639         LDAP_CONST char *filter,
1640         char **attrs,
1641         int attrsonly ));
1642
1643 LDAP_F( int )
1644 ldap_search_s LDAP_P((  /* deprecated */
1645         LDAP *ld,
1646         LDAP_CONST char *base,
1647         int scope,
1648         LDAP_CONST char *filter,
1649         char **attrs,
1650         int attrsonly,
1651         LDAPMessage **res ));
1652
1653 LDAP_F( int )
1654 ldap_search_st LDAP_P(( /* deprecated */
1655         LDAP *ld,
1656         LDAP_CONST char *base,
1657         int scope,
1658         LDAP_CONST char *filter,
1659     char **attrs,
1660         int attrsonly,
1661         struct timeval *timeout,
1662         LDAPMessage **res ));
1663 #endif
1664
1665 /*
1666  * in unbind.c
1667  */
1668 LDAP_F( int )
1669 ldap_unbind_ext LDAP_P((
1670         LDAP                    *ld,
1671         LDAPControl             **serverctrls,
1672         LDAPControl             **clientctrls));
1673
1674 LDAP_F( int )
1675 ldap_unbind_ext_s LDAP_P((
1676         LDAP                    *ld,
1677         LDAPControl             **serverctrls,
1678         LDAPControl             **clientctrls));
1679
1680 #if LDAP_DEPRECATED
1681 LDAP_F( int )
1682 ldap_unbind LDAP_P(( /* deprecated */
1683         LDAP *ld ));
1684
1685 LDAP_F( int )
1686 ldap_unbind_s LDAP_P(( /* deprecated */
1687         LDAP *ld ));
1688 #endif
1689
1690 /*
1691  * in filter.c
1692  */
1693 LDAP_F( int )
1694 ldap_put_vrFilter LDAP_P((
1695         BerElement *ber,
1696         const char *vrf ));
1697
1698 /*
1699  * in free.c
1700  */
1701
1702 LDAP_F( void * )
1703 ldap_memalloc LDAP_P((
1704         ber_len_t s ));
1705
1706 LDAP_F( void * )
1707 ldap_memrealloc LDAP_P((
1708         void* p,
1709         ber_len_t s ));
1710
1711 LDAP_F( void * )
1712 ldap_memcalloc LDAP_P((
1713         ber_len_t n,
1714         ber_len_t s ));
1715
1716 LDAP_F( void )
1717 ldap_memfree LDAP_P((
1718         void* p ));
1719
1720 LDAP_F( void )
1721 ldap_memvfree LDAP_P((
1722         void** v ));
1723
1724 LDAP_F( char * )
1725 ldap_strdup LDAP_P((
1726         LDAP_CONST char * ));
1727
1728 LDAP_F( void )
1729 ldap_mods_free LDAP_P((
1730         LDAPMod **mods,
1731         int freemods ));
1732
1733
1734 #if LDAP_DEPRECATED
1735 /*
1736  * in sort.c (deprecated)
1737  */
1738 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1739         LDAP_CONST char *left,
1740         LDAP_CONST char *right ));
1741
1742 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1743         LDAP_CONST void *left,
1744         LDAP_CONST void *right ));
1745
1746 LDAP_F( int )   /* deprecated */
1747 ldap_sort_entries LDAP_P(( LDAP *ld,
1748         LDAPMessage **chain,
1749         LDAP_CONST char *attr,
1750         LDAP_SORT_AD_CMP_PROC *cmp ));
1751
1752 LDAP_F( int )   /* deprecated */
1753 ldap_sort_values LDAP_P((
1754         LDAP *ld,
1755         char **vals,
1756         LDAP_SORT_AV_CMP_PROC *cmp ));
1757
1758 LDAP_F( int ) /* deprecated */
1759 ldap_sort_strcasecmp LDAP_P((
1760         LDAP_CONST void *a,
1761         LDAP_CONST void *b ));
1762 #endif
1763
1764 /*
1765  * in url.c
1766  */
1767 LDAP_F( int )
1768 ldap_is_ldap_url LDAP_P((
1769         LDAP_CONST char *url ));
1770
1771 LDAP_F( int )
1772 ldap_is_ldaps_url LDAP_P((
1773         LDAP_CONST char *url ));
1774
1775 LDAP_F( int )
1776 ldap_is_ldapi_url LDAP_P((
1777         LDAP_CONST char *url ));
1778
1779 LDAP_F( int )
1780 ldap_url_parse LDAP_P((
1781         LDAP_CONST char *url,
1782         LDAPURLDesc **ludpp ));
1783
1784 LDAP_F( char * )
1785 ldap_url_desc2str LDAP_P((
1786         LDAPURLDesc *ludp ));
1787
1788 LDAP_F( void )
1789 ldap_free_urldesc LDAP_P((
1790         LDAPURLDesc *ludp ));
1791
1792
1793 /*
1794  * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1795  *  in cancel.c
1796  */
1797 #define LDAP_API_FEATURE_CANCEL 1000
1798
1799 LDAP_F( int )
1800 ldap_cancel LDAP_P(( LDAP *ld,
1801         int cancelid,
1802         LDAPControl             **sctrls,
1803         LDAPControl             **cctrls,
1804         int                             *msgidp ));
1805
1806 LDAP_F( int )
1807 ldap_cancel_s LDAP_P(( LDAP *ld,
1808         int cancelid,
1809         LDAPControl **sctrl,
1810         LDAPControl **cctrl ));
1811
1812 /*
1813  * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1814  *  in turn.c
1815  */
1816 #define LDAP_API_FEATURE_TURN 1000
1817
1818 LDAP_F( int )
1819 ldap_turn LDAP_P(( LDAP *ld,
1820         int mutual,
1821         LDAP_CONST char* identifier,
1822         LDAPControl             **sctrls,
1823         LDAPControl             **cctrls,
1824         int                             *msgidp ));
1825
1826 LDAP_F( int )
1827 ldap_turn_s LDAP_P(( LDAP *ld,
1828         int mutual,
1829         LDAP_CONST char* identifier,
1830         LDAPControl **sctrl,
1831         LDAPControl **cctrl ));
1832
1833 /*
1834  * LDAP Paged Results
1835  *      in pagectrl.c
1836  */
1837 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1838
1839 LDAP_F( int )
1840 ldap_create_page_control_value LDAP_P((
1841         LDAP *ld,
1842         ber_int_t pagesize,
1843         struct berval *cookie,
1844         struct berval *value ));
1845
1846 LDAP_F( int )
1847 ldap_create_page_control LDAP_P((
1848         LDAP *ld,
1849         ber_int_t pagesize,
1850         struct berval *cookie,
1851         int iscritical,
1852         LDAPControl **ctrlp ));
1853
1854 #if LDAP_DEPRECATED
1855 LDAP_F( int )
1856 ldap_parse_page_control LDAP_P((
1857         LDAP *ld,
1858         LDAPControl **ctrls,
1859         ber_int_t *count,
1860         struct berval **cookie ));
1861 #endif
1862
1863 LDAP_F( int )
1864 ldap_parse_pageresponse_control LDAP_P((
1865         LDAP *ld,
1866         LDAPControl *ctrl,
1867         ber_int_t *count,
1868         struct berval *cookie ));
1869
1870 /*
1871  * LDAP Server Side Sort
1872  *      in sortctrl.c
1873  */
1874 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1875
1876 /* structure for a sort-key */
1877 typedef struct ldapsortkey {
1878         char *attributeType;
1879         char *orderingRule;
1880         int reverseOrder;
1881 } LDAPSortKey;
1882
1883 LDAP_F( int )
1884 ldap_create_sort_keylist LDAP_P((
1885         LDAPSortKey ***sortKeyList,
1886         char *keyString ));
1887
1888 LDAP_F( void )
1889 ldap_free_sort_keylist LDAP_P((
1890         LDAPSortKey **sortkeylist ));
1891
1892 LDAP_F( int )
1893 ldap_create_sort_control_value LDAP_P((
1894         LDAP *ld,
1895         LDAPSortKey **keyList,
1896         struct berval *value ));
1897
1898 LDAP_F( int )
1899 ldap_create_sort_control LDAP_P((
1900         LDAP *ld,
1901         LDAPSortKey **keyList,
1902         int iscritical,
1903         LDAPControl **ctrlp ));
1904
1905 LDAP_F( int )
1906 ldap_parse_sortresponse_control LDAP_P((
1907         LDAP *ld,
1908         LDAPControl *ctrl,
1909         ber_int_t *result,
1910         char **attribute ));
1911
1912 /*
1913  * LDAP Virtual List View
1914  *      in vlvctrl.c
1915  */
1916 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1917
1918 /* structure for virtual list */
1919 typedef struct ldapvlvinfo {
1920         ber_int_t ldvlv_version;
1921     ber_int_t ldvlv_before_count;
1922     ber_int_t ldvlv_after_count;
1923     ber_int_t ldvlv_offset;
1924     ber_int_t ldvlv_count;
1925     struct berval *     ldvlv_attrvalue;
1926     struct berval *     ldvlv_context;
1927     void *                      ldvlv_extradata;
1928 } LDAPVLVInfo;
1929
1930 LDAP_F( int )
1931 ldap_create_vlv_control_value LDAP_P((
1932         LDAP *ld,
1933         LDAPVLVInfo *ldvlistp,
1934         struct berval *value));
1935
1936 LDAP_F( int )
1937 ldap_create_vlv_control LDAP_P((
1938         LDAP *ld,
1939         LDAPVLVInfo *ldvlistp,
1940         LDAPControl **ctrlp ));
1941
1942 LDAP_F( int )
1943 ldap_parse_vlvresponse_control LDAP_P((
1944         LDAP          *ld,
1945         LDAPControl   *ctrls,
1946         ber_int_t *target_posp,
1947         ber_int_t *list_countp,
1948         struct berval **contextp,
1949         int           *errcodep ));
1950
1951 /*
1952  * LDAP Who Am I?
1953  *      in whoami.c
1954  */
1955 #define LDAP_API_FEATURE_WHOAMI 1000
1956
1957 LDAP_F( int )
1958 ldap_parse_whoami LDAP_P((
1959         LDAP *ld,
1960         LDAPMessage *res,
1961         struct berval **authzid ));
1962
1963 LDAP_F( int )
1964 ldap_whoami LDAP_P(( LDAP *ld,
1965         LDAPControl             **sctrls,
1966         LDAPControl             **cctrls,
1967         int                             *msgidp ));
1968
1969 LDAP_F( int )
1970 ldap_whoami_s LDAP_P((
1971         LDAP *ld,
1972         struct berval **authzid,
1973         LDAPControl **sctrls,
1974         LDAPControl **cctrls ));
1975
1976 /*
1977  * LDAP Password Modify
1978  *      in passwd.c
1979  */
1980 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1981
1982 LDAP_F( int )
1983 ldap_parse_passwd LDAP_P((
1984         LDAP *ld,
1985         LDAPMessage *res,
1986         struct berval *newpasswd ));
1987
1988 LDAP_F( int )
1989 ldap_passwd LDAP_P(( LDAP *ld,
1990         struct berval   *user,
1991         struct berval   *oldpw,
1992         struct berval   *newpw,
1993         LDAPControl             **sctrls,
1994         LDAPControl             **cctrls,
1995         int                             *msgidp ));
1996
1997 LDAP_F( int )
1998 ldap_passwd_s LDAP_P((
1999         LDAP *ld,
2000         struct berval   *user,
2001         struct berval   *oldpw,
2002         struct berval   *newpw,
2003         struct berval *newpasswd,
2004         LDAPControl **sctrls,
2005         LDAPControl **cctrls ));
2006
2007 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2008 /*
2009  * LDAP Password Policy controls
2010  *      in ppolicy.c
2011  */
2012 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2013
2014 typedef enum passpolicyerror_enum {
2015        PP_passwordExpired = 0,
2016        PP_accountLocked = 1,
2017        PP_changeAfterReset = 2,
2018        PP_passwordModNotAllowed = 3,
2019        PP_mustSupplyOldPassword = 4,
2020        PP_insufficientPasswordQuality = 5,
2021        PP_passwordTooShort = 6,
2022        PP_passwordTooYoung = 7,
2023        PP_passwordInHistory = 8,
2024        PP_noError = 65535
2025 } LDAPPasswordPolicyError;
2026
2027 LDAP_F( int )
2028 ldap_create_passwordpolicy_control LDAP_P((
2029         LDAP *ld,
2030         LDAPControl **ctrlp ));
2031
2032 LDAP_F( int )
2033 ldap_parse_passwordpolicy_control LDAP_P((
2034         LDAP *ld,
2035         LDAPControl *ctrl,
2036         ber_int_t *expirep,
2037         ber_int_t *gracep,
2038         LDAPPasswordPolicyError *errorp ));
2039
2040 LDAP_F( const char * )
2041 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2042 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2043
2044 /*
2045  * LDAP Dynamic Directory Services Refresh RFC2589
2046  *      in dds.c
2047  */
2048 #define LDAP_API_FEATURE_REFRESH 1000
2049
2050 LDAP_F( int )
2051 ldap_parse_refresh LDAP_P((
2052         LDAP *ld,
2053         LDAPMessage *res,
2054         ber_int_t *newttl ));
2055
2056 LDAP_F( int )
2057 ldap_refresh LDAP_P(( LDAP *ld,
2058         struct berval   *dn,
2059         ber_int_t ttl,
2060         LDAPControl             **sctrls,
2061         LDAPControl             **cctrls,
2062         int                             *msgidp ));
2063
2064 LDAP_F( int )
2065 ldap_refresh_s LDAP_P((
2066         LDAP *ld,
2067         struct berval   *dn,
2068         ber_int_t ttl,
2069         ber_int_t *newttl,
2070         LDAPControl **sctrls,
2071         LDAPControl **cctrls ));
2072
2073 /*
2074  * LDAP Transactions
2075  */
2076 #ifdef LDAP_X_TXN
2077 LDAP_F( int )
2078 ldap_txn_start LDAP_P(( LDAP *ld,
2079         LDAPControl             **sctrls,
2080         LDAPControl             **cctrls,
2081         int                             *msgidp ));
2082
2083 LDAP_F( int )
2084 ldap_txn_start_s LDAP_P(( LDAP *ld,
2085         LDAPControl **sctrl,
2086         LDAPControl **cctrl,
2087         struct berval **rettxnid ));
2088
2089 LDAP_F( int )
2090 ldap_txn_end LDAP_P(( LDAP *ld,
2091         int     commit,
2092         struct berval   *txnid,
2093         LDAPControl             **sctrls,
2094         LDAPControl             **cctrls,
2095         int                             *msgidp ));
2096
2097 LDAP_F( int )
2098 ldap_txn_end_s LDAP_P(( LDAP *ld,
2099         int     commit,
2100         struct berval *txnid,
2101         LDAPControl **sctrl,
2102         LDAPControl **cctrl,
2103         int *retidp ));
2104 #endif
2105
2106 LDAP_END_DECL
2107 #endif /* _LDAP_H */
Cloned from git://git.openldap.org/openldap.git