2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2005 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 2251: 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 */
124 /* OpenLDAP TLS options */
125 #define LDAP_OPT_X_TLS 0x6000
126 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
127 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
128 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
129 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
130 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
131 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
132 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
133 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
134 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
135 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
136 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
137 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
138 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
140 #define LDAP_OPT_X_TLS_NEVER 0
141 #define LDAP_OPT_X_TLS_HARD 1
142 #define LDAP_OPT_X_TLS_DEMAND 2
143 #define LDAP_OPT_X_TLS_ALLOW 3
144 #define LDAP_OPT_X_TLS_TRY 4
146 #define LDAP_OPT_X_TLS_CRL_NONE 0
147 #define LDAP_OPT_X_TLS_CRL_PEER 1
148 #define LDAP_OPT_X_TLS_CRL_ALL 2
150 /* OpenLDAP SASL options */
151 #define LDAP_OPT_X_SASL_MECH 0x6100
152 #define LDAP_OPT_X_SASL_REALM 0x6101
153 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
154 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
155 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
156 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
157 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
158 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
159 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
160 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
162 /* Private API Extensions -- reserved for application use */
163 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
166 * ldap_get_option() and ldap_set_option() return values.
167 * As later versions may return other values indicating
168 * failure, current applications should only compare returned
169 * value against LDAP_OPT_SUCCESS.
171 #define LDAP_OPT_SUCCESS 0
172 #define LDAP_OPT_ERROR (-1)
174 /* option on/off values */
175 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
176 #define LDAP_OPT_OFF ((void *) 0)
178 typedef struct ldapapiinfo {
179 int ldapai_info_version; /* version of LDAPAPIInfo */
180 #define LDAP_API_INFO_VERSION (1)
181 int ldapai_api_version; /* revision of API supported */
182 int ldapai_protocol_version; /* highest LDAP version supported */
183 char **ldapai_extensions; /* names of API extensions */
184 char *ldapai_vendor_name; /* name of supplier */
185 int ldapai_vendor_version; /* supplier-specific version * 100 */
188 typedef struct ldap_apifeature_info {
189 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
190 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
191 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
192 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
193 } LDAPAPIFeatureInfo;
196 * LDAP Control structure
198 typedef struct ldapcontrol {
199 char * ldctl_oid; /* numericoid of control */
200 struct berval ldctl_value; /* encoded value of control */
201 char ldctl_iscritical; /* criticality */
205 /* standard track controls */
206 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
207 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
208 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
210 /* standard track - not implemented in slapd(8) */
211 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
212 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
214 /* but not yet formalized controls */
215 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
216 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
218 /* various works in progress */
219 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
220 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
221 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
222 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
225 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
226 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
227 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
228 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
229 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
232 /* LDAP VLV *//* not implemented in slapd(8) */
233 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
234 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
236 /* Password policy Controls *//* work in progress */
237 /* ITS#3458: released, but not to latest draft; disabled by default */
238 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
239 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
241 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
242 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
243 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
244 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
245 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
246 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
248 #define LDAP_SYNC_NONE 0x00
249 #define LDAP_SYNC_REFRESH_ONLY 0x01
250 #define LDAP_SYNC_RESERVED 0x02
251 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
253 #define LDAP_SYNC_REFRESH_PRESENTS 0
254 #define LDAP_SYNC_REFRESH_DELETES 1
256 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
257 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
258 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
259 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
261 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
262 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
263 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
264 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
266 #define LDAP_SYNC_PRESENT 0
267 #define LDAP_SYNC_ADD 1
268 #define LDAP_SYNC_MODIFY 2
269 #define LDAP_SYNC_DELETE 3
271 /* MS ActiveDirectory controls (for compatibility) */
272 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
273 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
274 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
275 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
276 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
277 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
278 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */
280 /* LDAP Chaining Behavior Control *//* work in progress */
281 /* <draft-sermersheim-ldap-chaining>;
282 * see also LDAP_REQUIRES_CHAINING, LDAP_CANNOT_CHAIN */
284 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
286 #define LDAP_CHAINING_PREFERRED 0
287 #define LDAP_CHAINING_REQUIRED 1
288 #define LDAP_REFERRALS_PREFERRED 2
289 #define LDAP_REFERRALS_REQUIRED 3
292 /* LDAP Unsolicited Notifications */
293 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
294 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
296 /* LDAP Extended Operations */
297 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
299 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
300 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
301 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
302 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
303 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
305 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
306 #define LDAP_EXOP_X_CANCEL "1.3.6.1.1.8"
308 /* LDAP Grouping of Related Operations *//* a work in progress */
310 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
311 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
312 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
313 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
314 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
315 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
316 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
319 /* LDAP Grouping Types *//* a work in progress */
321 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
325 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
326 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
327 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
328 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
329 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
330 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
333 /* LDAP Experimental (works in progress) Features */
334 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
335 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
336 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
337 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
341 * specific LDAP instantiations of BER types we know about
344 /* Overview of LBER tag construction
351 * 1 0 = CONTEXT-SPECIFIC
358 * | 5 ... 1 | TAG-NUMBER
362 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
363 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
365 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
366 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
368 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
369 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
371 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
373 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
374 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
375 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
376 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
378 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
379 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
381 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
383 /* LDAP Request Messages */
384 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
385 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
386 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
387 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
388 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
389 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
390 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
391 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
392 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
393 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
394 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
395 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
397 /* LDAP Response Messages */
398 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
399 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
400 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
401 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
402 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
403 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
404 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
405 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
406 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
407 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
408 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
409 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
410 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
412 #define LDAP_RES_ANY (-1)
413 #define LDAP_RES_UNSOLICITED (0)
417 #define LDAP_SASL_SIMPLE ((char*)0)
418 #define LDAP_SASL_NULL ("")
421 /* authentication methods available */
422 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
423 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
424 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
425 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
426 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
427 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
431 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
432 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
433 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
434 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
435 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
436 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
437 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
438 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
439 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
440 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
442 /* extended filter component types */
443 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
444 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
445 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
446 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
448 /* substring filter component types */
449 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
450 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
451 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
454 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
455 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
456 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
457 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
458 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
459 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
460 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
461 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
462 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
464 /* substring filter component types */
465 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
466 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
467 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
472 #define LDAP_SUCCESS 0x00
474 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
476 #define LDAP_OPERATIONS_ERROR 0x01
477 #define LDAP_PROTOCOL_ERROR 0x02
478 #define LDAP_TIMELIMIT_EXCEEDED 0x03
479 #define LDAP_SIZELIMIT_EXCEEDED 0x04
480 #define LDAP_COMPARE_FALSE 0x05
481 #define LDAP_COMPARE_TRUE 0x06
482 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
483 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
484 #define LDAP_STRONG_AUTH_REQUIRED 0x08
485 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
486 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
488 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
489 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
490 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
491 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
492 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
494 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
496 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
497 #define LDAP_UNDEFINED_TYPE 0x11
498 #define LDAP_INAPPROPRIATE_MATCHING 0x12
499 #define LDAP_CONSTRAINT_VIOLATION 0x13
500 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
501 #define LDAP_INVALID_SYNTAX 0x15
503 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
505 #define LDAP_NO_SUCH_OBJECT 0x20
506 #define LDAP_ALIAS_PROBLEM 0x21
507 #define LDAP_INVALID_DN_SYNTAX 0x22
508 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
509 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
511 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
513 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
514 #define LDAP_INAPPROPRIATE_AUTH 0x30
515 #define LDAP_INVALID_CREDENTIALS 0x31
516 #define LDAP_INSUFFICIENT_ACCESS 0x32
518 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
520 #define LDAP_BUSY 0x33
521 #define LDAP_UNAVAILABLE 0x34
522 #define LDAP_UNWILLING_TO_PERFORM 0x35
523 #define LDAP_LOOP_DETECT 0x36
525 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
527 #define LDAP_NAMING_VIOLATION 0x40
528 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
529 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
530 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
531 #define LDAP_ALREADY_EXISTS 0x44
532 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
533 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
534 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
536 #define LDAP_OTHER 0x50
538 /* LCUP operation codes (113-117) - not implemented */
539 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
540 #define LDAP_CUP_SECURITY_VIOLATION 0x72
541 #define LDAP_CUP_INVALID_DATA 0x73
542 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
543 #define LDAP_CUP_RELOAD_REQUIRED 0x75
545 /* Cancel operation codes (118-121) */
546 #define LDAP_CANCELLED 0x76
547 #define LDAP_NO_SUCH_OPERATION 0x77
548 #define LDAP_TOO_LATE 0x78
549 #define LDAP_CANNOT_CANCEL 0x79
552 /* Experimental result codes */
553 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
554 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
556 /* for the LDAP Sync operation */
557 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
559 /* for the LDAP No-Op control */
560 #define LDAP_NO_OPERATION 0x410e
562 /* for the Assertion control */
563 #define LDAP_ASSERTION_FAILED 0x410f
565 /* for the Chaining Behavior control (consecutive result codes requested;
566 * see <draft-sermersheim-ldap-chaining> ) */
567 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
568 #define LDAP_REQUIRES_CHAINING 0x4110
569 #define LDAP_CANNOT_CHAIN 0x4111
574 * Based on draft-ietf-ldap-c-api-xx
575 * but with new negative code values
577 #define LDAP_API_ERROR(n) ((n)<0)
578 #define LDAP_API_RESULT(n) ((n)<=0)
580 #define LDAP_SERVER_DOWN (-1)
581 #define LDAP_LOCAL_ERROR (-2)
582 #define LDAP_ENCODING_ERROR (-3)
583 #define LDAP_DECODING_ERROR (-4)
584 #define LDAP_TIMEOUT (-5)
585 #define LDAP_AUTH_UNKNOWN (-6)
586 #define LDAP_FILTER_ERROR (-7)
587 #define LDAP_USER_CANCELLED (-8)
588 #define LDAP_PARAM_ERROR (-9)
589 #define LDAP_NO_MEMORY (-10)
590 #define LDAP_CONNECT_ERROR (-11)
591 #define LDAP_NOT_SUPPORTED (-12)
592 #define LDAP_CONTROL_NOT_FOUND (-13)
593 #define LDAP_NO_RESULTS_RETURNED (-14)
594 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
595 #define LDAP_CLIENT_LOOP (-16)
596 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
600 * This structure represents both ldap messages and ldap responses.
601 * These are really the same, except in the case of search responses,
602 * where a response has multiple messages.
605 typedef struct ldapmsg LDAPMessage;
607 /* for modifications */
608 typedef struct ldapmod {
611 #define LDAP_MOD_OP (0x0007)
612 #define LDAP_MOD_ADD (0x0000)
613 #define LDAP_MOD_DELETE (0x0001)
614 #define LDAP_MOD_REPLACE (0x0002)
615 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
616 #define LDAP_MOD_BVALUES (0x0080)
617 /* IMPORTANT: do not use code 0x1000 (or above),
618 * it is used internally by the backends!
619 * (see ldap/servers/slapd/slap.h)
625 struct berval **modv_bvals;
627 #define mod_values mod_vals.modv_strvals
628 #define mod_bvalues mod_vals.modv_bvals
632 * structure representing an ldap session which can
633 * encompass connections to multiple servers (in the
634 * face of referrals).
636 typedef struct ldap LDAP;
638 #define LDAP_DEREF_NEVER 0x00
639 #define LDAP_DEREF_SEARCHING 0x01
640 #define LDAP_DEREF_FINDING 0x02
641 #define LDAP_DEREF_ALWAYS 0x03
643 #define LDAP_NO_LIMIT 0
645 /* how many messages to retrieve results for */
646 #define LDAP_MSG_ONE 0x00
647 #define LDAP_MSG_ALL 0x01
648 #define LDAP_MSG_RECEIVED 0x02
651 * types for ldap URL handling
653 typedef struct ldap_url_desc {
654 struct ldap_url_desc *lud_next;
666 #define LDAP_URL_SUCCESS 0x00 /* Success */
667 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
668 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
670 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
671 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
672 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
673 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
674 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
675 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
676 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
677 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
680 * The API draft spec says we should declare (or cause to be declared)
681 * 'struct timeval'. We don't. See IETF LDAPext discussions.
689 ldap_get_option LDAP_P((
695 ldap_set_option LDAP_P((
698 LDAP_CONST void *invalue));
700 /* V3 REBIND Function Callback Prototype */
701 typedef int (LDAP_REBIND_PROC) LDAP_P((
702 LDAP *ld, LDAP_CONST char *url,
703 ber_tag_t request, ber_int_t msgid,
707 ldap_set_rebind_proc LDAP_P((
709 LDAP_REBIND_PROC *rebind_proc,
716 ldap_create_control LDAP_P((
717 LDAP_CONST char *requestOID,
720 LDAPControl **ctrlp ));
722 LDAP_F( LDAPControl * )
723 ldap_find_control LDAP_P((
724 LDAP_CONST char *oid,
725 LDAPControl **ctrls ));
728 ldap_control_free LDAP_P((
729 LDAPControl *ctrl ));
732 ldap_controls_free LDAP_P((
733 LDAPControl **ctrls ));
739 ldap_domain2dn LDAP_P((
740 LDAP_CONST char* domain,
744 ldap_dn2domain LDAP_P((
749 ldap_domain2hostlist LDAP_P((
750 LDAP_CONST char *domain,
757 ldap_extended_operation LDAP_P((
759 LDAP_CONST char *reqoid,
760 struct berval *reqdata,
761 LDAPControl **serverctrls,
762 LDAPControl **clientctrls,
766 ldap_extended_operation_s LDAP_P((
768 LDAP_CONST char *reqoid,
769 struct berval *reqdata,
770 LDAPControl **serverctrls,
771 LDAPControl **clientctrls,
773 struct berval **retdatap ));
776 ldap_parse_extended_result LDAP_P((
780 struct berval **retdatap,
784 ldap_parse_intermediate LDAP_P((
788 struct berval **retdatap,
789 LDAPControl ***serverctrls,
795 #ifdef LDAP_EXOP_GROUPING_CREATE
798 ldap_grouping_create LDAP_P((
800 LDAP_CONST char *grpoid,
801 struct berval *grpdata,
802 LDAPControl **serverctrls,
803 LDAPControl **clientctrls,
807 ldap_grouping_create_s LDAP_P((
809 LDAP_CONST char *grpoid,
810 struct berval *grpdata,
811 LDAPControl **serverctrls,
812 LDAPControl **clientctrls,
813 struct berval **retgrpcookiep,
814 struct berval **retgrpdatap ));
817 ldap_parse_grouping_create_result LDAP_P((
820 struct berval **retgrpcookiep,
821 struct berval **retgrpdatap,
822 LDAPControl ***serverctrls,
826 ldap_grouping_end LDAP_P((
828 LDAP_CONST char *grpoid,
829 struct berval *grpdata,
830 LDAPControl **serverctrls,
831 LDAPControl **clientctrls,
835 ldap_grouping_end_s LDAP_P((
837 LDAP_CONST char *grpoid,
838 struct berval *grpdata,
839 LDAPControl **serverctrls,
840 LDAPControl **clientctrls,
841 struct berval **retgrpdatap ));
844 ldap_parse_grouping_end_result LDAP_P((
847 struct berval **retgrpdatap,
848 LDAPControl ***serverctrls,
852 ldap_grouping_action_operation LDAP_P((
854 LDAP_CONST char *grpoid,
855 struct berval *grpdata,
856 LDAPControl **serverctrls,
857 LDAPControl **clientctrls,
861 ldap_grouping_action_operation_s LDAP_P((
863 LDAP_CONST char *grpoid,
864 struct berval *grpdata,
865 LDAPControl **serverctrls,
866 LDAPControl **clientctrls,
867 struct berval **retgrpcookiep,
868 struct berval **retgrpdatap ));
871 ldap_parse_grouping_action_result LDAP_P((
874 struct berval **retgrpcookiep,
875 struct berval **retgrpdatap,
876 LDAPControl ***serverctrls,
880 ldap_parse_grouping_end_notice LDAP_P((
883 struct berval **retdatap,
884 struct berval **retgrpcookiep,
885 struct berval **retgrpdatap,
889 ldap_parse_grouping_info_notice LDAP_P((
892 struct berval **retdatap,
893 struct berval **retgrpcookiep,
894 struct berval **retgrpdatap,
902 ldap_abandon_ext LDAP_P((
905 LDAPControl **serverctrls,
906 LDAPControl **clientctrls ));
910 ldap_abandon LDAP_P(( /* deprecated */
920 ldap_add_ext LDAP_P((
924 LDAPControl **serverctrls,
925 LDAPControl **clientctrls,
929 ldap_add_ext_s LDAP_P((
933 LDAPControl **serverctrls,
934 LDAPControl **clientctrls ));
938 ldap_add LDAP_P(( /* deprecated */
944 ldap_add_s LDAP_P(( /* deprecated */
955 ldap_sasl_bind LDAP_P((
958 LDAP_CONST char *mechanism,
960 LDAPControl **serverctrls,
961 LDAPControl **clientctrls,
964 /* Interaction flags (should be passed about in a control)
965 * Automatic (default): use defaults, prompt otherwise
966 * Interactive: prompt always
967 * Quiet: never prompt
969 #define LDAP_SASL_AUTOMATIC 0U
970 #define LDAP_SASL_INTERACTIVE 1U
971 #define LDAP_SASL_QUIET 2U
974 * V3 SASL Interaction Function Callback Prototype
975 * when using Cyrus SASL, interact is pointer to sasl_interact_t
976 * should likely passed in a control (and provided controls)
978 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
979 LDAP *ld, unsigned flags, void* defaults, void *interact ));
982 ldap_sasl_interactive_bind_s LDAP_P((
984 LDAP_CONST char *dn, /* usually NULL */
985 LDAP_CONST char *saslMechanism,
986 LDAPControl **serverControls,
987 LDAPControl **clientControls,
989 /* should be client controls */
991 LDAP_SASL_INTERACT_PROC *proc,
995 ldap_sasl_bind_s LDAP_P((
998 LDAP_CONST char *mechanism,
1000 LDAPControl **serverctrls,
1001 LDAPControl **clientctrls,
1002 struct berval **servercredp ));
1005 ldap_parse_sasl_bind_result LDAP_P((
1008 struct berval **servercredp,
1017 ldap_bind LDAP_P(( /* deprecated */
1019 LDAP_CONST char *who,
1020 LDAP_CONST char *passwd,
1024 ldap_bind_s LDAP_P(( /* deprecated */
1026 LDAP_CONST char *who,
1027 LDAP_CONST char *cred,
1034 ldap_simple_bind LDAP_P(( /* deprecated */
1036 LDAP_CONST char *who,
1037 LDAP_CONST char *passwd ));
1040 ldap_simple_bind_s LDAP_P(( /* deprecated */
1042 LDAP_CONST char *who,
1043 LDAP_CONST char *passwd ));
1051 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1053 LDAP_CONST char *who ));
1056 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1058 LDAP_CONST char *who ));
1061 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1063 LDAP_CONST char *who ));
1066 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1068 LDAP_CONST char *who ));
1071 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1073 LDAP_CONST char *who ));
1081 ldap_compare_ext LDAP_P((
1083 LDAP_CONST char *dn,
1084 LDAP_CONST char *attr,
1085 struct berval *bvalue,
1086 LDAPControl **serverctrls,
1087 LDAPControl **clientctrls,
1091 ldap_compare_ext_s LDAP_P((
1093 LDAP_CONST char *dn,
1094 LDAP_CONST char *attr,
1095 struct berval *bvalue,
1096 LDAPControl **serverctrls,
1097 LDAPControl **clientctrls ));
1101 ldap_compare LDAP_P(( /* deprecated */
1103 LDAP_CONST char *dn,
1104 LDAP_CONST char *attr,
1105 LDAP_CONST char *value ));
1108 ldap_compare_s LDAP_P(( /* deprecated */
1110 LDAP_CONST char *dn,
1111 LDAP_CONST char *attr,
1112 LDAP_CONST char *value ));
1120 ldap_delete_ext LDAP_P((
1122 LDAP_CONST char *dn,
1123 LDAPControl **serverctrls,
1124 LDAPControl **clientctrls,
1128 ldap_delete_ext_s LDAP_P((
1130 LDAP_CONST char *dn,
1131 LDAPControl **serverctrls,
1132 LDAPControl **clientctrls ));
1136 ldap_delete LDAP_P(( /* deprecated */
1138 LDAP_CONST char *dn ));
1141 ldap_delete_s LDAP_P(( /* deprecated */
1143 LDAP_CONST char *dn ));
1151 ldap_parse_result LDAP_P((
1158 LDAPControl ***serverctrls,
1162 ldap_err2string LDAP_P((
1167 ldap_result2error LDAP_P(( /* deprecated */
1173 ldap_perror LDAP_P(( /* deprecated */
1175 LDAP_CONST char *s ));
1183 ldap_modify_ext LDAP_P((
1185 LDAP_CONST char *dn,
1187 LDAPControl **serverctrls,
1188 LDAPControl **clientctrls,
1192 ldap_modify_ext_s LDAP_P((
1194 LDAP_CONST char *dn,
1196 LDAPControl **serverctrls,
1197 LDAPControl **clientctrls ));
1201 ldap_modify LDAP_P(( /* deprecated */
1203 LDAP_CONST char *dn,
1207 ldap_modify_s LDAP_P(( /* deprecated */
1209 LDAP_CONST char *dn,
1218 ldap_rename LDAP_P((
1220 LDAP_CONST char *dn,
1221 LDAP_CONST char *newrdn,
1222 LDAP_CONST char *newSuperior,
1224 LDAPControl **sctrls,
1225 LDAPControl **cctrls,
1229 ldap_rename_s LDAP_P((
1231 LDAP_CONST char *dn,
1232 LDAP_CONST char *newrdn,
1233 LDAP_CONST char *newSuperior,
1235 LDAPControl **sctrls,
1236 LDAPControl **cctrls ));
1240 ldap_rename2 LDAP_P(( /* deprecated */
1242 LDAP_CONST char *dn,
1243 LDAP_CONST char *newrdn,
1244 LDAP_CONST char *newSuperior,
1245 int deleteoldrdn ));
1248 ldap_rename2_s LDAP_P(( /* deprecated */
1250 LDAP_CONST char *dn,
1251 LDAP_CONST char *newrdn,
1252 LDAP_CONST char *newSuperior,
1253 int deleteoldrdn ));
1256 ldap_modrdn LDAP_P(( /* deprecated */
1258 LDAP_CONST char *dn,
1259 LDAP_CONST char *newrdn ));
1262 ldap_modrdn_s LDAP_P(( /* deprecated */
1264 LDAP_CONST char *dn,
1265 LDAP_CONST char *newrdn ));
1268 ldap_modrdn2 LDAP_P(( /* deprecated */
1270 LDAP_CONST char *dn,
1271 LDAP_CONST char *newrdn,
1272 int deleteoldrdn ));
1275 ldap_modrdn2_s LDAP_P(( /* deprecated */
1277 LDAP_CONST char *dn,
1278 LDAP_CONST char *newrdn,
1288 ldap_init LDAP_P(( /* deprecated */
1289 LDAP_CONST char *host,
1293 ldap_open LDAP_P(( /* deprecated */
1294 LDAP_CONST char *host,
1299 ldap_create LDAP_P((
1303 ldap_initialize LDAP_P((
1305 LDAP_CONST char *url ));
1308 ldap_start_tls_s LDAP_P((
1310 LDAPControl **serverctrls,
1311 LDAPControl **clientctrls ));
1316 LDAP_F( LDAPMessage * )
1317 ldap_first_message LDAP_P((
1319 LDAPMessage *chain ));
1321 LDAP_F( LDAPMessage * )
1322 ldap_next_message LDAP_P((
1324 LDAPMessage *msg ));
1327 ldap_count_messages LDAP_P((
1329 LDAPMessage *chain ));
1334 LDAP_F( LDAPMessage * )
1335 ldap_first_reference LDAP_P((
1337 LDAPMessage *chain ));
1339 LDAP_F( LDAPMessage * )
1340 ldap_next_reference LDAP_P((
1342 LDAPMessage *ref ));
1345 ldap_count_references LDAP_P((
1347 LDAPMessage *chain ));
1350 ldap_parse_reference LDAP_P((
1354 LDAPControl ***serverctrls,
1361 LDAP_F( LDAPMessage * )
1362 ldap_first_entry LDAP_P((
1364 LDAPMessage *chain ));
1366 LDAP_F( LDAPMessage * )
1367 ldap_next_entry LDAP_P((
1369 LDAPMessage *entry ));
1372 ldap_count_entries LDAP_P((
1374 LDAPMessage *chain ));
1377 ldap_get_entry_controls LDAP_P((
1380 LDAPControl ***serverctrls));
1386 LDAP_F( LDAPMessage * )
1387 ldap_delete_result_entry LDAP_P((
1392 ldap_add_result_entry LDAP_P((
1401 ldap_get_dn LDAP_P((
1403 LDAPMessage *entry ));
1405 typedef struct ldap_ava {
1406 struct berval la_attr;
1407 struct berval la_value;
1409 #define LDAP_AVA_NULL 0x0000U
1410 #define LDAP_AVA_STRING 0x0001U
1411 #define LDAP_AVA_BINARY 0x0002U
1412 #define LDAP_AVA_NONPRINTABLE 0x0004U
1413 #define LDAP_AVA_FREE_ATTR 0x0010U
1414 #define LDAP_AVA_FREE_VALUE 0x0020U
1419 typedef LDAPAVA** LDAPRDN;
1420 typedef LDAPRDN* LDAPDN;
1423 #define LDAP_DN_FORMAT_LDAP 0x0000U
1424 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1425 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1426 #define LDAP_DN_FORMAT_DCE 0x0030U
1427 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1428 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1429 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1430 #define LDAP_DN_FORMAT_MASK 0x00F0U
1433 #define LDAP_DN_PRETTY 0x0100U
1434 #define LDAP_DN_SKIP 0x0200U
1435 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1436 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1437 #define LDAP_DN_PEDANTIC 0xF000U
1439 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1440 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1449 ldap_str2dn LDAP_P((
1450 LDAP_CONST char *str,
1461 ldap_dn2str LDAP_P((
1467 ldap_bv2rdn LDAP_P((
1474 ldap_str2rdn LDAP_P((
1475 LDAP_CONST char *str,
1481 ldap_rdn2bv LDAP_P((
1487 ldap_rdn2str LDAP_P((
1493 ldap_dn_normalize LDAP_P((
1494 LDAP_CONST char *in, unsigned iflags,
1495 char **out, unsigned oflags ));
1498 ldap_dn2ufn LDAP_P(( /* deprecated */
1499 LDAP_CONST char *dn ));
1502 ldap_explode_dn LDAP_P(( /* deprecated */
1503 LDAP_CONST char *dn,
1507 ldap_explode_rdn LDAP_P(( /* deprecated */
1508 LDAP_CONST char *rdn,
1511 typedef int LDAPDN_rewrite_func
1512 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1515 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1516 LDAPDN_rewrite_func *func, unsigned flags ));
1519 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1522 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1525 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1528 ldap_get_dn_ber LDAP_P((
1529 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1532 ldap_get_attribute_ber LDAP_P((
1533 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1534 struct berval **vals ));
1540 ldap_first_attribute LDAP_P((
1543 BerElement **ber ));
1546 ldap_next_attribute LDAP_P((
1555 LDAP_F( struct berval ** )
1556 ldap_get_values_len LDAP_P((
1559 LDAP_CONST char *target ));
1562 ldap_count_values_len LDAP_P((
1563 struct berval **vals ));
1566 ldap_value_free_len LDAP_P((
1567 struct berval **vals ));
1571 ldap_get_values LDAP_P(( /* deprecated */
1574 LDAP_CONST char *target ));
1577 ldap_count_values LDAP_P(( /* deprecated */
1581 ldap_value_free LDAP_P(( /* deprecated */
1589 ldap_result LDAP_P((
1593 struct timeval *timeout,
1594 LDAPMessage **result ));
1597 ldap_msgtype LDAP_P((
1605 ldap_msgfree LDAP_P((
1609 ldap_msgdelete LDAP_P((
1618 ldap_search_ext LDAP_P((
1620 LDAP_CONST char *base,
1622 LDAP_CONST char *filter,
1625 LDAPControl **serverctrls,
1626 LDAPControl **clientctrls,
1627 struct timeval *timeout,
1632 ldap_search_ext_s LDAP_P((
1634 LDAP_CONST char *base,
1636 LDAP_CONST char *filter,
1639 LDAPControl **serverctrls,
1640 LDAPControl **clientctrls,
1641 struct timeval *timeout,
1643 LDAPMessage **res ));
1647 ldap_search LDAP_P(( /* deprecated */
1649 LDAP_CONST char *base,
1651 LDAP_CONST char *filter,
1656 ldap_search_s LDAP_P(( /* deprecated */
1658 LDAP_CONST char *base,
1660 LDAP_CONST char *filter,
1663 LDAPMessage **res ));
1666 ldap_search_st LDAP_P(( /* deprecated */
1668 LDAP_CONST char *base,
1670 LDAP_CONST char *filter,
1673 struct timeval *timeout,
1674 LDAPMessage **res ));
1681 ldap_unbind_ext LDAP_P((
1683 LDAPControl **serverctrls,
1684 LDAPControl **clientctrls));
1687 ldap_unbind_ext_s LDAP_P((
1689 LDAPControl **serverctrls,
1690 LDAPControl **clientctrls));
1694 ldap_unbind LDAP_P(( /* deprecated */
1698 ldap_unbind_s LDAP_P(( /* deprecated */
1706 ldap_put_vrFilter LDAP_P((
1715 ldap_memalloc LDAP_P((
1719 ldap_memrealloc LDAP_P((
1724 ldap_memcalloc LDAP_P((
1729 ldap_memfree LDAP_P((
1733 ldap_memvfree LDAP_P((
1737 ldap_strdup LDAP_P((
1738 LDAP_CONST char * ));
1741 ldap_mods_free LDAP_P((
1748 * in sort.c (deprecated)
1750 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1751 LDAP_CONST char *left,
1752 LDAP_CONST char *right ));
1754 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1755 LDAP_CONST void *left,
1756 LDAP_CONST void *right ));
1758 LDAP_F( int ) /* deprecated */
1759 ldap_sort_entries LDAP_P(( LDAP *ld,
1760 LDAPMessage **chain,
1761 LDAP_CONST char *attr,
1762 LDAP_SORT_AD_CMP_PROC *cmp ));
1764 LDAP_F( int ) /* deprecated */
1765 ldap_sort_values LDAP_P((
1768 LDAP_SORT_AV_CMP_PROC *cmp ));
1770 LDAP_F( int ) /* deprecated */
1771 ldap_sort_strcasecmp LDAP_P((
1773 LDAP_CONST void *b ));
1780 ldap_is_ldap_url LDAP_P((
1781 LDAP_CONST char *url ));
1784 ldap_is_ldaps_url LDAP_P((
1785 LDAP_CONST char *url ));
1788 ldap_is_ldapi_url LDAP_P((
1789 LDAP_CONST char *url ));
1792 ldap_url_parse LDAP_P((
1793 LDAP_CONST char *url,
1794 LDAPURLDesc **ludpp ));
1797 ldap_url_desc2str LDAP_P((
1798 LDAPURLDesc *ludp ));
1801 ldap_free_urldesc LDAP_P((
1802 LDAPURLDesc *ludp ));
1806 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1809 #define LDAP_API_FEATURE_CANCEL 1000
1812 ldap_cancel LDAP_P(( LDAP *ld,
1814 LDAPControl **sctrls,
1815 LDAPControl **cctrls,
1819 ldap_cancel_s LDAP_P((
1822 LDAPControl **sctrl,
1823 LDAPControl **cctrl ));
1826 * LDAP Server Side Sort
1829 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1831 /* structure for a sort-key */
1832 typedef struct ldapsortkey {
1833 char * attributeType;
1834 char * orderingRule;
1839 ldap_create_sort_keylist LDAP_P((
1840 LDAPSortKey ***sortKeyList,
1844 ldap_free_sort_keylist LDAP_P((
1845 LDAPSortKey **sortkeylist ));
1848 ldap_create_sort_control LDAP_P((
1850 LDAPSortKey **keyList,
1852 LDAPControl **ctrlp ));
1855 ldap_parse_sort_control LDAP_P((
1857 LDAPControl **ctrlp,
1858 unsigned long *result,
1859 char **attribute ));
1863 * LDAP Virtual List View
1866 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1868 /* structure for virtual list */
1869 typedef struct ldapvlvinfo {
1871 unsigned long ldvlv_before_count;
1872 unsigned long ldvlv_after_count;
1873 unsigned long ldvlv_offset;
1874 unsigned long ldvlv_count;
1875 struct berval * ldvlv_attrvalue;
1876 struct berval * ldvlv_context;
1877 void * ldvlv_extradata;
1881 ldap_create_vlv_control LDAP_P((
1883 LDAPVLVInfo *ldvlistp,
1884 LDAPControl **ctrlp ));
1887 ldap_parse_vlv_control LDAP_P((
1889 LDAPControl **ctrls,
1890 unsigned long *target_posp,
1891 unsigned long *list_countp,
1892 struct berval **contextp,
1899 #ifdef LDAP_GROUPING_TRANSACTION
1901 ldap_parse_txn_create LDAP_P((
1904 struct berval **cookie ));
1907 ldap_txn_create LDAP_P((
1909 LDAPControl **sctrls,
1910 LDAPControl **cctrls,
1914 ldap_txn_create_s LDAP_P((
1916 struct berval **cookie,
1917 LDAPControl **sctrls,
1918 LDAPControl **cctrls ));
1921 ldap_txn_end LDAP_P((
1923 struct berval *cookie,
1925 LDAPControl **sctrls,
1926 LDAPControl **cctrls,
1930 ldap_txn_end_s LDAP_P((
1932 struct berval *cookie,
1934 LDAPControl **sctrls,
1935 LDAPControl **cctrls ));
1942 #define LDAP_API_FEATURE_WHOAMI 1000
1945 ldap_parse_whoami LDAP_P((
1948 struct berval **authzid ));
1951 ldap_whoami LDAP_P(( LDAP *ld,
1952 LDAPControl **sctrls,
1953 LDAPControl **cctrls,
1957 ldap_whoami_s LDAP_P((
1959 struct berval **authzid,
1960 LDAPControl **sctrls,
1961 LDAPControl **cctrls ));
1964 * LDAP Password Modify
1967 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1970 ldap_parse_passwd LDAP_P((
1973 struct berval *newpasswd ));
1976 ldap_passwd LDAP_P(( LDAP *ld,
1977 struct berval *user,
1978 struct berval *oldpw,
1979 struct berval *newpw,
1980 LDAPControl **sctrls,
1981 LDAPControl **cctrls,
1985 ldap_passwd_s LDAP_P((
1987 struct berval *user,
1988 struct berval *oldpw,
1989 struct berval *newpw,
1990 struct berval *newpasswd,
1991 LDAPControl **sctrls,
1992 LDAPControl **cctrls ));
1994 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
1996 * LDAP Password Policy controls
1999 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2001 typedef enum passpolicyerror_enum {
2002 PP_passwordExpired = 0,
2003 PP_accountLocked = 1,
2004 PP_changeAfterReset = 2,
2005 PP_passwordModNotAllowed = 3,
2006 PP_mustSupplyOldPassword = 4,
2007 PP_insufficientPasswordQuality = 5,
2008 PP_passwordTooShort = 6,
2009 PP_passwordTooYoung = 7,
2010 PP_passwordInHistory = 8,
2012 } LDAPPasswordPolicyError;
2015 ldap_create_passwordpolicy_control LDAP_P((
2017 LDAPControl **ctrlp ));
2020 ldap_parse_passwordpolicy_control LDAP_P((
2025 LDAPPasswordPolicyError *errorp ));
2027 LDAP_F( const char * )
2028 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2029 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2032 #endif /* _LDAP_H */