3 * Copyright 1998-2000 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 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */
107 /* private and experimental options */
108 #define LDAP_OPT_DNS 0x4001 /* use DN & DNS */
110 /* OpenLDAP specific options */
111 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
112 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
113 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
114 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
115 #define LDAP_OPT_URI 0x5006
117 /* OpenLDAP TLS options */
118 #define LDAP_OPT_X_TLS_CACERTFILE 0x6001
119 #define LDAP_OPT_X_TLS_CACERTDIR 0x6002
120 #define LDAP_OPT_X_TLS_CERT 0x6003
121 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
122 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
123 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
124 #define LDAP_OPT_X_TLS 0x6007
125 #define LDAP_OPT_X_TLS_PROTOCOL 0x6008
126 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6009
128 #define LDAP_OPT_X_TLS_NEVER 0
129 #define LDAP_OPT_X_TLS_HARD 1
130 #define LDAP_OPT_X_TLS_DEMAND 2
131 #define LDAP_OPT_X_TLS_ALLOW 3
132 #define LDAP_OPT_X_TLS_TRY 4
134 /* OpenLDAP SASL options */
135 #define LDAP_OPT_X_SASL_MINSSF 0x6100
136 #define LDAP_OPT_X_SASL_MAXSSF 0x6101
137 #define LDAP_OPT_X_SASL_ACTSSF 0x6102
140 #define LDAP_OPT_ON ((void *) 1)
141 #define LDAP_OPT_OFF ((void *) 0)
143 #define LDAP_OPT_SUCCESS 0
144 #define LDAP_OPT_ERROR (-1)
146 #define LDAP_API_INFO_VERSION (1)
147 typedef struct ldapapiinfo {
148 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
149 int ldapai_api_version; /* revision of API supported */
150 int ldapai_protocol_version; /* highest LDAP version supported */
151 char **ldapai_extensions; /* names of API extensions */
152 char *ldapai_vendor_name; /* name of supplier */
153 int ldapai_vendor_version; /* supplier-specific version * 100 */
156 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
157 typedef struct ldap_apifeature_info {
158 int ldapaif_info_version; /* version of this struct (1) */
159 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
160 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
161 } LDAPAPIFeatureInfo;
163 typedef struct ldapcontrol {
165 struct berval ldctl_value;
166 char ldctl_iscritical;
170 /* chase referrals controls */
171 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
172 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
173 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
175 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
177 /* Experimental Controls */
178 #define LDAP_CONTROL_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.5.1"
180 /* LDAP Unsolicited Notifications */
181 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
182 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
185 /* LDAP Extended Operations */
186 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
188 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
189 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
190 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
191 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
192 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
195 * specific LDAP instantiations of BER types we know about
198 /* Overview of LBER tag construction
205 * 1 0 = CONTEXT-SPECIFIC
212 * | 5 ... 1 | TAG-NUMBER
216 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
217 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
218 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octect string */
219 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octect string */
220 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
221 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
223 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
225 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
226 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
227 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
228 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
230 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
233 /* possible operations a client can invoke */
234 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
235 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
236 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
237 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
238 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
239 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
240 #define LDAP_REQ_MODRDN ((ber_tag_t) 0x6cU) /* application + constructed */
241 #define LDAP_REQ_MODDN LDAP_REQ_MODRDN
242 #define LDAP_REQ_RENAME LDAP_REQ_MODRDN
243 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
244 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
245 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
247 /* possible result types a server can return */
248 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
249 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
250 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
251 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
252 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
253 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
254 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
255 #define LDAP_RES_MODRDN ((ber_tag_t) 0x6dU) /* application + constructed */
256 #define LDAP_RES_MODDN LDAP_RES_MODRDN /* application + constructed */
257 #define LDAP_RES_RENAME LDAP_RES_MODRDN /* application + constructed */
258 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
259 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
260 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
262 #define LDAP_RES_ANY ((ber_tag_t)(-1))
263 #define LDAP_RES_UNSOLICITED ((ber_tag_t)(0))
267 #define LDAP_SASL_SIMPLE NULL
269 /* authentication methods available */
270 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
271 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
272 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + primitive */
273 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
274 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
275 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
279 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
280 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
281 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
282 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
283 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
284 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
285 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
286 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
287 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
288 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
290 /* extended filter component types */
291 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
292 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
293 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
294 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
296 /* substring filter component types */
297 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
298 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
299 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
302 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
303 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
304 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
306 /* substring filter component types */
307 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
308 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
309 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
312 * possible error codes we can return
315 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
317 #define LDAP_SUCCESS 0x00
318 #define LDAP_OPERATIONS_ERROR 0x01
319 #define LDAP_PROTOCOL_ERROR 0x02
320 #define LDAP_TIMELIMIT_EXCEEDED 0x03
321 #define LDAP_SIZELIMIT_EXCEEDED 0x04
322 #define LDAP_COMPARE_FALSE 0x05
323 #define LDAP_COMPARE_TRUE 0x06
324 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
325 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
326 #define LDAP_STRONG_AUTH_REQUIRED 0x08
327 #define LDAP_PARTIAL_RESULTS 0x09 /* not listed in v3 */
329 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
330 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
331 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
332 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
333 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
335 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
337 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
338 #define LDAP_UNDEFINED_TYPE 0x11
339 #define LDAP_INAPPROPRIATE_MATCHING 0x12
340 #define LDAP_CONSTRAINT_VIOLATION 0x13
341 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
342 #define LDAP_INVALID_SYNTAX 0x15
344 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
346 #define LDAP_NO_SUCH_OBJECT 0x20
347 #define LDAP_ALIAS_PROBLEM 0x21
348 #define LDAP_INVALID_DN_SYNTAX 0x22
349 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
350 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
352 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
354 #define LDAP_INAPPROPRIATE_AUTH 0x30
355 #define LDAP_INVALID_CREDENTIALS 0x31
356 #define LDAP_INSUFFICIENT_ACCESS 0x32
358 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
360 #define LDAP_BUSY 0x33
361 #define LDAP_UNAVAILABLE 0x34
362 #define LDAP_UNWILLING_TO_PERFORM 0x35
363 #define LDAP_LOOP_DETECT 0x36
365 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
367 #define LDAP_NAMING_VIOLATION 0x40
368 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
369 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
370 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
371 #define LDAP_ALREADY_EXISTS 0x44
372 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
373 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
374 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
376 #define LDAP_OTHER 0x50
378 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0xff) /* 81+ */
380 #define LDAP_SERVER_DOWN 0x51
381 #define LDAP_LOCAL_ERROR 0x52
382 #define LDAP_ENCODING_ERROR 0x53
383 #define LDAP_DECODING_ERROR 0x54
384 #define LDAP_TIMEOUT 0x55
385 #define LDAP_AUTH_UNKNOWN 0x56
386 #define LDAP_FILTER_ERROR 0x57
387 #define LDAP_USER_CANCELLED 0x58
388 #define LDAP_PARAM_ERROR 0x59
389 #define LDAP_NO_MEMORY 0x5a
391 #define LDAP_CONNECT_ERROR 0x5b /* new */
392 #define LDAP_NOT_SUPPORTED 0x5c /* new */
393 #define LDAP_CONTROL_NOT_FOUND 0x5d /* new */
394 #define LDAP_NO_RESULTS_RETURNED 0x5e /* new */
395 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* new */
396 #define LDAP_CLIENT_LOOP 0x60 /* new */
397 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* new */
400 * This structure represents both ldap messages and ldap responses.
401 * These are really the same, except in the case of search responses,
402 * where a response has multiple messages.
405 typedef struct ldapmsg LDAPMessage;
407 /* for modifications */
408 typedef struct ldapmod {
411 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
412 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
413 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
414 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
415 /* IMPORTANT: do not use code 0x1000 (or above),
416 * it is used internally by the backends!
417 * (see ldap/servers/slapd/slap.h)
423 struct berval **modv_bvals;
425 #define mod_values mod_vals.modv_strvals
426 #define mod_bvalues mod_vals.modv_bvals
430 * structures for ldap getfilter routines
433 typedef struct ldap_filt_info {
438 struct ldap_filt_info *lfi_next;
441 typedef struct ldap_filt_list {
445 LDAPFiltInfo *lfl_ilist;
446 struct ldap_filt_list *lfl_next;
450 #define LDAP_FILT_MAXSIZ 1024
452 typedef struct ldap_filt_desc {
453 LDAPFiltList *lfd_filtlist;
454 LDAPFiltInfo *lfd_curfip;
455 LDAPFiltInfo lfd_retfi;
456 char lfd_filter[ LDAP_FILT_MAXSIZ ];
458 char *lfd_curvalcopy;
459 char **lfd_curvalwords;
460 char *lfd_filtprefix;
461 char *lfd_filtsuffix;
466 * structure representing an ldap session which can
467 * encompass connections to multiple servers (in the
468 * face of referrals).
470 typedef struct ldap LDAP;
472 #define LDAP_DEREF_NEVER 0x00
473 #define LDAP_DEREF_SEARCHING 0x01
474 #define LDAP_DEREF_FINDING 0x02
475 #define LDAP_DEREF_ALWAYS 0x03
477 #define LDAP_NO_LIMIT 0
479 /* how many messages to retrieve results for */
480 #define LDAP_MSG_ONE 0x00
481 #define LDAP_MSG_ALL 0x01
482 #define LDAP_MSG_RECEIVED 0x02
485 * structure for ldap friendly mapping routines
488 typedef struct ldap_friendly {
494 * types for ldap URL handling
496 typedef struct ldap_url_desc {
497 struct ldap_url_desc *lud_next;
498 unsigned long lud_properties;
510 #define LDAP_URL_USE_SSL 0x00000001
513 #define LDAP_PROTO_TCP 0x00
514 #define LDAP_PROTO_UDP 0x01
515 #define LDAP_PROTO_LOCAL 0x02
517 #define LDAP_URL_SUCCESS 0x00 /* Success */
518 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
519 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
521 #define LDAP_URL_ERR_NOTLDAP 0x03 /* URL doesn't begin with "ldap[s]://" */
522 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
523 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
524 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
525 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
526 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
527 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
528 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
531 * The API draft spec says we should declare (or cause to be declared)
532 * 'struct timeval'. We don't. See IETF LDAPext discussions.
540 ldap_get_option LDAP_P((
546 ldap_set_option LDAP_P((
549 LDAP_CONST void *invalue));
551 /* V3 REBIND Function Callback Prototype */
552 typedef int (LDAP_REBIND_PROC) ( LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid);
555 ldap_set_rebind_proc LDAP_P((
557 LDAP_REBIND_PROC *ldap_proc));
563 ldap_control_free LDAP_P((
564 LDAPControl *ctrl ));
567 ldap_controls_free LDAP_P((
568 LDAPControl **ctrls ));
574 ldap_domain2dn LDAP_P((
575 LDAP_CONST char* domain,
579 ldap_dn2domain LDAP_P((
584 ldap_domain2hostlist LDAP_P((
585 LDAP_CONST char *domain,
592 ldap_extended_operation LDAP_P((
594 LDAP_CONST char *reqoid,
595 struct berval *reqdata,
596 LDAPControl **serverctrls,
597 LDAPControl **clientctrls,
601 ldap_extended_operation_s LDAP_P((
603 LDAP_CONST char *reqoid,
604 struct berval *reqdata,
605 LDAPControl **serverctrls,
606 LDAPControl **clientctrls,
608 struct berval **retdatap ));
611 ldap_parse_extended_result LDAP_P((
615 struct berval **retdatap,
622 ldap_abandon LDAP_P(( /* deprecated */
627 ldap_abandon_ext LDAP_P((
630 LDAPControl **serverctrls,
631 LDAPControl **clientctrls ));
638 ldap_add_ext LDAP_P((
642 LDAPControl **serverctrls,
643 LDAPControl **clientctrls,
647 ldap_add_ext_s LDAP_P((
651 LDAPControl **serverctrls,
652 LDAPControl **clientctrls ));
655 ldap_add LDAP_P(( /* deprecated */
661 ldap_add_s LDAP_P(( /* deprecated */
671 ldap_sasl_bind LDAP_P((
674 LDAP_CONST char *mechanism,
676 LDAPControl **serverctrls,
677 LDAPControl **clientctrls,
681 ldap_negotiated_sasl_bind_s LDAP_P((
683 LDAP_CONST char *dn, /* usually NULL */
684 LDAP_CONST char *authenticationId,
685 LDAP_CONST char *authorizationId, /* usually NULL */
686 LDAP_CONST char *saslMechanism,
687 struct berval *passPhrase,
688 LDAPControl **serverControls,
689 LDAPControl **clientControls ));
692 ldap_sasl_bind_s LDAP_P((
695 LDAP_CONST char *mechanism,
697 LDAPControl **serverctrls,
698 LDAPControl **clientctrls,
699 struct berval **servercredp ));
702 ldap_parse_sasl_bind_result LDAP_P((
705 struct berval **servercredp,
713 ldap_bind LDAP_P(( /* deprecated */
715 LDAP_CONST char *who,
716 LDAP_CONST char *passwd,
720 ldap_bind_s LDAP_P(( /* deprecated */
722 LDAP_CONST char *who,
723 LDAP_CONST char *cred,
730 ldap_simple_bind LDAP_P((
732 LDAP_CONST char *who,
733 LDAP_CONST char *passwd ));
736 ldap_simple_bind_s LDAP_P((
738 LDAP_CONST char *who,
739 LDAP_CONST char *passwd ));
747 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
749 LDAP_CONST char *who ));
752 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
754 LDAP_CONST char *who ));
757 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
759 LDAP_CONST char *who ));
762 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
764 LDAP_CONST char *who ));
767 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
769 LDAP_CONST char *who ));
776 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
779 ldap_disable_cache LDAP_P(( LDAP *ld ));
782 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
785 ldap_destroy_cache LDAP_P(( LDAP *ld ));
788 ldap_flush_cache LDAP_P(( LDAP *ld ));
791 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
794 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
801 ldap_compare_ext LDAP_P((
804 LDAP_CONST char *attr,
805 struct berval *bvalue,
806 LDAPControl **serverctrls,
807 LDAPControl **clientctrls,
811 ldap_compare_ext_s LDAP_P((
814 LDAP_CONST char *attr,
815 struct berval *bvalue,
816 LDAPControl **serverctrls,
817 LDAPControl **clientctrls ));
820 ldap_compare LDAP_P(( /* deprecated */
823 LDAP_CONST char *attr,
824 LDAP_CONST char *value ));
827 ldap_compare_s LDAP_P(( /* deprecated */
830 LDAP_CONST char *attr,
831 LDAP_CONST char *value ));
838 ldap_delete_ext LDAP_P((
841 LDAPControl **serverctrls,
842 LDAPControl **clientctrls,
846 ldap_delete_ext_s LDAP_P((
849 LDAPControl **serverctrls,
850 LDAPControl **clientctrls ));
853 ldap_delete LDAP_P(( /* deprecated */
855 LDAP_CONST char *dn ));
858 ldap_delete_s LDAP_P(( /* deprecated */
860 LDAP_CONST char *dn ));
867 ldap_parse_result LDAP_P((
874 LDAPControl ***serverctrls,
878 ldap_err2string LDAP_P((
882 ldap_result2error LDAP_P(( /* deprecated */
888 ldap_perror LDAP_P(( /* deprecated */
890 LDAP_CONST char *s ));
897 ldap_modify_ext LDAP_P((
901 LDAPControl **serverctrls,
902 LDAPControl **clientctrls,
906 ldap_modify_ext_s LDAP_P((
910 LDAPControl **serverctrls,
911 LDAPControl **clientctrls ));
914 ldap_modify LDAP_P(( /* deprecated */
920 ldap_modify_s LDAP_P(( /* deprecated */
933 LDAP_CONST char *newrdn,
934 LDAP_CONST char *newSuperior,
936 LDAPControl **sctrls,
937 LDAPControl **cctrls,
941 ldap_rename_s LDAP_P((
944 LDAP_CONST char *newrdn,
945 LDAP_CONST char *newSuperior,
947 LDAPControl **sctrls,
948 LDAPControl **cctrls ));
951 ldap_rename_ext LDAP_P((
954 LDAP_CONST char *newrdn,
955 LDAP_CONST char *newparent,
957 LDAPControl **serverctrls,
958 LDAPControl **clientctrls,
962 ldap_rename_ext_s LDAP_P((
965 LDAP_CONST char *newrdn,
966 LDAP_CONST char *newparent,
968 LDAPControl **serverctrls,
969 LDAPControl **clientctrls ));
972 ldap_rename2 LDAP_P(( /* deprecated */
975 LDAP_CONST char *newrdn,
976 LDAP_CONST char *newSuperior,
980 ldap_rename2_s LDAP_P(( /* deprecated */
983 LDAP_CONST char *newrdn,
984 LDAP_CONST char *newSuperior,
988 ldap_modrdn LDAP_P(( /* deprecated */
991 LDAP_CONST char *newrdn ));
994 ldap_modrdn_s LDAP_P(( /* deprecated */
997 LDAP_CONST char *newrdn ));
1000 ldap_modrdn2 LDAP_P(( /* deprecated */
1002 LDAP_CONST char *dn,
1003 LDAP_CONST char *newrdn,
1004 int deleteoldrdn ));
1007 ldap_modrdn2_s LDAP_P(( /* deprecated */
1009 LDAP_CONST char *dn,
1010 LDAP_CONST char *newrdn,
1018 ldap_open LDAP_P(( /* deprecated */
1019 LDAP_CONST char *host,
1024 LDAP_CONST char *host,
1028 ldap_create LDAP_P((
1032 ldap_initialize LDAP_P((
1034 LDAP_CONST char *url ));
1037 ldap_start_tls LDAP_P((
1039 LDAPControl **serverctrls,
1040 LDAPControl **clientctrls ));
1045 LIBLDAP_F( LDAPMessage *)
1046 ldap_first_message LDAP_P((
1048 LDAPMessage *chain ));
1050 LIBLDAP_F( LDAPMessage *)
1051 ldap_next_message LDAP_P((
1053 LDAPMessage *msg ));
1056 ldap_count_messages LDAP_P((
1058 LDAPMessage *chain ));
1064 LIBLDAP_F( LDAPMessage *)
1065 ldap_first_reference LDAP_P((
1067 LDAPMessage *chain ));
1069 LIBLDAP_F( LDAPMessage *)
1070 ldap_next_reference LDAP_P((
1072 LDAPMessage *ref ));
1075 ldap_count_references LDAP_P((
1077 LDAPMessage *chain ));
1080 ldap_parse_reference LDAP_P((
1084 LDAPControl ***serverctrls,
1091 LIBLDAP_F( LDAPMessage *)
1092 ldap_first_entry LDAP_P((
1094 LDAPMessage *chain ));
1096 LIBLDAP_F( LDAPMessage *)
1097 ldap_next_entry LDAP_P((
1099 LDAPMessage *entry ));
1102 ldap_count_entries LDAP_P((
1104 LDAPMessage *chain ));
1107 ldap_get_entry_controls LDAP_P((
1110 LDAPControl ***serverctrls));
1116 LIBLDAP_F( LDAPMessage *)
1117 ldap_delete_result_entry LDAP_P((
1122 ldap_add_result_entry LDAP_P((
1131 ldap_get_dn LDAP_P((
1133 LDAPMessage *entry ));
1136 ldap_dn2ufn LDAP_P((
1137 LDAP_CONST char *dn ));
1139 LIBLDAP_F( char ** )
1140 ldap_explode_dn LDAP_P((
1141 LDAP_CONST char *dn,
1144 LIBLDAP_F( char ** )
1145 ldap_explode_rdn LDAP_P((
1146 LDAP_CONST char *rdn,
1150 ldap_parent_dn LDAP_P((
1151 LDAP_CONST char *dn ));
1154 ldap_relative_dn LDAP_P((
1155 LDAP_CONST char *dn ));
1158 ldap_normalize_dn LDAP_P((
1159 LDAP_CONST char *dn ));
1161 LIBLDAP_F( char ** )
1162 ldap_explode_dns LDAP_P(( /* deprecated */
1163 LDAP_CONST char *dn ));
1166 ldap_is_dns_dn LDAP_P(( /* deprecated */
1167 LDAP_CONST char *dn ));
1170 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1173 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1179 ldap_first_attribute LDAP_P((
1182 BerElement **ber ));
1185 ldap_next_attribute LDAP_P((
1195 ldap_get_values LDAP_P((
1198 LDAP_CONST char *target ));
1200 LIBLDAP_F( struct berval **)
1201 ldap_get_values_len LDAP_P((
1204 LDAP_CONST char *target ));
1207 ldap_count_values LDAP_P((
1211 ldap_count_values_len LDAP_P((
1212 struct berval **vals ));
1215 ldap_value_free LDAP_P((
1219 ldap_value_free_len LDAP_P((
1220 struct berval **vals ));
1226 ldap_result LDAP_P((
1230 struct timeval *timeout,
1231 LDAPMessage **result ));
1234 ldap_msgtype LDAP_P((
1242 ldap_msgfree LDAP_P((
1246 ldap_msgdelete LDAP_P((
1255 ldap_search_ext LDAP_P((
1257 LDAP_CONST char *base,
1259 LDAP_CONST char *filter,
1262 LDAPControl **serverctrls,
1263 LDAPControl **clientctrls,
1264 struct timeval *timeout,
1269 ldap_search_ext_s LDAP_P((
1271 LDAP_CONST char *base,
1273 LDAP_CONST char *filter,
1276 LDAPControl **serverctrls,
1277 LDAPControl **clientctrls,
1278 struct timeval *timeout,
1280 LDAPMessage **res ));
1283 ldap_search LDAP_P(( /* deprecated */
1285 LDAP_CONST char *base,
1287 LDAP_CONST char *filter,
1292 ldap_search_s LDAP_P(( /* deprecated */
1294 LDAP_CONST char *base,
1296 LDAP_CONST char *filter,
1299 LDAPMessage **res ));
1302 ldap_search_st LDAP_P(( /* deprecated */
1304 LDAP_CONST char *base,
1306 LDAP_CONST char *filter,
1309 struct timeval *timeout,
1310 LDAPMessage **res ));
1318 ldap_ufn_search_c LDAP_P(( /* deprecated */
1320 LDAP_CONST char *ufn,
1324 int (*cancelproc)( void *cl ),
1325 void *cancelparm ));
1328 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1330 LDAP_CONST char *ufn,
1334 int (*cancelproc)( void *cl ),
1341 ldap_ufn_search_s LDAP_P(( /* deprecated */
1343 LDAP_CONST char *ufn,
1346 LDAPMessage **res ));
1348 LIBLDAP_F( LDAPFiltDesc *)
1349 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1351 LDAP_CONST char *fname ));
1354 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1356 LDAP_CONST char *prefix ));
1359 ldap_ufn_timeout LDAP_P(( /* deprecated */
1367 ldap_unbind LDAP_P(( /* deprecated */
1371 ldap_unbind_s LDAP_P(( /* deprecated */
1375 ldap_unbind_ext LDAP_P((
1377 LDAPControl **serverctrls,
1378 LDAPControl **clientctrls));
1381 ldap_unbind_ext_s LDAP_P((
1383 LDAPControl **serverctrls,
1384 LDAPControl **clientctrls));
1390 LIBLDAP_F( LDAPFiltDesc *)
1391 ldap_init_getfilter LDAP_P(( /* deprecated */
1392 LDAP_CONST char *fname ));
1394 LIBLDAP_F( LDAPFiltDesc *)
1395 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1396 /* LDAP_CONST */ char *buf,
1397 ber_len_t buflen ));
1399 LIBLDAP_F( LDAPFiltInfo *)
1400 ldap_getfirstfilter LDAP_P(( /* deprecated */
1402 /* LDAP_CONST */ char *tagpat,
1403 /* LDAP_CONST */ char *value ));
1405 LIBLDAP_F( LDAPFiltInfo *)
1406 ldap_getnextfilter LDAP_P(( /* deprecated */
1407 LDAPFiltDesc *lfdp ));
1410 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1412 LDAP_CONST char *prefix,
1413 LDAP_CONST char *suffix ));
1416 ldap_build_filter LDAP_P(( /* deprecated */
1419 LDAP_CONST char *pattern,
1420 LDAP_CONST char *prefix,
1421 LDAP_CONST char *suffix,
1422 LDAP_CONST char *attr,
1423 LDAP_CONST char *value,
1432 ldap_memalloc LDAP_P((
1436 ldap_memrealloc LDAP_P((
1441 ldap_memcalloc LDAP_P((
1446 ldap_memfree LDAP_P((
1450 ldap_memvfree LDAP_P((
1454 ldap_strdup LDAP_P((
1455 LDAP_CONST char * ));
1458 ldap_getfilter_free LDAP_P((
1459 LDAPFiltDesc *lfdp ));
1462 ldap_mods_free LDAP_P((
1472 ldap_friendly_name LDAP_P(( /* deprecated */
1473 LDAP_CONST char *filename,
1474 /* LDAP_CONST */ char *uname,
1475 LDAPFriendlyMap **map ));
1478 ldap_free_friendlymap LDAP_P(( /* deprecated */
1479 LDAPFriendlyMap **map ));
1487 cldap_open LDAP_P(( /* deprecated */
1488 LDAP_CONST char *host,
1492 cldap_close LDAP_P(( /* deprecated */
1496 cldap_search_s LDAP_P(( /* deprecated */
1498 LDAP_CONST char *base,
1500 LDAP_CONST char *filter,
1507 cldap_setretryinfo LDAP_P(( /* deprecated */
1517 ldap_sort_entries LDAP_P(( LDAP *ld,
1518 LDAPMessage **chain,
1519 LDAP_CONST char *attr,
1520 int (*cmp) (LDAP_CONST char *, LDAP_CONST char *) ));
1523 ldap_sort_values LDAP_P((
1526 int (*cmp) (LDAP_CONST void *, LDAP_CONST void *) ));
1529 ldap_sort_strcasecmp LDAP_P((
1531 LDAP_CONST void *b ));
1537 * need _ext varients
1540 ldap_is_ldap_url LDAP_P((
1541 LDAP_CONST char *url ));
1544 ldap_is_ldaps_url LDAP_P((
1545 LDAP_CONST char *url ));
1548 ldap_url_parse LDAP_P((
1549 LDAP_CONST char *url,
1550 LDAPURLDesc **ludpp ));
1553 ldap_free_urldesc LDAP_P((
1554 LDAPURLDesc *ludp ));
1557 ldap_url_search LDAP_P((
1559 LDAP_CONST char *url,
1563 ldap_url_search_s LDAP_P((
1565 LDAP_CONST char *url,
1567 LDAPMessage **res ));
1570 ldap_url_search_st LDAP_P((
1572 LDAP_CONST char *url,
1574 struct timeval *timeout,
1575 LDAPMessage **res ));
1583 ldap_set_string_translators LDAP_P((
1585 BERTranslateProc encode_proc,
1586 BERTranslateProc decode_proc ));
1589 ldap_translate_from_t61 LDAP_P((
1596 ldap_translate_to_t61 LDAP_P((
1603 ldap_enable_translation LDAP_P((
1609 ldap_t61_to_8859 LDAP_P((
1615 ldap_8859_to_t61 LDAP_P((
1622 #endif /* _LDAP_H */