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
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"
245 /* not implemented in slapd(8) */
246 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
247 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
249 /* not implemented in slapd(8) */
250 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
251 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
253 /* LDAP Unsolicited Notifications */
254 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
255 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
257 /* LDAP Extended Operations */
258 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
260 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
261 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
262 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
263 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
264 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
266 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
267 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
270 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
271 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
272 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
273 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
274 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
275 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
277 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
280 * specific LDAP instantiations of BER types we know about
283 /* Overview of LBER tag construction
290 * 1 0 = CONTEXT-SPECIFIC
297 * | 5 ... 1 | TAG-NUMBER
301 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
302 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
304 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
305 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
307 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
308 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
310 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
312 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
313 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
314 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
315 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
317 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
319 /* possible operations a client can invoke */
320 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
321 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
322 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
323 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
324 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
325 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
326 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
327 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
328 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
329 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
330 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
331 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
333 /* possible result types a server can return */
334 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
335 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
336 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
337 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
338 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
339 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
340 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
341 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
342 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
343 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
344 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
345 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
346 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
348 #define LDAP_RES_ANY (-1)
349 #define LDAP_RES_UNSOLICITED (0)
353 #define LDAP_SASL_SIMPLE ((char*)0)
354 #define LDAP_SASL_NULL ("")
357 /* authentication methods available */
358 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
359 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
360 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
361 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
362 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
363 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
367 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
368 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
369 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
370 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
371 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
372 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
373 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
374 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
375 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
376 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
378 /* extended filter component types */
379 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
380 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
381 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
382 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
384 /* substring filter component types */
385 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
386 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
387 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
390 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
391 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
392 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
393 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
394 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
395 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
396 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
398 /* substring filter component types */
399 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
400 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
401 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
404 * possible error codes we can return
407 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
409 #define LDAP_SUCCESS 0x00
410 #define LDAP_OPERATIONS_ERROR 0x01
411 #define LDAP_PROTOCOL_ERROR 0x02
412 #define LDAP_TIMELIMIT_EXCEEDED 0x03
413 #define LDAP_SIZELIMIT_EXCEEDED 0x04
414 #define LDAP_COMPARE_FALSE 0x05
415 #define LDAP_COMPARE_TRUE 0x06
416 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
417 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
418 #define LDAP_STRONG_AUTH_REQUIRED 0x08
419 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
421 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
422 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
423 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
424 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
425 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
427 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
429 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
430 #define LDAP_UNDEFINED_TYPE 0x11
431 #define LDAP_INAPPROPRIATE_MATCHING 0x12
432 #define LDAP_CONSTRAINT_VIOLATION 0x13
433 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
434 #define LDAP_INVALID_SYNTAX 0x15
436 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
438 #define LDAP_NO_SUCH_OBJECT 0x20
439 #define LDAP_ALIAS_PROBLEM 0x21
440 #define LDAP_INVALID_DN_SYNTAX 0x22
441 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
442 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
444 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
446 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
447 #define LDAP_INAPPROPRIATE_AUTH 0x30
448 #define LDAP_INVALID_CREDENTIALS 0x31
449 #define LDAP_INSUFFICIENT_ACCESS 0x32
451 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
453 #define LDAP_BUSY 0x33
454 #define LDAP_UNAVAILABLE 0x34
455 #define LDAP_UNWILLING_TO_PERFORM 0x35
456 #define LDAP_LOOP_DETECT 0x36
458 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
460 #define LDAP_NAMING_VIOLATION 0x40
461 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
462 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
463 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
464 #define LDAP_ALREADY_EXISTS 0x44
465 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
466 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
467 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
469 #define LDAP_OTHER 0x50
471 /* Experimental result codes */
472 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
473 #define LDAP_PVT_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
475 /* for the LDAP Sync operation */
476 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
478 /* for the Assertion control */
479 #define LDAP_ASSERTION_FAILED 0x410f
481 /* for the Cancel operation */
482 #define LDAP_CANCELLED 0x4110
483 #define LDAP_NO_SUCH_OPERATION 0x4111
484 #define LDAP_TOO_LATE 0x4112
485 #define LDAP_CANNOT_CANCEL 0x4113
489 * Based on draft-ietf-ldap-c-api-xx
490 * but with new negative code values
492 #define LDAP_API_ERROR(n) ((n)<0)
493 #define LDAP_API_RESULT(n) ((n)<=0)
495 #define LDAP_SERVER_DOWN (-1)
496 #define LDAP_LOCAL_ERROR (-2)
497 #define LDAP_ENCODING_ERROR (-3)
498 #define LDAP_DECODING_ERROR (-4)
499 #define LDAP_TIMEOUT (-5)
500 #define LDAP_AUTH_UNKNOWN (-6)
501 #define LDAP_FILTER_ERROR (-7)
502 #define LDAP_USER_CANCELLED (-8)
503 #define LDAP_PARAM_ERROR (-9)
504 #define LDAP_NO_MEMORY (-10)
505 #define LDAP_CONNECT_ERROR (-11)
506 #define LDAP_NOT_SUPPORTED (-12)
507 #define LDAP_CONTROL_NOT_FOUND (-13)
508 #define LDAP_NO_RESULTS_RETURNED (-14)
509 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
510 #define LDAP_CLIENT_LOOP (-16)
511 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
515 * This structure represents both ldap messages and ldap responses.
516 * These are really the same, except in the case of search responses,
517 * where a response has multiple messages.
520 typedef struct ldapmsg LDAPMessage;
522 /* for modifications */
523 typedef struct ldapmod {
526 #define LDAP_MOD_OP (0x0007)
527 #define LDAP_MOD_ADD (0x0000)
528 #define LDAP_MOD_DELETE (0x0001)
529 #define LDAP_MOD_REPLACE (0x0002)
530 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
531 #define LDAP_MOD_BVALUES (0x0080)
532 /* IMPORTANT: do not use code 0x1000 (or above),
533 * it is used internally by the backends!
534 * (see ldap/servers/slapd/slap.h)
540 struct berval **modv_bvals;
542 #define mod_values mod_vals.modv_strvals
543 #define mod_bvalues mod_vals.modv_bvals
547 * structure representing an ldap session which can
548 * encompass connections to multiple servers (in the
549 * face of referrals).
551 typedef struct ldap LDAP;
553 #define LDAP_DEREF_NEVER 0x00
554 #define LDAP_DEREF_SEARCHING 0x01
555 #define LDAP_DEREF_FINDING 0x02
556 #define LDAP_DEREF_ALWAYS 0x03
558 #define LDAP_NO_LIMIT 0
560 /* how many messages to retrieve results for */
561 #define LDAP_MSG_ONE 0x00
562 #define LDAP_MSG_ALL 0x01
563 #define LDAP_MSG_RECEIVED 0x02
566 * types for ldap URL handling
568 typedef struct ldap_url_desc {
569 struct ldap_url_desc *lud_next;
581 #define LDAP_URL_SUCCESS 0x00 /* Success */
582 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
583 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
585 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
586 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
587 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
588 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
589 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
590 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
591 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
592 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
595 * The API draft spec says we should declare (or cause to be declared)
596 * 'struct timeval'. We don't. See IETF LDAPext discussions.
604 ldap_get_option LDAP_P((
610 ldap_set_option LDAP_P((
613 LDAP_CONST void *invalue));
615 /* V3 REBIND Function Callback Prototype */
616 typedef int (LDAP_REBIND_PROC) LDAP_P((
617 LDAP *ld, LDAP_CONST char *url,
618 ber_tag_t request, ber_int_t msgid,
622 ldap_set_rebind_proc LDAP_P((
624 LDAP_REBIND_PROC *rebind_proc,
631 ldap_create_control LDAP_P((
632 LDAP_CONST char *requestOID,
635 LDAPControl **ctrlp ));
638 ldap_control_free LDAP_P((
639 LDAPControl *ctrl ));
642 ldap_controls_free LDAP_P((
643 LDAPControl **ctrls ));
649 ldap_domain2dn LDAP_P((
650 LDAP_CONST char* domain,
654 ldap_dn2domain LDAP_P((
659 ldap_domain2hostlist LDAP_P((
660 LDAP_CONST char *domain,
667 ldap_extended_operation LDAP_P((
669 LDAP_CONST char *reqoid,
670 struct berval *reqdata,
671 LDAPControl **serverctrls,
672 LDAPControl **clientctrls,
676 ldap_extended_operation_s LDAP_P((
678 LDAP_CONST char *reqoid,
679 struct berval *reqdata,
680 LDAPControl **serverctrls,
681 LDAPControl **clientctrls,
683 struct berval **retdatap ));
686 ldap_parse_extended_result LDAP_P((
690 struct berval **retdatap,
694 ldap_parse_intermediate LDAP_P((
698 struct berval **retdatap,
699 LDAPControl ***serverctrls,
706 ldap_abandon_ext LDAP_P((
709 LDAPControl **serverctrls,
710 LDAPControl **clientctrls ));
712 #ifdef LDAP_DEPRECATED
714 ldap_abandon LDAP_P(( /* deprecated */
724 ldap_add_ext LDAP_P((
728 LDAPControl **serverctrls,
729 LDAPControl **clientctrls,
733 ldap_add_ext_s LDAP_P((
737 LDAPControl **serverctrls,
738 LDAPControl **clientctrls ));
740 #ifdef LDAP_DEPRECATED
742 ldap_add LDAP_P(( /* deprecated */
748 ldap_add_s LDAP_P(( /* deprecated */
759 ldap_sasl_bind LDAP_P((
762 LDAP_CONST char *mechanism,
764 LDAPControl **serverctrls,
765 LDAPControl **clientctrls,
768 /* Interaction flags (should be passed about in a control)
769 * Automatic (default): use defaults, prompt otherwise
770 * Interactive: prompt always
771 * Quiet: never prompt
773 #define LDAP_SASL_AUTOMATIC 0U
774 #define LDAP_SASL_INTERACTIVE 1U
775 #define LDAP_SASL_QUIET 2U
778 * V3 SASL Interaction Function Callback Prototype
779 * when using Cyrus SASL, interact is pointer to sasl_interact_t
780 * should likely passed in a control (and provided controls)
782 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
783 LDAP *ld, unsigned flags, void* defaults, void *interact ));
786 ldap_sasl_interactive_bind_s LDAP_P((
788 LDAP_CONST char *dn, /* usually NULL */
789 LDAP_CONST char *saslMechanism,
790 LDAPControl **serverControls,
791 LDAPControl **clientControls,
793 /* should be client controls */
795 LDAP_SASL_INTERACT_PROC *proc,
799 ldap_sasl_bind_s LDAP_P((
802 LDAP_CONST char *mechanism,
804 LDAPControl **serverctrls,
805 LDAPControl **clientctrls,
806 struct berval **servercredp ));
809 ldap_parse_sasl_bind_result LDAP_P((
812 struct berval **servercredp,
815 #ifdef LDAP_DEPRECATED
821 ldap_bind LDAP_P(( /* deprecated */
823 LDAP_CONST char *who,
824 LDAP_CONST char *passwd,
828 ldap_bind_s LDAP_P(( /* deprecated */
830 LDAP_CONST char *who,
831 LDAP_CONST char *cred,
838 ldap_simple_bind LDAP_P(( /* deprecated */
840 LDAP_CONST char *who,
841 LDAP_CONST char *passwd ));
844 ldap_simple_bind_s LDAP_P(( /* deprecated */
846 LDAP_CONST char *who,
847 LDAP_CONST char *passwd ));
855 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
857 LDAP_CONST char *who ));
860 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
862 LDAP_CONST char *who ));
865 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
867 LDAP_CONST char *who ));
870 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
872 LDAP_CONST char *who ));
875 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
877 LDAP_CONST char *who ));
885 ldap_compare_ext LDAP_P((
888 LDAP_CONST char *attr,
889 struct berval *bvalue,
890 LDAPControl **serverctrls,
891 LDAPControl **clientctrls,
895 ldap_compare_ext_s LDAP_P((
898 LDAP_CONST char *attr,
899 struct berval *bvalue,
900 LDAPControl **serverctrls,
901 LDAPControl **clientctrls ));
903 #ifdef LDAP_DEPRECATED
905 ldap_compare LDAP_P(( /* deprecated */
908 LDAP_CONST char *attr,
909 LDAP_CONST char *value ));
912 ldap_compare_s LDAP_P(( /* deprecated */
915 LDAP_CONST char *attr,
916 LDAP_CONST char *value ));
924 ldap_delete_ext LDAP_P((
927 LDAPControl **serverctrls,
928 LDAPControl **clientctrls,
932 ldap_delete_ext_s LDAP_P((
935 LDAPControl **serverctrls,
936 LDAPControl **clientctrls ));
938 #ifdef LDAP_DEPRECATED
940 ldap_delete LDAP_P(( /* deprecated */
942 LDAP_CONST char *dn ));
945 ldap_delete_s LDAP_P(( /* deprecated */
947 LDAP_CONST char *dn ));
955 ldap_parse_result LDAP_P((
962 LDAPControl ***serverctrls,
966 ldap_err2string LDAP_P((
969 #ifdef LDAP_DEPRECATED
971 ldap_result2error LDAP_P(( /* deprecated */
977 ldap_perror LDAP_P(( /* deprecated */
979 LDAP_CONST char *s ));
987 ldap_modify_ext LDAP_P((
991 LDAPControl **serverctrls,
992 LDAPControl **clientctrls,
996 ldap_modify_ext_s LDAP_P((
1000 LDAPControl **serverctrls,
1001 LDAPControl **clientctrls ));
1003 #ifdef LDAP_DEPRECATED
1005 ldap_modify LDAP_P(( /* deprecated */
1007 LDAP_CONST char *dn,
1011 ldap_modify_s LDAP_P(( /* deprecated */
1013 LDAP_CONST char *dn,
1022 ldap_rename LDAP_P((
1024 LDAP_CONST char *dn,
1025 LDAP_CONST char *newrdn,
1026 LDAP_CONST char *newSuperior,
1028 LDAPControl **sctrls,
1029 LDAPControl **cctrls,
1033 ldap_rename_s LDAP_P((
1035 LDAP_CONST char *dn,
1036 LDAP_CONST char *newrdn,
1037 LDAP_CONST char *newSuperior,
1039 LDAPControl **sctrls,
1040 LDAPControl **cctrls ));
1042 #ifdef LDAP_DEPRECATED
1044 ldap_rename2 LDAP_P(( /* deprecated */
1046 LDAP_CONST char *dn,
1047 LDAP_CONST char *newrdn,
1048 LDAP_CONST char *newSuperior,
1049 int deleteoldrdn ));
1052 ldap_rename2_s LDAP_P(( /* deprecated */
1054 LDAP_CONST char *dn,
1055 LDAP_CONST char *newrdn,
1056 LDAP_CONST char *newSuperior,
1057 int deleteoldrdn ));
1060 ldap_modrdn LDAP_P(( /* deprecated */
1062 LDAP_CONST char *dn,
1063 LDAP_CONST char *newrdn ));
1066 ldap_modrdn_s LDAP_P(( /* deprecated */
1068 LDAP_CONST char *dn,
1069 LDAP_CONST char *newrdn ));
1072 ldap_modrdn2 LDAP_P(( /* deprecated */
1074 LDAP_CONST char *dn,
1075 LDAP_CONST char *newrdn,
1076 int deleteoldrdn ));
1079 ldap_modrdn2_s LDAP_P(( /* deprecated */
1081 LDAP_CONST char *dn,
1082 LDAP_CONST char *newrdn,
1090 #ifdef LDAP_DEPRECATED
1092 ldap_init LDAP_P(( /* deprecated */
1093 LDAP_CONST char *host,
1097 ldap_open LDAP_P(( /* deprecated */
1098 LDAP_CONST char *host,
1103 ldap_create LDAP_P((
1107 ldap_initialize LDAP_P((
1109 LDAP_CONST char *url ));
1112 ldap_start_tls_s LDAP_P((
1114 LDAPControl **serverctrls,
1115 LDAPControl **clientctrls ));
1120 LDAP_F( LDAPMessage * )
1121 ldap_first_message LDAP_P((
1123 LDAPMessage *chain ));
1125 LDAP_F( LDAPMessage * )
1126 ldap_next_message LDAP_P((
1128 LDAPMessage *msg ));
1131 ldap_count_messages LDAP_P((
1133 LDAPMessage *chain ));
1138 LDAP_F( LDAPMessage * )
1139 ldap_first_reference LDAP_P((
1141 LDAPMessage *chain ));
1143 LDAP_F( LDAPMessage * )
1144 ldap_next_reference LDAP_P((
1146 LDAPMessage *ref ));
1149 ldap_count_references LDAP_P((
1151 LDAPMessage *chain ));
1154 ldap_parse_reference LDAP_P((
1158 LDAPControl ***serverctrls,
1165 LDAP_F( LDAPMessage * )
1166 ldap_first_entry LDAP_P((
1168 LDAPMessage *chain ));
1170 LDAP_F( LDAPMessage * )
1171 ldap_next_entry LDAP_P((
1173 LDAPMessage *entry ));
1176 ldap_count_entries LDAP_P((
1178 LDAPMessage *chain ));
1181 ldap_get_entry_controls LDAP_P((
1184 LDAPControl ***serverctrls));
1190 LDAP_F( LDAPMessage * )
1191 ldap_delete_result_entry LDAP_P((
1196 ldap_add_result_entry LDAP_P((
1205 ldap_get_dn LDAP_P((
1207 LDAPMessage *entry ));
1209 typedef struct ldap_ava {
1210 struct berval la_attr;
1211 struct berval la_value;
1213 #define LDAP_AVA_NULL 0x0000U
1214 #define LDAP_AVA_STRING 0x0001U
1215 #define LDAP_AVA_BINARY 0x0002U
1216 #define LDAP_AVA_NONPRINTABLE 0x0004U
1217 #define LDAP_AVA_FREE_ATTR 0x0010U
1218 #define LDAP_AVA_FREE_VALUE 0x0020U
1223 typedef LDAPAVA** LDAPRDN;
1224 typedef LDAPRDN* LDAPDN;
1227 #define LDAP_DN_FORMAT_LDAP 0x0000U
1228 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1229 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1230 #define LDAP_DN_FORMAT_DCE 0x0030U
1231 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1232 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1233 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1234 #define LDAP_DN_FORMAT_MASK 0x00F0U
1237 #define LDAP_DN_PRETTY 0x0100U
1238 #define LDAP_DN_SKIP 0x0200U
1239 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1240 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1241 #define LDAP_DN_PEDANTIC 0xF000U
1243 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1244 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1253 ldap_str2dn LDAP_P((
1254 LDAP_CONST char *str,
1265 ldap_dn2str LDAP_P((
1271 ldap_bv2rdn LDAP_P((
1278 ldap_str2rdn LDAP_P((
1279 LDAP_CONST char *str,
1285 ldap_rdn2bv LDAP_P((
1291 ldap_rdn2str LDAP_P((
1297 ldap_dn_normalize LDAP_P((
1298 LDAP_CONST char *in, unsigned iflags,
1299 char **out, unsigned oflags ));
1302 ldap_dn2ufn LDAP_P(( /* deprecated */
1303 LDAP_CONST char *dn ));
1306 ldap_explode_dn LDAP_P(( /* deprecated */
1307 LDAP_CONST char *dn,
1311 ldap_explode_rdn LDAP_P(( /* deprecated */
1312 LDAP_CONST char *rdn,
1315 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1318 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1319 LDAPDN_rewrite_func *func, unsigned flags ));
1322 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1325 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1328 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1331 ldap_get_dn_ber LDAP_P((
1332 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1335 ldap_get_attribute_ber LDAP_P((
1336 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1337 struct berval **vals ));
1343 ldap_first_attribute LDAP_P((
1346 BerElement **ber ));
1349 ldap_next_attribute LDAP_P((
1358 LDAP_F( struct berval ** )
1359 ldap_get_values_len LDAP_P((
1362 LDAP_CONST char *target ));
1365 ldap_count_values_len LDAP_P((
1366 struct berval **vals ));
1369 ldap_value_free_len LDAP_P((
1370 struct berval **vals ));
1372 #ifdef LDAP_DEPRECATED
1374 ldap_get_values LDAP_P(( /* deprecated */
1377 LDAP_CONST char *target ));
1380 ldap_count_values LDAP_P(( /* deprecated */
1384 ldap_value_free LDAP_P(( /* deprecated */
1392 ldap_result LDAP_P((
1396 struct timeval *timeout,
1397 LDAPMessage **result ));
1400 ldap_msgtype LDAP_P((
1408 ldap_msgfree LDAP_P((
1412 ldap_msgdelete LDAP_P((
1421 ldap_search_ext LDAP_P((
1423 LDAP_CONST char *base,
1425 LDAP_CONST char *filter,
1428 LDAPControl **serverctrls,
1429 LDAPControl **clientctrls,
1430 struct timeval *timeout,
1435 ldap_search_ext_s LDAP_P((
1437 LDAP_CONST char *base,
1439 LDAP_CONST char *filter,
1442 LDAPControl **serverctrls,
1443 LDAPControl **clientctrls,
1444 struct timeval *timeout,
1446 LDAPMessage **res ));
1448 #ifdef LDAP_DEPRECATED
1450 ldap_search LDAP_P(( /* deprecated */
1452 LDAP_CONST char *base,
1454 LDAP_CONST char *filter,
1459 ldap_search_s LDAP_P(( /* deprecated */
1461 LDAP_CONST char *base,
1463 LDAP_CONST char *filter,
1466 LDAPMessage **res ));
1469 ldap_search_st LDAP_P(( /* deprecated */
1471 LDAP_CONST char *base,
1473 LDAP_CONST char *filter,
1476 struct timeval *timeout,
1477 LDAPMessage **res ));
1484 ldap_unbind_ext LDAP_P((
1486 LDAPControl **serverctrls,
1487 LDAPControl **clientctrls));
1490 ldap_unbind_ext_s LDAP_P((
1492 LDAPControl **serverctrls,
1493 LDAPControl **clientctrls));
1495 #ifdef LDAP_DEPRECATED
1497 ldap_unbind LDAP_P(( /* deprecated */
1501 ldap_unbind_s LDAP_P(( /* deprecated */
1509 ldap_put_vrFilter LDAP_P((
1518 ldap_memalloc LDAP_P((
1522 ldap_memrealloc LDAP_P((
1527 ldap_memcalloc LDAP_P((
1532 ldap_memfree LDAP_P((
1536 ldap_memvfree LDAP_P((
1540 ldap_strdup LDAP_P((
1541 LDAP_CONST char * ));
1544 ldap_mods_free LDAP_P((
1549 #ifdef LDAP_DEPRECATED
1551 * in sort.c (deprecated)
1553 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1554 LDAP_CONST char *left,
1555 LDAP_CONST char *right ));
1557 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1558 LDAP_CONST void *left,
1559 LDAP_CONST void *right ));
1561 LDAP_F( int ) /* deprecated */
1562 ldap_sort_entries LDAP_P(( LDAP *ld,
1563 LDAPMessage **chain,
1564 LDAP_CONST char *attr,
1565 LDAP_SORT_AD_CMP_PROC *cmp ));
1567 LDAP_F( int ) /* deprecated */
1568 ldap_sort_values LDAP_P((
1571 LDAP_SORT_AV_CMP_PROC *cmp ));
1573 LDAP_F( int ) /* deprecated */
1574 ldap_sort_strcasecmp LDAP_P((
1576 LDAP_CONST void *b ));
1583 ldap_is_ldap_url LDAP_P((
1584 LDAP_CONST char *url ));
1587 ldap_is_ldaps_url LDAP_P((
1588 LDAP_CONST char *url ));
1591 ldap_is_ldapi_url LDAP_P((
1592 LDAP_CONST char *url ));
1595 ldap_url_parse LDAP_P((
1596 LDAP_CONST char *url,
1597 LDAPURLDesc **ludpp ));
1600 ldap_url_desc2str LDAP_P((
1601 LDAPURLDesc *ludp ));
1604 ldap_free_urldesc LDAP_P((
1605 LDAPURLDesc *ludp ));
1609 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1612 #define LDAP_API_FEATURE_CANCEL 1000
1615 ldap_cancel LDAP_P(( LDAP *ld,
1617 LDAPControl **sctrls,
1618 LDAPControl **cctrls,
1622 ldap_cancel_s LDAP_P((
1625 LDAPControl **sctrl,
1626 LDAPControl **cctrl ));
1629 * LDAP Server Side Sort
1632 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1634 /* structure for a sort-key */
1635 typedef struct ldapsortkey {
1636 char * attributeType;
1637 char * orderingRule;
1642 ldap_create_sort_keylist LDAP_P((
1643 LDAPSortKey ***sortKeyList,
1647 ldap_free_sort_keylist LDAP_P((
1648 LDAPSortKey **sortkeylist ));
1651 ldap_create_sort_control LDAP_P((
1653 LDAPSortKey **keyList,
1655 LDAPControl **ctrlp ));
1658 ldap_parse_sort_control LDAP_P((
1660 LDAPControl **ctrlp,
1661 unsigned long *result,
1662 char **attribute ));
1666 * LDAP Virtual List View
1669 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1671 /* structure for virtual list */
1672 typedef struct ldapvlvinfo {
1674 unsigned long ldvlv_before_count;
1675 unsigned long ldvlv_after_count;
1676 unsigned long ldvlv_offset;
1677 unsigned long ldvlv_count;
1678 struct berval * ldvlv_attrvalue;
1679 struct berval * ldvlv_context;
1680 void * ldvlv_extradata;
1684 ldap_create_vlv_control LDAP_P((
1686 LDAPVLVInfo *ldvlistp,
1687 LDAPControl **ctrlp ));
1690 ldap_parse_vlv_control LDAP_P((
1692 LDAPControl **ctrls,
1693 unsigned long *target_posp,
1694 unsigned long *list_countp,
1695 struct berval **contextp,
1702 #define LDAP_API_FEATURE_WHOAMI 1000
1705 ldap_parse_whoami LDAP_P((
1708 struct berval **authzid ));
1711 ldap_whoami LDAP_P(( LDAP *ld,
1712 LDAPControl **sctrls,
1713 LDAPControl **cctrls,
1717 ldap_whoami_s LDAP_P((
1719 struct berval **authzid,
1720 LDAPControl **sctrls,
1721 LDAPControl **cctrls ));
1724 * LDAP Password Modify
1727 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1730 ldap_parse_passwd LDAP_P((
1733 struct berval *newpasswd ));
1736 ldap_passwd LDAP_P(( LDAP *ld,
1737 struct berval *user,
1738 struct berval *oldpw,
1739 struct berval *newpw,
1740 LDAPControl **sctrls,
1741 LDAPControl **cctrls,
1745 ldap_passwd_s LDAP_P((
1747 struct berval *user,
1748 struct berval *oldpw,
1749 struct berval *newpw,
1750 struct berval *newpasswd,
1751 LDAPControl **sctrls,
1752 LDAPControl **cctrls ));
1756 #endif /* _LDAP_H */