2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2004 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
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>.
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16 * All rights reserved.
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.
32 /* include version and API feature defines */
33 #include <ldap_features.h>
37 #define LDAP_VERSION1 1
38 #define LDAP_VERSION2 2
39 #define LDAP_VERSION3 3
41 #define LDAP_VERSION_MIN LDAP_VERSION2
42 #define LDAP_VERSION LDAP_VERSION2
43 #define LDAP_VERSION_MAX LDAP_VERSION3
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).
51 #define LDAP_API_VERSION 3001
52 #define LDAP_VENDOR_NAME "OpenLDAP"
54 /* OpenLDAP API Features */
55 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
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
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 */
71 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
72 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
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 */
81 * 0x0000 - 0x0fff reserved for api options
82 * 0x1000 - 0x3fff reserved for api extended options
83 * 0x4000 - 0x7fff reserved for private and experimental options
86 #define LDAP_OPT_API_INFO 0x0000
87 #define LDAP_OPT_DESC 0x0001 /* historic */
88 #define LDAP_OPT_DEREF 0x0002
89 #define LDAP_OPT_SIZELIMIT 0x0003
90 #define LDAP_OPT_TIMELIMIT 0x0004
91 /* 0x05 - 0x07 not defined */
92 #define LDAP_OPT_REFERRALS 0x0008
93 #define LDAP_OPT_RESTART 0x0009
94 /* 0x0a - 0x10 not defined */
95 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
96 #define LDAP_OPT_SERVER_CONTROLS 0x0012
97 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
98 /* 0x14 not defined */
99 #define LDAP_OPT_API_FEATURE_INFO 0x0015
100 /* 0x16 - 0x2f not defined */
101 #define LDAP_OPT_HOST_NAME 0x0030
102 #define LDAP_OPT_RESULT_CODE 0x0031
103 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
104 #define LDAP_OPT_ERROR_STRING 0x0032
105 #define LDAP_OPT_MATCHED_DN 0x0033
106 /* 0x0034 - 0x3fff not defined */
109 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
111 /* private and experimental options */
112 /* OpenLDAP specific options */
113 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
114 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
115 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
116 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
117 #define LDAP_OPT_URI 0x5006
118 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
120 /* OpenLDAP TLS options */
121 #define LDAP_OPT_X_TLS 0x6000
122 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
123 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
124 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
125 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
126 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
127 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
128 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
129 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
130 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
131 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
133 #define LDAP_OPT_X_TLS_NEVER 0
134 #define LDAP_OPT_X_TLS_HARD 1
135 #define LDAP_OPT_X_TLS_DEMAND 2
136 #define LDAP_OPT_X_TLS_ALLOW 3
137 #define LDAP_OPT_X_TLS_TRY 4
139 /* OpenLDAP SASL options */
140 #define LDAP_OPT_X_SASL_MECH 0x6100
141 #define LDAP_OPT_X_SASL_REALM 0x6101
142 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
143 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
144 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
145 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
146 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
147 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
148 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
149 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
151 /* Private API Extensions -- reserved for application use */
152 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
155 * ldap_get_option() and ldap_set_option() return values.
156 * As later versions may return other values indicating
157 * failure, current applications should only compare returned
158 * value against LDAP_OPT_SUCCESS.
160 #define LDAP_OPT_SUCCESS 0
161 #define LDAP_OPT_ERROR (-1)
163 /* option on/off values */
164 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
165 #define LDAP_OPT_OFF ((void *) 0)
167 typedef struct ldapapiinfo {
168 int ldapai_info_version; /* version of LDAPAPIInfo */
169 #define LDAP_API_INFO_VERSION (1)
170 int ldapai_api_version; /* revision of API supported */
171 int ldapai_protocol_version; /* highest LDAP version supported */
172 char **ldapai_extensions; /* names of API extensions */
173 char *ldapai_vendor_name; /* name of supplier */
174 int ldapai_vendor_version; /* supplier-specific version * 100 */
177 typedef struct ldap_apifeature_info {
178 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
179 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
180 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
181 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
182 } LDAPAPIFeatureInfo;
185 * LDAP Control structure
187 typedef struct ldapcontrol {
188 char * ldctl_oid; /* numericoid of control */
189 struct berval ldctl_value; /* encoded value of control */
190 char ldctl_iscritical; /* criticality */
194 /* standard track controls */
195 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
196 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
197 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
199 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
200 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.1.10.2"
201 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
202 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
203 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
204 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
206 #define LDAP_CONTROL_SYNC "1.3.6.1.4.1.4203.666.5.6"
207 #define LDAP_CONTROL_SYNC_STATE "1.3.6.1.4.1.4203.666.5.7"
208 #define LDAP_CONTROL_SYNC_DONE "1.3.6.1.4.1.4203.666.5.8"
209 #define LDAP_SYNC_INFO "1.3.6.1.4.1.4203.666.10.2"
211 #define LDAP_SYNC_NONE 0x00
212 #define LDAP_SYNC_REFRESH_ONLY 0x01
213 #define LDAP_SYNC_RESERVED 0x02
214 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
216 #define LDAP_SYNC_REFRESH_PRESENTS 0
217 #define LDAP_SYNC_REFRESH_DELETES 1
219 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
220 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
221 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
222 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
224 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
225 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
226 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
227 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
229 #define LDAP_SYNC_PRESENT 0
230 #define LDAP_SYNC_ADD 1
231 #define LDAP_SYNC_MODIFY 2
232 #define LDAP_SYNC_DELETE 3
235 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
236 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
237 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
238 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
241 /* controls for MSAD compatibility */
242 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
243 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
244 #define LDAP_CONTORL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
246 /* not implemented in slapd(8) */
247 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
248 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
250 /* not implemented in slapd(8) */
251 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
252 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
254 /* LDAP Unsolicited Notifications */
255 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
256 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
258 /* LDAP Extended Operations */
259 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
261 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
262 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
263 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
264 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
265 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
267 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
268 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
271 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
272 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
273 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
274 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
275 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
276 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
278 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
279 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
280 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
281 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
284 * specific LDAP instantiations of BER types we know about
287 /* Overview of LBER tag construction
294 * 1 0 = CONTEXT-SPECIFIC
301 * | 5 ... 1 | TAG-NUMBER
305 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
306 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
308 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
309 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
311 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
312 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
314 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
316 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
317 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
318 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
319 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
321 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
323 /* LDAP Request Messages */
324 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
325 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
326 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
327 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
328 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
329 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
330 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
331 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
332 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
333 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
334 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
335 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
337 /* LDAP Response Messages */
338 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
339 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
340 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
341 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
342 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
343 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
344 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
345 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
346 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
347 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
348 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
349 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
350 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
352 #define LDAP_RES_ANY (-1)
353 #define LDAP_RES_UNSOLICITED (0)
357 #define LDAP_SASL_SIMPLE ((char*)0)
358 #define LDAP_SASL_NULL ("")
361 /* authentication methods available */
362 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
363 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
364 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
365 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
366 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
367 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
371 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
372 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
373 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
374 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
375 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
376 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
377 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
378 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
379 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
380 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
382 /* extended filter component types */
383 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
384 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
385 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
386 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
388 /* substring filter component types */
389 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
390 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
391 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
394 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
395 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
396 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
397 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
398 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
399 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
400 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
401 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
402 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
404 /* substring filter component types */
405 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
406 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
407 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
412 #define LDAP_SUCCESS 0x00
414 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
416 #define LDAP_OPERATIONS_ERROR 0x01
417 #define LDAP_PROTOCOL_ERROR 0x02
418 #define LDAP_TIMELIMIT_EXCEEDED 0x03
419 #define LDAP_SIZELIMIT_EXCEEDED 0x04
420 #define LDAP_COMPARE_FALSE 0x05
421 #define LDAP_COMPARE_TRUE 0x06
422 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
423 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
424 #define LDAP_STRONG_AUTH_REQUIRED 0x08
425 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
427 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
428 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
429 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
430 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
431 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
433 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
435 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
436 #define LDAP_UNDEFINED_TYPE 0x11
437 #define LDAP_INAPPROPRIATE_MATCHING 0x12
438 #define LDAP_CONSTRAINT_VIOLATION 0x13
439 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
440 #define LDAP_INVALID_SYNTAX 0x15
442 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
444 #define LDAP_NO_SUCH_OBJECT 0x20
445 #define LDAP_ALIAS_PROBLEM 0x21
446 #define LDAP_INVALID_DN_SYNTAX 0x22
447 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
448 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
450 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
452 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
453 #define LDAP_INAPPROPRIATE_AUTH 0x30
454 #define LDAP_INVALID_CREDENTIALS 0x31
455 #define LDAP_INSUFFICIENT_ACCESS 0x32
457 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
459 #define LDAP_BUSY 0x33
460 #define LDAP_UNAVAILABLE 0x34
461 #define LDAP_UNWILLING_TO_PERFORM 0x35
462 #define LDAP_LOOP_DETECT 0x36
464 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
466 #define LDAP_NAMING_VIOLATION 0x40
467 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
468 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
469 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
470 #define LDAP_ALREADY_EXISTS 0x44
471 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
472 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
473 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
475 #define LDAP_OTHER 0x50
477 /* Experimental result codes */
478 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
479 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
481 /* for the LDAP Sync operation */
482 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
484 /* for the LDAP No-Op control */
485 #define LDAP_NO_OPERATION 0x410e
487 /* for the Assertion control */
488 #define LDAP_ASSERTION_FAILED 0x410f
490 /* for the Cancel operation */
491 #define LDAP_CANCELLED 0x4110
492 #define LDAP_NO_SUCH_OPERATION 0x4111
493 #define LDAP_TOO_LATE 0x4112
494 #define LDAP_CANNOT_CANCEL 0x4113
498 * Based on draft-ietf-ldap-c-api-xx
499 * but with new negative code values
501 #define LDAP_API_ERROR(n) ((n)<0)
502 #define LDAP_API_RESULT(n) ((n)<=0)
504 #define LDAP_SERVER_DOWN (-1)
505 #define LDAP_LOCAL_ERROR (-2)
506 #define LDAP_ENCODING_ERROR (-3)
507 #define LDAP_DECODING_ERROR (-4)
508 #define LDAP_TIMEOUT (-5)
509 #define LDAP_AUTH_UNKNOWN (-6)
510 #define LDAP_FILTER_ERROR (-7)
511 #define LDAP_USER_CANCELLED (-8)
512 #define LDAP_PARAM_ERROR (-9)
513 #define LDAP_NO_MEMORY (-10)
514 #define LDAP_CONNECT_ERROR (-11)
515 #define LDAP_NOT_SUPPORTED (-12)
516 #define LDAP_CONTROL_NOT_FOUND (-13)
517 #define LDAP_NO_RESULTS_RETURNED (-14)
518 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
519 #define LDAP_CLIENT_LOOP (-16)
520 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
524 * This structure represents both ldap messages and ldap responses.
525 * These are really the same, except in the case of search responses,
526 * where a response has multiple messages.
529 typedef struct ldapmsg LDAPMessage;
531 /* for modifications */
532 typedef struct ldapmod {
535 #define LDAP_MOD_OP (0x0007)
536 #define LDAP_MOD_ADD (0x0000)
537 #define LDAP_MOD_DELETE (0x0001)
538 #define LDAP_MOD_REPLACE (0x0002)
539 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
540 #define LDAP_MOD_BVALUES (0x0080)
541 /* IMPORTANT: do not use code 0x1000 (or above),
542 * it is used internally by the backends!
543 * (see ldap/servers/slapd/slap.h)
549 struct berval **modv_bvals;
551 #define mod_values mod_vals.modv_strvals
552 #define mod_bvalues mod_vals.modv_bvals
556 * structure representing an ldap session which can
557 * encompass connections to multiple servers (in the
558 * face of referrals).
560 typedef struct ldap LDAP;
562 #define LDAP_DEREF_NEVER 0x00
563 #define LDAP_DEREF_SEARCHING 0x01
564 #define LDAP_DEREF_FINDING 0x02
565 #define LDAP_DEREF_ALWAYS 0x03
567 #define LDAP_NO_LIMIT 0
569 /* how many messages to retrieve results for */
570 #define LDAP_MSG_ONE 0x00
571 #define LDAP_MSG_ALL 0x01
572 #define LDAP_MSG_RECEIVED 0x02
575 * types for ldap URL handling
577 typedef struct ldap_url_desc {
578 struct ldap_url_desc *lud_next;
590 #define LDAP_URL_SUCCESS 0x00 /* Success */
591 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
592 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
594 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
595 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
596 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
597 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
598 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
599 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
600 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
601 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
604 * The API draft spec says we should declare (or cause to be declared)
605 * 'struct timeval'. We don't. See IETF LDAPext discussions.
613 ldap_get_option LDAP_P((
619 ldap_set_option LDAP_P((
622 LDAP_CONST void *invalue));
624 /* V3 REBIND Function Callback Prototype */
625 typedef int (LDAP_REBIND_PROC) LDAP_P((
626 LDAP *ld, LDAP_CONST char *url,
627 ber_tag_t request, ber_int_t msgid,
631 ldap_set_rebind_proc LDAP_P((
633 LDAP_REBIND_PROC *rebind_proc,
640 ldap_create_control LDAP_P((
641 LDAP_CONST char *requestOID,
644 LDAPControl **ctrlp ));
647 ldap_control_free LDAP_P((
648 LDAPControl *ctrl ));
651 ldap_controls_free LDAP_P((
652 LDAPControl **ctrls ));
658 ldap_domain2dn LDAP_P((
659 LDAP_CONST char* domain,
663 ldap_dn2domain LDAP_P((
668 ldap_domain2hostlist LDAP_P((
669 LDAP_CONST char *domain,
676 ldap_extended_operation LDAP_P((
678 LDAP_CONST char *reqoid,
679 struct berval *reqdata,
680 LDAPControl **serverctrls,
681 LDAPControl **clientctrls,
685 ldap_extended_operation_s LDAP_P((
687 LDAP_CONST char *reqoid,
688 struct berval *reqdata,
689 LDAPControl **serverctrls,
690 LDAPControl **clientctrls,
692 struct berval **retdatap ));
695 ldap_parse_extended_result LDAP_P((
699 struct berval **retdatap,
703 ldap_parse_intermediate LDAP_P((
707 struct berval **retdatap,
708 LDAPControl ***serverctrls,
715 ldap_abandon_ext LDAP_P((
718 LDAPControl **serverctrls,
719 LDAPControl **clientctrls ));
723 ldap_abandon LDAP_P(( /* deprecated */
733 ldap_add_ext LDAP_P((
737 LDAPControl **serverctrls,
738 LDAPControl **clientctrls,
742 ldap_add_ext_s LDAP_P((
746 LDAPControl **serverctrls,
747 LDAPControl **clientctrls ));
751 ldap_add LDAP_P(( /* deprecated */
757 ldap_add_s LDAP_P(( /* deprecated */
768 ldap_sasl_bind LDAP_P((
771 LDAP_CONST char *mechanism,
773 LDAPControl **serverctrls,
774 LDAPControl **clientctrls,
777 /* Interaction flags (should be passed about in a control)
778 * Automatic (default): use defaults, prompt otherwise
779 * Interactive: prompt always
780 * Quiet: never prompt
782 #define LDAP_SASL_AUTOMATIC 0U
783 #define LDAP_SASL_INTERACTIVE 1U
784 #define LDAP_SASL_QUIET 2U
787 * V3 SASL Interaction Function Callback Prototype
788 * when using Cyrus SASL, interact is pointer to sasl_interact_t
789 * should likely passed in a control (and provided controls)
791 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
792 LDAP *ld, unsigned flags, void* defaults, void *interact ));
795 ldap_sasl_interactive_bind_s LDAP_P((
797 LDAP_CONST char *dn, /* usually NULL */
798 LDAP_CONST char *saslMechanism,
799 LDAPControl **serverControls,
800 LDAPControl **clientControls,
802 /* should be client controls */
804 LDAP_SASL_INTERACT_PROC *proc,
808 ldap_sasl_bind_s LDAP_P((
811 LDAP_CONST char *mechanism,
813 LDAPControl **serverctrls,
814 LDAPControl **clientctrls,
815 struct berval **servercredp ));
818 ldap_parse_sasl_bind_result LDAP_P((
821 struct berval **servercredp,
830 ldap_bind LDAP_P(( /* deprecated */
832 LDAP_CONST char *who,
833 LDAP_CONST char *passwd,
837 ldap_bind_s LDAP_P(( /* deprecated */
839 LDAP_CONST char *who,
840 LDAP_CONST char *cred,
847 ldap_simple_bind LDAP_P(( /* deprecated */
849 LDAP_CONST char *who,
850 LDAP_CONST char *passwd ));
853 ldap_simple_bind_s LDAP_P(( /* deprecated */
855 LDAP_CONST char *who,
856 LDAP_CONST char *passwd ));
864 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
866 LDAP_CONST char *who ));
869 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
871 LDAP_CONST char *who ));
874 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
876 LDAP_CONST char *who ));
879 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
881 LDAP_CONST char *who ));
884 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
886 LDAP_CONST char *who ));
894 ldap_compare_ext LDAP_P((
897 LDAP_CONST char *attr,
898 struct berval *bvalue,
899 LDAPControl **serverctrls,
900 LDAPControl **clientctrls,
904 ldap_compare_ext_s LDAP_P((
907 LDAP_CONST char *attr,
908 struct berval *bvalue,
909 LDAPControl **serverctrls,
910 LDAPControl **clientctrls ));
914 ldap_compare LDAP_P(( /* deprecated */
917 LDAP_CONST char *attr,
918 LDAP_CONST char *value ));
921 ldap_compare_s LDAP_P(( /* deprecated */
924 LDAP_CONST char *attr,
925 LDAP_CONST char *value ));
933 ldap_delete_ext LDAP_P((
936 LDAPControl **serverctrls,
937 LDAPControl **clientctrls,
941 ldap_delete_ext_s LDAP_P((
944 LDAPControl **serverctrls,
945 LDAPControl **clientctrls ));
949 ldap_delete LDAP_P(( /* deprecated */
951 LDAP_CONST char *dn ));
954 ldap_delete_s LDAP_P(( /* deprecated */
956 LDAP_CONST char *dn ));
964 ldap_parse_result LDAP_P((
971 LDAPControl ***serverctrls,
975 ldap_err2string LDAP_P((
980 ldap_result2error LDAP_P(( /* deprecated */
986 ldap_perror LDAP_P(( /* deprecated */
988 LDAP_CONST char *s ));
996 ldap_modify_ext LDAP_P((
1000 LDAPControl **serverctrls,
1001 LDAPControl **clientctrls,
1005 ldap_modify_ext_s LDAP_P((
1007 LDAP_CONST char *dn,
1009 LDAPControl **serverctrls,
1010 LDAPControl **clientctrls ));
1014 ldap_modify LDAP_P(( /* deprecated */
1016 LDAP_CONST char *dn,
1020 ldap_modify_s LDAP_P(( /* deprecated */
1022 LDAP_CONST char *dn,
1031 ldap_rename LDAP_P((
1033 LDAP_CONST char *dn,
1034 LDAP_CONST char *newrdn,
1035 LDAP_CONST char *newSuperior,
1037 LDAPControl **sctrls,
1038 LDAPControl **cctrls,
1042 ldap_rename_s LDAP_P((
1044 LDAP_CONST char *dn,
1045 LDAP_CONST char *newrdn,
1046 LDAP_CONST char *newSuperior,
1048 LDAPControl **sctrls,
1049 LDAPControl **cctrls ));
1053 ldap_rename2 LDAP_P(( /* deprecated */
1055 LDAP_CONST char *dn,
1056 LDAP_CONST char *newrdn,
1057 LDAP_CONST char *newSuperior,
1058 int deleteoldrdn ));
1061 ldap_rename2_s LDAP_P(( /* deprecated */
1063 LDAP_CONST char *dn,
1064 LDAP_CONST char *newrdn,
1065 LDAP_CONST char *newSuperior,
1066 int deleteoldrdn ));
1069 ldap_modrdn LDAP_P(( /* deprecated */
1071 LDAP_CONST char *dn,
1072 LDAP_CONST char *newrdn ));
1075 ldap_modrdn_s LDAP_P(( /* deprecated */
1077 LDAP_CONST char *dn,
1078 LDAP_CONST char *newrdn ));
1081 ldap_modrdn2 LDAP_P(( /* deprecated */
1083 LDAP_CONST char *dn,
1084 LDAP_CONST char *newrdn,
1085 int deleteoldrdn ));
1088 ldap_modrdn2_s LDAP_P(( /* deprecated */
1090 LDAP_CONST char *dn,
1091 LDAP_CONST char *newrdn,
1101 ldap_init LDAP_P(( /* deprecated */
1102 LDAP_CONST char *host,
1106 ldap_open LDAP_P(( /* deprecated */
1107 LDAP_CONST char *host,
1112 ldap_create LDAP_P((
1116 ldap_initialize LDAP_P((
1118 LDAP_CONST char *url ));
1121 ldap_start_tls_s LDAP_P((
1123 LDAPControl **serverctrls,
1124 LDAPControl **clientctrls ));
1129 LDAP_F( LDAPMessage * )
1130 ldap_first_message LDAP_P((
1132 LDAPMessage *chain ));
1134 LDAP_F( LDAPMessage * )
1135 ldap_next_message LDAP_P((
1137 LDAPMessage *msg ));
1140 ldap_count_messages LDAP_P((
1142 LDAPMessage *chain ));
1147 LDAP_F( LDAPMessage * )
1148 ldap_first_reference LDAP_P((
1150 LDAPMessage *chain ));
1152 LDAP_F( LDAPMessage * )
1153 ldap_next_reference LDAP_P((
1155 LDAPMessage *ref ));
1158 ldap_count_references LDAP_P((
1160 LDAPMessage *chain ));
1163 ldap_parse_reference LDAP_P((
1167 LDAPControl ***serverctrls,
1174 LDAP_F( LDAPMessage * )
1175 ldap_first_entry LDAP_P((
1177 LDAPMessage *chain ));
1179 LDAP_F( LDAPMessage * )
1180 ldap_next_entry LDAP_P((
1182 LDAPMessage *entry ));
1185 ldap_count_entries LDAP_P((
1187 LDAPMessage *chain ));
1190 ldap_get_entry_controls LDAP_P((
1193 LDAPControl ***serverctrls));
1199 LDAP_F( LDAPMessage * )
1200 ldap_delete_result_entry LDAP_P((
1205 ldap_add_result_entry LDAP_P((
1214 ldap_get_dn LDAP_P((
1216 LDAPMessage *entry ));
1218 typedef struct ldap_ava {
1219 struct berval la_attr;
1220 struct berval la_value;
1222 #define LDAP_AVA_NULL 0x0000U
1223 #define LDAP_AVA_STRING 0x0001U
1224 #define LDAP_AVA_BINARY 0x0002U
1225 #define LDAP_AVA_NONPRINTABLE 0x0004U
1226 #define LDAP_AVA_FREE_ATTR 0x0010U
1227 #define LDAP_AVA_FREE_VALUE 0x0020U
1232 typedef LDAPAVA** LDAPRDN;
1233 typedef LDAPRDN* LDAPDN;
1236 #define LDAP_DN_FORMAT_LDAP 0x0000U
1237 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1238 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1239 #define LDAP_DN_FORMAT_DCE 0x0030U
1240 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1241 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1242 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1243 #define LDAP_DN_FORMAT_MASK 0x00F0U
1246 #define LDAP_DN_PRETTY 0x0100U
1247 #define LDAP_DN_SKIP 0x0200U
1248 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1249 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1250 #define LDAP_DN_PEDANTIC 0xF000U
1252 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1253 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1262 ldap_str2dn LDAP_P((
1263 LDAP_CONST char *str,
1274 ldap_dn2str LDAP_P((
1280 ldap_bv2rdn LDAP_P((
1287 ldap_str2rdn LDAP_P((
1288 LDAP_CONST char *str,
1294 ldap_rdn2bv LDAP_P((
1300 ldap_rdn2str LDAP_P((
1306 ldap_dn_normalize LDAP_P((
1307 LDAP_CONST char *in, unsigned iflags,
1308 char **out, unsigned oflags ));
1311 ldap_dn2ufn LDAP_P(( /* deprecated */
1312 LDAP_CONST char *dn ));
1315 ldap_explode_dn LDAP_P(( /* deprecated */
1316 LDAP_CONST char *dn,
1320 ldap_explode_rdn LDAP_P(( /* deprecated */
1321 LDAP_CONST char *rdn,
1324 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1327 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1328 LDAPDN_rewrite_func *func, unsigned flags ));
1331 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1334 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1337 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1340 ldap_get_dn_ber LDAP_P((
1341 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1344 ldap_get_attribute_ber LDAP_P((
1345 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1346 struct berval **vals ));
1352 ldap_first_attribute LDAP_P((
1355 BerElement **ber ));
1358 ldap_next_attribute LDAP_P((
1367 LDAP_F( struct berval ** )
1368 ldap_get_values_len LDAP_P((
1371 LDAP_CONST char *target ));
1374 ldap_count_values_len LDAP_P((
1375 struct berval **vals ));
1378 ldap_value_free_len LDAP_P((
1379 struct berval **vals ));
1383 ldap_get_values LDAP_P(( /* deprecated */
1386 LDAP_CONST char *target ));
1389 ldap_count_values LDAP_P(( /* deprecated */
1393 ldap_value_free LDAP_P(( /* deprecated */
1401 ldap_result LDAP_P((
1405 struct timeval *timeout,
1406 LDAPMessage **result ));
1409 ldap_msgtype LDAP_P((
1417 ldap_msgfree LDAP_P((
1421 ldap_msgdelete LDAP_P((
1430 ldap_search_ext LDAP_P((
1432 LDAP_CONST char *base,
1434 LDAP_CONST char *filter,
1437 LDAPControl **serverctrls,
1438 LDAPControl **clientctrls,
1439 struct timeval *timeout,
1444 ldap_search_ext_s LDAP_P((
1446 LDAP_CONST char *base,
1448 LDAP_CONST char *filter,
1451 LDAPControl **serverctrls,
1452 LDAPControl **clientctrls,
1453 struct timeval *timeout,
1455 LDAPMessage **res ));
1459 ldap_search LDAP_P(( /* deprecated */
1461 LDAP_CONST char *base,
1463 LDAP_CONST char *filter,
1468 ldap_search_s LDAP_P(( /* deprecated */
1470 LDAP_CONST char *base,
1472 LDAP_CONST char *filter,
1475 LDAPMessage **res ));
1478 ldap_search_st LDAP_P(( /* deprecated */
1480 LDAP_CONST char *base,
1482 LDAP_CONST char *filter,
1485 struct timeval *timeout,
1486 LDAPMessage **res ));
1493 ldap_unbind_ext LDAP_P((
1495 LDAPControl **serverctrls,
1496 LDAPControl **clientctrls));
1499 ldap_unbind_ext_s LDAP_P((
1501 LDAPControl **serverctrls,
1502 LDAPControl **clientctrls));
1506 ldap_unbind LDAP_P(( /* deprecated */
1510 ldap_unbind_s LDAP_P(( /* deprecated */
1518 ldap_put_vrFilter LDAP_P((
1527 ldap_memalloc LDAP_P((
1531 ldap_memrealloc LDAP_P((
1536 ldap_memcalloc LDAP_P((
1541 ldap_memfree LDAP_P((
1545 ldap_memvfree LDAP_P((
1549 ldap_strdup LDAP_P((
1550 LDAP_CONST char * ));
1553 ldap_mods_free LDAP_P((
1560 * in sort.c (deprecated)
1562 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1563 LDAP_CONST char *left,
1564 LDAP_CONST char *right ));
1566 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1567 LDAP_CONST void *left,
1568 LDAP_CONST void *right ));
1570 LDAP_F( int ) /* deprecated */
1571 ldap_sort_entries LDAP_P(( LDAP *ld,
1572 LDAPMessage **chain,
1573 LDAP_CONST char *attr,
1574 LDAP_SORT_AD_CMP_PROC *cmp ));
1576 LDAP_F( int ) /* deprecated */
1577 ldap_sort_values LDAP_P((
1580 LDAP_SORT_AV_CMP_PROC *cmp ));
1582 LDAP_F( int ) /* deprecated */
1583 ldap_sort_strcasecmp LDAP_P((
1585 LDAP_CONST void *b ));
1592 ldap_is_ldap_url LDAP_P((
1593 LDAP_CONST char *url ));
1596 ldap_is_ldaps_url LDAP_P((
1597 LDAP_CONST char *url ));
1600 ldap_is_ldapi_url LDAP_P((
1601 LDAP_CONST char *url ));
1604 ldap_url_parse LDAP_P((
1605 LDAP_CONST char *url,
1606 LDAPURLDesc **ludpp ));
1609 ldap_url_desc2str LDAP_P((
1610 LDAPURLDesc *ludp ));
1613 ldap_free_urldesc LDAP_P((
1614 LDAPURLDesc *ludp ));
1618 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1621 #define LDAP_API_FEATURE_CANCEL 1000
1624 ldap_cancel LDAP_P(( LDAP *ld,
1626 LDAPControl **sctrls,
1627 LDAPControl **cctrls,
1631 ldap_cancel_s LDAP_P((
1634 LDAPControl **sctrl,
1635 LDAPControl **cctrl ));
1638 * LDAP Server Side Sort
1641 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1643 /* structure for a sort-key */
1644 typedef struct ldapsortkey {
1645 char * attributeType;
1646 char * orderingRule;
1651 ldap_create_sort_keylist LDAP_P((
1652 LDAPSortKey ***sortKeyList,
1656 ldap_free_sort_keylist LDAP_P((
1657 LDAPSortKey **sortkeylist ));
1660 ldap_create_sort_control LDAP_P((
1662 LDAPSortKey **keyList,
1664 LDAPControl **ctrlp ));
1667 ldap_parse_sort_control LDAP_P((
1669 LDAPControl **ctrlp,
1670 unsigned long *result,
1671 char **attribute ));
1675 * LDAP Virtual List View
1678 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1680 /* structure for virtual list */
1681 typedef struct ldapvlvinfo {
1683 unsigned long ldvlv_before_count;
1684 unsigned long ldvlv_after_count;
1685 unsigned long ldvlv_offset;
1686 unsigned long ldvlv_count;
1687 struct berval * ldvlv_attrvalue;
1688 struct berval * ldvlv_context;
1689 void * ldvlv_extradata;
1693 ldap_create_vlv_control LDAP_P((
1695 LDAPVLVInfo *ldvlistp,
1696 LDAPControl **ctrlp ));
1699 ldap_parse_vlv_control LDAP_P((
1701 LDAPControl **ctrls,
1702 unsigned long *target_posp,
1703 unsigned long *list_countp,
1704 struct berval **contextp,
1711 #define LDAP_API_FEATURE_WHOAMI 1000
1714 ldap_parse_whoami LDAP_P((
1717 struct berval **authzid ));
1720 ldap_whoami LDAP_P(( LDAP *ld,
1721 LDAPControl **sctrls,
1722 LDAPControl **cctrls,
1726 ldap_whoami_s LDAP_P((
1728 struct berval **authzid,
1729 LDAPControl **sctrls,
1730 LDAPControl **cctrls ));
1733 * LDAP Password Modify
1736 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1739 ldap_parse_passwd LDAP_P((
1742 struct berval *newpasswd ));
1745 ldap_passwd LDAP_P(( LDAP *ld,
1746 struct berval *user,
1747 struct berval *oldpw,
1748 struct berval *newpw,
1749 LDAPControl **sctrls,
1750 LDAPControl **cctrls,
1754 ldap_passwd_s LDAP_P((
1756 struct berval *user,
1757 struct berval *oldpw,
1758 struct berval *newpw,
1759 struct berval *newpasswd,
1760 LDAPControl **sctrls,
1761 LDAPControl **cctrls ));
1765 #endif /* _LDAP_H */