2 * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
5 * Redistribution and use in source and binary forms are permitted only
6 * as authorized by the OpenLDAP Public License. A copy of this
7 * license is available at http://www.OpenLDAP.org/license.html or
8 * in file LICENSE in the top-level directory of the distribution.
11 * Copyright (c) 1990 Regents of the University of Michigan.
12 * All rights reserved.
14 * Redistribution and use in source and binary forms are permitted
15 * provided that this notice is preserved and that due credit is given
16 * to the University of Michigan at Ann Arbor. The name of the University
17 * may not be used to endorse or promote products derived from this
18 * software without specific prior written permission. This software
19 * is provided ``as is'' without express or implied warranty.
25 #include <ldap_cdefs.h>
27 /* draft spec requires ldap.h include lber declarations */
32 #define LDAP_VERSION1 1
33 #define LDAP_VERSION2 2
34 #define LDAP_VERSION3 3
36 #define LDAP_VERSION_MIN LDAP_VERSION2
37 #define LDAP_VERSION LDAP_VERSION2
38 #define LDAP_VERSION_MAX LDAP_VERSION3
41 * We'll use 2000+draft revision for our API version number
42 * As such, the number will be above the old RFC but below
43 * whatever number does finally get assigned
45 #define LDAP_API_VERSION 2003
46 #define LDAP_VENDOR_NAME "OpenLDAP"
47 /* We'll eventually release as 200 */
48 #define LDAP_VENDOR_VERSION 192
50 /* OpenLDAP API Features */
51 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
53 /* include LDAP_API_FEATURE defines */
54 #include <ldap_features.h>
56 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
57 ( defined( LDAP_THREAD_SAFE ) && \
58 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
59 /* -lldap may or may not be thread safe */
60 /* -lldap_r, if available, is always thread safe */
61 # define LDAP_API_FEATURE_THREAD_SAFE 1
63 #if defined( LDAP_THREAD_SAFE ) && \
64 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
65 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
66 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
71 #define LDAP_ROOT_DSE ""
72 #define LDAP_NO_ATTRS "1.1"
73 #define LDAP_ALL_USER_ATTRIBUTES "*"
76 * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
77 * 0x0000 - 0x0fff reserved for api options
78 * 0x1000 - 0x3fff reserved for api extended options
79 * 0x4000 - 0x7fff reserved for private and experimental options
81 #define LDAP_OPT_API_INFO 0x0000
82 #define LDAP_OPT_DESC 0x0001
83 #define LDAP_OPT_DEREF 0x0002
84 #define LDAP_OPT_SIZELIMIT 0x0003
85 #define LDAP_OPT_TIMELIMIT 0x0004
86 /* 0x05 - 0x07 not defined by current draft */
87 #define LDAP_OPT_REFERRALS 0x0008
88 #define LDAP_OPT_RESTART 0x0009
89 /* 0x0a - 0x10 not defined by current draft */
90 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
91 #define LDAP_OPT_SERVER_CONTROLS 0x0012
92 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
93 /* 0x14 not defined by current draft */
94 #define LDAP_OPT_API_FEATURE_INFO 0x0015
96 /* 0x16 - 0x2f not defined by current draft */
97 #define LDAP_OPT_HOST_NAME 0x0030
98 #define LDAP_OPT_ERROR_NUMBER 0x0031
99 #define LDAP_OPT_ERROR_STRING 0x0032
101 /* 0x33 - 0x0fff not defined by current draft */
103 /* extended options - none */
105 /* private and experimental options */
106 #define LDAP_OPT_DNS 0x4001 /* use DN & DNS */
108 /* OpenLDAP specific options */
109 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
110 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
111 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
112 #define LDAP_OPT_MATCHED_DN 0x5004 /* should have been in draft */
115 #define LDAP_OPT_ON ((void *) 1)
116 #define LDAP_OPT_OFF ((void *) 0)
118 #define LDAP_OPT_SUCCESS 0
119 #define LDAP_OPT_ERROR (-1)
121 #define LDAP_API_INFO_VERSION (1)
122 typedef struct ldapapiinfo {
123 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
124 int ldapai_api_version; /* revision of API supported */
125 int ldapai_protocol_version; /* highest LDAP version supported */
126 char **ldapai_extensions; /* names of API extensions */
127 char *ldapai_vendor_name; /* name of supplier */
128 int ldapai_vendor_version; /* supplier-specific version * 100 */
131 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
132 typedef struct ldap_apifeature_info {
133 int ldapaif_info_version; /* version of this struct (1) */
134 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
135 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
136 } LDAPAPIFeatureInfo;
138 typedef struct ldapcontrol {
140 struct berval ldctl_value;
141 char ldctl_iscritical;
144 /* LDAP "Standard" Controls */
146 /* chase referrals controls */
147 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
148 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020
149 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040
151 /* LDAP "Extension" Controls */
153 /* LDAP "Private/Experiemental" Controls */
157 * specific LDAP instantiations of BER types we know about
160 /* Overview of LBER tag construction
167 * 1 0 = CONTEXT-SPECIFIC
174 * | 5 ... 1 | TAG-NUMBER
178 #define LDAP_TAG_MESSAGE (ber_tag_t) 0x30U /* constructed + 16 */
179 #define OLD_LDAP_TAG_MESSAGE (ber_tag_t) 0x10U /* forgot the constructed bit */
180 #define LDAP_TAG_MSGID (ber_tag_t) 0x02U /* integer */
181 #define LDAP_TAG_LDAPDN (ber_tag_t) 0x04U /* octect string */
182 #define LDAP_TAG_CONTROLS (ber_tag_t) 0xa0U /* context specific + constructed + 0 */
183 #define LDAP_TAG_REFERRAL (ber_tag_t) 0xa3U /* context specific + constructed + 3 */
185 #define LDAP_TAG_NEWSUPERIOR (ber_tag_t) 0x80U /* context-specific + primitive + 0 */
187 #define LDAP_TAG_EXOP_REQ_OID (ber_tag_t) 0x80U /* context specific + primitive */
188 #define LDAP_TAG_EXOP_REQ_VALUE (ber_tag_t) 0x81U /* context specific + primitive */
189 #define LDAP_TAG_EXOP_RES_OID (ber_tag_t) 0x8aU /* context specific + primitive */
190 #define LDAP_TAG_EXOP_RES_VALUE (ber_tag_t) 0x8bU /* context specific + primitive */
192 #define LDAP_TAG_SASL_RES_CREDS (ber_tag_t) 0x87U /* context specific + primitive */
197 /* possible operations a client can invoke */
198 #define LDAP_REQ_BIND (ber_tag_t) 0x60U /* application + constructed */
199 #define LDAP_REQ_UNBIND (ber_tag_t) 0x42U /* application + primitive */
200 #define LDAP_REQ_SEARCH (ber_tag_t) 0x63U /* application + constructed */
201 #define LDAP_REQ_MODIFY (ber_tag_t) 0x66U /* application + constructed */
202 #define LDAP_REQ_ADD (ber_tag_t) 0x68U /* application + constructed */
203 #define LDAP_REQ_DELETE (ber_tag_t) 0x4aU /* application + primitive */
204 #define LDAP_REQ_MODRDN (ber_tag_t) 0x6cU /* application + constructed */
205 #define LDAP_REQ_MODDN LDAP_REQ_MODRDN
206 #define LDAP_REQ_RENAME LDAP_REQ_MODRDN
207 #define LDAP_REQ_COMPARE (ber_tag_t) 0x6eU /* application + constructed */
208 #define LDAP_REQ_ABANDON (ber_tag_t) 0x50U /* application + primitive */
209 #define LDAP_REQ_EXTENDED (ber_tag_t) 0x77U /* application + constructed */
211 /* U-Mich version 3.0 compatibility stuff */
212 #define LDAP_REQ_UNBIND_30 (ber_tag_t) 0x62U
213 #define LDAP_REQ_DELETE_30 (ber_tag_t) 0x6aU
214 #define LDAP_REQ_ABANDON_30 (ber_tag_t) 0x70U
217 * old broken stuff for backwards compatibility - forgot application tag
218 * and constructed/primitive bit
220 #define OLD_LDAP_REQ_BIND (ber_tag_t) 0x00U
221 #define OLD_LDAP_REQ_UNBIND (ber_tag_t) 0x02U
222 #define OLD_LDAP_REQ_SEARCH (ber_tag_t) 0x03U
223 #define OLD_LDAP_REQ_MODIFY (ber_tag_t) 0x06U
224 #define OLD_LDAP_REQ_ADD (ber_tag_t) 0x08U
225 #define OLD_LDAP_REQ_DELETE (ber_tag_t) 0x0aU
226 #define OLD_LDAP_REQ_MODRDN (ber_tag_t) 0x0cU
227 #define OLD_LDAP_REQ_COMPARE (ber_tag_t) 0x0eU
228 #define OLD_LDAP_REQ_ABANDON (ber_tag_t) 0x10U
230 /* possible result types a server can return */
231 #define LDAP_RES_BIND (ber_tag_t) 0x61U /* application + constructed */
232 #define LDAP_RES_SEARCH_ENTRY (ber_tag_t) 0x64U /* application + constructed */
233 #define LDAP_RES_SEARCH_REFERENCE (ber_tag_t) 0x73U /* V3: application + constructed */
234 #define LDAP_RES_SEARCH_RESULT (ber_tag_t) 0x65U /* application + constructed */
235 #define LDAP_RES_MODIFY (ber_tag_t) 0x67U /* application + constructed */
236 #define LDAP_RES_ADD (ber_tag_t) 0x69U /* application + constructed */
237 #define LDAP_RES_DELETE (ber_tag_t) 0x6bU /* application + constructed */
238 #define LDAP_RES_MODRDN (ber_tag_t) 0x6dU /* application + constructed */
239 #define LDAP_RES_MODDN LDAP_RES_MODRDN /* application + constructed */
240 #define LDAP_RES_RENAME LDAP_RES_MODRDN /* application + constructed */
241 #define LDAP_RES_COMPARE (ber_tag_t) 0x6fU /* application + constructed */
242 #define LDAP_RES_EXTENDED (ber_tag_t) 0x78U /* V3: application + constructed */
243 #define LDAP_RES_ANY ((ber_tag_t)(~0))
245 /* old broken stuff for backwards compatibility */
246 #define OLD_LDAP_RES_BIND (ber_tag_t) 0x01UL
247 #define OLD_LDAP_RES_SEARCH_ENTRY (ber_tag_t) 0x04UL
248 #define OLD_LDAP_RES_SEARCH_RESULT (ber_tag_t) 0x05U
249 #define OLD_LDAP_RES_MODIFY (ber_tag_t) 0x07U
250 #define OLD_LDAP_RES_ADD (ber_tag_t) 0x09U
251 #define OLD_LDAP_RES_DELETE (ber_tag_t) 0x0bU
252 #define OLD_LDAP_RES_MODRDN (ber_tag_t) 0x0dU
253 #define OLD_LDAP_RES_MODDN OLD_LDAP_RES_MODRDN
254 #define OLD_LDAP_RES_COMPARE (ber_tag_t) 0x0fU
257 #define LDAP_SASL_SIMPLE NULL
259 /* authentication methods available */
260 #define LDAP_AUTH_NONE (ber_tag_t) 0x00U /* no authentication */
261 #define LDAP_AUTH_SIMPLE (ber_tag_t) 0x80U /* context specific + primitive */
262 #define LDAP_AUTH_SASL (ber_tag_t) 0xa3U /* context specific + primitive */
263 #define LDAP_AUTH_KRBV4 (ber_tag_t) 0xffU /* means do both of the following */
264 #define LDAP_AUTH_KRBV41 (ber_tag_t) 0x81U /* context specific + primitive */
265 #define LDAP_AUTH_KRBV42 (ber_tag_t) 0x82U /* context specific + primitive */
267 /* U-Mich version 3.0 compatibility auth methods */
268 #define LDAP_AUTH_SIMPLE_30 (ber_tag_t) 0xa0U /* context specific + constructed */
269 #define LDAP_AUTH_KRBV41_30 (ber_tag_t) 0xa1U /* context specific + constructed */
270 #define LDAP_AUTH_KRBV42_30 (ber_tag_t) 0xa2U /* context specific + constructed */
272 /* old broken stuff */
273 #define OLD_LDAP_AUTH_SIMPLE (ber_tag_t) 0x00U
274 #define OLD_LDAP_AUTH_KRBV4 (ber_tag_t) 0x01U
275 #define OLD_LDAP_AUTH_KRBV42 (ber_tag_t) 0x02U
278 #define LDAP_FILTER_AND (ber_tag_t) 0xa0U /* context specific + constructed */
279 #define LDAP_FILTER_OR (ber_tag_t) 0xa1U /* context specific + constructed */
280 #define LDAP_FILTER_NOT (ber_tag_t) 0xa2U /* context specific + constructed */
281 #define LDAP_FILTER_EQUALITY (ber_tag_t) 0xa3U /* context specific + constructed */
282 #define LDAP_FILTER_SUBSTRINGS (ber_tag_t) 0xa4U /* context specific + constructed */
283 #define LDAP_FILTER_GE (ber_tag_t) 0xa5U /* context specific + constructed */
284 #define LDAP_FILTER_LE (ber_tag_t) 0xa6U /* context specific + constructed */
285 #define LDAP_FILTER_PRESENT (ber_tag_t) 0x87U /* context specific + primitive */
286 #define LDAP_FILTER_APPROX (ber_tag_t) 0xa8U /* context specific + constructed */
287 #define LDAP_FILTER_EXTENDED (ber_tag_t) 0xa9U /* context specific + constructed */
289 /* U-Mich version 3.0 compatibility filter types */
290 #define LDAP_FILTER_PRESENT_30 (ber_tag_t) 0xa7U /* context specific + constructed */
292 /* old broken stuff */
293 #define OLD_LDAP_FILTER_AND (ber_tag_t) 0x00U
294 #define OLD_LDAP_FILTER_OR (ber_tag_t) 0x01U
295 #define OLD_LDAP_FILTER_NOT (ber_tag_t) 0x02U
296 #define OLD_LDAP_FILTER_EQUALITY (ber_tag_t) 0x03U
297 #define OLD_LDAP_FILTER_SUBSTRINGS (ber_tag_t) 0x04U
298 #define OLD_LDAP_FILTER_GE (ber_tag_t) 0x05U
299 #define OLD_LDAP_FILTER_LE (ber_tag_t) 0x06U
300 #define OLD_LDAP_FILTER_PRESENT (ber_tag_t) 0x07U
301 #define OLD_LDAP_FILTER_APPROX (ber_tag_t) 0x08U
303 /* extended filter component types */
304 #define LDAP_FILTER_EXTENDED_OID (ber_tag_t) 0x81U /* context specific */
305 #define LDAP_FILTER_EXTENDED_TYPE (ber_tag_t) 0x82U /* context specific */
306 #define LDAP_FILTER_EXTENDED_VALUE (ber_tag_t) 0x83U /* context specific */
307 #define LDAP_FILTER_EXTENDED_DNATTRS (ber_tag_t) 0x84U /* context specific */
309 /* substring filter component types */
310 #define LDAP_SUBSTRING_INITIAL (ber_tag_t) 0x80U /* context specific */
311 #define LDAP_SUBSTRING_ANY (ber_tag_t) 0x81U /* context specific */
312 #define LDAP_SUBSTRING_FINAL (ber_tag_t) 0x82U /* context specific */
314 /* U-Mich version 3.0 compatibility substring filter component types */
315 #define LDAP_SUBSTRING_INITIAL_30 (ber_tag_t) 0xa0U /* context specific */
316 #define LDAP_SUBSTRING_ANY_30 (ber_tag_t) 0xa1U /* context specific */
317 #define LDAP_SUBSTRING_FINAL_30 (ber_tag_t) 0xa2U /* context specific */
319 /* old broken stuff */
320 #define OLD_LDAP_SUBSTRING_INITIAL (ber_tag_t) 0x00U
321 #define OLD_LDAP_SUBSTRING_ANY (ber_tag_t) 0x01U
322 #define OLD_LDAP_SUBSTRING_FINAL (ber_tag_t) 0x02U
325 #define LDAP_SCOPE_BASE (ber_int_t) 0x0000
326 #define LDAP_SCOPE_ONELEVEL (ber_int_t) 0x0001
327 #define LDAP_SCOPE_SUBTREE (ber_int_t) 0x0002
329 /* for modifications */
330 typedef struct ldapmod {
332 #define LDAP_MOD_ADD (ber_int_t) 0x0000
333 #define LDAP_MOD_DELETE (ber_int_t) 0x0001
334 #define LDAP_MOD_REPLACE (ber_int_t) 0x0002
335 #define LDAP_MOD_BVALUES (ber_int_t) 0x0080
336 /* IMPORTANT: do not use code 0x1000 (or above),
337 * it is used internally by the backends!
338 * (see ldap/servers/slapd/slap.h)
339 * JCG 05/1999 (gomez@engr.sgi.com)
344 struct berval **modv_bvals;
346 #define mod_values mod_vals.modv_strvals
347 #define mod_bvalues mod_vals.modv_bvals
351 * possible error codes we can return
354 #define LDAP_SUCCESS 0x00
355 #define LDAP_OPERATIONS_ERROR 0x01
356 #define LDAP_PROTOCOL_ERROR 0x02
357 #define LDAP_TIMELIMIT_EXCEEDED 0x03
358 #define LDAP_SIZELIMIT_EXCEEDED 0x04
359 #define LDAP_COMPARE_FALSE 0x05
360 #define LDAP_COMPARE_TRUE 0x06
361 #define LDAP_STRONG_AUTH_NOT_SUPPORTED 0x07
362 #define LDAP_AUTH_METHOD_NOT_SUPPORTED LDAP_STRONG_AUTH_NOT_SUPPORTED
363 #define LDAP_STRONG_AUTH_REQUIRED 0x08
364 #define LDAP_PARTIAL_RESULTS 0x09 /* not listed in v3 */
366 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
367 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
368 #define LDAP_UNAVAILABLE_CRITICIAL_EXTENSION 0x0c /* LDAPv3 */
369 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
370 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
372 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
373 #define LDAP_UNDEFINED_TYPE 0x11
374 #define LDAP_INAPPROPRIATE_MATCHING 0x12
375 #define LDAP_CONSTRAINT_VIOLATION 0x13
376 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
377 #define LDAP_INVALID_SYNTAX 0x15
379 #define LDAP_NO_SUCH_OBJECT 0x20
380 #define LDAP_ALIAS_PROBLEM 0x21
381 #define LDAP_INVALID_DN_SYNTAX 0x22
382 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
383 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
385 #define LDAP_NAME_ERROR(n) (((int)(n) & 0x00f0) == 0x0020)
387 #define LDAP_INAPPROPRIATE_AUTH 0x30
388 #define LDAP_INVALID_CREDENTIALS 0x31
389 #define LDAP_INSUFFICIENT_ACCESS 0x32
390 #define LDAP_BUSY 0x33
391 #define LDAP_UNAVAILABLE 0x34
392 #define LDAP_UNWILLING_TO_PERFORM 0x35
393 #define LDAP_LOOP_DETECT 0x36
395 #define LDAP_NAMING_VIOLATION 0x40
396 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
397 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
398 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
399 #define LDAP_ALREADY_EXISTS 0x44
400 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
401 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
402 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
404 #define LDAP_OTHER 0x50
405 #define LDAP_SERVER_DOWN 0x51
406 #define LDAP_LOCAL_ERROR 0x52
407 #define LDAP_ENCODING_ERROR 0x53
408 #define LDAP_DECODING_ERROR 0x54
409 #define LDAP_TIMEOUT 0x55
410 #define LDAP_AUTH_UNKNOWN 0x56
411 #define LDAP_FILTER_ERROR 0x57
412 #define LDAP_USER_CANCELLED 0x58
413 #define LDAP_PARAM_ERROR 0x59
414 #define LDAP_NO_MEMORY 0x5a
416 #define LDAP_CONNECT_ERROR 0x5b /* new */
417 #define LDAP_NOT_SUPPORTED 0x5c /* new */
418 #define LDAP_CONTROL_NOT_FOUND 0x5d /* new */
419 #define LDAP_NO_RESULTS_RETURNED 0x5e /* new */
420 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* new */
421 #define LDAP_CLIENT_LOOP 0x60 /* new */
422 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* new */
425 * This structure represents both ldap messages and ldap responses.
426 * These are really the same, except in the case of search responses,
427 * where a response has multiple messages.
430 typedef struct ldapmsg LDAPMessage;
433 * structures for ldap getfilter routines
436 typedef struct ldap_filt_info {
439 int lfi_scope; /* LDAP_SCOPE_BASE, etc */
440 int lfi_isexact; /* exact match filter? */
441 struct ldap_filt_info *lfi_next;
444 typedef struct ldap_filt_list {
448 LDAPFiltInfo *lfl_ilist;
449 struct ldap_filt_list *lfl_next;
453 #define LDAP_FILT_MAXSIZ 1024
455 typedef struct ldap_filt_desc {
456 LDAPFiltList *lfd_filtlist;
457 LDAPFiltInfo *lfd_curfip;
458 LDAPFiltInfo lfd_retfi;
459 char lfd_filter[ LDAP_FILT_MAXSIZ ];
461 char *lfd_curvalcopy;
462 char **lfd_curvalwords;
463 char *lfd_filtprefix;
464 char *lfd_filtsuffix;
469 * structure representing an ldap connection
472 typedef struct ldap LDAP;
474 #define LDAP_DEREF_NEVER 0x00
475 #define LDAP_DEREF_SEARCHING 0x01
476 #define LDAP_DEREF_FINDING 0x02
477 #define LDAP_DEREF_ALWAYS 0x03
479 #define LDAP_NO_LIMIT 0
481 /* how many messages to retrieve results for */
482 #define LDAP_MSG_ONE 0x00
483 #define LDAP_MSG_ALL 0x01
484 #define LDAP_MSG_RECEIVED 0x02
487 * structure for ldap friendly mapping routines
490 typedef struct ldap_friendly {
496 * types for ldap URL handling
498 typedef struct ldap_url_desc {
505 char *lud_string; /* for internal use only */
508 #define LDAP_URL_ERR_NOTLDAP 0x01 /* URL doesn't begin with "ldap://" */
509 #define LDAP_URL_ERR_NODN 0x02 /* URL has no DN (required) */
510 #define LDAP_URL_ERR_BADSCOPE 0x03 /* URL scope string is invalid */
511 #define LDAP_URL_ERR_MEM 0x04 /* can't allocate memory space */
514 * The API draft spec says we should declare (or cause to be declared)
515 * 'struct timeval'. We don't. See LDAPext discussions.
523 ldap_get_option LDAP_P((
529 ldap_set_option LDAP_P((
532 LDAP_CONST void *invalue));
539 ldap_control_free LDAP_P((
540 LDAPControl *ctrl ));
543 ldap_controls_free LDAP_P((
544 LDAPControl **ctrls ));
551 ldap_extended_operation LDAP_P((
553 LDAP_CONST char *reqoid,
554 struct berval *reqdata,
555 LDAPControl **serverctrls,
556 LDAPControl **clientctrls,
560 ldap_extended_operation_s LDAP_P((
562 LDAP_CONST char *reqoid,
563 struct berval *reqdata,
564 LDAPControl **serverctrls,
565 LDAPControl **clientctrls,
567 struct berval **retdatap ));
570 ldap_parse_extended_result LDAP_P((
574 struct berval **retdatap,
581 ldap_abandon LDAP_P((
586 ldap_abandon_ext LDAP_P((
589 LDAPControl **serverctrls,
590 LDAPControl **clientctrls ));
597 ldap_add_ext LDAP_P((
601 LDAPControl **serverctrls,
602 LDAPControl **clientctrls,
606 ldap_add_ext_s LDAP_P((
610 LDAPControl **serverctrls,
611 LDAPControl **clientctrls ));
630 ldap_sasl_bind LDAP_P((
633 LDAP_CONST char *mechanism,
635 LDAPControl **serverctrls,
636 LDAPControl **clientctrls,
640 ldap_sasl_bind_s LDAP_P((
643 LDAP_CONST char *mechanism,
645 LDAPControl **serverctrls,
646 LDAPControl **clientctrls,
647 struct berval **servercredp ));
650 ldap_parse_sasl_bind_result LDAP_P((
653 struct berval **servercredp,
663 LDAP_CONST char *who,
664 LDAP_CONST char *passwd,
670 LDAP_CONST char *who,
671 LDAP_CONST char *cred,
675 ldap_set_rebind_proc LDAP_P((
677 int (*rebindproc) LDAP_P((
689 ldap_simple_bind LDAP_P((
691 LDAP_CONST char *who,
692 LDAP_CONST char *passwd ));
695 ldap_simple_bind_s LDAP_P((
697 LDAP_CONST char *who,
698 LDAP_CONST char *passwd ));
706 ldap_kerberos_bind_s LDAP_P((
708 LDAP_CONST char *who ));
711 ldap_kerberos_bind1 LDAP_P((
713 LDAP_CONST char *who ));
716 ldap_kerberos_bind1_s LDAP_P((
718 LDAP_CONST char *who ));
721 ldap_kerberos_bind2 LDAP_P((
723 LDAP_CONST char *who ));
726 ldap_kerberos_bind2_s LDAP_P((
728 LDAP_CONST char *who ));
735 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
738 ldap_disable_cache LDAP_P(( LDAP *ld ));
741 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
744 ldap_destroy_cache LDAP_P(( LDAP *ld ));
747 ldap_flush_cache LDAP_P(( LDAP *ld ));
750 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
753 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
760 ldap_compare_ext LDAP_P((
763 LDAP_CONST char *attr,
764 struct berval *bvalue,
765 LDAPControl **serverctrls,
766 LDAPControl **clientctrls,
770 ldap_compare_ext_s LDAP_P((
773 LDAP_CONST char *attr,
774 struct berval *bvalue,
775 LDAPControl **serverctrls,
776 LDAPControl **clientctrls ));
779 ldap_compare LDAP_P((
782 LDAP_CONST char *attr,
783 LDAP_CONST char *value ));
786 ldap_compare_s LDAP_P((
789 LDAP_CONST char *attr,
790 LDAP_CONST char *value ));
797 ldap_delete_ext LDAP_P((
800 LDAPControl **serverctrls,
801 LDAPControl **clientctrls,
805 ldap_delete_ext_s LDAP_P((
808 LDAPControl **serverctrls,
809 LDAPControl **clientctrls ));
814 LDAP_CONST char *dn ));
817 ldap_delete_s LDAP_P((
819 LDAP_CONST char *dn ));
826 ldap_parse_result LDAP_P((
833 LDAPControl ***serverctrls,
837 ldap_err2string LDAP_P((
841 ldap_result2error LDAP_P(( /* deprecated */
847 ldap_perror LDAP_P(( /* deprecated */
849 LDAP_CONST char *s ));
856 ldap_modify_ext LDAP_P((
860 LDAPControl **serverctrls,
861 LDAPControl **clientctrls,
865 ldap_modify_ext_s LDAP_P((
869 LDAPControl **serverctrls,
870 LDAPControl **clientctrls ));
879 ldap_modify_s LDAP_P((
889 ldap_rename_ext LDAP_P((
892 LDAP_CONST char *newrdn,
893 LDAP_CONST char *newparent,
895 LDAPControl **serverctrls,
896 LDAPControl **clientctrls,
900 ldap_rename_ext_s LDAP_P((
903 LDAP_CONST char *newrdn,
904 LDAP_CONST char *newparent,
906 LDAPControl **serverctrls,
907 LDAPControl **clientctrls ));
910 ldap_rename2 LDAP_P((
913 LDAP_CONST char *newrdn,
915 LDAP_CONST char *newSuperior ));
918 ldap_rename2_s LDAP_P((
921 LDAP_CONST char *newrdn,
923 LDAP_CONST char *newSuperior));
929 LDAP_CONST char *newrdn ));
932 ldap_modrdn_s LDAP_P((
935 LDAP_CONST char *newrdn ));
938 ldap_modrdn2 LDAP_P((
941 LDAP_CONST char *newrdn,
945 ldap_modrdn2_s LDAP_P((
948 LDAP_CONST char *newrdn,
957 LDAP_CONST char *host,
962 LDAP_CONST char *host,
969 LDAP_F( LDAPMessage *)
970 ldap_first_message LDAP_P((
972 LDAPMessage *chain ));
974 LDAP_F( LDAPMessage *)
975 ldap_next_message LDAP_P((
980 ldap_count_messages LDAP_P((
982 LDAPMessage *chain ));
988 LDAP_F( LDAPMessage *)
989 ldap_first_reference LDAP_P((
991 LDAPMessage *chain ));
993 LDAP_F( LDAPMessage *)
994 ldap_next_reference LDAP_P((
999 ldap_count_references LDAP_P((
1001 LDAPMessage *chain ));
1004 ldap_parse_reference LDAP_P((
1008 LDAPControl ***serverctrls,
1015 LDAP_F( LDAPMessage *)
1016 ldap_first_entry LDAP_P((
1018 LDAPMessage *chain ));
1020 LDAP_F( LDAPMessage *)
1021 ldap_next_entry LDAP_P((
1023 LDAPMessage *entry ));
1026 ldap_count_entries LDAP_P((
1028 LDAPMessage *chain ));
1031 ldap_get_entry_controls LDAP_P((
1034 LDAPControl ***serverctrls));
1040 LDAP_F( LDAPMessage *)
1041 ldap_delete_result_entry LDAP_P((
1046 ldap_add_result_entry LDAP_P((
1055 ldap_get_dn LDAP_P((
1057 LDAPMessage *entry ));
1060 ldap_dn2ufn LDAP_P((
1061 LDAP_CONST char *dn ));
1064 ldap_explode_dn LDAP_P((
1065 LDAP_CONST char *dn,
1069 ldap_explode_rdn LDAP_P((
1070 LDAP_CONST char *rdn,
1074 ldap_parent_dn LDAP_P(( /* new (from slapd) */
1075 LDAP_CONST char *dn ));
1078 ldap_relative_dn LDAP_P(( /* new (from slapd) */
1079 LDAP_CONST char *dn ));
1082 ldap_normalize_dn LDAP_P(( /* new (from slapd) */
1083 LDAP_CONST char *dn ));
1086 ldap_explode_dns LDAP_P(( /* deprecated */
1087 LDAP_CONST char *dn ));
1090 ldap_is_dns_dn LDAP_P(( /* deprecated */
1091 LDAP_CONST char *dn ));
1098 ldap_first_attribute LDAP_P((
1101 BerElement **ber ));
1104 ldap_next_attribute LDAP_P((
1114 ldap_get_values LDAP_P((
1117 LDAP_CONST char *target ));
1119 LDAP_F( struct berval **)
1120 ldap_get_values_len LDAP_P((
1123 LDAP_CONST char *target ));
1126 ldap_count_values LDAP_P((
1130 ldap_count_values_len LDAP_P((
1131 struct berval **vals ));
1134 ldap_value_free LDAP_P((
1138 ldap_value_free_len LDAP_P((
1139 struct berval **vals ));
1145 ldap_result LDAP_P((
1149 struct timeval *timeout,
1150 LDAPMessage **result ));
1153 ldap_msgtype LDAP_P((
1161 ldap_msgfree LDAP_P((
1165 ldap_msgdelete LDAP_P((
1174 ldap_search_ext LDAP_P((
1176 LDAP_CONST char *base,
1178 LDAP_CONST char *filter,
1181 LDAPControl **serverctrls,
1182 LDAPControl **clientctrls,
1183 struct timeval *timeout,
1188 ldap_search_ext_s LDAP_P((
1190 LDAP_CONST char *base,
1192 LDAP_CONST char *filter,
1195 LDAPControl **serverctrls,
1196 LDAPControl **clientctrls,
1197 struct timeval *timeout,
1199 LDAPMessage **res ));
1202 ldap_search LDAP_P((
1204 LDAP_CONST char *base,
1206 LDAP_CONST char *filter,
1211 ldap_search_s LDAP_P((
1213 LDAP_CONST char *base,
1215 LDAP_CONST char *filter,
1218 LDAPMessage **res ));
1221 ldap_search_st LDAP_P((
1223 LDAP_CONST char *base,
1225 LDAP_CONST char *filter,
1228 struct timeval *timeout,
1229 LDAPMessage **res ));
1236 ldap_ufn_search_c LDAP_P((
1238 LDAP_CONST char *ufn,
1242 int (*cancelproc)( void *cl ),
1243 void *cancelparm ));
1246 ldap_ufn_search_ct LDAP_P((
1248 LDAP_CONST char *ufn,
1252 int (*cancelproc)( void *cl ),
1259 ldap_ufn_search_s LDAP_P((
1261 LDAP_CONST char *ufn,
1264 LDAPMessage **res ));
1266 LDAP_F( LDAPFiltDesc *)
1267 ldap_ufn_setfilter LDAP_P((
1269 LDAP_CONST char *fname ));
1272 ldap_ufn_setprefix LDAP_P((
1274 LDAP_CONST char *prefix ));
1277 ldap_ufn_timeout LDAP_P((
1285 ldap_unbind LDAP_P((
1289 ldap_unbind_s LDAP_P((
1293 ldap_unbind_ext LDAP_P((
1295 LDAPControl **serverctrls,
1296 LDAPControl **clientctrls));
1299 ldap_unbind_ext_s LDAP_P((
1301 LDAPControl **serverctrls,
1302 LDAPControl **clientctrls));
1307 LDAP_F( LDAPFiltDesc *)
1308 ldap_init_getfilter LDAP_P((
1309 LDAP_CONST char *fname ));
1311 LDAP_F( LDAPFiltDesc *)
1312 ldap_init_getfilter_buf LDAP_P((
1313 /* LDAP_CONST */ char *buf,
1314 ber_len_t buflen ));
1316 LDAP_F( LDAPFiltInfo *)
1317 ldap_getfirstfilter LDAP_P((
1319 /* LDAP_CONST */ char *tagpat,
1320 /* LDAP_CONST */ char *value ));
1322 LDAP_F( LDAPFiltInfo *)
1323 ldap_getnextfilter LDAP_P((
1324 LDAPFiltDesc *lfdp ));
1327 ldap_setfilteraffixes LDAP_P((
1329 LDAP_CONST char *prefix,
1330 LDAP_CONST char *suffix ));
1333 ldap_build_filter LDAP_P((
1336 LDAP_CONST char *pattern,
1337 LDAP_CONST char *prefix,
1338 LDAP_CONST char *suffix,
1339 LDAP_CONST char *attr,
1340 LDAP_CONST char *value,
1349 ldap_memalloc LDAP_P((
1353 ldap_memrealloc LDAP_P((
1358 ldap_memcalloc LDAP_P((
1363 ldap_memfree LDAP_P((
1367 ldap_memvfree LDAP_P((
1371 ldap_strdup LDAP_P((
1372 LDAP_CONST char * ));
1375 ldap_getfilter_free LDAP_P((
1376 LDAPFiltDesc *lfdp ));
1379 ldap_mods_free LDAP_P((
1388 ldap_friendly_name LDAP_P((
1389 LDAP_CONST char *filename,
1390 /* LDAP_CONST */ char *uname,
1391 LDAPFriendlyMap **map ));
1394 ldap_free_friendlymap LDAP_P((
1395 LDAPFriendlyMap **map ));
1403 LDAP_CONST char *host,
1407 cldap_close LDAP_P((
1411 cldap_search_s LDAP_P(( LDAP *ld,
1412 LDAP_CONST char *base,
1414 LDAP_CONST char *filter,
1421 cldap_setretryinfo LDAP_P((
1431 ldap_sort_entries LDAP_P(( LDAP *ld,
1432 LDAPMessage **chain,
1433 LDAP_CONST char *attr,
1434 int (*cmp) (LDAP_CONST char *, LDAP_CONST char *) ));
1437 ldap_sort_values LDAP_P((
1440 int (*cmp) (LDAP_CONST void *, LDAP_CONST void *) ));
1443 ldap_sort_strcasecmp LDAP_P((
1445 LDAP_CONST void *b ));
1451 * need _ext varients
1454 ldap_is_ldap_url LDAP_P((
1455 LDAP_CONST char *url ));
1458 ldap_url_parse LDAP_P((
1459 LDAP_CONST char *url,
1460 LDAPURLDesc **ludpp ));
1463 ldap_free_urldesc LDAP_P((
1464 LDAPURLDesc *ludp ));
1467 ldap_url_search LDAP_P((
1469 LDAP_CONST char *url,
1473 ldap_url_search_s LDAP_P((
1475 LDAP_CONST char *url,
1477 LDAPMessage **res ));
1480 ldap_url_search_st LDAP_P((
1482 LDAP_CONST char *url,
1484 struct timeval *timeout,
1485 LDAPMessage **res ));
1493 ldap_set_string_translators LDAP_P((
1495 BERTranslateProc encode_proc,
1496 BERTranslateProc decode_proc ));
1499 ldap_translate_from_t61 LDAP_P((
1506 ldap_translate_to_t61 LDAP_P((
1513 ldap_enable_translation LDAP_P((
1519 ldap_t61_to_8859 LDAP_P((
1525 ldap_8859_to_t61 LDAP_P((
1532 #endif /* _LDAP_H */