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 */
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
283 /* MS Active Directory controls (for compatibility) */
284 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
285 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
286 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
287 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
288 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
289 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
291 /* MS Active Directory controls - not implemented in slapd(8) */
292 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
293 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
295 /* various expired works */
296 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
297 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
298 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
299 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
300 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
302 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
303 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
304 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
305 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
306 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
307 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
308 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
310 /* LDAP VLV *//* not implemented in slapd(8) */
311 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
312 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
315 /* LDAP Unsolicited Notifications */
316 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
317 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
319 /* LDAP Extended Operations */
320 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
322 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
323 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
324 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
325 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
326 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
328 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
329 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
331 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
332 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
333 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
334 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
336 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
337 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
339 /* various works in progress */
341 #define LDAP_EXOP_X_TURN "1.3.6.1.4.1.4203.666.6.4" /* RFC 4531 */
344 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
345 /* a work in progress */
347 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
348 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
349 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
350 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
351 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
352 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
353 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
354 LDAP_X_DISTPROC_BASE ".6"
355 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
356 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
357 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
358 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
359 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
363 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* temp */
364 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
365 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
366 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
367 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
371 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
372 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
373 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
374 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
375 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
376 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
377 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
380 /* LDAP Experimental (works in progress) Features */
381 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
382 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
383 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
387 * specific LDAP instantiations of BER types we know about
390 /* Overview of LBER tag construction
397 * 1 0 = CONTEXT-SPECIFIC
404 * | 5 ... 1 | TAG-NUMBER
408 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
409 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
411 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
412 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
414 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
415 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
417 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
419 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
420 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
421 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
422 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
424 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
425 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
427 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
429 /* LDAP Request Messages */
430 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
431 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
432 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
433 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
434 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
435 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
436 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
437 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
438 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
439 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
440 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
441 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
443 /* LDAP Response Messages */
444 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
445 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
446 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
447 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
448 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
449 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
450 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
451 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
452 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
453 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
454 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
455 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
456 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
458 #define LDAP_RES_ANY (-1)
459 #define LDAP_RES_UNSOLICITED (0)
463 #define LDAP_SASL_SIMPLE ((char*)0)
464 #define LDAP_SASL_NULL ("")
467 /* authentication methods available */
468 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
469 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
470 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
471 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
472 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
473 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
477 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
478 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
479 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
480 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
481 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
482 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
483 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
484 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
485 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
486 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
488 /* extended filter component types */
489 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
490 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
491 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
492 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
494 /* substring filter component types */
495 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
496 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
497 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
500 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
501 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
502 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
503 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
504 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
505 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
506 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
507 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
508 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
510 /* substring filter component types */
511 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
512 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
513 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
518 #define LDAP_SUCCESS 0x00
520 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
522 #define LDAP_OPERATIONS_ERROR 0x01
523 #define LDAP_PROTOCOL_ERROR 0x02
524 #define LDAP_TIMELIMIT_EXCEEDED 0x03
525 #define LDAP_SIZELIMIT_EXCEEDED 0x04
526 #define LDAP_COMPARE_FALSE 0x05
527 #define LDAP_COMPARE_TRUE 0x06
528 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
529 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
530 #define LDAP_STRONG_AUTH_REQUIRED 0x08
531 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
532 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
534 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
535 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
536 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
537 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
538 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
540 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
542 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
543 #define LDAP_UNDEFINED_TYPE 0x11
544 #define LDAP_INAPPROPRIATE_MATCHING 0x12
545 #define LDAP_CONSTRAINT_VIOLATION 0x13
546 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
547 #define LDAP_INVALID_SYNTAX 0x15
549 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
551 #define LDAP_NO_SUCH_OBJECT 0x20
552 #define LDAP_ALIAS_PROBLEM 0x21
553 #define LDAP_INVALID_DN_SYNTAX 0x22
554 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
555 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
557 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
559 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
560 #define LDAP_INAPPROPRIATE_AUTH 0x30
561 #define LDAP_INVALID_CREDENTIALS 0x31
562 #define LDAP_INSUFFICIENT_ACCESS 0x32
564 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
566 #define LDAP_BUSY 0x33
567 #define LDAP_UNAVAILABLE 0x34
568 #define LDAP_UNWILLING_TO_PERFORM 0x35
569 #define LDAP_LOOP_DETECT 0x36
571 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
573 #define LDAP_NAMING_VIOLATION 0x40
574 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
575 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
576 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
577 #define LDAP_ALREADY_EXISTS 0x44
578 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
579 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
580 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
582 #define LDAP_OTHER 0x50
584 /* LCUP operation codes (113-117) - not implemented */
585 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
586 #define LDAP_CUP_SECURITY_VIOLATION 0x72
587 #define LDAP_CUP_INVALID_DATA 0x73
588 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
589 #define LDAP_CUP_RELOAD_REQUIRED 0x75
591 /* Cancel operation codes (118-121) */
592 #define LDAP_CANCELLED 0x76
593 #define LDAP_NO_SUCH_OPERATION 0x77
594 #define LDAP_TOO_LATE 0x78
595 #define LDAP_CANNOT_CANCEL 0x79
597 /* Assertion control (122) */
598 #define LDAP_ASSERTION_FAILED 0x7A
600 /* Proxied Authorization Denied (123) */
601 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
603 /* Experimental result codes */
604 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
606 /* LDAP Sync (4096) */
607 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
610 /* Private Use result codes */
611 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
613 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
614 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
616 /* for the LDAP No-Op control */
617 #define LDAP_X_NO_OPERATION 0x410e
619 /* for the Chaining Behavior control (consecutive result codes requested;
620 * see <draft-sermersheim-ldap-chaining> ) */
621 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
622 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
623 #define LDAP_X_CANNOT_CHAIN 0x4111
626 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
627 #ifdef LDAP_X_DISTPROC_BASE
628 #define LDAP_X_INVALIDREFERENCE 0x4112
632 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
633 #define LDAP_X_TXN_ID_INVALID 0x4121
638 * Based on draft-ietf-ldap-c-api-xx
639 * but with new negative code values
641 #define LDAP_API_ERROR(n) ((n)<0)
642 #define LDAP_API_RESULT(n) ((n)<=0)
644 #define LDAP_SERVER_DOWN (-1)
645 #define LDAP_LOCAL_ERROR (-2)
646 #define LDAP_ENCODING_ERROR (-3)
647 #define LDAP_DECODING_ERROR (-4)
648 #define LDAP_TIMEOUT (-5)
649 #define LDAP_AUTH_UNKNOWN (-6)
650 #define LDAP_FILTER_ERROR (-7)
651 #define LDAP_USER_CANCELLED (-8)
652 #define LDAP_PARAM_ERROR (-9)
653 #define LDAP_NO_MEMORY (-10)
654 #define LDAP_CONNECT_ERROR (-11)
655 #define LDAP_NOT_SUPPORTED (-12)
656 #define LDAP_CONTROL_NOT_FOUND (-13)
657 #define LDAP_NO_RESULTS_RETURNED (-14)
658 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
659 #define LDAP_CLIENT_LOOP (-16)
660 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
664 * This structure represents both ldap messages and ldap responses.
665 * These are really the same, except in the case of search responses,
666 * where a response has multiple messages.
669 typedef struct ldapmsg LDAPMessage;
671 /* for modifications */
672 typedef struct ldapmod {
675 #define LDAP_MOD_OP (0x0007)
676 #define LDAP_MOD_ADD (0x0000)
677 #define LDAP_MOD_DELETE (0x0001)
678 #define LDAP_MOD_REPLACE (0x0002)
679 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
680 #define LDAP_MOD_BVALUES (0x0080)
681 /* IMPORTANT: do not use code 0x1000 (or above),
682 * it is used internally by the backends!
683 * (see ldap/servers/slapd/slap.h)
689 struct berval **modv_bvals;
691 #define mod_values mod_vals.modv_strvals
692 #define mod_bvalues mod_vals.modv_bvals
696 * structure representing an ldap session which can
697 * encompass connections to multiple servers (in the
698 * face of referrals).
700 typedef struct ldap LDAP;
702 #define LDAP_DEREF_NEVER 0x00
703 #define LDAP_DEREF_SEARCHING 0x01
704 #define LDAP_DEREF_FINDING 0x02
705 #define LDAP_DEREF_ALWAYS 0x03
707 #define LDAP_NO_LIMIT 0
709 /* how many messages to retrieve results for */
710 #define LDAP_MSG_ONE 0x00
711 #define LDAP_MSG_ALL 0x01
712 #define LDAP_MSG_RECEIVED 0x02
715 * types for ldap URL handling
717 typedef struct ldap_url_desc {
718 struct ldap_url_desc *lud_next;
730 #define LDAP_URL_SUCCESS 0x00 /* Success */
731 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
732 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
734 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
735 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
736 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
737 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
738 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
739 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
740 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
741 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
744 * The API draft spec says we should declare (or cause to be declared)
745 * 'struct timeval'. We don't. See IETF LDAPext discussions.
753 ldap_get_option LDAP_P((
759 ldap_set_option LDAP_P((
762 LDAP_CONST void *invalue));
764 /* V3 REBIND Function Callback Prototype */
765 typedef int (LDAP_REBIND_PROC) LDAP_P((
766 LDAP *ld, LDAP_CONST char *url,
767 ber_tag_t request, ber_int_t msgid,
771 ldap_set_rebind_proc LDAP_P((
773 LDAP_REBIND_PROC *rebind_proc,
776 /* V3 referral selection Function Callback Prototype */
777 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
778 LDAP *ld, char ***refsp, int *cntp,
782 ldap_set_nextref_proc LDAP_P((
784 LDAP_NEXTREF_PROC *nextref_proc,
787 /* V3 URLLIST Function Callback Prototype */
788 typedef int (LDAP_URLLIST_PROC) LDAP_P((
790 LDAPURLDesc **urllist,
795 ldap_set_urllist_proc LDAP_P((
797 LDAP_URLLIST_PROC *urllist_proc,
804 ldap_create_control LDAP_P((
805 LDAP_CONST char *requestOID,
808 LDAPControl **ctrlp ));
810 LDAP_F( LDAPControl * )
811 ldap_find_control LDAP_P((
812 LDAP_CONST char *oid,
813 LDAPControl **ctrls ));
816 ldap_control_free LDAP_P((
817 LDAPControl *ctrl ));
820 ldap_controls_free LDAP_P((
821 LDAPControl **ctrls ));
827 ldap_domain2dn LDAP_P((
828 LDAP_CONST char* domain,
832 ldap_dn2domain LDAP_P((
837 ldap_domain2hostlist LDAP_P((
838 LDAP_CONST char *domain,
845 ldap_extended_operation LDAP_P((
847 LDAP_CONST char *reqoid,
848 struct berval *reqdata,
849 LDAPControl **serverctrls,
850 LDAPControl **clientctrls,
854 ldap_extended_operation_s LDAP_P((
856 LDAP_CONST char *reqoid,
857 struct berval *reqdata,
858 LDAPControl **serverctrls,
859 LDAPControl **clientctrls,
861 struct berval **retdatap ));
864 ldap_parse_extended_result LDAP_P((
868 struct berval **retdatap,
872 ldap_parse_intermediate LDAP_P((
876 struct berval **retdatap,
877 LDAPControl ***serverctrls,
885 ldap_abandon_ext LDAP_P((
888 LDAPControl **serverctrls,
889 LDAPControl **clientctrls ));
893 ldap_abandon LDAP_P(( /* deprecated, use ldap_abandon_ext */
902 ldap_add_ext LDAP_P((
906 LDAPControl **serverctrls,
907 LDAPControl **clientctrls,
911 ldap_add_ext_s LDAP_P((
915 LDAPControl **serverctrls,
916 LDAPControl **clientctrls ));
920 ldap_add LDAP_P(( /* deprecated, use ldap_add_ext */
926 ldap_add_s LDAP_P(( /* deprecated, use ldap_add_ext_s */
937 ldap_sasl_bind LDAP_P((
940 LDAP_CONST char *mechanism,
942 LDAPControl **serverctrls,
943 LDAPControl **clientctrls,
946 /* Interaction flags (should be passed about in a control)
947 * Automatic (default): use defaults, prompt otherwise
948 * Interactive: prompt always
949 * Quiet: never prompt
951 #define LDAP_SASL_AUTOMATIC 0U
952 #define LDAP_SASL_INTERACTIVE 1U
953 #define LDAP_SASL_QUIET 2U
956 * V3 SASL Interaction Function Callback Prototype
957 * when using Cyrus SASL, interact is pointer to sasl_interact_t
958 * should likely passed in a control (and provided controls)
960 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
961 LDAP *ld, unsigned flags, void* defaults, void *interact ));
964 ldap_sasl_interactive_bind_s LDAP_P((
966 LDAP_CONST char *dn, /* usually NULL */
967 LDAP_CONST char *saslMechanism,
968 LDAPControl **serverControls,
969 LDAPControl **clientControls,
971 /* should be client controls */
973 LDAP_SASL_INTERACT_PROC *proc,
977 ldap_sasl_bind_s LDAP_P((
980 LDAP_CONST char *mechanism,
982 LDAPControl **serverctrls,
983 LDAPControl **clientctrls,
984 struct berval **servercredp ));
987 ldap_parse_sasl_bind_result LDAP_P((
990 struct berval **servercredp,
999 ldap_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1001 LDAP_CONST char *who,
1002 LDAP_CONST char *passwd,
1006 ldap_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1008 LDAP_CONST char *who,
1009 LDAP_CONST char *cred,
1016 ldap_simple_bind LDAP_P(( /* deprecated, use ldap_sasl_bind */
1018 LDAP_CONST char *who,
1019 LDAP_CONST char *passwd ));
1022 ldap_simple_bind_s LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1024 LDAP_CONST char *who,
1025 LDAP_CONST char *passwd ));
1030 * (deprecated - use SASL instead)
1033 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1035 LDAP_CONST char *who ));
1038 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1040 LDAP_CONST char *who ));
1043 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1045 LDAP_CONST char *who ));
1048 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1050 LDAP_CONST char *who ));
1053 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1055 LDAP_CONST char *who ));
1063 ldap_compare_ext LDAP_P((
1065 LDAP_CONST char *dn,
1066 LDAP_CONST char *attr,
1067 struct berval *bvalue,
1068 LDAPControl **serverctrls,
1069 LDAPControl **clientctrls,
1073 ldap_compare_ext_s LDAP_P((
1075 LDAP_CONST char *dn,
1076 LDAP_CONST char *attr,
1077 struct berval *bvalue,
1078 LDAPControl **serverctrls,
1079 LDAPControl **clientctrls ));
1083 ldap_compare LDAP_P(( /* deprecated, use ldap_compare_ext */
1085 LDAP_CONST char *dn,
1086 LDAP_CONST char *attr,
1087 LDAP_CONST char *value ));
1090 ldap_compare_s LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1092 LDAP_CONST char *dn,
1093 LDAP_CONST char *attr,
1094 LDAP_CONST char *value ));
1102 ldap_delete_ext LDAP_P((
1104 LDAP_CONST char *dn,
1105 LDAPControl **serverctrls,
1106 LDAPControl **clientctrls,
1110 ldap_delete_ext_s LDAP_P((
1112 LDAP_CONST char *dn,
1113 LDAPControl **serverctrls,
1114 LDAPControl **clientctrls ));
1118 ldap_delete LDAP_P(( /* deprecated, use ldap_delete_ext */
1120 LDAP_CONST char *dn ));
1123 ldap_delete_s LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1125 LDAP_CONST char *dn ));
1133 ldap_parse_result LDAP_P((
1140 LDAPControl ***serverctrls,
1144 ldap_err2string LDAP_P((
1149 ldap_result2error LDAP_P(( /* deprecated, use ldap_parse_result */
1155 ldap_perror LDAP_P(( /* deprecated, use ldap_err2string */
1157 LDAP_CONST char *s ));
1165 ldap_modify_ext LDAP_P((
1167 LDAP_CONST char *dn,
1169 LDAPControl **serverctrls,
1170 LDAPControl **clientctrls,
1174 ldap_modify_ext_s LDAP_P((
1176 LDAP_CONST char *dn,
1178 LDAPControl **serverctrls,
1179 LDAPControl **clientctrls ));
1183 ldap_modify LDAP_P(( /* deprecated, use ldap_modify_ext */
1185 LDAP_CONST char *dn,
1189 ldap_modify_s LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1191 LDAP_CONST char *dn,
1200 ldap_rename LDAP_P((
1202 LDAP_CONST char *dn,
1203 LDAP_CONST char *newrdn,
1204 LDAP_CONST char *newSuperior,
1206 LDAPControl **sctrls,
1207 LDAPControl **cctrls,
1211 ldap_rename_s LDAP_P((
1213 LDAP_CONST char *dn,
1214 LDAP_CONST char *newrdn,
1215 LDAP_CONST char *newSuperior,
1217 LDAPControl **sctrls,
1218 LDAPControl **cctrls ));
1222 ldap_rename2 LDAP_P(( /* deprecated, use ldap_rename */
1224 LDAP_CONST char *dn,
1225 LDAP_CONST char *newrdn,
1226 LDAP_CONST char *newSuperior,
1227 int deleteoldrdn ));
1230 ldap_rename2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1232 LDAP_CONST char *dn,
1233 LDAP_CONST char *newrdn,
1234 LDAP_CONST char *newSuperior,
1235 int deleteoldrdn ));
1238 ldap_modrdn LDAP_P(( /* deprecated, use ldap_rename */
1240 LDAP_CONST char *dn,
1241 LDAP_CONST char *newrdn ));
1244 ldap_modrdn_s LDAP_P(( /* deprecated, use ldap_rename_s */
1246 LDAP_CONST char *dn,
1247 LDAP_CONST char *newrdn ));
1250 ldap_modrdn2 LDAP_P(( /* deprecated, use ldap_rename */
1252 LDAP_CONST char *dn,
1253 LDAP_CONST char *newrdn,
1254 int deleteoldrdn ));
1257 ldap_modrdn2_s LDAP_P(( /* deprecated, use ldap_rename_s */
1259 LDAP_CONST char *dn,
1260 LDAP_CONST char *newrdn,
1270 ldap_init LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1271 LDAP_CONST char *host,
1275 ldap_open LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1276 LDAP_CONST char *host,
1281 ldap_create LDAP_P((
1285 ldap_initialize LDAP_P((
1287 LDAP_CONST char *url ));
1294 ldap_tls_inplace LDAP_P((
1298 ldap_start_tls LDAP_P((
1300 LDAPControl **serverctrls,
1301 LDAPControl **clientctrls,
1305 ldap_install_tls LDAP_P((
1309 ldap_start_tls_s LDAP_P((
1311 LDAPControl **serverctrls,
1312 LDAPControl **clientctrls ));
1317 LDAP_F( LDAPMessage * )
1318 ldap_first_message LDAP_P((
1320 LDAPMessage *chain ));
1322 LDAP_F( LDAPMessage * )
1323 ldap_next_message LDAP_P((
1325 LDAPMessage *msg ));
1328 ldap_count_messages LDAP_P((
1330 LDAPMessage *chain ));
1335 LDAP_F( LDAPMessage * )
1336 ldap_first_reference LDAP_P((
1338 LDAPMessage *chain ));
1340 LDAP_F( LDAPMessage * )
1341 ldap_next_reference LDAP_P((
1343 LDAPMessage *ref ));
1346 ldap_count_references LDAP_P((
1348 LDAPMessage *chain ));
1351 ldap_parse_reference LDAP_P((
1355 LDAPControl ***serverctrls,
1362 LDAP_F( LDAPMessage * )
1363 ldap_first_entry LDAP_P((
1365 LDAPMessage *chain ));
1367 LDAP_F( LDAPMessage * )
1368 ldap_next_entry LDAP_P((
1370 LDAPMessage *entry ));
1373 ldap_count_entries LDAP_P((
1375 LDAPMessage *chain ));
1378 ldap_get_entry_controls LDAP_P((
1381 LDAPControl ***serverctrls));
1387 LDAP_F( LDAPMessage * )
1388 ldap_delete_result_entry LDAP_P((
1393 ldap_add_result_entry LDAP_P((
1402 ldap_get_dn LDAP_P((
1404 LDAPMessage *entry ));
1406 typedef struct ldap_ava {
1407 struct berval la_attr;
1408 struct berval la_value;
1410 #define LDAP_AVA_NULL 0x0000U
1411 #define LDAP_AVA_STRING 0x0001U
1412 #define LDAP_AVA_BINARY 0x0002U
1413 #define LDAP_AVA_NONPRINTABLE 0x0004U
1414 #define LDAP_AVA_FREE_ATTR 0x0010U
1415 #define LDAP_AVA_FREE_VALUE 0x0020U
1420 typedef LDAPAVA** LDAPRDN;
1421 typedef LDAPRDN* LDAPDN;
1424 #define LDAP_DN_FORMAT_LDAP 0x0000U
1425 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1426 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1427 #define LDAP_DN_FORMAT_DCE 0x0030U
1428 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1429 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1430 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1431 #define LDAP_DN_FORMAT_MASK 0x00F0U
1434 #define LDAP_DN_PRETTY 0x0100U
1435 #define LDAP_DN_SKIP 0x0200U
1436 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1437 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1438 #define LDAP_DN_PEDANTIC 0xF000U
1440 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1441 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1450 ldap_str2dn LDAP_P((
1451 LDAP_CONST char *str,
1462 ldap_dn2str LDAP_P((
1468 ldap_bv2rdn LDAP_P((
1475 ldap_str2rdn LDAP_P((
1476 LDAP_CONST char *str,
1482 ldap_rdn2bv LDAP_P((
1488 ldap_rdn2str LDAP_P((
1494 ldap_dn_normalize LDAP_P((
1495 LDAP_CONST char *in, unsigned iflags,
1496 char **out, unsigned oflags ));
1499 ldap_dn2ufn LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1500 LDAP_CONST char *dn ));
1503 ldap_explode_dn LDAP_P(( /* deprecated, ldap_str2dn */
1504 LDAP_CONST char *dn,
1508 ldap_explode_rdn LDAP_P(( /* deprecated, ldap_str2rdn */
1509 LDAP_CONST char *rdn,
1512 typedef int LDAPDN_rewrite_func
1513 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1516 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1517 LDAPDN_rewrite_func *func, unsigned flags ));
1520 ldap_dn2dcedn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1521 LDAP_CONST char *dn ));
1524 ldap_dcedn2dn LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1525 LDAP_CONST char *dce ));
1528 ldap_dn2ad_canonical LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1529 LDAP_CONST char *dn ));
1532 ldap_get_dn_ber LDAP_P((
1533 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1536 ldap_get_attribute_ber LDAP_P((
1537 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1538 struct berval **vals ));
1544 ldap_first_attribute LDAP_P((
1547 BerElement **ber ));
1550 ldap_next_attribute LDAP_P((
1559 LDAP_F( struct berval ** )
1560 ldap_get_values_len LDAP_P((
1563 LDAP_CONST char *target ));
1566 ldap_count_values_len LDAP_P((
1567 struct berval **vals ));
1570 ldap_value_free_len LDAP_P((
1571 struct berval **vals ));
1575 ldap_get_values LDAP_P(( /* deprecated, use ldap_get_values_len */
1578 LDAP_CONST char *target ));
1581 ldap_count_values LDAP_P(( /* deprecated, use ldap_count_values_len */
1585 ldap_value_free LDAP_P(( /* deprecated, use ldap_values_free_len */
1593 ldap_result LDAP_P((
1597 struct timeval *timeout,
1598 LDAPMessage **result ));
1601 ldap_msgtype LDAP_P((
1609 ldap_msgfree LDAP_P((
1613 ldap_msgdelete LDAP_P((
1622 ldap_bv2escaped_filter_value LDAP_P((
1624 struct berval *out ));
1627 ldap_search_ext LDAP_P((
1629 LDAP_CONST char *base,
1631 LDAP_CONST char *filter,
1634 LDAPControl **serverctrls,
1635 LDAPControl **clientctrls,
1636 struct timeval *timeout,
1641 ldap_search_ext_s LDAP_P((
1643 LDAP_CONST char *base,
1645 LDAP_CONST char *filter,
1648 LDAPControl **serverctrls,
1649 LDAPControl **clientctrls,
1650 struct timeval *timeout,
1652 LDAPMessage **res ));
1656 ldap_search LDAP_P(( /* deprecated, use ldap_search_ext */
1658 LDAP_CONST char *base,
1660 LDAP_CONST char *filter,
1665 ldap_search_s LDAP_P(( /* deprecated, use ldap_search_ext_s */
1667 LDAP_CONST char *base,
1669 LDAP_CONST char *filter,
1672 LDAPMessage **res ));
1675 ldap_search_st LDAP_P(( /* deprecated, use ldap_search_ext_s */
1677 LDAP_CONST char *base,
1679 LDAP_CONST char *filter,
1682 struct timeval *timeout,
1683 LDAPMessage **res ));
1690 ldap_unbind_ext LDAP_P((
1692 LDAPControl **serverctrls,
1693 LDAPControl **clientctrls));
1696 ldap_unbind_ext_s LDAP_P((
1698 LDAPControl **serverctrls,
1699 LDAPControl **clientctrls));
1703 ldap_unbind LDAP_P(( /* deprecated, use ldap_unbind_ext */
1707 ldap_unbind_s LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1715 ldap_put_vrFilter LDAP_P((
1724 ldap_memalloc LDAP_P((
1728 ldap_memrealloc LDAP_P((
1733 ldap_memcalloc LDAP_P((
1738 ldap_memfree LDAP_P((
1742 ldap_memvfree LDAP_P((
1746 ldap_strdup LDAP_P((
1747 LDAP_CONST char * ));
1750 ldap_mods_free LDAP_P((
1757 * in sort.c (deprecated, use custom code instead)
1759 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1760 LDAP_CONST char *left,
1761 LDAP_CONST char *right ));
1763 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1764 LDAP_CONST void *left,
1765 LDAP_CONST void *right ));
1767 LDAP_F( int ) /* deprecated */
1768 ldap_sort_entries LDAP_P(( LDAP *ld,
1769 LDAPMessage **chain,
1770 LDAP_CONST char *attr,
1771 LDAP_SORT_AD_CMP_PROC *cmp ));
1773 LDAP_F( int ) /* deprecated */
1774 ldap_sort_values LDAP_P((
1777 LDAP_SORT_AV_CMP_PROC *cmp ));
1779 LDAP_F( int ) /* deprecated */
1780 ldap_sort_strcasecmp LDAP_P((
1782 LDAP_CONST void *b ));
1789 ldap_is_ldap_url LDAP_P((
1790 LDAP_CONST char *url ));
1793 ldap_is_ldaps_url LDAP_P((
1794 LDAP_CONST char *url ));
1797 ldap_is_ldapi_url LDAP_P((
1798 LDAP_CONST char *url ));
1801 ldap_url_parse LDAP_P((
1802 LDAP_CONST char *url,
1803 LDAPURLDesc **ludpp ));
1806 ldap_url_desc2str LDAP_P((
1807 LDAPURLDesc *ludp ));
1810 ldap_free_urldesc LDAP_P((
1811 LDAPURLDesc *ludp ));
1815 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1818 #define LDAP_API_FEATURE_CANCEL 1000
1821 ldap_cancel LDAP_P(( LDAP *ld,
1823 LDAPControl **sctrls,
1824 LDAPControl **cctrls,
1828 ldap_cancel_s LDAP_P(( LDAP *ld,
1830 LDAPControl **sctrl,
1831 LDAPControl **cctrl ));
1834 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1837 #define LDAP_API_FEATURE_TURN 1000
1840 ldap_turn LDAP_P(( LDAP *ld,
1842 LDAP_CONST char* identifier,
1843 LDAPControl **sctrls,
1844 LDAPControl **cctrls,
1848 ldap_turn_s LDAP_P(( LDAP *ld,
1850 LDAP_CONST char* identifier,
1851 LDAPControl **sctrl,
1852 LDAPControl **cctrl ));
1855 * LDAP Paged Results
1858 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1861 ldap_create_page_control_value LDAP_P((
1864 struct berval *cookie,
1865 struct berval *value ));
1868 ldap_create_page_control LDAP_P((
1871 struct berval *cookie,
1873 LDAPControl **ctrlp ));
1877 ldap_parse_page_control LDAP_P((
1878 /* deprecated, use ldap_parse_pageresponse_control */
1880 LDAPControl **ctrls,
1882 struct berval **cookie ));
1886 ldap_parse_pageresponse_control LDAP_P((
1890 struct berval *cookie ));
1893 * LDAP Server Side Sort
1896 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
1898 /* structure for a sort-key */
1899 typedef struct ldapsortkey {
1900 char *attributeType;
1906 ldap_create_sort_keylist LDAP_P((
1907 LDAPSortKey ***sortKeyList,
1911 ldap_free_sort_keylist LDAP_P((
1912 LDAPSortKey **sortkeylist ));
1915 ldap_create_sort_control_value LDAP_P((
1917 LDAPSortKey **keyList,
1918 struct berval *value ));
1921 ldap_create_sort_control LDAP_P((
1923 LDAPSortKey **keyList,
1925 LDAPControl **ctrlp ));
1928 ldap_parse_sortresponse_control LDAP_P((
1932 char **attribute ));
1935 * LDAP Virtual List View
1938 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
1940 /* structure for virtual list */
1941 typedef struct ldapvlvinfo {
1942 ber_int_t ldvlv_version;
1943 ber_int_t ldvlv_before_count;
1944 ber_int_t ldvlv_after_count;
1945 ber_int_t ldvlv_offset;
1946 ber_int_t ldvlv_count;
1947 struct berval * ldvlv_attrvalue;
1948 struct berval * ldvlv_context;
1949 void * ldvlv_extradata;
1953 ldap_create_vlv_control_value LDAP_P((
1955 LDAPVLVInfo *ldvlistp,
1956 struct berval *value));
1959 ldap_create_vlv_control LDAP_P((
1961 LDAPVLVInfo *ldvlistp,
1962 LDAPControl **ctrlp ));
1965 ldap_parse_vlvresponse_control LDAP_P((
1968 ber_int_t *target_posp,
1969 ber_int_t *list_countp,
1970 struct berval **contextp,
1977 #define LDAP_API_FEATURE_WHOAMI 1000
1980 ldap_parse_whoami LDAP_P((
1983 struct berval **authzid ));
1986 ldap_whoami LDAP_P(( LDAP *ld,
1987 LDAPControl **sctrls,
1988 LDAPControl **cctrls,
1992 ldap_whoami_s LDAP_P((
1994 struct berval **authzid,
1995 LDAPControl **sctrls,
1996 LDAPControl **cctrls ));
1999 * LDAP Password Modify
2002 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2005 ldap_parse_passwd LDAP_P((
2008 struct berval *newpasswd ));
2011 ldap_passwd LDAP_P(( LDAP *ld,
2012 struct berval *user,
2013 struct berval *oldpw,
2014 struct berval *newpw,
2015 LDAPControl **sctrls,
2016 LDAPControl **cctrls,
2020 ldap_passwd_s LDAP_P((
2022 struct berval *user,
2023 struct berval *oldpw,
2024 struct berval *newpw,
2025 struct berval *newpasswd,
2026 LDAPControl **sctrls,
2027 LDAPControl **cctrls ));
2029 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2031 * LDAP Password Policy controls
2034 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2036 typedef enum passpolicyerror_enum {
2037 PP_passwordExpired = 0,
2038 PP_accountLocked = 1,
2039 PP_changeAfterReset = 2,
2040 PP_passwordModNotAllowed = 3,
2041 PP_mustSupplyOldPassword = 4,
2042 PP_insufficientPasswordQuality = 5,
2043 PP_passwordTooShort = 6,
2044 PP_passwordTooYoung = 7,
2045 PP_passwordInHistory = 8,
2047 } LDAPPasswordPolicyError;
2050 ldap_create_passwordpolicy_control LDAP_P((
2052 LDAPControl **ctrlp ));
2055 ldap_parse_passwordpolicy_control LDAP_P((
2060 LDAPPasswordPolicyError *errorp ));
2062 LDAP_F( const char * )
2063 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2064 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2067 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2070 #define LDAP_API_FEATURE_REFRESH 1000
2073 ldap_parse_refresh LDAP_P((
2076 ber_int_t *newttl ));
2079 ldap_refresh LDAP_P(( LDAP *ld,
2082 LDAPControl **sctrls,
2083 LDAPControl **cctrls,
2087 ldap_refresh_s LDAP_P((
2092 LDAPControl **sctrls,
2093 LDAPControl **cctrls ));
2100 ldap_txn_start LDAP_P(( LDAP *ld,
2101 LDAPControl **sctrls,
2102 LDAPControl **cctrls,
2106 ldap_txn_start_s LDAP_P(( LDAP *ld,
2107 LDAPControl **sctrl,
2108 LDAPControl **cctrl,
2109 struct berval **rettxnid ));
2112 ldap_txn_end LDAP_P(( LDAP *ld,
2114 struct berval *txnid,
2115 LDAPControl **sctrls,
2116 LDAPControl **cctrls,
2120 ldap_txn_end_s LDAP_P(( LDAP *ld,
2122 struct berval *txnid,
2123 LDAPControl **sctrl,
2124 LDAPControl **cctrl,
2129 #endif /* _LDAP_H */