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 /* standard track - not implemented in slapd(8) */
200 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
201 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
203 /* but not yet formalized controls */
204 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
205 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
207 /* various works in progress */
208 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
209 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
210 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
211 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
214 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
215 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
216 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
217 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
218 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
221 /* LDAP VLV *//* not implemented in slapd(8) */
222 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
223 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
225 /* Password policy Controls *//* work in progress */
227 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
228 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
231 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
232 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
233 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
234 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
235 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
236 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
238 #define LDAP_SYNC_NONE 0x00
239 #define LDAP_SYNC_REFRESH_ONLY 0x01
240 #define LDAP_SYNC_RESERVED 0x02
241 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
243 #define LDAP_SYNC_REFRESH_PRESENTS 0
244 #define LDAP_SYNC_REFRESH_DELETES 1
246 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
247 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
248 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
249 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
251 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
252 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
253 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
254 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
256 #define LDAP_SYNC_PRESENT 0
257 #define LDAP_SYNC_ADD 1
258 #define LDAP_SYNC_MODIFY 2
259 #define LDAP_SYNC_DELETE 3
261 /* MS ActiveDirectory controls (for compatibility) */
262 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
263 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
264 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
265 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
266 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
267 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
268 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */
270 /* LDAP Unsolicited Notifications */
271 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
272 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
274 /* LDAP Extended Operations */
275 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
277 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
278 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
279 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
280 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
281 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
283 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
284 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
286 /* LDAP Grouping of Related Operations *//* a work in progress */
288 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
289 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
290 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
291 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
292 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
293 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
294 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
297 /* LDAP Grouping Types *//* a work in progress */
299 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
303 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
304 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
305 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
306 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
307 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
308 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
309 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
312 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
313 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
314 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
318 * specific LDAP instantiations of BER types we know about
321 /* Overview of LBER tag construction
328 * 1 0 = CONTEXT-SPECIFIC
335 * | 5 ... 1 | TAG-NUMBER
339 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
340 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
342 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
343 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
345 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
346 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
348 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
350 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
351 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
352 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
353 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
355 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
357 /* LDAP Request Messages */
358 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
359 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
360 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
361 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
362 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
363 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
364 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
365 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
366 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
367 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
368 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
369 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
371 /* LDAP Response Messages */
372 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
373 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
374 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
375 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
376 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
377 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
378 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
379 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
380 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
381 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
382 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
383 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
384 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
386 #define LDAP_RES_ANY (-1)
387 #define LDAP_RES_UNSOLICITED (0)
391 #define LDAP_SASL_SIMPLE ((char*)0)
392 #define LDAP_SASL_NULL ("")
395 /* authentication methods available */
396 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
397 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
398 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
399 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
400 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
401 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
405 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
406 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
407 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
408 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
409 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
410 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
411 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
412 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
413 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
414 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
416 /* extended filter component types */
417 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
418 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
419 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
420 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
422 /* substring filter component types */
423 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
424 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
425 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
428 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
429 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
430 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
431 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
432 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
433 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
434 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
436 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
437 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
440 /* substring filter component types */
441 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
442 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
443 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
448 #define LDAP_SUCCESS 0x00
450 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
452 #define LDAP_OPERATIONS_ERROR 0x01
453 #define LDAP_PROTOCOL_ERROR 0x02
454 #define LDAP_TIMELIMIT_EXCEEDED 0x03
455 #define LDAP_SIZELIMIT_EXCEEDED 0x04
456 #define LDAP_COMPARE_FALSE 0x05
457 #define LDAP_COMPARE_TRUE 0x06
458 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
459 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
460 #define LDAP_STRONG_AUTH_REQUIRED 0x08
461 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
463 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
464 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
465 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
466 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
467 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
469 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
471 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
472 #define LDAP_UNDEFINED_TYPE 0x11
473 #define LDAP_INAPPROPRIATE_MATCHING 0x12
474 #define LDAP_CONSTRAINT_VIOLATION 0x13
475 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
476 #define LDAP_INVALID_SYNTAX 0x15
478 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
480 #define LDAP_NO_SUCH_OBJECT 0x20
481 #define LDAP_ALIAS_PROBLEM 0x21
482 #define LDAP_INVALID_DN_SYNTAX 0x22
483 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
484 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
486 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
488 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
489 #define LDAP_INAPPROPRIATE_AUTH 0x30
490 #define LDAP_INVALID_CREDENTIALS 0x31
491 #define LDAP_INSUFFICIENT_ACCESS 0x32
493 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
495 #define LDAP_BUSY 0x33
496 #define LDAP_UNAVAILABLE 0x34
497 #define LDAP_UNWILLING_TO_PERFORM 0x35
498 #define LDAP_LOOP_DETECT 0x36
500 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
502 #define LDAP_NAMING_VIOLATION 0x40
503 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
504 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
505 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
506 #define LDAP_ALREADY_EXISTS 0x44
507 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
508 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
509 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
511 #define LDAP_OTHER 0x50
513 /* Experimental result codes */
514 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
515 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
517 /* for the LDAP Sync operation */
518 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
520 /* for the LDAP No-Op control */
521 #define LDAP_NO_OPERATION 0x410e
523 /* for the Assertion control */
524 #define LDAP_ASSERTION_FAILED 0x410f
526 /* for the Cancel operation */
527 #define LDAP_CANCELLED 0x4110
528 #define LDAP_NO_SUCH_OPERATION 0x4111
529 #define LDAP_TOO_LATE 0x4112
530 #define LDAP_CANNOT_CANCEL 0x4113
534 * Based on draft-ietf-ldap-c-api-xx
535 * but with new negative code values
537 #define LDAP_API_ERROR(n) ((n)<0)
538 #define LDAP_API_RESULT(n) ((n)<=0)
540 #define LDAP_SERVER_DOWN (-1)
541 #define LDAP_LOCAL_ERROR (-2)
542 #define LDAP_ENCODING_ERROR (-3)
543 #define LDAP_DECODING_ERROR (-4)
544 #define LDAP_TIMEOUT (-5)
545 #define LDAP_AUTH_UNKNOWN (-6)
546 #define LDAP_FILTER_ERROR (-7)
547 #define LDAP_USER_CANCELLED (-8)
548 #define LDAP_PARAM_ERROR (-9)
549 #define LDAP_NO_MEMORY (-10)
550 #define LDAP_CONNECT_ERROR (-11)
551 #define LDAP_NOT_SUPPORTED (-12)
552 #define LDAP_CONTROL_NOT_FOUND (-13)
553 #define LDAP_NO_RESULTS_RETURNED (-14)
554 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
555 #define LDAP_CLIENT_LOOP (-16)
556 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
560 * This structure represents both ldap messages and ldap responses.
561 * These are really the same, except in the case of search responses,
562 * where a response has multiple messages.
565 typedef struct ldapmsg LDAPMessage;
567 /* for modifications */
568 typedef struct ldapmod {
571 #define LDAP_MOD_OP (0x0007)
572 #define LDAP_MOD_ADD (0x0000)
573 #define LDAP_MOD_DELETE (0x0001)
574 #define LDAP_MOD_REPLACE (0x0002)
575 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
576 #define LDAP_MOD_BVALUES (0x0080)
577 /* IMPORTANT: do not use code 0x1000 (or above),
578 * it is used internally by the backends!
579 * (see ldap/servers/slapd/slap.h)
585 struct berval **modv_bvals;
587 #define mod_values mod_vals.modv_strvals
588 #define mod_bvalues mod_vals.modv_bvals
592 * structure representing an ldap session which can
593 * encompass connections to multiple servers (in the
594 * face of referrals).
596 typedef struct ldap LDAP;
598 #define LDAP_DEREF_NEVER 0x00
599 #define LDAP_DEREF_SEARCHING 0x01
600 #define LDAP_DEREF_FINDING 0x02
601 #define LDAP_DEREF_ALWAYS 0x03
603 #define LDAP_NO_LIMIT 0
605 /* how many messages to retrieve results for */
606 #define LDAP_MSG_ONE 0x00
607 #define LDAP_MSG_ALL 0x01
608 #define LDAP_MSG_RECEIVED 0x02
611 * types for ldap URL handling
613 typedef struct ldap_url_desc {
614 struct ldap_url_desc *lud_next;
626 #define LDAP_URL_SUCCESS 0x00 /* Success */
627 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
628 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
630 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
631 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
632 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
633 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
634 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
635 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
636 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
637 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
640 * The API draft spec says we should declare (or cause to be declared)
641 * 'struct timeval'. We don't. See IETF LDAPext discussions.
649 ldap_get_option LDAP_P((
655 ldap_set_option LDAP_P((
658 LDAP_CONST void *invalue));
660 /* V3 REBIND Function Callback Prototype */
661 typedef int (LDAP_REBIND_PROC) LDAP_P((
662 LDAP *ld, LDAP_CONST char *url,
663 ber_tag_t request, ber_int_t msgid,
667 ldap_set_rebind_proc LDAP_P((
669 LDAP_REBIND_PROC *rebind_proc,
676 ldap_create_control LDAP_P((
677 LDAP_CONST char *requestOID,
680 LDAPControl **ctrlp ));
682 LDAP_F( LDAPControl * )
683 ldap_find_control LDAP_P((
684 LDAP_CONST char *oid,
685 LDAPControl **ctrls ));
688 ldap_control_free LDAP_P((
689 LDAPControl *ctrl ));
692 ldap_controls_free LDAP_P((
693 LDAPControl **ctrls ));
699 ldap_domain2dn LDAP_P((
700 LDAP_CONST char* domain,
704 ldap_dn2domain LDAP_P((
709 ldap_domain2hostlist LDAP_P((
710 LDAP_CONST char *domain,
717 ldap_extended_operation LDAP_P((
719 LDAP_CONST char *reqoid,
720 struct berval *reqdata,
721 LDAPControl **serverctrls,
722 LDAPControl **clientctrls,
726 ldap_extended_operation_s LDAP_P((
728 LDAP_CONST char *reqoid,
729 struct berval *reqdata,
730 LDAPControl **serverctrls,
731 LDAPControl **clientctrls,
733 struct berval **retdatap ));
736 ldap_parse_extended_result LDAP_P((
740 struct berval **retdatap,
744 ldap_parse_intermediate LDAP_P((
748 struct berval **retdatap,
749 LDAPControl ***serverctrls,
755 #ifdef LDAP_EXOP_GROUPING_CREATE
758 ldap_grouping_create LDAP_P((
760 LDAP_CONST char *grpoid,
761 struct berval *grpdata,
762 LDAPControl **serverctrls,
763 LDAPControl **clientctrls,
767 ldap_grouping_create_s LDAP_P((
769 LDAP_CONST char *grpoid,
770 struct berval *grpdata,
771 LDAPControl **serverctrls,
772 LDAPControl **clientctrls,
773 struct berval **retgrpcookiep,
774 struct berval **retgrpdatap ));
777 ldap_parse_grouping_create_result LDAP_P((
780 struct berval **retgrpcookiep,
781 struct berval **retgrpdatap,
782 LDAPControl ***serverctrls,
786 ldap_grouping_end LDAP_P((
788 LDAP_CONST char *grpoid,
789 struct berval *grpdata,
790 LDAPControl **serverctrls,
791 LDAPControl **clientctrls,
795 ldap_grouping_end_s LDAP_P((
797 LDAP_CONST char *grpoid,
798 struct berval *grpdata,
799 LDAPControl **serverctrls,
800 LDAPControl **clientctrls,
801 struct berval **retgrpdatap ));
804 ldap_parse_grouping_end_result LDAP_P((
807 struct berval **retgrpdatap,
808 LDAPControl ***serverctrls,
812 ldap_grouping_action_operation LDAP_P((
814 LDAP_CONST char *grpoid,
815 struct berval *grpdata,
816 LDAPControl **serverctrls,
817 LDAPControl **clientctrls,
821 ldap_grouping_action_operation_s LDAP_P((
823 LDAP_CONST char *grpoid,
824 struct berval *grpdata,
825 LDAPControl **serverctrls,
826 LDAPControl **clientctrls,
827 struct berval **retgrpcookiep,
828 struct berval **retgrpdatap ));
831 ldap_parse_grouping_action_result LDAP_P((
834 struct berval **retgrpcookiep,
835 struct berval **retgrpdatap,
836 LDAPControl ***serverctrls,
840 ldap_parse_grouping_end_notice LDAP_P((
843 struct berval **retdatap,
844 struct berval **retgrpcookiep,
845 struct berval **retgrpdatap,
849 ldap_parse_grouping_info_notice LDAP_P((
852 struct berval **retdatap,
853 struct berval **retgrpcookiep,
854 struct berval **retgrpdatap,
862 ldap_abandon_ext LDAP_P((
865 LDAPControl **serverctrls,
866 LDAPControl **clientctrls ));
870 ldap_abandon LDAP_P(( /* deprecated */
880 ldap_add_ext LDAP_P((
884 LDAPControl **serverctrls,
885 LDAPControl **clientctrls,
889 ldap_add_ext_s LDAP_P((
893 LDAPControl **serverctrls,
894 LDAPControl **clientctrls ));
898 ldap_add LDAP_P(( /* deprecated */
904 ldap_add_s LDAP_P(( /* deprecated */
915 ldap_sasl_bind LDAP_P((
918 LDAP_CONST char *mechanism,
920 LDAPControl **serverctrls,
921 LDAPControl **clientctrls,
924 /* Interaction flags (should be passed about in a control)
925 * Automatic (default): use defaults, prompt otherwise
926 * Interactive: prompt always
927 * Quiet: never prompt
929 #define LDAP_SASL_AUTOMATIC 0U
930 #define LDAP_SASL_INTERACTIVE 1U
931 #define LDAP_SASL_QUIET 2U
934 * V3 SASL Interaction Function Callback Prototype
935 * when using Cyrus SASL, interact is pointer to sasl_interact_t
936 * should likely passed in a control (and provided controls)
938 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
939 LDAP *ld, unsigned flags, void* defaults, void *interact ));
942 ldap_sasl_interactive_bind_s LDAP_P((
944 LDAP_CONST char *dn, /* usually NULL */
945 LDAP_CONST char *saslMechanism,
946 LDAPControl **serverControls,
947 LDAPControl **clientControls,
949 /* should be client controls */
951 LDAP_SASL_INTERACT_PROC *proc,
955 ldap_sasl_bind_s LDAP_P((
958 LDAP_CONST char *mechanism,
960 LDAPControl **serverctrls,
961 LDAPControl **clientctrls,
962 struct berval **servercredp ));
965 ldap_parse_sasl_bind_result LDAP_P((
968 struct berval **servercredp,
977 ldap_bind LDAP_P(( /* deprecated */
979 LDAP_CONST char *who,
980 LDAP_CONST char *passwd,
984 ldap_bind_s LDAP_P(( /* deprecated */
986 LDAP_CONST char *who,
987 LDAP_CONST char *cred,
994 ldap_simple_bind LDAP_P(( /* deprecated */
996 LDAP_CONST char *who,
997 LDAP_CONST char *passwd ));
1000 ldap_simple_bind_s LDAP_P(( /* deprecated */
1002 LDAP_CONST char *who,
1003 LDAP_CONST char *passwd ));
1011 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1013 LDAP_CONST char *who ));
1016 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1018 LDAP_CONST char *who ));
1021 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1023 LDAP_CONST char *who ));
1026 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1028 LDAP_CONST char *who ));
1031 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1033 LDAP_CONST char *who ));
1041 ldap_compare_ext LDAP_P((
1043 LDAP_CONST char *dn,
1044 LDAP_CONST char *attr,
1045 struct berval *bvalue,
1046 LDAPControl **serverctrls,
1047 LDAPControl **clientctrls,
1051 ldap_compare_ext_s LDAP_P((
1053 LDAP_CONST char *dn,
1054 LDAP_CONST char *attr,
1055 struct berval *bvalue,
1056 LDAPControl **serverctrls,
1057 LDAPControl **clientctrls ));
1061 ldap_compare LDAP_P(( /* deprecated */
1063 LDAP_CONST char *dn,
1064 LDAP_CONST char *attr,
1065 LDAP_CONST char *value ));
1068 ldap_compare_s LDAP_P(( /* deprecated */
1070 LDAP_CONST char *dn,
1071 LDAP_CONST char *attr,
1072 LDAP_CONST char *value ));
1080 ldap_delete_ext LDAP_P((
1082 LDAP_CONST char *dn,
1083 LDAPControl **serverctrls,
1084 LDAPControl **clientctrls,
1088 ldap_delete_ext_s LDAP_P((
1090 LDAP_CONST char *dn,
1091 LDAPControl **serverctrls,
1092 LDAPControl **clientctrls ));
1096 ldap_delete LDAP_P(( /* deprecated */
1098 LDAP_CONST char *dn ));
1101 ldap_delete_s LDAP_P(( /* deprecated */
1103 LDAP_CONST char *dn ));
1111 ldap_parse_result LDAP_P((
1118 LDAPControl ***serverctrls,
1122 ldap_err2string LDAP_P((
1127 ldap_result2error LDAP_P(( /* deprecated */
1133 ldap_perror LDAP_P(( /* deprecated */
1135 LDAP_CONST char *s ));
1143 ldap_modify_ext LDAP_P((
1145 LDAP_CONST char *dn,
1147 LDAPControl **serverctrls,
1148 LDAPControl **clientctrls,
1152 ldap_modify_ext_s LDAP_P((
1154 LDAP_CONST char *dn,
1156 LDAPControl **serverctrls,
1157 LDAPControl **clientctrls ));
1161 ldap_modify LDAP_P(( /* deprecated */
1163 LDAP_CONST char *dn,
1167 ldap_modify_s LDAP_P(( /* deprecated */
1169 LDAP_CONST char *dn,
1178 ldap_rename LDAP_P((
1180 LDAP_CONST char *dn,
1181 LDAP_CONST char *newrdn,
1182 LDAP_CONST char *newSuperior,
1184 LDAPControl **sctrls,
1185 LDAPControl **cctrls,
1189 ldap_rename_s LDAP_P((
1191 LDAP_CONST char *dn,
1192 LDAP_CONST char *newrdn,
1193 LDAP_CONST char *newSuperior,
1195 LDAPControl **sctrls,
1196 LDAPControl **cctrls ));
1200 ldap_rename2 LDAP_P(( /* deprecated */
1202 LDAP_CONST char *dn,
1203 LDAP_CONST char *newrdn,
1204 LDAP_CONST char *newSuperior,
1205 int deleteoldrdn ));
1208 ldap_rename2_s LDAP_P(( /* deprecated */
1210 LDAP_CONST char *dn,
1211 LDAP_CONST char *newrdn,
1212 LDAP_CONST char *newSuperior,
1213 int deleteoldrdn ));
1216 ldap_modrdn LDAP_P(( /* deprecated */
1218 LDAP_CONST char *dn,
1219 LDAP_CONST char *newrdn ));
1222 ldap_modrdn_s LDAP_P(( /* deprecated */
1224 LDAP_CONST char *dn,
1225 LDAP_CONST char *newrdn ));
1228 ldap_modrdn2 LDAP_P(( /* deprecated */
1230 LDAP_CONST char *dn,
1231 LDAP_CONST char *newrdn,
1232 int deleteoldrdn ));
1235 ldap_modrdn2_s LDAP_P(( /* deprecated */
1237 LDAP_CONST char *dn,
1238 LDAP_CONST char *newrdn,
1248 ldap_init LDAP_P(( /* deprecated */
1249 LDAP_CONST char *host,
1253 ldap_open LDAP_P(( /* deprecated */
1254 LDAP_CONST char *host,
1259 ldap_create LDAP_P((
1263 ldap_initialize LDAP_P((
1265 LDAP_CONST char *url ));
1268 ldap_start_tls_s LDAP_P((
1270 LDAPControl **serverctrls,
1271 LDAPControl **clientctrls ));
1276 LDAP_F( LDAPMessage * )
1277 ldap_first_message LDAP_P((
1279 LDAPMessage *chain ));
1281 LDAP_F( LDAPMessage * )
1282 ldap_next_message LDAP_P((
1284 LDAPMessage *msg ));
1287 ldap_count_messages LDAP_P((
1289 LDAPMessage *chain ));
1294 LDAP_F( LDAPMessage * )
1295 ldap_first_reference LDAP_P((
1297 LDAPMessage *chain ));
1299 LDAP_F( LDAPMessage * )
1300 ldap_next_reference LDAP_P((
1302 LDAPMessage *ref ));
1305 ldap_count_references LDAP_P((
1307 LDAPMessage *chain ));
1310 ldap_parse_reference LDAP_P((
1314 LDAPControl ***serverctrls,
1321 LDAP_F( LDAPMessage * )
1322 ldap_first_entry LDAP_P((
1324 LDAPMessage *chain ));
1326 LDAP_F( LDAPMessage * )
1327 ldap_next_entry LDAP_P((
1329 LDAPMessage *entry ));
1332 ldap_count_entries LDAP_P((
1334 LDAPMessage *chain ));
1337 ldap_get_entry_controls LDAP_P((
1340 LDAPControl ***serverctrls));
1346 LDAP_F( LDAPMessage * )
1347 ldap_delete_result_entry LDAP_P((
1352 ldap_add_result_entry LDAP_P((
1361 ldap_get_dn LDAP_P((
1363 LDAPMessage *entry ));
1365 typedef struct ldap_ava {
1366 struct berval la_attr;
1367 struct berval la_value;
1369 #define LDAP_AVA_NULL 0x0000U
1370 #define LDAP_AVA_STRING 0x0001U
1371 #define LDAP_AVA_BINARY 0x0002U
1372 #define LDAP_AVA_NONPRINTABLE 0x0004U
1373 #define LDAP_AVA_FREE_ATTR 0x0010U
1374 #define LDAP_AVA_FREE_VALUE 0x0020U
1379 typedef LDAPAVA** LDAPRDN;
1380 typedef LDAPRDN* LDAPDN;
1383 #define LDAP_DN_FORMAT_LDAP 0x0000U
1384 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1385 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1386 #define LDAP_DN_FORMAT_DCE 0x0030U
1387 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1388 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1389 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1390 #define LDAP_DN_FORMAT_MASK 0x00F0U
1393 #define LDAP_DN_PRETTY 0x0100U
1394 #define LDAP_DN_SKIP 0x0200U
1395 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1396 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1397 #define LDAP_DN_PEDANTIC 0xF000U
1399 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1400 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1409 ldap_str2dn LDAP_P((
1410 LDAP_CONST char *str,
1421 ldap_dn2str LDAP_P((
1427 ldap_bv2rdn LDAP_P((
1434 ldap_str2rdn LDAP_P((
1435 LDAP_CONST char *str,
1441 ldap_rdn2bv LDAP_P((
1447 ldap_rdn2str LDAP_P((
1453 ldap_dn_normalize LDAP_P((
1454 LDAP_CONST char *in, unsigned iflags,
1455 char **out, unsigned oflags ));
1458 ldap_dn2ufn LDAP_P(( /* deprecated */
1459 LDAP_CONST char *dn ));
1462 ldap_explode_dn LDAP_P(( /* deprecated */
1463 LDAP_CONST char *dn,
1467 ldap_explode_rdn LDAP_P(( /* deprecated */
1468 LDAP_CONST char *rdn,
1471 typedef int LDAPDN_rewrite_func
1472 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1475 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1476 LDAPDN_rewrite_func *func, unsigned flags ));
1479 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1482 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1485 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1488 ldap_get_dn_ber LDAP_P((
1489 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1492 ldap_get_attribute_ber LDAP_P((
1493 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1494 struct berval **vals ));
1500 ldap_first_attribute LDAP_P((
1503 BerElement **ber ));
1506 ldap_next_attribute LDAP_P((
1515 LDAP_F( struct berval ** )
1516 ldap_get_values_len LDAP_P((
1519 LDAP_CONST char *target ));
1522 ldap_count_values_len LDAP_P((
1523 struct berval **vals ));
1526 ldap_value_free_len LDAP_P((
1527 struct berval **vals ));
1531 ldap_get_values LDAP_P(( /* deprecated */
1534 LDAP_CONST char *target ));
1537 ldap_count_values LDAP_P(( /* deprecated */
1541 ldap_value_free LDAP_P(( /* deprecated */
1549 ldap_result LDAP_P((
1553 struct timeval *timeout,
1554 LDAPMessage **result ));
1557 ldap_msgtype LDAP_P((
1565 ldap_msgfree LDAP_P((
1569 ldap_msgdelete LDAP_P((
1578 ldap_search_ext LDAP_P((
1580 LDAP_CONST char *base,
1582 LDAP_CONST char *filter,
1585 LDAPControl **serverctrls,
1586 LDAPControl **clientctrls,
1587 struct timeval *timeout,
1592 ldap_search_ext_s LDAP_P((
1594 LDAP_CONST char *base,
1596 LDAP_CONST char *filter,
1599 LDAPControl **serverctrls,
1600 LDAPControl **clientctrls,
1601 struct timeval *timeout,
1603 LDAPMessage **res ));
1607 ldap_search LDAP_P(( /* deprecated */
1609 LDAP_CONST char *base,
1611 LDAP_CONST char *filter,
1616 ldap_search_s LDAP_P(( /* deprecated */
1618 LDAP_CONST char *base,
1620 LDAP_CONST char *filter,
1623 LDAPMessage **res ));
1626 ldap_search_st LDAP_P(( /* deprecated */
1628 LDAP_CONST char *base,
1630 LDAP_CONST char *filter,
1633 struct timeval *timeout,
1634 LDAPMessage **res ));
1641 ldap_unbind_ext LDAP_P((
1643 LDAPControl **serverctrls,
1644 LDAPControl **clientctrls));
1647 ldap_unbind_ext_s LDAP_P((
1649 LDAPControl **serverctrls,
1650 LDAPControl **clientctrls));
1654 ldap_unbind LDAP_P(( /* deprecated */
1658 ldap_unbind_s LDAP_P(( /* deprecated */
1666 ldap_put_vrFilter LDAP_P((
1675 ldap_memalloc LDAP_P((
1679 ldap_memrealloc LDAP_P((
1684 ldap_memcalloc LDAP_P((
1689 ldap_memfree LDAP_P((
1693 ldap_memvfree LDAP_P((
1697 ldap_strdup LDAP_P((
1698 LDAP_CONST char * ));
1701 ldap_mods_free LDAP_P((
1708 * in sort.c (deprecated)
1710 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1711 LDAP_CONST char *left,
1712 LDAP_CONST char *right ));
1714 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1715 LDAP_CONST void *left,
1716 LDAP_CONST void *right ));
1718 LDAP_F( int ) /* deprecated */
1719 ldap_sort_entries LDAP_P(( LDAP *ld,
1720 LDAPMessage **chain,
1721 LDAP_CONST char *attr,
1722 LDAP_SORT_AD_CMP_PROC *cmp ));
1724 LDAP_F( int ) /* deprecated */
1725 ldap_sort_values LDAP_P((
1728 LDAP_SORT_AV_CMP_PROC *cmp ));
1730 LDAP_F( int ) /* deprecated */
1731 ldap_sort_strcasecmp LDAP_P((
1733 LDAP_CONST void *b ));
1740 ldap_is_ldap_url LDAP_P((
1741 LDAP_CONST char *url ));
1744 ldap_is_ldaps_url LDAP_P((
1745 LDAP_CONST char *url ));
1748 ldap_is_ldapi_url LDAP_P((
1749 LDAP_CONST char *url ));
1752 ldap_url_parse LDAP_P((
1753 LDAP_CONST char *url,
1754 LDAPURLDesc **ludpp ));
1757 ldap_url_desc2str LDAP_P((
1758 LDAPURLDesc *ludp ));
1761 ldap_free_urldesc LDAP_P((
1762 LDAPURLDesc *ludp ));
1766 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1769 #define LDAP_API_FEATURE_CANCEL 1000
1772 ldap_cancel LDAP_P(( LDAP *ld,
1774 LDAPControl **sctrls,
1775 LDAPControl **cctrls,
1779 ldap_cancel_s LDAP_P((
1782 LDAPControl **sctrl,
1783 LDAPControl **cctrl ));
1786 * LDAP Server Side Sort
1789 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1791 /* structure for a sort-key */
1792 typedef struct ldapsortkey {
1793 char * attributeType;
1794 char * orderingRule;
1799 ldap_create_sort_keylist LDAP_P((
1800 LDAPSortKey ***sortKeyList,
1804 ldap_free_sort_keylist LDAP_P((
1805 LDAPSortKey **sortkeylist ));
1808 ldap_create_sort_control LDAP_P((
1810 LDAPSortKey **keyList,
1812 LDAPControl **ctrlp ));
1815 ldap_parse_sort_control LDAP_P((
1817 LDAPControl **ctrlp,
1818 unsigned long *result,
1819 char **attribute ));
1823 * LDAP Virtual List View
1826 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1828 /* structure for virtual list */
1829 typedef struct ldapvlvinfo {
1831 unsigned long ldvlv_before_count;
1832 unsigned long ldvlv_after_count;
1833 unsigned long ldvlv_offset;
1834 unsigned long ldvlv_count;
1835 struct berval * ldvlv_attrvalue;
1836 struct berval * ldvlv_context;
1837 void * ldvlv_extradata;
1841 ldap_create_vlv_control LDAP_P((
1843 LDAPVLVInfo *ldvlistp,
1844 LDAPControl **ctrlp ));
1847 ldap_parse_vlv_control LDAP_P((
1849 LDAPControl **ctrls,
1850 unsigned long *target_posp,
1851 unsigned long *list_countp,
1852 struct berval **contextp,
1859 #ifdef LDAP_GROUPING_TRANSACTION
1861 ldap_parse_txn_create LDAP_P((
1864 struct berval **cookie ));
1867 ldap_txn_create LDAP_P((
1869 LDAPControl **sctrls,
1870 LDAPControl **cctrls,
1874 ldap_txn_create_s LDAP_P((
1876 struct berval **cookie,
1877 LDAPControl **sctrls,
1878 LDAPControl **cctrls ));
1881 ldap_txn_end LDAP_P((
1883 struct berval *cookie,
1885 LDAPControl **sctrls,
1886 LDAPControl **cctrls,
1890 ldap_txn_end_s LDAP_P((
1892 struct berval *cookie,
1894 LDAPControl **sctrls,
1895 LDAPControl **cctrls ));
1902 #define LDAP_API_FEATURE_WHOAMI 1000
1905 ldap_parse_whoami LDAP_P((
1908 struct berval **authzid ));
1911 ldap_whoami LDAP_P(( LDAP *ld,
1912 LDAPControl **sctrls,
1913 LDAPControl **cctrls,
1917 ldap_whoami_s LDAP_P((
1919 struct berval **authzid,
1920 LDAPControl **sctrls,
1921 LDAPControl **cctrls ));
1924 * LDAP Password Modify
1927 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1930 ldap_parse_passwd LDAP_P((
1933 struct berval *newpasswd ));
1936 ldap_passwd LDAP_P(( LDAP *ld,
1937 struct berval *user,
1938 struct berval *oldpw,
1939 struct berval *newpw,
1940 LDAPControl **sctrls,
1941 LDAPControl **cctrls,
1945 ldap_passwd_s LDAP_P((
1947 struct berval *user,
1948 struct berval *oldpw,
1949 struct berval *newpw,
1950 struct berval *newpasswd,
1951 LDAPControl **sctrls,
1952 LDAPControl **cctrls ));
1954 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
1956 * LDAP Password Policy controls
1959 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
1961 typedef enum passpolicyerror_enum {
1962 PP_passwordExpired = 0,
1963 PP_accountLocked = 1,
1964 PP_changeAfterReset = 2,
1965 PP_passwordModNotAllowed = 3,
1966 PP_mustSupplyOldPassword = 4,
1967 PP_insufficientPasswordQuality = 5,
1968 PP_passwordTooShort = 6,
1969 PP_passwordTooYoung = 7,
1970 PP_passwordInHistory = 8,
1972 } LDAPPasswordPolicyError;
1975 ldap_create_passwordpolicy_control LDAP_P((
1977 LDAPControl **ctrlp ));
1980 ldap_parse_passwordpolicy_control LDAP_P((
1985 LDAPPasswordPolicyError *errorp ));
1987 LDAP_F( const char * )
1988 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
1990 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
1993 #endif /* _LDAP_H */