2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2017 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
299 /* LDAP Don't Use Copy Control (RFC 6171) */
300 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.1.22"
302 /* Password policy Controls *//* work in progress */
303 /* ITS#3458: released; disabled by default */
304 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
305 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
307 /* various works in progress */
308 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
309 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
310 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
311 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
312 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
313 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
314 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
315 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
317 /* LDAP Chaining Behavior Control *//* work in progress */
318 /* <draft-sermersheim-ldap-chaining>;
319 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
320 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
322 #define LDAP_CHAINING_PREFERRED 0
323 #define LDAP_CHAINING_REQUIRED 1
324 #define LDAP_REFERRALS_PREFERRED 2
325 #define LDAP_REFERRALS_REQUIRED 3
327 /* MS Active Directory controls (for compatibility) */
328 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
329 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
330 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
331 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
332 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
333 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
334 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
336 /* MS Active Directory controls - not implemented in slapd(8) */
337 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
339 /* <draft-wahl-ldap-session> */
340 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
341 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
342 LDAP_CONTROL_X_SESSION_TRACKING ".1"
343 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
344 LDAP_CONTROL_X_SESSION_TRACKING ".2"
345 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
346 LDAP_CONTROL_X_SESSION_TRACKING ".3"
347 /* various expired works */
349 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
350 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
351 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
352 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
353 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
355 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
356 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
357 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
358 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
359 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
360 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
361 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
364 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
365 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
367 /* LDAP Unsolicited Notifications */
368 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
369 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
371 /* LDAP Extended Operations */
372 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
374 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
375 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
376 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
377 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
378 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
380 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
381 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
383 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
384 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
385 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
386 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x81U)
388 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
389 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
391 /* various works in progress */
392 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
393 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
395 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
396 /* a work in progress */
397 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
398 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
399 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
400 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
401 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
402 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
403 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
404 LDAP_X_DISTPROC_BASE ".6"
405 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
406 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
407 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
408 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
409 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
412 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
413 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
414 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
415 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
416 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
420 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
421 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
422 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
423 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
424 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
425 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
426 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
428 /* LDAP Experimental (works in progress) Features */
429 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
430 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
431 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
434 * specific LDAP instantiations of BER types we know about
437 /* Overview of LBER tag construction
444 * 1 0 = CONTEXT-SPECIFIC
451 * | 5 ... 1 | TAG-NUMBER
455 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
456 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
458 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
459 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
461 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
462 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
464 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
466 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
467 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
468 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
469 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
471 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
472 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
474 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
476 /* LDAP Request Messages */
477 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
478 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
479 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
480 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
481 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
482 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
483 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
484 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
485 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
486 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
487 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
488 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
490 /* LDAP Response Messages */
491 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
492 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
493 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
494 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
495 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
496 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
497 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
498 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
499 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
500 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
501 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
502 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
503 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
505 #define LDAP_RES_ANY (-1)
506 #define LDAP_RES_UNSOLICITED (0)
510 #define LDAP_SASL_SIMPLE ((char*)0)
511 #define LDAP_SASL_NULL ("")
514 /* authentication methods available */
515 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
516 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
517 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
518 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
519 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
520 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
522 /* used by the Windows API but not used on the wire */
523 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
526 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
527 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
528 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
529 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
530 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
531 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
532 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
533 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
534 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
535 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
537 /* extended filter component types */
538 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
539 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
540 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
541 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
543 /* substring filter component types */
544 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
545 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
546 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
549 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
550 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
551 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
552 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
553 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
554 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
555 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
556 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
557 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
559 /* substring filter component types */
560 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
561 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
562 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
567 #define LDAP_SUCCESS 0x00
569 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
571 #define LDAP_OPERATIONS_ERROR 0x01
572 #define LDAP_PROTOCOL_ERROR 0x02
573 #define LDAP_TIMELIMIT_EXCEEDED 0x03
574 #define LDAP_SIZELIMIT_EXCEEDED 0x04
575 #define LDAP_COMPARE_FALSE 0x05
576 #define LDAP_COMPARE_TRUE 0x06
577 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
578 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
579 #define LDAP_STRONG_AUTH_REQUIRED 0x08
580 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
581 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
583 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
584 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
585 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
586 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
587 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
589 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
591 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
592 #define LDAP_UNDEFINED_TYPE 0x11
593 #define LDAP_INAPPROPRIATE_MATCHING 0x12
594 #define LDAP_CONSTRAINT_VIOLATION 0x13
595 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
596 #define LDAP_INVALID_SYNTAX 0x15
598 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
600 #define LDAP_NO_SUCH_OBJECT 0x20
601 #define LDAP_ALIAS_PROBLEM 0x21
602 #define LDAP_INVALID_DN_SYNTAX 0x22
603 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
604 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
606 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
608 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
609 #define LDAP_INAPPROPRIATE_AUTH 0x30
610 #define LDAP_INVALID_CREDENTIALS 0x31
611 #define LDAP_INSUFFICIENT_ACCESS 0x32
613 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
615 #define LDAP_BUSY 0x33
616 #define LDAP_UNAVAILABLE 0x34
617 #define LDAP_UNWILLING_TO_PERFORM 0x35
618 #define LDAP_LOOP_DETECT 0x36
620 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
622 #define LDAP_NAMING_VIOLATION 0x40
623 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
624 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
625 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
626 #define LDAP_ALREADY_EXISTS 0x44
627 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
628 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
629 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
631 #define LDAP_VLV_ERROR 0x4C
633 #define LDAP_OTHER 0x50
635 /* LCUP operation codes (113-117) - not implemented */
636 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
637 #define LDAP_CUP_SECURITY_VIOLATION 0x72
638 #define LDAP_CUP_INVALID_DATA 0x73
639 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
640 #define LDAP_CUP_RELOAD_REQUIRED 0x75
642 /* Cancel operation codes (118-121) */
643 #define LDAP_CANCELLED 0x76
644 #define LDAP_NO_SUCH_OPERATION 0x77
645 #define LDAP_TOO_LATE 0x78
646 #define LDAP_CANNOT_CANCEL 0x79
648 /* Assertion control (122) */
649 #define LDAP_ASSERTION_FAILED 0x7A
651 /* Proxied Authorization Denied (123) */
652 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
654 /* Experimental result codes */
655 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
657 /* LDAP Sync (4096) */
658 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
661 /* Private Use result codes */
662 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
664 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
665 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
667 /* for the LDAP No-Op control */
668 #define LDAP_X_NO_OPERATION 0x410e
670 /* for the Chaining Behavior control (consecutive result codes requested;
671 * see <draft-sermersheim-ldap-chaining> ) */
672 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
673 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
674 #define LDAP_X_CANNOT_CHAIN 0x4111
677 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
678 #ifdef LDAP_X_DISTPROC_BASE
679 #define LDAP_X_INVALIDREFERENCE 0x4112
683 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
684 #define LDAP_X_TXN_ID_INVALID 0x4121
689 * Based on draft-ietf-ldap-c-api-xx
690 * but with new negative code values
692 #define LDAP_API_ERROR(n) ((n)<0)
693 #define LDAP_API_RESULT(n) ((n)<=0)
695 #define LDAP_SERVER_DOWN (-1)
696 #define LDAP_LOCAL_ERROR (-2)
697 #define LDAP_ENCODING_ERROR (-3)
698 #define LDAP_DECODING_ERROR (-4)
699 #define LDAP_TIMEOUT (-5)
700 #define LDAP_AUTH_UNKNOWN (-6)
701 #define LDAP_FILTER_ERROR (-7)
702 #define LDAP_USER_CANCELLED (-8)
703 #define LDAP_PARAM_ERROR (-9)
704 #define LDAP_NO_MEMORY (-10)
705 #define LDAP_CONNECT_ERROR (-11)
706 #define LDAP_NOT_SUPPORTED (-12)
707 #define LDAP_CONTROL_NOT_FOUND (-13)
708 #define LDAP_NO_RESULTS_RETURNED (-14)
709 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
710 #define LDAP_CLIENT_LOOP (-16)
711 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
712 #define LDAP_X_CONNECTING (-18)
716 * This structure represents both ldap messages and ldap responses.
717 * These are really the same, except in the case of search responses,
718 * where a response has multiple messages.
721 typedef struct ldapmsg LDAPMessage;
723 /* for modifications */
724 typedef struct ldapmod {
727 #define LDAP_MOD_OP (0x0007)
728 #define LDAP_MOD_ADD (0x0000)
729 #define LDAP_MOD_DELETE (0x0001)
730 #define LDAP_MOD_REPLACE (0x0002)
731 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
732 #define LDAP_MOD_BVALUES (0x0080)
733 /* IMPORTANT: do not use code 0x1000 (or above),
734 * it is used internally by the backends!
735 * (see ldap/servers/slapd/slap.h)
741 struct berval **modv_bvals;
743 #define mod_values mod_vals.modv_strvals
744 #define mod_bvalues mod_vals.modv_bvals
748 * structure representing an ldap session which can
749 * encompass connections to multiple servers (in the
750 * face of referrals).
752 typedef struct ldap LDAP;
754 #define LDAP_DEREF_NEVER 0x00
755 #define LDAP_DEREF_SEARCHING 0x01
756 #define LDAP_DEREF_FINDING 0x02
757 #define LDAP_DEREF_ALWAYS 0x03
759 #define LDAP_NO_LIMIT 0
761 /* how many messages to retrieve results for */
762 #define LDAP_MSG_ONE 0x00
763 #define LDAP_MSG_ALL 0x01
764 #define LDAP_MSG_RECEIVED 0x02
767 * types for ldap URL handling
769 typedef struct ldap_url_desc {
770 struct ldap_url_desc *lud_next;
782 #define LDAP_URL_SUCCESS 0x00 /* Success */
783 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
784 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
786 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
787 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
788 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
789 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
790 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
791 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
792 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
793 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
796 * LDAP sync (RFC4533) API
799 typedef struct ldap_sync_t ldap_sync_t;
802 /* these are private - the client should never see them */
803 LDAP_SYNC_CAPI_NONE = -1,
805 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
806 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
807 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
809 /* these are passed to ls_search_entry() */
810 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
811 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
812 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
813 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
815 /* these are passed to ls_intermediate() */
816 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
817 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
819 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
820 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
822 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
823 } ldap_sync_refresh_t;
826 * Called when an entry is returned by ldap_result().
827 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
828 * the entry has been either added or modified, and thus
829 * the complete view of the entry should be in the LDAPMessage.
830 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
831 * only the DN should be in the LDAPMessage.
833 typedef int (*ldap_sync_search_entry_f) LDAP_P((
836 struct berval *entryUUID,
837 ldap_sync_refresh_t phase ));
840 * Called when a reference is returned; the client should know
841 * what to do with it.
843 typedef int (*ldap_sync_search_reference_f) LDAP_P((
848 * Called when specific intermediate/final messages are returned.
849 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
850 * a "presents" or "deletes" phase begins.
851 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
852 * with refreshDone set to "TRUE" has been returned, to indicate
853 * that the refresh phase of a refreshAndPersist is complete.
854 * In the above cases, syncUUIDs is NULL.
856 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
857 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
858 * that are either present or have been deleted.
860 typedef int (*ldap_sync_intermediate_f) LDAP_P((
864 ldap_sync_refresh_t phase ));
867 * Called when a searchResultDone is returned. In refreshAndPersist,
868 * this can only occur if the search for any reason is being terminated
871 typedef int (*ldap_sync_search_result_f) LDAP_P((
874 int refreshDeletes ));
877 * This structure contains all information about the persistent search;
878 * the caller is responsible for connecting, setting version, binding, tls...
881 /* conf search params */
892 /* helpers - add as appropriate */
893 ldap_sync_search_entry_f ls_search_entry;
894 ldap_sync_search_reference_f ls_search_reference;
895 ldap_sync_intermediate_f ls_intermediate;
896 ldap_sync_search_result_f ls_search_result;
898 /* set by the caller as appropriate */
904 /* --- the parameters below are private - do not modify --- */
906 /* FIXME: make the structure opaque, and provide an interface
907 * to modify the public values? */
913 /* needed by refreshOnly */
916 /* opaque - need to pass between sessions, updated by the API */
917 struct berval ls_cookie;
919 /* state variable - do not modify */
920 ldap_sync_refresh_t ls_refreshPhase;
924 * End of LDAP sync (RFC4533) API
928 * Connection callbacks...
933 /* Called after a connection is established */
934 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
935 struct ldap_conncb *ctx ));
936 /* Called before a connection is closed */
937 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
939 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
940 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
942 typedef struct ldap_conncb {
943 ldap_conn_add_f *lc_add;
944 ldap_conn_del_f *lc_del;
949 * The API draft spec says we should declare (or cause to be declared)
950 * 'struct timeval'. We don't. See IETF LDAPext discussions.
958 ldap_get_option LDAP_P((
964 ldap_set_option LDAP_P((
967 LDAP_CONST void *invalue));
969 /* V3 REBIND Function Callback Prototype */
970 typedef int (LDAP_REBIND_PROC) LDAP_P((
971 LDAP *ld, LDAP_CONST char *url,
972 ber_tag_t request, ber_int_t msgid,
976 ldap_set_rebind_proc LDAP_P((
978 LDAP_REBIND_PROC *rebind_proc,
981 /* V3 referral selection Function Callback Prototype */
982 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
983 LDAP *ld, char ***refsp, int *cntp,
987 ldap_set_nextref_proc LDAP_P((
989 LDAP_NEXTREF_PROC *nextref_proc,
992 /* V3 URLLIST Function Callback Prototype */
993 typedef int (LDAP_URLLIST_PROC) LDAP_P((
995 LDAPURLDesc **urllist,
1000 ldap_set_urllist_proc LDAP_P((
1002 LDAP_URLLIST_PROC *urllist_proc,
1010 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
1011 LDAP_CONST char *requestOID,
1014 LDAPControl **ctrlp ));
1016 LDAP_F( LDAPControl * )
1017 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
1018 LDAP_CONST char *oid,
1019 LDAPControl **ctrls ));
1023 ldap_control_create LDAP_P((
1024 LDAP_CONST char *requestOID,
1026 struct berval *value,
1028 LDAPControl **ctrlp ));
1030 LDAP_F( LDAPControl * )
1031 ldap_control_find LDAP_P((
1032 LDAP_CONST char *oid,
1033 LDAPControl **ctrls,
1034 LDAPControl ***nextctrlp ));
1037 ldap_control_free LDAP_P((
1038 LDAPControl *ctrl ));
1041 ldap_controls_free LDAP_P((
1042 LDAPControl **ctrls ));
1044 LDAP_F( LDAPControl ** )
1045 ldap_controls_dup LDAP_P((
1046 LDAPControl *LDAP_CONST *controls ));
1048 LDAP_F( LDAPControl * )
1049 ldap_control_dup LDAP_P((
1050 LDAP_CONST LDAPControl *c ));
1056 ldap_domain2dn LDAP_P((
1057 LDAP_CONST char* domain,
1061 ldap_dn2domain LDAP_P((
1062 LDAP_CONST char* dn,
1066 ldap_domain2hostlist LDAP_P((
1067 LDAP_CONST char *domain,
1074 ldap_extended_operation LDAP_P((
1076 LDAP_CONST char *reqoid,
1077 struct berval *reqdata,
1078 LDAPControl **serverctrls,
1079 LDAPControl **clientctrls,
1083 ldap_extended_operation_s LDAP_P((
1085 LDAP_CONST char *reqoid,
1086 struct berval *reqdata,
1087 LDAPControl **serverctrls,
1088 LDAPControl **clientctrls,
1090 struct berval **retdatap ));
1093 ldap_parse_extended_result LDAP_P((
1097 struct berval **retdatap,
1101 ldap_parse_intermediate LDAP_P((
1105 struct berval **retdatap,
1106 LDAPControl ***serverctrls,
1114 ldap_abandon_ext LDAP_P((
1117 LDAPControl **serverctrls,
1118 LDAPControl **clientctrls ));
1122 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1131 ldap_add_ext LDAP_P((
1133 LDAP_CONST char *dn,
1135 LDAPControl **serverctrls,
1136 LDAPControl **clientctrls,
1140 ldap_add_ext_s LDAP_P((
1142 LDAP_CONST char *dn,
1144 LDAPControl **serverctrls,
1145 LDAPControl **clientctrls ));
1149 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1151 LDAP_CONST char *dn,
1155 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1157 LDAP_CONST char *dn,
1166 ldap_sasl_bind LDAP_P((
1168 LDAP_CONST char *dn,
1169 LDAP_CONST char *mechanism,
1170 struct berval *cred,
1171 LDAPControl **serverctrls,
1172 LDAPControl **clientctrls,
1175 /* Interaction flags (should be passed about in a control)
1176 * Automatic (default): use defaults, prompt otherwise
1177 * Interactive: prompt always
1178 * Quiet: never prompt
1180 #define LDAP_SASL_AUTOMATIC 0U
1181 #define LDAP_SASL_INTERACTIVE 1U
1182 #define LDAP_SASL_QUIET 2U
1185 * V3 SASL Interaction Function Callback Prototype
1186 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1187 * should likely passed in a control (and provided controls)
1189 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1190 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1193 ldap_sasl_interactive_bind LDAP_P((
1195 LDAP_CONST char *dn, /* usually NULL */
1196 LDAP_CONST char *saslMechanism,
1197 LDAPControl **serverControls,
1198 LDAPControl **clientControls,
1200 /* should be client controls */
1202 LDAP_SASL_INTERACT_PROC *proc,
1205 /* as obtained from ldap_result() */
1206 LDAPMessage *result,
1208 /* returned during bind processing */
1213 ldap_sasl_interactive_bind_s LDAP_P((
1215 LDAP_CONST char *dn, /* usually NULL */
1216 LDAP_CONST char *saslMechanism,
1217 LDAPControl **serverControls,
1218 LDAPControl **clientControls,
1220 /* should be client controls */
1222 LDAP_SASL_INTERACT_PROC *proc,
1226 ldap_sasl_bind_s LDAP_P((
1228 LDAP_CONST char *dn,
1229 LDAP_CONST char *mechanism,
1230 struct berval *cred,
1231 LDAPControl **serverctrls,
1232 LDAPControl **clientctrls,
1233 struct berval **servercredp ));
1236 ldap_parse_sasl_bind_result LDAP_P((
1239 struct berval **servercredp,
1248 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1250 LDAP_CONST char *who,
1251 LDAP_CONST char *passwd,
1255 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1257 LDAP_CONST char *who,
1258 LDAP_CONST char *cred,
1265 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1267 LDAP_CONST char *who,
1268 LDAP_CONST char *passwd ));
1271 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1273 LDAP_CONST char *who,
1274 LDAP_CONST char *passwd ));
1283 ldap_compare_ext LDAP_P((
1285 LDAP_CONST char *dn,
1286 LDAP_CONST char *attr,
1287 struct berval *bvalue,
1288 LDAPControl **serverctrls,
1289 LDAPControl **clientctrls,
1293 ldap_compare_ext_s LDAP_P((
1295 LDAP_CONST char *dn,
1296 LDAP_CONST char *attr,
1297 struct berval *bvalue,
1298 LDAPControl **serverctrls,
1299 LDAPControl **clientctrls ));
1303 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1305 LDAP_CONST char *dn,
1306 LDAP_CONST char *attr,
1307 LDAP_CONST char *value ));
1310 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1312 LDAP_CONST char *dn,
1313 LDAP_CONST char *attr,
1314 LDAP_CONST char *value ));
1322 ldap_delete_ext LDAP_P((
1324 LDAP_CONST char *dn,
1325 LDAPControl **serverctrls,
1326 LDAPControl **clientctrls,
1330 ldap_delete_ext_s LDAP_P((
1332 LDAP_CONST char *dn,
1333 LDAPControl **serverctrls,
1334 LDAPControl **clientctrls ));
1338 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1340 LDAP_CONST char *dn ));
1343 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1345 LDAP_CONST char *dn ));
1353 ldap_parse_result LDAP_P((
1360 LDAPControl ***serverctrls,
1364 ldap_err2string LDAP_P((
1369 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1375 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1377 LDAP_CONST char *s ));
1385 ldap_gssapi_bind LDAP_P((
1387 LDAP_CONST char *dn,
1388 LDAP_CONST char *creds ));
1391 ldap_gssapi_bind_s LDAP_P((
1393 LDAP_CONST char *dn,
1394 LDAP_CONST char *creds ));
1401 ldap_modify_ext LDAP_P((
1403 LDAP_CONST char *dn,
1405 LDAPControl **serverctrls,
1406 LDAPControl **clientctrls,
1410 ldap_modify_ext_s LDAP_P((
1412 LDAP_CONST char *dn,
1414 LDAPControl **serverctrls,
1415 LDAPControl **clientctrls ));
1419 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1421 LDAP_CONST char *dn,
1425 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1427 LDAP_CONST char *dn,
1436 ldap_rename LDAP_P((
1438 LDAP_CONST char *dn,
1439 LDAP_CONST char *newrdn,
1440 LDAP_CONST char *newSuperior,
1442 LDAPControl **sctrls,
1443 LDAPControl **cctrls,
1447 ldap_rename_s 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_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1460 LDAP_CONST char *dn,
1461 LDAP_CONST char *newrdn,
1462 LDAP_CONST char *newSuperior,
1463 int deleteoldrdn ));
1466 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1468 LDAP_CONST char *dn,
1469 LDAP_CONST char *newrdn,
1470 LDAP_CONST char *newSuperior,
1471 int deleteoldrdn ));
1474 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1476 LDAP_CONST char *dn,
1477 LDAP_CONST char *newrdn ));
1480 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1482 LDAP_CONST char *dn,
1483 LDAP_CONST char *newrdn ));
1486 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1488 LDAP_CONST char *dn,
1489 LDAP_CONST char *newrdn,
1490 int deleteoldrdn ));
1493 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1495 LDAP_CONST char *dn,
1496 LDAP_CONST char *newrdn,
1506 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1507 LDAP_CONST char *host,
1511 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1512 LDAP_CONST char *host,
1517 ldap_create LDAP_P((
1521 ldap_initialize LDAP_P((
1523 LDAP_CONST char *url ));
1534 ldap_tls_inplace LDAP_P((
1538 ldap_start_tls LDAP_P((
1540 LDAPControl **serverctrls,
1541 LDAPControl **clientctrls,
1545 ldap_install_tls LDAP_P((
1549 ldap_start_tls_s LDAP_P((
1551 LDAPControl **serverctrls,
1552 LDAPControl **clientctrls ));
1557 LDAP_F( LDAPMessage * )
1558 ldap_first_message LDAP_P((
1560 LDAPMessage *chain ));
1562 LDAP_F( LDAPMessage * )
1563 ldap_next_message LDAP_P((
1565 LDAPMessage *msg ));
1568 ldap_count_messages LDAP_P((
1570 LDAPMessage *chain ));
1575 LDAP_F( LDAPMessage * )
1576 ldap_first_reference LDAP_P((
1578 LDAPMessage *chain ));
1580 LDAP_F( LDAPMessage * )
1581 ldap_next_reference LDAP_P((
1583 LDAPMessage *ref ));
1586 ldap_count_references LDAP_P((
1588 LDAPMessage *chain ));
1591 ldap_parse_reference LDAP_P((
1595 LDAPControl ***serverctrls,
1602 LDAP_F( LDAPMessage * )
1603 ldap_first_entry LDAP_P((
1605 LDAPMessage *chain ));
1607 LDAP_F( LDAPMessage * )
1608 ldap_next_entry LDAP_P((
1610 LDAPMessage *entry ));
1613 ldap_count_entries LDAP_P((
1615 LDAPMessage *chain ));
1618 ldap_get_entry_controls LDAP_P((
1621 LDAPControl ***serverctrls));
1627 LDAP_F( LDAPMessage * )
1628 ldap_delete_result_entry LDAP_P((
1633 ldap_add_result_entry LDAP_P((
1642 ldap_get_dn LDAP_P((
1644 LDAPMessage *entry ));
1646 typedef struct ldap_ava {
1647 struct berval la_attr;
1648 struct berval la_value;
1650 #define LDAP_AVA_NULL 0x0000U
1651 #define LDAP_AVA_STRING 0x0001U
1652 #define LDAP_AVA_BINARY 0x0002U
1653 #define LDAP_AVA_NONPRINTABLE 0x0004U
1654 #define LDAP_AVA_FREE_ATTR 0x0010U
1655 #define LDAP_AVA_FREE_VALUE 0x0020U
1660 typedef LDAPAVA** LDAPRDN;
1661 typedef LDAPRDN* LDAPDN;
1664 #define LDAP_DN_FORMAT_LDAP 0x0000U
1665 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1666 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1667 #define LDAP_DN_FORMAT_DCE 0x0030U
1668 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1669 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1670 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1671 #define LDAP_DN_FORMAT_MASK 0x00F0U
1674 #define LDAP_DN_PRETTY 0x0100U
1675 #define LDAP_DN_SKIP 0x0200U
1676 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1677 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1678 #define LDAP_DN_PEDANTIC 0xF000U
1680 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1681 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1690 ldap_str2dn LDAP_P((
1691 LDAP_CONST char *str,
1702 ldap_dn2str LDAP_P((
1708 ldap_bv2rdn LDAP_P((
1715 ldap_str2rdn LDAP_P((
1716 LDAP_CONST char *str,
1722 ldap_rdn2bv LDAP_P((
1728 ldap_rdn2str LDAP_P((
1734 ldap_dn_normalize LDAP_P((
1735 LDAP_CONST char *in, unsigned iflags,
1736 char **out, unsigned oflags ));
1739 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1740 LDAP_CONST char *dn ));
1743 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1744 LDAP_CONST char *dn,
1748 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1749 LDAP_CONST char *rdn,
1752 typedef int LDAPDN_rewrite_func
1753 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1756 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1757 LDAPDN_rewrite_func *func, unsigned flags ));
1760 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1761 LDAP_CONST char *dn ));
1764 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1765 LDAP_CONST char *dce ));
1768 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1769 LDAP_CONST char *dn ));
1772 ldap_get_dn_ber LDAP_P((
1773 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1776 ldap_get_attribute_ber LDAP_P((
1777 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1778 struct berval **vals ));
1784 ldap_first_attribute LDAP_P((
1787 BerElement **ber ));
1790 ldap_next_attribute LDAP_P((
1799 LDAP_F( struct berval ** )
1800 ldap_get_values_len LDAP_P((
1803 LDAP_CONST char *target ));
1806 ldap_count_values_len LDAP_P((
1807 struct berval **vals ));
1810 ldap_value_free_len LDAP_P((
1811 struct berval **vals ));
1815 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1818 LDAP_CONST char *target ));
1821 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1825 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1833 ldap_result LDAP_P((
1837 struct timeval *timeout,
1838 LDAPMessage **result ));
1841 ldap_msgtype LDAP_P((
1849 ldap_msgfree LDAP_P((
1853 ldap_msgdelete LDAP_P((
1862 ldap_bv2escaped_filter_value LDAP_P((
1864 struct berval *out ));
1867 ldap_search_ext LDAP_P((
1869 LDAP_CONST char *base,
1871 LDAP_CONST char *filter,
1874 LDAPControl **serverctrls,
1875 LDAPControl **clientctrls,
1876 struct timeval *timeout,
1881 ldap_search_ext_s LDAP_P((
1883 LDAP_CONST char *base,
1885 LDAP_CONST char *filter,
1888 LDAPControl **serverctrls,
1889 LDAPControl **clientctrls,
1890 struct timeval *timeout,
1892 LDAPMessage **res ));
1896 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1898 LDAP_CONST char *base,
1900 LDAP_CONST char *filter,
1905 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1907 LDAP_CONST char *base,
1909 LDAP_CONST char *filter,
1912 LDAPMessage **res ));
1915 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1917 LDAP_CONST char *base,
1919 LDAP_CONST char *filter,
1922 struct timeval *timeout,
1923 LDAPMessage **res ));
1930 ldap_unbind_ext LDAP_P((
1932 LDAPControl **serverctrls,
1933 LDAPControl **clientctrls));
1936 ldap_unbind_ext_s LDAP_P((
1938 LDAPControl **serverctrls,
1939 LDAPControl **clientctrls));
1942 ldap_destroy LDAP_P((
1947 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1951 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1959 ldap_put_vrFilter LDAP_P((
1968 ldap_memalloc LDAP_P((
1972 ldap_memrealloc LDAP_P((
1977 ldap_memcalloc LDAP_P((
1982 ldap_memfree LDAP_P((
1986 ldap_memvfree LDAP_P((
1990 ldap_strdup LDAP_P((
1991 LDAP_CONST char * ));
1994 ldap_mods_free LDAP_P((
2001 * in sort.c (deprecated, use custom code instead)
2003 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
2004 LDAP_CONST char *left,
2005 LDAP_CONST char *right ));
2007 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
2008 LDAP_CONST void *left,
2009 LDAP_CONST void *right ));
2011 LDAP_F( int ) /* deprecated */
2012 ldap_sort_entries LDAP_P(( LDAP *ld,
2013 LDAPMessage **chain,
2014 LDAP_CONST char *attr,
2015 LDAP_SORT_AD_CMP_PROC *cmp ));
2017 LDAP_F( int ) /* deprecated */
2018 ldap_sort_values LDAP_P((
2021 LDAP_SORT_AV_CMP_PROC *cmp ));
2023 LDAP_F( int ) /* deprecated */
2024 ldap_sort_strcasecmp LDAP_P((
2026 LDAP_CONST void *b ));
2033 ldap_is_ldap_url LDAP_P((
2034 LDAP_CONST char *url ));
2037 ldap_is_ldaps_url LDAP_P((
2038 LDAP_CONST char *url ));
2041 ldap_is_ldapi_url LDAP_P((
2042 LDAP_CONST char *url ));
2045 ldap_url_parse LDAP_P((
2046 LDAP_CONST char *url,
2047 LDAPURLDesc **ludpp ));
2050 ldap_url_desc2str LDAP_P((
2051 LDAPURLDesc *ludp ));
2054 ldap_free_urldesc LDAP_P((
2055 LDAPURLDesc *ludp ));
2059 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2062 #define LDAP_API_FEATURE_CANCEL 1000
2065 ldap_cancel LDAP_P(( LDAP *ld,
2067 LDAPControl **sctrls,
2068 LDAPControl **cctrls,
2072 ldap_cancel_s LDAP_P(( LDAP *ld,
2074 LDAPControl **sctrl,
2075 LDAPControl **cctrl ));
2078 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2081 #define LDAP_API_FEATURE_TURN 1000
2084 ldap_turn LDAP_P(( LDAP *ld,
2086 LDAP_CONST char* identifier,
2087 LDAPControl **sctrls,
2088 LDAPControl **cctrls,
2092 ldap_turn_s LDAP_P(( LDAP *ld,
2094 LDAP_CONST char* identifier,
2095 LDAPControl **sctrl,
2096 LDAPControl **cctrl ));
2099 * LDAP Paged Results
2102 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2105 ldap_create_page_control_value LDAP_P((
2108 struct berval *cookie,
2109 struct berval *value ));
2112 ldap_create_page_control LDAP_P((
2115 struct berval *cookie,
2117 LDAPControl **ctrlp ));
2121 ldap_parse_page_control LDAP_P((
2122 /* deprecated, use ldap_parse_pageresponse_control */
2124 LDAPControl **ctrls,
2126 struct berval **cookie ));
2130 ldap_parse_pageresponse_control LDAP_P((
2134 struct berval *cookie ));
2137 * LDAP Server Side Sort
2140 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2142 /* structure for a sort-key */
2143 typedef struct ldapsortkey {
2144 char *attributeType;
2150 ldap_create_sort_keylist LDAP_P((
2151 LDAPSortKey ***sortKeyList,
2155 ldap_free_sort_keylist LDAP_P((
2156 LDAPSortKey **sortkeylist ));
2159 ldap_create_sort_control_value LDAP_P((
2161 LDAPSortKey **keyList,
2162 struct berval *value ));
2165 ldap_create_sort_control LDAP_P((
2167 LDAPSortKey **keyList,
2169 LDAPControl **ctrlp ));
2172 ldap_parse_sortresponse_control LDAP_P((
2176 char **attribute ));
2179 * LDAP Virtual List View
2182 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2184 /* structure for virtual list */
2185 typedef struct ldapvlvinfo {
2186 ber_int_t ldvlv_version;
2187 ber_int_t ldvlv_before_count;
2188 ber_int_t ldvlv_after_count;
2189 ber_int_t ldvlv_offset;
2190 ber_int_t ldvlv_count;
2191 struct berval * ldvlv_attrvalue;
2192 struct berval * ldvlv_context;
2193 void * ldvlv_extradata;
2197 ldap_create_vlv_control_value LDAP_P((
2199 LDAPVLVInfo *ldvlistp,
2200 struct berval *value));
2203 ldap_create_vlv_control LDAP_P((
2205 LDAPVLVInfo *ldvlistp,
2206 LDAPControl **ctrlp ));
2209 ldap_parse_vlvresponse_control LDAP_P((
2212 ber_int_t *target_posp,
2213 ber_int_t *list_countp,
2214 struct berval **contextp,
2221 #define LDAP_API_FEATURE_WHOAMI 1000
2224 ldap_parse_whoami LDAP_P((
2227 struct berval **authzid ));
2230 ldap_whoami LDAP_P(( LDAP *ld,
2231 LDAPControl **sctrls,
2232 LDAPControl **cctrls,
2236 ldap_whoami_s LDAP_P((
2238 struct berval **authzid,
2239 LDAPControl **sctrls,
2240 LDAPControl **cctrls ));
2243 * LDAP Password Modify
2246 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2249 ldap_parse_passwd LDAP_P((
2252 struct berval *newpasswd ));
2255 ldap_passwd LDAP_P(( LDAP *ld,
2256 struct berval *user,
2257 struct berval *oldpw,
2258 struct berval *newpw,
2259 LDAPControl **sctrls,
2260 LDAPControl **cctrls,
2264 ldap_passwd_s LDAP_P((
2266 struct berval *user,
2267 struct berval *oldpw,
2268 struct berval *newpw,
2269 struct berval *newpasswd,
2270 LDAPControl **sctrls,
2271 LDAPControl **cctrls ));
2273 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2275 * LDAP Password Policy controls
2278 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2280 typedef enum passpolicyerror_enum {
2281 PP_passwordExpired = 0,
2282 PP_accountLocked = 1,
2283 PP_changeAfterReset = 2,
2284 PP_passwordModNotAllowed = 3,
2285 PP_mustSupplyOldPassword = 4,
2286 PP_insufficientPasswordQuality = 5,
2287 PP_passwordTooShort = 6,
2288 PP_passwordTooYoung = 7,
2289 PP_passwordInHistory = 8,
2291 } LDAPPasswordPolicyError;
2294 ldap_create_passwordpolicy_control LDAP_P((
2296 LDAPControl **ctrlp ));
2299 ldap_parse_passwordpolicy_control LDAP_P((
2304 LDAPPasswordPolicyError *errorp ));
2306 LDAP_F( const char * )
2307 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2308 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2311 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2314 #define LDAP_API_FEATURE_REFRESH 1000
2317 ldap_parse_refresh LDAP_P((
2320 ber_int_t *newttl ));
2323 ldap_refresh LDAP_P(( LDAP *ld,
2326 LDAPControl **sctrls,
2327 LDAPControl **cctrls,
2331 ldap_refresh_s LDAP_P((
2336 LDAPControl **sctrls,
2337 LDAPControl **cctrls ));
2344 ldap_txn_start LDAP_P(( LDAP *ld,
2345 LDAPControl **sctrls,
2346 LDAPControl **cctrls,
2350 ldap_txn_start_s LDAP_P(( LDAP *ld,
2351 LDAPControl **sctrl,
2352 LDAPControl **cctrl,
2353 struct berval **rettxnid ));
2356 ldap_txn_end LDAP_P(( LDAP *ld,
2358 struct berval *txnid,
2359 LDAPControl **sctrls,
2360 LDAPControl **cctrls,
2364 ldap_txn_end_s LDAP_P(( LDAP *ld,
2366 struct berval *txnid,
2367 LDAPControl **sctrl,
2368 LDAPControl **cctrl,
2377 * initialize the persistent search structure
2379 LDAP_F( ldap_sync_t * )
2380 ldap_sync_initialize LDAP_P((
2384 * destroy the persistent search structure
2387 ldap_sync_destroy LDAP_P((
2392 * initialize a refreshOnly sync
2395 ldap_sync_init LDAP_P((
2400 * initialize a refreshOnly sync
2403 ldap_sync_init_refresh_only LDAP_P((
2407 * initialize a refreshAndPersist sync
2410 ldap_sync_init_refresh_and_persist LDAP_P((
2414 * poll for new responses
2417 ldap_sync_poll LDAP_P((
2420 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2426 ldap_create_session_tracking_value LDAP_P((
2428 char *sessionSourceIp,
2429 char *sessionSourceName,
2431 struct berval *sessionTrackingIdentifier,
2432 struct berval *value ));
2435 ldap_create_session_tracking_control LDAP_P((
2437 char *sessionSourceIp,
2438 char *sessionSourceName,
2440 struct berval *sessionTrackingIdentifier,
2441 LDAPControl **ctrlp ));
2444 ldap_parse_session_tracking_control LDAP_P((
2448 struct berval *name,
2450 struct berval *id ));
2452 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2458 ldap_create_assertion_control_value LDAP_P((
2461 struct berval *value ));
2464 ldap_create_assertion_control LDAP_P((
2468 LDAPControl **ctrlp ));
2474 typedef struct LDAPDerefSpec {
2479 typedef struct LDAPDerefVal {
2482 struct LDAPDerefVal *next;
2485 typedef struct LDAPDerefRes {
2487 struct berval derefVal;
2488 LDAPDerefVal *attrVals;
2489 struct LDAPDerefRes *next;
2493 ldap_create_deref_control_value LDAP_P((
2496 struct berval *value ));
2499 ldap_create_deref_control LDAP_P((
2503 LDAPControl **ctrlp ));
2506 ldap_derefresponse_free LDAP_P((
2507 LDAPDerefRes *dr ));
2510 ldap_parse_derefresponse_control LDAP_P((
2513 LDAPDerefRes **drp ));
2516 ldap_parse_deref_control LDAP_P((
2518 LDAPControl **ctrls,
2519 LDAPDerefRes **drp ));
2522 #endif /* _LDAP_H */