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_MANAGEDIT "1.3.6.1.4.1.4203.666.5.12"
266 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
267 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
268 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
271 /* LDAP Chaining Behavior Control *//* work in progress */
272 /* <draft-sermersheim-ldap-chaining>;
273 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
274 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
276 #define LDAP_CHAINING_PREFERRED 0
277 #define LDAP_CHAINING_REQUIRED 1
278 #define LDAP_REFERRALS_PREFERRED 2
279 #define LDAP_REFERRALS_REQUIRED 3
281 /* MS Active Directory controls (for compatibility) */
282 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
283 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
284 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
285 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
286 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
287 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
289 /* MS Active Directory controls - not implemented in slapd(8) */
290 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
291 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
293 /* various expired works */
294 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
295 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
296 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
297 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
298 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
300 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
301 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
302 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
303 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
304 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
305 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
306 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
308 /* LDAP VLV *//* not implemented in slapd(8) */
309 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
310 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
313 /* LDAP Unsolicited Notifications */
314 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
315 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
317 /* LDAP Extended Operations */
318 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
320 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
321 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
322 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
323 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
324 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
326 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
327 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
329 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
330 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
331 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
332 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
334 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
335 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
337 /* various works in progress */
338 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
339 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
341 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
342 /* a work in progress */
343 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
344 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
345 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
346 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
347 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
348 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
349 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
350 LDAP_X_DISTPROC_BASE ".6"
351 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
352 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
353 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
354 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
355 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
358 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
359 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
360 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
361 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
362 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
366 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
367 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
368 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
369 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
370 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
371 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
372 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
374 /* LDAP Experimental (works in progress) Features */
375 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
376 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
377 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
380 * specific LDAP instantiations of BER types we know about
383 /* Overview of LBER tag construction
390 * 1 0 = CONTEXT-SPECIFIC
397 * | 5 ... 1 | TAG-NUMBER
401 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
402 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
404 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
405 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
407 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
408 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
410 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
412 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
413 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
414 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
415 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
417 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
418 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
420 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
422 /* LDAP Request Messages */
423 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
424 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
425 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
426 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
427 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
428 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
429 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
430 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
431 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
432 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
433 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
434 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
436 /* LDAP Response Messages */
437 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
438 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
439 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
440 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
441 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
442 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
443 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
444 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
445 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
446 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
447 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
448 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
449 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
451 #define LDAP_RES_ANY (-1)
452 #define LDAP_RES_UNSOLICITED (0)
456 #define LDAP_SASL_SIMPLE ((char*)0)
457 #define LDAP_SASL_NULL ("")
460 /* authentication methods available */
461 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
462 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
463 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
464 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
465 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
466 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
470 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
471 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
472 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
473 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
474 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
475 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
476 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
477 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
478 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
479 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
481 /* extended filter component types */
482 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
483 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
484 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
485 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
487 /* substring filter component types */
488 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
489 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
490 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
493 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
494 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
495 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
496 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
497 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
498 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
499 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
500 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
501 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
503 /* substring filter component types */
504 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
505 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
506 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
511 #define LDAP_SUCCESS 0x00
513 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
515 #define LDAP_OPERATIONS_ERROR 0x01
516 #define LDAP_PROTOCOL_ERROR 0x02
517 #define LDAP_TIMELIMIT_EXCEEDED 0x03
518 #define LDAP_SIZELIMIT_EXCEEDED 0x04
519 #define LDAP_COMPARE_FALSE 0x05
520 #define LDAP_COMPARE_TRUE 0x06
521 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
522 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
523 #define LDAP_STRONG_AUTH_REQUIRED 0x08
524 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
525 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
527 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
528 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
529 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
530 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
531 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
533 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
535 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
536 #define LDAP_UNDEFINED_TYPE 0x11
537 #define LDAP_INAPPROPRIATE_MATCHING 0x12
538 #define LDAP_CONSTRAINT_VIOLATION 0x13
539 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
540 #define LDAP_INVALID_SYNTAX 0x15
542 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
544 #define LDAP_NO_SUCH_OBJECT 0x20
545 #define LDAP_ALIAS_PROBLEM 0x21
546 #define LDAP_INVALID_DN_SYNTAX 0x22
547 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
548 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
550 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
552 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
553 #define LDAP_INAPPROPRIATE_AUTH 0x30
554 #define LDAP_INVALID_CREDENTIALS 0x31
555 #define LDAP_INSUFFICIENT_ACCESS 0x32
557 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
559 #define LDAP_BUSY 0x33
560 #define LDAP_UNAVAILABLE 0x34
561 #define LDAP_UNWILLING_TO_PERFORM 0x35
562 #define LDAP_LOOP_DETECT 0x36
564 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
566 #define LDAP_NAMING_VIOLATION 0x40
567 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
568 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
569 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
570 #define LDAP_ALREADY_EXISTS 0x44
571 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
572 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
573 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
575 #define LDAP_OTHER 0x50
577 /* LCUP operation codes (113-117) - not implemented */
578 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
579 #define LDAP_CUP_SECURITY_VIOLATION 0x72
580 #define LDAP_CUP_INVALID_DATA 0x73
581 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
582 #define LDAP_CUP_RELOAD_REQUIRED 0x75
584 /* Cancel operation codes (118-121) */
585 #define LDAP_CANCELLED 0x76
586 #define LDAP_NO_SUCH_OPERATION 0x77
587 #define LDAP_TOO_LATE 0x78
588 #define LDAP_CANNOT_CANCEL 0x79
590 /* Assertion control (122) */
591 #define LDAP_ASSERTION_FAILED 0x7A
593 /* Proxied Authorization Denied (123) */
594 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
596 /* Experimental result codes */
597 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
599 /* LDAP Sync (4096) */
600 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
603 /* Private Use result codes */
604 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
606 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
607 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
609 /* for the LDAP No-Op control */
610 #define LDAP_X_NO_OPERATION 0x410e
612 /* for the Chaining Behavior control (consecutive result codes requested;
613 * see <draft-sermersheim-ldap-chaining> ) */
614 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
615 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
616 #define LDAP_X_CANNOT_CHAIN 0x4111
619 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
620 #ifdef LDAP_X_DISTPROC_BASE
621 #define LDAP_X_INVALIDREFERENCE 0x4112
625 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
626 #define LDAP_X_TXN_ID_INVALID 0x4121
631 * Based on draft-ietf-ldap-c-api-xx
632 * but with new negative code values
634 #define LDAP_API_ERROR(n) ((n)<0)
635 #define LDAP_API_RESULT(n) ((n)<=0)
637 #define LDAP_SERVER_DOWN (-1)
638 #define LDAP_LOCAL_ERROR (-2)
639 #define LDAP_ENCODING_ERROR (-3)
640 #define LDAP_DECODING_ERROR (-4)
641 #define LDAP_TIMEOUT (-5)
642 #define LDAP_AUTH_UNKNOWN (-6)
643 #define LDAP_FILTER_ERROR (-7)
644 #define LDAP_USER_CANCELLED (-8)
645 #define LDAP_PARAM_ERROR (-9)
646 #define LDAP_NO_MEMORY (-10)
647 #define LDAP_CONNECT_ERROR (-11)
648 #define LDAP_NOT_SUPPORTED (-12)
649 #define LDAP_CONTROL_NOT_FOUND (-13)
650 #define LDAP_NO_RESULTS_RETURNED (-14)
651 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
652 #define LDAP_CLIENT_LOOP (-16)
653 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
657 * This structure represents both ldap messages and ldap responses.
658 * These are really the same, except in the case of search responses,
659 * where a response has multiple messages.
662 typedef struct ldapmsg LDAPMessage;
664 /* for modifications */
665 typedef struct ldapmod {
668 #define LDAP_MOD_OP (0x0007)
669 #define LDAP_MOD_ADD (0x0000)
670 #define LDAP_MOD_DELETE (0x0001)
671 #define LDAP_MOD_REPLACE (0x0002)
672 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
673 #define LDAP_MOD_BVALUES (0x0080)
674 /* IMPORTANT: do not use code 0x1000 (or above),
675 * it is used internally by the backends!
676 * (see ldap/servers/slapd/slap.h)
682 struct berval **modv_bvals;
684 #define mod_values mod_vals.modv_strvals
685 #define mod_bvalues mod_vals.modv_bvals
689 * structure representing an ldap session which can
690 * encompass connections to multiple servers (in the
691 * face of referrals).
693 typedef struct ldap LDAP;
695 #define LDAP_DEREF_NEVER 0x00
696 #define LDAP_DEREF_SEARCHING 0x01
697 #define LDAP_DEREF_FINDING 0x02
698 #define LDAP_DEREF_ALWAYS 0x03
700 #define LDAP_NO_LIMIT 0
702 /* how many messages to retrieve results for */
703 #define LDAP_MSG_ONE 0x00
704 #define LDAP_MSG_ALL 0x01
705 #define LDAP_MSG_RECEIVED 0x02
708 * types for ldap URL handling
710 typedef struct ldap_url_desc {
711 struct ldap_url_desc *lud_next;
723 #define LDAP_URL_SUCCESS 0x00 /* Success */
724 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
725 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
727 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
728 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
729 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
730 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
731 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
732 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
733 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
734 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
737 * The API draft spec says we should declare (or cause to be declared)
738 * 'struct timeval'. We don't. See IETF LDAPext discussions.
746 ldap_get_option LDAP_P((
752 ldap_set_option LDAP_P((
755 LDAP_CONST void *invalue));
757 /* V3 REBIND Function Callback Prototype */
758 typedef int (LDAP_REBIND_PROC) LDAP_P((
759 LDAP *ld, LDAP_CONST char *url,
760 ber_tag_t request, ber_int_t msgid,
764 ldap_set_rebind_proc LDAP_P((
766 LDAP_REBIND_PROC *rebind_proc,
769 /* V3 referral selection Function Callback Prototype */
770 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
771 LDAP *ld, char ***refsp, int *cntp,
775 ldap_set_nextref_proc LDAP_P((
777 LDAP_NEXTREF_PROC *nextref_proc,
780 /* V3 URLLIST Function Callback Prototype */
781 typedef int (LDAP_URLLIST_PROC) LDAP_P((
783 LDAPURLDesc **urllist,
788 ldap_set_urllist_proc LDAP_P((
790 LDAP_URLLIST_PROC *urllist_proc,
797 ldap_create_control LDAP_P((
798 LDAP_CONST char *requestOID,
801 LDAPControl **ctrlp ));
803 LDAP_F( LDAPControl * )
804 ldap_find_control LDAP_P((
805 LDAP_CONST char *oid,
806 LDAPControl **ctrls ));
809 ldap_control_free LDAP_P((
810 LDAPControl *ctrl ));
813 ldap_controls_free LDAP_P((
814 LDAPControl **ctrls ));
820 ldap_domain2dn LDAP_P((
821 LDAP_CONST char* domain,
825 ldap_dn2domain LDAP_P((
830 ldap_domain2hostlist LDAP_P((
831 LDAP_CONST char *domain,
838 ldap_extended_operation LDAP_P((
840 LDAP_CONST char *reqoid,
841 struct berval *reqdata,
842 LDAPControl **serverctrls,
843 LDAPControl **clientctrls,
847 ldap_extended_operation_s LDAP_P((
849 LDAP_CONST char *reqoid,
850 struct berval *reqdata,
851 LDAPControl **serverctrls,
852 LDAPControl **clientctrls,
854 struct berval **retdatap ));
857 ldap_parse_extended_result LDAP_P((
861 struct berval **retdatap,
865 ldap_parse_intermediate LDAP_P((
869 struct berval **retdatap,
870 LDAPControl ***serverctrls,
878 ldap_abandon_ext LDAP_P((
881 LDAPControl **serverctrls,
882 LDAPControl **clientctrls ));
886 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
895 ldap_add_ext LDAP_P((
899 LDAPControl **serverctrls,
900 LDAPControl **clientctrls,
904 ldap_add_ext_s LDAP_P((
908 LDAPControl **serverctrls,
909 LDAPControl **clientctrls ));
913 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
919 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
930 ldap_sasl_bind LDAP_P((
933 LDAP_CONST char *mechanism,
935 LDAPControl **serverctrls,
936 LDAPControl **clientctrls,
939 /* Interaction flags (should be passed about in a control)
940 * Automatic (default): use defaults, prompt otherwise
941 * Interactive: prompt always
942 * Quiet: never prompt
944 #define LDAP_SASL_AUTOMATIC 0U
945 #define LDAP_SASL_INTERACTIVE 1U
946 #define LDAP_SASL_QUIET 2U
949 * V3 SASL Interaction Function Callback Prototype
950 * when using Cyrus SASL, interact is pointer to sasl_interact_t
951 * should likely passed in a control (and provided controls)
953 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
954 LDAP *ld, unsigned flags, void* defaults, void *interact ));
957 ldap_sasl_interactive_bind_s LDAP_P((
959 LDAP_CONST char *dn, /* usually NULL */
960 LDAP_CONST char *saslMechanism,
961 LDAPControl **serverControls,
962 LDAPControl **clientControls,
964 /* should be client controls */
966 LDAP_SASL_INTERACT_PROC *proc,
970 ldap_sasl_bind_s LDAP_P((
973 LDAP_CONST char *mechanism,
975 LDAPControl **serverctrls,
976 LDAPControl **clientctrls,
977 struct berval **servercredp ));
980 ldap_parse_sasl_bind_result LDAP_P((
983 struct berval **servercredp,
992 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
994 LDAP_CONST char *who,
995 LDAP_CONST char *passwd,
999 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1001 LDAP_CONST char *who,
1002 LDAP_CONST char *cred,
1009 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1011 LDAP_CONST char *who,
1012 LDAP_CONST char *passwd ));
1015 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1017 LDAP_CONST char *who,
1018 LDAP_CONST char *passwd ));
1023 * (deprecated - use SASL instead)
1026 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1028 LDAP_CONST char *who ));
1031 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1033 LDAP_CONST char *who ));
1036 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1038 LDAP_CONST char *who ));
1041 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1043 LDAP_CONST char *who ));
1046 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1048 LDAP_CONST char *who ));
1056 ldap_compare_ext LDAP_P((
1058 LDAP_CONST char *dn,
1059 LDAP_CONST char *attr,
1060 struct berval *bvalue,
1061 LDAPControl **serverctrls,
1062 LDAPControl **clientctrls,
1066 ldap_compare_ext_s LDAP_P((
1068 LDAP_CONST char *dn,
1069 LDAP_CONST char *attr,
1070 struct berval *bvalue,
1071 LDAPControl **serverctrls,
1072 LDAPControl **clientctrls ));
1076 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1078 LDAP_CONST char *dn,
1079 LDAP_CONST char *attr,
1080 LDAP_CONST char *value ));
1083 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1085 LDAP_CONST char *dn,
1086 LDAP_CONST char *attr,
1087 LDAP_CONST char *value ));
1095 ldap_delete_ext LDAP_P((
1097 LDAP_CONST char *dn,
1098 LDAPControl **serverctrls,
1099 LDAPControl **clientctrls,
1103 ldap_delete_ext_s LDAP_P((
1105 LDAP_CONST char *dn,
1106 LDAPControl **serverctrls,
1107 LDAPControl **clientctrls ));
1111 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1113 LDAP_CONST char *dn ));
1116 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1118 LDAP_CONST char *dn ));
1126 ldap_parse_result LDAP_P((
1133 LDAPControl ***serverctrls,
1137 ldap_err2string LDAP_P((
1142 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1148 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1150 LDAP_CONST char *s ));
1158 ldap_modify_ext LDAP_P((
1160 LDAP_CONST char *dn,
1162 LDAPControl **serverctrls,
1163 LDAPControl **clientctrls,
1167 ldap_modify_ext_s LDAP_P((
1169 LDAP_CONST char *dn,
1171 LDAPControl **serverctrls,
1172 LDAPControl **clientctrls ));
1176 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1178 LDAP_CONST char *dn,
1182 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1184 LDAP_CONST char *dn,
1193 ldap_rename LDAP_P((
1195 LDAP_CONST char *dn,
1196 LDAP_CONST char *newrdn,
1197 LDAP_CONST char *newSuperior,
1199 LDAPControl **sctrls,
1200 LDAPControl **cctrls,
1204 ldap_rename_s LDAP_P((
1206 LDAP_CONST char *dn,
1207 LDAP_CONST char *newrdn,
1208 LDAP_CONST char *newSuperior,
1210 LDAPControl **sctrls,
1211 LDAPControl **cctrls ));
1215 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1217 LDAP_CONST char *dn,
1218 LDAP_CONST char *newrdn,
1219 LDAP_CONST char *newSuperior,
1220 int deleteoldrdn ));
1223 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1225 LDAP_CONST char *dn,
1226 LDAP_CONST char *newrdn,
1227 LDAP_CONST char *newSuperior,
1228 int deleteoldrdn ));
1231 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1233 LDAP_CONST char *dn,
1234 LDAP_CONST char *newrdn ));
1237 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1239 LDAP_CONST char *dn,
1240 LDAP_CONST char *newrdn ));
1243 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1245 LDAP_CONST char *dn,
1246 LDAP_CONST char *newrdn,
1247 int deleteoldrdn ));
1250 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1252 LDAP_CONST char *dn,
1253 LDAP_CONST char *newrdn,
1263 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1264 LDAP_CONST char *host,
1268 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1269 LDAP_CONST char *host,
1274 ldap_create LDAP_P((
1278 ldap_initialize LDAP_P((
1280 LDAP_CONST char *url ));
1287 ldap_tls_inplace LDAP_P((
1291 ldap_start_tls LDAP_P((
1293 LDAPControl **serverctrls,
1294 LDAPControl **clientctrls,
1298 ldap_install_tls LDAP_P((
1302 ldap_start_tls_s LDAP_P((
1304 LDAPControl **serverctrls,
1305 LDAPControl **clientctrls ));
1310 LDAP_F( LDAPMessage * )
1311 ldap_first_message LDAP_P((
1313 LDAPMessage *chain ));
1315 LDAP_F( LDAPMessage * )
1316 ldap_next_message LDAP_P((
1318 LDAPMessage *msg ));
1321 ldap_count_messages LDAP_P((
1323 LDAPMessage *chain ));
1328 LDAP_F( LDAPMessage * )
1329 ldap_first_reference LDAP_P((
1331 LDAPMessage *chain ));
1333 LDAP_F( LDAPMessage * )
1334 ldap_next_reference LDAP_P((
1336 LDAPMessage *ref ));
1339 ldap_count_references LDAP_P((
1341 LDAPMessage *chain ));
1344 ldap_parse_reference LDAP_P((
1348 LDAPControl ***serverctrls,
1355 LDAP_F( LDAPMessage * )
1356 ldap_first_entry LDAP_P((
1358 LDAPMessage *chain ));
1360 LDAP_F( LDAPMessage * )
1361 ldap_next_entry LDAP_P((
1363 LDAPMessage *entry ));
1366 ldap_count_entries LDAP_P((
1368 LDAPMessage *chain ));
1371 ldap_get_entry_controls LDAP_P((
1374 LDAPControl ***serverctrls));
1380 LDAP_F( LDAPMessage * )
1381 ldap_delete_result_entry LDAP_P((
1386 ldap_add_result_entry LDAP_P((
1395 ldap_get_dn LDAP_P((
1397 LDAPMessage *entry ));
1399 typedef struct ldap_ava {
1400 struct berval la_attr;
1401 struct berval la_value;
1403 #define LDAP_AVA_NULL 0x0000U
1404 #define LDAP_AVA_STRING 0x0001U
1405 #define LDAP_AVA_BINARY 0x0002U
1406 #define LDAP_AVA_NONPRINTABLE 0x0004U
1407 #define LDAP_AVA_FREE_ATTR 0x0010U
1408 #define LDAP_AVA_FREE_VALUE 0x0020U
1413 typedef LDAPAVA** LDAPRDN;
1414 typedef LDAPRDN* LDAPDN;
1417 #define LDAP_DN_FORMAT_LDAP 0x0000U
1418 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1419 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1420 #define LDAP_DN_FORMAT_DCE 0x0030U
1421 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1422 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1423 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1424 #define LDAP_DN_FORMAT_MASK 0x00F0U
1427 #define LDAP_DN_PRETTY 0x0100U
1428 #define LDAP_DN_SKIP 0x0200U
1429 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1430 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1431 #define LDAP_DN_PEDANTIC 0xF000U
1433 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1434 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1443 ldap_str2dn LDAP_P((
1444 LDAP_CONST char *str,
1455 ldap_dn2str LDAP_P((
1461 ldap_bv2rdn LDAP_P((
1468 ldap_str2rdn LDAP_P((
1469 LDAP_CONST char *str,
1475 ldap_rdn2bv LDAP_P((
1481 ldap_rdn2str LDAP_P((
1487 ldap_dn_normalize LDAP_P((
1488 LDAP_CONST char *in, unsigned iflags,
1489 char **out, unsigned oflags ));
1492 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1493 LDAP_CONST char *dn ));
1496 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1497 LDAP_CONST char *dn,
1501 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1502 LDAP_CONST char *rdn,
1505 typedef int LDAPDN_rewrite_func
1506 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1509 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1510 LDAPDN_rewrite_func *func, unsigned flags ));
1513 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1514 LDAP_CONST char *dn ));
1517 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1518 LDAP_CONST char *dce ));
1521 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1522 LDAP_CONST char *dn ));
1525 ldap_get_dn_ber LDAP_P((
1526 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1529 ldap_get_attribute_ber LDAP_P((
1530 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1531 struct berval **vals ));
1537 ldap_first_attribute LDAP_P((
1540 BerElement **ber ));
1543 ldap_next_attribute LDAP_P((
1552 LDAP_F( struct berval ** )
1553 ldap_get_values_len LDAP_P((
1556 LDAP_CONST char *target ));
1559 ldap_count_values_len LDAP_P((
1560 struct berval **vals ));
1563 ldap_value_free_len LDAP_P((
1564 struct berval **vals ));
1568 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1571 LDAP_CONST char *target ));
1574 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1578 ldap_value_free LDAP_P(( /* deprecated, use ldap_values_free_len */
1586 ldap_result LDAP_P((
1590 struct timeval *timeout,
1591 LDAPMessage **result ));
1594 ldap_msgtype LDAP_P((
1602 ldap_msgfree LDAP_P((
1606 ldap_msgdelete LDAP_P((
1615 ldap_bv2escaped_filter_value LDAP_P((
1617 struct berval *out ));
1620 ldap_search_ext LDAP_P((
1622 LDAP_CONST char *base,
1624 LDAP_CONST char *filter,
1627 LDAPControl **serverctrls,
1628 LDAPControl **clientctrls,
1629 struct timeval *timeout,
1634 ldap_search_ext_s LDAP_P((
1636 LDAP_CONST char *base,
1638 LDAP_CONST char *filter,
1641 LDAPControl **serverctrls,
1642 LDAPControl **clientctrls,
1643 struct timeval *timeout,
1645 LDAPMessage **res ));
1649 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1651 LDAP_CONST char *base,
1653 LDAP_CONST char *filter,
1658 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1660 LDAP_CONST char *base,
1662 LDAP_CONST char *filter,
1665 LDAPMessage **res ));
1668 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1670 LDAP_CONST char *base,
1672 LDAP_CONST char *filter,
1675 struct timeval *timeout,
1676 LDAPMessage **res ));
1683 ldap_unbind_ext LDAP_P((
1685 LDAPControl **serverctrls,
1686 LDAPControl **clientctrls));
1689 ldap_unbind_ext_s LDAP_P((
1691 LDAPControl **serverctrls,
1692 LDAPControl **clientctrls));
1696 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1700 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1708 ldap_put_vrFilter LDAP_P((
1717 ldap_memalloc LDAP_P((
1721 ldap_memrealloc LDAP_P((
1726 ldap_memcalloc LDAP_P((
1731 ldap_memfree LDAP_P((
1735 ldap_memvfree LDAP_P((
1739 ldap_strdup LDAP_P((
1740 LDAP_CONST char * ));
1743 ldap_mods_free LDAP_P((
1750 * in sort.c (deprecated, use custom code instead)
1752 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1753 LDAP_CONST char *left,
1754 LDAP_CONST char *right ));
1756 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1757 LDAP_CONST void *left,
1758 LDAP_CONST void *right ));
1760 LDAP_F( int ) /* deprecated */
1761 ldap_sort_entries LDAP_P(( LDAP *ld,
1762 LDAPMessage **chain,
1763 LDAP_CONST char *attr,
1764 LDAP_SORT_AD_CMP_PROC *cmp ));
1766 LDAP_F( int ) /* deprecated */
1767 ldap_sort_values LDAP_P((
1770 LDAP_SORT_AV_CMP_PROC *cmp ));
1772 LDAP_F( int ) /* deprecated */
1773 ldap_sort_strcasecmp LDAP_P((
1775 LDAP_CONST void *b ));
1782 ldap_is_ldap_url LDAP_P((
1783 LDAP_CONST char *url ));
1786 ldap_is_ldaps_url LDAP_P((
1787 LDAP_CONST char *url ));
1790 ldap_is_ldapi_url LDAP_P((
1791 LDAP_CONST char *url ));
1794 ldap_url_parse LDAP_P((
1795 LDAP_CONST char *url,
1796 LDAPURLDesc **ludpp ));
1799 ldap_url_desc2str LDAP_P((
1800 LDAPURLDesc *ludp ));
1803 ldap_free_urldesc LDAP_P((
1804 LDAPURLDesc *ludp ));
1808 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1811 #define LDAP_API_FEATURE_CANCEL 1000
1814 ldap_cancel LDAP_P(( LDAP *ld,
1816 LDAPControl **sctrls,
1817 LDAPControl **cctrls,
1821 ldap_cancel_s LDAP_P(( LDAP *ld,
1823 LDAPControl **sctrl,
1824 LDAPControl **cctrl ));
1827 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1830 #define LDAP_API_FEATURE_TURN 1000
1833 ldap_turn LDAP_P(( LDAP *ld,
1835 LDAP_CONST char* identifier,
1836 LDAPControl **sctrls,
1837 LDAPControl **cctrls,
1841 ldap_turn_s LDAP_P(( LDAP *ld,
1843 LDAP_CONST char* identifier,
1844 LDAPControl **sctrl,
1845 LDAPControl **cctrl ));
1848 * LDAP Paged Results
1851 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1854 ldap_create_page_control_value LDAP_P((
1857 struct berval *cookie,
1858 struct berval *value ));
1861 ldap_create_page_control LDAP_P((
1864 struct berval *cookie,
1866 LDAPControl **ctrlp ));
1870 ldap_parse_page_control LDAP_P((
1871 /* deprecated, use ldap_parse_pageresponse_control */
1873 LDAPControl **ctrls,
1875 struct berval **cookie ));
1879 ldap_parse_pageresponse_control LDAP_P((
1883 struct berval *cookie ));
1886 * LDAP Server Side Sort
1889 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1891 /* structure for a sort-key */
1892 typedef struct ldapsortkey {
1893 char *attributeType;
1899 ldap_create_sort_keylist LDAP_P((
1900 LDAPSortKey ***sortKeyList,
1904 ldap_free_sort_keylist LDAP_P((
1905 LDAPSortKey **sortkeylist ));
1908 ldap_create_sort_control_value LDAP_P((
1910 LDAPSortKey **keyList,
1911 struct berval *value ));
1914 ldap_create_sort_control LDAP_P((
1916 LDAPSortKey **keyList,
1918 LDAPControl **ctrlp ));
1921 ldap_parse_sortresponse_control LDAP_P((
1925 char **attribute ));
1928 * LDAP Virtual List View
1931 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1933 /* structure for virtual list */
1934 typedef struct ldapvlvinfo {
1935 ber_int_t ldvlv_version;
1936 ber_int_t ldvlv_before_count;
1937 ber_int_t ldvlv_after_count;
1938 ber_int_t ldvlv_offset;
1939 ber_int_t ldvlv_count;
1940 struct berval * ldvlv_attrvalue;
1941 struct berval * ldvlv_context;
1942 void * ldvlv_extradata;
1946 ldap_create_vlv_control_value LDAP_P((
1948 LDAPVLVInfo *ldvlistp,
1949 struct berval *value));
1952 ldap_create_vlv_control LDAP_P((
1954 LDAPVLVInfo *ldvlistp,
1955 LDAPControl **ctrlp ));
1958 ldap_parse_vlvresponse_control LDAP_P((
1961 ber_int_t *target_posp,
1962 ber_int_t *list_countp,
1963 struct berval **contextp,
1970 #define LDAP_API_FEATURE_WHOAMI 1000
1973 ldap_parse_whoami LDAP_P((
1976 struct berval **authzid ));
1979 ldap_whoami LDAP_P(( LDAP *ld,
1980 LDAPControl **sctrls,
1981 LDAPControl **cctrls,
1985 ldap_whoami_s LDAP_P((
1987 struct berval **authzid,
1988 LDAPControl **sctrls,
1989 LDAPControl **cctrls ));
1992 * LDAP Password Modify
1995 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1998 ldap_parse_passwd LDAP_P((
2001 struct berval *newpasswd ));
2004 ldap_passwd LDAP_P(( LDAP *ld,
2005 struct berval *user,
2006 struct berval *oldpw,
2007 struct berval *newpw,
2008 LDAPControl **sctrls,
2009 LDAPControl **cctrls,
2013 ldap_passwd_s LDAP_P((
2015 struct berval *user,
2016 struct berval *oldpw,
2017 struct berval *newpw,
2018 struct berval *newpasswd,
2019 LDAPControl **sctrls,
2020 LDAPControl **cctrls ));
2022 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2024 * LDAP Password Policy controls
2027 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2029 typedef enum passpolicyerror_enum {
2030 PP_passwordExpired = 0,
2031 PP_accountLocked = 1,
2032 PP_changeAfterReset = 2,
2033 PP_passwordModNotAllowed = 3,
2034 PP_mustSupplyOldPassword = 4,
2035 PP_insufficientPasswordQuality = 5,
2036 PP_passwordTooShort = 6,
2037 PP_passwordTooYoung = 7,
2038 PP_passwordInHistory = 8,
2040 } LDAPPasswordPolicyError;
2043 ldap_create_passwordpolicy_control LDAP_P((
2045 LDAPControl **ctrlp ));
2048 ldap_parse_passwordpolicy_control LDAP_P((
2053 LDAPPasswordPolicyError *errorp ));
2055 LDAP_F( const char * )
2056 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2057 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2060 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2063 #define LDAP_API_FEATURE_REFRESH 1000
2066 ldap_parse_refresh LDAP_P((
2069 ber_int_t *newttl ));
2072 ldap_refresh LDAP_P(( LDAP *ld,
2075 LDAPControl **sctrls,
2076 LDAPControl **cctrls,
2080 ldap_refresh_s LDAP_P((
2085 LDAPControl **sctrls,
2086 LDAPControl **cctrls ));
2093 ldap_txn_start LDAP_P(( LDAP *ld,
2094 LDAPControl **sctrls,
2095 LDAPControl **cctrls,
2099 ldap_txn_start_s LDAP_P(( LDAP *ld,
2100 LDAPControl **sctrl,
2101 LDAPControl **cctrl,
2102 struct berval **rettxnid ));
2105 ldap_txn_end LDAP_P(( LDAP *ld,
2107 struct berval *txnid,
2108 LDAPControl **sctrls,
2109 LDAPControl **cctrls,
2113 ldap_txn_end_s LDAP_P(( LDAP *ld,
2115 struct berval *txnid,
2116 LDAPControl **sctrl,
2117 LDAPControl **cctrl,
2122 #endif /* _LDAP_H */