2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2011 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 #define LDAP_CONTROL_AUTHZID_REQUEST "2.16.840.1.113730.4.16" /* RFC 3829 */
269 #define LDAP_CONTROL_AUTHZID_RESPONSE "2.16.840.1.113730.4.15" /* RFC 3829 */
271 /* LDAP Content Synchronization Operation -- RFC 4533 */
272 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
273 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
274 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
275 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
276 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
278 #define LDAP_SYNC_NONE 0x00
279 #define LDAP_SYNC_REFRESH_ONLY 0x01
280 #define LDAP_SYNC_RESERVED 0x02
281 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
283 #define LDAP_SYNC_REFRESH_PRESENTS 0
284 #define LDAP_SYNC_REFRESH_DELETES 1
286 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
287 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
288 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
289 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
291 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
292 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
293 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
294 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
296 #define LDAP_SYNC_PRESENT 0
297 #define LDAP_SYNC_ADD 1
298 #define LDAP_SYNC_MODIFY 2
299 #define LDAP_SYNC_DELETE 3
300 #define LDAP_SYNC_NEW_COOKIE 4
302 /* LDAP Don't Use Copy Control (RFC 6171) */
303 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.1.22"
305 /* Password policy Controls *//* work in progress */
306 /* ITS#3458: released; disabled by default */
307 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
308 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
310 /* various works in progress */
311 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
312 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
313 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
314 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
315 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
316 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
317 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
318 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
320 /* LDAP Chaining Behavior Control *//* work in progress */
321 /* <draft-sermersheim-ldap-chaining>;
322 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
323 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
325 #define LDAP_CHAINING_PREFERRED 0
326 #define LDAP_CHAINING_REQUIRED 1
327 #define LDAP_REFERRALS_PREFERRED 2
328 #define LDAP_REFERRALS_REQUIRED 3
330 /* MS Active Directory controls (for compatibility) */
331 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
332 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
333 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
334 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
335 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
336 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
337 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
339 /* MS Active Directory controls - not implemented in slapd(8) */
340 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
342 /* <draft-wahl-ldap-session> */
343 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
344 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
345 LDAP_CONTROL_X_SESSION_TRACKING ".1"
346 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
347 LDAP_CONTROL_X_SESSION_TRACKING ".2"
348 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
349 LDAP_CONTROL_X_SESSION_TRACKING ".3"
350 /* various expired works */
352 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
353 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
354 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
355 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
356 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
358 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
359 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
360 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
361 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
362 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
363 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
364 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
367 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
368 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
370 /* LDAP Unsolicited Notifications */
371 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
372 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
374 /* LDAP Extended Operations */
375 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
377 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
378 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
379 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
380 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
381 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
383 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
384 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
386 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
387 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
388 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
389 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x81U)
391 #define LDAP_EXOP_VERIFY_CREDENTIALS "1.3.6.1.4.1.4203.666.6.5"
392 #define LDAP_EXOP_X_VERIFY_CREDENTIALS LDAP_EXOP_VERIFY_CREDENTIALS
394 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_COOKIE ((ber_tag_t) 0x80U)
395 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_SCREDS ((ber_tag_t) 0x81U)
396 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_CONTROLS ((ber_tag_t) 0xa2U) /* context specific + constructed + 2 */
398 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
399 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
401 /* various works in progress */
402 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
403 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
405 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
406 /* a work in progress */
407 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
408 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
409 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
410 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
411 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
412 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
413 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
414 LDAP_X_DISTPROC_BASE ".6"
415 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
416 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
417 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
418 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
419 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
422 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
423 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
424 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
425 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
426 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
430 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
431 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
432 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
433 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
434 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
435 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
436 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
438 /* LDAP Experimental (works in progress) Features */
439 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
440 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
441 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
444 * specific LDAP instantiations of BER types we know about
447 /* Overview of LBER tag construction
454 * 1 0 = CONTEXT-SPECIFIC
461 * | 5 ... 1 | TAG-NUMBER
465 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
466 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
468 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
469 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
471 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
472 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
474 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
476 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
477 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
478 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
479 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
481 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
482 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
484 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
486 /* LDAP Request Messages */
487 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
488 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
489 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
490 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
491 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
492 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
493 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
494 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
495 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
496 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
497 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
498 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
500 /* LDAP Response Messages */
501 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
502 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
503 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
504 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
505 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
506 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
507 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
508 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
509 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
510 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
511 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
512 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
513 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
515 #define LDAP_RES_ANY (-1)
516 #define LDAP_RES_UNSOLICITED (0)
520 #define LDAP_SASL_SIMPLE ((char*)0)
521 #define LDAP_SASL_NULL ("")
524 /* authentication methods available */
525 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
526 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
527 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
528 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
529 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
530 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
532 /* used by the Windows API but not used on the wire */
533 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
536 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
537 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
538 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
539 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
540 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
541 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
542 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
543 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
544 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
545 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
547 /* extended filter component types */
548 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
549 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
550 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
551 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
553 /* substring filter component types */
554 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
555 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
556 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
559 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
560 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
561 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
562 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
563 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
564 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
565 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
566 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
567 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
569 /* substring filter component types */
570 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
571 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
572 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
577 #define LDAP_SUCCESS 0x00
579 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
581 #define LDAP_OPERATIONS_ERROR 0x01
582 #define LDAP_PROTOCOL_ERROR 0x02
583 #define LDAP_TIMELIMIT_EXCEEDED 0x03
584 #define LDAP_SIZELIMIT_EXCEEDED 0x04
585 #define LDAP_COMPARE_FALSE 0x05
586 #define LDAP_COMPARE_TRUE 0x06
587 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
588 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
589 #define LDAP_STRONG_AUTH_REQUIRED 0x08
590 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
591 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
593 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
594 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
595 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
596 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
597 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
599 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
601 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
602 #define LDAP_UNDEFINED_TYPE 0x11
603 #define LDAP_INAPPROPRIATE_MATCHING 0x12
604 #define LDAP_CONSTRAINT_VIOLATION 0x13
605 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
606 #define LDAP_INVALID_SYNTAX 0x15
608 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
610 #define LDAP_NO_SUCH_OBJECT 0x20
611 #define LDAP_ALIAS_PROBLEM 0x21
612 #define LDAP_INVALID_DN_SYNTAX 0x22
613 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
614 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
616 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
618 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
619 #define LDAP_INAPPROPRIATE_AUTH 0x30
620 #define LDAP_INVALID_CREDENTIALS 0x31
621 #define LDAP_INSUFFICIENT_ACCESS 0x32
623 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
625 #define LDAP_BUSY 0x33
626 #define LDAP_UNAVAILABLE 0x34
627 #define LDAP_UNWILLING_TO_PERFORM 0x35
628 #define LDAP_LOOP_DETECT 0x36
630 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
632 #define LDAP_NAMING_VIOLATION 0x40
633 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
634 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
635 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
636 #define LDAP_ALREADY_EXISTS 0x44
637 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
638 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
639 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
641 #define LDAP_VLV_ERROR 0x4C
643 #define LDAP_OTHER 0x50
645 /* LCUP operation codes (113-117) - not implemented */
646 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
647 #define LDAP_CUP_SECURITY_VIOLATION 0x72
648 #define LDAP_CUP_INVALID_DATA 0x73
649 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
650 #define LDAP_CUP_RELOAD_REQUIRED 0x75
652 /* Cancel operation codes (118-121) */
653 #define LDAP_CANCELLED 0x76
654 #define LDAP_NO_SUCH_OPERATION 0x77
655 #define LDAP_TOO_LATE 0x78
656 #define LDAP_CANNOT_CANCEL 0x79
658 /* Assertion control (122) */
659 #define LDAP_ASSERTION_FAILED 0x7A
661 /* Proxied Authorization Denied (123) */
662 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
664 /* Experimental result codes */
665 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
667 /* LDAP Sync (4096) */
668 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
671 /* Private Use result codes */
672 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
674 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
675 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
677 /* for the LDAP No-Op control */
678 #define LDAP_X_NO_OPERATION 0x410e
680 /* for the Chaining Behavior control (consecutive result codes requested;
681 * see <draft-sermersheim-ldap-chaining> ) */
682 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
683 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
684 #define LDAP_X_CANNOT_CHAIN 0x4111
687 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
688 #ifdef LDAP_X_DISTPROC_BASE
689 #define LDAP_X_INVALIDREFERENCE 0x4112
693 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
694 #define LDAP_X_TXN_ID_INVALID 0x4121
699 * Based on draft-ietf-ldap-c-api-xx
700 * but with new negative code values
702 #define LDAP_API_ERROR(n) ((n)<0)
703 #define LDAP_API_RESULT(n) ((n)<=0)
705 #define LDAP_SERVER_DOWN (-1)
706 #define LDAP_LOCAL_ERROR (-2)
707 #define LDAP_ENCODING_ERROR (-3)
708 #define LDAP_DECODING_ERROR (-4)
709 #define LDAP_TIMEOUT (-5)
710 #define LDAP_AUTH_UNKNOWN (-6)
711 #define LDAP_FILTER_ERROR (-7)
712 #define LDAP_USER_CANCELLED (-8)
713 #define LDAP_PARAM_ERROR (-9)
714 #define LDAP_NO_MEMORY (-10)
715 #define LDAP_CONNECT_ERROR (-11)
716 #define LDAP_NOT_SUPPORTED (-12)
717 #define LDAP_CONTROL_NOT_FOUND (-13)
718 #define LDAP_NO_RESULTS_RETURNED (-14)
719 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
720 #define LDAP_CLIENT_LOOP (-16)
721 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
722 #define LDAP_X_CONNECTING (-18)
726 * This structure represents both ldap messages and ldap responses.
727 * These are really the same, except in the case of search responses,
728 * where a response has multiple messages.
731 typedef struct ldapmsg LDAPMessage;
733 /* for modifications */
734 typedef struct ldapmod {
737 #define LDAP_MOD_OP (0x0007)
738 #define LDAP_MOD_ADD (0x0000)
739 #define LDAP_MOD_DELETE (0x0001)
740 #define LDAP_MOD_REPLACE (0x0002)
741 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
742 #define LDAP_MOD_BVALUES (0x0080)
743 /* IMPORTANT: do not use code 0x1000 (or above),
744 * it is used internally by the backends!
745 * (see ldap/servers/slapd/slap.h)
751 struct berval **modv_bvals;
753 #define mod_values mod_vals.modv_strvals
754 #define mod_bvalues mod_vals.modv_bvals
758 * structure representing an ldap session which can
759 * encompass connections to multiple servers (in the
760 * face of referrals).
762 typedef struct ldap LDAP;
764 #define LDAP_DEREF_NEVER 0x00
765 #define LDAP_DEREF_SEARCHING 0x01
766 #define LDAP_DEREF_FINDING 0x02
767 #define LDAP_DEREF_ALWAYS 0x03
769 #define LDAP_NO_LIMIT 0
771 /* how many messages to retrieve results for */
772 #define LDAP_MSG_ONE 0x00
773 #define LDAP_MSG_ALL 0x01
774 #define LDAP_MSG_RECEIVED 0x02
777 * types for ldap URL handling
779 typedef struct ldap_url_desc {
780 struct ldap_url_desc *lud_next;
792 #define LDAP_URL_SUCCESS 0x00 /* Success */
793 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
794 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
796 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
797 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
798 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
799 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
800 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
801 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
802 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
803 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
806 * LDAP sync (RFC4533) API
809 typedef struct ldap_sync_t ldap_sync_t;
812 /* these are private - the client should never see them */
813 LDAP_SYNC_CAPI_NONE = -1,
815 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
816 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
817 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
819 /* these are passed to ls_search_entry() */
820 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
821 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
822 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
823 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
825 /* these are passed to ls_intermediate() */
826 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
827 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
829 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
830 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
832 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
833 } ldap_sync_refresh_t;
836 * Called when an entry is returned by ldap_result().
837 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
838 * the entry has been either added or modified, and thus
839 * the complete view of the entry should be in the LDAPMessage.
840 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
841 * only the DN should be in the LDAPMessage.
843 typedef int (*ldap_sync_search_entry_f) LDAP_P((
846 struct berval *entryUUID,
847 ldap_sync_refresh_t phase ));
850 * Called when a reference is returned; the client should know
851 * what to do with it.
853 typedef int (*ldap_sync_search_reference_f) LDAP_P((
858 * Called when specific intermediate/final messages are returned.
859 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
860 * a "presents" or "deletes" phase begins.
861 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
862 * with refreshDone set to "TRUE" has been returned, to indicate
863 * that the refresh phase of a refreshAndPersist is complete.
864 * In the above cases, syncUUIDs is NULL.
866 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
867 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
868 * that are either present or have been deleted.
870 typedef int (*ldap_sync_intermediate_f) LDAP_P((
874 ldap_sync_refresh_t phase ));
877 * Called when a searchResultDone is returned. In refreshAndPersist,
878 * this can only occur if the search for any reason is being terminated
881 typedef int (*ldap_sync_search_result_f) LDAP_P((
884 int refreshDeletes ));
887 * This structure contains all information about the persistent search;
888 * the caller is responsible for connecting, setting version, binding, tls...
891 /* conf search params */
902 /* helpers - add as appropriate */
903 ldap_sync_search_entry_f ls_search_entry;
904 ldap_sync_search_reference_f ls_search_reference;
905 ldap_sync_intermediate_f ls_intermediate;
906 ldap_sync_search_result_f ls_search_result;
908 /* set by the caller as appropriate */
914 /* --- the parameters below are private - do not modify --- */
916 /* FIXME: make the structure opaque, and provide an interface
917 * to modify the public values? */
923 /* needed by refreshOnly */
926 /* opaque - need to pass between sessions, updated by the API */
927 struct berval ls_cookie;
929 /* state variable - do not modify */
930 ldap_sync_refresh_t ls_refreshPhase;
934 * End of LDAP sync (RFC4533) API
938 * Connection callbacks...
943 /* Called after a connection is established */
944 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
945 struct ldap_conncb *ctx ));
946 /* Called before a connection is closed */
947 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
949 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
950 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
952 typedef struct ldap_conncb {
953 ldap_conn_add_f *lc_add;
954 ldap_conn_del_f *lc_del;
959 * The API draft spec says we should declare (or cause to be declared)
960 * 'struct timeval'. We don't. See IETF LDAPext discussions.
968 ldap_get_option LDAP_P((
974 ldap_set_option LDAP_P((
977 LDAP_CONST void *invalue));
979 /* V3 REBIND Function Callback Prototype */
980 typedef int (LDAP_REBIND_PROC) LDAP_P((
981 LDAP *ld, LDAP_CONST char *url,
982 ber_tag_t request, ber_int_t msgid,
986 ldap_set_rebind_proc LDAP_P((
988 LDAP_REBIND_PROC *rebind_proc,
991 /* V3 referral selection Function Callback Prototype */
992 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
993 LDAP *ld, char ***refsp, int *cntp,
997 ldap_set_nextref_proc LDAP_P((
999 LDAP_NEXTREF_PROC *nextref_proc,
1002 /* V3 URLLIST Function Callback Prototype */
1003 typedef int (LDAP_URLLIST_PROC) LDAP_P((
1005 LDAPURLDesc **urllist,
1010 ldap_set_urllist_proc LDAP_P((
1012 LDAP_URLLIST_PROC *urllist_proc,
1020 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
1021 LDAP_CONST char *requestOID,
1024 LDAPControl **ctrlp ));
1026 LDAP_F( LDAPControl * )
1027 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
1028 LDAP_CONST char *oid,
1029 LDAPControl **ctrls ));
1033 ldap_control_create LDAP_P((
1034 LDAP_CONST char *requestOID,
1036 struct berval *value,
1038 LDAPControl **ctrlp ));
1040 LDAP_F( LDAPControl * )
1041 ldap_control_find LDAP_P((
1042 LDAP_CONST char *oid,
1043 LDAPControl **ctrls,
1044 LDAPControl ***nextctrlp ));
1047 ldap_control_free LDAP_P((
1048 LDAPControl *ctrl ));
1051 ldap_controls_free LDAP_P((
1052 LDAPControl **ctrls ));
1054 LDAP_F( LDAPControl ** )
1055 ldap_controls_dup LDAP_P((
1056 LDAPControl *LDAP_CONST *controls ));
1058 LDAP_F( LDAPControl * )
1059 ldap_control_dup LDAP_P((
1060 LDAP_CONST LDAPControl *c ));
1066 ldap_domain2dn LDAP_P((
1067 LDAP_CONST char* domain,
1071 ldap_dn2domain LDAP_P((
1072 LDAP_CONST char* dn,
1076 ldap_domain2hostlist LDAP_P((
1077 LDAP_CONST char *domain,
1084 ldap_extended_operation LDAP_P((
1086 LDAP_CONST char *reqoid,
1087 struct berval *reqdata,
1088 LDAPControl **serverctrls,
1089 LDAPControl **clientctrls,
1093 ldap_extended_operation_s LDAP_P((
1095 LDAP_CONST char *reqoid,
1096 struct berval *reqdata,
1097 LDAPControl **serverctrls,
1098 LDAPControl **clientctrls,
1100 struct berval **retdatap ));
1103 ldap_parse_extended_result LDAP_P((
1107 struct berval **retdatap,
1111 ldap_parse_intermediate LDAP_P((
1115 struct berval **retdatap,
1116 LDAPControl ***serverctrls,
1124 ldap_abandon_ext LDAP_P((
1127 LDAPControl **serverctrls,
1128 LDAPControl **clientctrls ));
1132 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1141 ldap_add_ext LDAP_P((
1143 LDAP_CONST char *dn,
1145 LDAPControl **serverctrls,
1146 LDAPControl **clientctrls,
1150 ldap_add_ext_s LDAP_P((
1152 LDAP_CONST char *dn,
1154 LDAPControl **serverctrls,
1155 LDAPControl **clientctrls ));
1159 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1161 LDAP_CONST char *dn,
1165 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1167 LDAP_CONST char *dn,
1176 ldap_sasl_bind LDAP_P((
1178 LDAP_CONST char *dn,
1179 LDAP_CONST char *mechanism,
1180 struct berval *cred,
1181 LDAPControl **serverctrls,
1182 LDAPControl **clientctrls,
1185 /* Interaction flags (should be passed about in a control)
1186 * Automatic (default): use defaults, prompt otherwise
1187 * Interactive: prompt always
1188 * Quiet: never prompt
1190 #define LDAP_SASL_AUTOMATIC 0U
1191 #define LDAP_SASL_INTERACTIVE 1U
1192 #define LDAP_SASL_QUIET 2U
1195 * V3 SASL Interaction Function Callback Prototype
1196 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1197 * should likely passed in a control (and provided controls)
1199 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1200 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1203 ldap_sasl_interactive_bind LDAP_P((
1205 LDAP_CONST char *dn, /* usually NULL */
1206 LDAP_CONST char *saslMechanism,
1207 LDAPControl **serverControls,
1208 LDAPControl **clientControls,
1210 /* should be client controls */
1212 LDAP_SASL_INTERACT_PROC *proc,
1215 /* as obtained from ldap_result() */
1216 LDAPMessage *result,
1218 /* returned during bind processing */
1223 ldap_sasl_interactive_bind_s LDAP_P((
1225 LDAP_CONST char *dn, /* usually NULL */
1226 LDAP_CONST char *saslMechanism,
1227 LDAPControl **serverControls,
1228 LDAPControl **clientControls,
1230 /* should be client controls */
1232 LDAP_SASL_INTERACT_PROC *proc,
1236 ldap_sasl_bind_s LDAP_P((
1238 LDAP_CONST char *dn,
1239 LDAP_CONST char *mechanism,
1240 struct berval *cred,
1241 LDAPControl **serverctrls,
1242 LDAPControl **clientctrls,
1243 struct berval **servercredp ));
1246 ldap_parse_sasl_bind_result LDAP_P((
1249 struct berval **servercredp,
1258 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1260 LDAP_CONST char *who,
1261 LDAP_CONST char *passwd,
1265 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1267 LDAP_CONST char *who,
1268 LDAP_CONST char *cred,
1275 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1277 LDAP_CONST char *who,
1278 LDAP_CONST char *passwd ));
1281 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1283 LDAP_CONST char *who,
1284 LDAP_CONST char *passwd ));
1293 ldap_compare_ext 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_ext_s LDAP_P((
1305 LDAP_CONST char *dn,
1306 LDAP_CONST char *attr,
1307 struct berval *bvalue,
1308 LDAPControl **serverctrls,
1309 LDAPControl **clientctrls ));
1313 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1315 LDAP_CONST char *dn,
1316 LDAP_CONST char *attr,
1317 LDAP_CONST char *value ));
1320 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1322 LDAP_CONST char *dn,
1323 LDAP_CONST char *attr,
1324 LDAP_CONST char *value ));
1332 ldap_delete_ext LDAP_P((
1334 LDAP_CONST char *dn,
1335 LDAPControl **serverctrls,
1336 LDAPControl **clientctrls,
1340 ldap_delete_ext_s LDAP_P((
1342 LDAP_CONST char *dn,
1343 LDAPControl **serverctrls,
1344 LDAPControl **clientctrls ));
1348 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1350 LDAP_CONST char *dn ));
1353 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1355 LDAP_CONST char *dn ));
1363 ldap_parse_result LDAP_P((
1370 LDAPControl ***serverctrls,
1374 ldap_err2string LDAP_P((
1379 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1385 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1387 LDAP_CONST char *s ));
1395 ldap_gssapi_bind LDAP_P((
1397 LDAP_CONST char *dn,
1398 LDAP_CONST char *creds ));
1401 ldap_gssapi_bind_s LDAP_P((
1403 LDAP_CONST char *dn,
1404 LDAP_CONST char *creds ));
1411 ldap_modify_ext LDAP_P((
1413 LDAP_CONST char *dn,
1415 LDAPControl **serverctrls,
1416 LDAPControl **clientctrls,
1420 ldap_modify_ext_s LDAP_P((
1422 LDAP_CONST char *dn,
1424 LDAPControl **serverctrls,
1425 LDAPControl **clientctrls ));
1429 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1431 LDAP_CONST char *dn,
1435 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1437 LDAP_CONST char *dn,
1446 ldap_rename 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_rename_s LDAP_P((
1459 LDAP_CONST char *dn,
1460 LDAP_CONST char *newrdn,
1461 LDAP_CONST char *newSuperior,
1463 LDAPControl **sctrls,
1464 LDAPControl **cctrls ));
1468 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1470 LDAP_CONST char *dn,
1471 LDAP_CONST char *newrdn,
1472 LDAP_CONST char *newSuperior,
1473 int deleteoldrdn ));
1476 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1478 LDAP_CONST char *dn,
1479 LDAP_CONST char *newrdn,
1480 LDAP_CONST char *newSuperior,
1481 int deleteoldrdn ));
1484 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1486 LDAP_CONST char *dn,
1487 LDAP_CONST char *newrdn ));
1490 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1492 LDAP_CONST char *dn,
1493 LDAP_CONST char *newrdn ));
1496 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1498 LDAP_CONST char *dn,
1499 LDAP_CONST char *newrdn,
1500 int deleteoldrdn ));
1503 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1505 LDAP_CONST char *dn,
1506 LDAP_CONST char *newrdn,
1516 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1517 LDAP_CONST char *host,
1521 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1522 LDAP_CONST char *host,
1527 ldap_create LDAP_P((
1531 ldap_initialize LDAP_P((
1533 LDAP_CONST char *url ));
1544 ldap_tls_inplace LDAP_P((
1548 ldap_start_tls LDAP_P((
1550 LDAPControl **serverctrls,
1551 LDAPControl **clientctrls,
1555 ldap_install_tls LDAP_P((
1559 ldap_start_tls_s LDAP_P((
1561 LDAPControl **serverctrls,
1562 LDAPControl **clientctrls ));
1567 LDAP_F( LDAPMessage * )
1568 ldap_first_message LDAP_P((
1570 LDAPMessage *chain ));
1572 LDAP_F( LDAPMessage * )
1573 ldap_next_message LDAP_P((
1575 LDAPMessage *msg ));
1578 ldap_count_messages LDAP_P((
1580 LDAPMessage *chain ));
1585 LDAP_F( LDAPMessage * )
1586 ldap_first_reference LDAP_P((
1588 LDAPMessage *chain ));
1590 LDAP_F( LDAPMessage * )
1591 ldap_next_reference LDAP_P((
1593 LDAPMessage *ref ));
1596 ldap_count_references LDAP_P((
1598 LDAPMessage *chain ));
1601 ldap_parse_reference LDAP_P((
1605 LDAPControl ***serverctrls,
1612 LDAP_F( LDAPMessage * )
1613 ldap_first_entry LDAP_P((
1615 LDAPMessage *chain ));
1617 LDAP_F( LDAPMessage * )
1618 ldap_next_entry LDAP_P((
1620 LDAPMessage *entry ));
1623 ldap_count_entries LDAP_P((
1625 LDAPMessage *chain ));
1628 ldap_get_entry_controls LDAP_P((
1631 LDAPControl ***serverctrls));
1637 LDAP_F( LDAPMessage * )
1638 ldap_delete_result_entry LDAP_P((
1643 ldap_add_result_entry LDAP_P((
1652 ldap_get_dn LDAP_P((
1654 LDAPMessage *entry ));
1656 typedef struct ldap_ava {
1657 struct berval la_attr;
1658 struct berval la_value;
1660 #define LDAP_AVA_NULL 0x0000U
1661 #define LDAP_AVA_STRING 0x0001U
1662 #define LDAP_AVA_BINARY 0x0002U
1663 #define LDAP_AVA_NONPRINTABLE 0x0004U
1664 #define LDAP_AVA_FREE_ATTR 0x0010U
1665 #define LDAP_AVA_FREE_VALUE 0x0020U
1670 typedef LDAPAVA** LDAPRDN;
1671 typedef LDAPRDN* LDAPDN;
1674 #define LDAP_DN_FORMAT_LDAP 0x0000U
1675 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1676 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1677 #define LDAP_DN_FORMAT_DCE 0x0030U
1678 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1679 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1680 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1681 #define LDAP_DN_FORMAT_MASK 0x00F0U
1684 #define LDAP_DN_PRETTY 0x0100U
1685 #define LDAP_DN_SKIP 0x0200U
1686 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1687 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1688 #define LDAP_DN_PEDANTIC 0xF000U
1690 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1691 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1700 ldap_str2dn LDAP_P((
1701 LDAP_CONST char *str,
1712 ldap_dn2str LDAP_P((
1718 ldap_bv2rdn LDAP_P((
1725 ldap_str2rdn LDAP_P((
1726 LDAP_CONST char *str,
1732 ldap_rdn2bv LDAP_P((
1738 ldap_rdn2str LDAP_P((
1744 ldap_dn_normalize LDAP_P((
1745 LDAP_CONST char *in, unsigned iflags,
1746 char **out, unsigned oflags ));
1749 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1750 LDAP_CONST char *dn ));
1753 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1754 LDAP_CONST char *dn,
1758 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1759 LDAP_CONST char *rdn,
1762 typedef int LDAPDN_rewrite_func
1763 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1766 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1767 LDAPDN_rewrite_func *func, unsigned flags ));
1770 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1771 LDAP_CONST char *dn ));
1774 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1775 LDAP_CONST char *dce ));
1778 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1779 LDAP_CONST char *dn ));
1782 ldap_get_dn_ber LDAP_P((
1783 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1786 ldap_get_attribute_ber LDAP_P((
1787 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1788 struct berval **vals ));
1794 ldap_first_attribute LDAP_P((
1797 BerElement **ber ));
1800 ldap_next_attribute LDAP_P((
1809 LDAP_F( struct berval ** )
1810 ldap_get_values_len LDAP_P((
1813 LDAP_CONST char *target ));
1816 ldap_count_values_len LDAP_P((
1817 struct berval **vals ));
1820 ldap_value_free_len LDAP_P((
1821 struct berval **vals ));
1825 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1828 LDAP_CONST char *target ));
1831 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1835 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1843 ldap_result LDAP_P((
1847 struct timeval *timeout,
1848 LDAPMessage **result ));
1851 ldap_msgtype LDAP_P((
1859 ldap_msgfree LDAP_P((
1863 ldap_msgdelete LDAP_P((
1872 ldap_bv2escaped_filter_value LDAP_P((
1874 struct berval *out ));
1877 ldap_search_ext LDAP_P((
1879 LDAP_CONST char *base,
1881 LDAP_CONST char *filter,
1884 LDAPControl **serverctrls,
1885 LDAPControl **clientctrls,
1886 struct timeval *timeout,
1891 ldap_search_ext_s LDAP_P((
1893 LDAP_CONST char *base,
1895 LDAP_CONST char *filter,
1898 LDAPControl **serverctrls,
1899 LDAPControl **clientctrls,
1900 struct timeval *timeout,
1902 LDAPMessage **res ));
1906 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1908 LDAP_CONST char *base,
1910 LDAP_CONST char *filter,
1915 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1917 LDAP_CONST char *base,
1919 LDAP_CONST char *filter,
1922 LDAPMessage **res ));
1925 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1927 LDAP_CONST char *base,
1929 LDAP_CONST char *filter,
1932 struct timeval *timeout,
1933 LDAPMessage **res ));
1940 ldap_unbind_ext LDAP_P((
1942 LDAPControl **serverctrls,
1943 LDAPControl **clientctrls));
1946 ldap_unbind_ext_s LDAP_P((
1948 LDAPControl **serverctrls,
1949 LDAPControl **clientctrls));
1952 ldap_destroy LDAP_P((
1957 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1961 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1969 ldap_put_vrFilter LDAP_P((
1978 ldap_memalloc LDAP_P((
1982 ldap_memrealloc LDAP_P((
1987 ldap_memcalloc LDAP_P((
1992 ldap_memfree LDAP_P((
1996 ldap_memvfree LDAP_P((
2000 ldap_strdup LDAP_P((
2001 LDAP_CONST char * ));
2004 ldap_mods_free LDAP_P((
2011 * in sort.c (deprecated, use custom code instead)
2013 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
2014 LDAP_CONST char *left,
2015 LDAP_CONST char *right ));
2017 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
2018 LDAP_CONST void *left,
2019 LDAP_CONST void *right ));
2021 LDAP_F( int ) /* deprecated */
2022 ldap_sort_entries LDAP_P(( LDAP *ld,
2023 LDAPMessage **chain,
2024 LDAP_CONST char *attr,
2025 LDAP_SORT_AD_CMP_PROC *cmp ));
2027 LDAP_F( int ) /* deprecated */
2028 ldap_sort_values LDAP_P((
2031 LDAP_SORT_AV_CMP_PROC *cmp ));
2033 LDAP_F( int ) /* deprecated */
2034 ldap_sort_strcasecmp LDAP_P((
2036 LDAP_CONST void *b ));
2043 ldap_is_ldap_url LDAP_P((
2044 LDAP_CONST char *url ));
2047 ldap_is_ldaps_url LDAP_P((
2048 LDAP_CONST char *url ));
2051 ldap_is_ldapi_url LDAP_P((
2052 LDAP_CONST char *url ));
2055 ldap_url_parse LDAP_P((
2056 LDAP_CONST char *url,
2057 LDAPURLDesc **ludpp ));
2060 ldap_url_desc2str LDAP_P((
2061 LDAPURLDesc *ludp ));
2064 ldap_free_urldesc LDAP_P((
2065 LDAPURLDesc *ludp ));
2069 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2072 #define LDAP_API_FEATURE_CANCEL 1000
2075 ldap_cancel LDAP_P(( LDAP *ld,
2077 LDAPControl **sctrls,
2078 LDAPControl **cctrls,
2082 ldap_cancel_s LDAP_P(( LDAP *ld,
2084 LDAPControl **sctrl,
2085 LDAPControl **cctrl ));
2088 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2091 #define LDAP_API_FEATURE_TURN 1000
2094 ldap_turn LDAP_P(( LDAP *ld,
2096 LDAP_CONST char* identifier,
2097 LDAPControl **sctrls,
2098 LDAPControl **cctrls,
2102 ldap_turn_s LDAP_P(( LDAP *ld,
2104 LDAP_CONST char* identifier,
2105 LDAPControl **sctrl,
2106 LDAPControl **cctrl ));
2109 * LDAP Paged Results
2112 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2115 ldap_create_page_control_value LDAP_P((
2118 struct berval *cookie,
2119 struct berval *value ));
2122 ldap_create_page_control LDAP_P((
2125 struct berval *cookie,
2127 LDAPControl **ctrlp ));
2131 ldap_parse_page_control LDAP_P((
2132 /* deprecated, use ldap_parse_pageresponse_control */
2134 LDAPControl **ctrls,
2136 struct berval **cookie ));
2140 ldap_parse_pageresponse_control LDAP_P((
2144 struct berval *cookie ));
2147 * LDAP Server Side Sort
2150 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2152 /* structure for a sort-key */
2153 typedef struct ldapsortkey {
2154 char *attributeType;
2160 ldap_create_sort_keylist LDAP_P((
2161 LDAPSortKey ***sortKeyList,
2165 ldap_free_sort_keylist LDAP_P((
2166 LDAPSortKey **sortkeylist ));
2169 ldap_create_sort_control_value LDAP_P((
2171 LDAPSortKey **keyList,
2172 struct berval *value ));
2175 ldap_create_sort_control LDAP_P((
2177 LDAPSortKey **keyList,
2179 LDAPControl **ctrlp ));
2182 ldap_parse_sortresponse_control LDAP_P((
2186 char **attribute ));
2189 * LDAP Virtual List View
2192 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2194 /* structure for virtual list */
2195 typedef struct ldapvlvinfo {
2196 ber_int_t ldvlv_version;
2197 ber_int_t ldvlv_before_count;
2198 ber_int_t ldvlv_after_count;
2199 ber_int_t ldvlv_offset;
2200 ber_int_t ldvlv_count;
2201 struct berval * ldvlv_attrvalue;
2202 struct berval * ldvlv_context;
2203 void * ldvlv_extradata;
2207 ldap_create_vlv_control_value LDAP_P((
2209 LDAPVLVInfo *ldvlistp,
2210 struct berval *value));
2213 ldap_create_vlv_control LDAP_P((
2215 LDAPVLVInfo *ldvlistp,
2216 LDAPControl **ctrlp ));
2219 ldap_parse_vlvresponse_control LDAP_P((
2222 ber_int_t *target_posp,
2223 ber_int_t *list_countp,
2224 struct berval **contextp,
2228 * LDAP Verify Credentials
2230 #define LDAP_API_FEATURE_VERIFY_CREDENTIALS 1000
2233 ldap_verify_credentials LDAP_P((
2235 struct berval *cookie,
2236 LDAP_CONST char *dn,
2237 LDAP_CONST char *mechanism,
2238 struct berval *cred,
2239 LDAPControl **ctrls,
2240 LDAPControl **serverctrls,
2241 LDAPControl **clientctrls,
2245 ldap_verify_credentials_s LDAP_P((
2247 struct berval *cookie,
2248 LDAP_CONST char *dn,
2249 LDAP_CONST char *mechanism,
2250 struct berval *cred,
2251 LDAPControl **vcictrls,
2252 LDAPControl **serverctrls,
2253 LDAPControl **clientctrls,
2256 struct berval **scookie,
2257 struct berval **servercredp,
2258 LDAPControl ***vcoctrls));
2262 ldap_parse_verify_credentials LDAP_P((
2267 struct berval **cookie,
2268 struct berval **servercredp,
2269 LDAPControl ***vcctrls));
2271 /* not yet implemented */
2272 /* #define LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE 1000 */
2273 #ifdef LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE
2275 ldap_verify_credentials_interactive LDAP_P((
2277 LDAP_CONST char *dn, /* usually NULL */
2278 LDAP_CONST char *saslMechanism,
2279 LDAPControl **vcControls,
2280 LDAPControl **serverControls,
2281 LDAPControl **clientControls,
2283 /* should be client controls */
2285 LDAP_SASL_INTERACT_PROC *proc,
2289 /* as obtained from ldap_result() */
2290 LDAPMessage *result,
2292 /* returned during bind processing */
2301 #define LDAP_API_FEATURE_WHOAMI 1000
2304 ldap_parse_whoami LDAP_P((
2307 struct berval **authzid ));
2310 ldap_whoami LDAP_P(( LDAP *ld,
2311 LDAPControl **sctrls,
2312 LDAPControl **cctrls,
2316 ldap_whoami_s LDAP_P((
2318 struct berval **authzid,
2319 LDAPControl **sctrls,
2320 LDAPControl **cctrls ));
2323 * LDAP Password Modify
2326 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2329 ldap_parse_passwd LDAP_P((
2332 struct berval *newpasswd ));
2335 ldap_passwd LDAP_P(( LDAP *ld,
2336 struct berval *user,
2337 struct berval *oldpw,
2338 struct berval *newpw,
2339 LDAPControl **sctrls,
2340 LDAPControl **cctrls,
2344 ldap_passwd_s LDAP_P((
2346 struct berval *user,
2347 struct berval *oldpw,
2348 struct berval *newpw,
2349 struct berval *newpasswd,
2350 LDAPControl **sctrls,
2351 LDAPControl **cctrls ));
2353 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2355 * LDAP Password Policy controls
2358 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2360 typedef enum passpolicyerror_enum {
2361 PP_passwordExpired = 0,
2362 PP_accountLocked = 1,
2363 PP_changeAfterReset = 2,
2364 PP_passwordModNotAllowed = 3,
2365 PP_mustSupplyOldPassword = 4,
2366 PP_insufficientPasswordQuality = 5,
2367 PP_passwordTooShort = 6,
2368 PP_passwordTooYoung = 7,
2369 PP_passwordInHistory = 8,
2371 } LDAPPasswordPolicyError;
2374 ldap_create_passwordpolicy_control LDAP_P((
2376 LDAPControl **ctrlp ));
2379 ldap_parse_passwordpolicy_control LDAP_P((
2384 LDAPPasswordPolicyError *errorp ));
2386 LDAP_F( const char * )
2387 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2388 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2391 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2394 #define LDAP_API_FEATURE_REFRESH 1000
2397 ldap_parse_refresh LDAP_P((
2400 ber_int_t *newttl ));
2403 ldap_refresh LDAP_P(( LDAP *ld,
2406 LDAPControl **sctrls,
2407 LDAPControl **cctrls,
2411 ldap_refresh_s LDAP_P((
2416 LDAPControl **sctrls,
2417 LDAPControl **cctrls ));
2424 ldap_txn_start LDAP_P(( LDAP *ld,
2425 LDAPControl **sctrls,
2426 LDAPControl **cctrls,
2430 ldap_txn_start_s LDAP_P(( LDAP *ld,
2431 LDAPControl **sctrl,
2432 LDAPControl **cctrl,
2433 struct berval **rettxnid ));
2436 ldap_txn_end LDAP_P(( LDAP *ld,
2438 struct berval *txnid,
2439 LDAPControl **sctrls,
2440 LDAPControl **cctrls,
2444 ldap_txn_end_s LDAP_P(( LDAP *ld,
2446 struct berval *txnid,
2447 LDAPControl **sctrl,
2448 LDAPControl **cctrl,
2457 * initialize the persistent search structure
2459 LDAP_F( ldap_sync_t * )
2460 ldap_sync_initialize LDAP_P((
2464 * destroy the persistent search structure
2467 ldap_sync_destroy LDAP_P((
2472 * initialize a refreshOnly sync
2475 ldap_sync_init LDAP_P((
2480 * initialize a refreshOnly sync
2483 ldap_sync_init_refresh_only LDAP_P((
2487 * initialize a refreshAndPersist sync
2490 ldap_sync_init_refresh_and_persist LDAP_P((
2494 * poll for new responses
2497 ldap_sync_poll LDAP_P((
2500 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2506 ldap_create_session_tracking_value LDAP_P((
2508 char *sessionSourceIp,
2509 char *sessionSourceName,
2511 struct berval *sessionTrackingIdentifier,
2512 struct berval *value ));
2515 ldap_create_session_tracking LDAP_P((
2517 char *sessionSourceIp,
2518 char *sessionSourceName,
2520 struct berval *sessionTrackingIdentifier,
2521 LDAPControl **ctrlp ));
2524 ldap_parse_session_tracking_control LDAP_P((
2528 struct berval *name,
2530 struct berval *id ));
2532 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2538 ldap_create_assertion_control_value LDAP_P((
2541 struct berval *value ));
2544 ldap_create_assertion_control LDAP_P((
2548 LDAPControl **ctrlp ));
2554 typedef struct LDAPDerefSpec {
2559 typedef struct LDAPDerefVal {
2562 struct LDAPDerefVal *next;
2565 typedef struct LDAPDerefRes {
2567 struct berval derefVal;
2568 LDAPDerefVal *attrVals;
2569 struct LDAPDerefRes *next;
2573 ldap_create_deref_control_value LDAP_P((
2576 struct berval *value ));
2579 ldap_create_deref_control LDAP_P((
2583 LDAPControl **ctrlp ));
2586 ldap_derefresponse_free LDAP_P((
2587 LDAPDerefRes *dr ));
2590 ldap_parse_derefresponse_control LDAP_P((
2593 LDAPDerefRes **drp ));
2596 ldap_parse_deref_control LDAP_P((
2598 LDAPControl **ctrls,
2599 LDAPDerefRes **drp ));
2602 * high level LDIF to LDAP structure support
2604 #define LDIF_DEFAULT_ADD 0x01 /* if changetype missing, assume LDAP_ADD */
2605 #define LDIF_ENTRIES_ONLY 0x02 /* ignore changetypes other than add */
2606 #define LDIF_NO_CONTROLS 0x04 /* ignore control specifications */
2608 typedef struct ldifrecord {
2609 ber_tag_t lr_op; /* type of operation - LDAP_REQ_MODIFY, LDAP_REQ_ADD, etc. */
2610 struct berval lr_dn; /* DN of operation */
2611 LDAPControl **lr_ctrls; /* controls specified for operation */
2612 /* some ops such as LDAP_REQ_DELETE require only a DN */
2613 /* other ops require different data - the ldif_ops union
2614 is used to specify the data for each type of operation */
2616 LDAPMod **lr_mods; /* list of mods for LDAP_REQ_MODIFY, LDAP_REQ_ADD */
2617 #define lrop_mods ldif_ops.lr_mods
2618 struct ldif_op_rename_s {
2619 struct berval lr_newrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2620 #define lrop_newrdn ldif_ops.ldif_op_rename.lr_newrdn
2621 struct berval lr_newsuperior; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2622 #define lrop_newsup ldif_ops.ldif_op_rename.lr_newsuperior
2623 int lr_deleteoldrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2624 #define lrop_delold ldif_ops.ldif_op_rename.lr_deleteoldrdn
2625 } ldif_op_rename; /* rename/moddn/modrdn */
2626 /* the following are for future support */
2627 struct ldif_op_ext_s {
2628 struct berval lr_extop_oid; /* LDAP_REQ_EXTENDED */
2629 #define lrop_extop_oid ldif_ops.ldif_op_ext.lr_extop_oid
2630 struct berval lr_extop_data; /* LDAP_REQ_EXTENDED */
2631 #define lrop_extop_data ldif_ops.ldif_op_ext.lr_extop_data
2632 } ldif_op_ext; /* extended operation */
2633 struct ldif_op_cmp_s {
2634 struct berval lr_cmp_attr; /* LDAP_REQ_COMPARE */
2635 #define lrop_cmp_attr ldif_ops.ldif_op_cmp.lr_cmp_attr
2636 struct berval lr_cmp_bvalue; /* LDAP_REQ_COMPARE */
2637 #define lrop_cmp_bval ldif_ops.ldif_op_cmp.lr_cmp_bvalue
2638 } ldif_op_cmp; /* compare operation */
2640 /* PRIVATE STUFF - DO NOT TOUCH */
2641 /* for efficiency, the implementation allocates memory */
2642 /* in large blobs, and makes the above fields point to */
2643 /* locations inside those blobs - one consequence is that */
2644 /* you cannot simply free the above allocated fields, nor */
2645 /* assign them to be owned by another memory context which */
2646 /* might free them (unless providing your own mem ctx) */
2647 /* we use the fields below to keep track of those blobs */
2648 /* so we that we can free them later */
2649 void *lr_ctx; /* the memory context or NULL */
2652 unsigned char *lr_mops;
2654 struct berval *lr_vals;
2655 struct berval *lr_btype;
2658 /* free internal fields - does not free the LDIFRecord */
2660 ldap_ldif_record_done LDAP_P((
2664 ldap_parse_ldif_record LDAP_P((
2665 struct berval *rbuf,
2669 unsigned int flags ));
2672 #endif /* _LDAP_H */