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
63 # define LDAP_API_FEATURE_SESSION_THREAD_SAFE 1
64 # define LDAP_API_FEATURE_OPERATION_THREAD_SAFE 1
66 #if defined( LDAP_THREAD_SAFE ) && \
67 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
68 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
69 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
73 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
74 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
76 #define LDAP_ROOT_DSE ""
77 #define LDAP_NO_ATTRS "1.1"
78 #define LDAP_ALL_USER_ATTRIBUTES "*"
79 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
81 /* RFC 4511: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
82 #define LDAP_MAXINT (2147483647)
86 * 0x0000 - 0x0fff reserved for api options
87 * 0x1000 - 0x3fff reserved for api extended options
88 * 0x4000 - 0x7fff reserved for private and experimental options
91 #define LDAP_OPT_API_INFO 0x0000
92 #define LDAP_OPT_DESC 0x0001 /* historic */
93 #define LDAP_OPT_DEREF 0x0002
94 #define LDAP_OPT_SIZELIMIT 0x0003
95 #define LDAP_OPT_TIMELIMIT 0x0004
96 /* 0x05 - 0x07 not defined */
97 #define LDAP_OPT_REFERRALS 0x0008
98 #define LDAP_OPT_RESTART 0x0009
99 /* 0x0a - 0x10 not defined */
100 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
101 #define LDAP_OPT_SERVER_CONTROLS 0x0012
102 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
103 /* 0x14 not defined */
104 #define LDAP_OPT_API_FEATURE_INFO 0x0015
105 /* 0x16 - 0x2f not defined */
106 #define LDAP_OPT_HOST_NAME 0x0030
107 #define LDAP_OPT_RESULT_CODE 0x0031
108 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
109 #define LDAP_OPT_DIAGNOSTIC_MESSAGE 0x0032
110 #define LDAP_OPT_ERROR_STRING LDAP_OPT_DIAGNOSTIC_MESSAGE
111 #define LDAP_OPT_MATCHED_DN 0x0033
112 /* 0x0034 - 0x3fff not defined */
113 /* 0x0091 used by Microsoft for LDAP_OPT_AUTO_RECONNECT */
114 #define LDAP_OPT_SSPI_FLAGS 0x0092
115 /* 0x0093 used by Microsoft for LDAP_OPT_SSL_INFO */
116 /* 0x0094 used by Microsoft for LDAP_OPT_REF_DEREF_CONN_PER_MSG */
117 #define LDAP_OPT_SIGN 0x0095
118 #define LDAP_OPT_ENCRYPT 0x0096
119 #define LDAP_OPT_SASL_METHOD 0x0097
120 /* 0x0098 used by Microsoft for LDAP_OPT_AREC_EXCLUSIVE */
121 #define LDAP_OPT_SECURITY_CONTEXT 0x0099
122 /* 0x009A used by Microsoft for LDAP_OPT_ROOTDSE_CACHE */
123 /* 0x009B - 0x3fff not defined */
126 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
128 /* private and experimental options */
129 /* OpenLDAP specific options */
130 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
131 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
132 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
133 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
134 #define LDAP_OPT_URI 0x5006
135 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
136 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */
137 #define LDAP_OPT_DEFBASE 0x5009 /* searchbase */
138 #define LDAP_OPT_CONNECT_ASYNC 0x5010 /* create connections asynchronously */
139 #define LDAP_OPT_CONNECT_CB 0x5011 /* connection callbacks */
140 #define LDAP_OPT_SESSION_REFCNT 0x5012 /* session reference count */
142 /* OpenLDAP TLS options */
143 #define LDAP_OPT_X_TLS 0x6000
144 #define LDAP_OPT_X_TLS_CTX 0x6001 /* OpenSSL CTX* */
145 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
146 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
147 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
148 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
149 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
150 #define LDAP_OPT_X_TLS_PROTOCOL_MIN 0x6007
151 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
152 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
153 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a /* OpenSSL SSL* */
154 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
155 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
156 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
157 #define LDAP_OPT_X_TLS_DHFILE 0x600e
158 #define LDAP_OPT_X_TLS_NEWCTX 0x600f
159 #define LDAP_OPT_X_TLS_CRLFILE 0x6010 /* GNUtls only */
161 #define LDAP_OPT_X_TLS_NEVER 0
162 #define LDAP_OPT_X_TLS_HARD 1
163 #define LDAP_OPT_X_TLS_DEMAND 2
164 #define LDAP_OPT_X_TLS_ALLOW 3
165 #define LDAP_OPT_X_TLS_TRY 4
167 #define LDAP_OPT_X_TLS_CRL_NONE 0
168 #define LDAP_OPT_X_TLS_CRL_PEER 1
169 #define LDAP_OPT_X_TLS_CRL_ALL 2
171 /* for LDAP_OPT_X_TLS_PROTOCOL_MIN */
172 #define LDAP_OPT_X_TLS_PROTOCOL(maj,min) (((maj) << 8) + (min))
173 #define LDAP_OPT_X_TLS_PROTOCOL_SSL2 (2 << 8)
174 #define LDAP_OPT_X_TLS_PROTOCOL_SSL3 (3 << 8)
175 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_0 ((3 << 8) + 1)
176 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_1 ((3 << 8) + 2)
177 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_2 ((3 << 8) + 3)
179 /* OpenLDAP SASL options */
180 #define LDAP_OPT_X_SASL_MECH 0x6100
181 #define LDAP_OPT_X_SASL_REALM 0x6101
182 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
183 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
184 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
185 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
186 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
187 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
188 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
189 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
190 #define LDAP_OPT_X_SASL_MECHLIST 0x610a /* read-only */
191 #define LDAP_OPT_X_SASL_NOCANON 0x610b
192 #define LDAP_OPT_X_SASL_USERNAME 0x610c /* read-only */
193 #define LDAP_OPT_X_SASL_GSS_CREDS 0x610d
195 /* OpenLDAP GSSAPI options */
196 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT 0x6200
197 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL 0x6201
200 * OpenLDAP per connection tcp-keepalive settings
201 * (Linux only, ignored where unsupported)
203 #define LDAP_OPT_X_KEEPALIVE_IDLE 0x6300
204 #define LDAP_OPT_X_KEEPALIVE_PROBES 0x6301
205 #define LDAP_OPT_X_KEEPALIVE_INTERVAL 0x6302
207 /* Private API Extensions -- reserved for application use */
208 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
211 * ldap_get_option() and ldap_set_option() return values.
212 * As later versions may return other values indicating
213 * failure, current applications should only compare returned
214 * value against LDAP_OPT_SUCCESS.
216 #define LDAP_OPT_SUCCESS 0
217 #define LDAP_OPT_ERROR (-1)
219 /* option on/off values */
220 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
221 #define LDAP_OPT_OFF ((void *) 0)
223 typedef struct ldapapiinfo {
224 int ldapai_info_version; /* version of LDAPAPIInfo */
225 #define LDAP_API_INFO_VERSION (1)
226 int ldapai_api_version; /* revision of API supported */
227 int ldapai_protocol_version; /* highest LDAP version supported */
228 char **ldapai_extensions; /* names of API extensions */
229 char *ldapai_vendor_name; /* name of supplier */
230 int ldapai_vendor_version; /* supplier-specific version * 100 */
233 typedef struct ldap_apifeature_info {
234 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
235 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
236 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
237 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
238 } LDAPAPIFeatureInfo;
241 * LDAP Control structure
243 typedef struct ldapcontrol {
244 char * ldctl_oid; /* numericoid of control */
245 struct berval ldctl_value; /* encoded value of control */
246 char ldctl_iscritical; /* criticality */
250 /* standard track controls */
251 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
252 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
253 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
255 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
257 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
258 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
259 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
261 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
262 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
264 /* non-standard track controls */
265 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
267 /* LDAP Content Synchronization Operation -- RFC 4533 */
268 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
269 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
270 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
271 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
272 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
274 #define LDAP_SYNC_NONE 0x00
275 #define LDAP_SYNC_REFRESH_ONLY 0x01
276 #define LDAP_SYNC_RESERVED 0x02
277 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
279 #define LDAP_SYNC_REFRESH_PRESENTS 0
280 #define LDAP_SYNC_REFRESH_DELETES 1
282 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
283 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
284 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
285 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
287 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
288 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
289 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
290 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
292 #define LDAP_SYNC_PRESENT 0
293 #define LDAP_SYNC_ADD 1
294 #define LDAP_SYNC_MODIFY 2
295 #define LDAP_SYNC_DELETE 3
296 #define LDAP_SYNC_NEW_COOKIE 4
299 /* Password policy Controls *//* work in progress */
300 /* ITS#3458: released; disabled by default */
301 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
302 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
304 /* various works in progress */
305 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
306 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
307 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
308 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
309 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
310 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
311 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
312 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
313 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
315 /* LDAP Chaining Behavior Control *//* work in progress */
316 /* <draft-sermersheim-ldap-chaining>;
317 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
318 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
320 #define LDAP_CHAINING_PREFERRED 0
321 #define LDAP_CHAINING_REQUIRED 1
322 #define LDAP_REFERRALS_PREFERRED 2
323 #define LDAP_REFERRALS_REQUIRED 3
325 /* MS Active Directory controls (for compatibility) */
326 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
327 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
328 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
329 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
330 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
331 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
332 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
334 /* MS Active Directory controls - not implemented in slapd(8) */
335 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
338 /* <draft-wahl-ldap-session> */
339 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
340 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
341 LDAP_CONTROL_X_SESSION_TRACKING ".1"
342 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
343 LDAP_CONTROL_X_SESSION_TRACKING ".2"
344 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
345 LDAP_CONTROL_X_SESSION_TRACKING ".3"
346 #endif /* LDAP_DEVEL */
348 /* various expired works */
349 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
350 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
351 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
352 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
353 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
355 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
356 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
357 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
358 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
359 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
360 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
361 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
364 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
365 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
367 /* LDAP Unsolicited Notifications */
368 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
369 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
371 /* LDAP Extended Operations */
372 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
374 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
375 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
376 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
377 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
378 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
380 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
381 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
383 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
384 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
385 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
386 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
388 #define LDAP_EXOP_VERIFY_CREDENTIALS "1.3.6.1.4.1.4203.666.6.5"
389 #define LDAP_EXOP_X_VERIFY_CREDENTIALS LDAP_EXOP_VERIFY_CREDENTIALS
391 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_COOKIE ((ber_tag_t) 0x80U)
392 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_SCREDS ((ber_tag_t) 0x81U)
393 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_CONTROLS ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
395 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
396 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
398 /* various works in progress */
399 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
400 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
402 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
403 /* a work in progress */
404 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
405 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
406 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
407 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
408 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
409 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
410 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
411 LDAP_X_DISTPROC_BASE ".6"
412 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
413 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
414 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
415 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
416 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
419 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
420 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
421 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
422 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
423 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
427 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
428 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
429 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
430 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
431 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
432 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
433 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
435 /* LDAP Experimental (works in progress) Features */
436 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
437 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
438 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
441 * specific LDAP instantiations of BER types we know about
444 /* Overview of LBER tag construction
451 * 1 0 = CONTEXT-SPECIFIC
458 * | 5 ... 1 | TAG-NUMBER
462 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
463 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
465 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
466 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
468 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
469 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
471 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
473 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
474 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
475 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
476 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
478 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
479 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
481 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
483 /* LDAP Request Messages */
484 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
485 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
486 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
487 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
488 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
489 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
490 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
491 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
492 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
493 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
494 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
495 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
497 /* LDAP Response Messages */
498 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
499 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
500 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
501 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
502 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
503 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
504 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
505 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
506 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
507 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
508 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
509 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
510 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
512 #define LDAP_RES_ANY (-1)
513 #define LDAP_RES_UNSOLICITED (0)
517 #define LDAP_SASL_SIMPLE ((char*)0)
518 #define LDAP_SASL_NULL ("")
521 /* authentication methods available */
522 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
523 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
524 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
525 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
526 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
527 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
529 /* used by the Windows API but not used on the wire */
530 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
533 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
534 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
535 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
536 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
537 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
538 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
539 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
540 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
541 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
542 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
544 /* extended filter component types */
545 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
546 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
547 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
548 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
550 /* substring filter component types */
551 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
552 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
553 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
556 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
557 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
558 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
559 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
560 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
561 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
562 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
563 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
564 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
566 /* substring filter component types */
567 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
568 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
569 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
574 #define LDAP_SUCCESS 0x00
576 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
578 #define LDAP_OPERATIONS_ERROR 0x01
579 #define LDAP_PROTOCOL_ERROR 0x02
580 #define LDAP_TIMELIMIT_EXCEEDED 0x03
581 #define LDAP_SIZELIMIT_EXCEEDED 0x04
582 #define LDAP_COMPARE_FALSE 0x05
583 #define LDAP_COMPARE_TRUE 0x06
584 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
585 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
586 #define LDAP_STRONG_AUTH_REQUIRED 0x08
587 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
588 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
590 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
591 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
592 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
593 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
594 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
596 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
598 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
599 #define LDAP_UNDEFINED_TYPE 0x11
600 #define LDAP_INAPPROPRIATE_MATCHING 0x12
601 #define LDAP_CONSTRAINT_VIOLATION 0x13
602 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
603 #define LDAP_INVALID_SYNTAX 0x15
605 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
607 #define LDAP_NO_SUCH_OBJECT 0x20
608 #define LDAP_ALIAS_PROBLEM 0x21
609 #define LDAP_INVALID_DN_SYNTAX 0x22
610 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
611 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
613 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
615 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
616 #define LDAP_INAPPROPRIATE_AUTH 0x30
617 #define LDAP_INVALID_CREDENTIALS 0x31
618 #define LDAP_INSUFFICIENT_ACCESS 0x32
620 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
622 #define LDAP_BUSY 0x33
623 #define LDAP_UNAVAILABLE 0x34
624 #define LDAP_UNWILLING_TO_PERFORM 0x35
625 #define LDAP_LOOP_DETECT 0x36
627 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
629 #define LDAP_NAMING_VIOLATION 0x40
630 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
631 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
632 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
633 #define LDAP_ALREADY_EXISTS 0x44
634 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
635 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
636 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
638 #define LDAP_VLV_ERROR 0x4C
640 #define LDAP_OTHER 0x50
642 /* LCUP operation codes (113-117) - not implemented */
643 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
644 #define LDAP_CUP_SECURITY_VIOLATION 0x72
645 #define LDAP_CUP_INVALID_DATA 0x73
646 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
647 #define LDAP_CUP_RELOAD_REQUIRED 0x75
649 /* Cancel operation codes (118-121) */
650 #define LDAP_CANCELLED 0x76
651 #define LDAP_NO_SUCH_OPERATION 0x77
652 #define LDAP_TOO_LATE 0x78
653 #define LDAP_CANNOT_CANCEL 0x79
655 /* Assertion control (122) */
656 #define LDAP_ASSERTION_FAILED 0x7A
658 /* Proxied Authorization Denied (123) */
659 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
661 /* Experimental result codes */
662 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
664 /* LDAP Sync (4096) */
665 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
668 /* Private Use result codes */
669 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
671 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
672 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
674 /* for the LDAP No-Op control */
675 #define LDAP_X_NO_OPERATION 0x410e
677 /* for the Chaining Behavior control (consecutive result codes requested;
678 * see <draft-sermersheim-ldap-chaining> ) */
679 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
680 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
681 #define LDAP_X_CANNOT_CHAIN 0x4111
684 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
685 #ifdef LDAP_X_DISTPROC_BASE
686 #define LDAP_X_INVALIDREFERENCE 0x4112
690 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
691 #define LDAP_X_TXN_ID_INVALID 0x4121
696 * Based on draft-ietf-ldap-c-api-xx
697 * but with new negative code values
699 #define LDAP_API_ERROR(n) ((n)<0)
700 #define LDAP_API_RESULT(n) ((n)<=0)
702 #define LDAP_SERVER_DOWN (-1)
703 #define LDAP_LOCAL_ERROR (-2)
704 #define LDAP_ENCODING_ERROR (-3)
705 #define LDAP_DECODING_ERROR (-4)
706 #define LDAP_TIMEOUT (-5)
707 #define LDAP_AUTH_UNKNOWN (-6)
708 #define LDAP_FILTER_ERROR (-7)
709 #define LDAP_USER_CANCELLED (-8)
710 #define LDAP_PARAM_ERROR (-9)
711 #define LDAP_NO_MEMORY (-10)
712 #define LDAP_CONNECT_ERROR (-11)
713 #define LDAP_NOT_SUPPORTED (-12)
714 #define LDAP_CONTROL_NOT_FOUND (-13)
715 #define LDAP_NO_RESULTS_RETURNED (-14)
716 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
717 #define LDAP_CLIENT_LOOP (-16)
718 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
719 #define LDAP_X_CONNECTING (-18)
723 * This structure represents both ldap messages and ldap responses.
724 * These are really the same, except in the case of search responses,
725 * where a response has multiple messages.
728 typedef struct ldapmsg LDAPMessage;
730 /* for modifications */
731 typedef struct ldapmod {
734 #define LDAP_MOD_OP (0x0007)
735 #define LDAP_MOD_ADD (0x0000)
736 #define LDAP_MOD_DELETE (0x0001)
737 #define LDAP_MOD_REPLACE (0x0002)
738 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
739 #define LDAP_MOD_BVALUES (0x0080)
740 /* IMPORTANT: do not use code 0x1000 (or above),
741 * it is used internally by the backends!
742 * (see ldap/servers/slapd/slap.h)
748 struct berval **modv_bvals;
750 #define mod_values mod_vals.modv_strvals
751 #define mod_bvalues mod_vals.modv_bvals
755 * structure representing an ldap session which can
756 * encompass connections to multiple servers (in the
757 * face of referrals).
759 typedef struct ldap LDAP;
761 #define LDAP_DEREF_NEVER 0x00
762 #define LDAP_DEREF_SEARCHING 0x01
763 #define LDAP_DEREF_FINDING 0x02
764 #define LDAP_DEREF_ALWAYS 0x03
766 #define LDAP_NO_LIMIT 0
768 /* how many messages to retrieve results for */
769 #define LDAP_MSG_ONE 0x00
770 #define LDAP_MSG_ALL 0x01
771 #define LDAP_MSG_RECEIVED 0x02
774 * types for ldap URL handling
776 typedef struct ldap_url_desc {
777 struct ldap_url_desc *lud_next;
789 #define LDAP_URL_SUCCESS 0x00 /* Success */
790 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
791 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
793 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
794 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
795 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
796 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
797 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
798 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
799 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
800 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
803 * LDAP sync (RFC4533) API
806 typedef struct ldap_sync_t ldap_sync_t;
809 /* these are private - the client should never see them */
810 LDAP_SYNC_CAPI_NONE = -1,
812 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
813 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
814 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
816 /* these are passed to ls_search_entry() */
817 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
818 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
819 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
820 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
822 /* these are passed to ls_intermediate() */
823 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
824 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
826 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
827 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
829 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
830 } ldap_sync_refresh_t;
833 * Called when an entry is returned by ldap_result().
834 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
835 * the entry has been either added or modified, and thus
836 * the complete view of the entry should be in the LDAPMessage.
837 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
838 * only the DN should be in the LDAPMessage.
840 typedef int (*ldap_sync_search_entry_f) LDAP_P((
843 struct berval *entryUUID,
844 ldap_sync_refresh_t phase ));
847 * Called when a reference is returned; the client should know
848 * what to do with it.
850 typedef int (*ldap_sync_search_reference_f) LDAP_P((
855 * Called when specific intermediate/final messages are returned.
856 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
857 * a "presents" or "deletes" phase begins.
858 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
859 * with refreshDone set to "TRUE" has been returned, to indicate
860 * that the refresh phase of a refreshAndPersist is complete.
861 * In the above cases, syncUUIDs is NULL.
863 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
864 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
865 * that are either present or have been deleted.
867 typedef int (*ldap_sync_intermediate_f) LDAP_P((
871 ldap_sync_refresh_t phase ));
874 * Called when a searchResultDone is returned. In refreshAndPersist,
875 * this can only occur if the search for any reason is being terminated
878 typedef int (*ldap_sync_search_result_f) LDAP_P((
881 int refreshDeletes ));
884 * This structure contains all information about the persistent search;
885 * the caller is responsible for connecting, setting version, binding, tls...
888 /* conf search params */
899 /* helpers - add as appropriate */
900 ldap_sync_search_entry_f ls_search_entry;
901 ldap_sync_search_reference_f ls_search_reference;
902 ldap_sync_intermediate_f ls_intermediate;
903 ldap_sync_search_result_f ls_search_result;
905 /* set by the caller as appropriate */
911 /* --- the parameters below are private - do not modify --- */
913 /* FIXME: make the structure opaque, and provide an interface
914 * to modify the public values? */
920 /* needed by refreshOnly */
923 /* opaque - need to pass between sessions, updated by the API */
924 struct berval ls_cookie;
926 /* state variable - do not modify */
927 ldap_sync_refresh_t ls_refreshPhase;
931 * End of LDAP sync (RFC4533) API
935 * Connection callbacks...
940 /* Called after a connection is established */
941 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
942 struct ldap_conncb *ctx ));
943 /* Called before a connection is closed */
944 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
946 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
947 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
949 typedef struct ldap_conncb {
950 ldap_conn_add_f *lc_add;
951 ldap_conn_del_f *lc_del;
956 * The API draft spec says we should declare (or cause to be declared)
957 * 'struct timeval'. We don't. See IETF LDAPext discussions.
965 ldap_get_option LDAP_P((
971 ldap_set_option LDAP_P((
974 LDAP_CONST void *invalue));
976 /* V3 REBIND Function Callback Prototype */
977 typedef int (LDAP_REBIND_PROC) LDAP_P((
978 LDAP *ld, LDAP_CONST char *url,
979 ber_tag_t request, ber_int_t msgid,
983 ldap_set_rebind_proc LDAP_P((
985 LDAP_REBIND_PROC *rebind_proc,
988 /* V3 referral selection Function Callback Prototype */
989 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
990 LDAP *ld, char ***refsp, int *cntp,
994 ldap_set_nextref_proc LDAP_P((
996 LDAP_NEXTREF_PROC *nextref_proc,
999 /* V3 URLLIST Function Callback Prototype */
1000 typedef int (LDAP_URLLIST_PROC) LDAP_P((
1002 LDAPURLDesc **urllist,
1007 ldap_set_urllist_proc LDAP_P((
1009 LDAP_URLLIST_PROC *urllist_proc,
1017 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
1018 LDAP_CONST char *requestOID,
1021 LDAPControl **ctrlp ));
1023 LDAP_F( LDAPControl * )
1024 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
1025 LDAP_CONST char *oid,
1026 LDAPControl **ctrls ));
1030 ldap_control_create LDAP_P((
1031 LDAP_CONST char *requestOID,
1033 struct berval *value,
1035 LDAPControl **ctrlp ));
1037 LDAP_F( LDAPControl * )
1038 ldap_control_find LDAP_P((
1039 LDAP_CONST char *oid,
1040 LDAPControl **ctrls,
1041 LDAPControl ***nextctrlp ));
1044 ldap_control_free LDAP_P((
1045 LDAPControl *ctrl ));
1048 ldap_controls_free LDAP_P((
1049 LDAPControl **ctrls ));
1051 LDAP_F( LDAPControl ** )
1052 ldap_controls_dup LDAP_P((
1053 LDAPControl *LDAP_CONST *controls ));
1055 LDAP_F( LDAPControl * )
1056 ldap_control_dup LDAP_P((
1057 LDAP_CONST LDAPControl *c ));
1063 ldap_domain2dn LDAP_P((
1064 LDAP_CONST char* domain,
1068 ldap_dn2domain LDAP_P((
1069 LDAP_CONST char* dn,
1073 ldap_domain2hostlist LDAP_P((
1074 LDAP_CONST char *domain,
1081 ldap_extended_operation LDAP_P((
1083 LDAP_CONST char *reqoid,
1084 struct berval *reqdata,
1085 LDAPControl **serverctrls,
1086 LDAPControl **clientctrls,
1090 ldap_extended_operation_s LDAP_P((
1092 LDAP_CONST char *reqoid,
1093 struct berval *reqdata,
1094 LDAPControl **serverctrls,
1095 LDAPControl **clientctrls,
1097 struct berval **retdatap ));
1100 ldap_parse_extended_result LDAP_P((
1104 struct berval **retdatap,
1108 ldap_parse_intermediate LDAP_P((
1112 struct berval **retdatap,
1113 LDAPControl ***serverctrls,
1121 ldap_abandon_ext LDAP_P((
1124 LDAPControl **serverctrls,
1125 LDAPControl **clientctrls ));
1129 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1138 ldap_add_ext LDAP_P((
1140 LDAP_CONST char *dn,
1142 LDAPControl **serverctrls,
1143 LDAPControl **clientctrls,
1147 ldap_add_ext_s LDAP_P((
1149 LDAP_CONST char *dn,
1151 LDAPControl **serverctrls,
1152 LDAPControl **clientctrls ));
1156 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1158 LDAP_CONST char *dn,
1162 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1164 LDAP_CONST char *dn,
1173 ldap_sasl_bind LDAP_P((
1175 LDAP_CONST char *dn,
1176 LDAP_CONST char *mechanism,
1177 struct berval *cred,
1178 LDAPControl **serverctrls,
1179 LDAPControl **clientctrls,
1182 /* Interaction flags (should be passed about in a control)
1183 * Automatic (default): use defaults, prompt otherwise
1184 * Interactive: prompt always
1185 * Quiet: never prompt
1187 #define LDAP_SASL_AUTOMATIC 0U
1188 #define LDAP_SASL_INTERACTIVE 1U
1189 #define LDAP_SASL_QUIET 2U
1192 * V3 SASL Interaction Function Callback Prototype
1193 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1194 * should likely passed in a control (and provided controls)
1196 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1197 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1200 ldap_sasl_interactive_bind LDAP_P((
1202 LDAP_CONST char *dn, /* usually NULL */
1203 LDAP_CONST char *saslMechanism,
1204 LDAPControl **serverControls,
1205 LDAPControl **clientControls,
1207 /* should be client controls */
1209 LDAP_SASL_INTERACT_PROC *proc,
1212 /* as obtained from ldap_result() */
1213 LDAPMessage *result,
1215 /* returned during bind processing */
1220 ldap_sasl_interactive_bind_s LDAP_P((
1222 LDAP_CONST char *dn, /* usually NULL */
1223 LDAP_CONST char *saslMechanism,
1224 LDAPControl **serverControls,
1225 LDAPControl **clientControls,
1227 /* should be client controls */
1229 LDAP_SASL_INTERACT_PROC *proc,
1233 ldap_sasl_bind_s LDAP_P((
1235 LDAP_CONST char *dn,
1236 LDAP_CONST char *mechanism,
1237 struct berval *cred,
1238 LDAPControl **serverctrls,
1239 LDAPControl **clientctrls,
1240 struct berval **servercredp ));
1243 ldap_parse_sasl_bind_result LDAP_P((
1246 struct berval **servercredp,
1255 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1257 LDAP_CONST char *who,
1258 LDAP_CONST char *passwd,
1262 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1264 LDAP_CONST char *who,
1265 LDAP_CONST char *cred,
1272 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1274 LDAP_CONST char *who,
1275 LDAP_CONST char *passwd ));
1278 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1280 LDAP_CONST char *who,
1281 LDAP_CONST char *passwd ));
1290 ldap_compare_ext 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_ext_s LDAP_P((
1302 LDAP_CONST char *dn,
1303 LDAP_CONST char *attr,
1304 struct berval *bvalue,
1305 LDAPControl **serverctrls,
1306 LDAPControl **clientctrls ));
1310 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1312 LDAP_CONST char *dn,
1313 LDAP_CONST char *attr,
1314 LDAP_CONST char *value ));
1317 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1319 LDAP_CONST char *dn,
1320 LDAP_CONST char *attr,
1321 LDAP_CONST char *value ));
1329 ldap_delete_ext LDAP_P((
1331 LDAP_CONST char *dn,
1332 LDAPControl **serverctrls,
1333 LDAPControl **clientctrls,
1337 ldap_delete_ext_s LDAP_P((
1339 LDAP_CONST char *dn,
1340 LDAPControl **serverctrls,
1341 LDAPControl **clientctrls ));
1345 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1347 LDAP_CONST char *dn ));
1350 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1352 LDAP_CONST char *dn ));
1360 ldap_parse_result LDAP_P((
1367 LDAPControl ***serverctrls,
1371 ldap_err2string LDAP_P((
1376 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1382 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1384 LDAP_CONST char *s ));
1392 ldap_gssapi_bind LDAP_P((
1394 LDAP_CONST char *dn,
1395 LDAP_CONST char *creds ));
1398 ldap_gssapi_bind_s LDAP_P((
1400 LDAP_CONST char *dn,
1401 LDAP_CONST char *creds ));
1408 ldap_modify_ext LDAP_P((
1410 LDAP_CONST char *dn,
1412 LDAPControl **serverctrls,
1413 LDAPControl **clientctrls,
1417 ldap_modify_ext_s LDAP_P((
1419 LDAP_CONST char *dn,
1421 LDAPControl **serverctrls,
1422 LDAPControl **clientctrls ));
1426 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1428 LDAP_CONST char *dn,
1432 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1434 LDAP_CONST char *dn,
1443 ldap_rename LDAP_P((
1445 LDAP_CONST char *dn,
1446 LDAP_CONST char *newrdn,
1447 LDAP_CONST char *newSuperior,
1449 LDAPControl **sctrls,
1450 LDAPControl **cctrls,
1454 ldap_rename_s LDAP_P((
1456 LDAP_CONST char *dn,
1457 LDAP_CONST char *newrdn,
1458 LDAP_CONST char *newSuperior,
1460 LDAPControl **sctrls,
1461 LDAPControl **cctrls ));
1465 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1467 LDAP_CONST char *dn,
1468 LDAP_CONST char *newrdn,
1469 LDAP_CONST char *newSuperior,
1470 int deleteoldrdn ));
1473 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1475 LDAP_CONST char *dn,
1476 LDAP_CONST char *newrdn,
1477 LDAP_CONST char *newSuperior,
1478 int deleteoldrdn ));
1481 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1483 LDAP_CONST char *dn,
1484 LDAP_CONST char *newrdn ));
1487 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1489 LDAP_CONST char *dn,
1490 LDAP_CONST char *newrdn ));
1493 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1495 LDAP_CONST char *dn,
1496 LDAP_CONST char *newrdn,
1497 int deleteoldrdn ));
1500 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1502 LDAP_CONST char *dn,
1503 LDAP_CONST char *newrdn,
1513 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1514 LDAP_CONST char *host,
1518 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1519 LDAP_CONST char *host,
1524 ldap_create LDAP_P((
1528 ldap_initialize LDAP_P((
1530 LDAP_CONST char *url ));
1541 ldap_tls_inplace LDAP_P((
1545 ldap_start_tls LDAP_P((
1547 LDAPControl **serverctrls,
1548 LDAPControl **clientctrls,
1552 ldap_install_tls LDAP_P((
1556 ldap_start_tls_s LDAP_P((
1558 LDAPControl **serverctrls,
1559 LDAPControl **clientctrls ));
1564 LDAP_F( LDAPMessage * )
1565 ldap_first_message LDAP_P((
1567 LDAPMessage *chain ));
1569 LDAP_F( LDAPMessage * )
1570 ldap_next_message LDAP_P((
1572 LDAPMessage *msg ));
1575 ldap_count_messages LDAP_P((
1577 LDAPMessage *chain ));
1582 LDAP_F( LDAPMessage * )
1583 ldap_first_reference LDAP_P((
1585 LDAPMessage *chain ));
1587 LDAP_F( LDAPMessage * )
1588 ldap_next_reference LDAP_P((
1590 LDAPMessage *ref ));
1593 ldap_count_references LDAP_P((
1595 LDAPMessage *chain ));
1598 ldap_parse_reference LDAP_P((
1602 LDAPControl ***serverctrls,
1609 LDAP_F( LDAPMessage * )
1610 ldap_first_entry LDAP_P((
1612 LDAPMessage *chain ));
1614 LDAP_F( LDAPMessage * )
1615 ldap_next_entry LDAP_P((
1617 LDAPMessage *entry ));
1620 ldap_count_entries LDAP_P((
1622 LDAPMessage *chain ));
1625 ldap_get_entry_controls LDAP_P((
1628 LDAPControl ***serverctrls));
1634 LDAP_F( LDAPMessage * )
1635 ldap_delete_result_entry LDAP_P((
1640 ldap_add_result_entry LDAP_P((
1649 ldap_get_dn LDAP_P((
1651 LDAPMessage *entry ));
1653 typedef struct ldap_ava {
1654 struct berval la_attr;
1655 struct berval la_value;
1657 #define LDAP_AVA_NULL 0x0000U
1658 #define LDAP_AVA_STRING 0x0001U
1659 #define LDAP_AVA_BINARY 0x0002U
1660 #define LDAP_AVA_NONPRINTABLE 0x0004U
1661 #define LDAP_AVA_FREE_ATTR 0x0010U
1662 #define LDAP_AVA_FREE_VALUE 0x0020U
1667 typedef LDAPAVA** LDAPRDN;
1668 typedef LDAPRDN* LDAPDN;
1671 #define LDAP_DN_FORMAT_LDAP 0x0000U
1672 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1673 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1674 #define LDAP_DN_FORMAT_DCE 0x0030U
1675 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1676 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1677 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1678 #define LDAP_DN_FORMAT_MASK 0x00F0U
1681 #define LDAP_DN_PRETTY 0x0100U
1682 #define LDAP_DN_SKIP 0x0200U
1683 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1684 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1685 #define LDAP_DN_PEDANTIC 0xF000U
1687 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1688 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1697 ldap_str2dn LDAP_P((
1698 LDAP_CONST char *str,
1709 ldap_dn2str LDAP_P((
1715 ldap_bv2rdn LDAP_P((
1722 ldap_str2rdn LDAP_P((
1723 LDAP_CONST char *str,
1729 ldap_rdn2bv LDAP_P((
1735 ldap_rdn2str LDAP_P((
1741 ldap_dn_normalize LDAP_P((
1742 LDAP_CONST char *in, unsigned iflags,
1743 char **out, unsigned oflags ));
1746 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1747 LDAP_CONST char *dn ));
1750 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1751 LDAP_CONST char *dn,
1755 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1756 LDAP_CONST char *rdn,
1759 typedef int LDAPDN_rewrite_func
1760 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1763 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1764 LDAPDN_rewrite_func *func, unsigned flags ));
1767 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1768 LDAP_CONST char *dn ));
1771 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1772 LDAP_CONST char *dce ));
1775 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1776 LDAP_CONST char *dn ));
1779 ldap_get_dn_ber LDAP_P((
1780 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1783 ldap_get_attribute_ber LDAP_P((
1784 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1785 struct berval **vals ));
1791 ldap_first_attribute LDAP_P((
1794 BerElement **ber ));
1797 ldap_next_attribute LDAP_P((
1806 LDAP_F( struct berval ** )
1807 ldap_get_values_len LDAP_P((
1810 LDAP_CONST char *target ));
1813 ldap_count_values_len LDAP_P((
1814 struct berval **vals ));
1817 ldap_value_free_len LDAP_P((
1818 struct berval **vals ));
1822 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1825 LDAP_CONST char *target ));
1828 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1832 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1840 ldap_result LDAP_P((
1844 struct timeval *timeout,
1845 LDAPMessage **result ));
1848 ldap_msgtype LDAP_P((
1856 ldap_msgfree LDAP_P((
1860 ldap_msgdelete LDAP_P((
1869 ldap_bv2escaped_filter_value LDAP_P((
1871 struct berval *out ));
1874 ldap_search_ext LDAP_P((
1876 LDAP_CONST char *base,
1878 LDAP_CONST char *filter,
1881 LDAPControl **serverctrls,
1882 LDAPControl **clientctrls,
1883 struct timeval *timeout,
1888 ldap_search_ext_s LDAP_P((
1890 LDAP_CONST char *base,
1892 LDAP_CONST char *filter,
1895 LDAPControl **serverctrls,
1896 LDAPControl **clientctrls,
1897 struct timeval *timeout,
1899 LDAPMessage **res ));
1903 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1905 LDAP_CONST char *base,
1907 LDAP_CONST char *filter,
1912 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1914 LDAP_CONST char *base,
1916 LDAP_CONST char *filter,
1919 LDAPMessage **res ));
1922 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1924 LDAP_CONST char *base,
1926 LDAP_CONST char *filter,
1929 struct timeval *timeout,
1930 LDAPMessage **res ));
1937 ldap_unbind_ext LDAP_P((
1939 LDAPControl **serverctrls,
1940 LDAPControl **clientctrls));
1943 ldap_unbind_ext_s LDAP_P((
1945 LDAPControl **serverctrls,
1946 LDAPControl **clientctrls));
1949 ldap_destroy LDAP_P((
1954 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1958 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1966 ldap_put_vrFilter LDAP_P((
1975 ldap_memalloc LDAP_P((
1979 ldap_memrealloc LDAP_P((
1984 ldap_memcalloc LDAP_P((
1989 ldap_memfree LDAP_P((
1993 ldap_memvfree LDAP_P((
1997 ldap_strdup LDAP_P((
1998 LDAP_CONST char * ));
2001 ldap_mods_free LDAP_P((
2008 * in sort.c (deprecated, use custom code instead)
2010 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
2011 LDAP_CONST char *left,
2012 LDAP_CONST char *right ));
2014 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
2015 LDAP_CONST void *left,
2016 LDAP_CONST void *right ));
2018 LDAP_F( int ) /* deprecated */
2019 ldap_sort_entries LDAP_P(( LDAP *ld,
2020 LDAPMessage **chain,
2021 LDAP_CONST char *attr,
2022 LDAP_SORT_AD_CMP_PROC *cmp ));
2024 LDAP_F( int ) /* deprecated */
2025 ldap_sort_values LDAP_P((
2028 LDAP_SORT_AV_CMP_PROC *cmp ));
2030 LDAP_F( int ) /* deprecated */
2031 ldap_sort_strcasecmp LDAP_P((
2033 LDAP_CONST void *b ));
2040 ldap_is_ldap_url LDAP_P((
2041 LDAP_CONST char *url ));
2044 ldap_is_ldaps_url LDAP_P((
2045 LDAP_CONST char *url ));
2048 ldap_is_ldapi_url LDAP_P((
2049 LDAP_CONST char *url ));
2052 ldap_url_parse LDAP_P((
2053 LDAP_CONST char *url,
2054 LDAPURLDesc **ludpp ));
2057 ldap_url_desc2str LDAP_P((
2058 LDAPURLDesc *ludp ));
2061 ldap_free_urldesc LDAP_P((
2062 LDAPURLDesc *ludp ));
2066 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2069 #define LDAP_API_FEATURE_CANCEL 1000
2072 ldap_cancel LDAP_P(( LDAP *ld,
2074 LDAPControl **sctrls,
2075 LDAPControl **cctrls,
2079 ldap_cancel_s LDAP_P(( LDAP *ld,
2081 LDAPControl **sctrl,
2082 LDAPControl **cctrl ));
2085 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2088 #define LDAP_API_FEATURE_TURN 1000
2091 ldap_turn LDAP_P(( LDAP *ld,
2093 LDAP_CONST char* identifier,
2094 LDAPControl **sctrls,
2095 LDAPControl **cctrls,
2099 ldap_turn_s LDAP_P(( LDAP *ld,
2101 LDAP_CONST char* identifier,
2102 LDAPControl **sctrl,
2103 LDAPControl **cctrl ));
2106 * LDAP Paged Results
2109 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2112 ldap_create_page_control_value LDAP_P((
2115 struct berval *cookie,
2116 struct berval *value ));
2119 ldap_create_page_control LDAP_P((
2122 struct berval *cookie,
2124 LDAPControl **ctrlp ));
2128 ldap_parse_page_control LDAP_P((
2129 /* deprecated, use ldap_parse_pageresponse_control */
2131 LDAPControl **ctrls,
2133 struct berval **cookie ));
2137 ldap_parse_pageresponse_control LDAP_P((
2141 struct berval *cookie ));
2144 * LDAP Server Side Sort
2147 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2149 /* structure for a sort-key */
2150 typedef struct ldapsortkey {
2151 char *attributeType;
2157 ldap_create_sort_keylist LDAP_P((
2158 LDAPSortKey ***sortKeyList,
2162 ldap_free_sort_keylist LDAP_P((
2163 LDAPSortKey **sortkeylist ));
2166 ldap_create_sort_control_value LDAP_P((
2168 LDAPSortKey **keyList,
2169 struct berval *value ));
2172 ldap_create_sort_control LDAP_P((
2174 LDAPSortKey **keyList,
2176 LDAPControl **ctrlp ));
2179 ldap_parse_sortresponse_control LDAP_P((
2183 char **attribute ));
2186 * LDAP Virtual List View
2189 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2191 /* structure for virtual list */
2192 typedef struct ldapvlvinfo {
2193 ber_int_t ldvlv_version;
2194 ber_int_t ldvlv_before_count;
2195 ber_int_t ldvlv_after_count;
2196 ber_int_t ldvlv_offset;
2197 ber_int_t ldvlv_count;
2198 struct berval * ldvlv_attrvalue;
2199 struct berval * ldvlv_context;
2200 void * ldvlv_extradata;
2204 ldap_create_vlv_control_value LDAP_P((
2206 LDAPVLVInfo *ldvlistp,
2207 struct berval *value));
2210 ldap_create_vlv_control LDAP_P((
2212 LDAPVLVInfo *ldvlistp,
2213 LDAPControl **ctrlp ));
2216 ldap_parse_vlvresponse_control LDAP_P((
2219 ber_int_t *target_posp,
2220 ber_int_t *list_countp,
2221 struct berval **contextp,
2225 * LDAP Verify Credentials
2227 #define LDAP_API_FEATURE_VERIFY_CREDENTIALS 1000
2230 ldap_verify_credentials LDAP_P((
2232 struct berval *cookie,
2233 LDAP_CONST char *dn,
2234 LDAP_CONST char *mechanism,
2235 struct berval *cred,
2236 LDAPControl **ctrls,
2237 LDAPControl **serverctrls,
2238 LDAPControl **clientctrls,
2242 ldap_verify_credentials_s LDAP_P((
2244 struct berval *cookie,
2245 LDAP_CONST char *dn,
2246 LDAP_CONST char *mechanism,
2247 struct berval *cred,
2248 LDAPControl **vcictrls,
2249 LDAPControl **serverctrls,
2250 LDAPControl **clientctrls,
2253 struct berval **scookie,
2254 struct berval **servercredp,
2255 LDAPControl ***vcoctrls));
2259 ldap_parse_verify_credentials LDAP_P((
2264 struct berval **cookie,
2265 struct berval **servercredp,
2266 LDAPControl ***vcctrls));
2272 #define LDAP_API_FEATURE_WHOAMI 1000
2275 ldap_parse_whoami LDAP_P((
2278 struct berval **authzid ));
2281 ldap_whoami LDAP_P(( LDAP *ld,
2282 LDAPControl **sctrls,
2283 LDAPControl **cctrls,
2287 ldap_whoami_s LDAP_P((
2289 struct berval **authzid,
2290 LDAPControl **sctrls,
2291 LDAPControl **cctrls ));
2294 * LDAP Password Modify
2297 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2300 ldap_parse_passwd LDAP_P((
2303 struct berval *newpasswd ));
2306 ldap_passwd LDAP_P(( LDAP *ld,
2307 struct berval *user,
2308 struct berval *oldpw,
2309 struct berval *newpw,
2310 LDAPControl **sctrls,
2311 LDAPControl **cctrls,
2315 ldap_passwd_s LDAP_P((
2317 struct berval *user,
2318 struct berval *oldpw,
2319 struct berval *newpw,
2320 struct berval *newpasswd,
2321 LDAPControl **sctrls,
2322 LDAPControl **cctrls ));
2324 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2326 * LDAP Password Policy controls
2329 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2331 typedef enum passpolicyerror_enum {
2332 PP_passwordExpired = 0,
2333 PP_accountLocked = 1,
2334 PP_changeAfterReset = 2,
2335 PP_passwordModNotAllowed = 3,
2336 PP_mustSupplyOldPassword = 4,
2337 PP_insufficientPasswordQuality = 5,
2338 PP_passwordTooShort = 6,
2339 PP_passwordTooYoung = 7,
2340 PP_passwordInHistory = 8,
2342 } LDAPPasswordPolicyError;
2345 ldap_create_passwordpolicy_control LDAP_P((
2347 LDAPControl **ctrlp ));
2350 ldap_parse_passwordpolicy_control LDAP_P((
2355 LDAPPasswordPolicyError *errorp ));
2357 LDAP_F( const char * )
2358 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2359 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2362 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2365 #define LDAP_API_FEATURE_REFRESH 1000
2368 ldap_parse_refresh LDAP_P((
2371 ber_int_t *newttl ));
2374 ldap_refresh LDAP_P(( LDAP *ld,
2377 LDAPControl **sctrls,
2378 LDAPControl **cctrls,
2382 ldap_refresh_s LDAP_P((
2387 LDAPControl **sctrls,
2388 LDAPControl **cctrls ));
2395 ldap_txn_start LDAP_P(( LDAP *ld,
2396 LDAPControl **sctrls,
2397 LDAPControl **cctrls,
2401 ldap_txn_start_s LDAP_P(( LDAP *ld,
2402 LDAPControl **sctrl,
2403 LDAPControl **cctrl,
2404 struct berval **rettxnid ));
2407 ldap_txn_end LDAP_P(( LDAP *ld,
2409 struct berval *txnid,
2410 LDAPControl **sctrls,
2411 LDAPControl **cctrls,
2415 ldap_txn_end_s LDAP_P(( LDAP *ld,
2417 struct berval *txnid,
2418 LDAPControl **sctrl,
2419 LDAPControl **cctrl,
2428 * initialize the persistent search structure
2430 LDAP_F( ldap_sync_t * )
2431 ldap_sync_initialize LDAP_P((
2435 * destroy the persistent search structure
2438 ldap_sync_destroy LDAP_P((
2443 * initialize a refreshOnly sync
2446 ldap_sync_init LDAP_P((
2451 * initialize a refreshOnly sync
2454 ldap_sync_init_refresh_only LDAP_P((
2458 * initialize a refreshAndPersist sync
2461 ldap_sync_init_refresh_and_persist LDAP_P((
2465 * poll for new responses
2468 ldap_sync_poll LDAP_P((
2471 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2477 ldap_create_session_tracking_value LDAP_P((
2479 char *sessionSourceIp,
2480 char *sessionSourceName,
2482 struct berval *sessionTrackingIdentifier,
2483 struct berval *value ));
2486 ldap_create_session_tracking LDAP_P((
2488 char *sessionSourceIp,
2489 char *sessionSourceName,
2491 struct berval *sessionTrackingIdentifier,
2492 LDAPControl **ctrlp ));
2495 ldap_parse_session_tracking_control LDAP_P((
2499 struct berval *name,
2501 struct berval *id ));
2503 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2509 ldap_create_assertion_control_value LDAP_P((
2512 struct berval *value ));
2515 ldap_create_assertion_control LDAP_P((
2519 LDAPControl **ctrlp ));
2525 typedef struct LDAPDerefSpec {
2530 typedef struct LDAPDerefVal {
2533 struct LDAPDerefVal *next;
2536 typedef struct LDAPDerefRes {
2538 struct berval derefVal;
2539 LDAPDerefVal *attrVals;
2540 struct LDAPDerefRes *next;
2544 ldap_create_deref_control_value LDAP_P((
2547 struct berval *value ));
2550 ldap_create_deref_control LDAP_P((
2554 LDAPControl **ctrlp ));
2557 ldap_derefresponse_free LDAP_P((
2558 LDAPDerefRes *dr ));
2561 ldap_parse_derefresponse_control LDAP_P((
2564 LDAPDerefRes **drp ));
2567 ldap_parse_deref_control LDAP_P((
2569 LDAPControl **ctrls,
2570 LDAPDerefRes **drp ));
2573 * high level LDIF to LDAP structure support
2575 #define LDIF_DEFAULT_ADD 0x01 /* if changetype missing, assume LDAP_ADD */
2576 #define LDIF_ENTRIES_ONLY 0x02 /* ignore changetypes other than add */
2577 #define LDIF_NO_CONTROLS 0x04 /* ignore control specifications */
2579 typedef struct ldifrecord {
2580 ber_tag_t lr_op; /* type of operation - LDAP_REQ_MODIFY, LDAP_REQ_ADD, etc. */
2581 struct berval lr_dn; /* DN of operation */
2582 LDAPControl **lr_ctrls; /* controls specified for operation */
2583 /* some ops such as LDAP_REQ_DELETE require only a DN */
2584 /* other ops require different data - the ldif_ops union
2585 is used to specify the data for each type of operation */
2587 LDAPMod **lr_mods; /* list of mods for LDAP_REQ_MODIFY, LDAP_REQ_ADD */
2588 #define lrop_mods ldif_ops.lr_mods
2589 struct ldif_op_rename_s {
2590 struct berval lr_newrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2591 #define lrop_newrdn ldif_ops.ldif_op_rename.lr_newrdn
2592 struct berval lr_newsuperior; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2593 #define lrop_newsup ldif_ops.ldif_op_rename.lr_newsuperior
2594 int lr_deleteoldrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2595 #define lrop_delold ldif_ops.ldif_op_rename.lr_deleteoldrdn
2596 } ldif_op_rename; /* rename/moddn/modrdn */
2597 /* the following are for future support */
2598 struct ldif_op_ext_s {
2599 struct berval lr_extop_oid; /* LDAP_REQ_EXTENDED */
2600 #define lrop_extop_oid ldif_ops.ldif_op_ext.lr_extop_oid
2601 struct berval lr_extop_data; /* LDAP_REQ_EXTENDED */
2602 #define lrop_extop_data ldif_ops.ldif_op_ext.lr_extop_data
2603 } ldif_op_ext; /* extended operation */
2604 struct ldif_op_cmp_s {
2605 struct berval lr_cmp_attr; /* LDAP_REQ_COMPARE */
2606 #define lrop_cmp_attr ldif_ops.ldif_op_cmp.lr_cmp_attr
2607 struct berval lr_cmp_bvalue; /* LDAP_REQ_COMPARE */
2608 #define lrop_cmp_bval ldif_ops.ldif_op_cmp.lr_cmp_bvalue
2609 } ldif_op_cmp; /* compare operation */
2611 /* PRIVATE STUFF - DO NOT TOUCH */
2612 /* for efficiency, the implementation allocates memory */
2613 /* in large blobs, and makes the above fields point to */
2614 /* locations inside those blobs - one consequence is that */
2615 /* you cannot simply free the above allocated fields, nor */
2616 /* assign them to be owned by another memory context which */
2617 /* might free them (unless providing your own mem ctx) */
2618 /* we use the fields below to keep track of those blobs */
2619 /* so we that we can free them later */
2620 void *lr_ctx; /* the memory context or NULL */
2623 unsigned char *lr_mops;
2625 struct berval *lr_vals;
2626 struct berval *lr_btype;
2629 /* free internal fields - does not free the LDIFRecord */
2631 ldap_ldif_record_done LDAP_P((
2635 ldap_parse_ldif_record LDAP_P((
2636 struct berval *rbuf,
2640 unsigned int flags ));
2643 #endif /* _LDAP_H */