2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2006 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
64 #if defined( LDAP_THREAD_SAFE ) && \
65 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
66 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
67 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
71 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
72 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
74 #define LDAP_ROOT_DSE ""
75 #define LDAP_NO_ATTRS "1.1"
76 #define LDAP_ALL_USER_ATTRIBUTES "*"
77 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
79 /* RFC 4511: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
80 #define LDAP_MAXINT (2147483647)
84 * 0x0000 - 0x0fff reserved for api options
85 * 0x1000 - 0x3fff reserved for api extended options
86 * 0x4000 - 0x7fff reserved for private and experimental options
89 #define LDAP_OPT_API_INFO 0x0000
90 #define LDAP_OPT_DESC 0x0001 /* historic */
91 #define LDAP_OPT_DEREF 0x0002
92 #define LDAP_OPT_SIZELIMIT 0x0003
93 #define LDAP_OPT_TIMELIMIT 0x0004
94 /* 0x05 - 0x07 not defined */
95 #define LDAP_OPT_REFERRALS 0x0008
96 #define LDAP_OPT_RESTART 0x0009
97 /* 0x0a - 0x10 not defined */
98 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
99 #define LDAP_OPT_SERVER_CONTROLS 0x0012
100 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
101 /* 0x14 not defined */
102 #define LDAP_OPT_API_FEATURE_INFO 0x0015
103 /* 0x16 - 0x2f not defined */
104 #define LDAP_OPT_HOST_NAME 0x0030
105 #define LDAP_OPT_RESULT_CODE 0x0031
106 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
107 #define LDAP_OPT_ERROR_STRING 0x0032
108 #define LDAP_OPT_MATCHED_DN 0x0033
109 /* 0x0034 - 0x3fff not defined */
112 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
114 /* private and experimental options */
115 /* OpenLDAP specific options */
116 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
117 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
118 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
119 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
120 #define LDAP_OPT_URI 0x5006
121 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
122 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */
123 #define LDAP_OPT_DEFBASE 0x5009 /* searchbase */
125 /* OpenLDAP TLS options */
126 #define LDAP_OPT_X_TLS 0x6000
127 #define LDAP_OPT_X_TLS_CTX 0x6001 /* OpenSSL CTX */
128 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
129 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
130 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
131 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
132 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
133 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
134 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
135 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
136 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
137 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
138 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
139 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
140 #define LDAP_OPT_X_TLS_DHFILE 0x600e
141 #define LDAP_OPT_X_TLS_NEWCTX 0x600f
143 #define LDAP_OPT_X_TLS_NEVER 0
144 #define LDAP_OPT_X_TLS_HARD 1
145 #define LDAP_OPT_X_TLS_DEMAND 2
146 #define LDAP_OPT_X_TLS_ALLOW 3
147 #define LDAP_OPT_X_TLS_TRY 4
149 #define LDAP_OPT_X_TLS_CRL_NONE 0
150 #define LDAP_OPT_X_TLS_CRL_PEER 1
151 #define LDAP_OPT_X_TLS_CRL_ALL 2
153 /* OpenLDAP SASL options */
154 #define LDAP_OPT_X_SASL_MECH 0x6100
155 #define LDAP_OPT_X_SASL_REALM 0x6101
156 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
157 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
158 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
159 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
160 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
161 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
162 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
163 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
165 /* Private API Extensions -- reserved for application use */
166 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
169 * ldap_get_option() and ldap_set_option() return values.
170 * As later versions may return other values indicating
171 * failure, current applications should only compare returned
172 * value against LDAP_OPT_SUCCESS.
174 #define LDAP_OPT_SUCCESS 0
175 #define LDAP_OPT_ERROR (-1)
177 /* option on/off values */
178 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
179 #define LDAP_OPT_OFF ((void *) 0)
181 typedef struct ldapapiinfo {
182 int ldapai_info_version; /* version of LDAPAPIInfo */
183 #define LDAP_API_INFO_VERSION (1)
184 int ldapai_api_version; /* revision of API supported */
185 int ldapai_protocol_version; /* highest LDAP version supported */
186 char **ldapai_extensions; /* names of API extensions */
187 char *ldapai_vendor_name; /* name of supplier */
188 int ldapai_vendor_version; /* supplier-specific version * 100 */
191 typedef struct ldap_apifeature_info {
192 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
193 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
194 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
195 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
196 } LDAPAPIFeatureInfo;
199 * LDAP Control structure
201 typedef struct ldapcontrol {
202 char * ldctl_oid; /* numericoid of control */
203 struct berval ldctl_value; /* encoded value of control */
204 char ldctl_iscritical; /* criticality */
208 /* standard track controls */
209 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
210 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
211 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
213 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
215 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
216 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
217 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
219 /* standard track - not implemented in slapd(8) */
220 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
221 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
223 /* non-standard track controls */
224 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
226 /* LDAP Content Synchronization Operation -- RFC 4533 */
227 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
228 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
229 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
230 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
231 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
233 #define LDAP_SYNC_NONE 0x00
234 #define LDAP_SYNC_REFRESH_ONLY 0x01
235 #define LDAP_SYNC_RESERVED 0x02
236 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
238 #define LDAP_SYNC_REFRESH_PRESENTS 0
239 #define LDAP_SYNC_REFRESH_DELETES 1
241 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
242 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
243 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
244 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
246 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
247 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
248 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
249 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
251 #define LDAP_SYNC_PRESENT 0
252 #define LDAP_SYNC_ADD 1
253 #define LDAP_SYNC_MODIFY 2
254 #define LDAP_SYNC_DELETE 3
257 /* Password policy Controls *//* work in progress */
258 /* ITS#3458: released; disabled by default */
259 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
260 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
262 /* various works in progress */
263 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
264 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
265 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
266 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
267 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
268 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
269 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
272 /* LDAP Chaining Behavior Control *//* work in progress */
273 /* <draft-sermersheim-ldap-chaining>;
274 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
275 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
277 #define LDAP_CHAINING_PREFERRED 0
278 #define LDAP_CHAINING_REQUIRED 1
279 #define LDAP_REFERRALS_PREFERRED 2
280 #define LDAP_REFERRALS_REQUIRED 3
282 /* MS Active Directory controls (for compatibility) */
283 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
284 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
285 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
286 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
287 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
288 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
290 /* MS Active Directory controls - not implemented in slapd(8) */
291 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
292 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
294 /* various expired works */
295 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
296 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
297 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
298 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
299 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
301 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
302 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
303 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
304 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
305 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
306 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
307 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
309 /* LDAP VLV *//* not implemented in slapd(8) */
310 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
311 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
314 /* LDAP Unsolicited Notifications */
315 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
316 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
318 /* LDAP Extended Operations */
319 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
321 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
322 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
323 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
324 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
325 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
327 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
328 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
330 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
331 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
332 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
333 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
335 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
336 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
338 /* various works in progress */
339 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
340 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
342 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
343 /* a work in progress */
344 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
345 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
346 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
347 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
348 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
349 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
350 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
351 LDAP_X_DISTPROC_BASE ".6"
352 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
353 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
354 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
355 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
356 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
359 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
360 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
361 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
362 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
363 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
367 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
368 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
369 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
370 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
371 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
372 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
373 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
375 /* LDAP Experimental (works in progress) Features */
376 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
377 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
378 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
381 * specific LDAP instantiations of BER types we know about
384 /* Overview of LBER tag construction
391 * 1 0 = CONTEXT-SPECIFIC
398 * | 5 ... 1 | TAG-NUMBER
402 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
403 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
405 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
406 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
408 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
409 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
411 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
413 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
414 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
415 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
416 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
418 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
419 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
421 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
423 /* LDAP Request Messages */
424 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
425 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
426 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
427 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
428 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
429 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
430 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
431 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
432 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
433 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
434 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
435 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
437 /* LDAP Response Messages */
438 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
439 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
440 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
441 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
442 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
443 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
444 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
445 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
446 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
447 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
448 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
449 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
450 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
452 #define LDAP_RES_ANY (-1)
453 #define LDAP_RES_UNSOLICITED (0)
457 #define LDAP_SASL_SIMPLE ((char*)0)
458 #define LDAP_SASL_NULL ("")
461 /* authentication methods available */
462 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
463 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
464 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
465 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
466 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
467 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
471 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
472 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
473 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
474 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
475 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
476 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
477 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
478 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
479 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
480 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
482 /* extended filter component types */
483 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
484 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
485 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
486 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
488 /* substring filter component types */
489 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
490 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
491 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
494 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
495 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
496 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
497 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
498 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
499 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
500 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
501 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
502 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
504 /* substring filter component types */
505 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
506 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
507 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
512 #define LDAP_SUCCESS 0x00
514 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
516 #define LDAP_OPERATIONS_ERROR 0x01
517 #define LDAP_PROTOCOL_ERROR 0x02
518 #define LDAP_TIMELIMIT_EXCEEDED 0x03
519 #define LDAP_SIZELIMIT_EXCEEDED 0x04
520 #define LDAP_COMPARE_FALSE 0x05
521 #define LDAP_COMPARE_TRUE 0x06
522 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
523 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
524 #define LDAP_STRONG_AUTH_REQUIRED 0x08
525 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
526 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
528 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
529 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
530 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
531 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
532 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
534 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
536 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
537 #define LDAP_UNDEFINED_TYPE 0x11
538 #define LDAP_INAPPROPRIATE_MATCHING 0x12
539 #define LDAP_CONSTRAINT_VIOLATION 0x13
540 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
541 #define LDAP_INVALID_SYNTAX 0x15
543 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
545 #define LDAP_NO_SUCH_OBJECT 0x20
546 #define LDAP_ALIAS_PROBLEM 0x21
547 #define LDAP_INVALID_DN_SYNTAX 0x22
548 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
549 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
551 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
553 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
554 #define LDAP_INAPPROPRIATE_AUTH 0x30
555 #define LDAP_INVALID_CREDENTIALS 0x31
556 #define LDAP_INSUFFICIENT_ACCESS 0x32
558 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
560 #define LDAP_BUSY 0x33
561 #define LDAP_UNAVAILABLE 0x34
562 #define LDAP_UNWILLING_TO_PERFORM 0x35
563 #define LDAP_LOOP_DETECT 0x36
565 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
567 #define LDAP_NAMING_VIOLATION 0x40
568 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
569 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
570 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
571 #define LDAP_ALREADY_EXISTS 0x44
572 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
573 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
574 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
576 #define LDAP_OTHER 0x50
578 /* LCUP operation codes (113-117) - not implemented */
579 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
580 #define LDAP_CUP_SECURITY_VIOLATION 0x72
581 #define LDAP_CUP_INVALID_DATA 0x73
582 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
583 #define LDAP_CUP_RELOAD_REQUIRED 0x75
585 /* Cancel operation codes (118-121) */
586 #define LDAP_CANCELLED 0x76
587 #define LDAP_NO_SUCH_OPERATION 0x77
588 #define LDAP_TOO_LATE 0x78
589 #define LDAP_CANNOT_CANCEL 0x79
591 /* Assertion control (122) */
592 #define LDAP_ASSERTION_FAILED 0x7A
594 /* Proxied Authorization Denied (123) */
595 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
597 /* Experimental result codes */
598 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
600 /* LDAP Sync (4096) */
601 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
604 /* Private Use result codes */
605 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
607 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
608 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
610 /* for the LDAP No-Op control */
611 #define LDAP_X_NO_OPERATION 0x410e
613 /* for the Chaining Behavior control (consecutive result codes requested;
614 * see <draft-sermersheim-ldap-chaining> ) */
615 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
616 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
617 #define LDAP_X_CANNOT_CHAIN 0x4111
620 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
621 #ifdef LDAP_X_DISTPROC_BASE
622 #define LDAP_X_INVALIDREFERENCE 0x4112
626 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
627 #define LDAP_X_TXN_ID_INVALID 0x4121
632 * Based on draft-ietf-ldap-c-api-xx
633 * but with new negative code values
635 #define LDAP_API_ERROR(n) ((n)<0)
636 #define LDAP_API_RESULT(n) ((n)<=0)
638 #define LDAP_SERVER_DOWN (-1)
639 #define LDAP_LOCAL_ERROR (-2)
640 #define LDAP_ENCODING_ERROR (-3)
641 #define LDAP_DECODING_ERROR (-4)
642 #define LDAP_TIMEOUT (-5)
643 #define LDAP_AUTH_UNKNOWN (-6)
644 #define LDAP_FILTER_ERROR (-7)
645 #define LDAP_USER_CANCELLED (-8)
646 #define LDAP_PARAM_ERROR (-9)
647 #define LDAP_NO_MEMORY (-10)
648 #define LDAP_CONNECT_ERROR (-11)
649 #define LDAP_NOT_SUPPORTED (-12)
650 #define LDAP_CONTROL_NOT_FOUND (-13)
651 #define LDAP_NO_RESULTS_RETURNED (-14)
652 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
653 #define LDAP_CLIENT_LOOP (-16)
654 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
658 * This structure represents both ldap messages and ldap responses.
659 * These are really the same, except in the case of search responses,
660 * where a response has multiple messages.
663 typedef struct ldapmsg LDAPMessage;
665 /* for modifications */
666 typedef struct ldapmod {
669 #define LDAP_MOD_OP (0x0007)
670 #define LDAP_MOD_ADD (0x0000)
671 #define LDAP_MOD_DELETE (0x0001)
672 #define LDAP_MOD_REPLACE (0x0002)
673 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
674 #define LDAP_MOD_BVALUES (0x0080)
675 /* IMPORTANT: do not use code 0x1000 (or above),
676 * it is used internally by the backends!
677 * (see ldap/servers/slapd/slap.h)
683 struct berval **modv_bvals;
685 #define mod_values mod_vals.modv_strvals
686 #define mod_bvalues mod_vals.modv_bvals
690 * structure representing an ldap session which can
691 * encompass connections to multiple servers (in the
692 * face of referrals).
694 typedef struct ldap LDAP;
696 #define LDAP_DEREF_NEVER 0x00
697 #define LDAP_DEREF_SEARCHING 0x01
698 #define LDAP_DEREF_FINDING 0x02
699 #define LDAP_DEREF_ALWAYS 0x03
701 #define LDAP_NO_LIMIT 0
703 /* how many messages to retrieve results for */
704 #define LDAP_MSG_ONE 0x00
705 #define LDAP_MSG_ALL 0x01
706 #define LDAP_MSG_RECEIVED 0x02
709 * types for ldap URL handling
711 typedef struct ldap_url_desc {
712 struct ldap_url_desc *lud_next;
724 #define LDAP_URL_SUCCESS 0x00 /* Success */
725 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
726 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
728 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
729 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
730 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
731 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
732 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
733 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
734 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
735 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
738 * The API draft spec says we should declare (or cause to be declared)
739 * 'struct timeval'. We don't. See IETF LDAPext discussions.
747 ldap_get_option LDAP_P((
753 ldap_set_option LDAP_P((
756 LDAP_CONST void *invalue));
758 /* V3 REBIND Function Callback Prototype */
759 typedef int (LDAP_REBIND_PROC) LDAP_P((
760 LDAP *ld, LDAP_CONST char *url,
761 ber_tag_t request, ber_int_t msgid,
765 ldap_set_rebind_proc LDAP_P((
767 LDAP_REBIND_PROC *rebind_proc,
770 /* V3 referral selection Function Callback Prototype */
771 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
772 LDAP *ld, char ***refsp, int *cntp,
776 ldap_set_nextref_proc LDAP_P((
778 LDAP_NEXTREF_PROC *nextref_proc,
781 /* V3 URLLIST Function Callback Prototype */
782 typedef int (LDAP_URLLIST_PROC) LDAP_P((
784 LDAPURLDesc **urllist,
789 ldap_set_urllist_proc LDAP_P((
791 LDAP_URLLIST_PROC *urllist_proc,
798 ldap_create_control LDAP_P((
799 LDAP_CONST char *requestOID,
802 LDAPControl **ctrlp ));
804 LDAP_F( LDAPControl * )
805 ldap_find_control LDAP_P((
806 LDAP_CONST char *oid,
807 LDAPControl **ctrls ));
810 ldap_control_free LDAP_P((
811 LDAPControl *ctrl ));
814 ldap_controls_free LDAP_P((
815 LDAPControl **ctrls ));
821 ldap_domain2dn LDAP_P((
822 LDAP_CONST char* domain,
826 ldap_dn2domain LDAP_P((
831 ldap_domain2hostlist LDAP_P((
832 LDAP_CONST char *domain,
839 ldap_extended_operation LDAP_P((
841 LDAP_CONST char *reqoid,
842 struct berval *reqdata,
843 LDAPControl **serverctrls,
844 LDAPControl **clientctrls,
848 ldap_extended_operation_s LDAP_P((
850 LDAP_CONST char *reqoid,
851 struct berval *reqdata,
852 LDAPControl **serverctrls,
853 LDAPControl **clientctrls,
855 struct berval **retdatap ));
858 ldap_parse_extended_result LDAP_P((
862 struct berval **retdatap,
866 ldap_parse_intermediate LDAP_P((
870 struct berval **retdatap,
871 LDAPControl ***serverctrls,
879 ldap_abandon_ext LDAP_P((
882 LDAPControl **serverctrls,
883 LDAPControl **clientctrls ));
887 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
896 ldap_add_ext LDAP_P((
900 LDAPControl **serverctrls,
901 LDAPControl **clientctrls,
905 ldap_add_ext_s LDAP_P((
909 LDAPControl **serverctrls,
910 LDAPControl **clientctrls ));
914 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
920 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
931 ldap_sasl_bind LDAP_P((
934 LDAP_CONST char *mechanism,
936 LDAPControl **serverctrls,
937 LDAPControl **clientctrls,
940 /* Interaction flags (should be passed about in a control)
941 * Automatic (default): use defaults, prompt otherwise
942 * Interactive: prompt always
943 * Quiet: never prompt
945 #define LDAP_SASL_AUTOMATIC 0U
946 #define LDAP_SASL_INTERACTIVE 1U
947 #define LDAP_SASL_QUIET 2U
950 * V3 SASL Interaction Function Callback Prototype
951 * when using Cyrus SASL, interact is pointer to sasl_interact_t
952 * should likely passed in a control (and provided controls)
954 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
955 LDAP *ld, unsigned flags, void* defaults, void *interact ));
958 ldap_sasl_interactive_bind_s LDAP_P((
960 LDAP_CONST char *dn, /* usually NULL */
961 LDAP_CONST char *saslMechanism,
962 LDAPControl **serverControls,
963 LDAPControl **clientControls,
965 /* should be client controls */
967 LDAP_SASL_INTERACT_PROC *proc,
971 ldap_sasl_bind_s LDAP_P((
974 LDAP_CONST char *mechanism,
976 LDAPControl **serverctrls,
977 LDAPControl **clientctrls,
978 struct berval **servercredp ));
981 ldap_parse_sasl_bind_result LDAP_P((
984 struct berval **servercredp,
993 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
995 LDAP_CONST char *who,
996 LDAP_CONST char *passwd,
1000 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1002 LDAP_CONST char *who,
1003 LDAP_CONST char *cred,
1010 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1012 LDAP_CONST char *who,
1013 LDAP_CONST char *passwd ));
1016 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1018 LDAP_CONST char *who,
1019 LDAP_CONST char *passwd ));
1024 * (deprecated - use SASL instead)
1027 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1029 LDAP_CONST char *who ));
1032 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1034 LDAP_CONST char *who ));
1037 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1039 LDAP_CONST char *who ));
1042 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1044 LDAP_CONST char *who ));
1047 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1049 LDAP_CONST char *who ));
1057 ldap_compare_ext LDAP_P((
1059 LDAP_CONST char *dn,
1060 LDAP_CONST char *attr,
1061 struct berval *bvalue,
1062 LDAPControl **serverctrls,
1063 LDAPControl **clientctrls,
1067 ldap_compare_ext_s LDAP_P((
1069 LDAP_CONST char *dn,
1070 LDAP_CONST char *attr,
1071 struct berval *bvalue,
1072 LDAPControl **serverctrls,
1073 LDAPControl **clientctrls ));
1077 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1079 LDAP_CONST char *dn,
1080 LDAP_CONST char *attr,
1081 LDAP_CONST char *value ));
1084 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1086 LDAP_CONST char *dn,
1087 LDAP_CONST char *attr,
1088 LDAP_CONST char *value ));
1096 ldap_delete_ext LDAP_P((
1098 LDAP_CONST char *dn,
1099 LDAPControl **serverctrls,
1100 LDAPControl **clientctrls,
1104 ldap_delete_ext_s LDAP_P((
1106 LDAP_CONST char *dn,
1107 LDAPControl **serverctrls,
1108 LDAPControl **clientctrls ));
1112 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1114 LDAP_CONST char *dn ));
1117 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1119 LDAP_CONST char *dn ));
1127 ldap_parse_result LDAP_P((
1134 LDAPControl ***serverctrls,
1138 ldap_err2string LDAP_P((
1143 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1149 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1151 LDAP_CONST char *s ));
1159 ldap_modify_ext LDAP_P((
1161 LDAP_CONST char *dn,
1163 LDAPControl **serverctrls,
1164 LDAPControl **clientctrls,
1168 ldap_modify_ext_s LDAP_P((
1170 LDAP_CONST char *dn,
1172 LDAPControl **serverctrls,
1173 LDAPControl **clientctrls ));
1177 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1179 LDAP_CONST char *dn,
1183 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1185 LDAP_CONST char *dn,
1194 ldap_rename LDAP_P((
1196 LDAP_CONST char *dn,
1197 LDAP_CONST char *newrdn,
1198 LDAP_CONST char *newSuperior,
1200 LDAPControl **sctrls,
1201 LDAPControl **cctrls,
1205 ldap_rename_s LDAP_P((
1207 LDAP_CONST char *dn,
1208 LDAP_CONST char *newrdn,
1209 LDAP_CONST char *newSuperior,
1211 LDAPControl **sctrls,
1212 LDAPControl **cctrls ));
1216 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1218 LDAP_CONST char *dn,
1219 LDAP_CONST char *newrdn,
1220 LDAP_CONST char *newSuperior,
1221 int deleteoldrdn ));
1224 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1226 LDAP_CONST char *dn,
1227 LDAP_CONST char *newrdn,
1228 LDAP_CONST char *newSuperior,
1229 int deleteoldrdn ));
1232 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1234 LDAP_CONST char *dn,
1235 LDAP_CONST char *newrdn ));
1238 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1240 LDAP_CONST char *dn,
1241 LDAP_CONST char *newrdn ));
1244 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1246 LDAP_CONST char *dn,
1247 LDAP_CONST char *newrdn,
1248 int deleteoldrdn ));
1251 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1253 LDAP_CONST char *dn,
1254 LDAP_CONST char *newrdn,
1264 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1265 LDAP_CONST char *host,
1269 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1270 LDAP_CONST char *host,
1275 ldap_create LDAP_P((
1279 ldap_initialize LDAP_P((
1281 LDAP_CONST char *url ));
1288 ldap_tls_inplace LDAP_P((
1292 ldap_start_tls LDAP_P((
1294 LDAPControl **serverctrls,
1295 LDAPControl **clientctrls,
1299 ldap_install_tls LDAP_P((
1303 ldap_start_tls_s LDAP_P((
1305 LDAPControl **serverctrls,
1306 LDAPControl **clientctrls ));
1311 LDAP_F( LDAPMessage * )
1312 ldap_first_message LDAP_P((
1314 LDAPMessage *chain ));
1316 LDAP_F( LDAPMessage * )
1317 ldap_next_message LDAP_P((
1319 LDAPMessage *msg ));
1322 ldap_count_messages LDAP_P((
1324 LDAPMessage *chain ));
1329 LDAP_F( LDAPMessage * )
1330 ldap_first_reference LDAP_P((
1332 LDAPMessage *chain ));
1334 LDAP_F( LDAPMessage * )
1335 ldap_next_reference LDAP_P((
1337 LDAPMessage *ref ));
1340 ldap_count_references LDAP_P((
1342 LDAPMessage *chain ));
1345 ldap_parse_reference LDAP_P((
1349 LDAPControl ***serverctrls,
1356 LDAP_F( LDAPMessage * )
1357 ldap_first_entry LDAP_P((
1359 LDAPMessage *chain ));
1361 LDAP_F( LDAPMessage * )
1362 ldap_next_entry LDAP_P((
1364 LDAPMessage *entry ));
1367 ldap_count_entries LDAP_P((
1369 LDAPMessage *chain ));
1372 ldap_get_entry_controls LDAP_P((
1375 LDAPControl ***serverctrls));
1381 LDAP_F( LDAPMessage * )
1382 ldap_delete_result_entry LDAP_P((
1387 ldap_add_result_entry LDAP_P((
1396 ldap_get_dn LDAP_P((
1398 LDAPMessage *entry ));
1400 typedef struct ldap_ava {
1401 struct berval la_attr;
1402 struct berval la_value;
1404 #define LDAP_AVA_NULL 0x0000U
1405 #define LDAP_AVA_STRING 0x0001U
1406 #define LDAP_AVA_BINARY 0x0002U
1407 #define LDAP_AVA_NONPRINTABLE 0x0004U
1408 #define LDAP_AVA_FREE_ATTR 0x0010U
1409 #define LDAP_AVA_FREE_VALUE 0x0020U
1414 typedef LDAPAVA** LDAPRDN;
1415 typedef LDAPRDN* LDAPDN;
1418 #define LDAP_DN_FORMAT_LDAP 0x0000U
1419 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1420 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1421 #define LDAP_DN_FORMAT_DCE 0x0030U
1422 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1423 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1424 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1425 #define LDAP_DN_FORMAT_MASK 0x00F0U
1428 #define LDAP_DN_PRETTY 0x0100U
1429 #define LDAP_DN_SKIP 0x0200U
1430 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1431 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1432 #define LDAP_DN_PEDANTIC 0xF000U
1434 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1435 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1444 ldap_str2dn LDAP_P((
1445 LDAP_CONST char *str,
1456 ldap_dn2str LDAP_P((
1462 ldap_bv2rdn LDAP_P((
1469 ldap_str2rdn LDAP_P((
1470 LDAP_CONST char *str,
1476 ldap_rdn2bv LDAP_P((
1482 ldap_rdn2str LDAP_P((
1488 ldap_dn_normalize LDAP_P((
1489 LDAP_CONST char *in, unsigned iflags,
1490 char **out, unsigned oflags ));
1493 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1494 LDAP_CONST char *dn ));
1497 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1498 LDAP_CONST char *dn,
1502 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1503 LDAP_CONST char *rdn,
1506 typedef int LDAPDN_rewrite_func
1507 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1510 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1511 LDAPDN_rewrite_func *func, unsigned flags ));
1514 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1515 LDAP_CONST char *dn ));
1518 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1519 LDAP_CONST char *dce ));
1522 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1523 LDAP_CONST char *dn ));
1526 ldap_get_dn_ber LDAP_P((
1527 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1530 ldap_get_attribute_ber LDAP_P((
1531 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1532 struct berval **vals ));
1538 ldap_first_attribute LDAP_P((
1541 BerElement **ber ));
1544 ldap_next_attribute LDAP_P((
1553 LDAP_F( struct berval ** )
1554 ldap_get_values_len LDAP_P((
1557 LDAP_CONST char *target ));
1560 ldap_count_values_len LDAP_P((
1561 struct berval **vals ));
1564 ldap_value_free_len LDAP_P((
1565 struct berval **vals ));
1569 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1572 LDAP_CONST char *target ));
1575 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1579 ldap_value_free LDAP_P(( /* deprecated, use ldap_values_free_len */
1587 ldap_result LDAP_P((
1591 struct timeval *timeout,
1592 LDAPMessage **result ));
1595 ldap_msgtype LDAP_P((
1603 ldap_msgfree LDAP_P((
1607 ldap_msgdelete LDAP_P((
1616 ldap_bv2escaped_filter_value LDAP_P((
1618 struct berval *out ));
1621 ldap_search_ext LDAP_P((
1623 LDAP_CONST char *base,
1625 LDAP_CONST char *filter,
1628 LDAPControl **serverctrls,
1629 LDAPControl **clientctrls,
1630 struct timeval *timeout,
1635 ldap_search_ext_s LDAP_P((
1637 LDAP_CONST char *base,
1639 LDAP_CONST char *filter,
1642 LDAPControl **serverctrls,
1643 LDAPControl **clientctrls,
1644 struct timeval *timeout,
1646 LDAPMessage **res ));
1650 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1652 LDAP_CONST char *base,
1654 LDAP_CONST char *filter,
1659 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1661 LDAP_CONST char *base,
1663 LDAP_CONST char *filter,
1666 LDAPMessage **res ));
1669 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1671 LDAP_CONST char *base,
1673 LDAP_CONST char *filter,
1676 struct timeval *timeout,
1677 LDAPMessage **res ));
1684 ldap_unbind_ext LDAP_P((
1686 LDAPControl **serverctrls,
1687 LDAPControl **clientctrls));
1690 ldap_unbind_ext_s LDAP_P((
1692 LDAPControl **serverctrls,
1693 LDAPControl **clientctrls));
1697 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1701 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1709 ldap_put_vrFilter LDAP_P((
1718 ldap_memalloc LDAP_P((
1722 ldap_memrealloc LDAP_P((
1727 ldap_memcalloc LDAP_P((
1732 ldap_memfree LDAP_P((
1736 ldap_memvfree LDAP_P((
1740 ldap_strdup LDAP_P((
1741 LDAP_CONST char * ));
1744 ldap_mods_free LDAP_P((
1751 * in sort.c (deprecated, use custom code instead)
1753 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1754 LDAP_CONST char *left,
1755 LDAP_CONST char *right ));
1757 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1758 LDAP_CONST void *left,
1759 LDAP_CONST void *right ));
1761 LDAP_F( int ) /* deprecated */
1762 ldap_sort_entries LDAP_P(( LDAP *ld,
1763 LDAPMessage **chain,
1764 LDAP_CONST char *attr,
1765 LDAP_SORT_AD_CMP_PROC *cmp ));
1767 LDAP_F( int ) /* deprecated */
1768 ldap_sort_values LDAP_P((
1771 LDAP_SORT_AV_CMP_PROC *cmp ));
1773 LDAP_F( int ) /* deprecated */
1774 ldap_sort_strcasecmp LDAP_P((
1776 LDAP_CONST void *b ));
1783 ldap_is_ldap_url LDAP_P((
1784 LDAP_CONST char *url ));
1787 ldap_is_ldaps_url LDAP_P((
1788 LDAP_CONST char *url ));
1791 ldap_is_ldapi_url LDAP_P((
1792 LDAP_CONST char *url ));
1795 ldap_url_parse LDAP_P((
1796 LDAP_CONST char *url,
1797 LDAPURLDesc **ludpp ));
1800 ldap_url_desc2str LDAP_P((
1801 LDAPURLDesc *ludp ));
1804 ldap_free_urldesc LDAP_P((
1805 LDAPURLDesc *ludp ));
1809 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1812 #define LDAP_API_FEATURE_CANCEL 1000
1815 ldap_cancel LDAP_P(( LDAP *ld,
1817 LDAPControl **sctrls,
1818 LDAPControl **cctrls,
1822 ldap_cancel_s LDAP_P(( LDAP *ld,
1824 LDAPControl **sctrl,
1825 LDAPControl **cctrl ));
1828 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1831 #define LDAP_API_FEATURE_TURN 1000
1834 ldap_turn LDAP_P(( LDAP *ld,
1836 LDAP_CONST char* identifier,
1837 LDAPControl **sctrls,
1838 LDAPControl **cctrls,
1842 ldap_turn_s LDAP_P(( LDAP *ld,
1844 LDAP_CONST char* identifier,
1845 LDAPControl **sctrl,
1846 LDAPControl **cctrl ));
1849 * LDAP Paged Results
1852 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1855 ldap_create_page_control_value LDAP_P((
1858 struct berval *cookie,
1859 struct berval *value ));
1862 ldap_create_page_control LDAP_P((
1865 struct berval *cookie,
1867 LDAPControl **ctrlp ));
1871 ldap_parse_page_control LDAP_P((
1872 /* deprecated, use ldap_parse_pageresponse_control */
1874 LDAPControl **ctrls,
1876 struct berval **cookie ));
1880 ldap_parse_pageresponse_control LDAP_P((
1884 struct berval *cookie ));
1887 * LDAP Server Side Sort
1890 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1892 /* structure for a sort-key */
1893 typedef struct ldapsortkey {
1894 char *attributeType;
1900 ldap_create_sort_keylist LDAP_P((
1901 LDAPSortKey ***sortKeyList,
1905 ldap_free_sort_keylist LDAP_P((
1906 LDAPSortKey **sortkeylist ));
1909 ldap_create_sort_control_value LDAP_P((
1911 LDAPSortKey **keyList,
1912 struct berval *value ));
1915 ldap_create_sort_control LDAP_P((
1917 LDAPSortKey **keyList,
1919 LDAPControl **ctrlp ));
1922 ldap_parse_sortresponse_control LDAP_P((
1926 char **attribute ));
1929 * LDAP Virtual List View
1932 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1934 /* structure for virtual list */
1935 typedef struct ldapvlvinfo {
1936 ber_int_t ldvlv_version;
1937 ber_int_t ldvlv_before_count;
1938 ber_int_t ldvlv_after_count;
1939 ber_int_t ldvlv_offset;
1940 ber_int_t ldvlv_count;
1941 struct berval * ldvlv_attrvalue;
1942 struct berval * ldvlv_context;
1943 void * ldvlv_extradata;
1947 ldap_create_vlv_control_value LDAP_P((
1949 LDAPVLVInfo *ldvlistp,
1950 struct berval *value));
1953 ldap_create_vlv_control LDAP_P((
1955 LDAPVLVInfo *ldvlistp,
1956 LDAPControl **ctrlp ));
1959 ldap_parse_vlvresponse_control LDAP_P((
1962 ber_int_t *target_posp,
1963 ber_int_t *list_countp,
1964 struct berval **contextp,
1971 #define LDAP_API_FEATURE_WHOAMI 1000
1974 ldap_parse_whoami LDAP_P((
1977 struct berval **authzid ));
1980 ldap_whoami LDAP_P(( LDAP *ld,
1981 LDAPControl **sctrls,
1982 LDAPControl **cctrls,
1986 ldap_whoami_s LDAP_P((
1988 struct berval **authzid,
1989 LDAPControl **sctrls,
1990 LDAPControl **cctrls ));
1993 * LDAP Password Modify
1996 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1999 ldap_parse_passwd LDAP_P((
2002 struct berval *newpasswd ));
2005 ldap_passwd LDAP_P(( LDAP *ld,
2006 struct berval *user,
2007 struct berval *oldpw,
2008 struct berval *newpw,
2009 LDAPControl **sctrls,
2010 LDAPControl **cctrls,
2014 ldap_passwd_s LDAP_P((
2016 struct berval *user,
2017 struct berval *oldpw,
2018 struct berval *newpw,
2019 struct berval *newpasswd,
2020 LDAPControl **sctrls,
2021 LDAPControl **cctrls ));
2023 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2025 * LDAP Password Policy controls
2028 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2030 typedef enum passpolicyerror_enum {
2031 PP_passwordExpired = 0,
2032 PP_accountLocked = 1,
2033 PP_changeAfterReset = 2,
2034 PP_passwordModNotAllowed = 3,
2035 PP_mustSupplyOldPassword = 4,
2036 PP_insufficientPasswordQuality = 5,
2037 PP_passwordTooShort = 6,
2038 PP_passwordTooYoung = 7,
2039 PP_passwordInHistory = 8,
2041 } LDAPPasswordPolicyError;
2044 ldap_create_passwordpolicy_control LDAP_P((
2046 LDAPControl **ctrlp ));
2049 ldap_parse_passwordpolicy_control LDAP_P((
2054 LDAPPasswordPolicyError *errorp ));
2056 LDAP_F( const char * )
2057 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2058 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2061 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2064 #define LDAP_API_FEATURE_REFRESH 1000
2067 ldap_parse_refresh LDAP_P((
2070 ber_int_t *newttl ));
2073 ldap_refresh LDAP_P(( LDAP *ld,
2076 LDAPControl **sctrls,
2077 LDAPControl **cctrls,
2081 ldap_refresh_s LDAP_P((
2086 LDAPControl **sctrls,
2087 LDAPControl **cctrls ));
2094 ldap_txn_start LDAP_P(( LDAP *ld,
2095 LDAPControl **sctrls,
2096 LDAPControl **cctrls,
2100 ldap_txn_start_s LDAP_P(( LDAP *ld,
2101 LDAPControl **sctrl,
2102 LDAPControl **cctrl,
2103 struct berval **rettxnid ));
2106 ldap_txn_end LDAP_P(( LDAP *ld,
2108 struct berval *txnid,
2109 LDAPControl **sctrls,
2110 LDAPControl **cctrls,
2114 ldap_txn_end_s LDAP_P(( LDAP *ld,
2116 struct berval *txnid,
2117 LDAPControl **sctrl,
2118 LDAPControl **cctrl,
2123 #endif /* _LDAP_H */