2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2008 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 */
79 /* RFC 4511: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
80 #define LDAP_MAXINT (2147483647)
84 * 0x0000 - 0x0fff reserved for api options
85 * 0x1000 - 0x3fff reserved for api extended options
86 * 0x4000 - 0x7fff reserved for private and experimental options
89 #define LDAP_OPT_API_INFO 0x0000
90 #define LDAP_OPT_DESC 0x0001 /* historic */
91 #define LDAP_OPT_DEREF 0x0002
92 #define LDAP_OPT_SIZELIMIT 0x0003
93 #define LDAP_OPT_TIMELIMIT 0x0004
94 /* 0x05 - 0x07 not defined */
95 #define LDAP_OPT_REFERRALS 0x0008
96 #define LDAP_OPT_RESTART 0x0009
97 /* 0x0a - 0x10 not defined */
98 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
99 #define LDAP_OPT_SERVER_CONTROLS 0x0012
100 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
101 /* 0x14 not defined */
102 #define LDAP_OPT_API_FEATURE_INFO 0x0015
103 /* 0x16 - 0x2f not defined */
104 #define LDAP_OPT_HOST_NAME 0x0030
105 #define LDAP_OPT_RESULT_CODE 0x0031
106 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
107 #define LDAP_OPT_DIAGNOSTIC_MESSAGE 0x0032
108 #define LDAP_OPT_ERROR_STRING LDAP_OPT_DIAGNOSTIC_MESSAGE
109 #define LDAP_OPT_MATCHED_DN 0x0033
110 /* 0x0034 - 0x3fff not defined */
111 /* 0x0091 used by Microsoft for LDAP_OPT_AUTO_RECONNECT */
112 #define LDAP_OPT_SSPI_FLAGS 0x0092
113 /* 0x0093 used by Microsoft for LDAP_OPT_SSL_INFO */
114 /* 0x0094 used by Microsoft for LDAP_OPT_REF_DEREF_CONN_PER_MSG */
115 #define LDAP_OPT_SIGN 0x0095
116 #define LDAP_OPT_ENCRYPT 0x0096
117 #define LDAP_OPT_SASL_METHOD 0x0097
118 /* 0x0098 used by Microsoft for LDAP_OPT_AREC_EXCLUSIVE */
119 #define LDAP_OPT_SECURITY_CONTEXT 0x0099
120 /* 0x009A used by Microsoft for LDAP_OPT_ROOTDSE_CACHE */
121 /* 0x009B - 0x3fff not defined */
124 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
126 /* private and experimental options */
127 /* OpenLDAP specific options */
128 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
129 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
130 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
131 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
132 #define LDAP_OPT_URI 0x5006
133 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
134 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */
135 #define LDAP_OPT_DEFBASE 0x5009 /* searchbase */
136 #define LDAP_OPT_CONNECT_ASYNC 0x5010 /* create connections asynchronously */
137 #define LDAP_OPT_CONNECT_CB 0x5011 /* connection callbacks */
139 /* OpenLDAP TLS options */
140 #define LDAP_OPT_X_TLS 0x6000
141 #define LDAP_OPT_X_TLS_CTX 0x6001 /* OpenSSL CTX* */
142 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
143 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
144 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
145 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
146 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
147 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
148 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
149 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
150 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a /* OpenSSL SSL* */
151 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
152 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
153 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
154 #define LDAP_OPT_X_TLS_DHFILE 0x600e
155 #define LDAP_OPT_X_TLS_NEWCTX 0x600f
156 #define LDAP_OPT_X_TLS_CRLFILE 0x6010 /* GNUtls only */
158 #define LDAP_OPT_X_TLS_NEVER 0
159 #define LDAP_OPT_X_TLS_HARD 1
160 #define LDAP_OPT_X_TLS_DEMAND 2
161 #define LDAP_OPT_X_TLS_ALLOW 3
162 #define LDAP_OPT_X_TLS_TRY 4
164 #define LDAP_OPT_X_TLS_CRL_NONE 0
165 #define LDAP_OPT_X_TLS_CRL_PEER 1
166 #define LDAP_OPT_X_TLS_CRL_ALL 2
168 /* OpenLDAP SASL options */
169 #define LDAP_OPT_X_SASL_MECH 0x6100
170 #define LDAP_OPT_X_SASL_REALM 0x6101
171 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
172 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
173 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
174 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
175 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
176 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
177 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
178 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
179 #define LDAP_OPT_X_SASL_MECHLIST 0x610a /* read-only */
181 /* OpenLDAP GSSAPI options */
182 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT 0x6200
183 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL 0x6201
186 /* Private API Extensions -- reserved for application use */
187 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
190 * ldap_get_option() and ldap_set_option() return values.
191 * As later versions may return other values indicating
192 * failure, current applications should only compare returned
193 * value against LDAP_OPT_SUCCESS.
195 #define LDAP_OPT_SUCCESS 0
196 #define LDAP_OPT_ERROR (-1)
198 /* option on/off values */
199 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
200 #define LDAP_OPT_OFF ((void *) 0)
202 typedef struct ldapapiinfo {
203 int ldapai_info_version; /* version of LDAPAPIInfo */
204 #define LDAP_API_INFO_VERSION (1)
205 int ldapai_api_version; /* revision of API supported */
206 int ldapai_protocol_version; /* highest LDAP version supported */
207 char **ldapai_extensions; /* names of API extensions */
208 char *ldapai_vendor_name; /* name of supplier */
209 int ldapai_vendor_version; /* supplier-specific version * 100 */
212 typedef struct ldap_apifeature_info {
213 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
214 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
215 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
216 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
217 } LDAPAPIFeatureInfo;
220 * LDAP Control structure
222 typedef struct ldapcontrol {
223 char * ldctl_oid; /* numericoid of control */
224 struct berval ldctl_value; /* encoded value of control */
225 char ldctl_iscritical; /* criticality */
229 /* standard track controls */
230 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
231 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
232 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
234 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
236 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
237 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
238 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
240 /* standard track - not implemented in slapd(8) */
241 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
242 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
244 /* non-standard track controls */
245 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
247 /* LDAP Content Synchronization Operation -- RFC 4533 */
248 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
249 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
250 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
251 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
252 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
254 #define LDAP_SYNC_NONE 0x00
255 #define LDAP_SYNC_REFRESH_ONLY 0x01
256 #define LDAP_SYNC_RESERVED 0x02
257 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
259 #define LDAP_SYNC_REFRESH_PRESENTS 0
260 #define LDAP_SYNC_REFRESH_DELETES 1
262 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
263 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
264 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
265 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
267 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
268 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
269 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
270 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
272 #define LDAP_SYNC_PRESENT 0
273 #define LDAP_SYNC_ADD 1
274 #define LDAP_SYNC_MODIFY 2
275 #define LDAP_SYNC_DELETE 3
278 /* Password policy Controls *//* work in progress */
279 /* ITS#3458: released; disabled by default */
280 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
281 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
283 /* various works in progress */
284 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
285 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
286 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
287 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
288 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
289 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
290 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
293 /* LDAP Chaining Behavior Control *//* work in progress */
294 /* <draft-sermersheim-ldap-chaining>;
295 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
296 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
298 #define LDAP_CHAINING_PREFERRED 0
299 #define LDAP_CHAINING_REQUIRED 1
300 #define LDAP_REFERRALS_PREFERRED 2
301 #define LDAP_REFERRALS_REQUIRED 3
303 /* MS Active Directory controls (for compatibility) */
304 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
305 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
306 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
307 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
308 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
309 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
310 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
312 /* MS Active Directory controls - not implemented in slapd(8) */
313 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
316 /* <draft-wahl-ldap-session> */
317 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
318 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
319 LDAP_CONTROL_X_SESSION_TRACKING ".1"
320 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
321 LDAP_CONTROL_X_SESSION_TRACKING ".2"
322 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
323 LDAP_CONTROL_X_SESSION_TRACKING ".3"
324 #endif /* LDAP_DEVEL */
326 /* various expired works */
327 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
328 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
329 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
330 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
331 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
333 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
334 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
335 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
336 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
337 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
338 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
339 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
341 /* LDAP VLV *//* not implemented in slapd(8) */
342 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
343 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
346 /* LDAP Unsolicited Notifications */
347 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
348 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
350 /* LDAP Extended Operations */
351 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
353 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
354 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
355 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
356 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
357 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
359 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
360 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
362 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
363 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
364 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
365 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
367 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
368 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
370 /* various works in progress */
371 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
372 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
374 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
375 /* a work in progress */
376 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
377 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
378 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
379 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
380 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
381 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
382 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
383 LDAP_X_DISTPROC_BASE ".6"
384 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
385 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
386 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
387 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
388 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
391 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
392 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
393 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
394 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
395 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
399 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
400 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
401 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
402 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
403 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
404 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
405 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
407 /* LDAP Experimental (works in progress) Features */
408 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
409 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
410 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
413 * specific LDAP instantiations of BER types we know about
416 /* Overview of LBER tag construction
423 * 1 0 = CONTEXT-SPECIFIC
430 * | 5 ... 1 | TAG-NUMBER
434 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
435 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
437 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
438 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
440 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
441 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
443 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
445 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
446 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
447 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
448 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
450 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
451 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
453 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
455 /* LDAP Request Messages */
456 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
457 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
458 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
459 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
460 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
461 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
462 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
463 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
464 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
465 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
466 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
467 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
469 /* LDAP Response Messages */
470 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
471 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
472 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
473 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
474 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
475 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
476 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
477 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
478 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
479 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
480 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
481 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
482 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
484 #define LDAP_RES_ANY (-1)
485 #define LDAP_RES_UNSOLICITED (0)
489 #define LDAP_SASL_SIMPLE ((char*)0)
490 #define LDAP_SASL_NULL ("")
493 /* authentication methods available */
494 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
495 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
496 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
497 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
498 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
499 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
501 /* used by the Windows API but not used on the wire */
502 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
505 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
506 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
507 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
508 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
509 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
510 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
511 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
512 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
513 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
514 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
516 /* extended filter component types */
517 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
518 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
519 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
520 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
522 /* substring filter component types */
523 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
524 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
525 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
528 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
529 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
530 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
531 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
532 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
533 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
534 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
535 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
536 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
538 /* substring filter component types */
539 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
540 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
541 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
546 #define LDAP_SUCCESS 0x00
548 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
550 #define LDAP_OPERATIONS_ERROR 0x01
551 #define LDAP_PROTOCOL_ERROR 0x02
552 #define LDAP_TIMELIMIT_EXCEEDED 0x03
553 #define LDAP_SIZELIMIT_EXCEEDED 0x04
554 #define LDAP_COMPARE_FALSE 0x05
555 #define LDAP_COMPARE_TRUE 0x06
556 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
557 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
558 #define LDAP_STRONG_AUTH_REQUIRED 0x08
559 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
560 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
562 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
563 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
564 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
565 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
566 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
568 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
570 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
571 #define LDAP_UNDEFINED_TYPE 0x11
572 #define LDAP_INAPPROPRIATE_MATCHING 0x12
573 #define LDAP_CONSTRAINT_VIOLATION 0x13
574 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
575 #define LDAP_INVALID_SYNTAX 0x15
577 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
579 #define LDAP_NO_SUCH_OBJECT 0x20
580 #define LDAP_ALIAS_PROBLEM 0x21
581 #define LDAP_INVALID_DN_SYNTAX 0x22
582 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
583 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
585 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
587 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
588 #define LDAP_INAPPROPRIATE_AUTH 0x30
589 #define LDAP_INVALID_CREDENTIALS 0x31
590 #define LDAP_INSUFFICIENT_ACCESS 0x32
592 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
594 #define LDAP_BUSY 0x33
595 #define LDAP_UNAVAILABLE 0x34
596 #define LDAP_UNWILLING_TO_PERFORM 0x35
597 #define LDAP_LOOP_DETECT 0x36
599 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
601 #define LDAP_NAMING_VIOLATION 0x40
602 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
603 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
604 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
605 #define LDAP_ALREADY_EXISTS 0x44
606 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
607 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
608 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
610 #define LDAP_OTHER 0x50
612 /* LCUP operation codes (113-117) - not implemented */
613 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
614 #define LDAP_CUP_SECURITY_VIOLATION 0x72
615 #define LDAP_CUP_INVALID_DATA 0x73
616 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
617 #define LDAP_CUP_RELOAD_REQUIRED 0x75
619 /* Cancel operation codes (118-121) */
620 #define LDAP_CANCELLED 0x76
621 #define LDAP_NO_SUCH_OPERATION 0x77
622 #define LDAP_TOO_LATE 0x78
623 #define LDAP_CANNOT_CANCEL 0x79
625 /* Assertion control (122) */
626 #define LDAP_ASSERTION_FAILED 0x7A
628 /* Proxied Authorization Denied (123) */
629 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
631 /* Experimental result codes */
632 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
634 /* LDAP Sync (4096) */
635 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
638 /* Private Use result codes */
639 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
641 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
642 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
644 /* for the LDAP No-Op control */
645 #define LDAP_X_NO_OPERATION 0x410e
647 /* for the Chaining Behavior control (consecutive result codes requested;
648 * see <draft-sermersheim-ldap-chaining> ) */
649 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
650 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
651 #define LDAP_X_CANNOT_CHAIN 0x4111
654 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
655 #ifdef LDAP_X_DISTPROC_BASE
656 #define LDAP_X_INVALIDREFERENCE 0x4112
660 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
661 #define LDAP_X_TXN_ID_INVALID 0x4121
666 * Based on draft-ietf-ldap-c-api-xx
667 * but with new negative code values
669 #define LDAP_API_ERROR(n) ((n)<0)
670 #define LDAP_API_RESULT(n) ((n)<=0)
672 #define LDAP_SERVER_DOWN (-1)
673 #define LDAP_LOCAL_ERROR (-2)
674 #define LDAP_ENCODING_ERROR (-3)
675 #define LDAP_DECODING_ERROR (-4)
676 #define LDAP_TIMEOUT (-5)
677 #define LDAP_AUTH_UNKNOWN (-6)
678 #define LDAP_FILTER_ERROR (-7)
679 #define LDAP_USER_CANCELLED (-8)
680 #define LDAP_PARAM_ERROR (-9)
681 #define LDAP_NO_MEMORY (-10)
682 #define LDAP_CONNECT_ERROR (-11)
683 #define LDAP_NOT_SUPPORTED (-12)
684 #define LDAP_CONTROL_NOT_FOUND (-13)
685 #define LDAP_NO_RESULTS_RETURNED (-14)
686 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
687 #define LDAP_CLIENT_LOOP (-16)
688 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
689 #define LDAP_X_CONNECTING (-18)
693 * This structure represents both ldap messages and ldap responses.
694 * These are really the same, except in the case of search responses,
695 * where a response has multiple messages.
698 typedef struct ldapmsg LDAPMessage;
700 /* for modifications */
701 typedef struct ldapmod {
704 #define LDAP_MOD_OP (0x0007)
705 #define LDAP_MOD_ADD (0x0000)
706 #define LDAP_MOD_DELETE (0x0001)
707 #define LDAP_MOD_REPLACE (0x0002)
708 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
709 #define LDAP_MOD_BVALUES (0x0080)
710 /* IMPORTANT: do not use code 0x1000 (or above),
711 * it is used internally by the backends!
712 * (see ldap/servers/slapd/slap.h)
718 struct berval **modv_bvals;
720 #define mod_values mod_vals.modv_strvals
721 #define mod_bvalues mod_vals.modv_bvals
725 * structure representing an ldap session which can
726 * encompass connections to multiple servers (in the
727 * face of referrals).
729 typedef struct ldap LDAP;
731 #define LDAP_DEREF_NEVER 0x00
732 #define LDAP_DEREF_SEARCHING 0x01
733 #define LDAP_DEREF_FINDING 0x02
734 #define LDAP_DEREF_ALWAYS 0x03
736 #define LDAP_NO_LIMIT 0
738 /* how many messages to retrieve results for */
739 #define LDAP_MSG_ONE 0x00
740 #define LDAP_MSG_ALL 0x01
741 #define LDAP_MSG_RECEIVED 0x02
744 * types for ldap URL handling
746 typedef struct ldap_url_desc {
747 struct ldap_url_desc *lud_next;
759 #define LDAP_URL_SUCCESS 0x00 /* Success */
760 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
761 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
763 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
764 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
765 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
766 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
767 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
768 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
769 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
770 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
773 * LDAP sync (RFC4533) API
776 typedef struct ldap_sync_t ldap_sync_t;
779 /* these are private - the client should never see them */
780 LDAP_SYNC_CAPI_NONE = -1,
782 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
783 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
784 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
786 /* these are passed to ls_search_entry() */
787 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
788 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
789 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
790 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
792 /* these are passed to ls_intermediate() */
793 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
794 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
796 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
797 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
799 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
800 } ldap_sync_refresh_t;
803 * Called when an entry is returned by ldap_result().
804 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
805 * the entry has been either added or modified, and thus
806 * the complete view of the entry should be in the LDAPMessage.
807 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
808 * only the DN should be in the LDAPMessage.
810 typedef int (*ldap_sync_search_entry_f) LDAP_P((
813 struct berval *entryUUID,
814 ldap_sync_refresh_t phase ));
817 * Called when a reference is returned; the client should know
818 * what to do with it.
820 typedef int (*ldap_sync_search_reference_f) LDAP_P((
825 * Called when specific intermediate/final messages are returned.
826 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
827 * a "presents" or "deletes" phase begins.
828 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
829 * with refreshDone set to "TRUE" has been returned, to indicate
830 * that the refresh phase of a refreshAndPersist is complete.
831 * In the above cases, syncUUIDs is NULL.
833 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
834 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
835 * that are either present or have been deleted.
837 typedef int (*ldap_sync_intermediate_f) LDAP_P((
841 ldap_sync_refresh_t phase ));
844 * Called when a searchResultDone is returned. In refreshAndPersist,
845 * this can only occur if the search for any reason is being terminated
848 typedef int (*ldap_sync_search_result_f) LDAP_P((
851 int refreshDeletes ));
854 * This structure contains all information about the persistent search;
855 * the caller is responsible for connecting, setting version, binding, tls...
858 /* conf search params */
869 /* helpers - add as appropriate */
870 ldap_sync_search_entry_f ls_search_entry;
871 ldap_sync_search_reference_f ls_search_reference;
872 ldap_sync_intermediate_f ls_intermediate;
873 ldap_sync_search_result_f ls_search_result;
875 /* set by the caller as appropriate */
881 /* --- the parameters below are private - do not modify --- */
883 /* FIXME: make the structure opaque, and provide an interface
884 * to modify the public values? */
890 /* needed by refreshOnly */
893 /* opaque - need to pass between sessions, updated by the API */
894 struct berval ls_cookie;
896 /* state variable - do not modify */
897 ldap_sync_refresh_t ls_refreshPhase;
901 * End of LDAP sync (RFC4533) API
905 * Connection callbacks...
910 /* Called after a connection is established */
911 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
912 struct ldap_conncb *ctx ));
913 /* Called before a connection is closed */
914 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
916 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
917 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
919 typedef struct ldap_conncb {
920 ldap_conn_add_f *lc_add;
921 ldap_conn_del_f *lc_del;
926 * The API draft spec says we should declare (or cause to be declared)
927 * 'struct timeval'. We don't. See IETF LDAPext discussions.
935 ldap_get_option LDAP_P((
941 ldap_set_option LDAP_P((
944 LDAP_CONST void *invalue));
946 /* V3 REBIND Function Callback Prototype */
947 typedef int (LDAP_REBIND_PROC) LDAP_P((
948 LDAP *ld, LDAP_CONST char *url,
949 ber_tag_t request, ber_int_t msgid,
953 ldap_set_rebind_proc LDAP_P((
955 LDAP_REBIND_PROC *rebind_proc,
958 /* V3 referral selection Function Callback Prototype */
959 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
960 LDAP *ld, char ***refsp, int *cntp,
964 ldap_set_nextref_proc LDAP_P((
966 LDAP_NEXTREF_PROC *nextref_proc,
969 /* V3 URLLIST Function Callback Prototype */
970 typedef int (LDAP_URLLIST_PROC) LDAP_P((
972 LDAPURLDesc **urllist,
977 ldap_set_urllist_proc LDAP_P((
979 LDAP_URLLIST_PROC *urllist_proc,
987 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
988 LDAP_CONST char *requestOID,
991 LDAPControl **ctrlp ));
993 LDAP_F( LDAPControl * )
994 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
995 LDAP_CONST char *oid,
996 LDAPControl **ctrls ));
1000 ldap_control_create LDAP_P((
1001 LDAP_CONST char *requestOID,
1003 struct berval *value,
1005 LDAPControl **ctrlp ));
1007 LDAP_F( LDAPControl * )
1008 ldap_control_find LDAP_P((
1009 LDAP_CONST char *oid,
1010 LDAPControl **ctrls,
1011 LDAPControl ***nextctrlp ));
1014 ldap_control_free LDAP_P((
1015 LDAPControl *ctrl ));
1018 ldap_controls_free LDAP_P((
1019 LDAPControl **ctrls ));
1021 LDAP_F( LDAPControl ** )
1022 ldap_controls_dup LDAP_P((
1023 LDAPControl *LDAP_CONST *controls ));
1025 LDAP_F( LDAPControl * )
1026 ldap_control_dup LDAP_P((
1027 LDAP_CONST LDAPControl *c ));
1033 ldap_domain2dn LDAP_P((
1034 LDAP_CONST char* domain,
1038 ldap_dn2domain LDAP_P((
1039 LDAP_CONST char* dn,
1043 ldap_domain2hostlist LDAP_P((
1044 LDAP_CONST char *domain,
1051 ldap_extended_operation LDAP_P((
1053 LDAP_CONST char *reqoid,
1054 struct berval *reqdata,
1055 LDAPControl **serverctrls,
1056 LDAPControl **clientctrls,
1060 ldap_extended_operation_s LDAP_P((
1062 LDAP_CONST char *reqoid,
1063 struct berval *reqdata,
1064 LDAPControl **serverctrls,
1065 LDAPControl **clientctrls,
1067 struct berval **retdatap ));
1070 ldap_parse_extended_result LDAP_P((
1074 struct berval **retdatap,
1078 ldap_parse_intermediate LDAP_P((
1082 struct berval **retdatap,
1083 LDAPControl ***serverctrls,
1091 ldap_abandon_ext LDAP_P((
1094 LDAPControl **serverctrls,
1095 LDAPControl **clientctrls ));
1099 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1108 ldap_add_ext LDAP_P((
1110 LDAP_CONST char *dn,
1112 LDAPControl **serverctrls,
1113 LDAPControl **clientctrls,
1117 ldap_add_ext_s LDAP_P((
1119 LDAP_CONST char *dn,
1121 LDAPControl **serverctrls,
1122 LDAPControl **clientctrls ));
1126 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1128 LDAP_CONST char *dn,
1132 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1134 LDAP_CONST char *dn,
1143 ldap_sasl_bind LDAP_P((
1145 LDAP_CONST char *dn,
1146 LDAP_CONST char *mechanism,
1147 struct berval *cred,
1148 LDAPControl **serverctrls,
1149 LDAPControl **clientctrls,
1152 /* Interaction flags (should be passed about in a control)
1153 * Automatic (default): use defaults, prompt otherwise
1154 * Interactive: prompt always
1155 * Quiet: never prompt
1157 #define LDAP_SASL_AUTOMATIC 0U
1158 #define LDAP_SASL_INTERACTIVE 1U
1159 #define LDAP_SASL_QUIET 2U
1162 * V3 SASL Interaction Function Callback Prototype
1163 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1164 * should likely passed in a control (and provided controls)
1166 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1167 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1170 ldap_sasl_interactive_bind_s LDAP_P((
1172 LDAP_CONST char *dn, /* usually NULL */
1173 LDAP_CONST char *saslMechanism,
1174 LDAPControl **serverControls,
1175 LDAPControl **clientControls,
1177 /* should be client controls */
1179 LDAP_SASL_INTERACT_PROC *proc,
1183 ldap_sasl_bind_s LDAP_P((
1185 LDAP_CONST char *dn,
1186 LDAP_CONST char *mechanism,
1187 struct berval *cred,
1188 LDAPControl **serverctrls,
1189 LDAPControl **clientctrls,
1190 struct berval **servercredp ));
1193 ldap_parse_sasl_bind_result LDAP_P((
1196 struct berval **servercredp,
1205 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1207 LDAP_CONST char *who,
1208 LDAP_CONST char *passwd,
1212 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1214 LDAP_CONST char *who,
1215 LDAP_CONST char *cred,
1222 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1224 LDAP_CONST char *who,
1225 LDAP_CONST char *passwd ));
1228 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1230 LDAP_CONST char *who,
1231 LDAP_CONST char *passwd ));
1240 ldap_compare_ext LDAP_P((
1242 LDAP_CONST char *dn,
1243 LDAP_CONST char *attr,
1244 struct berval *bvalue,
1245 LDAPControl **serverctrls,
1246 LDAPControl **clientctrls,
1250 ldap_compare_ext_s LDAP_P((
1252 LDAP_CONST char *dn,
1253 LDAP_CONST char *attr,
1254 struct berval *bvalue,
1255 LDAPControl **serverctrls,
1256 LDAPControl **clientctrls ));
1260 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1262 LDAP_CONST char *dn,
1263 LDAP_CONST char *attr,
1264 LDAP_CONST char *value ));
1267 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1269 LDAP_CONST char *dn,
1270 LDAP_CONST char *attr,
1271 LDAP_CONST char *value ));
1279 ldap_delete_ext LDAP_P((
1281 LDAP_CONST char *dn,
1282 LDAPControl **serverctrls,
1283 LDAPControl **clientctrls,
1287 ldap_delete_ext_s LDAP_P((
1289 LDAP_CONST char *dn,
1290 LDAPControl **serverctrls,
1291 LDAPControl **clientctrls ));
1295 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1297 LDAP_CONST char *dn ));
1300 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1302 LDAP_CONST char *dn ));
1310 ldap_parse_result LDAP_P((
1317 LDAPControl ***serverctrls,
1321 ldap_err2string LDAP_P((
1326 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1332 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1334 LDAP_CONST char *s ));
1342 ldap_modify_ext LDAP_P((
1344 LDAP_CONST char *dn,
1346 LDAPControl **serverctrls,
1347 LDAPControl **clientctrls,
1351 ldap_modify_ext_s LDAP_P((
1353 LDAP_CONST char *dn,
1355 LDAPControl **serverctrls,
1356 LDAPControl **clientctrls ));
1360 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1362 LDAP_CONST char *dn,
1366 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1368 LDAP_CONST char *dn,
1377 ldap_rename LDAP_P((
1379 LDAP_CONST char *dn,
1380 LDAP_CONST char *newrdn,
1381 LDAP_CONST char *newSuperior,
1383 LDAPControl **sctrls,
1384 LDAPControl **cctrls,
1388 ldap_rename_s LDAP_P((
1390 LDAP_CONST char *dn,
1391 LDAP_CONST char *newrdn,
1392 LDAP_CONST char *newSuperior,
1394 LDAPControl **sctrls,
1395 LDAPControl **cctrls ));
1399 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1401 LDAP_CONST char *dn,
1402 LDAP_CONST char *newrdn,
1403 LDAP_CONST char *newSuperior,
1404 int deleteoldrdn ));
1407 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1409 LDAP_CONST char *dn,
1410 LDAP_CONST char *newrdn,
1411 LDAP_CONST char *newSuperior,
1412 int deleteoldrdn ));
1415 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1417 LDAP_CONST char *dn,
1418 LDAP_CONST char *newrdn ));
1421 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1423 LDAP_CONST char *dn,
1424 LDAP_CONST char *newrdn ));
1427 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1429 LDAP_CONST char *dn,
1430 LDAP_CONST char *newrdn,
1431 int deleteoldrdn ));
1434 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1436 LDAP_CONST char *dn,
1437 LDAP_CONST char *newrdn,
1447 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1448 LDAP_CONST char *host,
1452 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1453 LDAP_CONST char *host,
1458 ldap_create LDAP_P((
1462 ldap_initialize LDAP_P((
1464 LDAP_CONST char *url ));
1471 ldap_tls_inplace LDAP_P((
1475 ldap_start_tls LDAP_P((
1477 LDAPControl **serverctrls,
1478 LDAPControl **clientctrls,
1482 ldap_install_tls LDAP_P((
1486 ldap_start_tls_s LDAP_P((
1488 LDAPControl **serverctrls,
1489 LDAPControl **clientctrls ));
1494 LDAP_F( LDAPMessage * )
1495 ldap_first_message LDAP_P((
1497 LDAPMessage *chain ));
1499 LDAP_F( LDAPMessage * )
1500 ldap_next_message LDAP_P((
1502 LDAPMessage *msg ));
1505 ldap_count_messages LDAP_P((
1507 LDAPMessage *chain ));
1512 LDAP_F( LDAPMessage * )
1513 ldap_first_reference LDAP_P((
1515 LDAPMessage *chain ));
1517 LDAP_F( LDAPMessage * )
1518 ldap_next_reference LDAP_P((
1520 LDAPMessage *ref ));
1523 ldap_count_references LDAP_P((
1525 LDAPMessage *chain ));
1528 ldap_parse_reference LDAP_P((
1532 LDAPControl ***serverctrls,
1539 LDAP_F( LDAPMessage * )
1540 ldap_first_entry LDAP_P((
1542 LDAPMessage *chain ));
1544 LDAP_F( LDAPMessage * )
1545 ldap_next_entry LDAP_P((
1547 LDAPMessage *entry ));
1550 ldap_count_entries LDAP_P((
1552 LDAPMessage *chain ));
1555 ldap_get_entry_controls LDAP_P((
1558 LDAPControl ***serverctrls));
1564 LDAP_F( LDAPMessage * )
1565 ldap_delete_result_entry LDAP_P((
1570 ldap_add_result_entry LDAP_P((
1579 ldap_get_dn LDAP_P((
1581 LDAPMessage *entry ));
1583 typedef struct ldap_ava {
1584 struct berval la_attr;
1585 struct berval la_value;
1587 #define LDAP_AVA_NULL 0x0000U
1588 #define LDAP_AVA_STRING 0x0001U
1589 #define LDAP_AVA_BINARY 0x0002U
1590 #define LDAP_AVA_NONPRINTABLE 0x0004U
1591 #define LDAP_AVA_FREE_ATTR 0x0010U
1592 #define LDAP_AVA_FREE_VALUE 0x0020U
1597 typedef LDAPAVA** LDAPRDN;
1598 typedef LDAPRDN* LDAPDN;
1601 #define LDAP_DN_FORMAT_LDAP 0x0000U
1602 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1603 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1604 #define LDAP_DN_FORMAT_DCE 0x0030U
1605 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1606 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1607 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1608 #define LDAP_DN_FORMAT_MASK 0x00F0U
1611 #define LDAP_DN_PRETTY 0x0100U
1612 #define LDAP_DN_SKIP 0x0200U
1613 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1614 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1615 #define LDAP_DN_PEDANTIC 0xF000U
1617 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1618 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1627 ldap_str2dn LDAP_P((
1628 LDAP_CONST char *str,
1639 ldap_dn2str LDAP_P((
1645 ldap_bv2rdn LDAP_P((
1652 ldap_str2rdn LDAP_P((
1653 LDAP_CONST char *str,
1659 ldap_rdn2bv LDAP_P((
1665 ldap_rdn2str LDAP_P((
1671 ldap_dn_normalize LDAP_P((
1672 LDAP_CONST char *in, unsigned iflags,
1673 char **out, unsigned oflags ));
1676 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1677 LDAP_CONST char *dn ));
1680 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1681 LDAP_CONST char *dn,
1685 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1686 LDAP_CONST char *rdn,
1689 typedef int LDAPDN_rewrite_func
1690 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1693 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1694 LDAPDN_rewrite_func *func, unsigned flags ));
1697 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1698 LDAP_CONST char *dn ));
1701 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1702 LDAP_CONST char *dce ));
1705 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1706 LDAP_CONST char *dn ));
1709 ldap_get_dn_ber LDAP_P((
1710 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1713 ldap_get_attribute_ber LDAP_P((
1714 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1715 struct berval **vals ));
1721 ldap_first_attribute LDAP_P((
1724 BerElement **ber ));
1727 ldap_next_attribute LDAP_P((
1736 LDAP_F( struct berval ** )
1737 ldap_get_values_len LDAP_P((
1740 LDAP_CONST char *target ));
1743 ldap_count_values_len LDAP_P((
1744 struct berval **vals ));
1747 ldap_value_free_len LDAP_P((
1748 struct berval **vals ));
1752 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1755 LDAP_CONST char *target ));
1758 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1762 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1770 ldap_result LDAP_P((
1774 struct timeval *timeout,
1775 LDAPMessage **result ));
1778 ldap_msgtype LDAP_P((
1786 ldap_msgfree LDAP_P((
1790 ldap_msgdelete LDAP_P((
1799 ldap_bv2escaped_filter_value LDAP_P((
1801 struct berval *out ));
1804 ldap_search_ext LDAP_P((
1806 LDAP_CONST char *base,
1808 LDAP_CONST char *filter,
1811 LDAPControl **serverctrls,
1812 LDAPControl **clientctrls,
1813 struct timeval *timeout,
1818 ldap_search_ext_s LDAP_P((
1820 LDAP_CONST char *base,
1822 LDAP_CONST char *filter,
1825 LDAPControl **serverctrls,
1826 LDAPControl **clientctrls,
1827 struct timeval *timeout,
1829 LDAPMessage **res ));
1833 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1835 LDAP_CONST char *base,
1837 LDAP_CONST char *filter,
1842 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1844 LDAP_CONST char *base,
1846 LDAP_CONST char *filter,
1849 LDAPMessage **res ));
1852 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1854 LDAP_CONST char *base,
1856 LDAP_CONST char *filter,
1859 struct timeval *timeout,
1860 LDAPMessage **res ));
1867 ldap_unbind_ext LDAP_P((
1869 LDAPControl **serverctrls,
1870 LDAPControl **clientctrls));
1873 ldap_unbind_ext_s LDAP_P((
1875 LDAPControl **serverctrls,
1876 LDAPControl **clientctrls));
1880 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1884 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1892 ldap_put_vrFilter LDAP_P((
1901 ldap_memalloc LDAP_P((
1905 ldap_memrealloc LDAP_P((
1910 ldap_memcalloc LDAP_P((
1915 ldap_memfree LDAP_P((
1919 ldap_memvfree LDAP_P((
1923 ldap_strdup LDAP_P((
1924 LDAP_CONST char * ));
1927 ldap_mods_free LDAP_P((
1934 * in sort.c (deprecated, use custom code instead)
1936 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1937 LDAP_CONST char *left,
1938 LDAP_CONST char *right ));
1940 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1941 LDAP_CONST void *left,
1942 LDAP_CONST void *right ));
1944 LDAP_F( int ) /* deprecated */
1945 ldap_sort_entries LDAP_P(( LDAP *ld,
1946 LDAPMessage **chain,
1947 LDAP_CONST char *attr,
1948 LDAP_SORT_AD_CMP_PROC *cmp ));
1950 LDAP_F( int ) /* deprecated */
1951 ldap_sort_values LDAP_P((
1954 LDAP_SORT_AV_CMP_PROC *cmp ));
1956 LDAP_F( int ) /* deprecated */
1957 ldap_sort_strcasecmp LDAP_P((
1959 LDAP_CONST void *b ));
1966 ldap_is_ldap_url LDAP_P((
1967 LDAP_CONST char *url ));
1970 ldap_is_ldaps_url LDAP_P((
1971 LDAP_CONST char *url ));
1974 ldap_is_ldapi_url LDAP_P((
1975 LDAP_CONST char *url ));
1978 ldap_url_parse LDAP_P((
1979 LDAP_CONST char *url,
1980 LDAPURLDesc **ludpp ));
1983 ldap_url_desc2str LDAP_P((
1984 LDAPURLDesc *ludp ));
1987 ldap_free_urldesc LDAP_P((
1988 LDAPURLDesc *ludp ));
1992 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1995 #define LDAP_API_FEATURE_CANCEL 1000
1998 ldap_cancel LDAP_P(( LDAP *ld,
2000 LDAPControl **sctrls,
2001 LDAPControl **cctrls,
2005 ldap_cancel_s LDAP_P(( LDAP *ld,
2007 LDAPControl **sctrl,
2008 LDAPControl **cctrl ));
2011 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2014 #define LDAP_API_FEATURE_TURN 1000
2017 ldap_turn LDAP_P(( LDAP *ld,
2019 LDAP_CONST char* identifier,
2020 LDAPControl **sctrls,
2021 LDAPControl **cctrls,
2025 ldap_turn_s LDAP_P(( LDAP *ld,
2027 LDAP_CONST char* identifier,
2028 LDAPControl **sctrl,
2029 LDAPControl **cctrl ));
2032 * LDAP Paged Results
2035 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2038 ldap_create_page_control_value LDAP_P((
2041 struct berval *cookie,
2042 struct berval *value ));
2045 ldap_create_page_control LDAP_P((
2048 struct berval *cookie,
2050 LDAPControl **ctrlp ));
2054 ldap_parse_page_control LDAP_P((
2055 /* deprecated, use ldap_parse_pageresponse_control */
2057 LDAPControl **ctrls,
2059 struct berval **cookie ));
2063 ldap_parse_pageresponse_control LDAP_P((
2067 struct berval *cookie ));
2070 * LDAP Server Side Sort
2073 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2075 /* structure for a sort-key */
2076 typedef struct ldapsortkey {
2077 char *attributeType;
2083 ldap_create_sort_keylist LDAP_P((
2084 LDAPSortKey ***sortKeyList,
2088 ldap_free_sort_keylist LDAP_P((
2089 LDAPSortKey **sortkeylist ));
2092 ldap_create_sort_control_value LDAP_P((
2094 LDAPSortKey **keyList,
2095 struct berval *value ));
2098 ldap_create_sort_control LDAP_P((
2100 LDAPSortKey **keyList,
2102 LDAPControl **ctrlp ));
2105 ldap_parse_sortresponse_control LDAP_P((
2109 char **attribute ));
2112 * LDAP Virtual List View
2115 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2117 /* structure for virtual list */
2118 typedef struct ldapvlvinfo {
2119 ber_int_t ldvlv_version;
2120 ber_int_t ldvlv_before_count;
2121 ber_int_t ldvlv_after_count;
2122 ber_int_t ldvlv_offset;
2123 ber_int_t ldvlv_count;
2124 struct berval * ldvlv_attrvalue;
2125 struct berval * ldvlv_context;
2126 void * ldvlv_extradata;
2130 ldap_create_vlv_control_value LDAP_P((
2132 LDAPVLVInfo *ldvlistp,
2133 struct berval *value));
2136 ldap_create_vlv_control LDAP_P((
2138 LDAPVLVInfo *ldvlistp,
2139 LDAPControl **ctrlp ));
2142 ldap_parse_vlvresponse_control LDAP_P((
2145 ber_int_t *target_posp,
2146 ber_int_t *list_countp,
2147 struct berval **contextp,
2154 #define LDAP_API_FEATURE_WHOAMI 1000
2157 ldap_parse_whoami LDAP_P((
2160 struct berval **authzid ));
2163 ldap_whoami LDAP_P(( LDAP *ld,
2164 LDAPControl **sctrls,
2165 LDAPControl **cctrls,
2169 ldap_whoami_s LDAP_P((
2171 struct berval **authzid,
2172 LDAPControl **sctrls,
2173 LDAPControl **cctrls ));
2176 * LDAP Password Modify
2179 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2182 ldap_parse_passwd LDAP_P((
2185 struct berval *newpasswd ));
2188 ldap_passwd LDAP_P(( LDAP *ld,
2189 struct berval *user,
2190 struct berval *oldpw,
2191 struct berval *newpw,
2192 LDAPControl **sctrls,
2193 LDAPControl **cctrls,
2197 ldap_passwd_s LDAP_P((
2199 struct berval *user,
2200 struct berval *oldpw,
2201 struct berval *newpw,
2202 struct berval *newpasswd,
2203 LDAPControl **sctrls,
2204 LDAPControl **cctrls ));
2206 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2208 * LDAP Password Policy controls
2211 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2213 typedef enum passpolicyerror_enum {
2214 PP_passwordExpired = 0,
2215 PP_accountLocked = 1,
2216 PP_changeAfterReset = 2,
2217 PP_passwordModNotAllowed = 3,
2218 PP_mustSupplyOldPassword = 4,
2219 PP_insufficientPasswordQuality = 5,
2220 PP_passwordTooShort = 6,
2221 PP_passwordTooYoung = 7,
2222 PP_passwordInHistory = 8,
2224 } LDAPPasswordPolicyError;
2227 ldap_create_passwordpolicy_control LDAP_P((
2229 LDAPControl **ctrlp ));
2232 ldap_parse_passwordpolicy_control LDAP_P((
2237 LDAPPasswordPolicyError *errorp ));
2239 LDAP_F( const char * )
2240 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2241 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2244 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2247 #define LDAP_API_FEATURE_REFRESH 1000
2250 ldap_parse_refresh LDAP_P((
2253 ber_int_t *newttl ));
2256 ldap_refresh LDAP_P(( LDAP *ld,
2259 LDAPControl **sctrls,
2260 LDAPControl **cctrls,
2264 ldap_refresh_s LDAP_P((
2269 LDAPControl **sctrls,
2270 LDAPControl **cctrls ));
2277 ldap_txn_start LDAP_P(( LDAP *ld,
2278 LDAPControl **sctrls,
2279 LDAPControl **cctrls,
2283 ldap_txn_start_s LDAP_P(( LDAP *ld,
2284 LDAPControl **sctrl,
2285 LDAPControl **cctrl,
2286 struct berval **rettxnid ));
2289 ldap_txn_end LDAP_P(( LDAP *ld,
2291 struct berval *txnid,
2292 LDAPControl **sctrls,
2293 LDAPControl **cctrls,
2297 ldap_txn_end_s LDAP_P(( LDAP *ld,
2299 struct berval *txnid,
2300 LDAPControl **sctrl,
2301 LDAPControl **cctrl,
2310 * initialize the persistent search structure
2312 LDAP_F( ldap_sync_t * )
2313 ldap_sync_initialize LDAP_P((
2317 * destroy the persistent search structure
2320 ldap_sync_destroy LDAP_P((
2325 * initialize a refreshOnly sync
2328 ldap_sync_init LDAP_P((
2333 * initialize a refreshOnly sync
2336 ldap_sync_init_refresh_only LDAP_P((
2340 * initialize a refreshAndPersist sync
2343 ldap_sync_init_refresh_and_persist LDAP_P((
2347 * poll for new responses
2350 ldap_sync_poll LDAP_P((
2353 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2359 ldap_create_session_tracking_value LDAP_P((
2361 char *sessionSourceIp,
2362 char *sessionSourceName,
2364 struct berval *sessionTrackingIdentifier,
2365 struct berval *value ));
2368 ldap_create_session_tracking LDAP_P((
2370 char *sessionSourceIp,
2371 char *sessionSourceName,
2373 struct berval *sessionTrackingIdentifier,
2374 LDAPControl **ctrlp ));
2377 ldap_parse_session_tracking_control LDAP_P((
2381 struct berval *name,
2383 struct berval *id ));
2385 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2391 ldap_create_assertion_control_value LDAP_P((
2394 struct berval *value ));
2397 ldap_create_assertion_control LDAP_P((
2401 LDAPControl **ctrlp ));
2404 #endif /* _LDAP_H */