2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2004 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms are permitted
19 * provided that this notice is preserved and that due credit is given
20 * to the University of Michigan at Ann Arbor. The name of the University
21 * may not be used to endorse or promote products derived from this
22 * software without specific prior written permission. This software
23 * is provided ``as is'' without express or implied warranty.
32 /* include version and API feature defines */
33 #include <ldap_features.h>
37 #define LDAP_VERSION1 1
38 #define LDAP_VERSION2 2
39 #define LDAP_VERSION3 3
41 #define LDAP_VERSION_MIN LDAP_VERSION2
42 #define LDAP_VERSION LDAP_VERSION2
43 #define LDAP_VERSION_MAX LDAP_VERSION3
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 */
84 /* RFC 2251: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
85 #define LDAP_MAXINT (2147483647)
89 * 0x0000 - 0x0fff reserved for api options
90 * 0x1000 - 0x3fff reserved for api extended options
91 * 0x4000 - 0x7fff reserved for private and experimental options
94 #define LDAP_OPT_API_INFO 0x0000
95 #define LDAP_OPT_DESC 0x0001 /* historic */
96 #define LDAP_OPT_DEREF 0x0002
97 #define LDAP_OPT_SIZELIMIT 0x0003
98 #define LDAP_OPT_TIMELIMIT 0x0004
99 /* 0x05 - 0x07 not defined */
100 #define LDAP_OPT_REFERRALS 0x0008
101 #define LDAP_OPT_RESTART 0x0009
102 /* 0x0a - 0x10 not defined */
103 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
104 #define LDAP_OPT_SERVER_CONTROLS 0x0012
105 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
106 /* 0x14 not defined */
107 #define LDAP_OPT_API_FEATURE_INFO 0x0015
108 /* 0x16 - 0x2f not defined */
109 #define LDAP_OPT_HOST_NAME 0x0030
110 #define LDAP_OPT_RESULT_CODE 0x0031
111 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
112 #define LDAP_OPT_ERROR_STRING 0x0032
113 #define LDAP_OPT_MATCHED_DN 0x0033
114 /* 0x0034 - 0x3fff not defined */
117 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
119 /* private and experimental options */
120 /* OpenLDAP specific options */
121 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
122 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
123 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
124 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
125 #define LDAP_OPT_URI 0x5006
126 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
128 /* OpenLDAP TLS options */
129 #define LDAP_OPT_X_TLS 0x6000
130 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
131 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
132 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
133 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
134 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
135 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
136 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
137 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
138 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
139 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
141 #define LDAP_OPT_X_TLS_NEVER 0
142 #define LDAP_OPT_X_TLS_HARD 1
143 #define LDAP_OPT_X_TLS_DEMAND 2
144 #define LDAP_OPT_X_TLS_ALLOW 3
145 #define LDAP_OPT_X_TLS_TRY 4
147 /* OpenLDAP SASL options */
148 #define LDAP_OPT_X_SASL_MECH 0x6100
149 #define LDAP_OPT_X_SASL_REALM 0x6101
150 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
151 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
152 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
153 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
154 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
155 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
156 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
157 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
159 /* Private API Extensions -- reserved for application use */
160 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
163 * ldap_get_option() and ldap_set_option() return values.
164 * As later versions may return other values indicating
165 * failure, current applications should only compare returned
166 * value against LDAP_OPT_SUCCESS.
168 #define LDAP_OPT_SUCCESS 0
169 #define LDAP_OPT_ERROR (-1)
171 /* option on/off values */
172 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
173 #define LDAP_OPT_OFF ((void *) 0)
175 typedef struct ldapapiinfo {
176 int ldapai_info_version; /* version of LDAPAPIInfo */
177 #define LDAP_API_INFO_VERSION (1)
178 int ldapai_api_version; /* revision of API supported */
179 int ldapai_protocol_version; /* highest LDAP version supported */
180 char **ldapai_extensions; /* names of API extensions */
181 char *ldapai_vendor_name; /* name of supplier */
182 int ldapai_vendor_version; /* supplier-specific version * 100 */
185 typedef struct ldap_apifeature_info {
186 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
187 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
188 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
189 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
190 } LDAPAPIFeatureInfo;
193 * LDAP Control structure
195 typedef struct ldapcontrol {
196 char * ldctl_oid; /* numericoid of control */
197 struct berval ldctl_value; /* encoded value of control */
198 char ldctl_iscritical; /* criticality */
202 /* standard track controls */
203 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
204 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
205 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
207 /* standard track - not implemented in slapd(8) */
208 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
209 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
211 /* but not yet formalized controls */
212 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
213 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
215 /* various works in progress */
216 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
217 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
218 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
219 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
221 /* LDAP VLV *//* not implemented in slapd(8) */
222 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
223 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
225 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
226 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
227 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
228 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
229 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
230 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
232 #define LDAP_SYNC_NONE 0x00
233 #define LDAP_SYNC_REFRESH_ONLY 0x01
234 #define LDAP_SYNC_RESERVED 0x02
235 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
237 #define LDAP_SYNC_REFRESH_PRESENTS 0
238 #define LDAP_SYNC_REFRESH_DELETES 1
240 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
241 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
242 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
243 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
245 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
246 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
247 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
248 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
250 #define LDAP_SYNC_PRESENT 0
251 #define LDAP_SYNC_ADD 1
252 #define LDAP_SYNC_MODIFY 2
253 #define LDAP_SYNC_DELETE 3
255 /* MS ActiveDirectory controls (for compatibility) */
256 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
257 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
259 /* LDAP Unsolicited Notifications */
260 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
261 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
263 /* LDAP Extended Operations */
264 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
266 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
267 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
268 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
269 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
270 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
272 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
273 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
276 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
277 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
278 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
279 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
280 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
281 #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_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
323 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
325 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
327 /* LDAP Request Messages */
328 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
329 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
330 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
331 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
332 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
333 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
334 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
335 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
336 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
337 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
338 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
339 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
341 /* LDAP Response Messages */
342 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
343 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
344 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
345 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
346 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
347 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
348 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
349 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
350 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
351 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
352 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
353 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
354 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
356 #define LDAP_RES_ANY (-1)
357 #define LDAP_RES_UNSOLICITED (0)
361 #define LDAP_SASL_SIMPLE ((char*)0)
362 #define LDAP_SASL_NULL ("")
365 /* authentication methods available */
366 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
367 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
368 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
369 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
370 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
371 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
375 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
376 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
377 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
378 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
379 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
380 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
381 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
382 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
383 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
384 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
386 /* extended filter component types */
387 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
388 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
389 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
390 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
392 /* substring filter component types */
393 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
394 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
395 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
398 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
399 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
400 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
401 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
402 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
403 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
404 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
406 /* substring filter component types */
407 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
408 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
409 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
414 #define LDAP_SUCCESS 0x00
416 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
418 #define LDAP_OPERATIONS_ERROR 0x01
419 #define LDAP_PROTOCOL_ERROR 0x02
420 #define LDAP_TIMELIMIT_EXCEEDED 0x03
421 #define LDAP_SIZELIMIT_EXCEEDED 0x04
422 #define LDAP_COMPARE_FALSE 0x05
423 #define LDAP_COMPARE_TRUE 0x06
424 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
425 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
426 #define LDAP_STRONG_AUTH_REQUIRED 0x08
427 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
429 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
430 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
431 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
432 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
433 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
435 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
437 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
438 #define LDAP_UNDEFINED_TYPE 0x11
439 #define LDAP_INAPPROPRIATE_MATCHING 0x12
440 #define LDAP_CONSTRAINT_VIOLATION 0x13
441 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
442 #define LDAP_INVALID_SYNTAX 0x15
444 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
446 #define LDAP_NO_SUCH_OBJECT 0x20
447 #define LDAP_ALIAS_PROBLEM 0x21
448 #define LDAP_INVALID_DN_SYNTAX 0x22
449 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
450 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
452 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
454 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
455 #define LDAP_INAPPROPRIATE_AUTH 0x30
456 #define LDAP_INVALID_CREDENTIALS 0x31
457 #define LDAP_INSUFFICIENT_ACCESS 0x32
459 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
461 #define LDAP_BUSY 0x33
462 #define LDAP_UNAVAILABLE 0x34
463 #define LDAP_UNWILLING_TO_PERFORM 0x35
464 #define LDAP_LOOP_DETECT 0x36
466 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
468 #define LDAP_NAMING_VIOLATION 0x40
469 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
470 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
471 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
472 #define LDAP_ALREADY_EXISTS 0x44
473 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
474 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
475 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
477 #define LDAP_OTHER 0x50
479 /* Experimental result codes */
480 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
481 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
483 /* for the LDAP Sync operation */
484 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
486 /* for the LDAP No-Op control */
487 #define LDAP_NO_OPERATION 0x410e
489 /* for the Assertion control */
490 #define LDAP_ASSERTION_FAILED 0x410f
492 /* for the Cancel operation */
493 #define LDAP_CANCELLED 0x4110
494 #define LDAP_NO_SUCH_OPERATION 0x4111
495 #define LDAP_TOO_LATE 0x4112
496 #define LDAP_CANNOT_CANCEL 0x4113
500 * Based on draft-ietf-ldap-c-api-xx
501 * but with new negative code values
503 #define LDAP_API_ERROR(n) ((n)<0)
504 #define LDAP_API_RESULT(n) ((n)<=0)
506 #define LDAP_SERVER_DOWN (-1)
507 #define LDAP_LOCAL_ERROR (-2)
508 #define LDAP_ENCODING_ERROR (-3)
509 #define LDAP_DECODING_ERROR (-4)
510 #define LDAP_TIMEOUT (-5)
511 #define LDAP_AUTH_UNKNOWN (-6)
512 #define LDAP_FILTER_ERROR (-7)
513 #define LDAP_USER_CANCELLED (-8)
514 #define LDAP_PARAM_ERROR (-9)
515 #define LDAP_NO_MEMORY (-10)
516 #define LDAP_CONNECT_ERROR (-11)
517 #define LDAP_NOT_SUPPORTED (-12)
518 #define LDAP_CONTROL_NOT_FOUND (-13)
519 #define LDAP_NO_RESULTS_RETURNED (-14)
520 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
521 #define LDAP_CLIENT_LOOP (-16)
522 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
526 * This structure represents both ldap messages and ldap responses.
527 * These are really the same, except in the case of search responses,
528 * where a response has multiple messages.
531 typedef struct ldapmsg LDAPMessage;
533 /* for modifications */
534 typedef struct ldapmod {
537 #define LDAP_MOD_OP (0x0007)
538 #define LDAP_MOD_ADD (0x0000)
539 #define LDAP_MOD_DELETE (0x0001)
540 #define LDAP_MOD_REPLACE (0x0002)
541 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
542 #define LDAP_MOD_BVALUES (0x0080)
543 /* IMPORTANT: do not use code 0x1000 (or above),
544 * it is used internally by the backends!
545 * (see ldap/servers/slapd/slap.h)
551 struct berval **modv_bvals;
553 #define mod_values mod_vals.modv_strvals
554 #define mod_bvalues mod_vals.modv_bvals
558 * structure representing an ldap session which can
559 * encompass connections to multiple servers (in the
560 * face of referrals).
562 typedef struct ldap LDAP;
564 #define LDAP_DEREF_NEVER 0x00
565 #define LDAP_DEREF_SEARCHING 0x01
566 #define LDAP_DEREF_FINDING 0x02
567 #define LDAP_DEREF_ALWAYS 0x03
569 #define LDAP_NO_LIMIT 0
571 /* how many messages to retrieve results for */
572 #define LDAP_MSG_ONE 0x00
573 #define LDAP_MSG_ALL 0x01
574 #define LDAP_MSG_RECEIVED 0x02
577 * types for ldap URL handling
579 typedef struct ldap_url_desc {
580 struct ldap_url_desc *lud_next;
592 #define LDAP_URL_SUCCESS 0x00 /* Success */
593 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
594 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
596 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
597 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
598 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
599 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
600 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
601 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
602 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
603 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
606 * The API draft spec says we should declare (or cause to be declared)
607 * 'struct timeval'. We don't. See IETF LDAPext discussions.
615 ldap_get_option LDAP_P((
621 ldap_set_option LDAP_P((
624 LDAP_CONST void *invalue));
626 /* V3 REBIND Function Callback Prototype */
627 typedef int (LDAP_REBIND_PROC) LDAP_P((
628 LDAP *ld, LDAP_CONST char *url,
629 ber_tag_t request, ber_int_t msgid,
633 ldap_set_rebind_proc LDAP_P((
635 LDAP_REBIND_PROC *rebind_proc,
642 ldap_create_control LDAP_P((
643 LDAP_CONST char *requestOID,
646 LDAPControl **ctrlp ));
648 LDAP_F( LDAPControl * )
649 ldap_find_control LDAP_P((
650 LDAP_CONST char *oid,
651 LDAPControl **ctrls ));
654 ldap_control_free LDAP_P((
655 LDAPControl *ctrl ));
658 ldap_controls_free LDAP_P((
659 LDAPControl **ctrls ));
665 ldap_domain2dn LDAP_P((
666 LDAP_CONST char* domain,
670 ldap_dn2domain LDAP_P((
675 ldap_domain2hostlist LDAP_P((
676 LDAP_CONST char *domain,
683 ldap_extended_operation LDAP_P((
685 LDAP_CONST char *reqoid,
686 struct berval *reqdata,
687 LDAPControl **serverctrls,
688 LDAPControl **clientctrls,
692 ldap_extended_operation_s LDAP_P((
694 LDAP_CONST char *reqoid,
695 struct berval *reqdata,
696 LDAPControl **serverctrls,
697 LDAPControl **clientctrls,
699 struct berval **retdatap ));
702 ldap_parse_extended_result LDAP_P((
706 struct berval **retdatap,
710 ldap_parse_intermediate LDAP_P((
714 struct berval **retdatap,
715 LDAPControl ***serverctrls,
722 ldap_abandon_ext LDAP_P((
725 LDAPControl **serverctrls,
726 LDAPControl **clientctrls ));
730 ldap_abandon LDAP_P(( /* deprecated */
740 ldap_add_ext LDAP_P((
744 LDAPControl **serverctrls,
745 LDAPControl **clientctrls,
749 ldap_add_ext_s LDAP_P((
753 LDAPControl **serverctrls,
754 LDAPControl **clientctrls ));
758 ldap_add LDAP_P(( /* deprecated */
764 ldap_add_s LDAP_P(( /* deprecated */
775 ldap_sasl_bind LDAP_P((
778 LDAP_CONST char *mechanism,
780 LDAPControl **serverctrls,
781 LDAPControl **clientctrls,
784 /* Interaction flags (should be passed about in a control)
785 * Automatic (default): use defaults, prompt otherwise
786 * Interactive: prompt always
787 * Quiet: never prompt
789 #define LDAP_SASL_AUTOMATIC 0U
790 #define LDAP_SASL_INTERACTIVE 1U
791 #define LDAP_SASL_QUIET 2U
794 * V3 SASL Interaction Function Callback Prototype
795 * when using Cyrus SASL, interact is pointer to sasl_interact_t
796 * should likely passed in a control (and provided controls)
798 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
799 LDAP *ld, unsigned flags, void* defaults, void *interact ));
802 ldap_sasl_interactive_bind_s LDAP_P((
804 LDAP_CONST char *dn, /* usually NULL */
805 LDAP_CONST char *saslMechanism,
806 LDAPControl **serverControls,
807 LDAPControl **clientControls,
809 /* should be client controls */
811 LDAP_SASL_INTERACT_PROC *proc,
815 ldap_sasl_bind_s LDAP_P((
818 LDAP_CONST char *mechanism,
820 LDAPControl **serverctrls,
821 LDAPControl **clientctrls,
822 struct berval **servercredp ));
825 ldap_parse_sasl_bind_result LDAP_P((
828 struct berval **servercredp,
837 ldap_bind LDAP_P(( /* deprecated */
839 LDAP_CONST char *who,
840 LDAP_CONST char *passwd,
844 ldap_bind_s LDAP_P(( /* deprecated */
846 LDAP_CONST char *who,
847 LDAP_CONST char *cred,
854 ldap_simple_bind LDAP_P(( /* deprecated */
856 LDAP_CONST char *who,
857 LDAP_CONST char *passwd ));
860 ldap_simple_bind_s LDAP_P(( /* deprecated */
862 LDAP_CONST char *who,
863 LDAP_CONST char *passwd ));
871 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
873 LDAP_CONST char *who ));
876 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
878 LDAP_CONST char *who ));
881 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
883 LDAP_CONST char *who ));
886 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
888 LDAP_CONST char *who ));
891 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
893 LDAP_CONST char *who ));
901 ldap_compare_ext LDAP_P((
904 LDAP_CONST char *attr,
905 struct berval *bvalue,
906 LDAPControl **serverctrls,
907 LDAPControl **clientctrls,
911 ldap_compare_ext_s LDAP_P((
914 LDAP_CONST char *attr,
915 struct berval *bvalue,
916 LDAPControl **serverctrls,
917 LDAPControl **clientctrls ));
921 ldap_compare LDAP_P(( /* deprecated */
924 LDAP_CONST char *attr,
925 LDAP_CONST char *value ));
928 ldap_compare_s LDAP_P(( /* deprecated */
931 LDAP_CONST char *attr,
932 LDAP_CONST char *value ));
940 ldap_delete_ext LDAP_P((
943 LDAPControl **serverctrls,
944 LDAPControl **clientctrls,
948 ldap_delete_ext_s LDAP_P((
951 LDAPControl **serverctrls,
952 LDAPControl **clientctrls ));
956 ldap_delete LDAP_P(( /* deprecated */
958 LDAP_CONST char *dn ));
961 ldap_delete_s LDAP_P(( /* deprecated */
963 LDAP_CONST char *dn ));
971 ldap_parse_result LDAP_P((
978 LDAPControl ***serverctrls,
982 ldap_err2string LDAP_P((
987 ldap_result2error LDAP_P(( /* deprecated */
993 ldap_perror LDAP_P(( /* deprecated */
995 LDAP_CONST char *s ));
1003 ldap_modify_ext LDAP_P((
1005 LDAP_CONST char *dn,
1007 LDAPControl **serverctrls,
1008 LDAPControl **clientctrls,
1012 ldap_modify_ext_s LDAP_P((
1014 LDAP_CONST char *dn,
1016 LDAPControl **serverctrls,
1017 LDAPControl **clientctrls ));
1021 ldap_modify LDAP_P(( /* deprecated */
1023 LDAP_CONST char *dn,
1027 ldap_modify_s LDAP_P(( /* deprecated */
1029 LDAP_CONST char *dn,
1038 ldap_rename 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_rename_s LDAP_P((
1051 LDAP_CONST char *dn,
1052 LDAP_CONST char *newrdn,
1053 LDAP_CONST char *newSuperior,
1055 LDAPControl **sctrls,
1056 LDAPControl **cctrls ));
1060 ldap_rename2 LDAP_P(( /* deprecated */
1062 LDAP_CONST char *dn,
1063 LDAP_CONST char *newrdn,
1064 LDAP_CONST char *newSuperior,
1065 int deleteoldrdn ));
1068 ldap_rename2_s LDAP_P(( /* deprecated */
1070 LDAP_CONST char *dn,
1071 LDAP_CONST char *newrdn,
1072 LDAP_CONST char *newSuperior,
1073 int deleteoldrdn ));
1076 ldap_modrdn LDAP_P(( /* deprecated */
1078 LDAP_CONST char *dn,
1079 LDAP_CONST char *newrdn ));
1082 ldap_modrdn_s LDAP_P(( /* deprecated */
1084 LDAP_CONST char *dn,
1085 LDAP_CONST char *newrdn ));
1088 ldap_modrdn2 LDAP_P(( /* deprecated */
1090 LDAP_CONST char *dn,
1091 LDAP_CONST char *newrdn,
1092 int deleteoldrdn ));
1095 ldap_modrdn2_s LDAP_P(( /* deprecated */
1097 LDAP_CONST char *dn,
1098 LDAP_CONST char *newrdn,
1108 ldap_init LDAP_P(( /* deprecated */
1109 LDAP_CONST char *host,
1113 ldap_open LDAP_P(( /* deprecated */
1114 LDAP_CONST char *host,
1119 ldap_create LDAP_P((
1123 ldap_initialize LDAP_P((
1125 LDAP_CONST char *url ));
1128 ldap_start_tls_s LDAP_P((
1130 LDAPControl **serverctrls,
1131 LDAPControl **clientctrls ));
1136 LDAP_F( LDAPMessage * )
1137 ldap_first_message LDAP_P((
1139 LDAPMessage *chain ));
1141 LDAP_F( LDAPMessage * )
1142 ldap_next_message LDAP_P((
1144 LDAPMessage *msg ));
1147 ldap_count_messages LDAP_P((
1149 LDAPMessage *chain ));
1154 LDAP_F( LDAPMessage * )
1155 ldap_first_reference LDAP_P((
1157 LDAPMessage *chain ));
1159 LDAP_F( LDAPMessage * )
1160 ldap_next_reference LDAP_P((
1162 LDAPMessage *ref ));
1165 ldap_count_references LDAP_P((
1167 LDAPMessage *chain ));
1170 ldap_parse_reference LDAP_P((
1174 LDAPControl ***serverctrls,
1181 LDAP_F( LDAPMessage * )
1182 ldap_first_entry LDAP_P((
1184 LDAPMessage *chain ));
1186 LDAP_F( LDAPMessage * )
1187 ldap_next_entry LDAP_P((
1189 LDAPMessage *entry ));
1192 ldap_count_entries LDAP_P((
1194 LDAPMessage *chain ));
1197 ldap_get_entry_controls LDAP_P((
1200 LDAPControl ***serverctrls));
1206 LDAP_F( LDAPMessage * )
1207 ldap_delete_result_entry LDAP_P((
1212 ldap_add_result_entry LDAP_P((
1221 ldap_get_dn LDAP_P((
1223 LDAPMessage *entry ));
1225 typedef struct ldap_ava {
1226 struct berval la_attr;
1227 struct berval la_value;
1229 #define LDAP_AVA_NULL 0x0000U
1230 #define LDAP_AVA_STRING 0x0001U
1231 #define LDAP_AVA_BINARY 0x0002U
1232 #define LDAP_AVA_NONPRINTABLE 0x0004U
1233 #define LDAP_AVA_FREE_ATTR 0x0010U
1234 #define LDAP_AVA_FREE_VALUE 0x0020U
1239 typedef LDAPAVA** LDAPRDN;
1240 typedef LDAPRDN* LDAPDN;
1243 #define LDAP_DN_FORMAT_LDAP 0x0000U
1244 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1245 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1246 #define LDAP_DN_FORMAT_DCE 0x0030U
1247 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1248 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1249 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1250 #define LDAP_DN_FORMAT_MASK 0x00F0U
1253 #define LDAP_DN_PRETTY 0x0100U
1254 #define LDAP_DN_SKIP 0x0200U
1255 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1256 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1257 #define LDAP_DN_PEDANTIC 0xF000U
1259 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1260 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1269 ldap_str2dn LDAP_P((
1270 LDAP_CONST char *str,
1281 ldap_dn2str LDAP_P((
1287 ldap_bv2rdn LDAP_P((
1294 ldap_str2rdn LDAP_P((
1295 LDAP_CONST char *str,
1301 ldap_rdn2bv LDAP_P((
1307 ldap_rdn2str LDAP_P((
1313 ldap_dn_normalize LDAP_P((
1314 LDAP_CONST char *in, unsigned iflags,
1315 char **out, unsigned oflags ));
1318 ldap_dn2ufn LDAP_P(( /* deprecated */
1319 LDAP_CONST char *dn ));
1322 ldap_explode_dn LDAP_P(( /* deprecated */
1323 LDAP_CONST char *dn,
1327 ldap_explode_rdn LDAP_P(( /* deprecated */
1328 LDAP_CONST char *rdn,
1331 typedef int LDAPDN_rewrite_func
1332 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1335 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1336 LDAPDN_rewrite_func *func, unsigned flags ));
1339 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1342 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1345 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1348 ldap_get_dn_ber LDAP_P((
1349 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1352 ldap_get_attribute_ber LDAP_P((
1353 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1354 struct berval **vals ));
1360 ldap_first_attribute LDAP_P((
1363 BerElement **ber ));
1366 ldap_next_attribute LDAP_P((
1375 LDAP_F( struct berval ** )
1376 ldap_get_values_len LDAP_P((
1379 LDAP_CONST char *target ));
1382 ldap_count_values_len LDAP_P((
1383 struct berval **vals ));
1386 ldap_value_free_len LDAP_P((
1387 struct berval **vals ));
1391 ldap_get_values LDAP_P(( /* deprecated */
1394 LDAP_CONST char *target ));
1397 ldap_count_values LDAP_P(( /* deprecated */
1401 ldap_value_free LDAP_P(( /* deprecated */
1409 ldap_result LDAP_P((
1413 struct timeval *timeout,
1414 LDAPMessage **result ));
1417 ldap_msgtype LDAP_P((
1425 ldap_msgfree LDAP_P((
1429 ldap_msgdelete LDAP_P((
1438 ldap_search_ext LDAP_P((
1440 LDAP_CONST char *base,
1442 LDAP_CONST char *filter,
1445 LDAPControl **serverctrls,
1446 LDAPControl **clientctrls,
1447 struct timeval *timeout,
1452 ldap_search_ext_s LDAP_P((
1454 LDAP_CONST char *base,
1456 LDAP_CONST char *filter,
1459 LDAPControl **serverctrls,
1460 LDAPControl **clientctrls,
1461 struct timeval *timeout,
1463 LDAPMessage **res ));
1467 ldap_search LDAP_P(( /* deprecated */
1469 LDAP_CONST char *base,
1471 LDAP_CONST char *filter,
1476 ldap_search_s LDAP_P(( /* deprecated */
1478 LDAP_CONST char *base,
1480 LDAP_CONST char *filter,
1483 LDAPMessage **res ));
1486 ldap_search_st LDAP_P(( /* deprecated */
1488 LDAP_CONST char *base,
1490 LDAP_CONST char *filter,
1493 struct timeval *timeout,
1494 LDAPMessage **res ));
1501 ldap_unbind_ext LDAP_P((
1503 LDAPControl **serverctrls,
1504 LDAPControl **clientctrls));
1507 ldap_unbind_ext_s LDAP_P((
1509 LDAPControl **serverctrls,
1510 LDAPControl **clientctrls));
1514 ldap_unbind LDAP_P(( /* deprecated */
1518 ldap_unbind_s LDAP_P(( /* deprecated */
1526 ldap_put_vrFilter LDAP_P((
1535 ldap_memalloc LDAP_P((
1539 ldap_memrealloc LDAP_P((
1544 ldap_memcalloc LDAP_P((
1549 ldap_memfree LDAP_P((
1553 ldap_memvfree LDAP_P((
1557 ldap_strdup LDAP_P((
1558 LDAP_CONST char * ));
1561 ldap_mods_free LDAP_P((
1568 * in sort.c (deprecated)
1570 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1571 LDAP_CONST char *left,
1572 LDAP_CONST char *right ));
1574 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1575 LDAP_CONST void *left,
1576 LDAP_CONST void *right ));
1578 LDAP_F( int ) /* deprecated */
1579 ldap_sort_entries LDAP_P(( LDAP *ld,
1580 LDAPMessage **chain,
1581 LDAP_CONST char *attr,
1582 LDAP_SORT_AD_CMP_PROC *cmp ));
1584 LDAP_F( int ) /* deprecated */
1585 ldap_sort_values LDAP_P((
1588 LDAP_SORT_AV_CMP_PROC *cmp ));
1590 LDAP_F( int ) /* deprecated */
1591 ldap_sort_strcasecmp LDAP_P((
1593 LDAP_CONST void *b ));
1600 ldap_is_ldap_url LDAP_P((
1601 LDAP_CONST char *url ));
1604 ldap_is_ldaps_url LDAP_P((
1605 LDAP_CONST char *url ));
1608 ldap_is_ldapi_url LDAP_P((
1609 LDAP_CONST char *url ));
1612 ldap_url_parse LDAP_P((
1613 LDAP_CONST char *url,
1614 LDAPURLDesc **ludpp ));
1617 ldap_url_desc2str LDAP_P((
1618 LDAPURLDesc *ludp ));
1621 ldap_free_urldesc LDAP_P((
1622 LDAPURLDesc *ludp ));
1626 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1629 #define LDAP_API_FEATURE_CANCEL 1000
1632 ldap_cancel LDAP_P(( LDAP *ld,
1634 LDAPControl **sctrls,
1635 LDAPControl **cctrls,
1639 ldap_cancel_s LDAP_P((
1642 LDAPControl **sctrl,
1643 LDAPControl **cctrl ));
1646 * LDAP Server Side Sort
1649 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1651 /* structure for a sort-key */
1652 typedef struct ldapsortkey {
1653 char * attributeType;
1654 char * orderingRule;
1659 ldap_create_sort_keylist LDAP_P((
1660 LDAPSortKey ***sortKeyList,
1664 ldap_free_sort_keylist LDAP_P((
1665 LDAPSortKey **sortkeylist ));
1668 ldap_create_sort_control LDAP_P((
1670 LDAPSortKey **keyList,
1672 LDAPControl **ctrlp ));
1675 ldap_parse_sort_control LDAP_P((
1677 LDAPControl **ctrlp,
1678 unsigned long *result,
1679 char **attribute ));
1683 * LDAP Virtual List View
1686 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1688 /* structure for virtual list */
1689 typedef struct ldapvlvinfo {
1691 unsigned long ldvlv_before_count;
1692 unsigned long ldvlv_after_count;
1693 unsigned long ldvlv_offset;
1694 unsigned long ldvlv_count;
1695 struct berval * ldvlv_attrvalue;
1696 struct berval * ldvlv_context;
1697 void * ldvlv_extradata;
1701 ldap_create_vlv_control LDAP_P((
1703 LDAPVLVInfo *ldvlistp,
1704 LDAPControl **ctrlp ));
1707 ldap_parse_vlv_control LDAP_P((
1709 LDAPControl **ctrls,
1710 unsigned long *target_posp,
1711 unsigned long *list_countp,
1712 struct berval **contextp,
1720 #define LDAP_API_FEATURE_WHOAMI 1000
1723 ldap_parse_whoami LDAP_P((
1726 struct berval **authzid ));
1729 ldap_whoami LDAP_P(( LDAP *ld,
1730 LDAPControl **sctrls,
1731 LDAPControl **cctrls,
1735 ldap_whoami_s LDAP_P((
1737 struct berval **authzid,
1738 LDAPControl **sctrls,
1739 LDAPControl **cctrls ));
1742 * LDAP Password Modify
1745 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1748 ldap_parse_passwd LDAP_P((
1751 struct berval *newpasswd ));
1754 ldap_passwd LDAP_P(( LDAP *ld,
1755 struct berval *user,
1756 struct berval *oldpw,
1757 struct berval *newpw,
1758 LDAPControl **sctrls,
1759 LDAPControl **cctrls,
1763 ldap_passwd_s LDAP_P((
1765 struct berval *user,
1766 struct berval *oldpw,
1767 struct berval *newpw,
1768 struct berval *newpasswd,
1769 LDAPControl **sctrls,
1770 LDAPControl **cctrls ));
1773 #endif /* _LDAP_H */