2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2013 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 */
160 #define LDAP_OPT_X_TLS_PACKAGE 0x6011
161 #define LDAP_OPT_X_TLS_ECNAME 0x6012
163 #define LDAP_OPT_X_TLS_NEVER 0
164 #define LDAP_OPT_X_TLS_HARD 1
165 #define LDAP_OPT_X_TLS_DEMAND 2
166 #define LDAP_OPT_X_TLS_ALLOW 3
167 #define LDAP_OPT_X_TLS_TRY 4
169 #define LDAP_OPT_X_TLS_CRL_NONE 0
170 #define LDAP_OPT_X_TLS_CRL_PEER 1
171 #define LDAP_OPT_X_TLS_CRL_ALL 2
173 /* for LDAP_OPT_X_TLS_PROTOCOL_MIN */
174 #define LDAP_OPT_X_TLS_PROTOCOL(maj,min) (((maj) << 8) + (min))
175 #define LDAP_OPT_X_TLS_PROTOCOL_SSL2 (2 << 8)
176 #define LDAP_OPT_X_TLS_PROTOCOL_SSL3 (3 << 8)
177 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_0 ((3 << 8) + 1)
178 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_1 ((3 << 8) + 2)
179 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_2 ((3 << 8) + 3)
181 /* OpenLDAP SASL options */
182 #define LDAP_OPT_X_SASL_MECH 0x6100
183 #define LDAP_OPT_X_SASL_REALM 0x6101
184 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
185 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
186 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
187 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
188 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
189 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
190 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
191 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
192 #define LDAP_OPT_X_SASL_MECHLIST 0x610a /* read-only */
193 #define LDAP_OPT_X_SASL_NOCANON 0x610b
194 #define LDAP_OPT_X_SASL_USERNAME 0x610c /* read-only */
195 #define LDAP_OPT_X_SASL_GSS_CREDS 0x610d
197 /* OpenLDAP GSSAPI options */
198 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT 0x6200
199 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL 0x6201
202 * OpenLDAP per connection tcp-keepalive settings
203 * (Linux only, ignored where unsupported)
205 #define LDAP_OPT_X_KEEPALIVE_IDLE 0x6300
206 #define LDAP_OPT_X_KEEPALIVE_PROBES 0x6301
207 #define LDAP_OPT_X_KEEPALIVE_INTERVAL 0x6302
209 /* Private API Extensions -- reserved for application use */
210 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
213 * ldap_get_option() and ldap_set_option() return values.
214 * As later versions may return other values indicating
215 * failure, current applications should only compare returned
216 * value against LDAP_OPT_SUCCESS.
218 #define LDAP_OPT_SUCCESS 0
219 #define LDAP_OPT_ERROR (-1)
221 /* option on/off values */
222 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
223 #define LDAP_OPT_OFF ((void *) 0)
225 typedef struct ldapapiinfo {
226 int ldapai_info_version; /* version of LDAPAPIInfo */
227 #define LDAP_API_INFO_VERSION (1)
228 int ldapai_api_version; /* revision of API supported */
229 int ldapai_protocol_version; /* highest LDAP version supported */
230 char **ldapai_extensions; /* names of API extensions */
231 char *ldapai_vendor_name; /* name of supplier */
232 int ldapai_vendor_version; /* supplier-specific version * 100 */
235 typedef struct ldap_apifeature_info {
236 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
237 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
238 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
239 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
240 } LDAPAPIFeatureInfo;
243 * LDAP Control structure
245 typedef struct ldapcontrol {
246 char * ldctl_oid; /* numericoid of control */
247 struct berval ldctl_value; /* encoded value of control */
248 char ldctl_iscritical; /* criticality */
252 /* standard track controls */
253 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
254 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
255 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
257 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
259 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
260 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
261 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
263 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
264 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
266 /* non-standard track controls */
267 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
269 #define LDAP_CONTROL_AUTHZID_REQUEST "2.16.840.1.113730.4.16" /* RFC 3829 */
270 #define LDAP_CONTROL_AUTHZID_RESPONSE "2.16.840.1.113730.4.15" /* RFC 3829 */
272 /* LDAP Content Synchronization Operation -- RFC 4533 */
273 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
274 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
275 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
276 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
277 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
279 #define LDAP_SYNC_NONE 0x00
280 #define LDAP_SYNC_REFRESH_ONLY 0x01
281 #define LDAP_SYNC_RESERVED 0x02
282 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
284 #define LDAP_SYNC_REFRESH_PRESENTS 0
285 #define LDAP_SYNC_REFRESH_DELETES 1
287 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
288 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
289 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
290 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
292 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
293 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
294 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
295 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
297 #define LDAP_SYNC_PRESENT 0
298 #define LDAP_SYNC_ADD 1
299 #define LDAP_SYNC_MODIFY 2
300 #define LDAP_SYNC_DELETE 3
301 #define LDAP_SYNC_NEW_COOKIE 4
303 /* LDAP Don't Use Copy Control (RFC 6171) */
304 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.1.22"
306 /* Password policy Controls *//* work in progress */
307 /* ITS#3458: released; disabled by default */
308 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
309 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
311 /* various works in progress */
312 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
313 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
314 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
315 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
316 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
317 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
318 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
319 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
321 /* LDAP Chaining Behavior Control *//* work in progress */
322 /* <draft-sermersheim-ldap-chaining>;
323 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
324 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
326 #define LDAP_CHAINING_PREFERRED 0
327 #define LDAP_CHAINING_REQUIRED 1
328 #define LDAP_REFERRALS_PREFERRED 2
329 #define LDAP_REFERRALS_REQUIRED 3
331 /* MS Active Directory controls (for compatibility) */
332 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
333 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
334 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
335 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
336 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
337 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
338 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
340 /* MS Active Directory controls - not implemented in slapd(8) */
341 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
343 /* <draft-wahl-ldap-session> */
344 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
345 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
346 LDAP_CONTROL_X_SESSION_TRACKING ".1"
347 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
348 LDAP_CONTROL_X_SESSION_TRACKING ".2"
349 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
350 LDAP_CONTROL_X_SESSION_TRACKING ".3"
351 /* various expired works */
353 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
354 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
355 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
356 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
357 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
359 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
360 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
361 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
362 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
363 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
364 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
365 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
368 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
369 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
371 /* LDAP Unsolicited Notifications */
372 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
373 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
375 /* LDAP Extended Operations */
376 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
378 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
379 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
380 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
381 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
382 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
384 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
385 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
387 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
388 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
389 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
390 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x81U)
392 #define LDAP_EXOP_VERIFY_CREDENTIALS "1.3.6.1.4.1.4203.666.6.5"
393 #define LDAP_EXOP_X_VERIFY_CREDENTIALS LDAP_EXOP_VERIFY_CREDENTIALS
395 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_COOKIE ((ber_tag_t) 0x80U)
396 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_SCREDS ((ber_tag_t) 0x81U)
397 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_CONTROLS ((ber_tag_t) 0xa2U) /* context specific + constructed + 2 */
399 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
400 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
402 /* various works in progress */
403 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
404 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
406 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
407 /* a work in progress */
408 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
409 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
410 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
411 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
412 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
413 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
414 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
415 LDAP_X_DISTPROC_BASE ".6"
416 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
417 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
418 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
419 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
420 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
423 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
424 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
425 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
426 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
427 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
431 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
432 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
433 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
434 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
435 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
436 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
437 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
439 /* LDAP Experimental (works in progress) Features */
440 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
441 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
442 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
445 * specific LDAP instantiations of BER types we know about
448 /* Overview of LBER tag construction
455 * 1 0 = CONTEXT-SPECIFIC
462 * | 5 ... 1 | TAG-NUMBER
466 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
467 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
469 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
470 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
472 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
473 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
475 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
477 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
478 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
479 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
480 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
482 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
483 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
485 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
487 /* LDAP Request Messages */
488 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
489 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
490 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
491 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
492 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
493 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
494 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
495 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
496 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
497 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
498 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
499 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
501 /* LDAP Response Messages */
502 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
503 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
504 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
505 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
506 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
507 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
508 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
509 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
510 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
511 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
512 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
513 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
514 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
516 #define LDAP_RES_ANY (-1)
517 #define LDAP_RES_UNSOLICITED (0)
521 #define LDAP_SASL_SIMPLE ((char*)0)
522 #define LDAP_SASL_NULL ("")
525 /* authentication methods available */
526 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
527 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
528 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
529 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
530 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
531 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
533 /* used by the Windows API but not used on the wire */
534 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
537 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
538 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
539 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
540 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
541 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
542 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
543 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
544 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
545 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
546 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
548 /* extended filter component types */
549 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
550 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
551 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
552 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
554 /* substring filter component types */
555 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
556 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
557 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
560 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
561 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
562 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
563 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
564 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
565 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
566 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
567 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
568 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
570 /* substring filter component types */
571 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
572 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
573 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
578 #define LDAP_SUCCESS 0x00
580 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
582 #define LDAP_OPERATIONS_ERROR 0x01
583 #define LDAP_PROTOCOL_ERROR 0x02
584 #define LDAP_TIMELIMIT_EXCEEDED 0x03
585 #define LDAP_SIZELIMIT_EXCEEDED 0x04
586 #define LDAP_COMPARE_FALSE 0x05
587 #define LDAP_COMPARE_TRUE 0x06
588 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
589 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
590 #define LDAP_STRONG_AUTH_REQUIRED 0x08
591 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
592 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
594 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
595 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
596 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
597 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
598 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
600 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
602 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
603 #define LDAP_UNDEFINED_TYPE 0x11
604 #define LDAP_INAPPROPRIATE_MATCHING 0x12
605 #define LDAP_CONSTRAINT_VIOLATION 0x13
606 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
607 #define LDAP_INVALID_SYNTAX 0x15
609 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
611 #define LDAP_NO_SUCH_OBJECT 0x20
612 #define LDAP_ALIAS_PROBLEM 0x21
613 #define LDAP_INVALID_DN_SYNTAX 0x22
614 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
615 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
617 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
619 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
620 #define LDAP_INAPPROPRIATE_AUTH 0x30
621 #define LDAP_INVALID_CREDENTIALS 0x31
622 #define LDAP_INSUFFICIENT_ACCESS 0x32
624 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
626 #define LDAP_BUSY 0x33
627 #define LDAP_UNAVAILABLE 0x34
628 #define LDAP_UNWILLING_TO_PERFORM 0x35
629 #define LDAP_LOOP_DETECT 0x36
631 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
633 #define LDAP_NAMING_VIOLATION 0x40
634 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
635 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
636 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
637 #define LDAP_ALREADY_EXISTS 0x44
638 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
639 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
640 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
642 #define LDAP_VLV_ERROR 0x4C
644 #define LDAP_OTHER 0x50
646 /* LCUP operation codes (113-117) - not implemented */
647 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
648 #define LDAP_CUP_SECURITY_VIOLATION 0x72
649 #define LDAP_CUP_INVALID_DATA 0x73
650 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
651 #define LDAP_CUP_RELOAD_REQUIRED 0x75
653 /* Cancel operation codes (118-121) */
654 #define LDAP_CANCELLED 0x76
655 #define LDAP_NO_SUCH_OPERATION 0x77
656 #define LDAP_TOO_LATE 0x78
657 #define LDAP_CANNOT_CANCEL 0x79
659 /* Assertion control (122) */
660 #define LDAP_ASSERTION_FAILED 0x7A
662 /* Proxied Authorization Denied (123) */
663 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
665 /* Experimental result codes */
666 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
668 /* LDAP Sync (4096) */
669 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
672 /* Private Use result codes */
673 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
675 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
676 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
678 /* for the LDAP No-Op control */
679 #define LDAP_X_NO_OPERATION 0x410e
681 /* for the Chaining Behavior control (consecutive result codes requested;
682 * see <draft-sermersheim-ldap-chaining> ) */
683 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
684 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
685 #define LDAP_X_CANNOT_CHAIN 0x4111
688 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
689 #ifdef LDAP_X_DISTPROC_BASE
690 #define LDAP_X_INVALIDREFERENCE 0x4112
694 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
695 #define LDAP_X_TXN_ID_INVALID 0x4121
700 * Based on draft-ietf-ldap-c-api-xx
701 * but with new negative code values
703 #define LDAP_API_ERROR(n) ((n)<0)
704 #define LDAP_API_RESULT(n) ((n)<=0)
706 #define LDAP_SERVER_DOWN (-1)
707 #define LDAP_LOCAL_ERROR (-2)
708 #define LDAP_ENCODING_ERROR (-3)
709 #define LDAP_DECODING_ERROR (-4)
710 #define LDAP_TIMEOUT (-5)
711 #define LDAP_AUTH_UNKNOWN (-6)
712 #define LDAP_FILTER_ERROR (-7)
713 #define LDAP_USER_CANCELLED (-8)
714 #define LDAP_PARAM_ERROR (-9)
715 #define LDAP_NO_MEMORY (-10)
716 #define LDAP_CONNECT_ERROR (-11)
717 #define LDAP_NOT_SUPPORTED (-12)
718 #define LDAP_CONTROL_NOT_FOUND (-13)
719 #define LDAP_NO_RESULTS_RETURNED (-14)
720 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
721 #define LDAP_CLIENT_LOOP (-16)
722 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
723 #define LDAP_X_CONNECTING (-18)
727 * This structure represents both ldap messages and ldap responses.
728 * These are really the same, except in the case of search responses,
729 * where a response has multiple messages.
732 typedef struct ldapmsg LDAPMessage;
734 /* for modifications */
735 typedef struct ldapmod {
738 #define LDAP_MOD_OP (0x0007)
739 #define LDAP_MOD_ADD (0x0000)
740 #define LDAP_MOD_DELETE (0x0001)
741 #define LDAP_MOD_REPLACE (0x0002)
742 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
743 #define LDAP_MOD_BVALUES (0x0080)
744 /* IMPORTANT: do not use code 0x1000 (or above),
745 * it is used internally by the backends!
746 * (see ldap/servers/slapd/slap.h)
752 struct berval **modv_bvals;
754 #define mod_values mod_vals.modv_strvals
755 #define mod_bvalues mod_vals.modv_bvals
759 * structure representing an ldap session which can
760 * encompass connections to multiple servers (in the
761 * face of referrals).
763 typedef struct ldap LDAP;
765 #define LDAP_DEREF_NEVER 0x00
766 #define LDAP_DEREF_SEARCHING 0x01
767 #define LDAP_DEREF_FINDING 0x02
768 #define LDAP_DEREF_ALWAYS 0x03
770 #define LDAP_NO_LIMIT 0
772 /* how many messages to retrieve results for */
773 #define LDAP_MSG_ONE 0x00
774 #define LDAP_MSG_ALL 0x01
775 #define LDAP_MSG_RECEIVED 0x02
778 * types for ldap URL handling
780 typedef struct ldap_url_desc {
781 struct ldap_url_desc *lud_next;
793 #define LDAP_URL_SUCCESS 0x00 /* Success */
794 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
795 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
797 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
798 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
799 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
800 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
801 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
802 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
803 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
804 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
807 * LDAP sync (RFC4533) API
810 typedef struct ldap_sync_t ldap_sync_t;
813 /* these are private - the client should never see them */
814 LDAP_SYNC_CAPI_NONE = -1,
816 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
817 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
818 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
820 /* these are passed to ls_search_entry() */
821 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
822 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
823 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
824 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
826 /* these are passed to ls_intermediate() */
827 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
828 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
830 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
831 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
833 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
834 } ldap_sync_refresh_t;
837 * Called when an entry is returned by ldap_result().
838 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
839 * the entry has been either added or modified, and thus
840 * the complete view of the entry should be in the LDAPMessage.
841 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
842 * only the DN should be in the LDAPMessage.
844 typedef int (*ldap_sync_search_entry_f) LDAP_P((
847 struct berval *entryUUID,
848 ldap_sync_refresh_t phase ));
851 * Called when a reference is returned; the client should know
852 * what to do with it.
854 typedef int (*ldap_sync_search_reference_f) LDAP_P((
859 * Called when specific intermediate/final messages are returned.
860 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
861 * a "presents" or "deletes" phase begins.
862 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
863 * with refreshDone set to "TRUE" has been returned, to indicate
864 * that the refresh phase of a refreshAndPersist is complete.
865 * In the above cases, syncUUIDs is NULL.
867 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
868 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
869 * that are either present or have been deleted.
871 typedef int (*ldap_sync_intermediate_f) LDAP_P((
875 ldap_sync_refresh_t phase ));
878 * Called when a searchResultDone is returned. In refreshAndPersist,
879 * this can only occur if the search for any reason is being terminated
882 typedef int (*ldap_sync_search_result_f) LDAP_P((
885 int refreshDeletes ));
888 * This structure contains all information about the persistent search;
889 * the caller is responsible for connecting, setting version, binding, tls...
892 /* conf search params */
903 /* helpers - add as appropriate */
904 ldap_sync_search_entry_f ls_search_entry;
905 ldap_sync_search_reference_f ls_search_reference;
906 ldap_sync_intermediate_f ls_intermediate;
907 ldap_sync_search_result_f ls_search_result;
909 /* set by the caller as appropriate */
915 /* --- the parameters below are private - do not modify --- */
917 /* FIXME: make the structure opaque, and provide an interface
918 * to modify the public values? */
924 /* needed by refreshOnly */
927 /* opaque - need to pass between sessions, updated by the API */
928 struct berval ls_cookie;
930 /* state variable - do not modify */
931 ldap_sync_refresh_t ls_refreshPhase;
935 * End of LDAP sync (RFC4533) API
939 * Connection callbacks...
944 /* Called after a connection is established */
945 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
946 struct ldap_conncb *ctx ));
947 /* Called before a connection is closed */
948 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
950 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
951 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
953 typedef struct ldap_conncb {
954 ldap_conn_add_f *lc_add;
955 ldap_conn_del_f *lc_del;
960 * The API draft spec says we should declare (or cause to be declared)
961 * 'struct timeval'. We don't. See IETF LDAPext discussions.
969 ldap_get_option LDAP_P((
975 ldap_set_option LDAP_P((
978 LDAP_CONST void *invalue));
980 /* V3 REBIND Function Callback Prototype */
981 typedef int (LDAP_REBIND_PROC) LDAP_P((
982 LDAP *ld, LDAP_CONST char *url,
983 ber_tag_t request, ber_int_t msgid,
987 ldap_set_rebind_proc LDAP_P((
989 LDAP_REBIND_PROC *rebind_proc,
992 /* V3 referral selection Function Callback Prototype */
993 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
994 LDAP *ld, char ***refsp, int *cntp,
998 ldap_set_nextref_proc LDAP_P((
1000 LDAP_NEXTREF_PROC *nextref_proc,
1003 /* V3 URLLIST Function Callback Prototype */
1004 typedef int (LDAP_URLLIST_PROC) LDAP_P((
1006 LDAPURLDesc **urllist,
1011 ldap_set_urllist_proc LDAP_P((
1013 LDAP_URLLIST_PROC *urllist_proc,
1021 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
1022 LDAP_CONST char *requestOID,
1025 LDAPControl **ctrlp ));
1027 LDAP_F( LDAPControl * )
1028 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
1029 LDAP_CONST char *oid,
1030 LDAPControl **ctrls ));
1034 ldap_control_create LDAP_P((
1035 LDAP_CONST char *requestOID,
1037 struct berval *value,
1039 LDAPControl **ctrlp ));
1041 LDAP_F( LDAPControl * )
1042 ldap_control_find LDAP_P((
1043 LDAP_CONST char *oid,
1044 LDAPControl **ctrls,
1045 LDAPControl ***nextctrlp ));
1048 ldap_control_free LDAP_P((
1049 LDAPControl *ctrl ));
1052 ldap_controls_free LDAP_P((
1053 LDAPControl **ctrls ));
1055 LDAP_F( LDAPControl ** )
1056 ldap_controls_dup LDAP_P((
1057 LDAPControl *LDAP_CONST *controls ));
1059 LDAP_F( LDAPControl * )
1060 ldap_control_dup LDAP_P((
1061 LDAP_CONST LDAPControl *c ));
1067 ldap_domain2dn LDAP_P((
1068 LDAP_CONST char* domain,
1072 ldap_dn2domain LDAP_P((
1073 LDAP_CONST char* dn,
1077 ldap_domain2hostlist LDAP_P((
1078 LDAP_CONST char *domain,
1085 ldap_extended_operation LDAP_P((
1087 LDAP_CONST char *reqoid,
1088 struct berval *reqdata,
1089 LDAPControl **serverctrls,
1090 LDAPControl **clientctrls,
1094 ldap_extended_operation_s LDAP_P((
1096 LDAP_CONST char *reqoid,
1097 struct berval *reqdata,
1098 LDAPControl **serverctrls,
1099 LDAPControl **clientctrls,
1101 struct berval **retdatap ));
1104 ldap_parse_extended_result LDAP_P((
1108 struct berval **retdatap,
1112 ldap_parse_intermediate LDAP_P((
1116 struct berval **retdatap,
1117 LDAPControl ***serverctrls,
1125 ldap_abandon_ext LDAP_P((
1128 LDAPControl **serverctrls,
1129 LDAPControl **clientctrls ));
1133 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1142 ldap_add_ext LDAP_P((
1144 LDAP_CONST char *dn,
1146 LDAPControl **serverctrls,
1147 LDAPControl **clientctrls,
1151 ldap_add_ext_s LDAP_P((
1153 LDAP_CONST char *dn,
1155 LDAPControl **serverctrls,
1156 LDAPControl **clientctrls ));
1160 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1162 LDAP_CONST char *dn,
1166 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1168 LDAP_CONST char *dn,
1177 ldap_sasl_bind LDAP_P((
1179 LDAP_CONST char *dn,
1180 LDAP_CONST char *mechanism,
1181 struct berval *cred,
1182 LDAPControl **serverctrls,
1183 LDAPControl **clientctrls,
1186 /* Interaction flags (should be passed about in a control)
1187 * Automatic (default): use defaults, prompt otherwise
1188 * Interactive: prompt always
1189 * Quiet: never prompt
1191 #define LDAP_SASL_AUTOMATIC 0U
1192 #define LDAP_SASL_INTERACTIVE 1U
1193 #define LDAP_SASL_QUIET 2U
1196 * V3 SASL Interaction Function Callback Prototype
1197 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1198 * should likely passed in a control (and provided controls)
1200 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1201 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1204 ldap_sasl_interactive_bind LDAP_P((
1206 LDAP_CONST char *dn, /* usually NULL */
1207 LDAP_CONST char *saslMechanism,
1208 LDAPControl **serverControls,
1209 LDAPControl **clientControls,
1211 /* should be client controls */
1213 LDAP_SASL_INTERACT_PROC *proc,
1216 /* as obtained from ldap_result() */
1217 LDAPMessage *result,
1219 /* returned during bind processing */
1224 ldap_sasl_interactive_bind_s LDAP_P((
1226 LDAP_CONST char *dn, /* usually NULL */
1227 LDAP_CONST char *saslMechanism,
1228 LDAPControl **serverControls,
1229 LDAPControl **clientControls,
1231 /* should be client controls */
1233 LDAP_SASL_INTERACT_PROC *proc,
1237 ldap_sasl_bind_s LDAP_P((
1239 LDAP_CONST char *dn,
1240 LDAP_CONST char *mechanism,
1241 struct berval *cred,
1242 LDAPControl **serverctrls,
1243 LDAPControl **clientctrls,
1244 struct berval **servercredp ));
1247 ldap_parse_sasl_bind_result LDAP_P((
1250 struct berval **servercredp,
1259 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1261 LDAP_CONST char *who,
1262 LDAP_CONST char *passwd,
1266 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1268 LDAP_CONST char *who,
1269 LDAP_CONST char *cred,
1276 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1278 LDAP_CONST char *who,
1279 LDAP_CONST char *passwd ));
1282 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1284 LDAP_CONST char *who,
1285 LDAP_CONST char *passwd ));
1294 ldap_compare_ext LDAP_P((
1296 LDAP_CONST char *dn,
1297 LDAP_CONST char *attr,
1298 struct berval *bvalue,
1299 LDAPControl **serverctrls,
1300 LDAPControl **clientctrls,
1304 ldap_compare_ext_s LDAP_P((
1306 LDAP_CONST char *dn,
1307 LDAP_CONST char *attr,
1308 struct berval *bvalue,
1309 LDAPControl **serverctrls,
1310 LDAPControl **clientctrls ));
1314 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1316 LDAP_CONST char *dn,
1317 LDAP_CONST char *attr,
1318 LDAP_CONST char *value ));
1321 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1323 LDAP_CONST char *dn,
1324 LDAP_CONST char *attr,
1325 LDAP_CONST char *value ));
1333 ldap_delete_ext LDAP_P((
1335 LDAP_CONST char *dn,
1336 LDAPControl **serverctrls,
1337 LDAPControl **clientctrls,
1341 ldap_delete_ext_s LDAP_P((
1343 LDAP_CONST char *dn,
1344 LDAPControl **serverctrls,
1345 LDAPControl **clientctrls ));
1349 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1351 LDAP_CONST char *dn ));
1354 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1356 LDAP_CONST char *dn ));
1364 ldap_parse_result LDAP_P((
1371 LDAPControl ***serverctrls,
1375 ldap_err2string LDAP_P((
1380 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1386 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1388 LDAP_CONST char *s ));
1396 ldap_gssapi_bind LDAP_P((
1398 LDAP_CONST char *dn,
1399 LDAP_CONST char *creds ));
1402 ldap_gssapi_bind_s LDAP_P((
1404 LDAP_CONST char *dn,
1405 LDAP_CONST char *creds ));
1412 ldap_modify_ext LDAP_P((
1414 LDAP_CONST char *dn,
1416 LDAPControl **serverctrls,
1417 LDAPControl **clientctrls,
1421 ldap_modify_ext_s LDAP_P((
1423 LDAP_CONST char *dn,
1425 LDAPControl **serverctrls,
1426 LDAPControl **clientctrls ));
1430 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1432 LDAP_CONST char *dn,
1436 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1438 LDAP_CONST char *dn,
1447 ldap_rename LDAP_P((
1449 LDAP_CONST char *dn,
1450 LDAP_CONST char *newrdn,
1451 LDAP_CONST char *newSuperior,
1453 LDAPControl **sctrls,
1454 LDAPControl **cctrls,
1458 ldap_rename_s LDAP_P((
1460 LDAP_CONST char *dn,
1461 LDAP_CONST char *newrdn,
1462 LDAP_CONST char *newSuperior,
1464 LDAPControl **sctrls,
1465 LDAPControl **cctrls ));
1469 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1471 LDAP_CONST char *dn,
1472 LDAP_CONST char *newrdn,
1473 LDAP_CONST char *newSuperior,
1474 int deleteoldrdn ));
1477 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1479 LDAP_CONST char *dn,
1480 LDAP_CONST char *newrdn,
1481 LDAP_CONST char *newSuperior,
1482 int deleteoldrdn ));
1485 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1487 LDAP_CONST char *dn,
1488 LDAP_CONST char *newrdn ));
1491 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1493 LDAP_CONST char *dn,
1494 LDAP_CONST char *newrdn ));
1497 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1499 LDAP_CONST char *dn,
1500 LDAP_CONST char *newrdn,
1501 int deleteoldrdn ));
1504 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1506 LDAP_CONST char *dn,
1507 LDAP_CONST char *newrdn,
1517 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1518 LDAP_CONST char *host,
1522 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1523 LDAP_CONST char *host,
1528 ldap_create LDAP_P((
1532 ldap_initialize LDAP_P((
1534 LDAP_CONST char *url ));
1545 ldap_tls_inplace LDAP_P((
1549 ldap_start_tls LDAP_P((
1551 LDAPControl **serverctrls,
1552 LDAPControl **clientctrls,
1556 ldap_install_tls LDAP_P((
1560 ldap_start_tls_s LDAP_P((
1562 LDAPControl **serverctrls,
1563 LDAPControl **clientctrls ));
1568 LDAP_F( LDAPMessage * )
1569 ldap_first_message LDAP_P((
1571 LDAPMessage *chain ));
1573 LDAP_F( LDAPMessage * )
1574 ldap_next_message LDAP_P((
1576 LDAPMessage *msg ));
1579 ldap_count_messages LDAP_P((
1581 LDAPMessage *chain ));
1586 LDAP_F( LDAPMessage * )
1587 ldap_first_reference LDAP_P((
1589 LDAPMessage *chain ));
1591 LDAP_F( LDAPMessage * )
1592 ldap_next_reference LDAP_P((
1594 LDAPMessage *ref ));
1597 ldap_count_references LDAP_P((
1599 LDAPMessage *chain ));
1602 ldap_parse_reference LDAP_P((
1606 LDAPControl ***serverctrls,
1613 LDAP_F( LDAPMessage * )
1614 ldap_first_entry LDAP_P((
1616 LDAPMessage *chain ));
1618 LDAP_F( LDAPMessage * )
1619 ldap_next_entry LDAP_P((
1621 LDAPMessage *entry ));
1624 ldap_count_entries LDAP_P((
1626 LDAPMessage *chain ));
1629 ldap_get_entry_controls LDAP_P((
1632 LDAPControl ***serverctrls));
1638 LDAP_F( LDAPMessage * )
1639 ldap_delete_result_entry LDAP_P((
1644 ldap_add_result_entry LDAP_P((
1653 ldap_get_dn LDAP_P((
1655 LDAPMessage *entry ));
1657 typedef struct ldap_ava {
1658 struct berval la_attr;
1659 struct berval la_value;
1661 #define LDAP_AVA_NULL 0x0000U
1662 #define LDAP_AVA_STRING 0x0001U
1663 #define LDAP_AVA_BINARY 0x0002U
1664 #define LDAP_AVA_NONPRINTABLE 0x0004U
1665 #define LDAP_AVA_FREE_ATTR 0x0010U
1666 #define LDAP_AVA_FREE_VALUE 0x0020U
1671 typedef LDAPAVA** LDAPRDN;
1672 typedef LDAPRDN* LDAPDN;
1675 #define LDAP_DN_FORMAT_LDAP 0x0000U
1676 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1677 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1678 #define LDAP_DN_FORMAT_DCE 0x0030U
1679 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1680 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1681 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1682 #define LDAP_DN_FORMAT_MASK 0x00F0U
1685 #define LDAP_DN_PRETTY 0x0100U
1686 #define LDAP_DN_SKIP 0x0200U
1687 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1688 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1689 #define LDAP_DN_PEDANTIC 0xF000U
1691 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1692 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1701 ldap_str2dn LDAP_P((
1702 LDAP_CONST char *str,
1713 ldap_dn2str LDAP_P((
1719 ldap_bv2rdn LDAP_P((
1726 ldap_str2rdn LDAP_P((
1727 LDAP_CONST char *str,
1733 ldap_rdn2bv LDAP_P((
1739 ldap_rdn2str LDAP_P((
1745 ldap_dn_normalize LDAP_P((
1746 LDAP_CONST char *in, unsigned iflags,
1747 char **out, unsigned oflags ));
1750 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1751 LDAP_CONST char *dn ));
1754 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1755 LDAP_CONST char *dn,
1759 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1760 LDAP_CONST char *rdn,
1763 typedef int LDAPDN_rewrite_func
1764 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1767 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1768 LDAPDN_rewrite_func *func, unsigned flags ));
1771 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1772 LDAP_CONST char *dn ));
1775 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1776 LDAP_CONST char *dce ));
1779 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1780 LDAP_CONST char *dn ));
1783 ldap_get_dn_ber LDAP_P((
1784 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1787 ldap_get_attribute_ber LDAP_P((
1788 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1789 struct berval **vals ));
1795 ldap_first_attribute LDAP_P((
1798 BerElement **ber ));
1801 ldap_next_attribute LDAP_P((
1810 LDAP_F( struct berval ** )
1811 ldap_get_values_len LDAP_P((
1814 LDAP_CONST char *target ));
1817 ldap_count_values_len LDAP_P((
1818 struct berval **vals ));
1821 ldap_value_free_len LDAP_P((
1822 struct berval **vals ));
1826 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1829 LDAP_CONST char *target ));
1832 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1836 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1844 ldap_result LDAP_P((
1848 struct timeval *timeout,
1849 LDAPMessage **result ));
1852 ldap_msgtype LDAP_P((
1860 ldap_msgfree LDAP_P((
1864 ldap_msgdelete LDAP_P((
1873 ldap_bv2escaped_filter_value LDAP_P((
1875 struct berval *out ));
1878 ldap_search_ext LDAP_P((
1880 LDAP_CONST char *base,
1882 LDAP_CONST char *filter,
1885 LDAPControl **serverctrls,
1886 LDAPControl **clientctrls,
1887 struct timeval *timeout,
1892 ldap_search_ext_s LDAP_P((
1894 LDAP_CONST char *base,
1896 LDAP_CONST char *filter,
1899 LDAPControl **serverctrls,
1900 LDAPControl **clientctrls,
1901 struct timeval *timeout,
1903 LDAPMessage **res ));
1907 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1909 LDAP_CONST char *base,
1911 LDAP_CONST char *filter,
1916 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1918 LDAP_CONST char *base,
1920 LDAP_CONST char *filter,
1923 LDAPMessage **res ));
1926 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1928 LDAP_CONST char *base,
1930 LDAP_CONST char *filter,
1933 struct timeval *timeout,
1934 LDAPMessage **res ));
1941 ldap_unbind_ext LDAP_P((
1943 LDAPControl **serverctrls,
1944 LDAPControl **clientctrls));
1947 ldap_unbind_ext_s LDAP_P((
1949 LDAPControl **serverctrls,
1950 LDAPControl **clientctrls));
1953 ldap_destroy LDAP_P((
1958 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1962 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1970 ldap_put_vrFilter LDAP_P((
1979 ldap_memalloc LDAP_P((
1983 ldap_memrealloc LDAP_P((
1988 ldap_memcalloc LDAP_P((
1993 ldap_memfree LDAP_P((
1997 ldap_memvfree LDAP_P((
2001 ldap_strdup LDAP_P((
2002 LDAP_CONST char * ));
2005 ldap_mods_free LDAP_P((
2012 * in sort.c (deprecated, use custom code instead)
2014 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
2015 LDAP_CONST char *left,
2016 LDAP_CONST char *right ));
2018 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
2019 LDAP_CONST void *left,
2020 LDAP_CONST void *right ));
2022 LDAP_F( int ) /* deprecated */
2023 ldap_sort_entries LDAP_P(( LDAP *ld,
2024 LDAPMessage **chain,
2025 LDAP_CONST char *attr,
2026 LDAP_SORT_AD_CMP_PROC *cmp ));
2028 LDAP_F( int ) /* deprecated */
2029 ldap_sort_values LDAP_P((
2032 LDAP_SORT_AV_CMP_PROC *cmp ));
2034 LDAP_F( int ) /* deprecated */
2035 ldap_sort_strcasecmp LDAP_P((
2037 LDAP_CONST void *b ));
2044 ldap_is_ldap_url LDAP_P((
2045 LDAP_CONST char *url ));
2048 ldap_is_ldaps_url LDAP_P((
2049 LDAP_CONST char *url ));
2052 ldap_is_ldapi_url LDAP_P((
2053 LDAP_CONST char *url ));
2056 ldap_url_parse LDAP_P((
2057 LDAP_CONST char *url,
2058 LDAPURLDesc **ludpp ));
2061 ldap_url_desc2str LDAP_P((
2062 LDAPURLDesc *ludp ));
2065 ldap_free_urldesc LDAP_P((
2066 LDAPURLDesc *ludp ));
2070 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2073 #define LDAP_API_FEATURE_CANCEL 1000
2076 ldap_cancel LDAP_P(( LDAP *ld,
2078 LDAPControl **sctrls,
2079 LDAPControl **cctrls,
2083 ldap_cancel_s LDAP_P(( LDAP *ld,
2085 LDAPControl **sctrl,
2086 LDAPControl **cctrl ));
2089 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2092 #define LDAP_API_FEATURE_TURN 1000
2095 ldap_turn LDAP_P(( LDAP *ld,
2097 LDAP_CONST char* identifier,
2098 LDAPControl **sctrls,
2099 LDAPControl **cctrls,
2103 ldap_turn_s LDAP_P(( LDAP *ld,
2105 LDAP_CONST char* identifier,
2106 LDAPControl **sctrl,
2107 LDAPControl **cctrl ));
2110 * LDAP Paged Results
2113 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2116 ldap_create_page_control_value LDAP_P((
2119 struct berval *cookie,
2120 struct berval *value ));
2123 ldap_create_page_control LDAP_P((
2126 struct berval *cookie,
2128 LDAPControl **ctrlp ));
2132 ldap_parse_page_control LDAP_P((
2133 /* deprecated, use ldap_parse_pageresponse_control */
2135 LDAPControl **ctrls,
2137 struct berval **cookie ));
2141 ldap_parse_pageresponse_control LDAP_P((
2145 struct berval *cookie ));
2148 * LDAP Server Side Sort
2151 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2153 /* structure for a sort-key */
2154 typedef struct ldapsortkey {
2155 char *attributeType;
2161 ldap_create_sort_keylist LDAP_P((
2162 LDAPSortKey ***sortKeyList,
2166 ldap_free_sort_keylist LDAP_P((
2167 LDAPSortKey **sortkeylist ));
2170 ldap_create_sort_control_value LDAP_P((
2172 LDAPSortKey **keyList,
2173 struct berval *value ));
2176 ldap_create_sort_control LDAP_P((
2178 LDAPSortKey **keyList,
2180 LDAPControl **ctrlp ));
2183 ldap_parse_sortresponse_control LDAP_P((
2187 char **attribute ));
2190 * LDAP Virtual List View
2193 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2195 /* structure for virtual list */
2196 typedef struct ldapvlvinfo {
2197 ber_int_t ldvlv_version;
2198 ber_int_t ldvlv_before_count;
2199 ber_int_t ldvlv_after_count;
2200 ber_int_t ldvlv_offset;
2201 ber_int_t ldvlv_count;
2202 struct berval * ldvlv_attrvalue;
2203 struct berval * ldvlv_context;
2204 void * ldvlv_extradata;
2208 ldap_create_vlv_control_value LDAP_P((
2210 LDAPVLVInfo *ldvlistp,
2211 struct berval *value));
2214 ldap_create_vlv_control LDAP_P((
2216 LDAPVLVInfo *ldvlistp,
2217 LDAPControl **ctrlp ));
2220 ldap_parse_vlvresponse_control LDAP_P((
2223 ber_int_t *target_posp,
2224 ber_int_t *list_countp,
2225 struct berval **contextp,
2229 * LDAP Verify Credentials
2231 #define LDAP_API_FEATURE_VERIFY_CREDENTIALS 1000
2234 ldap_verify_credentials LDAP_P((
2236 struct berval *cookie,
2237 LDAP_CONST char *dn,
2238 LDAP_CONST char *mechanism,
2239 struct berval *cred,
2240 LDAPControl **ctrls,
2241 LDAPControl **serverctrls,
2242 LDAPControl **clientctrls,
2246 ldap_verify_credentials_s LDAP_P((
2248 struct berval *cookie,
2249 LDAP_CONST char *dn,
2250 LDAP_CONST char *mechanism,
2251 struct berval *cred,
2252 LDAPControl **vcictrls,
2253 LDAPControl **serverctrls,
2254 LDAPControl **clientctrls,
2257 struct berval **scookie,
2258 struct berval **servercredp,
2259 LDAPControl ***vcoctrls));
2263 ldap_parse_verify_credentials LDAP_P((
2268 struct berval **cookie,
2269 struct berval **servercredp,
2270 LDAPControl ***vcctrls));
2272 /* not yet implemented */
2273 /* #define LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE 1000 */
2274 #ifdef LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE
2276 ldap_verify_credentials_interactive LDAP_P((
2278 LDAP_CONST char *dn, /* usually NULL */
2279 LDAP_CONST char *saslMechanism,
2280 LDAPControl **vcControls,
2281 LDAPControl **serverControls,
2282 LDAPControl **clientControls,
2284 /* should be client controls */
2286 LDAP_SASL_INTERACT_PROC *proc,
2290 /* as obtained from ldap_result() */
2291 LDAPMessage *result,
2293 /* returned during bind processing */
2302 #define LDAP_API_FEATURE_WHOAMI 1000
2305 ldap_parse_whoami LDAP_P((
2308 struct berval **authzid ));
2311 ldap_whoami LDAP_P(( LDAP *ld,
2312 LDAPControl **sctrls,
2313 LDAPControl **cctrls,
2317 ldap_whoami_s LDAP_P((
2319 struct berval **authzid,
2320 LDAPControl **sctrls,
2321 LDAPControl **cctrls ));
2324 * LDAP Password Modify
2327 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2330 ldap_parse_passwd LDAP_P((
2333 struct berval *newpasswd ));
2336 ldap_passwd LDAP_P(( LDAP *ld,
2337 struct berval *user,
2338 struct berval *oldpw,
2339 struct berval *newpw,
2340 LDAPControl **sctrls,
2341 LDAPControl **cctrls,
2345 ldap_passwd_s LDAP_P((
2347 struct berval *user,
2348 struct berval *oldpw,
2349 struct berval *newpw,
2350 struct berval *newpasswd,
2351 LDAPControl **sctrls,
2352 LDAPControl **cctrls ));
2354 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2356 * LDAP Password Policy controls
2359 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2361 typedef enum passpolicyerror_enum {
2362 PP_passwordExpired = 0,
2363 PP_accountLocked = 1,
2364 PP_changeAfterReset = 2,
2365 PP_passwordModNotAllowed = 3,
2366 PP_mustSupplyOldPassword = 4,
2367 PP_insufficientPasswordQuality = 5,
2368 PP_passwordTooShort = 6,
2369 PP_passwordTooYoung = 7,
2370 PP_passwordInHistory = 8,
2372 } LDAPPasswordPolicyError;
2375 ldap_create_passwordpolicy_control LDAP_P((
2377 LDAPControl **ctrlp ));
2380 ldap_parse_passwordpolicy_control LDAP_P((
2385 LDAPPasswordPolicyError *errorp ));
2387 LDAP_F( const char * )
2388 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2389 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2392 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2395 #define LDAP_API_FEATURE_REFRESH 1000
2398 ldap_parse_refresh LDAP_P((
2401 ber_int_t *newttl ));
2404 ldap_refresh LDAP_P(( LDAP *ld,
2407 LDAPControl **sctrls,
2408 LDAPControl **cctrls,
2412 ldap_refresh_s LDAP_P((
2417 LDAPControl **sctrls,
2418 LDAPControl **cctrls ));
2425 ldap_txn_start LDAP_P(( LDAP *ld,
2426 LDAPControl **sctrls,
2427 LDAPControl **cctrls,
2431 ldap_txn_start_s LDAP_P(( LDAP *ld,
2432 LDAPControl **sctrl,
2433 LDAPControl **cctrl,
2434 struct berval **rettxnid ));
2437 ldap_txn_end LDAP_P(( LDAP *ld,
2439 struct berval *txnid,
2440 LDAPControl **sctrls,
2441 LDAPControl **cctrls,
2445 ldap_txn_end_s LDAP_P(( LDAP *ld,
2447 struct berval *txnid,
2448 LDAPControl **sctrl,
2449 LDAPControl **cctrl,
2458 * initialize the persistent search structure
2460 LDAP_F( ldap_sync_t * )
2461 ldap_sync_initialize LDAP_P((
2465 * destroy the persistent search structure
2468 ldap_sync_destroy LDAP_P((
2473 * initialize a refreshOnly sync
2476 ldap_sync_init LDAP_P((
2481 * initialize a refreshOnly sync
2484 ldap_sync_init_refresh_only LDAP_P((
2488 * initialize a refreshAndPersist sync
2491 ldap_sync_init_refresh_and_persist LDAP_P((
2495 * poll for new responses
2498 ldap_sync_poll LDAP_P((
2501 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2507 ldap_create_session_tracking_value LDAP_P((
2509 char *sessionSourceIp,
2510 char *sessionSourceName,
2512 struct berval *sessionTrackingIdentifier,
2513 struct berval *value ));
2516 ldap_create_session_tracking_control LDAP_P((
2518 char *sessionSourceIp,
2519 char *sessionSourceName,
2521 struct berval *sessionTrackingIdentifier,
2522 LDAPControl **ctrlp ));
2525 ldap_parse_session_tracking_control LDAP_P((
2529 struct berval *name,
2531 struct berval *id ));
2533 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2539 ldap_create_assertion_control_value LDAP_P((
2542 struct berval *value ));
2545 ldap_create_assertion_control LDAP_P((
2549 LDAPControl **ctrlp ));
2555 typedef struct LDAPDerefSpec {
2560 typedef struct LDAPDerefVal {
2563 struct LDAPDerefVal *next;
2566 typedef struct LDAPDerefRes {
2568 struct berval derefVal;
2569 LDAPDerefVal *attrVals;
2570 struct LDAPDerefRes *next;
2574 ldap_create_deref_control_value LDAP_P((
2577 struct berval *value ));
2580 ldap_create_deref_control LDAP_P((
2584 LDAPControl **ctrlp ));
2587 ldap_derefresponse_free LDAP_P((
2588 LDAPDerefRes *dr ));
2591 ldap_parse_derefresponse_control LDAP_P((
2594 LDAPDerefRes **drp ));
2597 ldap_parse_deref_control LDAP_P((
2599 LDAPControl **ctrls,
2600 LDAPDerefRes **drp ));
2603 * high level LDIF to LDAP structure support
2605 #define LDIF_DEFAULT_ADD 0x01 /* if changetype missing, assume LDAP_ADD */
2606 #define LDIF_ENTRIES_ONLY 0x02 /* ignore changetypes other than add */
2607 #define LDIF_NO_CONTROLS 0x04 /* ignore control specifications */
2609 typedef struct ldifrecord {
2610 ber_tag_t lr_op; /* type of operation - LDAP_REQ_MODIFY, LDAP_REQ_ADD, etc. */
2611 struct berval lr_dn; /* DN of operation */
2612 LDAPControl **lr_ctrls; /* controls specified for operation */
2613 /* some ops such as LDAP_REQ_DELETE require only a DN */
2614 /* other ops require different data - the ldif_ops union
2615 is used to specify the data for each type of operation */
2617 LDAPMod **lr_mods; /* list of mods for LDAP_REQ_MODIFY, LDAP_REQ_ADD */
2618 #define lrop_mods ldif_ops.lr_mods
2619 struct ldif_op_rename_s {
2620 struct berval lr_newrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2621 #define lrop_newrdn ldif_ops.ldif_op_rename.lr_newrdn
2622 struct berval lr_newsuperior; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2623 #define lrop_newsup ldif_ops.ldif_op_rename.lr_newsuperior
2624 int lr_deleteoldrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2625 #define lrop_delold ldif_ops.ldif_op_rename.lr_deleteoldrdn
2626 } ldif_op_rename; /* rename/moddn/modrdn */
2627 /* the following are for future support */
2628 struct ldif_op_ext_s {
2629 struct berval lr_extop_oid; /* LDAP_REQ_EXTENDED */
2630 #define lrop_extop_oid ldif_ops.ldif_op_ext.lr_extop_oid
2631 struct berval lr_extop_data; /* LDAP_REQ_EXTENDED */
2632 #define lrop_extop_data ldif_ops.ldif_op_ext.lr_extop_data
2633 } ldif_op_ext; /* extended operation */
2634 struct ldif_op_cmp_s {
2635 struct berval lr_cmp_attr; /* LDAP_REQ_COMPARE */
2636 #define lrop_cmp_attr ldif_ops.ldif_op_cmp.lr_cmp_attr
2637 struct berval lr_cmp_bvalue; /* LDAP_REQ_COMPARE */
2638 #define lrop_cmp_bval ldif_ops.ldif_op_cmp.lr_cmp_bvalue
2639 } ldif_op_cmp; /* compare operation */
2641 /* PRIVATE STUFF - DO NOT TOUCH */
2642 /* for efficiency, the implementation allocates memory */
2643 /* in large blobs, and makes the above fields point to */
2644 /* locations inside those blobs - one consequence is that */
2645 /* you cannot simply free the above allocated fields, nor */
2646 /* assign them to be owned by another memory context which */
2647 /* might free them (unless providing your own mem ctx) */
2648 /* we use the fields below to keep track of those blobs */
2649 /* so we that we can free them later */
2650 void *lr_ctx; /* the memory context or NULL */
2653 unsigned char *lr_mops;
2655 struct berval *lr_vals;
2656 struct berval *lr_btype;
2659 /* free internal fields - does not free the LDIFRecord */
2661 ldap_ldif_record_done LDAP_P((
2665 ldap_parse_ldif_record LDAP_P((
2666 struct berval *rbuf,
2667 unsigned long linenum,
2670 unsigned int flags ));
2673 #endif /* _LDAP_H */