2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2010 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_MIN 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 /* for LDAP_OPT_X_TLS_PROTOCOL_MIN */
169 #define LDAP_OPT_X_TLS_PROTOCOL(maj,min) (((maj) << 8) + (min))
170 #define LDAP_OPT_X_TLS_PROTOCOL_SSL2 (2 << 8)
171 #define LDAP_OPT_X_TLS_PROTOCOL_SSL3 (3 << 8)
172 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_0 ((3 << 8) + 1)
173 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_1 ((3 << 8) + 2)
174 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_2 ((3 << 8) + 3)
176 /* OpenLDAP SASL options */
177 #define LDAP_OPT_X_SASL_MECH 0x6100
178 #define LDAP_OPT_X_SASL_REALM 0x6101
179 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
180 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
181 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
182 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
183 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
184 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
185 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
186 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
187 #define LDAP_OPT_X_SASL_MECHLIST 0x610a /* read-only */
188 #define LDAP_OPT_X_SASL_NOCANON 0x610b
189 #define LDAP_OPT_X_SASL_USERNAME 0x610c /* read-only */
190 #define LDAP_OPT_X_SASL_GSS_CREDS 0x610d
192 /* OpenLDAP GSSAPI options */
193 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT 0x6200
194 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL 0x6201
197 * OpenLDAP per connection tcp-keepalive settings
198 * (Linux only, ignored where unsupported)
200 #define LDAP_OPT_X_KEEPALIVE_IDLE 0x6300
201 #define LDAP_OPT_X_KEEPALIVE_PROBES 0x6301
202 #define LDAP_OPT_X_KEEPALIVE_INTERVAL 0x6302
204 /* Private API Extensions -- reserved for application use */
205 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
208 * ldap_get_option() and ldap_set_option() return values.
209 * As later versions may return other values indicating
210 * failure, current applications should only compare returned
211 * value against LDAP_OPT_SUCCESS.
213 #define LDAP_OPT_SUCCESS 0
214 #define LDAP_OPT_ERROR (-1)
216 /* option on/off values */
217 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
218 #define LDAP_OPT_OFF ((void *) 0)
220 typedef struct ldapapiinfo {
221 int ldapai_info_version; /* version of LDAPAPIInfo */
222 #define LDAP_API_INFO_VERSION (1)
223 int ldapai_api_version; /* revision of API supported */
224 int ldapai_protocol_version; /* highest LDAP version supported */
225 char **ldapai_extensions; /* names of API extensions */
226 char *ldapai_vendor_name; /* name of supplier */
227 int ldapai_vendor_version; /* supplier-specific version * 100 */
230 typedef struct ldap_apifeature_info {
231 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
232 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
233 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
234 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
235 } LDAPAPIFeatureInfo;
238 * LDAP Control structure
240 typedef struct ldapcontrol {
241 char * ldctl_oid; /* numericoid of control */
242 struct berval ldctl_value; /* encoded value of control */
243 char ldctl_iscritical; /* criticality */
247 /* standard track controls */
248 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
249 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
250 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
252 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
254 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
255 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
256 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
258 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
259 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
261 /* non-standard track controls */
262 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
264 /* LDAP Content Synchronization Operation -- RFC 4533 */
265 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
266 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
267 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
268 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
269 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
271 #define LDAP_SYNC_NONE 0x00
272 #define LDAP_SYNC_REFRESH_ONLY 0x01
273 #define LDAP_SYNC_RESERVED 0x02
274 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
276 #define LDAP_SYNC_REFRESH_PRESENTS 0
277 #define LDAP_SYNC_REFRESH_DELETES 1
279 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
280 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
281 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
282 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
284 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
285 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
286 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
287 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
289 #define LDAP_SYNC_PRESENT 0
290 #define LDAP_SYNC_ADD 1
291 #define LDAP_SYNC_MODIFY 2
292 #define LDAP_SYNC_DELETE 3
293 #define LDAP_SYNC_NEW_COOKIE 4
296 /* Password policy Controls *//* work in progress */
297 /* ITS#3458: released; disabled by default */
298 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
299 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
301 /* various works in progress */
302 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
303 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
304 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
305 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
306 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
307 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
308 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
309 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
310 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
312 /* LDAP Chaining Behavior Control *//* work in progress */
313 /* <draft-sermersheim-ldap-chaining>;
314 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
315 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
317 #define LDAP_CHAINING_PREFERRED 0
318 #define LDAP_CHAINING_REQUIRED 1
319 #define LDAP_REFERRALS_PREFERRED 2
320 #define LDAP_REFERRALS_REQUIRED 3
322 /* MS Active Directory controls (for compatibility) */
323 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
324 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
325 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
326 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
327 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
328 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
329 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
331 /* MS Active Directory controls - not implemented in slapd(8) */
332 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
335 /* <draft-wahl-ldap-session> */
336 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
337 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
338 LDAP_CONTROL_X_SESSION_TRACKING ".1"
339 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
340 LDAP_CONTROL_X_SESSION_TRACKING ".2"
341 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
342 LDAP_CONTROL_X_SESSION_TRACKING ".3"
343 #endif /* LDAP_DEVEL */
345 /* various expired works */
346 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
347 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
348 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
349 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
350 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
352 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
353 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
354 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
355 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
356 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
357 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
358 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
361 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
362 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
364 /* LDAP Unsolicited Notifications */
365 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
366 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
368 /* LDAP Extended Operations */
369 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
371 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
372 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
373 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
374 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
375 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
377 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
378 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
380 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
381 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
382 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
383 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
385 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
386 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
388 /* various works in progress */
389 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
390 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
392 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
393 /* a work in progress */
394 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
395 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
396 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
397 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
398 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
399 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
400 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
401 LDAP_X_DISTPROC_BASE ".6"
402 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
403 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
404 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
405 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
406 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
409 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
410 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
411 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
412 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
413 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
417 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
418 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
419 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
420 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
421 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
422 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
423 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
425 /* LDAP Experimental (works in progress) Features */
426 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
427 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
428 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
431 * specific LDAP instantiations of BER types we know about
434 /* Overview of LBER tag construction
441 * 1 0 = CONTEXT-SPECIFIC
448 * | 5 ... 1 | TAG-NUMBER
452 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
453 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
455 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
456 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
458 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
459 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
461 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
463 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
464 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
465 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
466 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
468 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
469 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
471 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
473 /* LDAP Request Messages */
474 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
475 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
476 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
477 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
478 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
479 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
480 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
481 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
482 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
483 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
484 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
485 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
487 /* LDAP Response Messages */
488 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
489 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
490 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
491 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
492 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
493 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
494 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
495 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
496 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
497 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
498 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
499 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
500 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
502 #define LDAP_RES_ANY (-1)
503 #define LDAP_RES_UNSOLICITED (0)
507 #define LDAP_SASL_SIMPLE ((char*)0)
508 #define LDAP_SASL_NULL ("")
511 /* authentication methods available */
512 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
513 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
514 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
515 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
516 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
517 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
519 /* used by the Windows API but not used on the wire */
520 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
523 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
524 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
525 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
526 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
527 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
528 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
529 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
530 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
531 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
532 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
534 /* extended filter component types */
535 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
536 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
537 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
538 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
540 /* substring filter component types */
541 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
542 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
543 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
546 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
547 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
548 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
549 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
550 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
551 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
552 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
553 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
554 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
556 /* substring filter component types */
557 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
558 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
559 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
564 #define LDAP_SUCCESS 0x00
566 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
568 #define LDAP_OPERATIONS_ERROR 0x01
569 #define LDAP_PROTOCOL_ERROR 0x02
570 #define LDAP_TIMELIMIT_EXCEEDED 0x03
571 #define LDAP_SIZELIMIT_EXCEEDED 0x04
572 #define LDAP_COMPARE_FALSE 0x05
573 #define LDAP_COMPARE_TRUE 0x06
574 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
575 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
576 #define LDAP_STRONG_AUTH_REQUIRED 0x08
577 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
578 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
580 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
581 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
582 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
583 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
584 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
586 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
588 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
589 #define LDAP_UNDEFINED_TYPE 0x11
590 #define LDAP_INAPPROPRIATE_MATCHING 0x12
591 #define LDAP_CONSTRAINT_VIOLATION 0x13
592 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
593 #define LDAP_INVALID_SYNTAX 0x15
595 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
597 #define LDAP_NO_SUCH_OBJECT 0x20
598 #define LDAP_ALIAS_PROBLEM 0x21
599 #define LDAP_INVALID_DN_SYNTAX 0x22
600 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
601 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
603 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
605 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
606 #define LDAP_INAPPROPRIATE_AUTH 0x30
607 #define LDAP_INVALID_CREDENTIALS 0x31
608 #define LDAP_INSUFFICIENT_ACCESS 0x32
610 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
612 #define LDAP_BUSY 0x33
613 #define LDAP_UNAVAILABLE 0x34
614 #define LDAP_UNWILLING_TO_PERFORM 0x35
615 #define LDAP_LOOP_DETECT 0x36
617 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
619 #define LDAP_NAMING_VIOLATION 0x40
620 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
621 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
622 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
623 #define LDAP_ALREADY_EXISTS 0x44
624 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
625 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
626 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
628 #define LDAP_VLV_ERROR 0x4C
630 #define LDAP_OTHER 0x50
632 /* LCUP operation codes (113-117) - not implemented */
633 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
634 #define LDAP_CUP_SECURITY_VIOLATION 0x72
635 #define LDAP_CUP_INVALID_DATA 0x73
636 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
637 #define LDAP_CUP_RELOAD_REQUIRED 0x75
639 /* Cancel operation codes (118-121) */
640 #define LDAP_CANCELLED 0x76
641 #define LDAP_NO_SUCH_OPERATION 0x77
642 #define LDAP_TOO_LATE 0x78
643 #define LDAP_CANNOT_CANCEL 0x79
645 /* Assertion control (122) */
646 #define LDAP_ASSERTION_FAILED 0x7A
648 /* Proxied Authorization Denied (123) */
649 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
651 /* Experimental result codes */
652 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
654 /* LDAP Sync (4096) */
655 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
658 /* Private Use result codes */
659 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
661 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
662 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
664 /* for the LDAP No-Op control */
665 #define LDAP_X_NO_OPERATION 0x410e
667 /* for the Chaining Behavior control (consecutive result codes requested;
668 * see <draft-sermersheim-ldap-chaining> ) */
669 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
670 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
671 #define LDAP_X_CANNOT_CHAIN 0x4111
674 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
675 #ifdef LDAP_X_DISTPROC_BASE
676 #define LDAP_X_INVALIDREFERENCE 0x4112
680 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
681 #define LDAP_X_TXN_ID_INVALID 0x4121
686 * Based on draft-ietf-ldap-c-api-xx
687 * but with new negative code values
689 #define LDAP_API_ERROR(n) ((n)<0)
690 #define LDAP_API_RESULT(n) ((n)<=0)
692 #define LDAP_SERVER_DOWN (-1)
693 #define LDAP_LOCAL_ERROR (-2)
694 #define LDAP_ENCODING_ERROR (-3)
695 #define LDAP_DECODING_ERROR (-4)
696 #define LDAP_TIMEOUT (-5)
697 #define LDAP_AUTH_UNKNOWN (-6)
698 #define LDAP_FILTER_ERROR (-7)
699 #define LDAP_USER_CANCELLED (-8)
700 #define LDAP_PARAM_ERROR (-9)
701 #define LDAP_NO_MEMORY (-10)
702 #define LDAP_CONNECT_ERROR (-11)
703 #define LDAP_NOT_SUPPORTED (-12)
704 #define LDAP_CONTROL_NOT_FOUND (-13)
705 #define LDAP_NO_RESULTS_RETURNED (-14)
706 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
707 #define LDAP_CLIENT_LOOP (-16)
708 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
709 #define LDAP_X_CONNECTING (-18)
713 * This structure represents both ldap messages and ldap responses.
714 * These are really the same, except in the case of search responses,
715 * where a response has multiple messages.
718 typedef struct ldapmsg LDAPMessage;
720 /* for modifications */
721 typedef struct ldapmod {
724 #define LDAP_MOD_OP (0x0007)
725 #define LDAP_MOD_ADD (0x0000)
726 #define LDAP_MOD_DELETE (0x0001)
727 #define LDAP_MOD_REPLACE (0x0002)
728 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
729 #define LDAP_MOD_BVALUES (0x0080)
730 /* IMPORTANT: do not use code 0x1000 (or above),
731 * it is used internally by the backends!
732 * (see ldap/servers/slapd/slap.h)
738 struct berval **modv_bvals;
740 #define mod_values mod_vals.modv_strvals
741 #define mod_bvalues mod_vals.modv_bvals
745 * structure representing an ldap session which can
746 * encompass connections to multiple servers (in the
747 * face of referrals).
749 typedef struct ldap LDAP;
751 #define LDAP_DEREF_NEVER 0x00
752 #define LDAP_DEREF_SEARCHING 0x01
753 #define LDAP_DEREF_FINDING 0x02
754 #define LDAP_DEREF_ALWAYS 0x03
756 #define LDAP_NO_LIMIT 0
758 /* how many messages to retrieve results for */
759 #define LDAP_MSG_ONE 0x00
760 #define LDAP_MSG_ALL 0x01
761 #define LDAP_MSG_RECEIVED 0x02
764 * types for ldap URL handling
766 typedef struct ldap_url_desc {
767 struct ldap_url_desc *lud_next;
779 #define LDAP_URL_SUCCESS 0x00 /* Success */
780 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
781 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
783 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
784 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
785 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
786 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
787 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
788 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
789 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
790 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
793 * LDAP sync (RFC4533) API
796 typedef struct ldap_sync_t ldap_sync_t;
799 /* these are private - the client should never see them */
800 LDAP_SYNC_CAPI_NONE = -1,
802 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
803 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
804 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
806 /* these are passed to ls_search_entry() */
807 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
808 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
809 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
810 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
812 /* these are passed to ls_intermediate() */
813 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
814 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
816 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
817 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
819 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
820 } ldap_sync_refresh_t;
823 * Called when an entry is returned by ldap_result().
824 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
825 * the entry has been either added or modified, and thus
826 * the complete view of the entry should be in the LDAPMessage.
827 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
828 * only the DN should be in the LDAPMessage.
830 typedef int (*ldap_sync_search_entry_f) LDAP_P((
833 struct berval *entryUUID,
834 ldap_sync_refresh_t phase ));
837 * Called when a reference is returned; the client should know
838 * what to do with it.
840 typedef int (*ldap_sync_search_reference_f) LDAP_P((
845 * Called when specific intermediate/final messages are returned.
846 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
847 * a "presents" or "deletes" phase begins.
848 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
849 * with refreshDone set to "TRUE" has been returned, to indicate
850 * that the refresh phase of a refreshAndPersist is complete.
851 * In the above cases, syncUUIDs is NULL.
853 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
854 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
855 * that are either present or have been deleted.
857 typedef int (*ldap_sync_intermediate_f) LDAP_P((
861 ldap_sync_refresh_t phase ));
864 * Called when a searchResultDone is returned. In refreshAndPersist,
865 * this can only occur if the search for any reason is being terminated
868 typedef int (*ldap_sync_search_result_f) LDAP_P((
871 int refreshDeletes ));
874 * This structure contains all information about the persistent search;
875 * the caller is responsible for connecting, setting version, binding, tls...
878 /* conf search params */
889 /* helpers - add as appropriate */
890 ldap_sync_search_entry_f ls_search_entry;
891 ldap_sync_search_reference_f ls_search_reference;
892 ldap_sync_intermediate_f ls_intermediate;
893 ldap_sync_search_result_f ls_search_result;
895 /* set by the caller as appropriate */
901 /* --- the parameters below are private - do not modify --- */
903 /* FIXME: make the structure opaque, and provide an interface
904 * to modify the public values? */
910 /* needed by refreshOnly */
913 /* opaque - need to pass between sessions, updated by the API */
914 struct berval ls_cookie;
916 /* state variable - do not modify */
917 ldap_sync_refresh_t ls_refreshPhase;
921 * End of LDAP sync (RFC4533) API
925 * Connection callbacks...
930 /* Called after a connection is established */
931 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
932 struct ldap_conncb *ctx ));
933 /* Called before a connection is closed */
934 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
936 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
937 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
939 typedef struct ldap_conncb {
940 ldap_conn_add_f *lc_add;
941 ldap_conn_del_f *lc_del;
946 * The API draft spec says we should declare (or cause to be declared)
947 * 'struct timeval'. We don't. See IETF LDAPext discussions.
955 ldap_get_option LDAP_P((
961 ldap_set_option LDAP_P((
964 LDAP_CONST void *invalue));
966 /* V3 REBIND Function Callback Prototype */
967 typedef int (LDAP_REBIND_PROC) LDAP_P((
968 LDAP *ld, LDAP_CONST char *url,
969 ber_tag_t request, ber_int_t msgid,
973 ldap_set_rebind_proc LDAP_P((
975 LDAP_REBIND_PROC *rebind_proc,
978 /* V3 referral selection Function Callback Prototype */
979 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
980 LDAP *ld, char ***refsp, int *cntp,
984 ldap_set_nextref_proc LDAP_P((
986 LDAP_NEXTREF_PROC *nextref_proc,
989 /* V3 URLLIST Function Callback Prototype */
990 typedef int (LDAP_URLLIST_PROC) LDAP_P((
992 LDAPURLDesc **urllist,
997 ldap_set_urllist_proc LDAP_P((
999 LDAP_URLLIST_PROC *urllist_proc,
1007 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
1008 LDAP_CONST char *requestOID,
1011 LDAPControl **ctrlp ));
1013 LDAP_F( LDAPControl * )
1014 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
1015 LDAP_CONST char *oid,
1016 LDAPControl **ctrls ));
1020 ldap_control_create LDAP_P((
1021 LDAP_CONST char *requestOID,
1023 struct berval *value,
1025 LDAPControl **ctrlp ));
1027 LDAP_F( LDAPControl * )
1028 ldap_control_find LDAP_P((
1029 LDAP_CONST char *oid,
1030 LDAPControl **ctrls,
1031 LDAPControl ***nextctrlp ));
1034 ldap_control_free LDAP_P((
1035 LDAPControl *ctrl ));
1038 ldap_controls_free LDAP_P((
1039 LDAPControl **ctrls ));
1041 LDAP_F( LDAPControl ** )
1042 ldap_controls_dup LDAP_P((
1043 LDAPControl *LDAP_CONST *controls ));
1045 LDAP_F( LDAPControl * )
1046 ldap_control_dup LDAP_P((
1047 LDAP_CONST LDAPControl *c ));
1053 ldap_domain2dn LDAP_P((
1054 LDAP_CONST char* domain,
1058 ldap_dn2domain LDAP_P((
1059 LDAP_CONST char* dn,
1063 ldap_domain2hostlist LDAP_P((
1064 LDAP_CONST char *domain,
1071 ldap_extended_operation LDAP_P((
1073 LDAP_CONST char *reqoid,
1074 struct berval *reqdata,
1075 LDAPControl **serverctrls,
1076 LDAPControl **clientctrls,
1080 ldap_extended_operation_s LDAP_P((
1082 LDAP_CONST char *reqoid,
1083 struct berval *reqdata,
1084 LDAPControl **serverctrls,
1085 LDAPControl **clientctrls,
1087 struct berval **retdatap ));
1090 ldap_parse_extended_result LDAP_P((
1094 struct berval **retdatap,
1098 ldap_parse_intermediate LDAP_P((
1102 struct berval **retdatap,
1103 LDAPControl ***serverctrls,
1111 ldap_abandon_ext LDAP_P((
1114 LDAPControl **serverctrls,
1115 LDAPControl **clientctrls ));
1119 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1128 ldap_add_ext LDAP_P((
1130 LDAP_CONST char *dn,
1132 LDAPControl **serverctrls,
1133 LDAPControl **clientctrls,
1137 ldap_add_ext_s LDAP_P((
1139 LDAP_CONST char *dn,
1141 LDAPControl **serverctrls,
1142 LDAPControl **clientctrls ));
1146 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1148 LDAP_CONST char *dn,
1152 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1154 LDAP_CONST char *dn,
1163 ldap_sasl_bind LDAP_P((
1165 LDAP_CONST char *dn,
1166 LDAP_CONST char *mechanism,
1167 struct berval *cred,
1168 LDAPControl **serverctrls,
1169 LDAPControl **clientctrls,
1172 /* Interaction flags (should be passed about in a control)
1173 * Automatic (default): use defaults, prompt otherwise
1174 * Interactive: prompt always
1175 * Quiet: never prompt
1177 #define LDAP_SASL_AUTOMATIC 0U
1178 #define LDAP_SASL_INTERACTIVE 1U
1179 #define LDAP_SASL_QUIET 2U
1182 * V3 SASL Interaction Function Callback Prototype
1183 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1184 * should likely passed in a control (and provided controls)
1186 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1187 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1190 ldap_sasl_interactive_bind LDAP_P((
1192 LDAP_CONST char *dn, /* usually NULL */
1193 LDAP_CONST char *saslMechanism,
1194 LDAPControl **serverControls,
1195 LDAPControl **clientControls,
1197 /* should be client controls */
1199 LDAP_SASL_INTERACT_PROC *proc,
1202 /* as obtained from ldap_result() */
1203 LDAPMessage *result,
1205 /* returned during bind processing */
1210 ldap_sasl_interactive_bind_s LDAP_P((
1212 LDAP_CONST char *dn, /* usually NULL */
1213 LDAP_CONST char *saslMechanism,
1214 LDAPControl **serverControls,
1215 LDAPControl **clientControls,
1217 /* should be client controls */
1219 LDAP_SASL_INTERACT_PROC *proc,
1223 ldap_sasl_bind_s LDAP_P((
1225 LDAP_CONST char *dn,
1226 LDAP_CONST char *mechanism,
1227 struct berval *cred,
1228 LDAPControl **serverctrls,
1229 LDAPControl **clientctrls,
1230 struct berval **servercredp ));
1233 ldap_parse_sasl_bind_result LDAP_P((
1236 struct berval **servercredp,
1245 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1247 LDAP_CONST char *who,
1248 LDAP_CONST char *passwd,
1252 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1254 LDAP_CONST char *who,
1255 LDAP_CONST char *cred,
1262 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1264 LDAP_CONST char *who,
1265 LDAP_CONST char *passwd ));
1268 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1270 LDAP_CONST char *who,
1271 LDAP_CONST char *passwd ));
1280 ldap_compare_ext LDAP_P((
1282 LDAP_CONST char *dn,
1283 LDAP_CONST char *attr,
1284 struct berval *bvalue,
1285 LDAPControl **serverctrls,
1286 LDAPControl **clientctrls,
1290 ldap_compare_ext_s LDAP_P((
1292 LDAP_CONST char *dn,
1293 LDAP_CONST char *attr,
1294 struct berval *bvalue,
1295 LDAPControl **serverctrls,
1296 LDAPControl **clientctrls ));
1300 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1302 LDAP_CONST char *dn,
1303 LDAP_CONST char *attr,
1304 LDAP_CONST char *value ));
1307 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1309 LDAP_CONST char *dn,
1310 LDAP_CONST char *attr,
1311 LDAP_CONST char *value ));
1319 ldap_delete_ext LDAP_P((
1321 LDAP_CONST char *dn,
1322 LDAPControl **serverctrls,
1323 LDAPControl **clientctrls,
1327 ldap_delete_ext_s LDAP_P((
1329 LDAP_CONST char *dn,
1330 LDAPControl **serverctrls,
1331 LDAPControl **clientctrls ));
1335 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1337 LDAP_CONST char *dn ));
1340 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1342 LDAP_CONST char *dn ));
1350 ldap_parse_result LDAP_P((
1357 LDAPControl ***serverctrls,
1361 ldap_err2string LDAP_P((
1366 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1372 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1374 LDAP_CONST char *s ));
1382 ldap_gssapi_bind LDAP_P((
1384 LDAP_CONST char *dn,
1385 LDAP_CONST char *creds ));
1388 ldap_gssapi_bind_s LDAP_P((
1390 LDAP_CONST char *dn,
1391 LDAP_CONST char *creds ));
1398 ldap_modify_ext LDAP_P((
1400 LDAP_CONST char *dn,
1402 LDAPControl **serverctrls,
1403 LDAPControl **clientctrls,
1407 ldap_modify_ext_s LDAP_P((
1409 LDAP_CONST char *dn,
1411 LDAPControl **serverctrls,
1412 LDAPControl **clientctrls ));
1416 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1418 LDAP_CONST char *dn,
1422 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1424 LDAP_CONST char *dn,
1433 ldap_rename LDAP_P((
1435 LDAP_CONST char *dn,
1436 LDAP_CONST char *newrdn,
1437 LDAP_CONST char *newSuperior,
1439 LDAPControl **sctrls,
1440 LDAPControl **cctrls,
1444 ldap_rename_s LDAP_P((
1446 LDAP_CONST char *dn,
1447 LDAP_CONST char *newrdn,
1448 LDAP_CONST char *newSuperior,
1450 LDAPControl **sctrls,
1451 LDAPControl **cctrls ));
1455 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1457 LDAP_CONST char *dn,
1458 LDAP_CONST char *newrdn,
1459 LDAP_CONST char *newSuperior,
1460 int deleteoldrdn ));
1463 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1465 LDAP_CONST char *dn,
1466 LDAP_CONST char *newrdn,
1467 LDAP_CONST char *newSuperior,
1468 int deleteoldrdn ));
1471 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1473 LDAP_CONST char *dn,
1474 LDAP_CONST char *newrdn ));
1477 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1479 LDAP_CONST char *dn,
1480 LDAP_CONST char *newrdn ));
1483 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1485 LDAP_CONST char *dn,
1486 LDAP_CONST char *newrdn,
1487 int deleteoldrdn ));
1490 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1492 LDAP_CONST char *dn,
1493 LDAP_CONST char *newrdn,
1503 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1504 LDAP_CONST char *host,
1508 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1509 LDAP_CONST char *host,
1514 ldap_create LDAP_P((
1518 ldap_initialize LDAP_P((
1520 LDAP_CONST char *url ));
1527 ldap_tls_inplace LDAP_P((
1531 ldap_start_tls LDAP_P((
1533 LDAPControl **serverctrls,
1534 LDAPControl **clientctrls,
1538 ldap_install_tls LDAP_P((
1542 ldap_start_tls_s LDAP_P((
1544 LDAPControl **serverctrls,
1545 LDAPControl **clientctrls ));
1550 LDAP_F( LDAPMessage * )
1551 ldap_first_message LDAP_P((
1553 LDAPMessage *chain ));
1555 LDAP_F( LDAPMessage * )
1556 ldap_next_message LDAP_P((
1558 LDAPMessage *msg ));
1561 ldap_count_messages LDAP_P((
1563 LDAPMessage *chain ));
1568 LDAP_F( LDAPMessage * )
1569 ldap_first_reference LDAP_P((
1571 LDAPMessage *chain ));
1573 LDAP_F( LDAPMessage * )
1574 ldap_next_reference LDAP_P((
1576 LDAPMessage *ref ));
1579 ldap_count_references LDAP_P((
1581 LDAPMessage *chain ));
1584 ldap_parse_reference LDAP_P((
1588 LDAPControl ***serverctrls,
1595 LDAP_F( LDAPMessage * )
1596 ldap_first_entry LDAP_P((
1598 LDAPMessage *chain ));
1600 LDAP_F( LDAPMessage * )
1601 ldap_next_entry LDAP_P((
1603 LDAPMessage *entry ));
1606 ldap_count_entries LDAP_P((
1608 LDAPMessage *chain ));
1611 ldap_get_entry_controls LDAP_P((
1614 LDAPControl ***serverctrls));
1620 LDAP_F( LDAPMessage * )
1621 ldap_delete_result_entry LDAP_P((
1626 ldap_add_result_entry LDAP_P((
1635 ldap_get_dn LDAP_P((
1637 LDAPMessage *entry ));
1639 typedef struct ldap_ava {
1640 struct berval la_attr;
1641 struct berval la_value;
1643 #define LDAP_AVA_NULL 0x0000U
1644 #define LDAP_AVA_STRING 0x0001U
1645 #define LDAP_AVA_BINARY 0x0002U
1646 #define LDAP_AVA_NONPRINTABLE 0x0004U
1647 #define LDAP_AVA_FREE_ATTR 0x0010U
1648 #define LDAP_AVA_FREE_VALUE 0x0020U
1653 typedef LDAPAVA** LDAPRDN;
1654 typedef LDAPRDN* LDAPDN;
1657 #define LDAP_DN_FORMAT_LDAP 0x0000U
1658 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1659 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1660 #define LDAP_DN_FORMAT_DCE 0x0030U
1661 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1662 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1663 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1664 #define LDAP_DN_FORMAT_MASK 0x00F0U
1667 #define LDAP_DN_PRETTY 0x0100U
1668 #define LDAP_DN_SKIP 0x0200U
1669 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1670 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1671 #define LDAP_DN_PEDANTIC 0xF000U
1673 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1674 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1683 ldap_str2dn LDAP_P((
1684 LDAP_CONST char *str,
1695 ldap_dn2str LDAP_P((
1701 ldap_bv2rdn LDAP_P((
1708 ldap_str2rdn LDAP_P((
1709 LDAP_CONST char *str,
1715 ldap_rdn2bv LDAP_P((
1721 ldap_rdn2str LDAP_P((
1727 ldap_dn_normalize LDAP_P((
1728 LDAP_CONST char *in, unsigned iflags,
1729 char **out, unsigned oflags ));
1732 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1733 LDAP_CONST char *dn ));
1736 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1737 LDAP_CONST char *dn,
1741 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1742 LDAP_CONST char *rdn,
1745 typedef int LDAPDN_rewrite_func
1746 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1749 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1750 LDAPDN_rewrite_func *func, unsigned flags ));
1753 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1754 LDAP_CONST char *dn ));
1757 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1758 LDAP_CONST char *dce ));
1761 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1762 LDAP_CONST char *dn ));
1765 ldap_get_dn_ber LDAP_P((
1766 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1769 ldap_get_attribute_ber LDAP_P((
1770 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1771 struct berval **vals ));
1777 ldap_first_attribute LDAP_P((
1780 BerElement **ber ));
1783 ldap_next_attribute LDAP_P((
1792 LDAP_F( struct berval ** )
1793 ldap_get_values_len LDAP_P((
1796 LDAP_CONST char *target ));
1799 ldap_count_values_len LDAP_P((
1800 struct berval **vals ));
1803 ldap_value_free_len LDAP_P((
1804 struct berval **vals ));
1808 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1811 LDAP_CONST char *target ));
1814 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1818 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1826 ldap_result LDAP_P((
1830 struct timeval *timeout,
1831 LDAPMessage **result ));
1834 ldap_msgtype LDAP_P((
1842 ldap_msgfree LDAP_P((
1846 ldap_msgdelete LDAP_P((
1855 ldap_bv2escaped_filter_value LDAP_P((
1857 struct berval *out ));
1860 ldap_search_ext LDAP_P((
1862 LDAP_CONST char *base,
1864 LDAP_CONST char *filter,
1867 LDAPControl **serverctrls,
1868 LDAPControl **clientctrls,
1869 struct timeval *timeout,
1874 ldap_search_ext_s LDAP_P((
1876 LDAP_CONST char *base,
1878 LDAP_CONST char *filter,
1881 LDAPControl **serverctrls,
1882 LDAPControl **clientctrls,
1883 struct timeval *timeout,
1885 LDAPMessage **res ));
1889 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1891 LDAP_CONST char *base,
1893 LDAP_CONST char *filter,
1898 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1900 LDAP_CONST char *base,
1902 LDAP_CONST char *filter,
1905 LDAPMessage **res ));
1908 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1910 LDAP_CONST char *base,
1912 LDAP_CONST char *filter,
1915 struct timeval *timeout,
1916 LDAPMessage **res ));
1923 ldap_unbind_ext LDAP_P((
1925 LDAPControl **serverctrls,
1926 LDAPControl **clientctrls));
1929 ldap_unbind_ext_s LDAP_P((
1931 LDAPControl **serverctrls,
1932 LDAPControl **clientctrls));
1936 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1940 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1948 ldap_put_vrFilter LDAP_P((
1957 ldap_memalloc LDAP_P((
1961 ldap_memrealloc LDAP_P((
1966 ldap_memcalloc LDAP_P((
1971 ldap_memfree LDAP_P((
1975 ldap_memvfree LDAP_P((
1979 ldap_strdup LDAP_P((
1980 LDAP_CONST char * ));
1983 ldap_mods_free LDAP_P((
1990 * in sort.c (deprecated, use custom code instead)
1992 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1993 LDAP_CONST char *left,
1994 LDAP_CONST char *right ));
1996 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1997 LDAP_CONST void *left,
1998 LDAP_CONST void *right ));
2000 LDAP_F( int ) /* deprecated */
2001 ldap_sort_entries LDAP_P(( LDAP *ld,
2002 LDAPMessage **chain,
2003 LDAP_CONST char *attr,
2004 LDAP_SORT_AD_CMP_PROC *cmp ));
2006 LDAP_F( int ) /* deprecated */
2007 ldap_sort_values LDAP_P((
2010 LDAP_SORT_AV_CMP_PROC *cmp ));
2012 LDAP_F( int ) /* deprecated */
2013 ldap_sort_strcasecmp LDAP_P((
2015 LDAP_CONST void *b ));
2022 ldap_is_ldap_url LDAP_P((
2023 LDAP_CONST char *url ));
2026 ldap_is_ldaps_url LDAP_P((
2027 LDAP_CONST char *url ));
2030 ldap_is_ldapi_url LDAP_P((
2031 LDAP_CONST char *url ));
2034 ldap_url_parse LDAP_P((
2035 LDAP_CONST char *url,
2036 LDAPURLDesc **ludpp ));
2039 ldap_url_desc2str LDAP_P((
2040 LDAPURLDesc *ludp ));
2043 ldap_free_urldesc LDAP_P((
2044 LDAPURLDesc *ludp ));
2048 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2051 #define LDAP_API_FEATURE_CANCEL 1000
2054 ldap_cancel LDAP_P(( LDAP *ld,
2056 LDAPControl **sctrls,
2057 LDAPControl **cctrls,
2061 ldap_cancel_s LDAP_P(( LDAP *ld,
2063 LDAPControl **sctrl,
2064 LDAPControl **cctrl ));
2067 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2070 #define LDAP_API_FEATURE_TURN 1000
2073 ldap_turn LDAP_P(( LDAP *ld,
2075 LDAP_CONST char* identifier,
2076 LDAPControl **sctrls,
2077 LDAPControl **cctrls,
2081 ldap_turn_s LDAP_P(( LDAP *ld,
2083 LDAP_CONST char* identifier,
2084 LDAPControl **sctrl,
2085 LDAPControl **cctrl ));
2088 * LDAP Paged Results
2091 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2094 ldap_create_page_control_value LDAP_P((
2097 struct berval *cookie,
2098 struct berval *value ));
2101 ldap_create_page_control LDAP_P((
2104 struct berval *cookie,
2106 LDAPControl **ctrlp ));
2110 ldap_parse_page_control LDAP_P((
2111 /* deprecated, use ldap_parse_pageresponse_control */
2113 LDAPControl **ctrls,
2115 struct berval **cookie ));
2119 ldap_parse_pageresponse_control LDAP_P((
2123 struct berval *cookie ));
2126 * LDAP Server Side Sort
2129 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2131 /* structure for a sort-key */
2132 typedef struct ldapsortkey {
2133 char *attributeType;
2139 ldap_create_sort_keylist LDAP_P((
2140 LDAPSortKey ***sortKeyList,
2144 ldap_free_sort_keylist LDAP_P((
2145 LDAPSortKey **sortkeylist ));
2148 ldap_create_sort_control_value LDAP_P((
2150 LDAPSortKey **keyList,
2151 struct berval *value ));
2154 ldap_create_sort_control LDAP_P((
2156 LDAPSortKey **keyList,
2158 LDAPControl **ctrlp ));
2161 ldap_parse_sortresponse_control LDAP_P((
2165 char **attribute ));
2168 * LDAP Virtual List View
2171 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2173 /* structure for virtual list */
2174 typedef struct ldapvlvinfo {
2175 ber_int_t ldvlv_version;
2176 ber_int_t ldvlv_before_count;
2177 ber_int_t ldvlv_after_count;
2178 ber_int_t ldvlv_offset;
2179 ber_int_t ldvlv_count;
2180 struct berval * ldvlv_attrvalue;
2181 struct berval * ldvlv_context;
2182 void * ldvlv_extradata;
2186 ldap_create_vlv_control_value LDAP_P((
2188 LDAPVLVInfo *ldvlistp,
2189 struct berval *value));
2192 ldap_create_vlv_control LDAP_P((
2194 LDAPVLVInfo *ldvlistp,
2195 LDAPControl **ctrlp ));
2198 ldap_parse_vlvresponse_control LDAP_P((
2201 ber_int_t *target_posp,
2202 ber_int_t *list_countp,
2203 struct berval **contextp,
2210 #define LDAP_API_FEATURE_WHOAMI 1000
2213 ldap_parse_whoami LDAP_P((
2216 struct berval **authzid ));
2219 ldap_whoami LDAP_P(( LDAP *ld,
2220 LDAPControl **sctrls,
2221 LDAPControl **cctrls,
2225 ldap_whoami_s LDAP_P((
2227 struct berval **authzid,
2228 LDAPControl **sctrls,
2229 LDAPControl **cctrls ));
2232 * LDAP Password Modify
2235 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2238 ldap_parse_passwd LDAP_P((
2241 struct berval *newpasswd ));
2244 ldap_passwd LDAP_P(( LDAP *ld,
2245 struct berval *user,
2246 struct berval *oldpw,
2247 struct berval *newpw,
2248 LDAPControl **sctrls,
2249 LDAPControl **cctrls,
2253 ldap_passwd_s LDAP_P((
2255 struct berval *user,
2256 struct berval *oldpw,
2257 struct berval *newpw,
2258 struct berval *newpasswd,
2259 LDAPControl **sctrls,
2260 LDAPControl **cctrls ));
2262 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2264 * LDAP Password Policy controls
2267 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2269 typedef enum passpolicyerror_enum {
2270 PP_passwordExpired = 0,
2271 PP_accountLocked = 1,
2272 PP_changeAfterReset = 2,
2273 PP_passwordModNotAllowed = 3,
2274 PP_mustSupplyOldPassword = 4,
2275 PP_insufficientPasswordQuality = 5,
2276 PP_passwordTooShort = 6,
2277 PP_passwordTooYoung = 7,
2278 PP_passwordInHistory = 8,
2280 } LDAPPasswordPolicyError;
2283 ldap_create_passwordpolicy_control LDAP_P((
2285 LDAPControl **ctrlp ));
2288 ldap_parse_passwordpolicy_control LDAP_P((
2293 LDAPPasswordPolicyError *errorp ));
2295 LDAP_F( const char * )
2296 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2297 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2300 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2303 #define LDAP_API_FEATURE_REFRESH 1000
2306 ldap_parse_refresh LDAP_P((
2309 ber_int_t *newttl ));
2312 ldap_refresh LDAP_P(( LDAP *ld,
2315 LDAPControl **sctrls,
2316 LDAPControl **cctrls,
2320 ldap_refresh_s LDAP_P((
2325 LDAPControl **sctrls,
2326 LDAPControl **cctrls ));
2333 ldap_txn_start LDAP_P(( LDAP *ld,
2334 LDAPControl **sctrls,
2335 LDAPControl **cctrls,
2339 ldap_txn_start_s LDAP_P(( LDAP *ld,
2340 LDAPControl **sctrl,
2341 LDAPControl **cctrl,
2342 struct berval **rettxnid ));
2345 ldap_txn_end LDAP_P(( LDAP *ld,
2347 struct berval *txnid,
2348 LDAPControl **sctrls,
2349 LDAPControl **cctrls,
2353 ldap_txn_end_s LDAP_P(( LDAP *ld,
2355 struct berval *txnid,
2356 LDAPControl **sctrl,
2357 LDAPControl **cctrl,
2366 * initialize the persistent search structure
2368 LDAP_F( ldap_sync_t * )
2369 ldap_sync_initialize LDAP_P((
2373 * destroy the persistent search structure
2376 ldap_sync_destroy LDAP_P((
2381 * initialize a refreshOnly sync
2384 ldap_sync_init LDAP_P((
2389 * initialize a refreshOnly sync
2392 ldap_sync_init_refresh_only LDAP_P((
2396 * initialize a refreshAndPersist sync
2399 ldap_sync_init_refresh_and_persist LDAP_P((
2403 * poll for new responses
2406 ldap_sync_poll LDAP_P((
2409 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2415 ldap_create_session_tracking_value LDAP_P((
2417 char *sessionSourceIp,
2418 char *sessionSourceName,
2420 struct berval *sessionTrackingIdentifier,
2421 struct berval *value ));
2424 ldap_create_session_tracking LDAP_P((
2426 char *sessionSourceIp,
2427 char *sessionSourceName,
2429 struct berval *sessionTrackingIdentifier,
2430 LDAPControl **ctrlp ));
2433 ldap_parse_session_tracking_control LDAP_P((
2437 struct berval *name,
2439 struct berval *id ));
2441 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2447 ldap_create_assertion_control_value LDAP_P((
2450 struct berval *value ));
2453 ldap_create_assertion_control LDAP_P((
2457 LDAPControl **ctrlp ));
2463 typedef struct LDAPDerefSpec {
2468 typedef struct LDAPDerefVal {
2471 struct LDAPDerefVal *next;
2474 typedef struct LDAPDerefRes {
2476 struct berval derefVal;
2477 LDAPDerefVal *attrVals;
2478 struct LDAPDerefRes *next;
2482 ldap_create_deref_control_value LDAP_P((
2485 struct berval *value ));
2488 ldap_create_deref_control LDAP_P((
2492 LDAPControl **ctrlp ));
2495 ldap_derefresponse_free LDAP_P((
2496 LDAPDerefRes *dr ));
2499 ldap_parse_derefresponse_control LDAP_P((
2502 LDAPDerefRes **drp ));
2505 ldap_parse_deref_control LDAP_P((
2507 LDAPControl **ctrls,
2508 LDAPDerefRes **drp ));
2511 * high level LDIF to LDAP structure support
2513 #define LDIF_DEFAULT_ADD 0x01 /* if changetype missing, assume LDAP_ADD */
2514 #define LDIF_ENTRIES_ONLY 0x02 /* ignore changetypes other than add */
2515 #define LDIF_NO_CONTROLS 0x04 /* ignore control specifications */
2517 typedef struct ldifrecord {
2518 ber_tag_t lr_op; /* type of operation - LDAP_REQ_MODIFY, LDAP_REQ_ADD, etc. */
2519 struct berval lr_dn; /* DN of operation */
2520 LDAPControl **lr_ctrls; /* controls specified for operation */
2521 /* some ops such as LDAP_REQ_DELETE require only a DN */
2522 /* other ops require different data - the ldif_ops union
2523 is used to specify the data for each type of operation */
2525 LDAPMod **lr_mods; /* list of mods for LDAP_REQ_MODIFY, LDAP_REQ_ADD */
2526 #define lrop_mods ldif_ops.lr_mods
2527 struct ldif_op_rename_s {
2528 struct berval lr_newrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2529 #define lrop_newrdn ldif_ops.ldif_op_rename.lr_newrdn
2530 struct berval lr_newsuperior; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2531 #define lrop_newsup ldif_ops.ldif_op_rename.lr_newsuperior
2532 int lr_deleteoldrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2533 #define lrop_delold ldif_ops.ldif_op_rename.lr_deleteoldrdn
2534 } ldif_op_rename; /* rename/moddn/modrdn */
2535 /* the following are for future support */
2536 struct ldif_op_ext_s {
2537 struct berval lr_extop_oid; /* LDAP_REQ_EXTENDED */
2538 #define lrop_extop_oid ldif_ops.ldif_op_ext.lr_extop_oid
2539 struct berval lr_extop_data; /* LDAP_REQ_EXTENDED */
2540 #define lrop_extop_data ldif_ops.ldif_op_ext.lr_extop_data
2541 } ldif_op_ext; /* extended operation */
2542 struct ldif_op_cmp_s {
2543 struct berval lr_cmp_attr; /* LDAP_REQ_COMPARE */
2544 #define lrop_cmp_attr ldif_ops.ldif_op_cmp.lr_cmp_attr
2545 struct berval lr_cmp_bvalue; /* LDAP_REQ_COMPARE */
2546 #define lrop_cmp_bval ldif_ops.ldif_op_cmp.lr_cmp_bvalue
2547 } ldif_op_cmp; /* compare operation */
2549 /* PRIVATE STUFF - DO NOT TOUCH */
2550 /* for efficiency, the implementation allocates memory */
2551 /* in large blobs, and makes the above fields point to */
2552 /* locations inside those blobs - one consequence is that */
2553 /* you cannot simply free the above allocated fields, nor */
2554 /* assign them to be owned by another memory context which */
2555 /* might free them (unless providing your own mem ctx) */
2556 /* we use the fields below to keep track of those blobs */
2557 /* so we that we can free them later */
2558 void *lr_ctx; /* the memory context or NULL */
2561 unsigned char *lr_mops;
2563 struct berval *lr_vals;
2564 struct berval *lr_btype;
2567 /* free internal fields - does not free the LDIFRecord */
2569 ldap_ldif_record_done LDAP_P((
2573 ldap_parse_ldif_record LDAP_P((
2574 struct berval *rbuf,
2578 unsigned int flags ));
2581 #endif /* _LDAP_H */