2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2012 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
162 #define LDAP_OPT_X_TLS_NEVER 0
163 #define LDAP_OPT_X_TLS_HARD 1
164 #define LDAP_OPT_X_TLS_DEMAND 2
165 #define LDAP_OPT_X_TLS_ALLOW 3
166 #define LDAP_OPT_X_TLS_TRY 4
168 #define LDAP_OPT_X_TLS_CRL_NONE 0
169 #define LDAP_OPT_X_TLS_CRL_PEER 1
170 #define LDAP_OPT_X_TLS_CRL_ALL 2
172 /* for LDAP_OPT_X_TLS_PROTOCOL_MIN */
173 #define LDAP_OPT_X_TLS_PROTOCOL(maj,min) (((maj) << 8) + (min))
174 #define LDAP_OPT_X_TLS_PROTOCOL_SSL2 (2 << 8)
175 #define LDAP_OPT_X_TLS_PROTOCOL_SSL3 (3 << 8)
176 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_0 ((3 << 8) + 1)
177 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_1 ((3 << 8) + 2)
178 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_2 ((3 << 8) + 3)
180 /* OpenLDAP SASL options */
181 #define LDAP_OPT_X_SASL_MECH 0x6100
182 #define LDAP_OPT_X_SASL_REALM 0x6101
183 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
184 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
185 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
186 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
187 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
188 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
189 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
190 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
191 #define LDAP_OPT_X_SASL_MECHLIST 0x610a /* read-only */
192 #define LDAP_OPT_X_SASL_NOCANON 0x610b
193 #define LDAP_OPT_X_SASL_USERNAME 0x610c /* read-only */
194 #define LDAP_OPT_X_SASL_GSS_CREDS 0x610d
196 /* OpenLDAP GSSAPI options */
197 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT 0x6200
198 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL 0x6201
201 * OpenLDAP per connection tcp-keepalive settings
202 * (Linux only, ignored where unsupported)
204 #define LDAP_OPT_X_KEEPALIVE_IDLE 0x6300
205 #define LDAP_OPT_X_KEEPALIVE_PROBES 0x6301
206 #define LDAP_OPT_X_KEEPALIVE_INTERVAL 0x6302
208 /* Private API Extensions -- reserved for application use */
209 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
212 * ldap_get_option() and ldap_set_option() return values.
213 * As later versions may return other values indicating
214 * failure, current applications should only compare returned
215 * value against LDAP_OPT_SUCCESS.
217 #define LDAP_OPT_SUCCESS 0
218 #define LDAP_OPT_ERROR (-1)
220 /* option on/off values */
221 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
222 #define LDAP_OPT_OFF ((void *) 0)
224 typedef struct ldapapiinfo {
225 int ldapai_info_version; /* version of LDAPAPIInfo */
226 #define LDAP_API_INFO_VERSION (1)
227 int ldapai_api_version; /* revision of API supported */
228 int ldapai_protocol_version; /* highest LDAP version supported */
229 char **ldapai_extensions; /* names of API extensions */
230 char *ldapai_vendor_name; /* name of supplier */
231 int ldapai_vendor_version; /* supplier-specific version * 100 */
234 typedef struct ldap_apifeature_info {
235 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
236 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
237 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
238 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
239 } LDAPAPIFeatureInfo;
242 * LDAP Control structure
244 typedef struct ldapcontrol {
245 char * ldctl_oid; /* numericoid of control */
246 struct berval ldctl_value; /* encoded value of control */
247 char ldctl_iscritical; /* criticality */
251 /* standard track controls */
252 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
253 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
254 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
256 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
258 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
259 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
260 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
262 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
263 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
265 /* non-standard track controls */
266 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
268 /* LDAP Content Synchronization Operation -- RFC 4533 */
269 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
270 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
271 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
272 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
273 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
275 #define LDAP_SYNC_NONE 0x00
276 #define LDAP_SYNC_REFRESH_ONLY 0x01
277 #define LDAP_SYNC_RESERVED 0x02
278 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
280 #define LDAP_SYNC_REFRESH_PRESENTS 0
281 #define LDAP_SYNC_REFRESH_DELETES 1
283 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
284 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
285 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
286 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
288 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
289 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
290 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
291 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
293 #define LDAP_SYNC_PRESENT 0
294 #define LDAP_SYNC_ADD 1
295 #define LDAP_SYNC_MODIFY 2
296 #define LDAP_SYNC_DELETE 3
297 #define LDAP_SYNC_NEW_COOKIE 4
300 /* Password policy Controls *//* work in progress */
301 /* ITS#3458: released; disabled by default */
302 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
303 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
305 /* various works in progress */
306 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
307 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
308 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
309 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
310 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
311 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
312 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
313 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
314 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
316 /* LDAP Chaining Behavior Control *//* work in progress */
317 /* <draft-sermersheim-ldap-chaining>;
318 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
319 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
321 #define LDAP_CHAINING_PREFERRED 0
322 #define LDAP_CHAINING_REQUIRED 1
323 #define LDAP_REFERRALS_PREFERRED 2
324 #define LDAP_REFERRALS_REQUIRED 3
326 /* MS Active Directory controls (for compatibility) */
327 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
328 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
329 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
330 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
331 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
332 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
333 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
335 /* MS Active Directory controls - not implemented in slapd(8) */
336 #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 /* various expired works */
348 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
349 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
350 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
351 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
352 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
354 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
355 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
356 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
357 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
358 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
359 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
360 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
363 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
364 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
366 /* LDAP Unsolicited Notifications */
367 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
368 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
370 /* LDAP Extended Operations */
371 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
373 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
374 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
375 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
376 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
377 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
379 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
380 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
382 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
383 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
384 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
385 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x81U)
387 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
388 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
390 /* various works in progress */
391 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
392 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
394 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
395 /* a work in progress */
396 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
397 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
398 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
399 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
400 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
401 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
402 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
403 LDAP_X_DISTPROC_BASE ".6"
404 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
405 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
406 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
407 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
408 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
411 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
412 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
413 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
414 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
415 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
419 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
420 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
421 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
422 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
423 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
424 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
425 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
427 /* LDAP Experimental (works in progress) Features */
428 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
429 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
430 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
433 * specific LDAP instantiations of BER types we know about
436 /* Overview of LBER tag construction
443 * 1 0 = CONTEXT-SPECIFIC
450 * | 5 ... 1 | TAG-NUMBER
454 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
455 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
457 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
458 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
460 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
461 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
463 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
465 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
466 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
467 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
468 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
470 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
471 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
473 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
475 /* LDAP Request Messages */
476 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
477 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
478 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
479 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
480 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
481 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
482 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
483 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
484 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
485 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
486 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
487 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
489 /* LDAP Response Messages */
490 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
491 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
492 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
493 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
494 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
495 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
496 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
497 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
498 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
499 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
500 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
501 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
502 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
504 #define LDAP_RES_ANY (-1)
505 #define LDAP_RES_UNSOLICITED (0)
509 #define LDAP_SASL_SIMPLE ((char*)0)
510 #define LDAP_SASL_NULL ("")
513 /* authentication methods available */
514 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
515 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
516 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
517 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
518 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
519 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
521 /* used by the Windows API but not used on the wire */
522 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
525 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
526 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
527 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
528 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
529 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
530 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
531 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
532 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
533 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
534 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
536 /* extended filter component types */
537 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
538 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
539 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
540 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
542 /* substring filter component types */
543 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
544 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
545 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
548 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
549 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
550 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
551 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
552 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
553 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
554 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
555 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
556 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
558 /* substring filter component types */
559 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
560 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
561 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
566 #define LDAP_SUCCESS 0x00
568 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
570 #define LDAP_OPERATIONS_ERROR 0x01
571 #define LDAP_PROTOCOL_ERROR 0x02
572 #define LDAP_TIMELIMIT_EXCEEDED 0x03
573 #define LDAP_SIZELIMIT_EXCEEDED 0x04
574 #define LDAP_COMPARE_FALSE 0x05
575 #define LDAP_COMPARE_TRUE 0x06
576 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
577 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
578 #define LDAP_STRONG_AUTH_REQUIRED 0x08
579 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
580 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
582 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
583 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
584 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
585 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
586 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
588 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
590 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
591 #define LDAP_UNDEFINED_TYPE 0x11
592 #define LDAP_INAPPROPRIATE_MATCHING 0x12
593 #define LDAP_CONSTRAINT_VIOLATION 0x13
594 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
595 #define LDAP_INVALID_SYNTAX 0x15
597 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
599 #define LDAP_NO_SUCH_OBJECT 0x20
600 #define LDAP_ALIAS_PROBLEM 0x21
601 #define LDAP_INVALID_DN_SYNTAX 0x22
602 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
603 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
605 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
607 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
608 #define LDAP_INAPPROPRIATE_AUTH 0x30
609 #define LDAP_INVALID_CREDENTIALS 0x31
610 #define LDAP_INSUFFICIENT_ACCESS 0x32
612 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
614 #define LDAP_BUSY 0x33
615 #define LDAP_UNAVAILABLE 0x34
616 #define LDAP_UNWILLING_TO_PERFORM 0x35
617 #define LDAP_LOOP_DETECT 0x36
619 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
621 #define LDAP_NAMING_VIOLATION 0x40
622 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
623 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
624 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
625 #define LDAP_ALREADY_EXISTS 0x44
626 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
627 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
628 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
630 #define LDAP_VLV_ERROR 0x4C
632 #define LDAP_OTHER 0x50
634 /* LCUP operation codes (113-117) - not implemented */
635 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
636 #define LDAP_CUP_SECURITY_VIOLATION 0x72
637 #define LDAP_CUP_INVALID_DATA 0x73
638 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
639 #define LDAP_CUP_RELOAD_REQUIRED 0x75
641 /* Cancel operation codes (118-121) */
642 #define LDAP_CANCELLED 0x76
643 #define LDAP_NO_SUCH_OPERATION 0x77
644 #define LDAP_TOO_LATE 0x78
645 #define LDAP_CANNOT_CANCEL 0x79
647 /* Assertion control (122) */
648 #define LDAP_ASSERTION_FAILED 0x7A
650 /* Proxied Authorization Denied (123) */
651 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
653 /* Experimental result codes */
654 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
656 /* LDAP Sync (4096) */
657 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
660 /* Private Use result codes */
661 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
663 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
664 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
666 /* for the LDAP No-Op control */
667 #define LDAP_X_NO_OPERATION 0x410e
669 /* for the Chaining Behavior control (consecutive result codes requested;
670 * see <draft-sermersheim-ldap-chaining> ) */
671 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
672 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
673 #define LDAP_X_CANNOT_CHAIN 0x4111
676 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
677 #ifdef LDAP_X_DISTPROC_BASE
678 #define LDAP_X_INVALIDREFERENCE 0x4112
682 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
683 #define LDAP_X_TXN_ID_INVALID 0x4121
688 * Based on draft-ietf-ldap-c-api-xx
689 * but with new negative code values
691 #define LDAP_API_ERROR(n) ((n)<0)
692 #define LDAP_API_RESULT(n) ((n)<=0)
694 #define LDAP_SERVER_DOWN (-1)
695 #define LDAP_LOCAL_ERROR (-2)
696 #define LDAP_ENCODING_ERROR (-3)
697 #define LDAP_DECODING_ERROR (-4)
698 #define LDAP_TIMEOUT (-5)
699 #define LDAP_AUTH_UNKNOWN (-6)
700 #define LDAP_FILTER_ERROR (-7)
701 #define LDAP_USER_CANCELLED (-8)
702 #define LDAP_PARAM_ERROR (-9)
703 #define LDAP_NO_MEMORY (-10)
704 #define LDAP_CONNECT_ERROR (-11)
705 #define LDAP_NOT_SUPPORTED (-12)
706 #define LDAP_CONTROL_NOT_FOUND (-13)
707 #define LDAP_NO_RESULTS_RETURNED (-14)
708 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
709 #define LDAP_CLIENT_LOOP (-16)
710 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
711 #define LDAP_X_CONNECTING (-18)
715 * This structure represents both ldap messages and ldap responses.
716 * These are really the same, except in the case of search responses,
717 * where a response has multiple messages.
720 typedef struct ldapmsg LDAPMessage;
722 /* for modifications */
723 typedef struct ldapmod {
726 #define LDAP_MOD_OP (0x0007)
727 #define LDAP_MOD_ADD (0x0000)
728 #define LDAP_MOD_DELETE (0x0001)
729 #define LDAP_MOD_REPLACE (0x0002)
730 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
731 #define LDAP_MOD_BVALUES (0x0080)
732 /* IMPORTANT: do not use code 0x1000 (or above),
733 * it is used internally by the backends!
734 * (see ldap/servers/slapd/slap.h)
740 struct berval **modv_bvals;
742 #define mod_values mod_vals.modv_strvals
743 #define mod_bvalues mod_vals.modv_bvals
747 * structure representing an ldap session which can
748 * encompass connections to multiple servers (in the
749 * face of referrals).
751 typedef struct ldap LDAP;
753 #define LDAP_DEREF_NEVER 0x00
754 #define LDAP_DEREF_SEARCHING 0x01
755 #define LDAP_DEREF_FINDING 0x02
756 #define LDAP_DEREF_ALWAYS 0x03
758 #define LDAP_NO_LIMIT 0
760 /* how many messages to retrieve results for */
761 #define LDAP_MSG_ONE 0x00
762 #define LDAP_MSG_ALL 0x01
763 #define LDAP_MSG_RECEIVED 0x02
766 * types for ldap URL handling
768 typedef struct ldap_url_desc {
769 struct ldap_url_desc *lud_next;
781 #define LDAP_URL_SUCCESS 0x00 /* Success */
782 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
783 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
785 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
786 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
787 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
788 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
789 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
790 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
791 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
792 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
795 * LDAP sync (RFC4533) API
798 typedef struct ldap_sync_t ldap_sync_t;
801 /* these are private - the client should never see them */
802 LDAP_SYNC_CAPI_NONE = -1,
804 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
805 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
806 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
808 /* these are passed to ls_search_entry() */
809 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
810 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
811 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
812 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
814 /* these are passed to ls_intermediate() */
815 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
816 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
818 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
819 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
821 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
822 } ldap_sync_refresh_t;
825 * Called when an entry is returned by ldap_result().
826 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
827 * the entry has been either added or modified, and thus
828 * the complete view of the entry should be in the LDAPMessage.
829 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
830 * only the DN should be in the LDAPMessage.
832 typedef int (*ldap_sync_search_entry_f) LDAP_P((
835 struct berval *entryUUID,
836 ldap_sync_refresh_t phase ));
839 * Called when a reference is returned; the client should know
840 * what to do with it.
842 typedef int (*ldap_sync_search_reference_f) LDAP_P((
847 * Called when specific intermediate/final messages are returned.
848 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
849 * a "presents" or "deletes" phase begins.
850 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
851 * with refreshDone set to "TRUE" has been returned, to indicate
852 * that the refresh phase of a refreshAndPersist is complete.
853 * In the above cases, syncUUIDs is NULL.
855 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
856 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
857 * that are either present or have been deleted.
859 typedef int (*ldap_sync_intermediate_f) LDAP_P((
863 ldap_sync_refresh_t phase ));
866 * Called when a searchResultDone is returned. In refreshAndPersist,
867 * this can only occur if the search for any reason is being terminated
870 typedef int (*ldap_sync_search_result_f) LDAP_P((
873 int refreshDeletes ));
876 * This structure contains all information about the persistent search;
877 * the caller is responsible for connecting, setting version, binding, tls...
880 /* conf search params */
891 /* helpers - add as appropriate */
892 ldap_sync_search_entry_f ls_search_entry;
893 ldap_sync_search_reference_f ls_search_reference;
894 ldap_sync_intermediate_f ls_intermediate;
895 ldap_sync_search_result_f ls_search_result;
897 /* set by the caller as appropriate */
903 /* --- the parameters below are private - do not modify --- */
905 /* FIXME: make the structure opaque, and provide an interface
906 * to modify the public values? */
912 /* needed by refreshOnly */
915 /* opaque - need to pass between sessions, updated by the API */
916 struct berval ls_cookie;
918 /* state variable - do not modify */
919 ldap_sync_refresh_t ls_refreshPhase;
923 * End of LDAP sync (RFC4533) API
927 * Connection callbacks...
932 /* Called after a connection is established */
933 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
934 struct ldap_conncb *ctx ));
935 /* Called before a connection is closed */
936 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
938 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
939 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
941 typedef struct ldap_conncb {
942 ldap_conn_add_f *lc_add;
943 ldap_conn_del_f *lc_del;
948 * The API draft spec says we should declare (or cause to be declared)
949 * 'struct timeval'. We don't. See IETF LDAPext discussions.
957 ldap_get_option LDAP_P((
963 ldap_set_option LDAP_P((
966 LDAP_CONST void *invalue));
968 /* V3 REBIND Function Callback Prototype */
969 typedef int (LDAP_REBIND_PROC) LDAP_P((
970 LDAP *ld, LDAP_CONST char *url,
971 ber_tag_t request, ber_int_t msgid,
975 ldap_set_rebind_proc LDAP_P((
977 LDAP_REBIND_PROC *rebind_proc,
980 /* V3 referral selection Function Callback Prototype */
981 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
982 LDAP *ld, char ***refsp, int *cntp,
986 ldap_set_nextref_proc LDAP_P((
988 LDAP_NEXTREF_PROC *nextref_proc,
991 /* V3 URLLIST Function Callback Prototype */
992 typedef int (LDAP_URLLIST_PROC) LDAP_P((
994 LDAPURLDesc **urllist,
999 ldap_set_urllist_proc LDAP_P((
1001 LDAP_URLLIST_PROC *urllist_proc,
1009 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
1010 LDAP_CONST char *requestOID,
1013 LDAPControl **ctrlp ));
1015 LDAP_F( LDAPControl * )
1016 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
1017 LDAP_CONST char *oid,
1018 LDAPControl **ctrls ));
1022 ldap_control_create LDAP_P((
1023 LDAP_CONST char *requestOID,
1025 struct berval *value,
1027 LDAPControl **ctrlp ));
1029 LDAP_F( LDAPControl * )
1030 ldap_control_find LDAP_P((
1031 LDAP_CONST char *oid,
1032 LDAPControl **ctrls,
1033 LDAPControl ***nextctrlp ));
1036 ldap_control_free LDAP_P((
1037 LDAPControl *ctrl ));
1040 ldap_controls_free LDAP_P((
1041 LDAPControl **ctrls ));
1043 LDAP_F( LDAPControl ** )
1044 ldap_controls_dup LDAP_P((
1045 LDAPControl *LDAP_CONST *controls ));
1047 LDAP_F( LDAPControl * )
1048 ldap_control_dup LDAP_P((
1049 LDAP_CONST LDAPControl *c ));
1055 ldap_domain2dn LDAP_P((
1056 LDAP_CONST char* domain,
1060 ldap_dn2domain LDAP_P((
1061 LDAP_CONST char* dn,
1065 ldap_domain2hostlist LDAP_P((
1066 LDAP_CONST char *domain,
1073 ldap_extended_operation LDAP_P((
1075 LDAP_CONST char *reqoid,
1076 struct berval *reqdata,
1077 LDAPControl **serverctrls,
1078 LDAPControl **clientctrls,
1082 ldap_extended_operation_s LDAP_P((
1084 LDAP_CONST char *reqoid,
1085 struct berval *reqdata,
1086 LDAPControl **serverctrls,
1087 LDAPControl **clientctrls,
1089 struct berval **retdatap ));
1092 ldap_parse_extended_result LDAP_P((
1096 struct berval **retdatap,
1100 ldap_parse_intermediate LDAP_P((
1104 struct berval **retdatap,
1105 LDAPControl ***serverctrls,
1113 ldap_abandon_ext LDAP_P((
1116 LDAPControl **serverctrls,
1117 LDAPControl **clientctrls ));
1121 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1130 ldap_add_ext LDAP_P((
1132 LDAP_CONST char *dn,
1134 LDAPControl **serverctrls,
1135 LDAPControl **clientctrls,
1139 ldap_add_ext_s LDAP_P((
1141 LDAP_CONST char *dn,
1143 LDAPControl **serverctrls,
1144 LDAPControl **clientctrls ));
1148 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1150 LDAP_CONST char *dn,
1154 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1156 LDAP_CONST char *dn,
1165 ldap_sasl_bind LDAP_P((
1167 LDAP_CONST char *dn,
1168 LDAP_CONST char *mechanism,
1169 struct berval *cred,
1170 LDAPControl **serverctrls,
1171 LDAPControl **clientctrls,
1174 /* Interaction flags (should be passed about in a control)
1175 * Automatic (default): use defaults, prompt otherwise
1176 * Interactive: prompt always
1177 * Quiet: never prompt
1179 #define LDAP_SASL_AUTOMATIC 0U
1180 #define LDAP_SASL_INTERACTIVE 1U
1181 #define LDAP_SASL_QUIET 2U
1184 * V3 SASL Interaction Function Callback Prototype
1185 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1186 * should likely passed in a control (and provided controls)
1188 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1189 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1192 ldap_sasl_interactive_bind LDAP_P((
1194 LDAP_CONST char *dn, /* usually NULL */
1195 LDAP_CONST char *saslMechanism,
1196 LDAPControl **serverControls,
1197 LDAPControl **clientControls,
1199 /* should be client controls */
1201 LDAP_SASL_INTERACT_PROC *proc,
1204 /* as obtained from ldap_result() */
1205 LDAPMessage *result,
1207 /* returned during bind processing */
1212 ldap_sasl_interactive_bind_s LDAP_P((
1214 LDAP_CONST char *dn, /* usually NULL */
1215 LDAP_CONST char *saslMechanism,
1216 LDAPControl **serverControls,
1217 LDAPControl **clientControls,
1219 /* should be client controls */
1221 LDAP_SASL_INTERACT_PROC *proc,
1225 ldap_sasl_bind_s LDAP_P((
1227 LDAP_CONST char *dn,
1228 LDAP_CONST char *mechanism,
1229 struct berval *cred,
1230 LDAPControl **serverctrls,
1231 LDAPControl **clientctrls,
1232 struct berval **servercredp ));
1235 ldap_parse_sasl_bind_result LDAP_P((
1238 struct berval **servercredp,
1247 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1249 LDAP_CONST char *who,
1250 LDAP_CONST char *passwd,
1254 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1256 LDAP_CONST char *who,
1257 LDAP_CONST char *cred,
1264 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1266 LDAP_CONST char *who,
1267 LDAP_CONST char *passwd ));
1270 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1272 LDAP_CONST char *who,
1273 LDAP_CONST char *passwd ));
1282 ldap_compare_ext LDAP_P((
1284 LDAP_CONST char *dn,
1285 LDAP_CONST char *attr,
1286 struct berval *bvalue,
1287 LDAPControl **serverctrls,
1288 LDAPControl **clientctrls,
1292 ldap_compare_ext_s LDAP_P((
1294 LDAP_CONST char *dn,
1295 LDAP_CONST char *attr,
1296 struct berval *bvalue,
1297 LDAPControl **serverctrls,
1298 LDAPControl **clientctrls ));
1302 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1304 LDAP_CONST char *dn,
1305 LDAP_CONST char *attr,
1306 LDAP_CONST char *value ));
1309 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1311 LDAP_CONST char *dn,
1312 LDAP_CONST char *attr,
1313 LDAP_CONST char *value ));
1321 ldap_delete_ext LDAP_P((
1323 LDAP_CONST char *dn,
1324 LDAPControl **serverctrls,
1325 LDAPControl **clientctrls,
1329 ldap_delete_ext_s LDAP_P((
1331 LDAP_CONST char *dn,
1332 LDAPControl **serverctrls,
1333 LDAPControl **clientctrls ));
1337 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1339 LDAP_CONST char *dn ));
1342 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1344 LDAP_CONST char *dn ));
1352 ldap_parse_result LDAP_P((
1359 LDAPControl ***serverctrls,
1363 ldap_err2string LDAP_P((
1368 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1374 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1376 LDAP_CONST char *s ));
1384 ldap_gssapi_bind LDAP_P((
1386 LDAP_CONST char *dn,
1387 LDAP_CONST char *creds ));
1390 ldap_gssapi_bind_s LDAP_P((
1392 LDAP_CONST char *dn,
1393 LDAP_CONST char *creds ));
1400 ldap_modify_ext LDAP_P((
1402 LDAP_CONST char *dn,
1404 LDAPControl **serverctrls,
1405 LDAPControl **clientctrls,
1409 ldap_modify_ext_s LDAP_P((
1411 LDAP_CONST char *dn,
1413 LDAPControl **serverctrls,
1414 LDAPControl **clientctrls ));
1418 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1420 LDAP_CONST char *dn,
1424 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1426 LDAP_CONST char *dn,
1435 ldap_rename LDAP_P((
1437 LDAP_CONST char *dn,
1438 LDAP_CONST char *newrdn,
1439 LDAP_CONST char *newSuperior,
1441 LDAPControl **sctrls,
1442 LDAPControl **cctrls,
1446 ldap_rename_s LDAP_P((
1448 LDAP_CONST char *dn,
1449 LDAP_CONST char *newrdn,
1450 LDAP_CONST char *newSuperior,
1452 LDAPControl **sctrls,
1453 LDAPControl **cctrls ));
1457 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1459 LDAP_CONST char *dn,
1460 LDAP_CONST char *newrdn,
1461 LDAP_CONST char *newSuperior,
1462 int deleteoldrdn ));
1465 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1467 LDAP_CONST char *dn,
1468 LDAP_CONST char *newrdn,
1469 LDAP_CONST char *newSuperior,
1470 int deleteoldrdn ));
1473 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1475 LDAP_CONST char *dn,
1476 LDAP_CONST char *newrdn ));
1479 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1481 LDAP_CONST char *dn,
1482 LDAP_CONST char *newrdn ));
1485 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1487 LDAP_CONST char *dn,
1488 LDAP_CONST char *newrdn,
1489 int deleteoldrdn ));
1492 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1494 LDAP_CONST char *dn,
1495 LDAP_CONST char *newrdn,
1505 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1506 LDAP_CONST char *host,
1510 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1511 LDAP_CONST char *host,
1516 ldap_create LDAP_P((
1520 ldap_initialize LDAP_P((
1522 LDAP_CONST char *url ));
1533 ldap_tls_inplace LDAP_P((
1537 ldap_start_tls LDAP_P((
1539 LDAPControl **serverctrls,
1540 LDAPControl **clientctrls,
1544 ldap_install_tls LDAP_P((
1548 ldap_start_tls_s LDAP_P((
1550 LDAPControl **serverctrls,
1551 LDAPControl **clientctrls ));
1556 LDAP_F( LDAPMessage * )
1557 ldap_first_message LDAP_P((
1559 LDAPMessage *chain ));
1561 LDAP_F( LDAPMessage * )
1562 ldap_next_message LDAP_P((
1564 LDAPMessage *msg ));
1567 ldap_count_messages LDAP_P((
1569 LDAPMessage *chain ));
1574 LDAP_F( LDAPMessage * )
1575 ldap_first_reference LDAP_P((
1577 LDAPMessage *chain ));
1579 LDAP_F( LDAPMessage * )
1580 ldap_next_reference LDAP_P((
1582 LDAPMessage *ref ));
1585 ldap_count_references LDAP_P((
1587 LDAPMessage *chain ));
1590 ldap_parse_reference LDAP_P((
1594 LDAPControl ***serverctrls,
1601 LDAP_F( LDAPMessage * )
1602 ldap_first_entry LDAP_P((
1604 LDAPMessage *chain ));
1606 LDAP_F( LDAPMessage * )
1607 ldap_next_entry LDAP_P((
1609 LDAPMessage *entry ));
1612 ldap_count_entries LDAP_P((
1614 LDAPMessage *chain ));
1617 ldap_get_entry_controls LDAP_P((
1620 LDAPControl ***serverctrls));
1626 LDAP_F( LDAPMessage * )
1627 ldap_delete_result_entry LDAP_P((
1632 ldap_add_result_entry LDAP_P((
1641 ldap_get_dn LDAP_P((
1643 LDAPMessage *entry ));
1645 typedef struct ldap_ava {
1646 struct berval la_attr;
1647 struct berval la_value;
1649 #define LDAP_AVA_NULL 0x0000U
1650 #define LDAP_AVA_STRING 0x0001U
1651 #define LDAP_AVA_BINARY 0x0002U
1652 #define LDAP_AVA_NONPRINTABLE 0x0004U
1653 #define LDAP_AVA_FREE_ATTR 0x0010U
1654 #define LDAP_AVA_FREE_VALUE 0x0020U
1659 typedef LDAPAVA** LDAPRDN;
1660 typedef LDAPRDN* LDAPDN;
1663 #define LDAP_DN_FORMAT_LDAP 0x0000U
1664 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1665 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1666 #define LDAP_DN_FORMAT_DCE 0x0030U
1667 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1668 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1669 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1670 #define LDAP_DN_FORMAT_MASK 0x00F0U
1673 #define LDAP_DN_PRETTY 0x0100U
1674 #define LDAP_DN_SKIP 0x0200U
1675 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1676 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1677 #define LDAP_DN_PEDANTIC 0xF000U
1679 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1680 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1689 ldap_str2dn LDAP_P((
1690 LDAP_CONST char *str,
1701 ldap_dn2str LDAP_P((
1707 ldap_bv2rdn LDAP_P((
1714 ldap_str2rdn LDAP_P((
1715 LDAP_CONST char *str,
1721 ldap_rdn2bv LDAP_P((
1727 ldap_rdn2str LDAP_P((
1733 ldap_dn_normalize LDAP_P((
1734 LDAP_CONST char *in, unsigned iflags,
1735 char **out, unsigned oflags ));
1738 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1739 LDAP_CONST char *dn ));
1742 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1743 LDAP_CONST char *dn,
1747 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1748 LDAP_CONST char *rdn,
1751 typedef int LDAPDN_rewrite_func
1752 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1755 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1756 LDAPDN_rewrite_func *func, unsigned flags ));
1759 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1760 LDAP_CONST char *dn ));
1763 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1764 LDAP_CONST char *dce ));
1767 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1768 LDAP_CONST char *dn ));
1771 ldap_get_dn_ber LDAP_P((
1772 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1775 ldap_get_attribute_ber LDAP_P((
1776 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1777 struct berval **vals ));
1783 ldap_first_attribute LDAP_P((
1786 BerElement **ber ));
1789 ldap_next_attribute LDAP_P((
1798 LDAP_F( struct berval ** )
1799 ldap_get_values_len LDAP_P((
1802 LDAP_CONST char *target ));
1805 ldap_count_values_len LDAP_P((
1806 struct berval **vals ));
1809 ldap_value_free_len LDAP_P((
1810 struct berval **vals ));
1814 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1817 LDAP_CONST char *target ));
1820 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1824 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1832 ldap_result LDAP_P((
1836 struct timeval *timeout,
1837 LDAPMessage **result ));
1840 ldap_msgtype LDAP_P((
1848 ldap_msgfree LDAP_P((
1852 ldap_msgdelete LDAP_P((
1861 ldap_bv2escaped_filter_value LDAP_P((
1863 struct berval *out ));
1866 ldap_search_ext LDAP_P((
1868 LDAP_CONST char *base,
1870 LDAP_CONST char *filter,
1873 LDAPControl **serverctrls,
1874 LDAPControl **clientctrls,
1875 struct timeval *timeout,
1880 ldap_search_ext_s LDAP_P((
1882 LDAP_CONST char *base,
1884 LDAP_CONST char *filter,
1887 LDAPControl **serverctrls,
1888 LDAPControl **clientctrls,
1889 struct timeval *timeout,
1891 LDAPMessage **res ));
1895 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1897 LDAP_CONST char *base,
1899 LDAP_CONST char *filter,
1904 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1906 LDAP_CONST char *base,
1908 LDAP_CONST char *filter,
1911 LDAPMessage **res ));
1914 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1916 LDAP_CONST char *base,
1918 LDAP_CONST char *filter,
1921 struct timeval *timeout,
1922 LDAPMessage **res ));
1929 ldap_unbind_ext LDAP_P((
1931 LDAPControl **serverctrls,
1932 LDAPControl **clientctrls));
1935 ldap_unbind_ext_s LDAP_P((
1937 LDAPControl **serverctrls,
1938 LDAPControl **clientctrls));
1941 ldap_destroy LDAP_P((
1946 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1950 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1958 ldap_put_vrFilter LDAP_P((
1967 ldap_memalloc LDAP_P((
1971 ldap_memrealloc LDAP_P((
1976 ldap_memcalloc LDAP_P((
1981 ldap_memfree LDAP_P((
1985 ldap_memvfree LDAP_P((
1989 ldap_strdup LDAP_P((
1990 LDAP_CONST char * ));
1993 ldap_mods_free LDAP_P((
2000 * in sort.c (deprecated, use custom code instead)
2002 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
2003 LDAP_CONST char *left,
2004 LDAP_CONST char *right ));
2006 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
2007 LDAP_CONST void *left,
2008 LDAP_CONST void *right ));
2010 LDAP_F( int ) /* deprecated */
2011 ldap_sort_entries LDAP_P(( LDAP *ld,
2012 LDAPMessage **chain,
2013 LDAP_CONST char *attr,
2014 LDAP_SORT_AD_CMP_PROC *cmp ));
2016 LDAP_F( int ) /* deprecated */
2017 ldap_sort_values LDAP_P((
2020 LDAP_SORT_AV_CMP_PROC *cmp ));
2022 LDAP_F( int ) /* deprecated */
2023 ldap_sort_strcasecmp LDAP_P((
2025 LDAP_CONST void *b ));
2032 ldap_is_ldap_url LDAP_P((
2033 LDAP_CONST char *url ));
2036 ldap_is_ldaps_url LDAP_P((
2037 LDAP_CONST char *url ));
2040 ldap_is_ldapi_url LDAP_P((
2041 LDAP_CONST char *url ));
2044 ldap_url_parse LDAP_P((
2045 LDAP_CONST char *url,
2046 LDAPURLDesc **ludpp ));
2049 ldap_url_desc2str LDAP_P((
2050 LDAPURLDesc *ludp ));
2053 ldap_free_urldesc LDAP_P((
2054 LDAPURLDesc *ludp ));
2058 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2061 #define LDAP_API_FEATURE_CANCEL 1000
2064 ldap_cancel LDAP_P(( LDAP *ld,
2066 LDAPControl **sctrls,
2067 LDAPControl **cctrls,
2071 ldap_cancel_s LDAP_P(( LDAP *ld,
2073 LDAPControl **sctrl,
2074 LDAPControl **cctrl ));
2077 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2080 #define LDAP_API_FEATURE_TURN 1000
2083 ldap_turn LDAP_P(( LDAP *ld,
2085 LDAP_CONST char* identifier,
2086 LDAPControl **sctrls,
2087 LDAPControl **cctrls,
2091 ldap_turn_s LDAP_P(( LDAP *ld,
2093 LDAP_CONST char* identifier,
2094 LDAPControl **sctrl,
2095 LDAPControl **cctrl ));
2098 * LDAP Paged Results
2101 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2104 ldap_create_page_control_value LDAP_P((
2107 struct berval *cookie,
2108 struct berval *value ));
2111 ldap_create_page_control LDAP_P((
2114 struct berval *cookie,
2116 LDAPControl **ctrlp ));
2120 ldap_parse_page_control LDAP_P((
2121 /* deprecated, use ldap_parse_pageresponse_control */
2123 LDAPControl **ctrls,
2125 struct berval **cookie ));
2129 ldap_parse_pageresponse_control LDAP_P((
2133 struct berval *cookie ));
2136 * LDAP Server Side Sort
2139 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2141 /* structure for a sort-key */
2142 typedef struct ldapsortkey {
2143 char *attributeType;
2149 ldap_create_sort_keylist LDAP_P((
2150 LDAPSortKey ***sortKeyList,
2154 ldap_free_sort_keylist LDAP_P((
2155 LDAPSortKey **sortkeylist ));
2158 ldap_create_sort_control_value LDAP_P((
2160 LDAPSortKey **keyList,
2161 struct berval *value ));
2164 ldap_create_sort_control LDAP_P((
2166 LDAPSortKey **keyList,
2168 LDAPControl **ctrlp ));
2171 ldap_parse_sortresponse_control LDAP_P((
2175 char **attribute ));
2178 * LDAP Virtual List View
2181 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2183 /* structure for virtual list */
2184 typedef struct ldapvlvinfo {
2185 ber_int_t ldvlv_version;
2186 ber_int_t ldvlv_before_count;
2187 ber_int_t ldvlv_after_count;
2188 ber_int_t ldvlv_offset;
2189 ber_int_t ldvlv_count;
2190 struct berval * ldvlv_attrvalue;
2191 struct berval * ldvlv_context;
2192 void * ldvlv_extradata;
2196 ldap_create_vlv_control_value LDAP_P((
2198 LDAPVLVInfo *ldvlistp,
2199 struct berval *value));
2202 ldap_create_vlv_control LDAP_P((
2204 LDAPVLVInfo *ldvlistp,
2205 LDAPControl **ctrlp ));
2208 ldap_parse_vlvresponse_control LDAP_P((
2211 ber_int_t *target_posp,
2212 ber_int_t *list_countp,
2213 struct berval **contextp,
2220 #define LDAP_API_FEATURE_WHOAMI 1000
2223 ldap_parse_whoami LDAP_P((
2226 struct berval **authzid ));
2229 ldap_whoami LDAP_P(( LDAP *ld,
2230 LDAPControl **sctrls,
2231 LDAPControl **cctrls,
2235 ldap_whoami_s LDAP_P((
2237 struct berval **authzid,
2238 LDAPControl **sctrls,
2239 LDAPControl **cctrls ));
2242 * LDAP Password Modify
2245 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2248 ldap_parse_passwd LDAP_P((
2251 struct berval *newpasswd ));
2254 ldap_passwd LDAP_P(( LDAP *ld,
2255 struct berval *user,
2256 struct berval *oldpw,
2257 struct berval *newpw,
2258 LDAPControl **sctrls,
2259 LDAPControl **cctrls,
2263 ldap_passwd_s LDAP_P((
2265 struct berval *user,
2266 struct berval *oldpw,
2267 struct berval *newpw,
2268 struct berval *newpasswd,
2269 LDAPControl **sctrls,
2270 LDAPControl **cctrls ));
2272 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2274 * LDAP Password Policy controls
2277 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2279 typedef enum passpolicyerror_enum {
2280 PP_passwordExpired = 0,
2281 PP_accountLocked = 1,
2282 PP_changeAfterReset = 2,
2283 PP_passwordModNotAllowed = 3,
2284 PP_mustSupplyOldPassword = 4,
2285 PP_insufficientPasswordQuality = 5,
2286 PP_passwordTooShort = 6,
2287 PP_passwordTooYoung = 7,
2288 PP_passwordInHistory = 8,
2290 } LDAPPasswordPolicyError;
2293 ldap_create_passwordpolicy_control LDAP_P((
2295 LDAPControl **ctrlp ));
2298 ldap_parse_passwordpolicy_control LDAP_P((
2303 LDAPPasswordPolicyError *errorp ));
2305 LDAP_F( const char * )
2306 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2307 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2310 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2313 #define LDAP_API_FEATURE_REFRESH 1000
2316 ldap_parse_refresh LDAP_P((
2319 ber_int_t *newttl ));
2322 ldap_refresh LDAP_P(( LDAP *ld,
2325 LDAPControl **sctrls,
2326 LDAPControl **cctrls,
2330 ldap_refresh_s LDAP_P((
2335 LDAPControl **sctrls,
2336 LDAPControl **cctrls ));
2343 ldap_txn_start LDAP_P(( LDAP *ld,
2344 LDAPControl **sctrls,
2345 LDAPControl **cctrls,
2349 ldap_txn_start_s LDAP_P(( LDAP *ld,
2350 LDAPControl **sctrl,
2351 LDAPControl **cctrl,
2352 struct berval **rettxnid ));
2355 ldap_txn_end LDAP_P(( LDAP *ld,
2357 struct berval *txnid,
2358 LDAPControl **sctrls,
2359 LDAPControl **cctrls,
2363 ldap_txn_end_s LDAP_P(( LDAP *ld,
2365 struct berval *txnid,
2366 LDAPControl **sctrl,
2367 LDAPControl **cctrl,
2376 * initialize the persistent search structure
2378 LDAP_F( ldap_sync_t * )
2379 ldap_sync_initialize LDAP_P((
2383 * destroy the persistent search structure
2386 ldap_sync_destroy LDAP_P((
2391 * initialize a refreshOnly sync
2394 ldap_sync_init LDAP_P((
2399 * initialize a refreshOnly sync
2402 ldap_sync_init_refresh_only LDAP_P((
2406 * initialize a refreshAndPersist sync
2409 ldap_sync_init_refresh_and_persist LDAP_P((
2413 * poll for new responses
2416 ldap_sync_poll LDAP_P((
2419 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2425 ldap_create_session_tracking_value LDAP_P((
2427 char *sessionSourceIp,
2428 char *sessionSourceName,
2430 struct berval *sessionTrackingIdentifier,
2431 struct berval *value ));
2434 ldap_create_session_tracking_control LDAP_P((
2436 char *sessionSourceIp,
2437 char *sessionSourceName,
2439 struct berval *sessionTrackingIdentifier,
2440 LDAPControl **ctrlp ));
2443 ldap_parse_session_tracking_control LDAP_P((
2447 struct berval *name,
2449 struct berval *id ));
2451 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2457 ldap_create_assertion_control_value LDAP_P((
2460 struct berval *value ));
2463 ldap_create_assertion_control LDAP_P((
2467 LDAPControl **ctrlp ));
2473 typedef struct LDAPDerefSpec {
2478 typedef struct LDAPDerefVal {
2481 struct LDAPDerefVal *next;
2484 typedef struct LDAPDerefRes {
2486 struct berval derefVal;
2487 LDAPDerefVal *attrVals;
2488 struct LDAPDerefRes *next;
2492 ldap_create_deref_control_value LDAP_P((
2495 struct berval *value ));
2498 ldap_create_deref_control LDAP_P((
2502 LDAPControl **ctrlp ));
2505 ldap_derefresponse_free LDAP_P((
2506 LDAPDerefRes *dr ));
2509 ldap_parse_derefresponse_control LDAP_P((
2512 LDAPDerefRes **drp ));
2515 ldap_parse_deref_control LDAP_P((
2517 LDAPControl **ctrls,
2518 LDAPDerefRes **drp ));
2521 #endif /* _LDAP_H */