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"
291 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
292 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
294 /* LDAP Chaining Behavior Control *//* work in progress */
295 /* <draft-sermersheim-ldap-chaining>;
296 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
297 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
299 #define LDAP_CHAINING_PREFERRED 0
300 #define LDAP_CHAINING_REQUIRED 1
301 #define LDAP_REFERRALS_PREFERRED 2
302 #define LDAP_REFERRALS_REQUIRED 3
304 /* MS Active Directory controls (for compatibility) */
305 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
306 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
307 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
308 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
309 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
310 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
311 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
313 /* MS Active Directory controls - not implemented in slapd(8) */
314 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
317 /* <draft-wahl-ldap-session> */
318 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
319 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
320 LDAP_CONTROL_X_SESSION_TRACKING ".1"
321 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
322 LDAP_CONTROL_X_SESSION_TRACKING ".2"
323 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
324 LDAP_CONTROL_X_SESSION_TRACKING ".3"
325 #endif /* LDAP_DEVEL */
327 /* various expired works */
328 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
329 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
330 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
331 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
332 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
334 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
335 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
336 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
337 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
338 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
339 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
340 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
342 /* LDAP VLV *//* not implemented in slapd(8) */
343 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
344 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
347 /* LDAP Unsolicited Notifications */
348 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
349 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
351 /* LDAP Extended Operations */
352 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
354 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
355 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
356 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
357 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
358 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
360 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
361 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
363 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
364 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
365 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
366 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
368 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
369 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
371 /* various works in progress */
372 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
373 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
375 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
376 /* a work in progress */
377 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
378 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
379 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
380 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
381 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
382 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
383 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
384 LDAP_X_DISTPROC_BASE ".6"
385 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
386 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
387 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
388 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
389 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
392 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
393 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
394 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
395 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
396 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
400 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
401 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
402 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
403 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
404 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
405 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
406 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
408 /* LDAP Experimental (works in progress) Features */
409 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
410 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
411 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
414 * specific LDAP instantiations of BER types we know about
417 /* Overview of LBER tag construction
424 * 1 0 = CONTEXT-SPECIFIC
431 * | 5 ... 1 | TAG-NUMBER
435 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
436 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
438 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
439 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
441 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
442 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
444 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
446 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
447 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
448 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
449 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
451 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
452 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
454 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
456 /* LDAP Request Messages */
457 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
458 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
459 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
460 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
461 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
462 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
463 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
464 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
465 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
466 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
467 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
468 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
470 /* LDAP Response Messages */
471 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
472 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
473 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
474 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
475 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
476 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
477 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
478 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
479 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
480 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
481 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
482 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
483 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
485 #define LDAP_RES_ANY (-1)
486 #define LDAP_RES_UNSOLICITED (0)
490 #define LDAP_SASL_SIMPLE ((char*)0)
491 #define LDAP_SASL_NULL ("")
494 /* authentication methods available */
495 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
496 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
497 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
498 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
499 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
500 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
502 /* used by the Windows API but not used on the wire */
503 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
506 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
507 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
508 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
509 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
510 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
511 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
512 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
513 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
514 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
515 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
517 /* extended filter component types */
518 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
519 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
520 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
521 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
523 /* substring filter component types */
524 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
525 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
526 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
529 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
530 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
531 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
532 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
533 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
534 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
535 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
536 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
537 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
539 /* substring filter component types */
540 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
541 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
542 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
547 #define LDAP_SUCCESS 0x00
549 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
551 #define LDAP_OPERATIONS_ERROR 0x01
552 #define LDAP_PROTOCOL_ERROR 0x02
553 #define LDAP_TIMELIMIT_EXCEEDED 0x03
554 #define LDAP_SIZELIMIT_EXCEEDED 0x04
555 #define LDAP_COMPARE_FALSE 0x05
556 #define LDAP_COMPARE_TRUE 0x06
557 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
558 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
559 #define LDAP_STRONG_AUTH_REQUIRED 0x08
560 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
561 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
563 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
564 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
565 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
566 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
567 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
569 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
571 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
572 #define LDAP_UNDEFINED_TYPE 0x11
573 #define LDAP_INAPPROPRIATE_MATCHING 0x12
574 #define LDAP_CONSTRAINT_VIOLATION 0x13
575 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
576 #define LDAP_INVALID_SYNTAX 0x15
578 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
580 #define LDAP_NO_SUCH_OBJECT 0x20
581 #define LDAP_ALIAS_PROBLEM 0x21
582 #define LDAP_INVALID_DN_SYNTAX 0x22
583 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
584 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
586 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
588 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
589 #define LDAP_INAPPROPRIATE_AUTH 0x30
590 #define LDAP_INVALID_CREDENTIALS 0x31
591 #define LDAP_INSUFFICIENT_ACCESS 0x32
593 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
595 #define LDAP_BUSY 0x33
596 #define LDAP_UNAVAILABLE 0x34
597 #define LDAP_UNWILLING_TO_PERFORM 0x35
598 #define LDAP_LOOP_DETECT 0x36
600 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
602 #define LDAP_NAMING_VIOLATION 0x40
603 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
604 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
605 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
606 #define LDAP_ALREADY_EXISTS 0x44
607 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
608 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
609 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
611 #define LDAP_OTHER 0x50
613 /* LCUP operation codes (113-117) - not implemented */
614 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
615 #define LDAP_CUP_SECURITY_VIOLATION 0x72
616 #define LDAP_CUP_INVALID_DATA 0x73
617 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
618 #define LDAP_CUP_RELOAD_REQUIRED 0x75
620 /* Cancel operation codes (118-121) */
621 #define LDAP_CANCELLED 0x76
622 #define LDAP_NO_SUCH_OPERATION 0x77
623 #define LDAP_TOO_LATE 0x78
624 #define LDAP_CANNOT_CANCEL 0x79
626 /* Assertion control (122) */
627 #define LDAP_ASSERTION_FAILED 0x7A
629 /* Proxied Authorization Denied (123) */
630 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
632 /* Experimental result codes */
633 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
635 /* LDAP Sync (4096) */
636 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
639 /* Private Use result codes */
640 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
642 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
643 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
645 /* for the LDAP No-Op control */
646 #define LDAP_X_NO_OPERATION 0x410e
648 /* for the Chaining Behavior control (consecutive result codes requested;
649 * see <draft-sermersheim-ldap-chaining> ) */
650 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
651 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
652 #define LDAP_X_CANNOT_CHAIN 0x4111
655 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
656 #ifdef LDAP_X_DISTPROC_BASE
657 #define LDAP_X_INVALIDREFERENCE 0x4112
661 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
662 #define LDAP_X_TXN_ID_INVALID 0x4121
667 * Based on draft-ietf-ldap-c-api-xx
668 * but with new negative code values
670 #define LDAP_API_ERROR(n) ((n)<0)
671 #define LDAP_API_RESULT(n) ((n)<=0)
673 #define LDAP_SERVER_DOWN (-1)
674 #define LDAP_LOCAL_ERROR (-2)
675 #define LDAP_ENCODING_ERROR (-3)
676 #define LDAP_DECODING_ERROR (-4)
677 #define LDAP_TIMEOUT (-5)
678 #define LDAP_AUTH_UNKNOWN (-6)
679 #define LDAP_FILTER_ERROR (-7)
680 #define LDAP_USER_CANCELLED (-8)
681 #define LDAP_PARAM_ERROR (-9)
682 #define LDAP_NO_MEMORY (-10)
683 #define LDAP_CONNECT_ERROR (-11)
684 #define LDAP_NOT_SUPPORTED (-12)
685 #define LDAP_CONTROL_NOT_FOUND (-13)
686 #define LDAP_NO_RESULTS_RETURNED (-14)
687 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
688 #define LDAP_CLIENT_LOOP (-16)
689 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
690 #define LDAP_X_CONNECTING (-18)
694 * This structure represents both ldap messages and ldap responses.
695 * These are really the same, except in the case of search responses,
696 * where a response has multiple messages.
699 typedef struct ldapmsg LDAPMessage;
701 /* for modifications */
702 typedef struct ldapmod {
705 #define LDAP_MOD_OP (0x0007)
706 #define LDAP_MOD_ADD (0x0000)
707 #define LDAP_MOD_DELETE (0x0001)
708 #define LDAP_MOD_REPLACE (0x0002)
709 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
710 #define LDAP_MOD_BVALUES (0x0080)
711 /* IMPORTANT: do not use code 0x1000 (or above),
712 * it is used internally by the backends!
713 * (see ldap/servers/slapd/slap.h)
719 struct berval **modv_bvals;
721 #define mod_values mod_vals.modv_strvals
722 #define mod_bvalues mod_vals.modv_bvals
726 * structure representing an ldap session which can
727 * encompass connections to multiple servers (in the
728 * face of referrals).
730 typedef struct ldap LDAP;
732 #define LDAP_DEREF_NEVER 0x00
733 #define LDAP_DEREF_SEARCHING 0x01
734 #define LDAP_DEREF_FINDING 0x02
735 #define LDAP_DEREF_ALWAYS 0x03
737 #define LDAP_NO_LIMIT 0
739 /* how many messages to retrieve results for */
740 #define LDAP_MSG_ONE 0x00
741 #define LDAP_MSG_ALL 0x01
742 #define LDAP_MSG_RECEIVED 0x02
745 * types for ldap URL handling
747 typedef struct ldap_url_desc {
748 struct ldap_url_desc *lud_next;
760 #define LDAP_URL_SUCCESS 0x00 /* Success */
761 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
762 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
764 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
765 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
766 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
767 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
768 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
769 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
770 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
771 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
774 * LDAP sync (RFC4533) API
777 typedef struct ldap_sync_t ldap_sync_t;
780 /* these are private - the client should never see them */
781 LDAP_SYNC_CAPI_NONE = -1,
783 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
784 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
785 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
787 /* these are passed to ls_search_entry() */
788 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
789 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
790 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
791 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
793 /* these are passed to ls_intermediate() */
794 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
795 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
797 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
798 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
800 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
801 } ldap_sync_refresh_t;
804 * Called when an entry is returned by ldap_result().
805 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
806 * the entry has been either added or modified, and thus
807 * the complete view of the entry should be in the LDAPMessage.
808 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
809 * only the DN should be in the LDAPMessage.
811 typedef int (*ldap_sync_search_entry_f) LDAP_P((
814 struct berval *entryUUID,
815 ldap_sync_refresh_t phase ));
818 * Called when a reference is returned; the client should know
819 * what to do with it.
821 typedef int (*ldap_sync_search_reference_f) LDAP_P((
826 * Called when specific intermediate/final messages are returned.
827 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
828 * a "presents" or "deletes" phase begins.
829 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
830 * with refreshDone set to "TRUE" has been returned, to indicate
831 * that the refresh phase of a refreshAndPersist is complete.
832 * In the above cases, syncUUIDs is NULL.
834 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
835 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
836 * that are either present or have been deleted.
838 typedef int (*ldap_sync_intermediate_f) LDAP_P((
842 ldap_sync_refresh_t phase ));
845 * Called when a searchResultDone is returned. In refreshAndPersist,
846 * this can only occur if the search for any reason is being terminated
849 typedef int (*ldap_sync_search_result_f) LDAP_P((
852 int refreshDeletes ));
855 * This structure contains all information about the persistent search;
856 * the caller is responsible for connecting, setting version, binding, tls...
859 /* conf search params */
870 /* helpers - add as appropriate */
871 ldap_sync_search_entry_f ls_search_entry;
872 ldap_sync_search_reference_f ls_search_reference;
873 ldap_sync_intermediate_f ls_intermediate;
874 ldap_sync_search_result_f ls_search_result;
876 /* set by the caller as appropriate */
882 /* --- the parameters below are private - do not modify --- */
884 /* FIXME: make the structure opaque, and provide an interface
885 * to modify the public values? */
891 /* needed by refreshOnly */
894 /* opaque - need to pass between sessions, updated by the API */
895 struct berval ls_cookie;
897 /* state variable - do not modify */
898 ldap_sync_refresh_t ls_refreshPhase;
902 * End of LDAP sync (RFC4533) API
906 * Connection callbacks...
911 /* Called after a connection is established */
912 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
913 struct ldap_conncb *ctx ));
914 /* Called before a connection is closed */
915 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
917 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
918 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
920 typedef struct ldap_conncb {
921 ldap_conn_add_f *lc_add;
922 ldap_conn_del_f *lc_del;
927 * The API draft spec says we should declare (or cause to be declared)
928 * 'struct timeval'. We don't. See IETF LDAPext discussions.
936 ldap_get_option LDAP_P((
942 ldap_set_option LDAP_P((
945 LDAP_CONST void *invalue));
947 /* V3 REBIND Function Callback Prototype */
948 typedef int (LDAP_REBIND_PROC) LDAP_P((
949 LDAP *ld, LDAP_CONST char *url,
950 ber_tag_t request, ber_int_t msgid,
954 ldap_set_rebind_proc LDAP_P((
956 LDAP_REBIND_PROC *rebind_proc,
959 /* V3 referral selection Function Callback Prototype */
960 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
961 LDAP *ld, char ***refsp, int *cntp,
965 ldap_set_nextref_proc LDAP_P((
967 LDAP_NEXTREF_PROC *nextref_proc,
970 /* V3 URLLIST Function Callback Prototype */
971 typedef int (LDAP_URLLIST_PROC) LDAP_P((
973 LDAPURLDesc **urllist,
978 ldap_set_urllist_proc LDAP_P((
980 LDAP_URLLIST_PROC *urllist_proc,
988 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
989 LDAP_CONST char *requestOID,
992 LDAPControl **ctrlp ));
994 LDAP_F( LDAPControl * )
995 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
996 LDAP_CONST char *oid,
997 LDAPControl **ctrls ));
1001 ldap_control_create LDAP_P((
1002 LDAP_CONST char *requestOID,
1004 struct berval *value,
1006 LDAPControl **ctrlp ));
1008 LDAP_F( LDAPControl * )
1009 ldap_control_find LDAP_P((
1010 LDAP_CONST char *oid,
1011 LDAPControl **ctrls,
1012 LDAPControl ***nextctrlp ));
1015 ldap_control_free LDAP_P((
1016 LDAPControl *ctrl ));
1019 ldap_controls_free LDAP_P((
1020 LDAPControl **ctrls ));
1022 LDAP_F( LDAPControl ** )
1023 ldap_controls_dup LDAP_P((
1024 LDAPControl *LDAP_CONST *controls ));
1026 LDAP_F( LDAPControl * )
1027 ldap_control_dup LDAP_P((
1028 LDAP_CONST LDAPControl *c ));
1034 ldap_domain2dn LDAP_P((
1035 LDAP_CONST char* domain,
1039 ldap_dn2domain LDAP_P((
1040 LDAP_CONST char* dn,
1044 ldap_domain2hostlist LDAP_P((
1045 LDAP_CONST char *domain,
1052 ldap_extended_operation LDAP_P((
1054 LDAP_CONST char *reqoid,
1055 struct berval *reqdata,
1056 LDAPControl **serverctrls,
1057 LDAPControl **clientctrls,
1061 ldap_extended_operation_s LDAP_P((
1063 LDAP_CONST char *reqoid,
1064 struct berval *reqdata,
1065 LDAPControl **serverctrls,
1066 LDAPControl **clientctrls,
1068 struct berval **retdatap ));
1071 ldap_parse_extended_result LDAP_P((
1075 struct berval **retdatap,
1079 ldap_parse_intermediate LDAP_P((
1083 struct berval **retdatap,
1084 LDAPControl ***serverctrls,
1092 ldap_abandon_ext LDAP_P((
1095 LDAPControl **serverctrls,
1096 LDAPControl **clientctrls ));
1100 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1109 ldap_add_ext LDAP_P((
1111 LDAP_CONST char *dn,
1113 LDAPControl **serverctrls,
1114 LDAPControl **clientctrls,
1118 ldap_add_ext_s LDAP_P((
1120 LDAP_CONST char *dn,
1122 LDAPControl **serverctrls,
1123 LDAPControl **clientctrls ));
1127 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1129 LDAP_CONST char *dn,
1133 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1135 LDAP_CONST char *dn,
1144 ldap_sasl_bind LDAP_P((
1146 LDAP_CONST char *dn,
1147 LDAP_CONST char *mechanism,
1148 struct berval *cred,
1149 LDAPControl **serverctrls,
1150 LDAPControl **clientctrls,
1153 /* Interaction flags (should be passed about in a control)
1154 * Automatic (default): use defaults, prompt otherwise
1155 * Interactive: prompt always
1156 * Quiet: never prompt
1158 #define LDAP_SASL_AUTOMATIC 0U
1159 #define LDAP_SASL_INTERACTIVE 1U
1160 #define LDAP_SASL_QUIET 2U
1163 * V3 SASL Interaction Function Callback Prototype
1164 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1165 * should likely passed in a control (and provided controls)
1167 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1168 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1171 ldap_sasl_interactive_bind_s LDAP_P((
1173 LDAP_CONST char *dn, /* usually NULL */
1174 LDAP_CONST char *saslMechanism,
1175 LDAPControl **serverControls,
1176 LDAPControl **clientControls,
1178 /* should be client controls */
1180 LDAP_SASL_INTERACT_PROC *proc,
1184 ldap_sasl_bind_s LDAP_P((
1186 LDAP_CONST char *dn,
1187 LDAP_CONST char *mechanism,
1188 struct berval *cred,
1189 LDAPControl **serverctrls,
1190 LDAPControl **clientctrls,
1191 struct berval **servercredp ));
1194 ldap_parse_sasl_bind_result LDAP_P((
1197 struct berval **servercredp,
1206 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1208 LDAP_CONST char *who,
1209 LDAP_CONST char *passwd,
1213 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1215 LDAP_CONST char *who,
1216 LDAP_CONST char *cred,
1223 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1225 LDAP_CONST char *who,
1226 LDAP_CONST char *passwd ));
1229 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1231 LDAP_CONST char *who,
1232 LDAP_CONST char *passwd ));
1241 ldap_compare_ext LDAP_P((
1243 LDAP_CONST char *dn,
1244 LDAP_CONST char *attr,
1245 struct berval *bvalue,
1246 LDAPControl **serverctrls,
1247 LDAPControl **clientctrls,
1251 ldap_compare_ext_s LDAP_P((
1253 LDAP_CONST char *dn,
1254 LDAP_CONST char *attr,
1255 struct berval *bvalue,
1256 LDAPControl **serverctrls,
1257 LDAPControl **clientctrls ));
1261 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1263 LDAP_CONST char *dn,
1264 LDAP_CONST char *attr,
1265 LDAP_CONST char *value ));
1268 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1270 LDAP_CONST char *dn,
1271 LDAP_CONST char *attr,
1272 LDAP_CONST char *value ));
1280 ldap_delete_ext LDAP_P((
1282 LDAP_CONST char *dn,
1283 LDAPControl **serverctrls,
1284 LDAPControl **clientctrls,
1288 ldap_delete_ext_s LDAP_P((
1290 LDAP_CONST char *dn,
1291 LDAPControl **serverctrls,
1292 LDAPControl **clientctrls ));
1296 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1298 LDAP_CONST char *dn ));
1301 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1303 LDAP_CONST char *dn ));
1311 ldap_parse_result LDAP_P((
1318 LDAPControl ***serverctrls,
1322 ldap_err2string LDAP_P((
1327 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1333 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1335 LDAP_CONST char *s ));
1343 ldap_modify_ext LDAP_P((
1345 LDAP_CONST char *dn,
1347 LDAPControl **serverctrls,
1348 LDAPControl **clientctrls,
1352 ldap_modify_ext_s LDAP_P((
1354 LDAP_CONST char *dn,
1356 LDAPControl **serverctrls,
1357 LDAPControl **clientctrls ));
1361 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1363 LDAP_CONST char *dn,
1367 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1369 LDAP_CONST char *dn,
1378 ldap_rename LDAP_P((
1380 LDAP_CONST char *dn,
1381 LDAP_CONST char *newrdn,
1382 LDAP_CONST char *newSuperior,
1384 LDAPControl **sctrls,
1385 LDAPControl **cctrls,
1389 ldap_rename_s LDAP_P((
1391 LDAP_CONST char *dn,
1392 LDAP_CONST char *newrdn,
1393 LDAP_CONST char *newSuperior,
1395 LDAPControl **sctrls,
1396 LDAPControl **cctrls ));
1400 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1402 LDAP_CONST char *dn,
1403 LDAP_CONST char *newrdn,
1404 LDAP_CONST char *newSuperior,
1405 int deleteoldrdn ));
1408 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1410 LDAP_CONST char *dn,
1411 LDAP_CONST char *newrdn,
1412 LDAP_CONST char *newSuperior,
1413 int deleteoldrdn ));
1416 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1418 LDAP_CONST char *dn,
1419 LDAP_CONST char *newrdn ));
1422 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1424 LDAP_CONST char *dn,
1425 LDAP_CONST char *newrdn ));
1428 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1430 LDAP_CONST char *dn,
1431 LDAP_CONST char *newrdn,
1432 int deleteoldrdn ));
1435 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1437 LDAP_CONST char *dn,
1438 LDAP_CONST char *newrdn,
1448 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1449 LDAP_CONST char *host,
1453 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1454 LDAP_CONST char *host,
1459 ldap_create LDAP_P((
1463 ldap_initialize LDAP_P((
1465 LDAP_CONST char *url ));
1472 ldap_tls_inplace LDAP_P((
1476 ldap_start_tls LDAP_P((
1478 LDAPControl **serverctrls,
1479 LDAPControl **clientctrls,
1483 ldap_install_tls LDAP_P((
1487 ldap_start_tls_s LDAP_P((
1489 LDAPControl **serverctrls,
1490 LDAPControl **clientctrls ));
1495 LDAP_F( LDAPMessage * )
1496 ldap_first_message LDAP_P((
1498 LDAPMessage *chain ));
1500 LDAP_F( LDAPMessage * )
1501 ldap_next_message LDAP_P((
1503 LDAPMessage *msg ));
1506 ldap_count_messages LDAP_P((
1508 LDAPMessage *chain ));
1513 LDAP_F( LDAPMessage * )
1514 ldap_first_reference LDAP_P((
1516 LDAPMessage *chain ));
1518 LDAP_F( LDAPMessage * )
1519 ldap_next_reference LDAP_P((
1521 LDAPMessage *ref ));
1524 ldap_count_references LDAP_P((
1526 LDAPMessage *chain ));
1529 ldap_parse_reference LDAP_P((
1533 LDAPControl ***serverctrls,
1540 LDAP_F( LDAPMessage * )
1541 ldap_first_entry LDAP_P((
1543 LDAPMessage *chain ));
1545 LDAP_F( LDAPMessage * )
1546 ldap_next_entry LDAP_P((
1548 LDAPMessage *entry ));
1551 ldap_count_entries LDAP_P((
1553 LDAPMessage *chain ));
1556 ldap_get_entry_controls LDAP_P((
1559 LDAPControl ***serverctrls));
1565 LDAP_F( LDAPMessage * )
1566 ldap_delete_result_entry LDAP_P((
1571 ldap_add_result_entry LDAP_P((
1580 ldap_get_dn LDAP_P((
1582 LDAPMessage *entry ));
1584 typedef struct ldap_ava {
1585 struct berval la_attr;
1586 struct berval la_value;
1588 #define LDAP_AVA_NULL 0x0000U
1589 #define LDAP_AVA_STRING 0x0001U
1590 #define LDAP_AVA_BINARY 0x0002U
1591 #define LDAP_AVA_NONPRINTABLE 0x0004U
1592 #define LDAP_AVA_FREE_ATTR 0x0010U
1593 #define LDAP_AVA_FREE_VALUE 0x0020U
1598 typedef LDAPAVA** LDAPRDN;
1599 typedef LDAPRDN* LDAPDN;
1602 #define LDAP_DN_FORMAT_LDAP 0x0000U
1603 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1604 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1605 #define LDAP_DN_FORMAT_DCE 0x0030U
1606 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1607 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1608 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1609 #define LDAP_DN_FORMAT_MASK 0x00F0U
1612 #define LDAP_DN_PRETTY 0x0100U
1613 #define LDAP_DN_SKIP 0x0200U
1614 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1615 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1616 #define LDAP_DN_PEDANTIC 0xF000U
1618 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1619 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1628 ldap_str2dn LDAP_P((
1629 LDAP_CONST char *str,
1640 ldap_dn2str LDAP_P((
1646 ldap_bv2rdn LDAP_P((
1653 ldap_str2rdn LDAP_P((
1654 LDAP_CONST char *str,
1660 ldap_rdn2bv LDAP_P((
1666 ldap_rdn2str LDAP_P((
1672 ldap_dn_normalize LDAP_P((
1673 LDAP_CONST char *in, unsigned iflags,
1674 char **out, unsigned oflags ));
1677 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1678 LDAP_CONST char *dn ));
1681 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1682 LDAP_CONST char *dn,
1686 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1687 LDAP_CONST char *rdn,
1690 typedef int LDAPDN_rewrite_func
1691 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1694 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1695 LDAPDN_rewrite_func *func, unsigned flags ));
1698 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1699 LDAP_CONST char *dn ));
1702 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1703 LDAP_CONST char *dce ));
1706 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1707 LDAP_CONST char *dn ));
1710 ldap_get_dn_ber LDAP_P((
1711 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1714 ldap_get_attribute_ber LDAP_P((
1715 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1716 struct berval **vals ));
1722 ldap_first_attribute LDAP_P((
1725 BerElement **ber ));
1728 ldap_next_attribute LDAP_P((
1737 LDAP_F( struct berval ** )
1738 ldap_get_values_len LDAP_P((
1741 LDAP_CONST char *target ));
1744 ldap_count_values_len LDAP_P((
1745 struct berval **vals ));
1748 ldap_value_free_len LDAP_P((
1749 struct berval **vals ));
1753 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1756 LDAP_CONST char *target ));
1759 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1763 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1771 ldap_result LDAP_P((
1775 struct timeval *timeout,
1776 LDAPMessage **result ));
1779 ldap_msgtype LDAP_P((
1787 ldap_msgfree LDAP_P((
1791 ldap_msgdelete LDAP_P((
1800 ldap_bv2escaped_filter_value LDAP_P((
1802 struct berval *out ));
1805 ldap_search_ext LDAP_P((
1807 LDAP_CONST char *base,
1809 LDAP_CONST char *filter,
1812 LDAPControl **serverctrls,
1813 LDAPControl **clientctrls,
1814 struct timeval *timeout,
1819 ldap_search_ext_s LDAP_P((
1821 LDAP_CONST char *base,
1823 LDAP_CONST char *filter,
1826 LDAPControl **serverctrls,
1827 LDAPControl **clientctrls,
1828 struct timeval *timeout,
1830 LDAPMessage **res ));
1834 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1836 LDAP_CONST char *base,
1838 LDAP_CONST char *filter,
1843 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1845 LDAP_CONST char *base,
1847 LDAP_CONST char *filter,
1850 LDAPMessage **res ));
1853 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1855 LDAP_CONST char *base,
1857 LDAP_CONST char *filter,
1860 struct timeval *timeout,
1861 LDAPMessage **res ));
1868 ldap_unbind_ext LDAP_P((
1870 LDAPControl **serverctrls,
1871 LDAPControl **clientctrls));
1874 ldap_unbind_ext_s LDAP_P((
1876 LDAPControl **serverctrls,
1877 LDAPControl **clientctrls));
1881 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1885 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1893 ldap_put_vrFilter LDAP_P((
1902 ldap_memalloc LDAP_P((
1906 ldap_memrealloc LDAP_P((
1911 ldap_memcalloc LDAP_P((
1916 ldap_memfree LDAP_P((
1920 ldap_memvfree LDAP_P((
1924 ldap_strdup LDAP_P((
1925 LDAP_CONST char * ));
1928 ldap_mods_free LDAP_P((
1935 * in sort.c (deprecated, use custom code instead)
1937 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1938 LDAP_CONST char *left,
1939 LDAP_CONST char *right ));
1941 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1942 LDAP_CONST void *left,
1943 LDAP_CONST void *right ));
1945 LDAP_F( int ) /* deprecated */
1946 ldap_sort_entries LDAP_P(( LDAP *ld,
1947 LDAPMessage **chain,
1948 LDAP_CONST char *attr,
1949 LDAP_SORT_AD_CMP_PROC *cmp ));
1951 LDAP_F( int ) /* deprecated */
1952 ldap_sort_values LDAP_P((
1955 LDAP_SORT_AV_CMP_PROC *cmp ));
1957 LDAP_F( int ) /* deprecated */
1958 ldap_sort_strcasecmp LDAP_P((
1960 LDAP_CONST void *b ));
1967 ldap_is_ldap_url LDAP_P((
1968 LDAP_CONST char *url ));
1971 ldap_is_ldaps_url LDAP_P((
1972 LDAP_CONST char *url ));
1975 ldap_is_ldapi_url LDAP_P((
1976 LDAP_CONST char *url ));
1979 ldap_url_parse LDAP_P((
1980 LDAP_CONST char *url,
1981 LDAPURLDesc **ludpp ));
1984 ldap_url_desc2str LDAP_P((
1985 LDAPURLDesc *ludp ));
1988 ldap_free_urldesc LDAP_P((
1989 LDAPURLDesc *ludp ));
1993 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1996 #define LDAP_API_FEATURE_CANCEL 1000
1999 ldap_cancel LDAP_P(( LDAP *ld,
2001 LDAPControl **sctrls,
2002 LDAPControl **cctrls,
2006 ldap_cancel_s LDAP_P(( LDAP *ld,
2008 LDAPControl **sctrl,
2009 LDAPControl **cctrl ));
2012 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2015 #define LDAP_API_FEATURE_TURN 1000
2018 ldap_turn LDAP_P(( LDAP *ld,
2020 LDAP_CONST char* identifier,
2021 LDAPControl **sctrls,
2022 LDAPControl **cctrls,
2026 ldap_turn_s LDAP_P(( LDAP *ld,
2028 LDAP_CONST char* identifier,
2029 LDAPControl **sctrl,
2030 LDAPControl **cctrl ));
2033 * LDAP Paged Results
2036 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2039 ldap_create_page_control_value LDAP_P((
2042 struct berval *cookie,
2043 struct berval *value ));
2046 ldap_create_page_control LDAP_P((
2049 struct berval *cookie,
2051 LDAPControl **ctrlp ));
2055 ldap_parse_page_control LDAP_P((
2056 /* deprecated, use ldap_parse_pageresponse_control */
2058 LDAPControl **ctrls,
2060 struct berval **cookie ));
2064 ldap_parse_pageresponse_control LDAP_P((
2068 struct berval *cookie ));
2071 * LDAP Server Side Sort
2074 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2076 /* structure for a sort-key */
2077 typedef struct ldapsortkey {
2078 char *attributeType;
2084 ldap_create_sort_keylist LDAP_P((
2085 LDAPSortKey ***sortKeyList,
2089 ldap_free_sort_keylist LDAP_P((
2090 LDAPSortKey **sortkeylist ));
2093 ldap_create_sort_control_value LDAP_P((
2095 LDAPSortKey **keyList,
2096 struct berval *value ));
2099 ldap_create_sort_control LDAP_P((
2101 LDAPSortKey **keyList,
2103 LDAPControl **ctrlp ));
2106 ldap_parse_sortresponse_control LDAP_P((
2110 char **attribute ));
2113 * LDAP Virtual List View
2116 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2118 /* structure for virtual list */
2119 typedef struct ldapvlvinfo {
2120 ber_int_t ldvlv_version;
2121 ber_int_t ldvlv_before_count;
2122 ber_int_t ldvlv_after_count;
2123 ber_int_t ldvlv_offset;
2124 ber_int_t ldvlv_count;
2125 struct berval * ldvlv_attrvalue;
2126 struct berval * ldvlv_context;
2127 void * ldvlv_extradata;
2131 ldap_create_vlv_control_value LDAP_P((
2133 LDAPVLVInfo *ldvlistp,
2134 struct berval *value));
2137 ldap_create_vlv_control LDAP_P((
2139 LDAPVLVInfo *ldvlistp,
2140 LDAPControl **ctrlp ));
2143 ldap_parse_vlvresponse_control LDAP_P((
2146 ber_int_t *target_posp,
2147 ber_int_t *list_countp,
2148 struct berval **contextp,
2155 #define LDAP_API_FEATURE_WHOAMI 1000
2158 ldap_parse_whoami LDAP_P((
2161 struct berval **authzid ));
2164 ldap_whoami LDAP_P(( LDAP *ld,
2165 LDAPControl **sctrls,
2166 LDAPControl **cctrls,
2170 ldap_whoami_s LDAP_P((
2172 struct berval **authzid,
2173 LDAPControl **sctrls,
2174 LDAPControl **cctrls ));
2177 * LDAP Password Modify
2180 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2183 ldap_parse_passwd LDAP_P((
2186 struct berval *newpasswd ));
2189 ldap_passwd LDAP_P(( LDAP *ld,
2190 struct berval *user,
2191 struct berval *oldpw,
2192 struct berval *newpw,
2193 LDAPControl **sctrls,
2194 LDAPControl **cctrls,
2198 ldap_passwd_s LDAP_P((
2200 struct berval *user,
2201 struct berval *oldpw,
2202 struct berval *newpw,
2203 struct berval *newpasswd,
2204 LDAPControl **sctrls,
2205 LDAPControl **cctrls ));
2207 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2209 * LDAP Password Policy controls
2212 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2214 typedef enum passpolicyerror_enum {
2215 PP_passwordExpired = 0,
2216 PP_accountLocked = 1,
2217 PP_changeAfterReset = 2,
2218 PP_passwordModNotAllowed = 3,
2219 PP_mustSupplyOldPassword = 4,
2220 PP_insufficientPasswordQuality = 5,
2221 PP_passwordTooShort = 6,
2222 PP_passwordTooYoung = 7,
2223 PP_passwordInHistory = 8,
2225 } LDAPPasswordPolicyError;
2228 ldap_create_passwordpolicy_control LDAP_P((
2230 LDAPControl **ctrlp ));
2233 ldap_parse_passwordpolicy_control LDAP_P((
2238 LDAPPasswordPolicyError *errorp ));
2240 LDAP_F( const char * )
2241 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2242 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2245 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2248 #define LDAP_API_FEATURE_REFRESH 1000
2251 ldap_parse_refresh LDAP_P((
2254 ber_int_t *newttl ));
2257 ldap_refresh LDAP_P(( LDAP *ld,
2260 LDAPControl **sctrls,
2261 LDAPControl **cctrls,
2265 ldap_refresh_s LDAP_P((
2270 LDAPControl **sctrls,
2271 LDAPControl **cctrls ));
2278 ldap_txn_start LDAP_P(( LDAP *ld,
2279 LDAPControl **sctrls,
2280 LDAPControl **cctrls,
2284 ldap_txn_start_s LDAP_P(( LDAP *ld,
2285 LDAPControl **sctrl,
2286 LDAPControl **cctrl,
2287 struct berval **rettxnid ));
2290 ldap_txn_end LDAP_P(( LDAP *ld,
2292 struct berval *txnid,
2293 LDAPControl **sctrls,
2294 LDAPControl **cctrls,
2298 ldap_txn_end_s LDAP_P(( LDAP *ld,
2300 struct berval *txnid,
2301 LDAPControl **sctrl,
2302 LDAPControl **cctrl,
2311 * initialize the persistent search structure
2313 LDAP_F( ldap_sync_t * )
2314 ldap_sync_initialize LDAP_P((
2318 * destroy the persistent search structure
2321 ldap_sync_destroy LDAP_P((
2326 * initialize a refreshOnly sync
2329 ldap_sync_init LDAP_P((
2334 * initialize a refreshOnly sync
2337 ldap_sync_init_refresh_only LDAP_P((
2341 * initialize a refreshAndPersist sync
2344 ldap_sync_init_refresh_and_persist LDAP_P((
2348 * poll for new responses
2351 ldap_sync_poll LDAP_P((
2354 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2360 ldap_create_session_tracking_value LDAP_P((
2362 char *sessionSourceIp,
2363 char *sessionSourceName,
2365 struct berval *sessionTrackingIdentifier,
2366 struct berval *value ));
2369 ldap_create_session_tracking LDAP_P((
2371 char *sessionSourceIp,
2372 char *sessionSourceName,
2374 struct berval *sessionTrackingIdentifier,
2375 LDAPControl **ctrlp ));
2378 ldap_parse_session_tracking_control LDAP_P((
2382 struct berval *name,
2384 struct berval *id ));
2386 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2392 ldap_create_assertion_control_value LDAP_P((
2395 struct berval *value ));
2398 ldap_create_assertion_control LDAP_P((
2402 LDAPControl **ctrlp ));
2408 typedef struct LDAPDerefSpec {
2413 typedef struct LDAPDerefVal {
2416 struct LDAPDerefVal *next;
2419 typedef struct LDAPDerefRes {
2421 struct berval derefVal;
2422 LDAPDerefVal *attrVals;
2423 struct LDAPDerefRes *next;
2427 ldap_create_deref_control_value LDAP_P((
2430 struct berval *value ));
2433 ldap_create_deref_control LDAP_P((
2437 LDAPControl **ctrlp ));
2440 ldap_derefresponse_free LDAP_P((
2441 LDAPDerefRes *dr ));
2444 ldap_parse_derefresponse_control LDAP_P((
2447 LDAPDerefRes **drp ));
2450 ldap_parse_deref_control LDAP_P((
2452 LDAPControl **ctrls,
2453 LDAPDerefRes **drp ));
2456 #endif /* _LDAP_H */