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
161 #define LDAP_OPT_X_TLS_ECNAME 0x6012
162 #define LDAP_OPT_X_TLS_VERSION 0x6013 /* read-only */
163 #define LDAP_OPT_X_TLS_CIPHER 0x6014 /* read-only */
164 #define LDAP_OPT_X_TLS_PEERCERT 0x6015 /* read-only */
165 #define LDAP_OPT_X_TLS_CACERT 0x6016
166 #define LDAP_OPT_X_TLS_CERT 0x6017
167 #define LDAP_OPT_X_TLS_KEY 0x6018
169 #define LDAP_OPT_X_TLS_NEVER 0
170 #define LDAP_OPT_X_TLS_HARD 1
171 #define LDAP_OPT_X_TLS_DEMAND 2
172 #define LDAP_OPT_X_TLS_ALLOW 3
173 #define LDAP_OPT_X_TLS_TRY 4
175 #define LDAP_OPT_X_TLS_CRL_NONE 0
176 #define LDAP_OPT_X_TLS_CRL_PEER 1
177 #define LDAP_OPT_X_TLS_CRL_ALL 2
179 /* for LDAP_OPT_X_TLS_PROTOCOL_MIN */
180 #define LDAP_OPT_X_TLS_PROTOCOL(maj,min) (((maj) << 8) + (min))
181 #define LDAP_OPT_X_TLS_PROTOCOL_SSL2 (2 << 8)
182 #define LDAP_OPT_X_TLS_PROTOCOL_SSL3 (3 << 8)
183 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_0 ((3 << 8) + 1)
184 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_1 ((3 << 8) + 2)
185 #define LDAP_OPT_X_TLS_PROTOCOL_TLS1_2 ((3 << 8) + 3)
187 /* OpenLDAP SASL options */
188 #define LDAP_OPT_X_SASL_MECH 0x6100
189 #define LDAP_OPT_X_SASL_REALM 0x6101
190 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
191 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
192 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
193 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
194 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
195 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
196 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
197 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
198 #define LDAP_OPT_X_SASL_MECHLIST 0x610a /* read-only */
199 #define LDAP_OPT_X_SASL_NOCANON 0x610b
200 #define LDAP_OPT_X_SASL_USERNAME 0x610c /* read-only */
201 #define LDAP_OPT_X_SASL_GSS_CREDS 0x610d
203 /* OpenLDAP GSSAPI options */
204 #define LDAP_OPT_X_GSSAPI_DO_NOT_FREE_CONTEXT 0x6200
205 #define LDAP_OPT_X_GSSAPI_ALLOW_REMOTE_PRINCIPAL 0x6201
208 * OpenLDAP per connection tcp-keepalive settings
209 * (Linux only, ignored where unsupported)
211 #define LDAP_OPT_X_KEEPALIVE_IDLE 0x6300
212 #define LDAP_OPT_X_KEEPALIVE_PROBES 0x6301
213 #define LDAP_OPT_X_KEEPALIVE_INTERVAL 0x6302
215 /* Private API Extensions -- reserved for application use */
216 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
219 * ldap_get_option() and ldap_set_option() return values.
220 * As later versions may return other values indicating
221 * failure, current applications should only compare returned
222 * value against LDAP_OPT_SUCCESS.
224 #define LDAP_OPT_SUCCESS 0
225 #define LDAP_OPT_ERROR (-1)
227 /* option on/off values */
228 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
229 #define LDAP_OPT_OFF ((void *) 0)
231 typedef struct ldapapiinfo {
232 int ldapai_info_version; /* version of LDAPAPIInfo */
233 #define LDAP_API_INFO_VERSION (1)
234 int ldapai_api_version; /* revision of API supported */
235 int ldapai_protocol_version; /* highest LDAP version supported */
236 char **ldapai_extensions; /* names of API extensions */
237 char *ldapai_vendor_name; /* name of supplier */
238 int ldapai_vendor_version; /* supplier-specific version * 100 */
241 typedef struct ldap_apifeature_info {
242 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
243 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
244 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
245 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
246 } LDAPAPIFeatureInfo;
249 * LDAP Control structure
251 typedef struct ldapcontrol {
252 char * ldctl_oid; /* numericoid of control */
253 struct berval ldctl_value; /* encoded value of control */
254 char ldctl_iscritical; /* criticality */
258 /* standard track controls */
259 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
260 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
261 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
263 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
265 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
266 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
267 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
269 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
270 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
272 /* non-standard track controls */
273 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
275 #define LDAP_CONTROL_AUTHZID_REQUEST "2.16.840.1.113730.4.16" /* RFC 3829 */
276 #define LDAP_CONTROL_AUTHZID_RESPONSE "2.16.840.1.113730.4.15" /* RFC 3829 */
278 /* LDAP Content Synchronization Operation -- RFC 4533 */
279 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
280 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
281 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
282 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
283 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
285 #define LDAP_SYNC_NONE 0x00
286 #define LDAP_SYNC_REFRESH_ONLY 0x01
287 #define LDAP_SYNC_RESERVED 0x02
288 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
290 #define LDAP_SYNC_REFRESH_PRESENTS 0
291 #define LDAP_SYNC_REFRESH_DELETES 1
293 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
294 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
295 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
296 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
298 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
299 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
300 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
301 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
303 #define LDAP_SYNC_PRESENT 0
304 #define LDAP_SYNC_ADD 1
305 #define LDAP_SYNC_MODIFY 2
306 #define LDAP_SYNC_DELETE 3
307 #define LDAP_SYNC_NEW_COOKIE 4
309 /* LDAP Don't Use Copy Control (RFC 6171) */
310 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.1.22"
312 /* Password policy Controls *//* work in progress */
313 /* ITS#3458: released; disabled by default */
314 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
315 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
317 /* various works in progress */
318 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
319 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
320 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
321 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
322 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
323 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
324 #define LDAP_CONTROL_X_DEREF "1.3.6.1.4.1.4203.666.5.16"
325 #define LDAP_CONTROL_X_WHATFAILED "1.3.6.1.4.1.4203.666.5.17"
327 /* LDAP Chaining Behavior Control *//* work in progress */
328 /* <draft-sermersheim-ldap-chaining>;
329 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
330 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
332 #define LDAP_CHAINING_PREFERRED 0
333 #define LDAP_CHAINING_REQUIRED 1
334 #define LDAP_REFERRALS_PREFERRED 2
335 #define LDAP_REFERRALS_REQUIRED 3
337 /* MS Active Directory controls (for compatibility) */
338 #define LDAP_CONTROL_X_LAZY_COMMIT "1.2.840.113556.1.4.619"
339 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
340 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
341 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
342 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
343 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
344 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
345 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
347 /* MS Active Directory controls - not implemented in slapd(8) */
348 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
350 /* <draft-wahl-ldap-session> */
351 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
352 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
353 LDAP_CONTROL_X_SESSION_TRACKING ".1"
354 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
355 LDAP_CONTROL_X_SESSION_TRACKING ".2"
356 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
357 LDAP_CONTROL_X_SESSION_TRACKING ".3"
358 /* various expired works */
360 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
361 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
362 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
363 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
364 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
366 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
367 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
368 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
369 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
370 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
371 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
372 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
375 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
376 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
378 /* LDAP Unsolicited Notifications */
379 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
380 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
382 /* LDAP Extended Operations */
383 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
385 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
386 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
387 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
388 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
389 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
391 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
392 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
394 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
395 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
396 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
397 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x81U)
399 #define LDAP_EXOP_VERIFY_CREDENTIALS "1.3.6.1.4.1.4203.666.6.5"
400 #define LDAP_EXOP_X_VERIFY_CREDENTIALS LDAP_EXOP_VERIFY_CREDENTIALS
402 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_COOKIE ((ber_tag_t) 0x80U)
403 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_SCREDS ((ber_tag_t) 0x81U)
404 #define LDAP_TAG_EXOP_VERIFY_CREDENTIALS_CONTROLS ((ber_tag_t) 0xa2U) /* context specific + constructed + 2 */
406 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
407 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
409 /* various works in progress */
410 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
411 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
413 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
414 /* a work in progress */
415 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
416 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
417 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
418 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
419 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
420 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
421 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
422 LDAP_X_DISTPROC_BASE ".6"
423 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
424 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
425 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
426 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
427 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
429 #define LDAP_TXN "1.3.6.1.1.21" /* RFC 5805 */
430 #define LDAP_EXOP_TXN_START LDAP_X_TXN ".1"
431 #define LDAP_CONTROL_TXN_SPEC LDAP_X_TXN ".2"
432 #define LDAP_EXOP_TXN_END LDAP_X_TXN ".3"
433 #define LDAP_EXOP_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
435 #define LDAP_X_TXN LDAP_TXN
436 #define LDAP_EXOP_X_TXN_START LDAP_EXOP_TXN_START
437 #define LDAP_CONTROL_X_TXN_SPEC LDAP_CONTROL_TXN_SPEC
438 #define LDAP_EXOP_X_TXN_END LDAP_EXOP_TXN_END
439 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_EXOP_TXN_ABORTED_NOTICE
442 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
443 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
444 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
445 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
446 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
447 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
448 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
450 /* LDAP Experimental (works in progress) Features */
451 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
452 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
453 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
456 * specific LDAP instantiations of BER types we know about
459 /* Overview of LBER tag construction
466 * 1 0 = CONTEXT-SPECIFIC
473 * | 5 ... 1 | TAG-NUMBER
477 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
478 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
480 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
481 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
483 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
484 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
486 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
488 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
489 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
490 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
491 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
493 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
494 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
496 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
498 /* LDAP Request Messages */
499 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
500 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
501 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
502 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
503 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
504 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
505 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
506 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
507 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
508 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
509 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
510 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
512 /* LDAP Response Messages */
513 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
514 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
515 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
516 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
517 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
518 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
519 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
520 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
521 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
522 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
523 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
524 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
525 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
527 #define LDAP_RES_ANY (-1)
528 #define LDAP_RES_UNSOLICITED (0)
532 #define LDAP_SASL_SIMPLE ((char*)0)
533 #define LDAP_SASL_NULL ("")
536 /* authentication methods available */
537 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
538 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
539 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
540 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
541 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
542 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
544 /* used by the Windows API but not used on the wire */
545 #define LDAP_AUTH_NEGOTIATE ((ber_tag_t) 0x04FFU)
548 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
549 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
550 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
551 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
552 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
553 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
554 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
555 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
556 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
557 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
559 /* extended filter component types */
560 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
561 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
562 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
563 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
565 /* substring filter component types */
566 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
567 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
568 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
571 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
572 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
573 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
574 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
575 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
576 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
577 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
578 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
579 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
581 /* substring filter component types */
582 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
583 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
584 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
589 #define LDAP_SUCCESS 0x00
591 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
593 #define LDAP_OPERATIONS_ERROR 0x01
594 #define LDAP_PROTOCOL_ERROR 0x02
595 #define LDAP_TIMELIMIT_EXCEEDED 0x03
596 #define LDAP_SIZELIMIT_EXCEEDED 0x04
597 #define LDAP_COMPARE_FALSE 0x05
598 #define LDAP_COMPARE_TRUE 0x06
599 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
600 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
601 #define LDAP_STRONG_AUTH_REQUIRED 0x08
602 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
603 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
605 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
606 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
607 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
608 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
609 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
611 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
613 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
614 #define LDAP_UNDEFINED_TYPE 0x11
615 #define LDAP_INAPPROPRIATE_MATCHING 0x12
616 #define LDAP_CONSTRAINT_VIOLATION 0x13
617 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
618 #define LDAP_INVALID_SYNTAX 0x15
620 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
622 #define LDAP_NO_SUCH_OBJECT 0x20
623 #define LDAP_ALIAS_PROBLEM 0x21
624 #define LDAP_INVALID_DN_SYNTAX 0x22
625 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
626 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
628 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
630 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
631 #define LDAP_INAPPROPRIATE_AUTH 0x30
632 #define LDAP_INVALID_CREDENTIALS 0x31
633 #define LDAP_INSUFFICIENT_ACCESS 0x32
635 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
637 #define LDAP_BUSY 0x33
638 #define LDAP_UNAVAILABLE 0x34
639 #define LDAP_UNWILLING_TO_PERFORM 0x35
640 #define LDAP_LOOP_DETECT 0x36
642 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
644 #define LDAP_NAMING_VIOLATION 0x40
645 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
646 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
647 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
648 #define LDAP_ALREADY_EXISTS 0x44
649 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
650 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
651 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
653 #define LDAP_VLV_ERROR 0x4C
655 #define LDAP_OTHER 0x50
657 /* LCUP operation codes (113-117) - not implemented */
658 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
659 #define LDAP_CUP_SECURITY_VIOLATION 0x72
660 #define LDAP_CUP_INVALID_DATA 0x73
661 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
662 #define LDAP_CUP_RELOAD_REQUIRED 0x75
664 /* Cancel operation codes (118-121) */
665 #define LDAP_CANCELLED 0x76
666 #define LDAP_NO_SUCH_OPERATION 0x77
667 #define LDAP_TOO_LATE 0x78
668 #define LDAP_CANNOT_CANCEL 0x79
670 /* Assertion control (122) */
671 #define LDAP_ASSERTION_FAILED 0x7A
673 /* Proxied Authorization Denied (123) */
674 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
676 /* Experimental result codes */
677 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
679 /* LDAP Sync (4096) */
680 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
683 /* Private Use result codes */
684 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
686 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
687 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
689 /* for the LDAP No-Op control */
690 #define LDAP_X_NO_OPERATION 0x410e
692 /* for the Chaining Behavior control (consecutive result codes requested;
693 * see <draft-sermersheim-ldap-chaining> ) */
694 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
695 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
696 #define LDAP_X_CANNOT_CHAIN 0x4111
699 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
700 #ifdef LDAP_X_DISTPROC_BASE
701 #define LDAP_X_INVALIDREFERENCE 0x4112
705 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
706 #define LDAP_X_TXN_ID_INVALID 0x4121
711 * Based on draft-ietf-ldap-c-api-xx
712 * but with new negative code values
714 #define LDAP_API_ERROR(n) ((n)<0)
715 #define LDAP_API_RESULT(n) ((n)<=0)
717 #define LDAP_SERVER_DOWN (-1)
718 #define LDAP_LOCAL_ERROR (-2)
719 #define LDAP_ENCODING_ERROR (-3)
720 #define LDAP_DECODING_ERROR (-4)
721 #define LDAP_TIMEOUT (-5)
722 #define LDAP_AUTH_UNKNOWN (-6)
723 #define LDAP_FILTER_ERROR (-7)
724 #define LDAP_USER_CANCELLED (-8)
725 #define LDAP_PARAM_ERROR (-9)
726 #define LDAP_NO_MEMORY (-10)
727 #define LDAP_CONNECT_ERROR (-11)
728 #define LDAP_NOT_SUPPORTED (-12)
729 #define LDAP_CONTROL_NOT_FOUND (-13)
730 #define LDAP_NO_RESULTS_RETURNED (-14)
731 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
732 #define LDAP_CLIENT_LOOP (-16)
733 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
734 #define LDAP_X_CONNECTING (-18)
738 * This structure represents both ldap messages and ldap responses.
739 * These are really the same, except in the case of search responses,
740 * where a response has multiple messages.
743 typedef struct ldapmsg LDAPMessage;
745 /* for modifications */
746 typedef struct ldapmod {
749 #define LDAP_MOD_OP (0x0007)
750 #define LDAP_MOD_ADD (0x0000)
751 #define LDAP_MOD_DELETE (0x0001)
752 #define LDAP_MOD_REPLACE (0x0002)
753 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
754 #define LDAP_MOD_BVALUES (0x0080)
755 /* IMPORTANT: do not use code 0x1000 (or above),
756 * it is used internally by the backends!
757 * (see ldap/servers/slapd/slap.h)
763 struct berval **modv_bvals;
765 #define mod_values mod_vals.modv_strvals
766 #define mod_bvalues mod_vals.modv_bvals
770 * structure representing an ldap session which can
771 * encompass connections to multiple servers (in the
772 * face of referrals).
774 typedef struct ldap LDAP;
776 #define LDAP_DEREF_NEVER 0x00
777 #define LDAP_DEREF_SEARCHING 0x01
778 #define LDAP_DEREF_FINDING 0x02
779 #define LDAP_DEREF_ALWAYS 0x03
781 #define LDAP_NO_LIMIT 0
783 /* how many messages to retrieve results for */
784 #define LDAP_MSG_ONE 0x00
785 #define LDAP_MSG_ALL 0x01
786 #define LDAP_MSG_RECEIVED 0x02
789 * types for ldap URL handling
791 typedef struct ldap_url_desc {
792 struct ldap_url_desc *lud_next;
804 #define LDAP_URL_SUCCESS 0x00 /* Success */
805 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
806 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
808 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
809 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
810 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
811 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
812 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
813 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
814 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
815 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
818 * LDAP sync (RFC4533) API
821 typedef struct ldap_sync_t ldap_sync_t;
824 /* these are private - the client should never see them */
825 LDAP_SYNC_CAPI_NONE = -1,
827 LDAP_SYNC_CAPI_PHASE_FLAG = 0x10U,
828 LDAP_SYNC_CAPI_IDSET_FLAG = 0x20U,
829 LDAP_SYNC_CAPI_DONE_FLAG = 0x40U,
831 /* these are passed to ls_search_entry() */
832 LDAP_SYNC_CAPI_PRESENT = LDAP_SYNC_PRESENT,
833 LDAP_SYNC_CAPI_ADD = LDAP_SYNC_ADD,
834 LDAP_SYNC_CAPI_MODIFY = LDAP_SYNC_MODIFY,
835 LDAP_SYNC_CAPI_DELETE = LDAP_SYNC_DELETE,
837 /* these are passed to ls_intermediate() */
838 LDAP_SYNC_CAPI_PRESENTS = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_PRESENT ),
839 LDAP_SYNC_CAPI_DELETES = ( LDAP_SYNC_CAPI_PHASE_FLAG | LDAP_SYNC_CAPI_DELETE ),
841 LDAP_SYNC_CAPI_PRESENTS_IDSET = ( LDAP_SYNC_CAPI_PRESENTS | LDAP_SYNC_CAPI_IDSET_FLAG ),
842 LDAP_SYNC_CAPI_DELETES_IDSET = ( LDAP_SYNC_CAPI_DELETES | LDAP_SYNC_CAPI_IDSET_FLAG ),
844 LDAP_SYNC_CAPI_DONE = ( LDAP_SYNC_CAPI_DONE_FLAG | LDAP_SYNC_CAPI_PRESENTS )
845 } ldap_sync_refresh_t;
848 * Called when an entry is returned by ldap_result().
849 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
850 * the entry has been either added or modified, and thus
851 * the complete view of the entry should be in the LDAPMessage.
852 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
853 * only the DN should be in the LDAPMessage.
855 typedef int (*ldap_sync_search_entry_f) LDAP_P((
858 struct berval *entryUUID,
859 ldap_sync_refresh_t phase ));
862 * Called when a reference is returned; the client should know
863 * what to do with it.
865 typedef int (*ldap_sync_search_reference_f) LDAP_P((
870 * Called when specific intermediate/final messages are returned.
871 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
872 * a "presents" or "deletes" phase begins.
873 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
874 * with refreshDone set to "TRUE" has been returned, to indicate
875 * that the refresh phase of a refreshAndPersist is complete.
876 * In the above cases, syncUUIDs is NULL.
878 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
879 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
880 * that are either present or have been deleted.
882 typedef int (*ldap_sync_intermediate_f) LDAP_P((
886 ldap_sync_refresh_t phase ));
889 * Called when a searchResultDone is returned. In refreshAndPersist,
890 * this can only occur if the search for any reason is being terminated
893 typedef int (*ldap_sync_search_result_f) LDAP_P((
896 int refreshDeletes ));
899 * This structure contains all information about the persistent search;
900 * the caller is responsible for connecting, setting version, binding, tls...
903 /* conf search params */
914 /* helpers - add as appropriate */
915 ldap_sync_search_entry_f ls_search_entry;
916 ldap_sync_search_reference_f ls_search_reference;
917 ldap_sync_intermediate_f ls_intermediate;
918 ldap_sync_search_result_f ls_search_result;
920 /* set by the caller as appropriate */
926 /* --- the parameters below are private - do not modify --- */
928 /* FIXME: make the structure opaque, and provide an interface
929 * to modify the public values? */
935 /* needed by refreshOnly */
938 /* opaque - need to pass between sessions, updated by the API */
939 struct berval ls_cookie;
941 /* state variable - do not modify */
942 ldap_sync_refresh_t ls_refreshPhase;
946 * End of LDAP sync (RFC4533) API
950 * Connection callbacks...
955 /* Called after a connection is established */
956 typedef int (ldap_conn_add_f) LDAP_P(( LDAP *ld, Sockbuf *sb, LDAPURLDesc *srv, struct sockaddr *addr,
957 struct ldap_conncb *ctx ));
958 /* Called before a connection is closed */
959 typedef void (ldap_conn_del_f) LDAP_P(( LDAP *ld, Sockbuf *sb, struct ldap_conncb *ctx ));
961 /* Callbacks are pushed on a stack. Last one pushed is first one executed. The
962 * delete callback is called with a NULL Sockbuf just before freeing the LDAP handle.
964 typedef struct ldap_conncb {
965 ldap_conn_add_f *lc_add;
966 ldap_conn_del_f *lc_del;
971 * The API draft spec says we should declare (or cause to be declared)
972 * 'struct timeval'. We don't. See IETF LDAPext discussions.
980 ldap_get_option LDAP_P((
986 ldap_set_option LDAP_P((
989 LDAP_CONST void *invalue));
991 /* V3 REBIND Function Callback Prototype */
992 typedef int (LDAP_REBIND_PROC) LDAP_P((
993 LDAP *ld, LDAP_CONST char *url,
994 ber_tag_t request, ber_int_t msgid,
998 ldap_set_rebind_proc LDAP_P((
1000 LDAP_REBIND_PROC *rebind_proc,
1003 /* V3 referral selection Function Callback Prototype */
1004 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
1005 LDAP *ld, char ***refsp, int *cntp,
1009 ldap_set_nextref_proc LDAP_P((
1011 LDAP_NEXTREF_PROC *nextref_proc,
1014 /* V3 URLLIST Function Callback Prototype */
1015 typedef int (LDAP_URLLIST_PROC) LDAP_P((
1017 LDAPURLDesc **urllist,
1022 ldap_set_urllist_proc LDAP_P((
1024 LDAP_URLLIST_PROC *urllist_proc,
1032 ldap_create_control LDAP_P(( /* deprecated, use ldap_control_create */
1033 LDAP_CONST char *requestOID,
1036 LDAPControl **ctrlp ));
1038 LDAP_F( LDAPControl * )
1039 ldap_find_control LDAP_P(( /* deprecated, use ldap_control_find */
1040 LDAP_CONST char *oid,
1041 LDAPControl **ctrls ));
1045 ldap_control_create LDAP_P((
1046 LDAP_CONST char *requestOID,
1048 struct berval *value,
1050 LDAPControl **ctrlp ));
1052 LDAP_F( LDAPControl * )
1053 ldap_control_find LDAP_P((
1054 LDAP_CONST char *oid,
1055 LDAPControl **ctrls,
1056 LDAPControl ***nextctrlp ));
1059 ldap_control_free LDAP_P((
1060 LDAPControl *ctrl ));
1063 ldap_controls_free LDAP_P((
1064 LDAPControl **ctrls ));
1066 LDAP_F( LDAPControl ** )
1067 ldap_controls_dup LDAP_P((
1068 LDAPControl *LDAP_CONST *controls ));
1070 LDAP_F( LDAPControl * )
1071 ldap_control_dup LDAP_P((
1072 LDAP_CONST LDAPControl *c ));
1078 ldap_domain2dn LDAP_P((
1079 LDAP_CONST char* domain,
1083 ldap_dn2domain LDAP_P((
1084 LDAP_CONST char* dn,
1088 ldap_domain2hostlist LDAP_P((
1089 LDAP_CONST char *domain,
1096 ldap_extended_operation LDAP_P((
1098 LDAP_CONST char *reqoid,
1099 struct berval *reqdata,
1100 LDAPControl **serverctrls,
1101 LDAPControl **clientctrls,
1105 ldap_extended_operation_s LDAP_P((
1107 LDAP_CONST char *reqoid,
1108 struct berval *reqdata,
1109 LDAPControl **serverctrls,
1110 LDAPControl **clientctrls,
1112 struct berval **retdatap ));
1115 ldap_parse_extended_result LDAP_P((
1119 struct berval **retdatap,
1123 ldap_parse_intermediate LDAP_P((
1127 struct berval **retdatap,
1128 LDAPControl ***serverctrls,
1136 ldap_abandon_ext LDAP_P((
1139 LDAPControl **serverctrls,
1140 LDAPControl **clientctrls ));
1144 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
1153 ldap_add_ext LDAP_P((
1155 LDAP_CONST char *dn,
1157 LDAPControl **serverctrls,
1158 LDAPControl **clientctrls,
1162 ldap_add_ext_s LDAP_P((
1164 LDAP_CONST char *dn,
1166 LDAPControl **serverctrls,
1167 LDAPControl **clientctrls ));
1171 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
1173 LDAP_CONST char *dn,
1177 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
1179 LDAP_CONST char *dn,
1188 ldap_sasl_bind LDAP_P((
1190 LDAP_CONST char *dn,
1191 LDAP_CONST char *mechanism,
1192 struct berval *cred,
1193 LDAPControl **serverctrls,
1194 LDAPControl **clientctrls,
1197 /* Interaction flags (should be passed about in a control)
1198 * Automatic (default): use defaults, prompt otherwise
1199 * Interactive: prompt always
1200 * Quiet: never prompt
1202 #define LDAP_SASL_AUTOMATIC 0U
1203 #define LDAP_SASL_INTERACTIVE 1U
1204 #define LDAP_SASL_QUIET 2U
1207 * V3 SASL Interaction Function Callback Prototype
1208 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1209 * should likely passed in a control (and provided controls)
1211 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1212 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1215 ldap_sasl_interactive_bind LDAP_P((
1217 LDAP_CONST char *dn, /* usually NULL */
1218 LDAP_CONST char *saslMechanism,
1219 LDAPControl **serverControls,
1220 LDAPControl **clientControls,
1222 /* should be client controls */
1224 LDAP_SASL_INTERACT_PROC *proc,
1227 /* as obtained from ldap_result() */
1228 LDAPMessage *result,
1230 /* returned during bind processing */
1235 ldap_sasl_interactive_bind_s LDAP_P((
1237 LDAP_CONST char *dn, /* usually NULL */
1238 LDAP_CONST char *saslMechanism,
1239 LDAPControl **serverControls,
1240 LDAPControl **clientControls,
1242 /* should be client controls */
1244 LDAP_SASL_INTERACT_PROC *proc,
1248 ldap_sasl_bind_s LDAP_P((
1250 LDAP_CONST char *dn,
1251 LDAP_CONST char *mechanism,
1252 struct berval *cred,
1253 LDAPControl **serverctrls,
1254 LDAPControl **clientctrls,
1255 struct berval **servercredp ));
1258 ldap_parse_sasl_bind_result LDAP_P((
1261 struct berval **servercredp,
1270 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1272 LDAP_CONST char *who,
1273 LDAP_CONST char *passwd,
1277 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1279 LDAP_CONST char *who,
1280 LDAP_CONST char *cred,
1287 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1289 LDAP_CONST char *who,
1290 LDAP_CONST char *passwd ));
1293 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1295 LDAP_CONST char *who,
1296 LDAP_CONST char *passwd ));
1305 ldap_compare_ext LDAP_P((
1307 LDAP_CONST char *dn,
1308 LDAP_CONST char *attr,
1309 struct berval *bvalue,
1310 LDAPControl **serverctrls,
1311 LDAPControl **clientctrls,
1315 ldap_compare_ext_s LDAP_P((
1317 LDAP_CONST char *dn,
1318 LDAP_CONST char *attr,
1319 struct berval *bvalue,
1320 LDAPControl **serverctrls,
1321 LDAPControl **clientctrls ));
1325 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1327 LDAP_CONST char *dn,
1328 LDAP_CONST char *attr,
1329 LDAP_CONST char *value ));
1332 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1334 LDAP_CONST char *dn,
1335 LDAP_CONST char *attr,
1336 LDAP_CONST char *value ));
1344 ldap_delete_ext LDAP_P((
1346 LDAP_CONST char *dn,
1347 LDAPControl **serverctrls,
1348 LDAPControl **clientctrls,
1352 ldap_delete_ext_s LDAP_P((
1354 LDAP_CONST char *dn,
1355 LDAPControl **serverctrls,
1356 LDAPControl **clientctrls ));
1360 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1362 LDAP_CONST char *dn ));
1365 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1367 LDAP_CONST char *dn ));
1375 ldap_parse_result LDAP_P((
1382 LDAPControl ***serverctrls,
1386 ldap_err2string LDAP_P((
1391 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1397 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1399 LDAP_CONST char *s ));
1407 ldap_gssapi_bind LDAP_P((
1409 LDAP_CONST char *dn,
1410 LDAP_CONST char *creds ));
1413 ldap_gssapi_bind_s LDAP_P((
1415 LDAP_CONST char *dn,
1416 LDAP_CONST char *creds ));
1423 ldap_modify_ext LDAP_P((
1425 LDAP_CONST char *dn,
1427 LDAPControl **serverctrls,
1428 LDAPControl **clientctrls,
1432 ldap_modify_ext_s LDAP_P((
1434 LDAP_CONST char *dn,
1436 LDAPControl **serverctrls,
1437 LDAPControl **clientctrls ));
1441 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1443 LDAP_CONST char *dn,
1447 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1449 LDAP_CONST char *dn,
1458 ldap_rename LDAP_P((
1460 LDAP_CONST char *dn,
1461 LDAP_CONST char *newrdn,
1462 LDAP_CONST char *newSuperior,
1464 LDAPControl **sctrls,
1465 LDAPControl **cctrls,
1469 ldap_rename_s LDAP_P((
1471 LDAP_CONST char *dn,
1472 LDAP_CONST char *newrdn,
1473 LDAP_CONST char *newSuperior,
1475 LDAPControl **sctrls,
1476 LDAPControl **cctrls ));
1480 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1482 LDAP_CONST char *dn,
1483 LDAP_CONST char *newrdn,
1484 LDAP_CONST char *newSuperior,
1485 int deleteoldrdn ));
1488 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1490 LDAP_CONST char *dn,
1491 LDAP_CONST char *newrdn,
1492 LDAP_CONST char *newSuperior,
1493 int deleteoldrdn ));
1496 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1498 LDAP_CONST char *dn,
1499 LDAP_CONST char *newrdn ));
1502 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1504 LDAP_CONST char *dn,
1505 LDAP_CONST char *newrdn ));
1508 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1510 LDAP_CONST char *dn,
1511 LDAP_CONST char *newrdn,
1512 int deleteoldrdn ));
1515 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1517 LDAP_CONST char *dn,
1518 LDAP_CONST char *newrdn,
1528 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1529 LDAP_CONST char *host,
1533 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1534 LDAP_CONST char *host,
1539 ldap_create LDAP_P((
1543 ldap_initialize LDAP_P((
1545 LDAP_CONST char *url ));
1556 ldap_tls_inplace LDAP_P((
1560 ldap_start_tls LDAP_P((
1562 LDAPControl **serverctrls,
1563 LDAPControl **clientctrls,
1567 ldap_install_tls LDAP_P((
1571 ldap_start_tls_s LDAP_P((
1573 LDAPControl **serverctrls,
1574 LDAPControl **clientctrls ));
1579 LDAP_F( LDAPMessage * )
1580 ldap_first_message LDAP_P((
1582 LDAPMessage *chain ));
1584 LDAP_F( LDAPMessage * )
1585 ldap_next_message LDAP_P((
1587 LDAPMessage *msg ));
1590 ldap_count_messages LDAP_P((
1592 LDAPMessage *chain ));
1597 LDAP_F( LDAPMessage * )
1598 ldap_first_reference LDAP_P((
1600 LDAPMessage *chain ));
1602 LDAP_F( LDAPMessage * )
1603 ldap_next_reference LDAP_P((
1605 LDAPMessage *ref ));
1608 ldap_count_references LDAP_P((
1610 LDAPMessage *chain ));
1613 ldap_parse_reference LDAP_P((
1617 LDAPControl ***serverctrls,
1624 LDAP_F( LDAPMessage * )
1625 ldap_first_entry LDAP_P((
1627 LDAPMessage *chain ));
1629 LDAP_F( LDAPMessage * )
1630 ldap_next_entry LDAP_P((
1632 LDAPMessage *entry ));
1635 ldap_count_entries LDAP_P((
1637 LDAPMessage *chain ));
1640 ldap_get_entry_controls LDAP_P((
1643 LDAPControl ***serverctrls));
1649 LDAP_F( LDAPMessage * )
1650 ldap_delete_result_entry LDAP_P((
1655 ldap_add_result_entry LDAP_P((
1664 ldap_get_dn LDAP_P((
1666 LDAPMessage *entry ));
1668 typedef struct ldap_ava {
1669 struct berval la_attr;
1670 struct berval la_value;
1672 #define LDAP_AVA_NULL 0x0000U
1673 #define LDAP_AVA_STRING 0x0001U
1674 #define LDAP_AVA_BINARY 0x0002U
1675 #define LDAP_AVA_NONPRINTABLE 0x0004U
1676 #define LDAP_AVA_FREE_ATTR 0x0010U
1677 #define LDAP_AVA_FREE_VALUE 0x0020U
1682 typedef LDAPAVA** LDAPRDN;
1683 typedef LDAPRDN* LDAPDN;
1686 #define LDAP_DN_FORMAT_LDAP 0x0000U
1687 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1688 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1689 #define LDAP_DN_FORMAT_DCE 0x0030U
1690 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1691 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1692 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1693 #define LDAP_DN_FORMAT_MASK 0x00F0U
1696 #define LDAP_DN_PRETTY 0x0100U
1697 #define LDAP_DN_SKIP 0x0200U
1698 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1699 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1700 #define LDAP_DN_PEDANTIC 0xF000U
1702 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1703 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1712 ldap_str2dn LDAP_P((
1713 LDAP_CONST char *str,
1724 ldap_dn2str LDAP_P((
1730 ldap_bv2rdn LDAP_P((
1737 ldap_str2rdn LDAP_P((
1738 LDAP_CONST char *str,
1744 ldap_rdn2bv LDAP_P((
1750 ldap_rdn2str LDAP_P((
1756 ldap_dn_normalize LDAP_P((
1757 LDAP_CONST char *in, unsigned iflags,
1758 char **out, unsigned oflags ));
1761 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1762 LDAP_CONST char *dn ));
1765 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1766 LDAP_CONST char *dn,
1770 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1771 LDAP_CONST char *rdn,
1774 typedef int LDAPDN_rewrite_func
1775 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1778 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1779 LDAPDN_rewrite_func *func, unsigned flags ));
1782 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1783 LDAP_CONST char *dn ));
1786 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1787 LDAP_CONST char *dce ));
1790 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1791 LDAP_CONST char *dn ));
1794 ldap_get_dn_ber LDAP_P((
1795 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1798 ldap_get_attribute_ber LDAP_P((
1799 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1800 struct berval **vals ));
1806 ldap_first_attribute LDAP_P((
1809 BerElement **ber ));
1812 ldap_next_attribute LDAP_P((
1821 LDAP_F( struct berval ** )
1822 ldap_get_values_len LDAP_P((
1825 LDAP_CONST char *target ));
1828 ldap_count_values_len LDAP_P((
1829 struct berval **vals ));
1832 ldap_value_free_len LDAP_P((
1833 struct berval **vals ));
1837 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1840 LDAP_CONST char *target ));
1843 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1847 ldap_value_free LDAP_P(( /* deprecated, use ldap_value_free_len */
1855 ldap_result LDAP_P((
1859 struct timeval *timeout,
1860 LDAPMessage **result ));
1863 ldap_msgtype LDAP_P((
1871 ldap_msgfree LDAP_P((
1875 ldap_msgdelete LDAP_P((
1884 ldap_bv2escaped_filter_value LDAP_P((
1886 struct berval *out ));
1889 ldap_search_ext LDAP_P((
1891 LDAP_CONST char *base,
1893 LDAP_CONST char *filter,
1896 LDAPControl **serverctrls,
1897 LDAPControl **clientctrls,
1898 struct timeval *timeout,
1903 ldap_search_ext_s LDAP_P((
1905 LDAP_CONST char *base,
1907 LDAP_CONST char *filter,
1910 LDAPControl **serverctrls,
1911 LDAPControl **clientctrls,
1912 struct timeval *timeout,
1914 LDAPMessage **res ));
1918 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1920 LDAP_CONST char *base,
1922 LDAP_CONST char *filter,
1927 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1929 LDAP_CONST char *base,
1931 LDAP_CONST char *filter,
1934 LDAPMessage **res ));
1937 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1939 LDAP_CONST char *base,
1941 LDAP_CONST char *filter,
1944 struct timeval *timeout,
1945 LDAPMessage **res ));
1952 ldap_unbind_ext LDAP_P((
1954 LDAPControl **serverctrls,
1955 LDAPControl **clientctrls));
1958 ldap_unbind_ext_s LDAP_P((
1960 LDAPControl **serverctrls,
1961 LDAPControl **clientctrls));
1964 ldap_destroy LDAP_P((
1969 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1973 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1981 ldap_put_vrFilter LDAP_P((
1990 ldap_memalloc LDAP_P((
1994 ldap_memrealloc LDAP_P((
1999 ldap_memcalloc LDAP_P((
2004 ldap_memfree LDAP_P((
2008 ldap_memvfree LDAP_P((
2012 ldap_strdup LDAP_P((
2013 LDAP_CONST char * ));
2016 ldap_mods_free LDAP_P((
2023 * in sort.c (deprecated, use custom code instead)
2025 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
2026 LDAP_CONST char *left,
2027 LDAP_CONST char *right ));
2029 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
2030 LDAP_CONST void *left,
2031 LDAP_CONST void *right ));
2033 LDAP_F( int ) /* deprecated */
2034 ldap_sort_entries LDAP_P(( LDAP *ld,
2035 LDAPMessage **chain,
2036 LDAP_CONST char *attr,
2037 LDAP_SORT_AD_CMP_PROC *cmp ));
2039 LDAP_F( int ) /* deprecated */
2040 ldap_sort_values LDAP_P((
2043 LDAP_SORT_AV_CMP_PROC *cmp ));
2045 LDAP_F( int ) /* deprecated */
2046 ldap_sort_strcasecmp LDAP_P((
2048 LDAP_CONST void *b ));
2055 ldap_is_ldap_url LDAP_P((
2056 LDAP_CONST char *url ));
2059 ldap_is_ldaps_url LDAP_P((
2060 LDAP_CONST char *url ));
2063 ldap_is_ldapi_url LDAP_P((
2064 LDAP_CONST char *url ));
2067 ldap_url_parse LDAP_P((
2068 LDAP_CONST char *url,
2069 LDAPURLDesc **ludpp ));
2072 ldap_url_desc2str LDAP_P((
2073 LDAPURLDesc *ludp ));
2076 ldap_free_urldesc LDAP_P((
2077 LDAPURLDesc *ludp ));
2081 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
2084 #define LDAP_API_FEATURE_CANCEL 1000
2087 ldap_cancel LDAP_P(( LDAP *ld,
2089 LDAPControl **sctrls,
2090 LDAPControl **cctrls,
2094 ldap_cancel_s LDAP_P(( LDAP *ld,
2096 LDAPControl **sctrl,
2097 LDAPControl **cctrl ));
2100 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
2103 #define LDAP_API_FEATURE_TURN 1000
2106 ldap_turn LDAP_P(( LDAP *ld,
2108 LDAP_CONST char* identifier,
2109 LDAPControl **sctrls,
2110 LDAPControl **cctrls,
2114 ldap_turn_s LDAP_P(( LDAP *ld,
2116 LDAP_CONST char* identifier,
2117 LDAPControl **sctrl,
2118 LDAPControl **cctrl ));
2121 * LDAP Paged Results
2124 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
2127 ldap_create_page_control_value LDAP_P((
2130 struct berval *cookie,
2131 struct berval *value ));
2134 ldap_create_page_control LDAP_P((
2137 struct berval *cookie,
2139 LDAPControl **ctrlp ));
2143 ldap_parse_page_control LDAP_P((
2144 /* deprecated, use ldap_parse_pageresponse_control */
2146 LDAPControl **ctrls,
2148 struct berval **cookie ));
2152 ldap_parse_pageresponse_control LDAP_P((
2156 struct berval *cookie ));
2159 * LDAP Server Side Sort
2162 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2164 /* structure for a sort-key */
2165 typedef struct ldapsortkey {
2166 char *attributeType;
2172 ldap_create_sort_keylist LDAP_P((
2173 LDAPSortKey ***sortKeyList,
2177 ldap_free_sort_keylist LDAP_P((
2178 LDAPSortKey **sortkeylist ));
2181 ldap_create_sort_control_value LDAP_P((
2183 LDAPSortKey **keyList,
2184 struct berval *value ));
2187 ldap_create_sort_control LDAP_P((
2189 LDAPSortKey **keyList,
2191 LDAPControl **ctrlp ));
2194 ldap_parse_sortresponse_control LDAP_P((
2198 char **attribute ));
2201 * LDAP Virtual List View
2204 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2206 /* structure for virtual list */
2207 typedef struct ldapvlvinfo {
2208 ber_int_t ldvlv_version;
2209 ber_int_t ldvlv_before_count;
2210 ber_int_t ldvlv_after_count;
2211 ber_int_t ldvlv_offset;
2212 ber_int_t ldvlv_count;
2213 struct berval * ldvlv_attrvalue;
2214 struct berval * ldvlv_context;
2215 void * ldvlv_extradata;
2219 ldap_create_vlv_control_value LDAP_P((
2221 LDAPVLVInfo *ldvlistp,
2222 struct berval *value));
2225 ldap_create_vlv_control LDAP_P((
2227 LDAPVLVInfo *ldvlistp,
2228 LDAPControl **ctrlp ));
2231 ldap_parse_vlvresponse_control LDAP_P((
2234 ber_int_t *target_posp,
2235 ber_int_t *list_countp,
2236 struct berval **contextp,
2240 * LDAP Verify Credentials
2242 #define LDAP_API_FEATURE_VERIFY_CREDENTIALS 1000
2245 ldap_verify_credentials LDAP_P((
2247 struct berval *cookie,
2248 LDAP_CONST char *dn,
2249 LDAP_CONST char *mechanism,
2250 struct berval *cred,
2251 LDAPControl **ctrls,
2252 LDAPControl **serverctrls,
2253 LDAPControl **clientctrls,
2257 ldap_verify_credentials_s LDAP_P((
2259 struct berval *cookie,
2260 LDAP_CONST char *dn,
2261 LDAP_CONST char *mechanism,
2262 struct berval *cred,
2263 LDAPControl **vcictrls,
2264 LDAPControl **serverctrls,
2265 LDAPControl **clientctrls,
2268 struct berval **scookie,
2269 struct berval **servercredp,
2270 LDAPControl ***vcoctrls));
2274 ldap_parse_verify_credentials LDAP_P((
2279 struct berval **cookie,
2280 struct berval **servercredp,
2281 LDAPControl ***vcctrls));
2283 /* not yet implemented */
2284 /* #define LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE 1000 */
2285 #ifdef LDAP_API_FEATURE_VERIFY_CREDENTIALS_INTERACTIVE
2287 ldap_verify_credentials_interactive LDAP_P((
2289 LDAP_CONST char *dn, /* usually NULL */
2290 LDAP_CONST char *saslMechanism,
2291 LDAPControl **vcControls,
2292 LDAPControl **serverControls,
2293 LDAPControl **clientControls,
2295 /* should be client controls */
2297 LDAP_SASL_INTERACT_PROC *proc,
2301 /* as obtained from ldap_result() */
2302 LDAPMessage *result,
2304 /* returned during bind processing */
2313 #define LDAP_API_FEATURE_WHOAMI 1000
2316 ldap_parse_whoami LDAP_P((
2319 struct berval **authzid ));
2322 ldap_whoami LDAP_P(( LDAP *ld,
2323 LDAPControl **sctrls,
2324 LDAPControl **cctrls,
2328 ldap_whoami_s LDAP_P((
2330 struct berval **authzid,
2331 LDAPControl **sctrls,
2332 LDAPControl **cctrls ));
2335 * LDAP Password Modify
2338 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2341 ldap_parse_passwd LDAP_P((
2344 struct berval *newpasswd ));
2347 ldap_passwd LDAP_P(( LDAP *ld,
2348 struct berval *user,
2349 struct berval *oldpw,
2350 struct berval *newpw,
2351 LDAPControl **sctrls,
2352 LDAPControl **cctrls,
2356 ldap_passwd_s LDAP_P((
2358 struct berval *user,
2359 struct berval *oldpw,
2360 struct berval *newpw,
2361 struct berval *newpasswd,
2362 LDAPControl **sctrls,
2363 LDAPControl **cctrls ));
2365 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2367 * LDAP Password Policy controls
2370 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2372 typedef enum passpolicyerror_enum {
2373 PP_passwordExpired = 0,
2374 PP_accountLocked = 1,
2375 PP_changeAfterReset = 2,
2376 PP_passwordModNotAllowed = 3,
2377 PP_mustSupplyOldPassword = 4,
2378 PP_insufficientPasswordQuality = 5,
2379 PP_passwordTooShort = 6,
2380 PP_passwordTooYoung = 7,
2381 PP_passwordInHistory = 8,
2383 } LDAPPasswordPolicyError;
2386 ldap_create_passwordpolicy_control LDAP_P((
2388 LDAPControl **ctrlp ));
2391 ldap_parse_passwordpolicy_control LDAP_P((
2396 LDAPPasswordPolicyError *errorp ));
2398 LDAP_F( const char * )
2399 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2400 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2403 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2406 #define LDAP_API_FEATURE_REFRESH 1000
2409 ldap_parse_refresh LDAP_P((
2412 ber_int_t *newttl ));
2415 ldap_refresh LDAP_P(( LDAP *ld,
2418 LDAPControl **sctrls,
2419 LDAPControl **cctrls,
2423 ldap_refresh_s LDAP_P((
2428 LDAPControl **sctrls,
2429 LDAPControl **cctrls ));
2436 ldap_txn_start LDAP_P(( LDAP *ld,
2437 LDAPControl **sctrls,
2438 LDAPControl **cctrls,
2442 ldap_txn_start_s LDAP_P(( LDAP *ld,
2443 LDAPControl **sctrl,
2444 LDAPControl **cctrl,
2445 struct berval **rettxnid ));
2448 ldap_txn_end LDAP_P(( LDAP *ld,
2450 struct berval *txnid,
2451 LDAPControl **sctrls,
2452 LDAPControl **cctrls,
2456 ldap_txn_end_s LDAP_P(( LDAP *ld,
2458 struct berval *txnid,
2459 LDAPControl **sctrl,
2460 LDAPControl **cctrl,
2469 * initialize the persistent search structure
2471 LDAP_F( ldap_sync_t * )
2472 ldap_sync_initialize LDAP_P((
2476 * destroy the persistent search structure
2479 ldap_sync_destroy LDAP_P((
2484 * initialize a refreshOnly sync
2487 ldap_sync_init LDAP_P((
2492 * initialize a refreshOnly sync
2495 ldap_sync_init_refresh_only LDAP_P((
2499 * initialize a refreshAndPersist sync
2502 ldap_sync_init_refresh_and_persist LDAP_P((
2506 * poll for new responses
2509 ldap_sync_poll LDAP_P((
2512 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2518 ldap_create_session_tracking_value LDAP_P((
2520 char *sessionSourceIp,
2521 char *sessionSourceName,
2523 struct berval *sessionTrackingIdentifier,
2524 struct berval *value ));
2527 ldap_create_session_tracking_control LDAP_P((
2529 char *sessionSourceIp,
2530 char *sessionSourceName,
2532 struct berval *sessionTrackingIdentifier,
2533 LDAPControl **ctrlp ));
2536 ldap_parse_session_tracking_control LDAP_P((
2540 struct berval *name,
2542 struct berval *id ));
2544 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2550 ldap_create_assertion_control_value LDAP_P((
2553 struct berval *value ));
2556 ldap_create_assertion_control LDAP_P((
2560 LDAPControl **ctrlp ));
2566 typedef struct LDAPDerefSpec {
2571 typedef struct LDAPDerefVal {
2574 struct LDAPDerefVal *next;
2577 typedef struct LDAPDerefRes {
2579 struct berval derefVal;
2580 LDAPDerefVal *attrVals;
2581 struct LDAPDerefRes *next;
2585 ldap_create_deref_control_value LDAP_P((
2588 struct berval *value ));
2591 ldap_create_deref_control LDAP_P((
2595 LDAPControl **ctrlp ));
2598 ldap_derefresponse_free LDAP_P((
2599 LDAPDerefRes *dr ));
2602 ldap_parse_derefresponse_control LDAP_P((
2605 LDAPDerefRes **drp ));
2608 ldap_parse_deref_control LDAP_P((
2610 LDAPControl **ctrls,
2611 LDAPDerefRes **drp ));
2614 * high level LDIF to LDAP structure support
2616 #define LDIF_DEFAULT_ADD 0x01 /* if changetype missing, assume LDAP_ADD */
2617 #define LDIF_ENTRIES_ONLY 0x02 /* ignore changetypes other than add */
2618 #define LDIF_NO_CONTROLS 0x04 /* ignore control specifications */
2620 typedef struct ldifrecord {
2621 ber_tag_t lr_op; /* type of operation - LDAP_REQ_MODIFY, LDAP_REQ_ADD, etc. */
2622 struct berval lr_dn; /* DN of operation */
2623 LDAPControl **lr_ctrls; /* controls specified for operation */
2624 /* some ops such as LDAP_REQ_DELETE require only a DN */
2625 /* other ops require different data - the ldif_ops union
2626 is used to specify the data for each type of operation */
2628 LDAPMod **lr_mods; /* list of mods for LDAP_REQ_MODIFY, LDAP_REQ_ADD */
2629 #define lrop_mods ldif_ops.lr_mods
2630 struct ldif_op_rename_s {
2631 struct berval lr_newrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2632 #define lrop_newrdn ldif_ops.ldif_op_rename.lr_newrdn
2633 struct berval lr_newsuperior; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2634 #define lrop_newsup ldif_ops.ldif_op_rename.lr_newsuperior
2635 int lr_deleteoldrdn; /* LDAP_REQ_MODDN, LDAP_REQ_MODRDN, LDAP_REQ_RENAME */
2636 #define lrop_delold ldif_ops.ldif_op_rename.lr_deleteoldrdn
2637 } ldif_op_rename; /* rename/moddn/modrdn */
2638 /* the following are for future support */
2639 struct ldif_op_ext_s {
2640 struct berval lr_extop_oid; /* LDAP_REQ_EXTENDED */
2641 #define lrop_extop_oid ldif_ops.ldif_op_ext.lr_extop_oid
2642 struct berval lr_extop_data; /* LDAP_REQ_EXTENDED */
2643 #define lrop_extop_data ldif_ops.ldif_op_ext.lr_extop_data
2644 } ldif_op_ext; /* extended operation */
2645 struct ldif_op_cmp_s {
2646 struct berval lr_cmp_attr; /* LDAP_REQ_COMPARE */
2647 #define lrop_cmp_attr ldif_ops.ldif_op_cmp.lr_cmp_attr
2648 struct berval lr_cmp_bvalue; /* LDAP_REQ_COMPARE */
2649 #define lrop_cmp_bval ldif_ops.ldif_op_cmp.lr_cmp_bvalue
2650 } ldif_op_cmp; /* compare operation */
2652 /* PRIVATE STUFF - DO NOT TOUCH */
2653 /* for efficiency, the implementation allocates memory */
2654 /* in large blobs, and makes the above fields point to */
2655 /* locations inside those blobs - one consequence is that */
2656 /* you cannot simply free the above allocated fields, nor */
2657 /* assign them to be owned by another memory context which */
2658 /* might free them (unless providing your own mem ctx) */
2659 /* we use the fields below to keep track of those blobs */
2660 /* so we that we can free them later */
2661 void *lr_ctx; /* the memory context or NULL */
2664 unsigned char *lr_mops;
2666 struct berval *lr_vals;
2667 struct berval *lr_btype;
2670 /* free internal fields - does not free the LDIFRecord */
2672 ldap_ldif_record_done LDAP_P((
2676 ldap_parse_ldif_record LDAP_P((
2677 struct berval *rbuf,
2678 unsigned long linenum,
2681 unsigned int flags ));
2684 #endif /* _LDAP_H */