3 * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms are permitted only
7 * as authorized by the OpenLDAP Public License. A copy of this
8 * license is available at http://www.OpenLDAP.org/license.html or
9 * in file LICENSE in the top-level directory of the distribution.
12 * Copyright (c) 1990 Regents of the University of Michigan.
13 * All rights reserved.
15 * Redistribution and use in source and binary forms are permitted
16 * provided that this notice is preserved and that due credit is given
17 * to the University of Michigan at Ann Arbor. The name of the University
18 * may not be used to endorse or promote products derived from this
19 * software without specific prior written permission. This software
20 * is provided ``as is'' without express or implied warranty.
31 #define LDAP_VERSION1 1
32 #define LDAP_VERSION2 2
33 #define LDAP_VERSION3 3
35 #define LDAP_VERSION_MIN LDAP_VERSION2
36 #define LDAP_VERSION LDAP_VERSION2
37 #define LDAP_VERSION_MAX LDAP_VERSION3
40 * We'll use 2000+draft revision for our API version number
41 * As such, the number will be above the old RFC but below
42 * whatever number does finally get assigned
44 #define LDAP_API_VERSION 2004
45 #define LDAP_VENDOR_NAME "OpenLDAP"
46 /* We'll eventually release as 200 */
47 #define LDAP_VENDOR_VERSION 194
49 /* OpenLDAP API Features */
50 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
52 /* include LDAP_API_FEATURE defines */
53 #include <ldap_features.h>
55 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
56 ( defined( LDAP_THREAD_SAFE ) && \
57 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
58 /* -lldap may or may not be thread safe */
59 /* -lldap_r, if available, is always thread safe */
60 # define LDAP_API_FEATURE_THREAD_SAFE 1
62 #if defined( LDAP_THREAD_SAFE ) && \
63 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
64 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
65 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
68 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
69 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
71 #define LDAP_ROOT_DSE ""
72 #define LDAP_NO_ATTRS "1.1"
73 #define LDAP_ALL_USER_ATTRIBUTES "*"
74 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
77 * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
78 * 0x0000 - 0x0fff reserved for api options
79 * 0x1000 - 0x3fff reserved for api extended options
80 * 0x4000 - 0x7fff reserved for private and experimental options
82 #define LDAP_OPT_API_INFO 0x0000
83 #define LDAP_OPT_DESC 0x0001 /* deprecated */
84 #define LDAP_OPT_DEREF 0x0002
85 #define LDAP_OPT_SIZELIMIT 0x0003
86 #define LDAP_OPT_TIMELIMIT 0x0004
87 /* 0x05 - 0x07 not defined by current draft */
88 #define LDAP_OPT_REFERRALS 0x0008
89 #define LDAP_OPT_RESTART 0x0009
90 /* 0x0a - 0x10 not defined by current draft */
91 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
92 #define LDAP_OPT_SERVER_CONTROLS 0x0012
93 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
94 /* 0x14 not defined by current draft */
95 #define LDAP_OPT_API_FEATURE_INFO 0x0015
97 /* 0x16 - 0x2f not defined by current draft */
98 #define LDAP_OPT_HOST_NAME 0x0030
99 #define LDAP_OPT_ERROR_NUMBER 0x0031
100 #define LDAP_OPT_ERROR_STRING 0x0032
101 #define LDAP_OPT_MATCHED_DN 0x0033
103 /* 0x34 - 0x0fff not defined by current draft */
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_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
113 #define LDAP_OPT_URI 0x5006
116 #define LDAP_OPT_X_TLS_CACERTFILE 0x6001
117 #define LDAP_OPT_X_TLS_CACERTDIR 0x6002
118 #define LDAP_OPT_X_TLS_CERT 0x6003
119 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
120 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
121 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
122 #define LDAP_OPT_X_TLS 0x6007
123 #define LDAP_OPT_X_TLS_PROTOCOL 0x6008
124 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6009
126 #define LDAP_OPT_X_TLS_NEVER 0
127 #define LDAP_OPT_X_TLS_HARD 1
128 #define LDAP_OPT_X_TLS_DEMAND 2
129 #define LDAP_OPT_X_TLS_ALLOW 3
130 #define LDAP_OPT_X_TLS_TRY 4
133 #define LDAP_OPT_ON ((void *) 1)
134 #define LDAP_OPT_OFF ((void *) 0)
136 #define LDAP_OPT_SUCCESS 0
137 #define LDAP_OPT_ERROR (-1)
139 #define LDAP_API_INFO_VERSION (1)
140 typedef struct ldapapiinfo {
141 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
142 int ldapai_api_version; /* revision of API supported */
143 int ldapai_protocol_version; /* highest LDAP version supported */
144 char **ldapai_extensions; /* names of API extensions */
145 char *ldapai_vendor_name; /* name of supplier */
146 int ldapai_vendor_version; /* supplier-specific version * 100 */
149 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
150 typedef struct ldap_apifeature_info {
151 int ldapaif_info_version; /* version of this struct (1) */
152 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
153 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
154 } LDAPAPIFeatureInfo;
156 typedef struct ldapcontrol {
158 struct berval ldctl_value;
159 char ldctl_iscritical;
163 /* chase referrals controls */
164 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
165 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
166 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
168 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
170 /* Experimental Controls */
171 #define LDAP_CONTROL_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.5.1"
173 /* LDAP Unsolicited Notifications */
174 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
175 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
178 /* LDAP Extended Operations */
179 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
181 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
182 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
183 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
184 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
185 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
188 * specific LDAP instantiations of BER types we know about
191 /* Overview of LBER tag construction
198 * 1 0 = CONTEXT-SPECIFIC
205 * | 5 ... 1 | TAG-NUMBER
209 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
210 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
211 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octect string */
212 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octect string */
213 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
214 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
216 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
218 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
219 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
220 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
221 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
223 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
226 /* possible operations a client can invoke */
227 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
228 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
229 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
230 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
231 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
232 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
233 #define LDAP_REQ_MODRDN ((ber_tag_t) 0x6cU) /* application + constructed */
234 #define LDAP_REQ_MODDN LDAP_REQ_MODRDN
235 #define LDAP_REQ_RENAME LDAP_REQ_MODRDN
236 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
237 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
238 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
240 /* possible result types a server can return */
241 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
242 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
243 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
244 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
245 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
246 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
247 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
248 #define LDAP_RES_MODRDN ((ber_tag_t) 0x6dU) /* application + constructed */
249 #define LDAP_RES_MODDN LDAP_RES_MODRDN /* application + constructed */
250 #define LDAP_RES_RENAME LDAP_RES_MODRDN /* application + constructed */
251 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
252 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
253 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
255 #define LDAP_RES_ANY ((ber_tag_t)(-1))
256 #define LDAP_RES_UNSOLICITED ((ber_tag_t)(0))
260 #define LDAP_SASL_SIMPLE NULL
262 /* authentication methods available */
263 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
264 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
265 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + primitive */
266 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
267 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
268 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
272 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
273 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
274 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
275 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
276 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
277 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
278 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
279 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
280 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
281 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
283 /* extended filter component types */
284 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
285 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
286 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
287 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
289 /* substring filter component types */
290 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
291 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
292 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
295 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
296 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
297 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
299 /* substring filter component types */
300 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
301 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
302 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
305 * possible error codes we can return
308 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
310 #define LDAP_SUCCESS 0x00
311 #define LDAP_OPERATIONS_ERROR 0x01
312 #define LDAP_PROTOCOL_ERROR 0x02
313 #define LDAP_TIMELIMIT_EXCEEDED 0x03
314 #define LDAP_SIZELIMIT_EXCEEDED 0x04
315 #define LDAP_COMPARE_FALSE 0x05
316 #define LDAP_COMPARE_TRUE 0x06
317 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
318 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
319 #define LDAP_STRONG_AUTH_REQUIRED 0x08
320 #define LDAP_PARTIAL_RESULTS 0x09 /* not listed in v3 */
322 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
323 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
324 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
325 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
326 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
328 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
330 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
331 #define LDAP_UNDEFINED_TYPE 0x11
332 #define LDAP_INAPPROPRIATE_MATCHING 0x12
333 #define LDAP_CONSTRAINT_VIOLATION 0x13
334 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
335 #define LDAP_INVALID_SYNTAX 0x15
337 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
339 #define LDAP_NO_SUCH_OBJECT 0x20
340 #define LDAP_ALIAS_PROBLEM 0x21
341 #define LDAP_INVALID_DN_SYNTAX 0x22
342 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
343 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
345 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
347 #define LDAP_INAPPROPRIATE_AUTH 0x30
348 #define LDAP_INVALID_CREDENTIALS 0x31
349 #define LDAP_INSUFFICIENT_ACCESS 0x32
351 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
353 #define LDAP_BUSY 0x33
354 #define LDAP_UNAVAILABLE 0x34
355 #define LDAP_UNWILLING_TO_PERFORM 0x35
356 #define LDAP_LOOP_DETECT 0x36
358 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
360 #define LDAP_NAMING_VIOLATION 0x40
361 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
362 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
363 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
364 #define LDAP_ALREADY_EXISTS 0x44
365 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
366 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
367 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
369 #define LDAP_OTHER 0x50
371 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0xff) /* 81+ */
373 #define LDAP_SERVER_DOWN 0x51
374 #define LDAP_LOCAL_ERROR 0x52
375 #define LDAP_ENCODING_ERROR 0x53
376 #define LDAP_DECODING_ERROR 0x54
377 #define LDAP_TIMEOUT 0x55
378 #define LDAP_AUTH_UNKNOWN 0x56
379 #define LDAP_FILTER_ERROR 0x57
380 #define LDAP_USER_CANCELLED 0x58
381 #define LDAP_PARAM_ERROR 0x59
382 #define LDAP_NO_MEMORY 0x5a
384 #define LDAP_CONNECT_ERROR 0x5b /* new */
385 #define LDAP_NOT_SUPPORTED 0x5c /* new */
386 #define LDAP_CONTROL_NOT_FOUND 0x5d /* new */
387 #define LDAP_NO_RESULTS_RETURNED 0x5e /* new */
388 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* new */
389 #define LDAP_CLIENT_LOOP 0x60 /* new */
390 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* new */
393 * This structure represents both ldap messages and ldap responses.
394 * These are really the same, except in the case of search responses,
395 * where a response has multiple messages.
398 typedef struct ldapmsg LDAPMessage;
400 /* for modifications */
401 typedef struct ldapmod {
404 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
405 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
406 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
407 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
408 /* IMPORTANT: do not use code 0x1000 (or above),
409 * it is used internally by the backends!
410 * (see ldap/servers/slapd/slap.h)
416 struct berval **modv_bvals;
418 #define mod_values mod_vals.modv_strvals
419 #define mod_bvalues mod_vals.modv_bvals
423 * structures for ldap getfilter routines
426 typedef struct ldap_filt_info {
431 struct ldap_filt_info *lfi_next;
434 typedef struct ldap_filt_list {
438 LDAPFiltInfo *lfl_ilist;
439 struct ldap_filt_list *lfl_next;
443 #define LDAP_FILT_MAXSIZ 1024
445 typedef struct ldap_filt_desc {
446 LDAPFiltList *lfd_filtlist;
447 LDAPFiltInfo *lfd_curfip;
448 LDAPFiltInfo lfd_retfi;
449 char lfd_filter[ LDAP_FILT_MAXSIZ ];
451 char *lfd_curvalcopy;
452 char **lfd_curvalwords;
453 char *lfd_filtprefix;
454 char *lfd_filtsuffix;
459 * structure representing an ldap session which can
460 * encompass connections to multiple servers (in the
461 * face of referrals).
463 typedef struct ldap LDAP;
465 #define LDAP_DEREF_NEVER 0x00
466 #define LDAP_DEREF_SEARCHING 0x01
467 #define LDAP_DEREF_FINDING 0x02
468 #define LDAP_DEREF_ALWAYS 0x03
470 #define LDAP_NO_LIMIT 0
472 /* how many messages to retrieve results for */
473 #define LDAP_MSG_ONE 0x00
474 #define LDAP_MSG_ALL 0x01
475 #define LDAP_MSG_RECEIVED 0x02
478 * structure for ldap friendly mapping routines
481 typedef struct ldap_friendly {
487 * types for ldap URL handling
489 typedef struct ldap_url_desc {
490 struct ldap_url_desc *lud_next;
491 unsigned long lud_properties;
503 #define LDAP_URL_USE_SSL 0x00000001
506 #define LDAP_PROTO_TCP 0x00
507 #define LDAP_PROTO_UDP 0x01
508 #define LDAP_PROTO_LOCAL 0x02
510 #define LDAP_URL_SUCCESS 0x00 /* Success */
511 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
512 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
514 #define LDAP_URL_ERR_NOTLDAP 0x03 /* URL doesn't begin with "ldap[s]://" */
515 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
516 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
517 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
518 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
519 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
520 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
521 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
524 * The API draft spec says we should declare (or cause to be declared)
525 * 'struct timeval'. We don't. See IETF LDAPext discussions.
533 ldap_get_option LDAP_P((
539 ldap_set_option LDAP_P((
542 LDAP_CONST void *invalue));
549 ldap_control_free LDAP_P((
550 LDAPControl *ctrl ));
553 ldap_controls_free LDAP_P((
554 LDAPControl **ctrls ));
560 ldap_dnssrv_init LDAP_P((
562 LDAP_CONST char *domain ));
568 ldap_extended_operation LDAP_P((
570 LDAP_CONST char *reqoid,
571 struct berval *reqdata,
572 LDAPControl **serverctrls,
573 LDAPControl **clientctrls,
577 ldap_extended_operation_s LDAP_P((
579 LDAP_CONST char *reqoid,
580 struct berval *reqdata,
581 LDAPControl **serverctrls,
582 LDAPControl **clientctrls,
584 struct berval **retdatap ));
587 ldap_parse_extended_result LDAP_P((
591 struct berval **retdatap,
598 ldap_abandon LDAP_P((
603 ldap_abandon_ext LDAP_P((
606 LDAPControl **serverctrls,
607 LDAPControl **clientctrls ));
614 ldap_add_ext LDAP_P((
618 LDAPControl **serverctrls,
619 LDAPControl **clientctrls,
623 ldap_add_ext_s LDAP_P((
627 LDAPControl **serverctrls,
628 LDAPControl **clientctrls ));
647 ldap_sasl_bind LDAP_P((
650 LDAP_CONST char *mechanism,
652 LDAPControl **serverctrls,
653 LDAPControl **clientctrls,
657 ldap_negotiated_sasl_bind_s LDAP_P((
659 LDAP_CONST char *dn, /* usually NULL */
660 LDAP_CONST char *authorizationId,
661 LDAP_CONST char *authenticationId, /* usually NULL */
662 LDAP_CONST char *saslMechanism,
663 struct berval *passPhrase,
664 LDAPControl **serverControls,
665 LDAPControl **clientControls ));
668 ldap_sasl_bind_s LDAP_P((
671 LDAP_CONST char *mechanism,
673 LDAPControl **serverctrls,
674 LDAPControl **clientctrls,
675 struct berval **servercredp ));
678 ldap_parse_sasl_bind_result LDAP_P((
681 struct berval **servercredp,
691 LDAP_CONST char *who,
692 LDAP_CONST char *passwd,
698 LDAP_CONST char *who,
699 LDAP_CONST char *cred,
703 ldap_set_rebind_proc LDAP_P((
705 int (*rebindproc) LDAP_P((
717 ldap_simple_bind LDAP_P((
719 LDAP_CONST char *who,
720 LDAP_CONST char *passwd ));
723 ldap_simple_bind_s LDAP_P((
725 LDAP_CONST char *who,
726 LDAP_CONST char *passwd ));
734 ldap_kerberos_bind_s LDAP_P((
736 LDAP_CONST char *who ));
739 ldap_kerberos_bind1 LDAP_P((
741 LDAP_CONST char *who ));
744 ldap_kerberos_bind1_s LDAP_P((
746 LDAP_CONST char *who ));
749 ldap_kerberos_bind2 LDAP_P((
751 LDAP_CONST char *who ));
754 ldap_kerberos_bind2_s LDAP_P((
756 LDAP_CONST char *who ));
763 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
766 ldap_disable_cache LDAP_P(( LDAP *ld ));
769 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
772 ldap_destroy_cache LDAP_P(( LDAP *ld ));
775 ldap_flush_cache LDAP_P(( LDAP *ld ));
778 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
781 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
788 ldap_compare_ext LDAP_P((
791 LDAP_CONST char *attr,
792 struct berval *bvalue,
793 LDAPControl **serverctrls,
794 LDAPControl **clientctrls,
798 ldap_compare_ext_s LDAP_P((
801 LDAP_CONST char *attr,
802 struct berval *bvalue,
803 LDAPControl **serverctrls,
804 LDAPControl **clientctrls ));
807 ldap_compare LDAP_P((
810 LDAP_CONST char *attr,
811 LDAP_CONST char *value ));
814 ldap_compare_s LDAP_P((
817 LDAP_CONST char *attr,
818 LDAP_CONST char *value ));
825 ldap_delete_ext LDAP_P((
828 LDAPControl **serverctrls,
829 LDAPControl **clientctrls,
833 ldap_delete_ext_s LDAP_P((
836 LDAPControl **serverctrls,
837 LDAPControl **clientctrls ));
842 LDAP_CONST char *dn ));
845 ldap_delete_s LDAP_P((
847 LDAP_CONST char *dn ));
854 ldap_parse_result LDAP_P((
861 LDAPControl ***serverctrls,
865 ldap_err2string LDAP_P((
869 ldap_result2error LDAP_P(( /* deprecated */
875 ldap_perror LDAP_P(( /* deprecated */
877 LDAP_CONST char *s ));
884 ldap_modify_ext LDAP_P((
888 LDAPControl **serverctrls,
889 LDAPControl **clientctrls,
893 ldap_modify_ext_s LDAP_P((
897 LDAPControl **serverctrls,
898 LDAPControl **clientctrls ));
907 ldap_modify_s LDAP_P((
920 LDAP_CONST char *newrdn,
921 LDAP_CONST char *newSuperior,
923 LDAPControl **sctrls,
924 LDAPControl **cctrls,
928 ldap_rename_s LDAP_P((
931 LDAP_CONST char *newrdn,
932 LDAP_CONST char *newSuperior,
934 LDAPControl **sctrls,
935 LDAPControl **cctrls ));
938 ldap_rename_ext LDAP_P((
941 LDAP_CONST char *newrdn,
942 LDAP_CONST char *newparent,
944 LDAPControl **serverctrls,
945 LDAPControl **clientctrls,
949 ldap_rename_ext_s LDAP_P((
952 LDAP_CONST char *newrdn,
953 LDAP_CONST char *newparent,
955 LDAPControl **serverctrls,
956 LDAPControl **clientctrls ));
959 ldap_rename2 LDAP_P((
962 LDAP_CONST char *newrdn,
963 LDAP_CONST char *newSuperior,
967 ldap_rename2_s LDAP_P((
970 LDAP_CONST char *newrdn,
971 LDAP_CONST char *newSuperior,
978 LDAP_CONST char *newrdn ));
981 ldap_modrdn_s LDAP_P((
984 LDAP_CONST char *newrdn ));
987 ldap_modrdn2 LDAP_P((
990 LDAP_CONST char *newrdn,
994 ldap_modrdn2_s LDAP_P((
997 LDAP_CONST char *newrdn,
1006 LDAP_CONST char *host,
1011 LDAP_CONST char *host,
1015 ldap_create LDAP_P((
1019 ldap_initialize LDAP_P((
1021 LDAP_CONST char *url ));
1024 ldap_start_tls LDAP_P((
1026 LDAPControl **serverctrls,
1027 LDAPControl **clientctrls ));
1032 LIBLDAP_F( LDAPMessage *)
1033 ldap_first_message LDAP_P((
1035 LDAPMessage *chain ));
1037 LIBLDAP_F( LDAPMessage *)
1038 ldap_next_message LDAP_P((
1040 LDAPMessage *msg ));
1043 ldap_count_messages LDAP_P((
1045 LDAPMessage *chain ));
1051 LIBLDAP_F( LDAPMessage *)
1052 ldap_first_reference LDAP_P((
1054 LDAPMessage *chain ));
1056 LIBLDAP_F( LDAPMessage *)
1057 ldap_next_reference LDAP_P((
1059 LDAPMessage *ref ));
1062 ldap_count_references LDAP_P((
1064 LDAPMessage *chain ));
1067 ldap_parse_reference LDAP_P((
1071 LDAPControl ***serverctrls,
1078 LIBLDAP_F( LDAPMessage *)
1079 ldap_first_entry LDAP_P((
1081 LDAPMessage *chain ));
1083 LIBLDAP_F( LDAPMessage *)
1084 ldap_next_entry LDAP_P((
1086 LDAPMessage *entry ));
1089 ldap_count_entries LDAP_P((
1091 LDAPMessage *chain ));
1094 ldap_get_entry_controls LDAP_P((
1097 LDAPControl ***serverctrls));
1103 LIBLDAP_F( LDAPMessage *)
1104 ldap_delete_result_entry LDAP_P((
1109 ldap_add_result_entry LDAP_P((
1118 ldap_get_dn LDAP_P((
1120 LDAPMessage *entry ));
1123 ldap_dn2ufn LDAP_P((
1124 LDAP_CONST char *dn ));
1126 LIBLDAP_F( char ** )
1127 ldap_explode_dn LDAP_P((
1128 LDAP_CONST char *dn,
1131 LIBLDAP_F( char ** )
1132 ldap_explode_rdn LDAP_P((
1133 LDAP_CONST char *rdn,
1137 ldap_parent_dn LDAP_P((
1138 LDAP_CONST char *dn ));
1141 ldap_relative_dn LDAP_P((
1142 LDAP_CONST char *dn ));
1145 ldap_normalize_dn LDAP_P((
1146 LDAP_CONST char *dn ));
1148 LIBLDAP_F( char ** )
1149 ldap_explode_dns LDAP_P(( /* deprecated */
1150 LDAP_CONST char *dn ));
1153 ldap_is_dns_dn LDAP_P(( /* deprecated */
1154 LDAP_CONST char *dn ));
1157 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn ));
1160 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce ));
1166 ldap_first_attribute LDAP_P((
1169 BerElement **ber ));
1172 ldap_next_attribute LDAP_P((
1182 ldap_get_values LDAP_P((
1185 LDAP_CONST char *target ));
1187 LIBLDAP_F( struct berval **)
1188 ldap_get_values_len LDAP_P((
1191 LDAP_CONST char *target ));
1194 ldap_count_values LDAP_P((
1198 ldap_count_values_len LDAP_P((
1199 struct berval **vals ));
1202 ldap_value_free LDAP_P((
1206 ldap_value_free_len LDAP_P((
1207 struct berval **vals ));
1213 ldap_result LDAP_P((
1217 struct timeval *timeout,
1218 LDAPMessage **result ));
1221 ldap_msgtype LDAP_P((
1229 ldap_msgfree LDAP_P((
1233 ldap_msgdelete LDAP_P((
1242 ldap_search_ext LDAP_P((
1244 LDAP_CONST char *base,
1246 LDAP_CONST char *filter,
1249 LDAPControl **serverctrls,
1250 LDAPControl **clientctrls,
1251 struct timeval *timeout,
1256 ldap_search_ext_s LDAP_P((
1258 LDAP_CONST char *base,
1260 LDAP_CONST char *filter,
1263 LDAPControl **serverctrls,
1264 LDAPControl **clientctrls,
1265 struct timeval *timeout,
1267 LDAPMessage **res ));
1270 ldap_search LDAP_P((
1272 LDAP_CONST char *base,
1274 LDAP_CONST char *filter,
1279 ldap_search_s LDAP_P((
1281 LDAP_CONST char *base,
1283 LDAP_CONST char *filter,
1286 LDAPMessage **res ));
1289 ldap_search_st LDAP_P((
1291 LDAP_CONST char *base,
1293 LDAP_CONST char *filter,
1296 struct timeval *timeout,
1297 LDAPMessage **res ));
1304 ldap_ufn_search_c LDAP_P((
1306 LDAP_CONST char *ufn,
1310 int (*cancelproc)( void *cl ),
1311 void *cancelparm ));
1314 ldap_ufn_search_ct LDAP_P((
1316 LDAP_CONST char *ufn,
1320 int (*cancelproc)( void *cl ),
1327 ldap_ufn_search_s LDAP_P((
1329 LDAP_CONST char *ufn,
1332 LDAPMessage **res ));
1334 LIBLDAP_F( LDAPFiltDesc *)
1335 ldap_ufn_setfilter LDAP_P((
1337 LDAP_CONST char *fname ));
1340 ldap_ufn_setprefix LDAP_P((
1342 LDAP_CONST char *prefix ));
1345 ldap_ufn_timeout LDAP_P((
1353 ldap_unbind LDAP_P((
1357 ldap_unbind_s LDAP_P((
1361 ldap_unbind_ext LDAP_P((
1363 LDAPControl **serverctrls,
1364 LDAPControl **clientctrls));
1367 ldap_unbind_ext_s LDAP_P((
1369 LDAPControl **serverctrls,
1370 LDAPControl **clientctrls));
1375 LIBLDAP_F( LDAPFiltDesc *)
1376 ldap_init_getfilter LDAP_P((
1377 LDAP_CONST char *fname ));
1379 LIBLDAP_F( LDAPFiltDesc *)
1380 ldap_init_getfilter_buf LDAP_P((
1381 /* LDAP_CONST */ char *buf,
1382 ber_len_t buflen ));
1384 LIBLDAP_F( LDAPFiltInfo *)
1385 ldap_getfirstfilter LDAP_P((
1387 /* LDAP_CONST */ char *tagpat,
1388 /* LDAP_CONST */ char *value ));
1390 LIBLDAP_F( LDAPFiltInfo *)
1391 ldap_getnextfilter LDAP_P((
1392 LDAPFiltDesc *lfdp ));
1395 ldap_setfilteraffixes LDAP_P((
1397 LDAP_CONST char *prefix,
1398 LDAP_CONST char *suffix ));
1401 ldap_build_filter LDAP_P((
1404 LDAP_CONST char *pattern,
1405 LDAP_CONST char *prefix,
1406 LDAP_CONST char *suffix,
1407 LDAP_CONST char *attr,
1408 LDAP_CONST char *value,
1417 ldap_memalloc LDAP_P((
1421 ldap_memrealloc LDAP_P((
1426 ldap_memcalloc LDAP_P((
1431 ldap_memfree LDAP_P((
1435 ldap_memvfree LDAP_P((
1439 ldap_strdup LDAP_P((
1440 LDAP_CONST char * ));
1443 ldap_getfilter_free LDAP_P((
1444 LDAPFiltDesc *lfdp ));
1447 ldap_mods_free LDAP_P((
1456 ldap_friendly_name LDAP_P((
1457 LDAP_CONST char *filename,
1458 /* LDAP_CONST */ char *uname,
1459 LDAPFriendlyMap **map ));
1462 ldap_free_friendlymap LDAP_P((
1463 LDAPFriendlyMap **map ));
1471 LDAP_CONST char *host,
1475 cldap_close LDAP_P((
1479 cldap_search_s LDAP_P(( LDAP *ld,
1480 LDAP_CONST char *base,
1482 LDAP_CONST char *filter,
1489 cldap_setretryinfo LDAP_P((
1499 ldap_sort_entries LDAP_P(( LDAP *ld,
1500 LDAPMessage **chain,
1501 LDAP_CONST char *attr,
1502 int (*cmp) (LDAP_CONST char *, LDAP_CONST char *) ));
1505 ldap_sort_values LDAP_P((
1508 int (*cmp) (LDAP_CONST void *, LDAP_CONST void *) ));
1511 ldap_sort_strcasecmp LDAP_P((
1513 LDAP_CONST void *b ));
1519 * need _ext varients
1522 ldap_is_ldap_url LDAP_P((
1523 LDAP_CONST char *url ));
1526 ldap_is_ldaps_url LDAP_P((
1527 LDAP_CONST char *url ));
1530 ldap_url_parse LDAP_P((
1531 LDAP_CONST char *url,
1532 LDAPURLDesc **ludpp ));
1535 ldap_free_urldesc LDAP_P((
1536 LDAPURLDesc *ludp ));
1539 ldap_url_search LDAP_P((
1541 LDAP_CONST char *url,
1545 ldap_url_search_s LDAP_P((
1547 LDAP_CONST char *url,
1549 LDAPMessage **res ));
1552 ldap_url_search_st LDAP_P((
1554 LDAP_CONST char *url,
1556 struct timeval *timeout,
1557 LDAPMessage **res ));
1565 ldap_set_string_translators LDAP_P((
1567 BERTranslateProc encode_proc,
1568 BERTranslateProc decode_proc ));
1571 ldap_translate_from_t61 LDAP_P((
1578 ldap_translate_to_t61 LDAP_P((
1585 ldap_enable_translation LDAP_P((
1591 ldap_t61_to_8859 LDAP_P((
1597 ldap_8859_to_t61 LDAP_P((
1604 #endif /* _LDAP_H */