2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2004 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 */
81 * 0x0000 - 0x0fff reserved for api options
82 * 0x1000 - 0x3fff reserved for api extended options
83 * 0x4000 - 0x7fff reserved for private and experimental options
86 #define LDAP_OPT_API_INFO 0x0000
87 #define LDAP_OPT_DESC 0x0001 /* historic */
88 #define LDAP_OPT_DEREF 0x0002
89 #define LDAP_OPT_SIZELIMIT 0x0003
90 #define LDAP_OPT_TIMELIMIT 0x0004
91 /* 0x05 - 0x07 not defined */
92 #define LDAP_OPT_REFERRALS 0x0008
93 #define LDAP_OPT_RESTART 0x0009
94 /* 0x0a - 0x10 not defined */
95 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
96 #define LDAP_OPT_SERVER_CONTROLS 0x0012
97 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
98 /* 0x14 not defined */
99 #define LDAP_OPT_API_FEATURE_INFO 0x0015
100 /* 0x16 - 0x2f not defined */
101 #define LDAP_OPT_HOST_NAME 0x0030
102 #define LDAP_OPT_RESULT_CODE 0x0031
103 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
104 #define LDAP_OPT_ERROR_STRING 0x0032
105 #define LDAP_OPT_MATCHED_DN 0x0033
106 /* 0x0034 - 0x3fff not defined */
109 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
111 /* private and experimental options */
112 /* OpenLDAP specific options */
113 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
114 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
115 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
116 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
117 #define LDAP_OPT_URI 0x5006
118 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
120 /* OpenLDAP TLS options */
121 #define LDAP_OPT_X_TLS 0x6000
122 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
123 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
124 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
125 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
126 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
127 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
128 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
129 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
130 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
131 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
133 #define LDAP_OPT_X_TLS_NEVER 0
134 #define LDAP_OPT_X_TLS_HARD 1
135 #define LDAP_OPT_X_TLS_DEMAND 2
136 #define LDAP_OPT_X_TLS_ALLOW 3
137 #define LDAP_OPT_X_TLS_TRY 4
139 /* OpenLDAP SASL options */
140 #define LDAP_OPT_X_SASL_MECH 0x6100
141 #define LDAP_OPT_X_SASL_REALM 0x6101
142 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
143 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
144 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
145 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
146 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
147 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
148 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
149 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
151 /* Private API Extensions -- reserved for application use */
152 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
155 * ldap_get_option() and ldap_set_option() return values.
156 * As later versions may return other values indicating
157 * failure, current applications should only compare returned
158 * value against LDAP_OPT_SUCCESS.
160 #define LDAP_OPT_SUCCESS 0
161 #define LDAP_OPT_ERROR (-1)
163 /* option on/off values */
164 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
165 #define LDAP_OPT_OFF ((void *) 0)
167 typedef struct ldapapiinfo {
168 int ldapai_info_version; /* version of LDAPAPIInfo */
169 #define LDAP_API_INFO_VERSION (1)
170 int ldapai_api_version; /* revision of API supported */
171 int ldapai_protocol_version; /* highest LDAP version supported */
172 char **ldapai_extensions; /* names of API extensions */
173 char *ldapai_vendor_name; /* name of supplier */
174 int ldapai_vendor_version; /* supplier-specific version * 100 */
177 typedef struct ldap_apifeature_info {
178 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
179 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
180 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
181 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
182 } LDAPAPIFeatureInfo;
185 * LDAP Control structure
187 typedef struct ldapcontrol {
188 char * ldctl_oid; /* numericoid of control */
189 struct berval ldctl_value; /* encoded value of control */
190 char ldctl_iscritical; /* criticality */
194 /* standard track controls */
195 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
196 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
197 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
199 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
200 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.1.10.2"
201 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
202 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
203 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
204 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
206 #define LDAP_CONTROL_SYNC "1.3.6.1.4.1.4203.666.5.6"
207 #define LDAP_CONTROL_SYNC_STATE "1.3.6.1.4.1.4203.666.5.7"
208 #define LDAP_CONTROL_SYNC_DONE "1.3.6.1.4.1.4203.666.5.8"
209 #define LDAP_SYNC_INFO "1.3.6.1.4.1.4203.666.10.2"
211 #define LDAP_SYNC_NONE 0x00
212 #define LDAP_SYNC_REFRESH_ONLY 0x01
213 #define LDAP_SYNC_RESERVED 0x02
214 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
216 #define LDAP_SYNC_REFRESH_PRESENTS 0
217 #define LDAP_SYNC_REFRESH_DELETES 1
219 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
220 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
221 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
222 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
224 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
225 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
226 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
227 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
229 #define LDAP_SYNC_PRESENT 0
230 #define LDAP_SYNC_ADD 1
231 #define LDAP_SYNC_MODIFY 2
232 #define LDAP_SYNC_DELETE 3
235 /* LDAP Duplicated Entry Control Extension */
236 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
237 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
238 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
239 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
242 /* Password policy Controls */
243 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
244 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
246 /* MS ActiveDirectory controls (for compatibility) */
247 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
248 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
249 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
250 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
251 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
252 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
253 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */
255 /* not implemented in slapd(8) */
256 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
257 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
259 /* not implemented in slapd(8) */
260 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
261 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
263 /* LDAP Unsolicited Notifications */
264 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
265 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
267 /* LDAP Extended Operations */
268 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
270 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
271 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
272 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
273 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
274 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
276 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
277 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
279 /* LDAP Grouping of Related Operations */
280 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
281 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
282 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
283 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
284 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
285 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
286 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
288 /* LDAP Grouping Types */
289 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
292 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
293 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
294 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
295 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
296 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
297 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
299 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
300 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
301 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
302 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
305 * specific LDAP instantiations of BER types we know about
308 /* Overview of LBER tag construction
315 * 1 0 = CONTEXT-SPECIFIC
322 * | 5 ... 1 | TAG-NUMBER
326 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
327 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
329 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
330 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
332 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
333 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
335 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
337 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
338 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
339 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
340 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
342 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
344 /* LDAP Request Messages */
345 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
346 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
347 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
348 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
349 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
350 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
351 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
352 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
353 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
354 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
355 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
356 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
358 /* LDAP Response Messages */
359 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
360 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
361 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
362 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
363 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
364 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
365 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
366 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
367 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
368 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
369 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
370 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
371 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
373 #define LDAP_RES_ANY (-1)
374 #define LDAP_RES_UNSOLICITED (0)
378 #define LDAP_SASL_SIMPLE ((char*)0)
379 #define LDAP_SASL_NULL ("")
382 /* authentication methods available */
383 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
384 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
385 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
386 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
387 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
388 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
392 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
393 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
394 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
395 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
396 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
397 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
398 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
399 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
400 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
401 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
403 /* extended filter component types */
404 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
405 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
406 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
407 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
409 /* substring filter component types */
410 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
411 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
412 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
415 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
416 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
417 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
418 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
419 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
420 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
421 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
422 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
423 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
425 /* substring filter component types */
426 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
427 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
428 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
433 #define LDAP_SUCCESS 0x00
435 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
437 #define LDAP_OPERATIONS_ERROR 0x01
438 #define LDAP_PROTOCOL_ERROR 0x02
439 #define LDAP_TIMELIMIT_EXCEEDED 0x03
440 #define LDAP_SIZELIMIT_EXCEEDED 0x04
441 #define LDAP_COMPARE_FALSE 0x05
442 #define LDAP_COMPARE_TRUE 0x06
443 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
444 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
445 #define LDAP_STRONG_AUTH_REQUIRED 0x08
446 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
448 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
449 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
450 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
451 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
452 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
454 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
456 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
457 #define LDAP_UNDEFINED_TYPE 0x11
458 #define LDAP_INAPPROPRIATE_MATCHING 0x12
459 #define LDAP_CONSTRAINT_VIOLATION 0x13
460 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
461 #define LDAP_INVALID_SYNTAX 0x15
463 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
465 #define LDAP_NO_SUCH_OBJECT 0x20
466 #define LDAP_ALIAS_PROBLEM 0x21
467 #define LDAP_INVALID_DN_SYNTAX 0x22
468 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
469 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
471 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
473 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
474 #define LDAP_INAPPROPRIATE_AUTH 0x30
475 #define LDAP_INVALID_CREDENTIALS 0x31
476 #define LDAP_INSUFFICIENT_ACCESS 0x32
478 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
480 #define LDAP_BUSY 0x33
481 #define LDAP_UNAVAILABLE 0x34
482 #define LDAP_UNWILLING_TO_PERFORM 0x35
483 #define LDAP_LOOP_DETECT 0x36
485 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
487 #define LDAP_NAMING_VIOLATION 0x40
488 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
489 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
490 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
491 #define LDAP_ALREADY_EXISTS 0x44
492 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
493 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
494 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
496 #define LDAP_OTHER 0x50
498 /* Experimental result codes */
499 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
500 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
502 /* for the LDAP Sync operation */
503 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
505 /* for the LDAP No-Op control */
506 #define LDAP_NO_OPERATION 0x410e
508 /* for the Assertion control */
509 #define LDAP_ASSERTION_FAILED 0x410f
511 /* for the Cancel operation */
512 #define LDAP_CANCELLED 0x4110
513 #define LDAP_NO_SUCH_OPERATION 0x4111
514 #define LDAP_TOO_LATE 0x4112
515 #define LDAP_CANNOT_CANCEL 0x4113
519 * Based on draft-ietf-ldap-c-api-xx
520 * but with new negative code values
522 #define LDAP_API_ERROR(n) ((n)<0)
523 #define LDAP_API_RESULT(n) ((n)<=0)
525 #define LDAP_SERVER_DOWN (-1)
526 #define LDAP_LOCAL_ERROR (-2)
527 #define LDAP_ENCODING_ERROR (-3)
528 #define LDAP_DECODING_ERROR (-4)
529 #define LDAP_TIMEOUT (-5)
530 #define LDAP_AUTH_UNKNOWN (-6)
531 #define LDAP_FILTER_ERROR (-7)
532 #define LDAP_USER_CANCELLED (-8)
533 #define LDAP_PARAM_ERROR (-9)
534 #define LDAP_NO_MEMORY (-10)
535 #define LDAP_CONNECT_ERROR (-11)
536 #define LDAP_NOT_SUPPORTED (-12)
537 #define LDAP_CONTROL_NOT_FOUND (-13)
538 #define LDAP_NO_RESULTS_RETURNED (-14)
539 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
540 #define LDAP_CLIENT_LOOP (-16)
541 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
545 * This structure represents both ldap messages and ldap responses.
546 * These are really the same, except in the case of search responses,
547 * where a response has multiple messages.
550 typedef struct ldapmsg LDAPMessage;
552 /* for modifications */
553 typedef struct ldapmod {
556 #define LDAP_MOD_OP (0x0007)
557 #define LDAP_MOD_ADD (0x0000)
558 #define LDAP_MOD_DELETE (0x0001)
559 #define LDAP_MOD_REPLACE (0x0002)
560 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
561 #define LDAP_MOD_BVALUES (0x0080)
562 /* IMPORTANT: do not use code 0x1000 (or above),
563 * it is used internally by the backends!
564 * (see ldap/servers/slapd/slap.h)
570 struct berval **modv_bvals;
572 #define mod_values mod_vals.modv_strvals
573 #define mod_bvalues mod_vals.modv_bvals
577 * structure representing an ldap session which can
578 * encompass connections to multiple servers (in the
579 * face of referrals).
581 typedef struct ldap LDAP;
583 #define LDAP_DEREF_NEVER 0x00
584 #define LDAP_DEREF_SEARCHING 0x01
585 #define LDAP_DEREF_FINDING 0x02
586 #define LDAP_DEREF_ALWAYS 0x03
588 #define LDAP_NO_LIMIT 0
590 /* how many messages to retrieve results for */
591 #define LDAP_MSG_ONE 0x00
592 #define LDAP_MSG_ALL 0x01
593 #define LDAP_MSG_RECEIVED 0x02
596 * types for ldap URL handling
598 typedef struct ldap_url_desc {
599 struct ldap_url_desc *lud_next;
611 #define LDAP_URL_SUCCESS 0x00 /* Success */
612 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
613 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
615 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
616 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
617 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
618 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
619 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
620 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
621 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
622 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
625 * The API draft spec says we should declare (or cause to be declared)
626 * 'struct timeval'. We don't. See IETF LDAPext discussions.
634 ldap_get_option LDAP_P((
640 ldap_set_option LDAP_P((
643 LDAP_CONST void *invalue));
645 /* V3 REBIND Function Callback Prototype */
646 typedef int (LDAP_REBIND_PROC) LDAP_P((
647 LDAP *ld, LDAP_CONST char *url,
648 ber_tag_t request, ber_int_t msgid,
652 ldap_set_rebind_proc LDAP_P((
654 LDAP_REBIND_PROC *rebind_proc,
661 ldap_create_control LDAP_P((
662 LDAP_CONST char *requestOID,
665 LDAPControl **ctrlp ));
667 LDAP_F( LDAPControl * )
668 ldap_find_control LDAP_P((
669 LDAP_CONST char *oid,
670 LDAPControl **ctrls ));
673 ldap_control_free LDAP_P((
674 LDAPControl *ctrl ));
677 ldap_controls_free LDAP_P((
678 LDAPControl **ctrls ));
684 ldap_domain2dn LDAP_P((
685 LDAP_CONST char* domain,
689 ldap_dn2domain LDAP_P((
694 ldap_domain2hostlist LDAP_P((
695 LDAP_CONST char *domain,
702 ldap_extended_operation LDAP_P((
704 LDAP_CONST char *reqoid,
705 struct berval *reqdata,
706 LDAPControl **serverctrls,
707 LDAPControl **clientctrls,
711 ldap_extended_operation_s LDAP_P((
713 LDAP_CONST char *reqoid,
714 struct berval *reqdata,
715 LDAPControl **serverctrls,
716 LDAPControl **clientctrls,
718 struct berval **retdatap ));
721 ldap_parse_extended_result LDAP_P((
725 struct berval **retdatap,
729 ldap_parse_intermediate LDAP_P((
733 struct berval **retdatap,
734 LDAPControl ***serverctrls,
742 ldap_grouping_create_operation LDAP_P((
744 LDAP_CONST char *grpoid,
745 struct berval *grpdata,
746 LDAPControl **serverctrls,
747 LDAPControl **clientctrls,
751 ldap_grouping_create_operation_s LDAP_P((
753 LDAP_CONST char *grpoid,
754 struct berval *grpdata,
755 LDAPControl **serverctrls,
756 LDAPControl **clientctrls,
757 struct berval **retgrpcookiep,
758 struct berval **retgrpdatap ));
761 ldap_parse_grouping_create_result LDAP_P((
764 struct berval **retgrpcookiep,
765 struct berval **retgrpdatap,
766 LDAPControl ***serverctrls,
770 ldap_grouping_end_operation LDAP_P((
772 LDAP_CONST char *grpoid,
773 struct berval *grpdata,
774 LDAPControl **serverctrls,
775 LDAPControl **clientctrls,
779 ldap_grouping_end_operation_s LDAP_P((
781 LDAP_CONST char *grpoid,
782 struct berval *grpdata,
783 LDAPControl **serverctrls,
784 LDAPControl **clientctrls,
785 struct berval **retgrpdatap ));
788 ldap_parse_grouping_end_result LDAP_P((
791 struct berval **retgrpdatap,
792 LDAPControl ***serverctrls,
796 ldap_grouping_action_operation LDAP_P((
798 LDAP_CONST char *grpoid,
799 struct berval *grpdata,
800 LDAPControl **serverctrls,
801 LDAPControl **clientctrls,
805 ldap_grouping_action_operation_s LDAP_P((
807 LDAP_CONST char *grpoid,
808 struct berval *grpdata,
809 LDAPControl **serverctrls,
810 LDAPControl **clientctrls,
811 struct berval **retgrpcookiep,
812 struct berval **retgrpdatap ));
815 ldap_parse_grouping_action_result LDAP_P((
818 struct berval **retgrpcookiep,
819 struct berval **retgrpdatap,
820 LDAPControl ***serverctrls,
824 ldap_parse_grouping_end_notice LDAP_P((
827 struct berval **retdatap,
828 struct berval **retgrpcookiep,
829 struct berval **retgrpdatap,
833 ldap_parse_grouping_info_notice LDAP_P((
836 struct berval **retdatap,
837 struct berval **retgrpcookiep,
838 struct berval **retgrpdatap,
845 ldap_abandon_ext LDAP_P((
848 LDAPControl **serverctrls,
849 LDAPControl **clientctrls ));
853 ldap_abandon LDAP_P(( /* deprecated */
863 ldap_add_ext LDAP_P((
867 LDAPControl **serverctrls,
868 LDAPControl **clientctrls,
872 ldap_add_ext_s LDAP_P((
876 LDAPControl **serverctrls,
877 LDAPControl **clientctrls ));
881 ldap_add LDAP_P(( /* deprecated */
887 ldap_add_s LDAP_P(( /* deprecated */
898 ldap_sasl_bind LDAP_P((
901 LDAP_CONST char *mechanism,
903 LDAPControl **serverctrls,
904 LDAPControl **clientctrls,
907 /* Interaction flags (should be passed about in a control)
908 * Automatic (default): use defaults, prompt otherwise
909 * Interactive: prompt always
910 * Quiet: never prompt
912 #define LDAP_SASL_AUTOMATIC 0U
913 #define LDAP_SASL_INTERACTIVE 1U
914 #define LDAP_SASL_QUIET 2U
917 * V3 SASL Interaction Function Callback Prototype
918 * when using Cyrus SASL, interact is pointer to sasl_interact_t
919 * should likely passed in a control (and provided controls)
921 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
922 LDAP *ld, unsigned flags, void* defaults, void *interact ));
925 ldap_sasl_interactive_bind_s LDAP_P((
927 LDAP_CONST char *dn, /* usually NULL */
928 LDAP_CONST char *saslMechanism,
929 LDAPControl **serverControls,
930 LDAPControl **clientControls,
932 /* should be client controls */
934 LDAP_SASL_INTERACT_PROC *proc,
938 ldap_sasl_bind_s LDAP_P((
941 LDAP_CONST char *mechanism,
943 LDAPControl **serverctrls,
944 LDAPControl **clientctrls,
945 struct berval **servercredp ));
948 ldap_parse_sasl_bind_result LDAP_P((
951 struct berval **servercredp,
960 ldap_bind LDAP_P(( /* deprecated */
962 LDAP_CONST char *who,
963 LDAP_CONST char *passwd,
967 ldap_bind_s LDAP_P(( /* deprecated */
969 LDAP_CONST char *who,
970 LDAP_CONST char *cred,
977 ldap_simple_bind LDAP_P(( /* deprecated */
979 LDAP_CONST char *who,
980 LDAP_CONST char *passwd ));
983 ldap_simple_bind_s LDAP_P(( /* deprecated */
985 LDAP_CONST char *who,
986 LDAP_CONST char *passwd ));
994 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
996 LDAP_CONST char *who ));
999 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1001 LDAP_CONST char *who ));
1004 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1006 LDAP_CONST char *who ));
1009 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1011 LDAP_CONST char *who ));
1014 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1016 LDAP_CONST char *who ));
1024 ldap_compare_ext LDAP_P((
1026 LDAP_CONST char *dn,
1027 LDAP_CONST char *attr,
1028 struct berval *bvalue,
1029 LDAPControl **serverctrls,
1030 LDAPControl **clientctrls,
1034 ldap_compare_ext_s LDAP_P((
1036 LDAP_CONST char *dn,
1037 LDAP_CONST char *attr,
1038 struct berval *bvalue,
1039 LDAPControl **serverctrls,
1040 LDAPControl **clientctrls ));
1044 ldap_compare LDAP_P(( /* deprecated */
1046 LDAP_CONST char *dn,
1047 LDAP_CONST char *attr,
1048 LDAP_CONST char *value ));
1051 ldap_compare_s LDAP_P(( /* deprecated */
1053 LDAP_CONST char *dn,
1054 LDAP_CONST char *attr,
1055 LDAP_CONST char *value ));
1063 ldap_delete_ext LDAP_P((
1065 LDAP_CONST char *dn,
1066 LDAPControl **serverctrls,
1067 LDAPControl **clientctrls,
1071 ldap_delete_ext_s LDAP_P((
1073 LDAP_CONST char *dn,
1074 LDAPControl **serverctrls,
1075 LDAPControl **clientctrls ));
1079 ldap_delete LDAP_P(( /* deprecated */
1081 LDAP_CONST char *dn ));
1084 ldap_delete_s LDAP_P(( /* deprecated */
1086 LDAP_CONST char *dn ));
1094 ldap_parse_result LDAP_P((
1101 LDAPControl ***serverctrls,
1105 ldap_err2string LDAP_P((
1110 ldap_result2error LDAP_P(( /* deprecated */
1116 ldap_perror LDAP_P(( /* deprecated */
1118 LDAP_CONST char *s ));
1126 ldap_modify_ext LDAP_P((
1128 LDAP_CONST char *dn,
1130 LDAPControl **serverctrls,
1131 LDAPControl **clientctrls,
1135 ldap_modify_ext_s LDAP_P((
1137 LDAP_CONST char *dn,
1139 LDAPControl **serverctrls,
1140 LDAPControl **clientctrls ));
1144 ldap_modify LDAP_P(( /* deprecated */
1146 LDAP_CONST char *dn,
1150 ldap_modify_s LDAP_P(( /* deprecated */
1152 LDAP_CONST char *dn,
1161 ldap_rename LDAP_P((
1163 LDAP_CONST char *dn,
1164 LDAP_CONST char *newrdn,
1165 LDAP_CONST char *newSuperior,
1167 LDAPControl **sctrls,
1168 LDAPControl **cctrls,
1172 ldap_rename_s LDAP_P((
1174 LDAP_CONST char *dn,
1175 LDAP_CONST char *newrdn,
1176 LDAP_CONST char *newSuperior,
1178 LDAPControl **sctrls,
1179 LDAPControl **cctrls ));
1183 ldap_rename2 LDAP_P(( /* deprecated */
1185 LDAP_CONST char *dn,
1186 LDAP_CONST char *newrdn,
1187 LDAP_CONST char *newSuperior,
1188 int deleteoldrdn ));
1191 ldap_rename2_s LDAP_P(( /* deprecated */
1193 LDAP_CONST char *dn,
1194 LDAP_CONST char *newrdn,
1195 LDAP_CONST char *newSuperior,
1196 int deleteoldrdn ));
1199 ldap_modrdn LDAP_P(( /* deprecated */
1201 LDAP_CONST char *dn,
1202 LDAP_CONST char *newrdn ));
1205 ldap_modrdn_s LDAP_P(( /* deprecated */
1207 LDAP_CONST char *dn,
1208 LDAP_CONST char *newrdn ));
1211 ldap_modrdn2 LDAP_P(( /* deprecated */
1213 LDAP_CONST char *dn,
1214 LDAP_CONST char *newrdn,
1215 int deleteoldrdn ));
1218 ldap_modrdn2_s LDAP_P(( /* deprecated */
1220 LDAP_CONST char *dn,
1221 LDAP_CONST char *newrdn,
1231 ldap_init LDAP_P(( /* deprecated */
1232 LDAP_CONST char *host,
1236 ldap_open LDAP_P(( /* deprecated */
1237 LDAP_CONST char *host,
1242 ldap_create LDAP_P((
1246 ldap_initialize LDAP_P((
1248 LDAP_CONST char *url ));
1251 ldap_start_tls_s LDAP_P((
1253 LDAPControl **serverctrls,
1254 LDAPControl **clientctrls ));
1259 LDAP_F( LDAPMessage * )
1260 ldap_first_message LDAP_P((
1262 LDAPMessage *chain ));
1264 LDAP_F( LDAPMessage * )
1265 ldap_next_message LDAP_P((
1267 LDAPMessage *msg ));
1270 ldap_count_messages LDAP_P((
1272 LDAPMessage *chain ));
1277 LDAP_F( LDAPMessage * )
1278 ldap_first_reference LDAP_P((
1280 LDAPMessage *chain ));
1282 LDAP_F( LDAPMessage * )
1283 ldap_next_reference LDAP_P((
1285 LDAPMessage *ref ));
1288 ldap_count_references LDAP_P((
1290 LDAPMessage *chain ));
1293 ldap_parse_reference LDAP_P((
1297 LDAPControl ***serverctrls,
1304 LDAP_F( LDAPMessage * )
1305 ldap_first_entry LDAP_P((
1307 LDAPMessage *chain ));
1309 LDAP_F( LDAPMessage * )
1310 ldap_next_entry LDAP_P((
1312 LDAPMessage *entry ));
1315 ldap_count_entries LDAP_P((
1317 LDAPMessage *chain ));
1320 ldap_get_entry_controls LDAP_P((
1323 LDAPControl ***serverctrls));
1329 LDAP_F( LDAPMessage * )
1330 ldap_delete_result_entry LDAP_P((
1335 ldap_add_result_entry LDAP_P((
1344 ldap_get_dn LDAP_P((
1346 LDAPMessage *entry ));
1348 typedef struct ldap_ava {
1349 struct berval la_attr;
1350 struct berval la_value;
1352 #define LDAP_AVA_NULL 0x0000U
1353 #define LDAP_AVA_STRING 0x0001U
1354 #define LDAP_AVA_BINARY 0x0002U
1355 #define LDAP_AVA_NONPRINTABLE 0x0004U
1356 #define LDAP_AVA_FREE_ATTR 0x0010U
1357 #define LDAP_AVA_FREE_VALUE 0x0020U
1362 typedef LDAPAVA** LDAPRDN;
1363 typedef LDAPRDN* LDAPDN;
1366 #define LDAP_DN_FORMAT_LDAP 0x0000U
1367 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1368 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1369 #define LDAP_DN_FORMAT_DCE 0x0030U
1370 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1371 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1372 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1373 #define LDAP_DN_FORMAT_MASK 0x00F0U
1376 #define LDAP_DN_PRETTY 0x0100U
1377 #define LDAP_DN_SKIP 0x0200U
1378 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1379 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1380 #define LDAP_DN_PEDANTIC 0xF000U
1382 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1383 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1392 ldap_str2dn LDAP_P((
1393 LDAP_CONST char *str,
1404 ldap_dn2str LDAP_P((
1410 ldap_bv2rdn LDAP_P((
1417 ldap_str2rdn LDAP_P((
1418 LDAP_CONST char *str,
1424 ldap_rdn2bv LDAP_P((
1430 ldap_rdn2str LDAP_P((
1436 ldap_dn_normalize LDAP_P((
1437 LDAP_CONST char *in, unsigned iflags,
1438 char **out, unsigned oflags ));
1441 ldap_dn2ufn LDAP_P(( /* deprecated */
1442 LDAP_CONST char *dn ));
1445 ldap_explode_dn LDAP_P(( /* deprecated */
1446 LDAP_CONST char *dn,
1450 ldap_explode_rdn LDAP_P(( /* deprecated */
1451 LDAP_CONST char *rdn,
1454 typedef int LDAPDN_rewrite_func
1455 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1458 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1459 LDAPDN_rewrite_func *func, unsigned flags ));
1462 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1465 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1468 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1471 ldap_get_dn_ber LDAP_P((
1472 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1475 ldap_get_attribute_ber LDAP_P((
1476 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1477 struct berval **vals ));
1483 ldap_first_attribute LDAP_P((
1486 BerElement **ber ));
1489 ldap_next_attribute LDAP_P((
1498 LDAP_F( struct berval ** )
1499 ldap_get_values_len LDAP_P((
1502 LDAP_CONST char *target ));
1505 ldap_count_values_len LDAP_P((
1506 struct berval **vals ));
1509 ldap_value_free_len LDAP_P((
1510 struct berval **vals ));
1514 ldap_get_values LDAP_P(( /* deprecated */
1517 LDAP_CONST char *target ));
1520 ldap_count_values LDAP_P(( /* deprecated */
1524 ldap_value_free LDAP_P(( /* deprecated */
1532 ldap_result LDAP_P((
1536 struct timeval *timeout,
1537 LDAPMessage **result ));
1540 ldap_msgtype LDAP_P((
1548 ldap_msgfree LDAP_P((
1552 ldap_msgdelete LDAP_P((
1561 ldap_search_ext LDAP_P((
1563 LDAP_CONST char *base,
1565 LDAP_CONST char *filter,
1568 LDAPControl **serverctrls,
1569 LDAPControl **clientctrls,
1570 struct timeval *timeout,
1575 ldap_search_ext_s LDAP_P((
1577 LDAP_CONST char *base,
1579 LDAP_CONST char *filter,
1582 LDAPControl **serverctrls,
1583 LDAPControl **clientctrls,
1584 struct timeval *timeout,
1586 LDAPMessage **res ));
1590 ldap_search LDAP_P(( /* deprecated */
1592 LDAP_CONST char *base,
1594 LDAP_CONST char *filter,
1599 ldap_search_s LDAP_P(( /* deprecated */
1601 LDAP_CONST char *base,
1603 LDAP_CONST char *filter,
1606 LDAPMessage **res ));
1609 ldap_search_st LDAP_P(( /* deprecated */
1611 LDAP_CONST char *base,
1613 LDAP_CONST char *filter,
1616 struct timeval *timeout,
1617 LDAPMessage **res ));
1624 ldap_unbind_ext LDAP_P((
1626 LDAPControl **serverctrls,
1627 LDAPControl **clientctrls));
1630 ldap_unbind_ext_s LDAP_P((
1632 LDAPControl **serverctrls,
1633 LDAPControl **clientctrls));
1637 ldap_unbind LDAP_P(( /* deprecated */
1641 ldap_unbind_s LDAP_P(( /* deprecated */
1649 ldap_put_vrFilter LDAP_P((
1658 ldap_memalloc LDAP_P((
1662 ldap_memrealloc LDAP_P((
1667 ldap_memcalloc LDAP_P((
1672 ldap_memfree LDAP_P((
1676 ldap_memvfree LDAP_P((
1680 ldap_strdup LDAP_P((
1681 LDAP_CONST char * ));
1684 ldap_mods_free LDAP_P((
1691 * in sort.c (deprecated)
1693 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1694 LDAP_CONST char *left,
1695 LDAP_CONST char *right ));
1697 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1698 LDAP_CONST void *left,
1699 LDAP_CONST void *right ));
1701 LDAP_F( int ) /* deprecated */
1702 ldap_sort_entries LDAP_P(( LDAP *ld,
1703 LDAPMessage **chain,
1704 LDAP_CONST char *attr,
1705 LDAP_SORT_AD_CMP_PROC *cmp ));
1707 LDAP_F( int ) /* deprecated */
1708 ldap_sort_values LDAP_P((
1711 LDAP_SORT_AV_CMP_PROC *cmp ));
1713 LDAP_F( int ) /* deprecated */
1714 ldap_sort_strcasecmp LDAP_P((
1716 LDAP_CONST void *b ));
1723 ldap_is_ldap_url LDAP_P((
1724 LDAP_CONST char *url ));
1727 ldap_is_ldaps_url LDAP_P((
1728 LDAP_CONST char *url ));
1731 ldap_is_ldapi_url LDAP_P((
1732 LDAP_CONST char *url ));
1735 ldap_url_parse LDAP_P((
1736 LDAP_CONST char *url,
1737 LDAPURLDesc **ludpp ));
1740 ldap_url_desc2str LDAP_P((
1741 LDAPURLDesc *ludp ));
1744 ldap_free_urldesc LDAP_P((
1745 LDAPURLDesc *ludp ));
1749 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1752 #define LDAP_API_FEATURE_CANCEL 1000
1755 ldap_cancel LDAP_P(( LDAP *ld,
1757 LDAPControl **sctrls,
1758 LDAPControl **cctrls,
1762 ldap_cancel_s LDAP_P((
1765 LDAPControl **sctrl,
1766 LDAPControl **cctrl ));
1769 * LDAP Server Side Sort
1772 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1774 /* structure for a sort-key */
1775 typedef struct ldapsortkey {
1776 char * attributeType;
1777 char * orderingRule;
1782 ldap_create_sort_keylist LDAP_P((
1783 LDAPSortKey ***sortKeyList,
1787 ldap_free_sort_keylist LDAP_P((
1788 LDAPSortKey **sortkeylist ));
1791 ldap_create_sort_control LDAP_P((
1793 LDAPSortKey **keyList,
1795 LDAPControl **ctrlp ));
1798 ldap_parse_sort_control LDAP_P((
1800 LDAPControl **ctrlp,
1801 unsigned long *result,
1802 char **attribute ));
1806 * LDAP Virtual List View
1809 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1811 /* structure for virtual list */
1812 typedef struct ldapvlvinfo {
1814 unsigned long ldvlv_before_count;
1815 unsigned long ldvlv_after_count;
1816 unsigned long ldvlv_offset;
1817 unsigned long ldvlv_count;
1818 struct berval * ldvlv_attrvalue;
1819 struct berval * ldvlv_context;
1820 void * ldvlv_extradata;
1824 ldap_create_vlv_control LDAP_P((
1826 LDAPVLVInfo *ldvlistp,
1827 LDAPControl **ctrlp ));
1830 ldap_parse_vlv_control LDAP_P((
1832 LDAPControl **ctrls,
1833 unsigned long *target_posp,
1834 unsigned long *list_countp,
1835 struct berval **contextp,
1843 ldap_parse_txn_create LDAP_P((
1846 struct berval **cookie ));
1849 ldap_txn_create LDAP_P((
1851 LDAPControl **sctrls,
1852 LDAPControl **cctrls,
1856 ldap_txn_create_s LDAP_P((
1858 struct berval **cookie,
1859 LDAPControl **sctrls,
1860 LDAPControl **cctrls ));
1863 ldap_txn_end LDAP_P((
1865 struct berval *cookie,
1867 LDAPControl **sctrls,
1868 LDAPControl **cctrls,
1872 ldap_txn_end_s LDAP_P((
1874 struct berval *cookie,
1876 LDAPControl **sctrls,
1877 LDAPControl **cctrls ));
1883 #define LDAP_API_FEATURE_WHOAMI 1000
1886 ldap_parse_whoami LDAP_P((
1889 struct berval **authzid ));
1892 ldap_whoami LDAP_P(( LDAP *ld,
1893 LDAPControl **sctrls,
1894 LDAPControl **cctrls,
1898 ldap_whoami_s LDAP_P((
1900 struct berval **authzid,
1901 LDAPControl **sctrls,
1902 LDAPControl **cctrls ));
1905 * LDAP Password Modify
1908 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1911 ldap_parse_passwd LDAP_P((
1914 struct berval *newpasswd ));
1917 ldap_passwd LDAP_P(( LDAP *ld,
1918 struct berval *user,
1919 struct berval *oldpw,
1920 struct berval *newpw,
1921 LDAPControl **sctrls,
1922 LDAPControl **cctrls,
1926 ldap_passwd_s LDAP_P((
1928 struct berval *user,
1929 struct berval *oldpw,
1930 struct berval *newpw,
1931 struct berval *newpasswd,
1932 LDAPControl **sctrls,
1933 LDAPControl **cctrls ));
1936 * LDAP Password Policy controls
1939 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
1941 typedef enum passpolicyerror_enum {
1942 PP_passwordExpired = 0,
1943 PP_accountLocked = 1,
1944 PP_changeAfterReset = 2,
1945 PP_passwordModNotAllowed = 3,
1946 PP_mustSupplyOldPassword = 4,
1947 PP_insufficientPasswordQuality = 5,
1948 PP_passwordTooShort = 6,
1949 PP_passwordTooYoung = 7,
1950 PP_passwordInHistory = 8,
1952 } LDAPPasswordPolicyError;
1955 ldap_create_passwordpolicy_control LDAP_P((
1957 LDAPControl **ctrlp ));
1960 ldap_parse_passwordpolicy_control LDAP_P((
1962 LDAPControl **ctrls,
1965 LDAPPasswordPolicyError *errorp ));
1968 #endif /* _LDAP_H */