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 */
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 */
123 /* OpenLDAP TLS options */
124 #define LDAP_OPT_X_TLS 0x6000
125 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
126 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
127 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
128 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
129 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
130 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
131 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
132 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
133 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
134 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
136 #define LDAP_OPT_X_TLS_NEVER 0
137 #define LDAP_OPT_X_TLS_HARD 1
138 #define LDAP_OPT_X_TLS_DEMAND 2
139 #define LDAP_OPT_X_TLS_ALLOW 3
140 #define LDAP_OPT_X_TLS_TRY 4
142 /* OpenLDAP SASL options */
143 #define LDAP_OPT_X_SASL_MECH 0x6100
144 #define LDAP_OPT_X_SASL_REALM 0x6101
145 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
146 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
147 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
148 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
149 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
150 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
151 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
152 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
154 /* Private API Extensions -- reserved for application use */
155 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
158 * ldap_get_option() and ldap_set_option() return values.
159 * As later versions may return other values indicating
160 * failure, current applications should only compare returned
161 * value against LDAP_OPT_SUCCESS.
163 #define LDAP_OPT_SUCCESS 0
164 #define LDAP_OPT_ERROR (-1)
166 /* option on/off values */
167 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
168 #define LDAP_OPT_OFF ((void *) 0)
170 typedef struct ldapapiinfo {
171 int ldapai_info_version; /* version of LDAPAPIInfo */
172 #define LDAP_API_INFO_VERSION (1)
173 int ldapai_api_version; /* revision of API supported */
174 int ldapai_protocol_version; /* highest LDAP version supported */
175 char **ldapai_extensions; /* names of API extensions */
176 char *ldapai_vendor_name; /* name of supplier */
177 int ldapai_vendor_version; /* supplier-specific version * 100 */
180 typedef struct ldap_apifeature_info {
181 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
182 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
183 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
184 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
185 } LDAPAPIFeatureInfo;
188 * LDAP Control structure
190 typedef struct ldapcontrol {
191 char * ldctl_oid; /* numericoid of control */
192 struct berval ldctl_value; /* encoded value of control */
193 char ldctl_iscritical; /* criticality */
197 /* standard track controls */
198 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
199 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
200 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
202 /* standard track - not implemented in slapd(8) */
203 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
204 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
206 /* but not yet formalized controls */
207 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
208 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
210 /* various works in progress */
211 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
212 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
213 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
214 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
217 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
218 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
219 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
220 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
221 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
224 /* LDAP VLV *//* not implemented in slapd(8) */
225 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
226 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
228 /* Password policy Controls *//* work in progress */
230 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
231 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
234 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
235 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
236 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
237 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
238 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
239 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
241 #define LDAP_SYNC_NONE 0x00
242 #define LDAP_SYNC_REFRESH_ONLY 0x01
243 #define LDAP_SYNC_RESERVED 0x02
244 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
246 #define LDAP_SYNC_REFRESH_PRESENTS 0
247 #define LDAP_SYNC_REFRESH_DELETES 1
249 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
250 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
251 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
252 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
254 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
255 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
256 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
257 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
259 #define LDAP_SYNC_PRESENT 0
260 #define LDAP_SYNC_ADD 1
261 #define LDAP_SYNC_MODIFY 2
262 #define LDAP_SYNC_DELETE 3
264 /* MS ActiveDirectory controls (for compatibility) */
265 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
266 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
267 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
268 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
269 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
270 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
271 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */
273 /* LDAP Unsolicited Notifications */
274 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
275 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
277 /* LDAP Extended Operations */
278 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
280 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
281 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
282 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
283 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
284 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
286 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
287 #define LDAP_EXOP_X_CANCEL "1.3.6.1.4.1.4203.666.6.3"
289 /* LDAP Grouping of Related Operations *//* a work in progress */
291 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
292 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
293 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
294 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
295 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
296 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
297 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
300 /* LDAP Grouping Types *//* a work in progress */
302 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
306 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
307 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
308 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
309 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
310 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
311 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
312 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
315 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
316 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
317 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
321 * specific LDAP instantiations of BER types we know about
324 /* Overview of LBER tag construction
331 * 1 0 = CONTEXT-SPECIFIC
338 * | 5 ... 1 | TAG-NUMBER
342 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
343 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
345 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
346 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
348 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
349 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
351 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
353 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
354 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
355 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
356 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
358 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
360 /* LDAP Request Messages */
361 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
362 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
363 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
364 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
365 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
366 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
367 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
368 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
369 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
370 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
371 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
372 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
374 /* LDAP Response Messages */
375 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
376 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
377 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
378 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
379 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
380 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
381 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
382 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
383 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
384 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
385 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
386 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
387 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
389 #define LDAP_RES_ANY (-1)
390 #define LDAP_RES_UNSOLICITED (0)
394 #define LDAP_SASL_SIMPLE ((char*)0)
395 #define LDAP_SASL_NULL ("")
398 /* authentication methods available */
399 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
400 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
401 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
402 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
403 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
404 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
408 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
409 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
410 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
411 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
412 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
413 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
414 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
415 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
416 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
417 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
419 /* extended filter component types */
420 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
421 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
422 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
423 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
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 */
431 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
432 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
433 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
434 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
435 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
436 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
437 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
439 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
440 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
443 /* substring filter component types */
444 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
445 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
446 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
451 #define LDAP_SUCCESS 0x00
453 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
455 #define LDAP_OPERATIONS_ERROR 0x01
456 #define LDAP_PROTOCOL_ERROR 0x02
457 #define LDAP_TIMELIMIT_EXCEEDED 0x03
458 #define LDAP_SIZELIMIT_EXCEEDED 0x04
459 #define LDAP_COMPARE_FALSE 0x05
460 #define LDAP_COMPARE_TRUE 0x06
461 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
462 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
463 #define LDAP_STRONG_AUTH_REQUIRED 0x08
464 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
466 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
467 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
468 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
469 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
470 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
472 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
474 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
475 #define LDAP_UNDEFINED_TYPE 0x11
476 #define LDAP_INAPPROPRIATE_MATCHING 0x12
477 #define LDAP_CONSTRAINT_VIOLATION 0x13
478 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
479 #define LDAP_INVALID_SYNTAX 0x15
481 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
483 #define LDAP_NO_SUCH_OBJECT 0x20
484 #define LDAP_ALIAS_PROBLEM 0x21
485 #define LDAP_INVALID_DN_SYNTAX 0x22
486 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
487 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
489 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
491 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
492 #define LDAP_INAPPROPRIATE_AUTH 0x30
493 #define LDAP_INVALID_CREDENTIALS 0x31
494 #define LDAP_INSUFFICIENT_ACCESS 0x32
496 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
498 #define LDAP_BUSY 0x33
499 #define LDAP_UNAVAILABLE 0x34
500 #define LDAP_UNWILLING_TO_PERFORM 0x35
501 #define LDAP_LOOP_DETECT 0x36
503 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
505 #define LDAP_NAMING_VIOLATION 0x40
506 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
507 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
508 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
509 #define LDAP_ALREADY_EXISTS 0x44
510 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
511 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
512 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
514 #define LDAP_OTHER 0x50
516 /* Experimental result codes */
517 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
518 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
520 /* for the LDAP Sync operation */
521 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
523 /* for the LDAP No-Op control */
524 #define LDAP_NO_OPERATION 0x410e
526 /* for the Assertion control */
527 #define LDAP_ASSERTION_FAILED 0x410f
529 /* for the Cancel operation */
530 #define LDAP_CANCELLED 0x4110
531 #define LDAP_NO_SUCH_OPERATION 0x4111
532 #define LDAP_TOO_LATE 0x4112
533 #define LDAP_CANNOT_CANCEL 0x4113
537 * Based on draft-ietf-ldap-c-api-xx
538 * but with new negative code values
540 #define LDAP_API_ERROR(n) ((n)<0)
541 #define LDAP_API_RESULT(n) ((n)<=0)
543 #define LDAP_SERVER_DOWN (-1)
544 #define LDAP_LOCAL_ERROR (-2)
545 #define LDAP_ENCODING_ERROR (-3)
546 #define LDAP_DECODING_ERROR (-4)
547 #define LDAP_TIMEOUT (-5)
548 #define LDAP_AUTH_UNKNOWN (-6)
549 #define LDAP_FILTER_ERROR (-7)
550 #define LDAP_USER_CANCELLED (-8)
551 #define LDAP_PARAM_ERROR (-9)
552 #define LDAP_NO_MEMORY (-10)
553 #define LDAP_CONNECT_ERROR (-11)
554 #define LDAP_NOT_SUPPORTED (-12)
555 #define LDAP_CONTROL_NOT_FOUND (-13)
556 #define LDAP_NO_RESULTS_RETURNED (-14)
557 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
558 #define LDAP_CLIENT_LOOP (-16)
559 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
563 * This structure represents both ldap messages and ldap responses.
564 * These are really the same, except in the case of search responses,
565 * where a response has multiple messages.
568 typedef struct ldapmsg LDAPMessage;
570 /* for modifications */
571 typedef struct ldapmod {
574 #define LDAP_MOD_OP (0x0007)
575 #define LDAP_MOD_ADD (0x0000)
576 #define LDAP_MOD_DELETE (0x0001)
577 #define LDAP_MOD_REPLACE (0x0002)
578 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
579 #define LDAP_MOD_BVALUES (0x0080)
580 /* IMPORTANT: do not use code 0x1000 (or above),
581 * it is used internally by the backends!
582 * (see ldap/servers/slapd/slap.h)
588 struct berval **modv_bvals;
590 #define mod_values mod_vals.modv_strvals
591 #define mod_bvalues mod_vals.modv_bvals
595 * structure representing an ldap session which can
596 * encompass connections to multiple servers (in the
597 * face of referrals).
599 typedef struct ldap LDAP;
601 #define LDAP_DEREF_NEVER 0x00
602 #define LDAP_DEREF_SEARCHING 0x01
603 #define LDAP_DEREF_FINDING 0x02
604 #define LDAP_DEREF_ALWAYS 0x03
606 #define LDAP_NO_LIMIT 0
608 /* how many messages to retrieve results for */
609 #define LDAP_MSG_ONE 0x00
610 #define LDAP_MSG_ALL 0x01
611 #define LDAP_MSG_RECEIVED 0x02
614 * types for ldap URL handling
616 typedef struct ldap_url_desc {
617 struct ldap_url_desc *lud_next;
629 #define LDAP_URL_SUCCESS 0x00 /* Success */
630 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
631 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
633 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
634 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
635 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
636 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
637 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
638 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
639 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
640 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
643 * The API draft spec says we should declare (or cause to be declared)
644 * 'struct timeval'. We don't. See IETF LDAPext discussions.
652 ldap_get_option LDAP_P((
658 ldap_set_option LDAP_P((
661 LDAP_CONST void *invalue));
663 /* V3 REBIND Function Callback Prototype */
664 typedef int (LDAP_REBIND_PROC) LDAP_P((
665 LDAP *ld, LDAP_CONST char *url,
666 ber_tag_t request, ber_int_t msgid,
670 ldap_set_rebind_proc LDAP_P((
672 LDAP_REBIND_PROC *rebind_proc,
679 ldap_create_control LDAP_P((
680 LDAP_CONST char *requestOID,
683 LDAPControl **ctrlp ));
685 LDAP_F( LDAPControl * )
686 ldap_find_control LDAP_P((
687 LDAP_CONST char *oid,
688 LDAPControl **ctrls ));
691 ldap_control_free LDAP_P((
692 LDAPControl *ctrl ));
695 ldap_controls_free LDAP_P((
696 LDAPControl **ctrls ));
702 ldap_domain2dn LDAP_P((
703 LDAP_CONST char* domain,
707 ldap_dn2domain LDAP_P((
712 ldap_domain2hostlist LDAP_P((
713 LDAP_CONST char *domain,
720 ldap_extended_operation LDAP_P((
722 LDAP_CONST char *reqoid,
723 struct berval *reqdata,
724 LDAPControl **serverctrls,
725 LDAPControl **clientctrls,
729 ldap_extended_operation_s LDAP_P((
731 LDAP_CONST char *reqoid,
732 struct berval *reqdata,
733 LDAPControl **serverctrls,
734 LDAPControl **clientctrls,
736 struct berval **retdatap ));
739 ldap_parse_extended_result LDAP_P((
743 struct berval **retdatap,
747 ldap_parse_intermediate LDAP_P((
751 struct berval **retdatap,
752 LDAPControl ***serverctrls,
758 #ifdef LDAP_EXOP_GROUPING_CREATE
761 ldap_grouping_create LDAP_P((
763 LDAP_CONST char *grpoid,
764 struct berval *grpdata,
765 LDAPControl **serverctrls,
766 LDAPControl **clientctrls,
770 ldap_grouping_create_s LDAP_P((
772 LDAP_CONST char *grpoid,
773 struct berval *grpdata,
774 LDAPControl **serverctrls,
775 LDAPControl **clientctrls,
776 struct berval **retgrpcookiep,
777 struct berval **retgrpdatap ));
780 ldap_parse_grouping_create_result LDAP_P((
783 struct berval **retgrpcookiep,
784 struct berval **retgrpdatap,
785 LDAPControl ***serverctrls,
789 ldap_grouping_end LDAP_P((
791 LDAP_CONST char *grpoid,
792 struct berval *grpdata,
793 LDAPControl **serverctrls,
794 LDAPControl **clientctrls,
798 ldap_grouping_end_s LDAP_P((
800 LDAP_CONST char *grpoid,
801 struct berval *grpdata,
802 LDAPControl **serverctrls,
803 LDAPControl **clientctrls,
804 struct berval **retgrpdatap ));
807 ldap_parse_grouping_end_result LDAP_P((
810 struct berval **retgrpdatap,
811 LDAPControl ***serverctrls,
815 ldap_grouping_action_operation LDAP_P((
817 LDAP_CONST char *grpoid,
818 struct berval *grpdata,
819 LDAPControl **serverctrls,
820 LDAPControl **clientctrls,
824 ldap_grouping_action_operation_s LDAP_P((
826 LDAP_CONST char *grpoid,
827 struct berval *grpdata,
828 LDAPControl **serverctrls,
829 LDAPControl **clientctrls,
830 struct berval **retgrpcookiep,
831 struct berval **retgrpdatap ));
834 ldap_parse_grouping_action_result LDAP_P((
837 struct berval **retgrpcookiep,
838 struct berval **retgrpdatap,
839 LDAPControl ***serverctrls,
843 ldap_parse_grouping_end_notice LDAP_P((
846 struct berval **retdatap,
847 struct berval **retgrpcookiep,
848 struct berval **retgrpdatap,
852 ldap_parse_grouping_info_notice LDAP_P((
855 struct berval **retdatap,
856 struct berval **retgrpcookiep,
857 struct berval **retgrpdatap,
865 ldap_abandon_ext LDAP_P((
868 LDAPControl **serverctrls,
869 LDAPControl **clientctrls ));
873 ldap_abandon LDAP_P(( /* deprecated */
883 ldap_add_ext LDAP_P((
887 LDAPControl **serverctrls,
888 LDAPControl **clientctrls,
892 ldap_add_ext_s LDAP_P((
896 LDAPControl **serverctrls,
897 LDAPControl **clientctrls ));
901 ldap_add LDAP_P(( /* deprecated */
907 ldap_add_s LDAP_P(( /* deprecated */
918 ldap_sasl_bind LDAP_P((
921 LDAP_CONST char *mechanism,
923 LDAPControl **serverctrls,
924 LDAPControl **clientctrls,
927 /* Interaction flags (should be passed about in a control)
928 * Automatic (default): use defaults, prompt otherwise
929 * Interactive: prompt always
930 * Quiet: never prompt
932 #define LDAP_SASL_AUTOMATIC 0U
933 #define LDAP_SASL_INTERACTIVE 1U
934 #define LDAP_SASL_QUIET 2U
937 * V3 SASL Interaction Function Callback Prototype
938 * when using Cyrus SASL, interact is pointer to sasl_interact_t
939 * should likely passed in a control (and provided controls)
941 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
942 LDAP *ld, unsigned flags, void* defaults, void *interact ));
945 ldap_sasl_interactive_bind_s LDAP_P((
947 LDAP_CONST char *dn, /* usually NULL */
948 LDAP_CONST char *saslMechanism,
949 LDAPControl **serverControls,
950 LDAPControl **clientControls,
952 /* should be client controls */
954 LDAP_SASL_INTERACT_PROC *proc,
958 ldap_sasl_bind_s LDAP_P((
961 LDAP_CONST char *mechanism,
963 LDAPControl **serverctrls,
964 LDAPControl **clientctrls,
965 struct berval **servercredp ));
968 ldap_parse_sasl_bind_result LDAP_P((
971 struct berval **servercredp,
980 ldap_bind LDAP_P(( /* deprecated */
982 LDAP_CONST char *who,
983 LDAP_CONST char *passwd,
987 ldap_bind_s LDAP_P(( /* deprecated */
989 LDAP_CONST char *who,
990 LDAP_CONST char *cred,
997 ldap_simple_bind LDAP_P(( /* deprecated */
999 LDAP_CONST char *who,
1000 LDAP_CONST char *passwd ));
1003 ldap_simple_bind_s LDAP_P(( /* deprecated */
1005 LDAP_CONST char *who,
1006 LDAP_CONST char *passwd ));
1014 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1016 LDAP_CONST char *who ));
1019 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1021 LDAP_CONST char *who ));
1024 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1026 LDAP_CONST char *who ));
1029 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1031 LDAP_CONST char *who ));
1034 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1036 LDAP_CONST char *who ));
1044 ldap_compare_ext LDAP_P((
1046 LDAP_CONST char *dn,
1047 LDAP_CONST char *attr,
1048 struct berval *bvalue,
1049 LDAPControl **serverctrls,
1050 LDAPControl **clientctrls,
1054 ldap_compare_ext_s LDAP_P((
1056 LDAP_CONST char *dn,
1057 LDAP_CONST char *attr,
1058 struct berval *bvalue,
1059 LDAPControl **serverctrls,
1060 LDAPControl **clientctrls ));
1064 ldap_compare LDAP_P(( /* deprecated */
1066 LDAP_CONST char *dn,
1067 LDAP_CONST char *attr,
1068 LDAP_CONST char *value ));
1071 ldap_compare_s LDAP_P(( /* deprecated */
1073 LDAP_CONST char *dn,
1074 LDAP_CONST char *attr,
1075 LDAP_CONST char *value ));
1083 ldap_delete_ext LDAP_P((
1085 LDAP_CONST char *dn,
1086 LDAPControl **serverctrls,
1087 LDAPControl **clientctrls,
1091 ldap_delete_ext_s LDAP_P((
1093 LDAP_CONST char *dn,
1094 LDAPControl **serverctrls,
1095 LDAPControl **clientctrls ));
1099 ldap_delete LDAP_P(( /* deprecated */
1101 LDAP_CONST char *dn ));
1104 ldap_delete_s LDAP_P(( /* deprecated */
1106 LDAP_CONST char *dn ));
1114 ldap_parse_result LDAP_P((
1121 LDAPControl ***serverctrls,
1125 ldap_err2string LDAP_P((
1130 ldap_result2error LDAP_P(( /* deprecated */
1136 ldap_perror LDAP_P(( /* deprecated */
1138 LDAP_CONST char *s ));
1146 ldap_modify_ext LDAP_P((
1148 LDAP_CONST char *dn,
1150 LDAPControl **serverctrls,
1151 LDAPControl **clientctrls,
1155 ldap_modify_ext_s LDAP_P((
1157 LDAP_CONST char *dn,
1159 LDAPControl **serverctrls,
1160 LDAPControl **clientctrls ));
1164 ldap_modify LDAP_P(( /* deprecated */
1166 LDAP_CONST char *dn,
1170 ldap_modify_s LDAP_P(( /* deprecated */
1172 LDAP_CONST char *dn,
1181 ldap_rename LDAP_P((
1183 LDAP_CONST char *dn,
1184 LDAP_CONST char *newrdn,
1185 LDAP_CONST char *newSuperior,
1187 LDAPControl **sctrls,
1188 LDAPControl **cctrls,
1192 ldap_rename_s LDAP_P((
1194 LDAP_CONST char *dn,
1195 LDAP_CONST char *newrdn,
1196 LDAP_CONST char *newSuperior,
1198 LDAPControl **sctrls,
1199 LDAPControl **cctrls ));
1203 ldap_rename2 LDAP_P(( /* deprecated */
1205 LDAP_CONST char *dn,
1206 LDAP_CONST char *newrdn,
1207 LDAP_CONST char *newSuperior,
1208 int deleteoldrdn ));
1211 ldap_rename2_s LDAP_P(( /* deprecated */
1213 LDAP_CONST char *dn,
1214 LDAP_CONST char *newrdn,
1215 LDAP_CONST char *newSuperior,
1216 int deleteoldrdn ));
1219 ldap_modrdn LDAP_P(( /* deprecated */
1221 LDAP_CONST char *dn,
1222 LDAP_CONST char *newrdn ));
1225 ldap_modrdn_s LDAP_P(( /* deprecated */
1227 LDAP_CONST char *dn,
1228 LDAP_CONST char *newrdn ));
1231 ldap_modrdn2 LDAP_P(( /* deprecated */
1233 LDAP_CONST char *dn,
1234 LDAP_CONST char *newrdn,
1235 int deleteoldrdn ));
1238 ldap_modrdn2_s LDAP_P(( /* deprecated */
1240 LDAP_CONST char *dn,
1241 LDAP_CONST char *newrdn,
1251 ldap_init LDAP_P(( /* deprecated */
1252 LDAP_CONST char *host,
1256 ldap_open LDAP_P(( /* deprecated */
1257 LDAP_CONST char *host,
1262 ldap_create LDAP_P((
1266 ldap_initialize LDAP_P((
1268 LDAP_CONST char *url ));
1271 ldap_start_tls_s LDAP_P((
1273 LDAPControl **serverctrls,
1274 LDAPControl **clientctrls ));
1279 LDAP_F( LDAPMessage * )
1280 ldap_first_message LDAP_P((
1282 LDAPMessage *chain ));
1284 LDAP_F( LDAPMessage * )
1285 ldap_next_message LDAP_P((
1287 LDAPMessage *msg ));
1290 ldap_count_messages LDAP_P((
1292 LDAPMessage *chain ));
1297 LDAP_F( LDAPMessage * )
1298 ldap_first_reference LDAP_P((
1300 LDAPMessage *chain ));
1302 LDAP_F( LDAPMessage * )
1303 ldap_next_reference LDAP_P((
1305 LDAPMessage *ref ));
1308 ldap_count_references LDAP_P((
1310 LDAPMessage *chain ));
1313 ldap_parse_reference LDAP_P((
1317 LDAPControl ***serverctrls,
1324 LDAP_F( LDAPMessage * )
1325 ldap_first_entry LDAP_P((
1327 LDAPMessage *chain ));
1329 LDAP_F( LDAPMessage * )
1330 ldap_next_entry LDAP_P((
1332 LDAPMessage *entry ));
1335 ldap_count_entries LDAP_P((
1337 LDAPMessage *chain ));
1340 ldap_get_entry_controls LDAP_P((
1343 LDAPControl ***serverctrls));
1349 LDAP_F( LDAPMessage * )
1350 ldap_delete_result_entry LDAP_P((
1355 ldap_add_result_entry LDAP_P((
1364 ldap_get_dn LDAP_P((
1366 LDAPMessage *entry ));
1368 typedef struct ldap_ava {
1369 struct berval la_attr;
1370 struct berval la_value;
1372 #define LDAP_AVA_NULL 0x0000U
1373 #define LDAP_AVA_STRING 0x0001U
1374 #define LDAP_AVA_BINARY 0x0002U
1375 #define LDAP_AVA_NONPRINTABLE 0x0004U
1376 #define LDAP_AVA_FREE_ATTR 0x0010U
1377 #define LDAP_AVA_FREE_VALUE 0x0020U
1382 typedef LDAPAVA** LDAPRDN;
1383 typedef LDAPRDN* LDAPDN;
1386 #define LDAP_DN_FORMAT_LDAP 0x0000U
1387 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1388 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1389 #define LDAP_DN_FORMAT_DCE 0x0030U
1390 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1391 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1392 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1393 #define LDAP_DN_FORMAT_MASK 0x00F0U
1396 #define LDAP_DN_PRETTY 0x0100U
1397 #define LDAP_DN_SKIP 0x0200U
1398 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1399 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1400 #define LDAP_DN_PEDANTIC 0xF000U
1402 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1403 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1412 ldap_str2dn LDAP_P((
1413 LDAP_CONST char *str,
1424 ldap_dn2str LDAP_P((
1430 ldap_bv2rdn LDAP_P((
1437 ldap_str2rdn LDAP_P((
1438 LDAP_CONST char *str,
1444 ldap_rdn2bv LDAP_P((
1450 ldap_rdn2str LDAP_P((
1456 ldap_dn_normalize LDAP_P((
1457 LDAP_CONST char *in, unsigned iflags,
1458 char **out, unsigned oflags ));
1461 ldap_dn2ufn LDAP_P(( /* deprecated */
1462 LDAP_CONST char *dn ));
1465 ldap_explode_dn LDAP_P(( /* deprecated */
1466 LDAP_CONST char *dn,
1470 ldap_explode_rdn LDAP_P(( /* deprecated */
1471 LDAP_CONST char *rdn,
1474 typedef int LDAPDN_rewrite_func
1475 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1478 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1479 LDAPDN_rewrite_func *func, unsigned flags ));
1482 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1485 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1488 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1491 ldap_get_dn_ber LDAP_P((
1492 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1495 ldap_get_attribute_ber LDAP_P((
1496 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1497 struct berval **vals ));
1503 ldap_first_attribute LDAP_P((
1506 BerElement **ber ));
1509 ldap_next_attribute LDAP_P((
1518 LDAP_F( struct berval ** )
1519 ldap_get_values_len LDAP_P((
1522 LDAP_CONST char *target ));
1525 ldap_count_values_len LDAP_P((
1526 struct berval **vals ));
1529 ldap_value_free_len LDAP_P((
1530 struct berval **vals ));
1534 ldap_get_values LDAP_P(( /* deprecated */
1537 LDAP_CONST char *target ));
1540 ldap_count_values LDAP_P(( /* deprecated */
1544 ldap_value_free LDAP_P(( /* deprecated */
1552 ldap_result LDAP_P((
1556 struct timeval *timeout,
1557 LDAPMessage **result ));
1560 ldap_msgtype LDAP_P((
1568 ldap_msgfree LDAP_P((
1572 ldap_msgdelete LDAP_P((
1581 ldap_search_ext LDAP_P((
1583 LDAP_CONST char *base,
1585 LDAP_CONST char *filter,
1588 LDAPControl **serverctrls,
1589 LDAPControl **clientctrls,
1590 struct timeval *timeout,
1595 ldap_search_ext_s LDAP_P((
1597 LDAP_CONST char *base,
1599 LDAP_CONST char *filter,
1602 LDAPControl **serverctrls,
1603 LDAPControl **clientctrls,
1604 struct timeval *timeout,
1606 LDAPMessage **res ));
1610 ldap_search LDAP_P(( /* deprecated */
1612 LDAP_CONST char *base,
1614 LDAP_CONST char *filter,
1619 ldap_search_s LDAP_P(( /* deprecated */
1621 LDAP_CONST char *base,
1623 LDAP_CONST char *filter,
1626 LDAPMessage **res ));
1629 ldap_search_st LDAP_P(( /* deprecated */
1631 LDAP_CONST char *base,
1633 LDAP_CONST char *filter,
1636 struct timeval *timeout,
1637 LDAPMessage **res ));
1644 ldap_unbind_ext LDAP_P((
1646 LDAPControl **serverctrls,
1647 LDAPControl **clientctrls));
1650 ldap_unbind_ext_s LDAP_P((
1652 LDAPControl **serverctrls,
1653 LDAPControl **clientctrls));
1657 ldap_unbind LDAP_P(( /* deprecated */
1661 ldap_unbind_s LDAP_P(( /* deprecated */
1669 ldap_put_vrFilter LDAP_P((
1678 ldap_memalloc LDAP_P((
1682 ldap_memrealloc LDAP_P((
1687 ldap_memcalloc LDAP_P((
1692 ldap_memfree LDAP_P((
1696 ldap_memvfree LDAP_P((
1700 ldap_strdup LDAP_P((
1701 LDAP_CONST char * ));
1704 ldap_mods_free LDAP_P((
1711 * in sort.c (deprecated)
1713 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1714 LDAP_CONST char *left,
1715 LDAP_CONST char *right ));
1717 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1718 LDAP_CONST void *left,
1719 LDAP_CONST void *right ));
1721 LDAP_F( int ) /* deprecated */
1722 ldap_sort_entries LDAP_P(( LDAP *ld,
1723 LDAPMessage **chain,
1724 LDAP_CONST char *attr,
1725 LDAP_SORT_AD_CMP_PROC *cmp ));
1727 LDAP_F( int ) /* deprecated */
1728 ldap_sort_values LDAP_P((
1731 LDAP_SORT_AV_CMP_PROC *cmp ));
1733 LDAP_F( int ) /* deprecated */
1734 ldap_sort_strcasecmp LDAP_P((
1736 LDAP_CONST void *b ));
1743 ldap_is_ldap_url LDAP_P((
1744 LDAP_CONST char *url ));
1747 ldap_is_ldaps_url LDAP_P((
1748 LDAP_CONST char *url ));
1751 ldap_is_ldapi_url LDAP_P((
1752 LDAP_CONST char *url ));
1755 ldap_url_parse LDAP_P((
1756 LDAP_CONST char *url,
1757 LDAPURLDesc **ludpp ));
1760 ldap_url_desc2str LDAP_P((
1761 LDAPURLDesc *ludp ));
1764 ldap_free_urldesc LDAP_P((
1765 LDAPURLDesc *ludp ));
1769 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1772 #define LDAP_API_FEATURE_CANCEL 1000
1775 ldap_cancel LDAP_P(( LDAP *ld,
1777 LDAPControl **sctrls,
1778 LDAPControl **cctrls,
1782 ldap_cancel_s LDAP_P((
1785 LDAPControl **sctrl,
1786 LDAPControl **cctrl ));
1789 * LDAP Server Side Sort
1792 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1794 /* structure for a sort-key */
1795 typedef struct ldapsortkey {
1796 char * attributeType;
1797 char * orderingRule;
1802 ldap_create_sort_keylist LDAP_P((
1803 LDAPSortKey ***sortKeyList,
1807 ldap_free_sort_keylist LDAP_P((
1808 LDAPSortKey **sortkeylist ));
1811 ldap_create_sort_control LDAP_P((
1813 LDAPSortKey **keyList,
1815 LDAPControl **ctrlp ));
1818 ldap_parse_sort_control LDAP_P((
1820 LDAPControl **ctrlp,
1821 unsigned long *result,
1822 char **attribute ));
1826 * LDAP Virtual List View
1829 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1831 /* structure for virtual list */
1832 typedef struct ldapvlvinfo {
1834 unsigned long ldvlv_before_count;
1835 unsigned long ldvlv_after_count;
1836 unsigned long ldvlv_offset;
1837 unsigned long ldvlv_count;
1838 struct berval * ldvlv_attrvalue;
1839 struct berval * ldvlv_context;
1840 void * ldvlv_extradata;
1844 ldap_create_vlv_control LDAP_P((
1846 LDAPVLVInfo *ldvlistp,
1847 LDAPControl **ctrlp ));
1850 ldap_parse_vlv_control LDAP_P((
1852 LDAPControl **ctrls,
1853 unsigned long *target_posp,
1854 unsigned long *list_countp,
1855 struct berval **contextp,
1862 #ifdef LDAP_GROUPING_TRANSACTION
1864 ldap_parse_txn_create LDAP_P((
1867 struct berval **cookie ));
1870 ldap_txn_create LDAP_P((
1872 LDAPControl **sctrls,
1873 LDAPControl **cctrls,
1877 ldap_txn_create_s LDAP_P((
1879 struct berval **cookie,
1880 LDAPControl **sctrls,
1881 LDAPControl **cctrls ));
1884 ldap_txn_end LDAP_P((
1886 struct berval *cookie,
1888 LDAPControl **sctrls,
1889 LDAPControl **cctrls,
1893 ldap_txn_end_s LDAP_P((
1895 struct berval *cookie,
1897 LDAPControl **sctrls,
1898 LDAPControl **cctrls ));
1905 #define LDAP_API_FEATURE_WHOAMI 1000
1908 ldap_parse_whoami LDAP_P((
1911 struct berval **authzid ));
1914 ldap_whoami LDAP_P(( LDAP *ld,
1915 LDAPControl **sctrls,
1916 LDAPControl **cctrls,
1920 ldap_whoami_s LDAP_P((
1922 struct berval **authzid,
1923 LDAPControl **sctrls,
1924 LDAPControl **cctrls ));
1927 * LDAP Password Modify
1930 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
1933 ldap_parse_passwd LDAP_P((
1936 struct berval *newpasswd ));
1939 ldap_passwd LDAP_P(( LDAP *ld,
1940 struct berval *user,
1941 struct berval *oldpw,
1942 struct berval *newpw,
1943 LDAPControl **sctrls,
1944 LDAPControl **cctrls,
1948 ldap_passwd_s LDAP_P((
1950 struct berval *user,
1951 struct berval *oldpw,
1952 struct berval *newpw,
1953 struct berval *newpasswd,
1954 LDAPControl **sctrls,
1955 LDAPControl **cctrls ));
1957 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
1959 * LDAP Password Policy controls
1962 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
1964 typedef enum passpolicyerror_enum {
1965 PP_passwordExpired = 0,
1966 PP_accountLocked = 1,
1967 PP_changeAfterReset = 2,
1968 PP_passwordModNotAllowed = 3,
1969 PP_mustSupplyOldPassword = 4,
1970 PP_insufficientPasswordQuality = 5,
1971 PP_passwordTooShort = 6,
1972 PP_passwordTooYoung = 7,
1973 PP_passwordInHistory = 8,
1975 } LDAPPasswordPolicyError;
1978 ldap_create_passwordpolicy_control LDAP_P((
1980 LDAPControl **ctrlp ));
1983 ldap_parse_passwordpolicy_control LDAP_P((
1988 LDAPPasswordPolicyError *errorp ));
1990 LDAP_F( const char * )
1991 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
1992 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
1995 #endif /* _LDAP_H */