2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2003 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
45 /* Use -DLDAP_DEPRECATED=0 to hide deprecated interfaces */
46 #ifndef LDAP_DEPRECATED
47 #define LDAP_DEPRECATED 1
51 * We use 3000+n here because it is above 1823 (for RFC 1823),
52 * above 2000+rev of IETF LDAPEXT draft (now quite dated),
53 * yet below allocations for new RFCs (just in case there is
54 * someday an RFC produced).
56 #define LDAP_API_VERSION 3001
57 #define LDAP_VENDOR_NAME "OpenLDAP"
59 /* OpenLDAP API Features */
60 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
62 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
63 ( defined( LDAP_THREAD_SAFE ) && \
64 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
65 /* -lldap may or may not be thread safe */
66 /* -lldap_r, if available, is always thread safe */
67 # define LDAP_API_FEATURE_THREAD_SAFE 1
69 #if defined( LDAP_THREAD_SAFE ) && \
70 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
71 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
72 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
76 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
77 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
79 #define LDAP_ROOT_DSE ""
80 #define LDAP_NO_ATTRS "1.1"
81 #define LDAP_ALL_USER_ATTRIBUTES "*"
82 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
86 * 0x0000 - 0x0fff reserved for api options
87 * 0x1000 - 0x3fff reserved for api extended options
88 * 0x4000 - 0x7fff reserved for private and experimental options
91 #define LDAP_OPT_API_INFO 0x0000
92 #define LDAP_OPT_DESC 0x0001 /* historic */
93 #define LDAP_OPT_DEREF 0x0002
94 #define LDAP_OPT_SIZELIMIT 0x0003
95 #define LDAP_OPT_TIMELIMIT 0x0004
96 /* 0x05 - 0x07 not defined */
97 #define LDAP_OPT_REFERRALS 0x0008
98 #define LDAP_OPT_RESTART 0x0009
99 /* 0x0a - 0x10 not defined */
100 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
101 #define LDAP_OPT_SERVER_CONTROLS 0x0012
102 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
103 /* 0x14 not defined */
104 #define LDAP_OPT_API_FEATURE_INFO 0x0015
105 /* 0x16 - 0x2f not defined */
106 #define LDAP_OPT_HOST_NAME 0x0030
107 #define LDAP_OPT_RESULT_CODE 0x0031
108 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
109 #define LDAP_OPT_ERROR_STRING 0x0032
110 #define LDAP_OPT_MATCHED_DN 0x0033
111 /* 0x0034 - 0x3fff not defined */
114 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
116 /* private and experimental options */
117 /* OpenLDAP specific options */
118 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
119 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
120 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
121 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
122 #define LDAP_OPT_URI 0x5006
123 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
125 /* OpenLDAP TLS options */
126 #define LDAP_OPT_X_TLS 0x6000
127 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
128 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
129 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
130 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
131 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
132 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
133 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
134 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
135 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
136 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
138 #define LDAP_OPT_X_TLS_NEVER 0
139 #define LDAP_OPT_X_TLS_HARD 1
140 #define LDAP_OPT_X_TLS_DEMAND 2
141 #define LDAP_OPT_X_TLS_ALLOW 3
142 #define LDAP_OPT_X_TLS_TRY 4
144 /* OpenLDAP SASL options */
145 #define LDAP_OPT_X_SASL_MECH 0x6100
146 #define LDAP_OPT_X_SASL_REALM 0x6101
147 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
148 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
149 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
150 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
151 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
152 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
153 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
154 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
156 /* Private API Extensions -- reserved for application use */
157 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
160 * ldap_get_option() and ldap_set_option() return values.
161 * As later versions may return other values indicating
162 * failure, current applications should only compare returned
163 * value against LDAP_OPT_SUCCESS.
165 #define LDAP_OPT_SUCCESS 0
166 #define LDAP_OPT_ERROR (-1)
168 /* option on/off values */
169 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
170 #define LDAP_OPT_OFF ((void *) 0)
172 typedef struct ldapapiinfo {
173 int ldapai_info_version; /* version of LDAPAPIInfo */
174 #define LDAP_API_INFO_VERSION (1)
175 int ldapai_api_version; /* revision of API supported */
176 int ldapai_protocol_version; /* highest LDAP version supported */
177 char **ldapai_extensions; /* names of API extensions */
178 char *ldapai_vendor_name; /* name of supplier */
179 int ldapai_vendor_version; /* supplier-specific version * 100 */
182 typedef struct ldap_apifeature_info {
183 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
184 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
185 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
186 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
187 } LDAPAPIFeatureInfo;
190 * LDAP Control structure
192 typedef struct ldapcontrol {
193 char * ldctl_oid; /* numericoid of control */
194 struct berval ldctl_value; /* encoded value of control */
195 char ldctl_iscritical; /* criticality */
199 /* standard track controls */
200 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
201 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
202 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
204 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
205 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.1.10.2"
206 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
207 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
208 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
209 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
211 #define LDAP_CONTROL_SYNC "1.3.6.1.4.1.4203.666.5.6"
212 #define LDAP_CONTROL_SYNC_STATE "1.3.6.1.4.1.4203.666.5.7"
213 #define LDAP_CONTROL_SYNC_DONE "1.3.6.1.4.1.4203.666.5.8"
214 #define LDAP_SYNC_INFO "1.3.6.1.4.1.4203.666.10.2"
216 #define LDAP_SYNC_NONE 0x00
217 #define LDAP_SYNC_REFRESH_ONLY 0x01
218 #define LDAP_SYNC_RESERVED 0x02
219 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
221 #define LDAP_SYNC_REFRESH_PRESENTS 0
222 #define LDAP_SYNC_REFRESH_DELETES 1
224 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
225 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
226 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
227 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
229 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
230 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
231 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
232 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
234 #define LDAP_SYNC_PRESENT 0
235 #define LDAP_SYNC_ADD 1
236 #define LDAP_SYNC_MODIFY 2
237 #define LDAP_SYNC_DELETE 3
240 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
241 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
242 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
243 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
246 /* controls for MSAD compatibility */
247 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
248 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
250 /* not implemented in slapd(8) */
251 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
252 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
254 /* not implemented in slapd(8) */
255 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
256 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
258 /* LDAP Unsolicited Notifications */
259 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
260 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
262 /* LDAP Extended Operations */
263 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
265 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
266 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
267 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
268 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
269 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
271 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
272 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
275 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
276 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
277 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
278 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
279 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
280 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
282 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
285 * specific LDAP instantiations of BER types we know about
288 /* Overview of LBER tag construction
295 * 1 0 = CONTEXT-SPECIFIC
302 * | 5 ... 1 | TAG-NUMBER
306 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
307 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
309 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
310 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
312 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
313 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
315 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
317 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
318 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
319 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
320 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
322 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
324 /* possible operations a client can invoke */
325 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
326 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
327 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
328 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
329 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
330 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
331 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
332 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
333 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
334 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
335 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
336 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
338 /* possible result types a server can return */
339 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
340 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
341 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
342 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
343 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
344 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
345 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
346 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
347 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
348 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
349 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
350 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
351 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
353 #define LDAP_RES_ANY (-1)
354 #define LDAP_RES_UNSOLICITED (0)
358 #define LDAP_SASL_SIMPLE ((char*)0)
359 #define LDAP_SASL_NULL ("")
362 /* authentication methods available */
363 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
364 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
365 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
366 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
367 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
368 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
372 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
373 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
374 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
375 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
376 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
377 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
378 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
379 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
380 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
381 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
383 /* extended filter component types */
384 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
385 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
386 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
387 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
389 /* substring filter component types */
390 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
391 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
392 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
395 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
396 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
397 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
398 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
399 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
400 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
401 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
403 /* substring filter component types */
404 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
405 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
406 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
409 * possible error codes we can return
412 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
414 #define LDAP_SUCCESS 0x00
415 #define LDAP_OPERATIONS_ERROR 0x01
416 #define LDAP_PROTOCOL_ERROR 0x02
417 #define LDAP_TIMELIMIT_EXCEEDED 0x03
418 #define LDAP_SIZELIMIT_EXCEEDED 0x04
419 #define LDAP_COMPARE_FALSE 0x05
420 #define LDAP_COMPARE_TRUE 0x06
421 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
422 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
423 #define LDAP_STRONG_AUTH_REQUIRED 0x08
424 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
426 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
427 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
428 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
429 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
430 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
432 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
434 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
435 #define LDAP_UNDEFINED_TYPE 0x11
436 #define LDAP_INAPPROPRIATE_MATCHING 0x12
437 #define LDAP_CONSTRAINT_VIOLATION 0x13
438 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
439 #define LDAP_INVALID_SYNTAX 0x15
441 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
443 #define LDAP_NO_SUCH_OBJECT 0x20
444 #define LDAP_ALIAS_PROBLEM 0x21
445 #define LDAP_INVALID_DN_SYNTAX 0x22
446 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
447 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
449 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
451 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
452 #define LDAP_INAPPROPRIATE_AUTH 0x30
453 #define LDAP_INVALID_CREDENTIALS 0x31
454 #define LDAP_INSUFFICIENT_ACCESS 0x32
456 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
458 #define LDAP_BUSY 0x33
459 #define LDAP_UNAVAILABLE 0x34
460 #define LDAP_UNWILLING_TO_PERFORM 0x35
461 #define LDAP_LOOP_DETECT 0x36
463 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
465 #define LDAP_NAMING_VIOLATION 0x40
466 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
467 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
468 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
469 #define LDAP_ALREADY_EXISTS 0x44
470 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
471 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
472 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
474 #define LDAP_OTHER 0x50
476 /* Experimental result codes */
477 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
478 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
480 /* for the LDAP Sync operation */
481 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
483 /* for the Assertion control */
484 #define LDAP_ASSERTION_FAILED 0x410f
486 /* for the Cancel operation */
487 #define LDAP_CANCELLED 0x4110
488 #define LDAP_NO_SUCH_OPERATION 0x4111
489 #define LDAP_TOO_LATE 0x4112
490 #define LDAP_CANNOT_CANCEL 0x4113
494 * Based on draft-ietf-ldap-c-api-xx
495 * but with new negative code values
497 #define LDAP_API_ERROR(n) ((n)<0)
498 #define LDAP_API_RESULT(n) ((n)<=0)
500 #define LDAP_SERVER_DOWN (-1)
501 #define LDAP_LOCAL_ERROR (-2)
502 #define LDAP_ENCODING_ERROR (-3)
503 #define LDAP_DECODING_ERROR (-4)
504 #define LDAP_TIMEOUT (-5)
505 #define LDAP_AUTH_UNKNOWN (-6)
506 #define LDAP_FILTER_ERROR (-7)
507 #define LDAP_USER_CANCELLED (-8)
508 #define LDAP_PARAM_ERROR (-9)
509 #define LDAP_NO_MEMORY (-10)
510 #define LDAP_CONNECT_ERROR (-11)
511 #define LDAP_NOT_SUPPORTED (-12)
512 #define LDAP_CONTROL_NOT_FOUND (-13)
513 #define LDAP_NO_RESULTS_RETURNED (-14)
514 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
515 #define LDAP_CLIENT_LOOP (-16)
516 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
520 * This structure represents both ldap messages and ldap responses.
521 * These are really the same, except in the case of search responses,
522 * where a response has multiple messages.
525 typedef struct ldapmsg LDAPMessage;
527 /* for modifications */
528 typedef struct ldapmod {
531 #define LDAP_MOD_OP (0x0007)
532 #define LDAP_MOD_ADD (0x0000)
533 #define LDAP_MOD_DELETE (0x0001)
534 #define LDAP_MOD_REPLACE (0x0002)
535 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
536 #define LDAP_MOD_BVALUES (0x0080)
537 /* IMPORTANT: do not use code 0x1000 (or above),
538 * it is used internally by the backends!
539 * (see ldap/servers/slapd/slap.h)
545 struct berval **modv_bvals;
547 #define mod_values mod_vals.modv_strvals
548 #define mod_bvalues mod_vals.modv_bvals
552 * structure representing an ldap session which can
553 * encompass connections to multiple servers (in the
554 * face of referrals).
556 typedef struct ldap LDAP;
558 #define LDAP_DEREF_NEVER 0x00
559 #define LDAP_DEREF_SEARCHING 0x01
560 #define LDAP_DEREF_FINDING 0x02
561 #define LDAP_DEREF_ALWAYS 0x03
563 #define LDAP_NO_LIMIT 0
565 /* how many messages to retrieve results for */
566 #define LDAP_MSG_ONE 0x00
567 #define LDAP_MSG_ALL 0x01
568 #define LDAP_MSG_RECEIVED 0x02
571 * types for ldap URL handling
573 typedef struct ldap_url_desc {
574 struct ldap_url_desc *lud_next;
586 #define LDAP_URL_SUCCESS 0x00 /* Success */
587 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
588 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
590 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
591 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
592 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
593 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
594 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
595 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
596 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
597 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
600 * The API draft spec says we should declare (or cause to be declared)
601 * 'struct timeval'. We don't. See IETF LDAPext discussions.
609 ldap_get_option LDAP_P((
615 ldap_set_option LDAP_P((
618 LDAP_CONST void *invalue));
620 /* V3 REBIND Function Callback Prototype */
621 typedef int (LDAP_REBIND_PROC) LDAP_P((
622 LDAP *ld, LDAP_CONST char *url,
623 ber_tag_t request, ber_int_t msgid,
627 ldap_set_rebind_proc LDAP_P((
629 LDAP_REBIND_PROC *rebind_proc,
636 ldap_create_control LDAP_P((
637 LDAP_CONST char *requestOID,
640 LDAPControl **ctrlp ));
643 ldap_control_free LDAP_P((
644 LDAPControl *ctrl ));
647 ldap_controls_free LDAP_P((
648 LDAPControl **ctrls ));
654 ldap_domain2dn LDAP_P((
655 LDAP_CONST char* domain,
659 ldap_dn2domain LDAP_P((
664 ldap_domain2hostlist LDAP_P((
665 LDAP_CONST char *domain,
672 ldap_extended_operation LDAP_P((
674 LDAP_CONST char *reqoid,
675 struct berval *reqdata,
676 LDAPControl **serverctrls,
677 LDAPControl **clientctrls,
681 ldap_extended_operation_s LDAP_P((
683 LDAP_CONST char *reqoid,
684 struct berval *reqdata,
685 LDAPControl **serverctrls,
686 LDAPControl **clientctrls,
688 struct berval **retdatap ));
691 ldap_parse_extended_result LDAP_P((
695 struct berval **retdatap,
699 ldap_parse_intermediate LDAP_P((
703 struct berval **retdatap,
704 LDAPControl ***serverctrls,
711 ldap_abandon_ext LDAP_P((
714 LDAPControl **serverctrls,
715 LDAPControl **clientctrls ));
719 ldap_abandon LDAP_P(( /* deprecated */
729 ldap_add_ext LDAP_P((
733 LDAPControl **serverctrls,
734 LDAPControl **clientctrls,
738 ldap_add_ext_s LDAP_P((
742 LDAPControl **serverctrls,
743 LDAPControl **clientctrls ));
747 ldap_add LDAP_P(( /* deprecated */
753 ldap_add_s LDAP_P(( /* deprecated */
764 ldap_sasl_bind LDAP_P((
767 LDAP_CONST char *mechanism,
769 LDAPControl **serverctrls,
770 LDAPControl **clientctrls,
773 /* Interaction flags (should be passed about in a control)
774 * Automatic (default): use defaults, prompt otherwise
775 * Interactive: prompt always
776 * Quiet: never prompt
778 #define LDAP_SASL_AUTOMATIC 0U
779 #define LDAP_SASL_INTERACTIVE 1U
780 #define LDAP_SASL_QUIET 2U
783 * V3 SASL Interaction Function Callback Prototype
784 * when using Cyrus SASL, interact is pointer to sasl_interact_t
785 * should likely passed in a control (and provided controls)
787 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
788 LDAP *ld, unsigned flags, void* defaults, void *interact ));
791 ldap_sasl_interactive_bind_s LDAP_P((
793 LDAP_CONST char *dn, /* usually NULL */
794 LDAP_CONST char *saslMechanism,
795 LDAPControl **serverControls,
796 LDAPControl **clientControls,
798 /* should be client controls */
800 LDAP_SASL_INTERACT_PROC *proc,
804 ldap_sasl_bind_s LDAP_P((
807 LDAP_CONST char *mechanism,
809 LDAPControl **serverctrls,
810 LDAPControl **clientctrls,
811 struct berval **servercredp ));
814 ldap_parse_sasl_bind_result LDAP_P((
817 struct berval **servercredp,
826 ldap_bind LDAP_P(( /* deprecated */
828 LDAP_CONST char *who,
829 LDAP_CONST char *passwd,
833 ldap_bind_s LDAP_P(( /* deprecated */
835 LDAP_CONST char *who,
836 LDAP_CONST char *cred,
843 ldap_simple_bind LDAP_P(( /* deprecated */
845 LDAP_CONST char *who,
846 LDAP_CONST char *passwd ));
849 ldap_simple_bind_s LDAP_P(( /* deprecated */
851 LDAP_CONST char *who,
852 LDAP_CONST char *passwd ));
860 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
862 LDAP_CONST char *who ));
865 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
867 LDAP_CONST char *who ));
870 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
872 LDAP_CONST char *who ));
875 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
877 LDAP_CONST char *who ));
880 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
882 LDAP_CONST char *who ));
890 ldap_compare_ext LDAP_P((
893 LDAP_CONST char *attr,
894 struct berval *bvalue,
895 LDAPControl **serverctrls,
896 LDAPControl **clientctrls,
900 ldap_compare_ext_s LDAP_P((
903 LDAP_CONST char *attr,
904 struct berval *bvalue,
905 LDAPControl **serverctrls,
906 LDAPControl **clientctrls ));
910 ldap_compare LDAP_P(( /* deprecated */
913 LDAP_CONST char *attr,
914 LDAP_CONST char *value ));
917 ldap_compare_s LDAP_P(( /* deprecated */
920 LDAP_CONST char *attr,
921 LDAP_CONST char *value ));
929 ldap_delete_ext LDAP_P((
932 LDAPControl **serverctrls,
933 LDAPControl **clientctrls,
937 ldap_delete_ext_s LDAP_P((
940 LDAPControl **serverctrls,
941 LDAPControl **clientctrls ));
945 ldap_delete LDAP_P(( /* deprecated */
947 LDAP_CONST char *dn ));
950 ldap_delete_s LDAP_P(( /* deprecated */
952 LDAP_CONST char *dn ));
960 ldap_parse_result LDAP_P((
967 LDAPControl ***serverctrls,
971 ldap_err2string LDAP_P((
976 ldap_result2error LDAP_P(( /* deprecated */
982 ldap_perror LDAP_P(( /* deprecated */
984 LDAP_CONST char *s ));
992 ldap_modify_ext LDAP_P((
996 LDAPControl **serverctrls,
997 LDAPControl **clientctrls,
1001 ldap_modify_ext_s LDAP_P((
1003 LDAP_CONST char *dn,
1005 LDAPControl **serverctrls,
1006 LDAPControl **clientctrls ));
1010 ldap_modify LDAP_P(( /* deprecated */
1012 LDAP_CONST char *dn,
1016 ldap_modify_s LDAP_P(( /* deprecated */
1018 LDAP_CONST char *dn,
1027 ldap_rename LDAP_P((
1029 LDAP_CONST char *dn,
1030 LDAP_CONST char *newrdn,
1031 LDAP_CONST char *newSuperior,
1033 LDAPControl **sctrls,
1034 LDAPControl **cctrls,
1038 ldap_rename_s LDAP_P((
1040 LDAP_CONST char *dn,
1041 LDAP_CONST char *newrdn,
1042 LDAP_CONST char *newSuperior,
1044 LDAPControl **sctrls,
1045 LDAPControl **cctrls ));
1049 ldap_rename2 LDAP_P(( /* deprecated */
1051 LDAP_CONST char *dn,
1052 LDAP_CONST char *newrdn,
1053 LDAP_CONST char *newSuperior,
1054 int deleteoldrdn ));
1057 ldap_rename2_s LDAP_P(( /* deprecated */
1059 LDAP_CONST char *dn,
1060 LDAP_CONST char *newrdn,
1061 LDAP_CONST char *newSuperior,
1062 int deleteoldrdn ));
1065 ldap_modrdn LDAP_P(( /* deprecated */
1067 LDAP_CONST char *dn,
1068 LDAP_CONST char *newrdn ));
1071 ldap_modrdn_s LDAP_P(( /* deprecated */
1073 LDAP_CONST char *dn,
1074 LDAP_CONST char *newrdn ));
1077 ldap_modrdn2 LDAP_P(( /* deprecated */
1079 LDAP_CONST char *dn,
1080 LDAP_CONST char *newrdn,
1081 int deleteoldrdn ));
1084 ldap_modrdn2_s LDAP_P(( /* deprecated */
1086 LDAP_CONST char *dn,
1087 LDAP_CONST char *newrdn,
1097 ldap_init LDAP_P(( /* deprecated */
1098 LDAP_CONST char *host,
1102 ldap_open LDAP_P(( /* deprecated */
1103 LDAP_CONST char *host,
1108 ldap_create LDAP_P((
1112 ldap_initialize LDAP_P((
1114 LDAP_CONST char *url ));
1117 ldap_start_tls_s LDAP_P((
1119 LDAPControl **serverctrls,
1120 LDAPControl **clientctrls ));
1125 LDAP_F( LDAPMessage * )
1126 ldap_first_message LDAP_P((
1128 LDAPMessage *chain ));
1130 LDAP_F( LDAPMessage * )
1131 ldap_next_message LDAP_P((
1133 LDAPMessage *msg ));
1136 ldap_count_messages LDAP_P((
1138 LDAPMessage *chain ));
1143 LDAP_F( LDAPMessage * )
1144 ldap_first_reference LDAP_P((
1146 LDAPMessage *chain ));
1148 LDAP_F( LDAPMessage * )
1149 ldap_next_reference LDAP_P((
1151 LDAPMessage *ref ));
1154 ldap_count_references LDAP_P((
1156 LDAPMessage *chain ));
1159 ldap_parse_reference LDAP_P((
1163 LDAPControl ***serverctrls,
1170 LDAP_F( LDAPMessage * )
1171 ldap_first_entry LDAP_P((
1173 LDAPMessage *chain ));
1175 LDAP_F( LDAPMessage * )
1176 ldap_next_entry LDAP_P((
1178 LDAPMessage *entry ));
1181 ldap_count_entries LDAP_P((
1183 LDAPMessage *chain ));
1186 ldap_get_entry_controls LDAP_P((
1189 LDAPControl ***serverctrls));
1195 LDAP_F( LDAPMessage * )
1196 ldap_delete_result_entry LDAP_P((
1201 ldap_add_result_entry LDAP_P((
1210 ldap_get_dn LDAP_P((
1212 LDAPMessage *entry ));
1214 typedef struct ldap_ava {
1215 struct berval la_attr;
1216 struct berval la_value;
1218 #define LDAP_AVA_NULL 0x0000U
1219 #define LDAP_AVA_STRING 0x0001U
1220 #define LDAP_AVA_BINARY 0x0002U
1221 #define LDAP_AVA_NONPRINTABLE 0x0004U
1222 #define LDAP_AVA_FREE_ATTR 0x0010U
1223 #define LDAP_AVA_FREE_VALUE 0x0020U
1228 typedef LDAPAVA** LDAPRDN;
1229 typedef LDAPRDN* LDAPDN;
1232 #define LDAP_DN_FORMAT_LDAP 0x0000U
1233 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1234 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1235 #define LDAP_DN_FORMAT_DCE 0x0030U
1236 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1237 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1238 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1239 #define LDAP_DN_FORMAT_MASK 0x00F0U
1242 #define LDAP_DN_PRETTY 0x0100U
1243 #define LDAP_DN_SKIP 0x0200U
1244 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1245 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1246 #define LDAP_DN_PEDANTIC 0xF000U
1248 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1249 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1258 ldap_str2dn LDAP_P((
1259 LDAP_CONST char *str,
1270 ldap_dn2str LDAP_P((
1276 ldap_bv2rdn LDAP_P((
1283 ldap_str2rdn LDAP_P((
1284 LDAP_CONST char *str,
1290 ldap_rdn2bv LDAP_P((
1296 ldap_rdn2str LDAP_P((
1302 ldap_dn_normalize LDAP_P((
1303 LDAP_CONST char *in, unsigned iflags,
1304 char **out, unsigned oflags ));
1307 ldap_dn2ufn LDAP_P(( /* deprecated */
1308 LDAP_CONST char *dn ));
1311 ldap_explode_dn LDAP_P(( /* deprecated */
1312 LDAP_CONST char *dn,
1316 ldap_explode_rdn LDAP_P(( /* deprecated */
1317 LDAP_CONST char *rdn,
1320 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1323 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1324 LDAPDN_rewrite_func *func, unsigned flags ));
1327 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1330 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1333 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1336 ldap_get_dn_ber LDAP_P((
1337 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1340 ldap_get_attribute_ber LDAP_P((
1341 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1342 struct berval **vals ));
1348 ldap_first_attribute LDAP_P((
1351 BerElement **ber ));
1354 ldap_next_attribute LDAP_P((
1363 LDAP_F( struct berval ** )
1364 ldap_get_values_len LDAP_P((
1367 LDAP_CONST char *target ));
1370 ldap_count_values_len LDAP_P((
1371 struct berval **vals ));
1374 ldap_value_free_len LDAP_P((
1375 struct berval **vals ));
1379 ldap_get_values LDAP_P(( /* deprecated */
1382 LDAP_CONST char *target ));
1385 ldap_count_values LDAP_P(( /* deprecated */
1389 ldap_value_free LDAP_P(( /* deprecated */
1397 ldap_result LDAP_P((
1401 struct timeval *timeout,
1402 LDAPMessage **result ));
1405 ldap_msgtype LDAP_P((
1413 ldap_msgfree LDAP_P((
1417 ldap_msgdelete LDAP_P((
1426 ldap_search_ext LDAP_P((
1428 LDAP_CONST char *base,
1430 LDAP_CONST char *filter,
1433 LDAPControl **serverctrls,
1434 LDAPControl **clientctrls,
1435 struct timeval *timeout,
1440 ldap_search_ext_s LDAP_P((
1442 LDAP_CONST char *base,
1444 LDAP_CONST char *filter,
1447 LDAPControl **serverctrls,
1448 LDAPControl **clientctrls,
1449 struct timeval *timeout,
1451 LDAPMessage **res ));
1455 ldap_search LDAP_P(( /* deprecated */
1457 LDAP_CONST char *base,
1459 LDAP_CONST char *filter,
1464 ldap_search_s LDAP_P(( /* deprecated */
1466 LDAP_CONST char *base,
1468 LDAP_CONST char *filter,
1471 LDAPMessage **res ));
1474 ldap_search_st LDAP_P(( /* deprecated */
1476 LDAP_CONST char *base,
1478 LDAP_CONST char *filter,
1481 struct timeval *timeout,
1482 LDAPMessage **res ));
1489 ldap_unbind_ext LDAP_P((
1491 LDAPControl **serverctrls,
1492 LDAPControl **clientctrls));
1495 ldap_unbind_ext_s LDAP_P((
1497 LDAPControl **serverctrls,
1498 LDAPControl **clientctrls));
1502 ldap_unbind LDAP_P(( /* deprecated */
1506 ldap_unbind_s LDAP_P(( /* deprecated */
1514 ldap_put_vrFilter LDAP_P((
1523 ldap_memalloc LDAP_P((
1527 ldap_memrealloc LDAP_P((
1532 ldap_memcalloc LDAP_P((
1537 ldap_memfree LDAP_P((
1541 ldap_memvfree LDAP_P((
1545 ldap_strdup LDAP_P((
1546 LDAP_CONST char * ));
1549 ldap_mods_free LDAP_P((
1556 * in sort.c (deprecated)
1558 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1559 LDAP_CONST char *left,
1560 LDAP_CONST char *right ));
1562 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1563 LDAP_CONST void *left,
1564 LDAP_CONST void *right ));
1566 LDAP_F( int ) /* deprecated */
1567 ldap_sort_entries LDAP_P(( LDAP *ld,
1568 LDAPMessage **chain,
1569 LDAP_CONST char *attr,
1570 LDAP_SORT_AD_CMP_PROC *cmp ));
1572 LDAP_F( int ) /* deprecated */
1573 ldap_sort_values LDAP_P((
1576 LDAP_SORT_AV_CMP_PROC *cmp ));
1578 LDAP_F( int ) /* deprecated */
1579 ldap_sort_strcasecmp LDAP_P((
1581 LDAP_CONST void *b ));
1588 ldap_is_ldap_url LDAP_P((
1589 LDAP_CONST char *url ));
1592 ldap_is_ldaps_url LDAP_P((
1593 LDAP_CONST char *url ));
1596 ldap_is_ldapi_url LDAP_P((
1597 LDAP_CONST char *url ));
1600 ldap_url_parse LDAP_P((
1601 LDAP_CONST char *url,
1602 LDAPURLDesc **ludpp ));
1605 ldap_url_desc2str LDAP_P((
1606 LDAPURLDesc *ludp ));
1609 ldap_free_urldesc LDAP_P((
1610 LDAPURLDesc *ludp ));
1614 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1617 #define LDAP_API_FEATURE_CANCEL 1000
1620 ldap_cancel LDAP_P(( LDAP *ld,
1622 LDAPControl **sctrls,
1623 LDAPControl **cctrls,
1627 ldap_cancel_s LDAP_P((
1630 LDAPControl **sctrl,
1631 LDAPControl **cctrl ));
1634 * LDAP Server Side Sort
1637 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1639 /* structure for a sort-key */
1640 typedef struct ldapsortkey {
1641 char * attributeType;
1642 char * orderingRule;
1647 ldap_create_sort_keylist LDAP_P((
1648 LDAPSortKey ***sortKeyList,
1652 ldap_free_sort_keylist LDAP_P((
1653 LDAPSortKey **sortkeylist ));
1656 ldap_create_sort_control LDAP_P((
1658 LDAPSortKey **keyList,
1660 LDAPControl **ctrlp ));
1663 ldap_parse_sort_control LDAP_P((
1665 LDAPControl **ctrlp,
1666 unsigned long *result,
1667 char **attribute ));
1671 * LDAP Virtual List View
1674 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1676 /* structure for virtual list */
1677 typedef struct ldapvlvinfo {
1679 unsigned long ldvlv_before_count;
1680 unsigned long ldvlv_after_count;
1681 unsigned long ldvlv_offset;
1682 unsigned long ldvlv_count;
1683 struct berval * ldvlv_attrvalue;
1684 struct berval * ldvlv_context;
1685 void * ldvlv_extradata;
1689 ldap_create_vlv_control LDAP_P((
1691 LDAPVLVInfo *ldvlistp,
1692 LDAPControl **ctrlp ));
1695 ldap_parse_vlv_control LDAP_P((
1697 LDAPControl **ctrls,
1698 unsigned long *target_posp,
1699 unsigned long *list_countp,
1700 struct berval **contextp,
1707 #define LDAP_API_FEATURE_WHOAMI 1000
1710 ldap_parse_whoami LDAP_P((
1713 struct berval **authzid ));
1716 ldap_whoami LDAP_P(( LDAP *ld,
1717 LDAPControl **sctrls,
1718 LDAPControl **cctrls,
1722 ldap_whoami_s LDAP_P((
1724 struct berval **authzid,
1725 LDAPControl **sctrls,
1726 LDAPControl **cctrls ));
1729 * LDAP Password Modify
1732 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1735 ldap_parse_passwd LDAP_P((
1738 struct berval *newpasswd ));
1741 ldap_passwd LDAP_P(( LDAP *ld,
1742 struct berval *user,
1743 struct berval *oldpw,
1744 struct berval *newpw,
1745 LDAPControl **sctrls,
1746 LDAPControl **cctrls,
1750 ldap_passwd_s LDAP_P((
1752 struct berval *user,
1753 struct berval *oldpw,
1754 struct berval *newpw,
1755 struct berval *newpasswd,
1756 LDAPControl **sctrls,
1757 LDAPControl **cctrls ));
1761 #endif /* _LDAP_H */