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 "+" /* OpenLDAP extension */
80 * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
81 * 0x0000 - 0x0fff reserved for api options
82 * 0x1000 - 0x3fff reserved for api extended options
83 * 0x4000 - 0x7fff reserved for private and experimental options
85 #define LDAP_OPT_API_INFO 0x0000
86 #define LDAP_OPT_DESC 0x0001 /* deprecated */
87 #define LDAP_OPT_DEREF 0x0002
88 #define LDAP_OPT_SIZELIMIT 0x0003
89 #define LDAP_OPT_TIMELIMIT 0x0004
90 /* 0x05 - 0x07 not defined by current draft */
91 #define LDAP_OPT_REFERRALS 0x0008
92 #define LDAP_OPT_RESTART 0x0009
93 /* 0x0a - 0x10 not defined by current draft */
94 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
95 #define LDAP_OPT_SERVER_CONTROLS 0x0012
96 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
97 /* 0x14 not defined by current draft */
98 #define LDAP_OPT_API_FEATURE_INFO 0x0015
100 /* 0x16 - 0x2f not defined by current draft */
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
107 /* 0x34 - 0x0fff not defined by current draft */
109 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */
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
152 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
153 #define LDAP_OPT_OFF ((void *) 0)
156 * ldap_get_option() and ldap_set_option() return values.
157 * As later versions may return other values indicating
158 * failure, current applications should only compare returned
159 * value against LDAP_OPT_SUCCESS.
161 #define LDAP_OPT_SUCCESS 0
162 #define LDAP_OPT_ERROR (-1)
164 #define LDAP_API_INFO_VERSION (1)
165 typedef struct ldapapiinfo {
166 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
167 int ldapai_api_version; /* revision of API supported */
168 int ldapai_protocol_version; /* highest LDAP version supported */
169 char **ldapai_extensions; /* names of API extensions */
170 char *ldapai_vendor_name; /* name of supplier */
171 int ldapai_vendor_version; /* supplier-specific version * 100 */
174 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
175 typedef struct ldap_apifeature_info {
176 int ldapaif_info_version; /* version of this struct (1) */
177 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
178 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
179 } LDAPAPIFeatureInfo;
181 typedef struct ldapcontrol {
183 struct berval ldctl_value;
184 char ldctl_iscritical;
188 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
189 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
190 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
191 #define LDAP_CONTROL_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.5.11"
193 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
194 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1"
195 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.1.10.2"
196 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
197 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
200 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
201 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
202 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
203 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
206 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319"
208 #define LDAP_CONTROL_SYNC "1.3.6.1.4.1.4203.666.5.6"
209 #define LDAP_CONTROL_SYNC_STATE "1.3.6.1.4.1.4203.666.5.7"
210 #define LDAP_CONTROL_SYNC_DONE "1.3.6.1.4.1.4203.666.5.8"
211 #define LDAP_SYNC_INFO "1.3.6.1.4.1.4203.666.10.2"
213 #define LDAP_SYNC_NONE 0x00
214 #define LDAP_SYNC_REFRESH_ONLY 0x01
215 #define LDAP_SYNC_RESERVED 0x02
216 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
218 #define LDAP_SYNC_REFRESH_PRESENTS 0
219 #define LDAP_SYNC_REFRESH_DELETES 1
221 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
222 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
223 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
224 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
226 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
227 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
228 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
229 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
231 #define LDAP_SYNC_PRESENT 0
232 #define LDAP_SYNC_ADD 1
233 #define LDAP_SYNC_MODIFY 2
234 #define LDAP_SYNC_DELETE 3
236 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
237 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
238 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
239 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
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 /* LDAP Unsolicited Notifications */
246 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
247 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
249 /* LDAP Extended Operations */
250 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
252 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
253 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
254 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
255 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
256 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
258 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
259 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
262 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* + */
263 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
264 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
265 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
266 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
267 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.5.6"
270 * specific LDAP instantiations of BER types we know about
273 /* Overview of LBER tag construction
280 * 1 0 = CONTEXT-SPECIFIC
287 * | 5 ... 1 | TAG-NUMBER
291 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
292 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
294 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
295 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
297 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
298 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
300 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
302 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
303 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
304 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
305 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
307 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
309 /* possible operations a client can invoke */
310 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
311 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
312 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
313 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
314 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
315 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
316 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
317 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
318 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
319 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
320 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
321 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
323 /* possible result types a server can return */
324 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
325 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
326 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
327 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
328 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
329 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
330 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
331 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
332 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
333 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
334 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
335 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
336 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
338 #define LDAP_RES_ANY (-1)
339 #define LDAP_RES_UNSOLICITED (0)
343 #define LDAP_SASL_SIMPLE ((char*)0)
344 #define LDAP_SASL_NULL ("")
347 /* authentication methods available */
348 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
349 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
350 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
351 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
352 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
353 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
357 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
358 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
359 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
360 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
361 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
362 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
363 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
364 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
365 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
366 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
368 /* extended filter component types */
369 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
370 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
371 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
372 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
374 /* substring filter component types */
375 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
376 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
377 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
380 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1)
381 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
382 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
383 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
385 /* substring filter component types */
386 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
387 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
388 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
391 * possible error codes we can return
394 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
396 #define LDAP_SUCCESS 0x00
397 #define LDAP_OPERATIONS_ERROR 0x01
398 #define LDAP_PROTOCOL_ERROR 0x02
399 #define LDAP_TIMELIMIT_EXCEEDED 0x03
400 #define LDAP_SIZELIMIT_EXCEEDED 0x04
401 #define LDAP_COMPARE_FALSE 0x05
402 #define LDAP_COMPARE_TRUE 0x06
403 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
404 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
405 #define LDAP_STRONG_AUTH_REQUIRED 0x08
406 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
408 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
409 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
410 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
411 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
412 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
414 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
416 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
417 #define LDAP_UNDEFINED_TYPE 0x11
418 #define LDAP_INAPPROPRIATE_MATCHING 0x12
419 #define LDAP_CONSTRAINT_VIOLATION 0x13
420 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
421 #define LDAP_INVALID_SYNTAX 0x15
423 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
425 #define LDAP_NO_SUCH_OBJECT 0x20
426 #define LDAP_ALIAS_PROBLEM 0x21
427 #define LDAP_INVALID_DN_SYNTAX 0x22
428 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
429 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
431 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
433 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
434 #define LDAP_INAPPROPRIATE_AUTH 0x30
435 #define LDAP_INVALID_CREDENTIALS 0x31
436 #define LDAP_INSUFFICIENT_ACCESS 0x32
438 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
440 #define LDAP_BUSY 0x33
441 #define LDAP_UNAVAILABLE 0x34
442 #define LDAP_UNWILLING_TO_PERFORM 0x35
443 #define LDAP_LOOP_DETECT 0x36
445 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
447 #define LDAP_NAMING_VIOLATION 0x40
448 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
449 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
450 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
451 #define LDAP_ALREADY_EXISTS 0x44
452 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
453 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
454 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
456 #define LDAP_OTHER 0x50
458 /* Expermental result codes */
459 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
460 #define LDAP_PVT_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
462 #define LDAP_SYNC_RESOURCES_EXHAUSTED 0x4100
463 #define LDAP_SYNC_SECURITY_VIOLATION 0x4101
464 #define LDAP_SYNC_INVALID_COOKIE 0x4102
465 #define LDAP_SYNC_UNSUPPORTED_SCHEME 0x4103
466 #define LDAP_SYNC_CLIENT_DISCONNECT 0x4104
467 #define LDAP_SYNC_RELOAD_REQUIRED 0x4105
469 #define LDAP_ASSERTION_FAILED 0x410f
471 /* resultCode for Cancel Response */
472 #define LDAP_CANCELLED 0x4110
473 #define LDAP_NO_SUCH_OPERATION 0x4111
474 #define LDAP_TOO_LATE 0x4112
475 #define LDAP_CANNOT_CANCEL 0x4113
479 * Based on draft-ietf-ldap-c-api-xx
480 * but with new (negative) codes
482 #define LDAP_API_ERROR(n) ((n)<0)
483 #define LDAP_API_RESULT(n) ((n)<=0)
485 #define LDAP_SERVER_DOWN (-1)
486 #define LDAP_LOCAL_ERROR (-2)
487 #define LDAP_ENCODING_ERROR (-3)
488 #define LDAP_DECODING_ERROR (-4)
489 #define LDAP_TIMEOUT (-5)
490 #define LDAP_AUTH_UNKNOWN (-6)
491 #define LDAP_FILTER_ERROR (-7)
492 #define LDAP_USER_CANCELLED (-8)
493 #define LDAP_PARAM_ERROR (-9)
494 #define LDAP_NO_MEMORY (-10)
495 #define LDAP_CONNECT_ERROR (-11)
496 #define LDAP_NOT_SUPPORTED (-12)
497 #define LDAP_CONTROL_NOT_FOUND (-13)
498 #define LDAP_NO_RESULTS_RETURNED (-14)
499 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
500 #define LDAP_CLIENT_LOOP (-16)
501 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
505 * This structure represents both ldap messages and ldap responses.
506 * These are really the same, except in the case of search responses,
507 * where a response has multiple messages.
510 typedef struct ldapmsg LDAPMessage;
512 /* for modifications */
513 typedef struct ldapmod {
516 #define LDAP_MOD_OP (0x0007)
517 #define LDAP_MOD_ADD (0x0000)
518 #define LDAP_MOD_DELETE (0x0001)
519 #define LDAP_MOD_REPLACE (0x0002)
520 #define LDAP_MOD_INCREMENT (0x0003)
521 #define LDAP_MOD_BVALUES (0x0080)
522 /* IMPORTANT: do not use code 0x1000 (or above),
523 * it is used internally by the backends!
524 * (see ldap/servers/slapd/slap.h)
530 struct berval **modv_bvals;
532 #define mod_values mod_vals.modv_strvals
533 #define mod_bvalues mod_vals.modv_bvals
537 * structure representing an ldap session which can
538 * encompass connections to multiple servers (in the
539 * face of referrals).
541 typedef struct ldap LDAP;
543 #define LDAP_DEREF_NEVER 0x00
544 #define LDAP_DEREF_SEARCHING 0x01
545 #define LDAP_DEREF_FINDING 0x02
546 #define LDAP_DEREF_ALWAYS 0x03
548 #define LDAP_NO_LIMIT 0
550 /* how many messages to retrieve results for */
551 #define LDAP_MSG_ONE 0x00
552 #define LDAP_MSG_ALL 0x01
553 #define LDAP_MSG_RECEIVED 0x02
556 * types for ldap URL handling
558 typedef struct ldap_url_desc {
559 struct ldap_url_desc *lud_next;
571 #define LDAP_URL_SUCCESS 0x00 /* Success */
572 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
573 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
575 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
576 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
577 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
578 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
579 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
580 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
581 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
582 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
585 * The API draft spec says we should declare (or cause to be declared)
586 * 'struct timeval'. We don't. See IETF LDAPext discussions.
594 ldap_get_option LDAP_P((
600 ldap_set_option LDAP_P((
603 LDAP_CONST void *invalue));
605 /* V3 REBIND Function Callback Prototype */
606 typedef int (LDAP_REBIND_PROC) LDAP_P((
607 LDAP *ld, LDAP_CONST char *url,
608 ber_tag_t request, ber_int_t msgid,
612 ldap_set_rebind_proc LDAP_P((
614 LDAP_REBIND_PROC *rebind_proc,
621 ldap_create_control LDAP_P((
622 LDAP_CONST char *requestOID,
625 LDAPControl **ctrlp ));
628 ldap_control_free LDAP_P((
629 LDAPControl *ctrl ));
632 ldap_controls_free LDAP_P((
633 LDAPControl **ctrls ));
639 ldap_domain2dn LDAP_P((
640 LDAP_CONST char* domain,
644 ldap_dn2domain LDAP_P((
649 ldap_domain2hostlist LDAP_P((
650 LDAP_CONST char *domain,
657 ldap_extended_operation LDAP_P((
659 LDAP_CONST char *reqoid,
660 struct berval *reqdata,
661 LDAPControl **serverctrls,
662 LDAPControl **clientctrls,
666 ldap_extended_operation_s LDAP_P((
668 LDAP_CONST char *reqoid,
669 struct berval *reqdata,
670 LDAPControl **serverctrls,
671 LDAPControl **clientctrls,
673 struct berval **retdatap ));
676 ldap_parse_extended_result LDAP_P((
680 struct berval **retdatap,
684 ldap_parse_intermediate LDAP_P((
688 struct berval **retdatap,
689 LDAPControl ***serverctrls,
696 ldap_abandon_ext LDAP_P((
699 LDAPControl **serverctrls,
700 LDAPControl **clientctrls ));
702 #ifdef LDAP_DEPRECATED
704 ldap_abandon LDAP_P(( /* deprecated */
714 ldap_add_ext LDAP_P((
718 LDAPControl **serverctrls,
719 LDAPControl **clientctrls,
723 ldap_add_ext_s LDAP_P((
727 LDAPControl **serverctrls,
728 LDAPControl **clientctrls ));
730 #ifdef LDAP_DEPRECATED
732 ldap_add LDAP_P(( /* deprecated */
738 ldap_add_s LDAP_P(( /* deprecated */
749 ldap_sasl_bind LDAP_P((
752 LDAP_CONST char *mechanism,
754 LDAPControl **serverctrls,
755 LDAPControl **clientctrls,
758 /* Interaction flags (should be passed about in a control)
759 * Automatic (default): use defaults, prompt otherwise
760 * Interactive: prompt always
761 * Quiet: never prompt
763 #define LDAP_SASL_AUTOMATIC 0U
764 #define LDAP_SASL_INTERACTIVE 1U
765 #define LDAP_SASL_QUIET 2U
768 * V3 SASL Interaction Function Callback Prototype
769 * when using Cyrus SASL, interact is pointer to sasl_interact_t
770 * should likely passed in a control (and provided controls)
772 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
773 LDAP *ld, unsigned flags, void* defaults, void *interact ));
776 ldap_sasl_interactive_bind_s LDAP_P((
778 LDAP_CONST char *dn, /* usually NULL */
779 LDAP_CONST char *saslMechanism,
780 LDAPControl **serverControls,
781 LDAPControl **clientControls,
783 /* should be client controls */
785 LDAP_SASL_INTERACT_PROC *proc,
789 ldap_sasl_bind_s LDAP_P((
792 LDAP_CONST char *mechanism,
794 LDAPControl **serverctrls,
795 LDAPControl **clientctrls,
796 struct berval **servercredp ));
799 ldap_parse_sasl_bind_result LDAP_P((
802 struct berval **servercredp,
805 #ifdef LDAP_DEPRECATED
811 ldap_bind LDAP_P(( /* deprecated */
813 LDAP_CONST char *who,
814 LDAP_CONST char *passwd,
818 ldap_bind_s LDAP_P(( /* deprecated */
820 LDAP_CONST char *who,
821 LDAP_CONST char *cred,
828 ldap_simple_bind LDAP_P(( /* deprecated */
830 LDAP_CONST char *who,
831 LDAP_CONST char *passwd ));
834 ldap_simple_bind_s LDAP_P(( /* deprecated */
836 LDAP_CONST char *who,
837 LDAP_CONST char *passwd ));
845 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
847 LDAP_CONST char *who ));
850 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
852 LDAP_CONST char *who ));
855 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
857 LDAP_CONST char *who ));
860 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
862 LDAP_CONST char *who ));
865 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
867 LDAP_CONST char *who ));
872 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
876 ldap_cancel LDAP_P(( LDAP *ld,
878 LDAPControl **sctrls,
879 LDAPControl **cctrls,
883 ldap_cancel_s LDAP_P((
887 LDAPControl **cctrl ));
893 ldap_compare_ext LDAP_P((
896 LDAP_CONST char *attr,
897 struct berval *bvalue,
898 LDAPControl **serverctrls,
899 LDAPControl **clientctrls,
903 ldap_compare_ext_s LDAP_P((
906 LDAP_CONST char *attr,
907 struct berval *bvalue,
908 LDAPControl **serverctrls,
909 LDAPControl **clientctrls ));
911 #ifdef LDAP_DEPRECATED
913 ldap_compare LDAP_P(( /* deprecated */
916 LDAP_CONST char *attr,
917 LDAP_CONST char *value ));
920 ldap_compare_s LDAP_P(( /* deprecated */
923 LDAP_CONST char *attr,
924 LDAP_CONST char *value ));
932 ldap_delete_ext LDAP_P((
935 LDAPControl **serverctrls,
936 LDAPControl **clientctrls,
940 ldap_delete_ext_s LDAP_P((
943 LDAPControl **serverctrls,
944 LDAPControl **clientctrls ));
946 #ifdef LDAP_DEPRECATED
948 ldap_delete LDAP_P(( /* deprecated */
950 LDAP_CONST char *dn ));
953 ldap_delete_s LDAP_P(( /* deprecated */
955 LDAP_CONST char *dn ));
963 ldap_parse_result LDAP_P((
970 LDAPControl ***serverctrls,
974 ldap_err2string LDAP_P((
977 #ifdef LDAP_DEPRECATED
979 ldap_result2error LDAP_P(( /* deprecated */
985 ldap_perror LDAP_P(( /* deprecated */
987 LDAP_CONST char *s ));
995 ldap_modify_ext LDAP_P((
999 LDAPControl **serverctrls,
1000 LDAPControl **clientctrls,
1004 ldap_modify_ext_s LDAP_P((
1006 LDAP_CONST char *dn,
1008 LDAPControl **serverctrls,
1009 LDAPControl **clientctrls ));
1011 #ifdef LDAP_DEPRECATED
1013 ldap_modify LDAP_P(( /* deprecated */
1015 LDAP_CONST char *dn,
1019 ldap_modify_s LDAP_P(( /* deprecated */
1021 LDAP_CONST char *dn,
1030 ldap_rename LDAP_P((
1032 LDAP_CONST char *dn,
1033 LDAP_CONST char *newrdn,
1034 LDAP_CONST char *newSuperior,
1036 LDAPControl **sctrls,
1037 LDAPControl **cctrls,
1041 ldap_rename_s LDAP_P((
1043 LDAP_CONST char *dn,
1044 LDAP_CONST char *newrdn,
1045 LDAP_CONST char *newSuperior,
1047 LDAPControl **sctrls,
1048 LDAPControl **cctrls ));
1050 #ifdef LDAP_DEPRECATED
1052 ldap_rename2 LDAP_P(( /* deprecated */
1054 LDAP_CONST char *dn,
1055 LDAP_CONST char *newrdn,
1056 LDAP_CONST char *newSuperior,
1057 int deleteoldrdn ));
1060 ldap_rename2_s LDAP_P(( /* deprecated */
1062 LDAP_CONST char *dn,
1063 LDAP_CONST char *newrdn,
1064 LDAP_CONST char *newSuperior,
1065 int deleteoldrdn ));
1068 ldap_modrdn LDAP_P(( /* deprecated */
1070 LDAP_CONST char *dn,
1071 LDAP_CONST char *newrdn ));
1074 ldap_modrdn_s LDAP_P(( /* deprecated */
1076 LDAP_CONST char *dn,
1077 LDAP_CONST char *newrdn ));
1080 ldap_modrdn2 LDAP_P(( /* deprecated */
1082 LDAP_CONST char *dn,
1083 LDAP_CONST char *newrdn,
1084 int deleteoldrdn ));
1087 ldap_modrdn2_s LDAP_P(( /* deprecated */
1089 LDAP_CONST char *dn,
1090 LDAP_CONST char *newrdn,
1098 #ifdef LDAP_DEPRECATED
1100 ldap_init LDAP_P(( /* deprecated */
1101 LDAP_CONST char *host,
1105 ldap_open LDAP_P(( /* deprecated */
1106 LDAP_CONST char *host,
1111 ldap_create LDAP_P((
1115 ldap_initialize LDAP_P((
1117 LDAP_CONST char *url ));
1120 ldap_start_tls_s LDAP_P((
1122 LDAPControl **serverctrls,
1123 LDAPControl **clientctrls ));
1128 LDAP_F( LDAPMessage * )
1129 ldap_first_message LDAP_P((
1131 LDAPMessage *chain ));
1133 LDAP_F( LDAPMessage * )
1134 ldap_next_message LDAP_P((
1136 LDAPMessage *msg ));
1139 ldap_count_messages LDAP_P((
1141 LDAPMessage *chain ));
1146 LDAP_F( LDAPMessage * )
1147 ldap_first_reference LDAP_P((
1149 LDAPMessage *chain ));
1151 LDAP_F( LDAPMessage * )
1152 ldap_next_reference LDAP_P((
1154 LDAPMessage *ref ));
1157 ldap_count_references LDAP_P((
1159 LDAPMessage *chain ));
1162 ldap_parse_reference LDAP_P((
1166 LDAPControl ***serverctrls,
1173 LDAP_F( LDAPMessage * )
1174 ldap_first_entry LDAP_P((
1176 LDAPMessage *chain ));
1178 LDAP_F( LDAPMessage * )
1179 ldap_next_entry LDAP_P((
1181 LDAPMessage *entry ));
1184 ldap_count_entries LDAP_P((
1186 LDAPMessage *chain ));
1189 ldap_get_entry_controls LDAP_P((
1192 LDAPControl ***serverctrls));
1198 LDAP_F( LDAPMessage * )
1199 ldap_delete_result_entry LDAP_P((
1204 ldap_add_result_entry LDAP_P((
1213 ldap_get_dn LDAP_P((
1215 LDAPMessage *entry ));
1217 typedef struct ldap_ava {
1218 struct berval la_attr;
1219 struct berval la_value;
1221 #define LDAP_AVA_NULL 0x0000U
1222 #define LDAP_AVA_STRING 0x0001U
1223 #define LDAP_AVA_BINARY 0x0002U
1224 #define LDAP_AVA_NONPRINTABLE 0x0004U
1225 #define LDAP_AVA_FREE_ATTR 0x0010U
1226 #define LDAP_AVA_FREE_VALUE 0x0020U
1231 typedef LDAPAVA** LDAPRDN;
1232 typedef LDAPRDN* LDAPDN;
1235 #define LDAP_DN_FORMAT_LDAP 0x0000U
1236 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1237 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1238 #define LDAP_DN_FORMAT_DCE 0x0030U
1239 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1240 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1241 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1242 #define LDAP_DN_FORMAT_MASK 0x00F0U
1245 #define LDAP_DN_PRETTY 0x0100U
1246 #define LDAP_DN_SKIP 0x0200U
1247 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1248 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1249 #define LDAP_DN_PEDANTIC 0xF000U
1251 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1252 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1261 ldap_str2dn LDAP_P((
1262 LDAP_CONST char *str,
1273 ldap_dn2str LDAP_P((
1279 ldap_bv2rdn LDAP_P((
1286 ldap_str2rdn LDAP_P((
1287 LDAP_CONST char *str,
1293 ldap_rdn2bv LDAP_P((
1299 ldap_rdn2str LDAP_P((
1305 ldap_dn_normalize LDAP_P((
1306 LDAP_CONST char *in, unsigned iflags,
1307 char **out, unsigned oflags ));
1310 ldap_dn2ufn LDAP_P(( /* deprecated */
1311 LDAP_CONST char *dn ));
1314 ldap_explode_dn LDAP_P(( /* deprecated */
1315 LDAP_CONST char *dn,
1319 ldap_explode_rdn LDAP_P(( /* deprecated */
1320 LDAP_CONST char *rdn,
1323 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1326 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1327 LDAPDN_rewrite_func *func, unsigned flags ));
1330 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1333 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1336 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1339 ldap_get_dn_ber LDAP_P((
1340 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1343 ldap_get_attribute_ber LDAP_P((
1344 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1345 struct berval **vals ));
1351 ldap_first_attribute LDAP_P((
1354 BerElement **ber ));
1357 ldap_next_attribute LDAP_P((
1366 LDAP_F( struct berval ** )
1367 ldap_get_values_len LDAP_P((
1370 LDAP_CONST char *target ));
1373 ldap_count_values_len LDAP_P((
1374 struct berval **vals ));
1377 ldap_value_free_len LDAP_P((
1378 struct berval **vals ));
1380 #ifdef LDAP_DEPRECATED
1382 ldap_get_values LDAP_P(( /* deprecated */
1385 LDAP_CONST char *target ));
1388 ldap_count_values LDAP_P(( /* deprecated */
1392 ldap_value_free LDAP_P(( /* deprecated */
1400 ldap_result LDAP_P((
1404 struct timeval *timeout,
1405 LDAPMessage **result ));
1408 ldap_msgtype LDAP_P((
1416 ldap_msgfree LDAP_P((
1420 ldap_msgdelete LDAP_P((
1429 ldap_search_ext LDAP_P((
1431 LDAP_CONST char *base,
1433 LDAP_CONST char *filter,
1436 LDAPControl **serverctrls,
1437 LDAPControl **clientctrls,
1438 struct timeval *timeout,
1443 ldap_search_ext_s LDAP_P((
1445 LDAP_CONST char *base,
1447 LDAP_CONST char *filter,
1450 LDAPControl **serverctrls,
1451 LDAPControl **clientctrls,
1452 struct timeval *timeout,
1454 LDAPMessage **res ));
1456 #ifdef LDAP_DEPRECATED
1458 ldap_search LDAP_P(( /* deprecated */
1460 LDAP_CONST char *base,
1462 LDAP_CONST char *filter,
1467 ldap_search_s LDAP_P(( /* deprecated */
1469 LDAP_CONST char *base,
1471 LDAP_CONST char *filter,
1474 LDAPMessage **res ));
1477 ldap_search_st LDAP_P(( /* deprecated */
1479 LDAP_CONST char *base,
1481 LDAP_CONST char *filter,
1484 struct timeval *timeout,
1485 LDAPMessage **res ));
1492 ldap_unbind_ext LDAP_P((
1494 LDAPControl **serverctrls,
1495 LDAPControl **clientctrls));
1498 ldap_unbind_ext_s LDAP_P((
1500 LDAPControl **serverctrls,
1501 LDAPControl **clientctrls));
1503 #ifdef LDAP_DEPRECATED
1505 ldap_unbind LDAP_P(( /* deprecated */
1509 ldap_unbind_s LDAP_P(( /* deprecated */
1517 ldap_put_vrFilter LDAP_P((
1526 ldap_memalloc LDAP_P((
1530 ldap_memrealloc LDAP_P((
1535 ldap_memcalloc LDAP_P((
1540 ldap_memfree LDAP_P((
1544 ldap_memvfree LDAP_P((
1548 ldap_strdup LDAP_P((
1549 LDAP_CONST char * ));
1552 ldap_mods_free LDAP_P((
1557 #ifdef LDAP_DEPRECATED
1559 * in sort.c (deprecated)
1561 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1562 LDAP_CONST char *left,
1563 LDAP_CONST char *right ));
1565 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1566 LDAP_CONST void *left,
1567 LDAP_CONST void *right ));
1569 LDAP_F( int ) /* deprecated */
1570 ldap_sort_entries LDAP_P(( LDAP *ld,
1571 LDAPMessage **chain,
1572 LDAP_CONST char *attr,
1573 LDAP_SORT_AD_CMP_PROC *cmp ));
1575 LDAP_F( int ) /* deprecated */
1576 ldap_sort_values LDAP_P((
1579 LDAP_SORT_AV_CMP_PROC *cmp ));
1581 LDAP_F( int ) /* deprecated */
1582 ldap_sort_strcasecmp LDAP_P((
1584 LDAP_CONST void *b ));
1591 ldap_is_ldap_url LDAP_P((
1592 LDAP_CONST char *url ));
1595 ldap_is_ldaps_url LDAP_P((
1596 LDAP_CONST char *url ));
1599 ldap_is_ldapi_url LDAP_P((
1600 LDAP_CONST char *url ));
1603 ldap_url_parse LDAP_P((
1604 LDAP_CONST char *url,
1605 LDAPURLDesc **ludpp ));
1608 ldap_url_desc2str LDAP_P((
1609 LDAPURLDesc *ludp ));
1612 ldap_free_urldesc LDAP_P((
1613 LDAPURLDesc *ludp ));
1617 * LDAP Server Side Sort
1620 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1622 /* structure for a sort-key */
1623 typedef struct ldapsortkey {
1624 char * attributeType;
1625 char * orderingRule;
1630 ldap_create_sort_keylist LDAP_P((
1631 LDAPSortKey ***sortKeyList,
1635 ldap_free_sort_keylist LDAP_P((
1636 LDAPSortKey **sortkeylist ));
1639 ldap_create_sort_control LDAP_P((
1641 LDAPSortKey **keyList,
1643 LDAPControl **ctrlp ));
1646 ldap_parse_sort_control LDAP_P((
1648 LDAPControl **ctrlp,
1649 unsigned long *result,
1650 char **attribute ));
1654 * LDAP Virtual List View
1657 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1659 /* structure for virtual list */
1660 typedef struct ldapvlvinfo {
1662 unsigned long ldvlv_before_count;
1663 unsigned long ldvlv_after_count;
1664 unsigned long ldvlv_offset;
1665 unsigned long ldvlv_count;
1666 struct berval * ldvlv_attrvalue;
1667 struct berval * ldvlv_context;
1668 void * ldvlv_extradata;
1672 ldap_create_vlv_control LDAP_P((
1674 LDAPVLVInfo *ldvlistp,
1675 LDAPControl **ctrlp ));
1678 ldap_parse_vlv_control LDAP_P((
1680 LDAPControl **ctrls,
1681 unsigned long *target_posp,
1682 unsigned long *list_countp,
1683 struct berval **contextp,
1692 ldap_parse_whoami LDAP_P((
1695 struct berval **authzid ));
1698 ldap_whoami LDAP_P(( LDAP *ld,
1699 LDAPControl **sctrls,
1700 LDAPControl **cctrls,
1704 ldap_whoami_s LDAP_P((
1706 struct berval **authzid,
1707 LDAPControl **sctrls,
1708 LDAPControl **cctrls ));
1711 * LDAP Password Modify
1716 ldap_parse_passwd LDAP_P((
1719 struct berval *newpasswd ));
1722 ldap_passwd LDAP_P(( LDAP *ld,
1723 struct berval *user,
1724 struct berval *oldpw,
1725 struct berval *newpw,
1726 LDAPControl **sctrls,
1727 LDAPControl **cctrls,
1731 ldap_passwd_s LDAP_P((
1733 struct berval *user,
1734 struct berval *oldpw,
1735 struct berval *newpw,
1736 struct berval *newpasswd,
1737 LDAPControl **sctrls,
1738 LDAPControl **cctrls ));
1742 #endif /* _LDAP_H */