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 20000 */
47 #define LDAP_VENDOR_VERSION 19910
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 /* 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
115 /* OpenLDAP TLS options */
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
125 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x600a
127 #define LDAP_OPT_X_TLS_NEVER 0
128 #define LDAP_OPT_X_TLS_HARD 1
129 #define LDAP_OPT_X_TLS_DEMAND 2
130 #define LDAP_OPT_X_TLS_ALLOW 3
131 #define LDAP_OPT_X_TLS_TRY 4
133 /* OpenLDAP SASL options */
134 #define LDAP_OPT_X_SASL_MECH 0x6100
135 #define LDAP_OPT_X_SASL_REALM 0x6101
136 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
137 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
138 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
139 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
140 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
141 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
142 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
143 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
147 #define LDAP_OPT_ON ((void *) 1)
148 #define LDAP_OPT_OFF ((void *) 0)
151 * ldap_get_option() and ldap_set_option() return values.
152 * As later versions may return other values indicating
153 * failure, current applications should only compare returned
154 * value against LDAP_OPT_SUCCESS.
156 #define LDAP_OPT_SUCCESS 0
157 #define LDAP_OPT_ERROR (-1)
159 #define LDAP_API_INFO_VERSION (1)
160 typedef struct ldapapiinfo {
161 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
162 int ldapai_api_version; /* revision of API supported */
163 int ldapai_protocol_version; /* highest LDAP version supported */
164 char **ldapai_extensions; /* names of API extensions */
165 char *ldapai_vendor_name; /* name of supplier */
166 int ldapai_vendor_version; /* supplier-specific version * 100 */
169 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
170 typedef struct ldap_apifeature_info {
171 int ldapaif_info_version; /* version of this struct (1) */
172 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
173 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
174 } LDAPAPIFeatureInfo;
176 typedef struct ldapcontrol {
178 struct berval ldctl_value;
179 char ldctl_iscritical;
183 /* chase referrals controls */
184 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
185 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
186 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
188 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
190 /* Experimental Controls */
192 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
193 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
194 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
195 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
197 /* LDAP Unsolicited Notifications */
198 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
199 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
201 /* LDAP Extended Operations */
202 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
204 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.666.6.1"
205 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
206 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
207 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
208 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
211 * specific LDAP instantiations of BER types we know about
214 /* Overview of LBER tag construction
221 * 1 0 = CONTEXT-SPECIFIC
228 * | 5 ... 1 | TAG-NUMBER
232 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
233 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
234 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octect string */
235 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octect string */
236 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
237 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
239 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
241 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
242 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
243 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
244 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
246 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
249 /* possible operations a client can invoke */
250 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
251 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
252 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
253 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
254 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
255 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
256 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
257 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
258 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
259 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
260 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
261 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
263 /* possible result types a server can return */
264 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
265 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
266 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
267 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
268 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
269 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
270 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
271 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
272 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
273 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
274 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
275 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
276 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
278 #define LDAP_RES_ANY (-1)
279 #define LDAP_RES_UNSOLICITED (0)
283 #define LDAP_SASL_SIMPLE ((char*)0)
286 /* authentication methods available */
287 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
288 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
289 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + primitive */
290 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
291 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
292 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
296 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
297 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
298 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
299 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
300 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
301 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
302 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
303 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
304 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
305 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
307 /* extended filter component types */
308 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
309 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
310 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
311 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
313 /* substring filter component types */
314 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
315 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
316 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
319 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
320 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
321 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
323 /* substring filter component types */
324 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
325 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
326 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
329 * possible error codes we can return
332 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
334 #define LDAP_SUCCESS 0x00
335 #define LDAP_OPERATIONS_ERROR 0x01
336 #define LDAP_PROTOCOL_ERROR 0x02
337 #define LDAP_TIMELIMIT_EXCEEDED 0x03
338 #define LDAP_SIZELIMIT_EXCEEDED 0x04
339 #define LDAP_COMPARE_FALSE 0x05
340 #define LDAP_COMPARE_TRUE 0x06
341 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
342 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
343 #define LDAP_STRONG_AUTH_REQUIRED 0x08
344 #define LDAP_PARTIAL_RESULTS 0x09 /* not listed in v3 */
346 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
347 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
348 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
349 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
350 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
352 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
354 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
355 #define LDAP_UNDEFINED_TYPE 0x11
356 #define LDAP_INAPPROPRIATE_MATCHING 0x12
357 #define LDAP_CONSTRAINT_VIOLATION 0x13
358 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
359 #define LDAP_INVALID_SYNTAX 0x15
361 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
363 #define LDAP_NO_SUCH_OBJECT 0x20
364 #define LDAP_ALIAS_PROBLEM 0x21
365 #define LDAP_INVALID_DN_SYNTAX 0x22
366 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
367 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
369 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
371 #define LDAP_INAPPROPRIATE_AUTH 0x30
372 #define LDAP_INVALID_CREDENTIALS 0x31
373 #define LDAP_INSUFFICIENT_ACCESS 0x32
375 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
377 #define LDAP_BUSY 0x33
378 #define LDAP_UNAVAILABLE 0x34
379 #define LDAP_UNWILLING_TO_PERFORM 0x35
380 #define LDAP_LOOP_DETECT 0x36
382 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
384 #define LDAP_NAMING_VIOLATION 0x40
385 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
386 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
387 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
388 #define LDAP_ALREADY_EXISTS 0x44
389 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
390 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
391 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
393 #define LDAP_OTHER 0x50
395 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
397 #define LDAP_SERVER_DOWN 0x51
398 #define LDAP_LOCAL_ERROR 0x52
399 #define LDAP_ENCODING_ERROR 0x53
400 #define LDAP_DECODING_ERROR 0x54
401 #define LDAP_TIMEOUT 0x55
402 #define LDAP_AUTH_UNKNOWN 0x56
403 #define LDAP_FILTER_ERROR 0x57
404 #define LDAP_USER_CANCELLED 0x58
405 #define LDAP_PARAM_ERROR 0x59
406 #define LDAP_NO_MEMORY 0x5a
408 /* not technically reserved for APIs */
409 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
410 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
411 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
412 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
413 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
414 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
415 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
418 * This structure represents both ldap messages and ldap responses.
419 * These are really the same, except in the case of search responses,
420 * where a response has multiple messages.
423 typedef struct ldapmsg LDAPMessage;
425 /* for modifications */
426 typedef struct ldapmod {
429 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
430 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
431 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
432 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
433 /* IMPORTANT: do not use code 0x1000 (or above),
434 * it is used internally by the backends!
435 * (see ldap/servers/slapd/slap.h)
441 struct berval **modv_bvals;
443 #define mod_values mod_vals.modv_strvals
444 #define mod_bvalues mod_vals.modv_bvals
448 * structures for ldap getfilter routines
451 typedef struct ldap_filt_info {
456 struct ldap_filt_info *lfi_next;
459 typedef struct ldap_filt_list {
463 LDAPFiltInfo *lfl_ilist;
464 struct ldap_filt_list *lfl_next;
468 #define LDAP_FILT_MAXSIZ 1024
470 typedef struct ldap_filt_desc {
471 LDAPFiltList *lfd_filtlist;
472 LDAPFiltInfo *lfd_curfip;
473 LDAPFiltInfo lfd_retfi;
474 char lfd_filter[ LDAP_FILT_MAXSIZ ];
476 char *lfd_curvalcopy;
477 char **lfd_curvalwords;
478 char *lfd_filtprefix;
479 char *lfd_filtsuffix;
484 * structure representing an ldap session which can
485 * encompass connections to multiple servers (in the
486 * face of referrals).
488 typedef struct ldap LDAP;
490 #define LDAP_DEREF_NEVER 0x00
491 #define LDAP_DEREF_SEARCHING 0x01
492 #define LDAP_DEREF_FINDING 0x02
493 #define LDAP_DEREF_ALWAYS 0x03
495 #define LDAP_NO_LIMIT 0
497 /* how many messages to retrieve results for */
498 #define LDAP_MSG_ONE 0x00
499 #define LDAP_MSG_ALL 0x01
500 #define LDAP_MSG_RECEIVED 0x02
503 * structure for ldap friendly mapping routines
506 typedef struct ldap_friendly {
512 * types for ldap URL handling
514 typedef struct ldap_url_desc {
515 struct ldap_url_desc *lud_next;
526 #define LDAP_URL_SUCCESS 0x00 /* Success */
527 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
528 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
530 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
531 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
532 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
533 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
534 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
535 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
536 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
537 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
540 * The API draft spec says we should declare (or cause to be declared)
541 * 'struct timeval'. We don't. See IETF LDAPext discussions.
549 ldap_get_option LDAP_P((
555 ldap_set_option LDAP_P((
558 LDAP_CONST void *invalue));
560 /* V3 REBIND Function Callback Prototype */
561 typedef int (LDAP_REBIND_PROC) LDAP_P((
562 LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
565 ldap_set_rebind_proc LDAP_P((
567 LDAP_REBIND_PROC *ldap_proc));
573 ldap_control_free LDAP_P((
574 LDAPControl *ctrl ));
577 ldap_controls_free LDAP_P((
578 LDAPControl **ctrls ));
584 ldap_domain2dn LDAP_P((
585 LDAP_CONST char* domain,
589 ldap_dn2domain LDAP_P((
594 ldap_domain2hostlist LDAP_P((
595 LDAP_CONST char *domain,
602 ldap_extended_operation LDAP_P((
604 LDAP_CONST char *reqoid,
605 struct berval *reqdata,
606 LDAPControl **serverctrls,
607 LDAPControl **clientctrls,
611 ldap_extended_operation_s LDAP_P((
613 LDAP_CONST char *reqoid,
614 struct berval *reqdata,
615 LDAPControl **serverctrls,
616 LDAPControl **clientctrls,
618 struct berval **retdatap ));
621 ldap_parse_extended_result LDAP_P((
625 struct berval **retdatap,
629 ldap_parse_extended_partial LDAP_P((
633 struct berval **retdatap,
634 LDAPControl ***serverctrls,
641 ldap_abandon_ext LDAP_P((
644 LDAPControl **serverctrls,
645 LDAPControl **clientctrls ));
648 ldap_abandon LDAP_P(( /* deprecated */
657 ldap_add_ext LDAP_P((
661 LDAPControl **serverctrls,
662 LDAPControl **clientctrls,
666 ldap_add_ext_s LDAP_P((
670 LDAPControl **serverctrls,
671 LDAPControl **clientctrls ));
674 ldap_add LDAP_P(( /* deprecated */
680 ldap_add_s LDAP_P(( /* deprecated */
690 ldap_sasl_bind LDAP_P((
693 LDAP_CONST char *mechanism,
695 LDAPControl **serverctrls,
696 LDAPControl **clientctrls,
699 /* Interaction flags (should be passed about in a control)
700 * Automatic (default): use defaults, prompt otherwise
701 * Interactive: prompt always
702 * Quiet: never prompt
704 #define LDAP_SASL_AUTOMATIC 0U
705 #define LDAP_SASL_INTERACTIVE 1U
706 #define LDAP_SASL_QUIET 2U
709 * V3 SASL Interaction Function Callback Prototype
710 * when using Cyrus SASL, interact is pointer to sasl_interact_t
711 * should likely passed in a control (and provided controls)
713 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
714 LDAP *ld, unsigned flags, void* defaults, void *interact ));
717 ldap_sasl_interactive_bind_s LDAP_P((
719 LDAP_CONST char *dn, /* usually NULL */
720 LDAP_CONST char *saslMechanism,
721 LDAPControl **serverControls,
722 LDAPControl **clientControls,
724 /* should be client controls */
726 LDAP_SASL_INTERACT_PROC *proc,
730 ldap_sasl_bind_s LDAP_P((
733 LDAP_CONST char *mechanism,
735 LDAPControl **serverctrls,
736 LDAPControl **clientctrls,
737 struct berval **servercredp ));
740 ldap_parse_sasl_bind_result LDAP_P((
743 struct berval **servercredp,
751 ldap_bind LDAP_P(( /* deprecated */
753 LDAP_CONST char *who,
754 LDAP_CONST char *passwd,
758 ldap_bind_s LDAP_P(( /* deprecated */
760 LDAP_CONST char *who,
761 LDAP_CONST char *cred,
768 ldap_simple_bind LDAP_P((
770 LDAP_CONST char *who,
771 LDAP_CONST char *passwd ));
774 ldap_simple_bind_s LDAP_P((
776 LDAP_CONST char *who,
777 LDAP_CONST char *passwd ));
785 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
787 LDAP_CONST char *who ));
790 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
792 LDAP_CONST char *who ));
795 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
797 LDAP_CONST char *who ));
800 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
802 LDAP_CONST char *who ));
805 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
807 LDAP_CONST char *who ));
814 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
817 ldap_disable_cache LDAP_P(( LDAP *ld ));
820 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
823 ldap_destroy_cache LDAP_P(( LDAP *ld ));
826 ldap_flush_cache LDAP_P(( LDAP *ld ));
829 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
832 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
839 ldap_compare_ext LDAP_P((
842 LDAP_CONST char *attr,
843 struct berval *bvalue,
844 LDAPControl **serverctrls,
845 LDAPControl **clientctrls,
849 ldap_compare_ext_s LDAP_P((
852 LDAP_CONST char *attr,
853 struct berval *bvalue,
854 LDAPControl **serverctrls,
855 LDAPControl **clientctrls ));
858 ldap_compare LDAP_P(( /* deprecated */
861 LDAP_CONST char *attr,
862 LDAP_CONST char *value ));
865 ldap_compare_s LDAP_P(( /* deprecated */
868 LDAP_CONST char *attr,
869 LDAP_CONST char *value ));
876 ldap_delete_ext LDAP_P((
879 LDAPControl **serverctrls,
880 LDAPControl **clientctrls,
884 ldap_delete_ext_s LDAP_P((
887 LDAPControl **serverctrls,
888 LDAPControl **clientctrls ));
891 ldap_delete LDAP_P(( /* deprecated */
893 LDAP_CONST char *dn ));
896 ldap_delete_s LDAP_P(( /* deprecated */
898 LDAP_CONST char *dn ));
905 ldap_parse_result LDAP_P((
912 LDAPControl ***serverctrls,
916 ldap_err2string LDAP_P((
920 ldap_result2error LDAP_P(( /* deprecated */
926 ldap_perror LDAP_P(( /* deprecated */
928 LDAP_CONST char *s ));
935 ldap_modify_ext LDAP_P((
939 LDAPControl **serverctrls,
940 LDAPControl **clientctrls,
944 ldap_modify_ext_s LDAP_P((
948 LDAPControl **serverctrls,
949 LDAPControl **clientctrls ));
952 ldap_modify LDAP_P(( /* deprecated */
958 ldap_modify_s LDAP_P(( /* deprecated */
971 LDAP_CONST char *newrdn,
972 LDAP_CONST char *newSuperior,
974 LDAPControl **sctrls,
975 LDAPControl **cctrls,
979 ldap_rename_s LDAP_P((
982 LDAP_CONST char *newrdn,
983 LDAP_CONST char *newSuperior,
985 LDAPControl **sctrls,
986 LDAPControl **cctrls ));
989 ldap_rename2 LDAP_P(( /* deprecated */
992 LDAP_CONST char *newrdn,
993 LDAP_CONST char *newSuperior,
997 ldap_rename2_s LDAP_P(( /* deprecated */
1000 LDAP_CONST char *newrdn,
1001 LDAP_CONST char *newSuperior,
1002 int deleteoldrdn ));
1005 ldap_modrdn LDAP_P(( /* deprecated */
1007 LDAP_CONST char *dn,
1008 LDAP_CONST char *newrdn ));
1011 ldap_modrdn_s LDAP_P(( /* deprecated */
1013 LDAP_CONST char *dn,
1014 LDAP_CONST char *newrdn ));
1017 ldap_modrdn2 LDAP_P(( /* deprecated */
1019 LDAP_CONST char *dn,
1020 LDAP_CONST char *newrdn,
1021 int deleteoldrdn ));
1024 ldap_modrdn2_s LDAP_P(( /* deprecated */
1026 LDAP_CONST char *dn,
1027 LDAP_CONST char *newrdn,
1036 LDAP_CONST char *host,
1040 ldap_open LDAP_P(( /* deprecated */
1041 LDAP_CONST char *host,
1045 ldap_create LDAP_P((
1049 ldap_initialize LDAP_P((
1051 LDAP_CONST char *url ));
1054 ldap_start_tls_s LDAP_P((
1056 LDAPControl **serverctrls,
1057 LDAPControl **clientctrls ));
1062 LDAP_F( LDAPMessage *)
1063 ldap_first_message LDAP_P((
1065 LDAPMessage *chain ));
1067 LDAP_F( LDAPMessage *)
1068 ldap_next_message LDAP_P((
1070 LDAPMessage *msg ));
1073 ldap_count_messages LDAP_P((
1075 LDAPMessage *chain ));
1081 LDAP_F( LDAPMessage *)
1082 ldap_first_reference LDAP_P((
1084 LDAPMessage *chain ));
1086 LDAP_F( LDAPMessage *)
1087 ldap_next_reference LDAP_P((
1089 LDAPMessage *ref ));
1092 ldap_count_references LDAP_P((
1094 LDAPMessage *chain ));
1097 ldap_parse_reference LDAP_P((
1101 LDAPControl ***serverctrls,
1108 LDAP_F( LDAPMessage *)
1109 ldap_first_entry LDAP_P((
1111 LDAPMessage *chain ));
1113 LDAP_F( LDAPMessage *)
1114 ldap_next_entry LDAP_P((
1116 LDAPMessage *entry ));
1119 ldap_count_entries LDAP_P((
1121 LDAPMessage *chain ));
1124 ldap_get_entry_controls LDAP_P((
1127 LDAPControl ***serverctrls));
1133 LDAP_F( LDAPMessage *)
1134 ldap_delete_result_entry LDAP_P((
1139 ldap_add_result_entry LDAP_P((
1148 ldap_get_dn LDAP_P((
1150 LDAPMessage *entry ));
1153 ldap_dn2ufn LDAP_P((
1154 LDAP_CONST char *dn ));
1157 ldap_explode_dn LDAP_P((
1158 LDAP_CONST char *dn,
1162 ldap_explode_rdn LDAP_P((
1163 LDAP_CONST char *rdn,
1167 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1170 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1176 ldap_first_attribute LDAP_P((
1179 BerElement **ber ));
1182 ldap_next_attribute LDAP_P((
1192 ldap_get_values LDAP_P((
1195 LDAP_CONST char *target ));
1197 LDAP_F( struct berval **)
1198 ldap_get_values_len LDAP_P((
1201 LDAP_CONST char *target ));
1204 ldap_count_values LDAP_P((
1208 ldap_count_values_len LDAP_P((
1209 struct berval **vals ));
1212 ldap_value_free LDAP_P((
1216 ldap_value_free_len LDAP_P((
1217 struct berval **vals ));
1223 ldap_result LDAP_P((
1227 struct timeval *timeout,
1228 LDAPMessage **result ));
1231 ldap_msgtype LDAP_P((
1239 ldap_msgfree LDAP_P((
1243 ldap_msgdelete LDAP_P((
1252 ldap_search_ext LDAP_P((
1254 LDAP_CONST char *base,
1256 LDAP_CONST char *filter,
1259 LDAPControl **serverctrls,
1260 LDAPControl **clientctrls,
1261 struct timeval *timeout,
1266 ldap_search_ext_s LDAP_P((
1268 LDAP_CONST char *base,
1270 LDAP_CONST char *filter,
1273 LDAPControl **serverctrls,
1274 LDAPControl **clientctrls,
1275 struct timeval *timeout,
1277 LDAPMessage **res ));
1280 ldap_search LDAP_P(( /* deprecated */
1282 LDAP_CONST char *base,
1284 LDAP_CONST char *filter,
1289 ldap_search_s LDAP_P(( /* deprecated */
1291 LDAP_CONST char *base,
1293 LDAP_CONST char *filter,
1296 LDAPMessage **res ));
1299 ldap_search_st LDAP_P(( /* deprecated */
1301 LDAP_CONST char *base,
1303 LDAP_CONST char *filter,
1306 struct timeval *timeout,
1307 LDAPMessage **res ));
1315 ldap_ufn_search_c LDAP_P(( /* deprecated */
1317 LDAP_CONST char *ufn,
1321 int (*cancelproc)( void *cl ),
1322 void *cancelparm ));
1325 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1327 LDAP_CONST char *ufn,
1331 int (*cancelproc)( void *cl ),
1338 ldap_ufn_search_s LDAP_P(( /* deprecated */
1340 LDAP_CONST char *ufn,
1343 LDAPMessage **res ));
1345 LDAP_F( LDAPFiltDesc *)
1346 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1348 LDAP_CONST char *fname ));
1351 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1353 LDAP_CONST char *prefix ));
1356 ldap_ufn_timeout LDAP_P(( /* deprecated */
1364 ldap_unbind LDAP_P(( /* deprecated */
1368 ldap_unbind_s LDAP_P(( /* deprecated */
1372 ldap_unbind_ext LDAP_P((
1374 LDAPControl **serverctrls,
1375 LDAPControl **clientctrls));
1378 ldap_unbind_ext_s LDAP_P((
1380 LDAPControl **serverctrls,
1381 LDAPControl **clientctrls));
1387 LDAP_F( LDAPFiltDesc *)
1388 ldap_init_getfilter LDAP_P(( /* deprecated */
1389 LDAP_CONST char *fname ));
1391 LDAP_F( LDAPFiltDesc *)
1392 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1393 /* LDAP_CONST */ char *buf,
1394 ber_len_t buflen ));
1396 LDAP_F( LDAPFiltInfo *)
1397 ldap_getfirstfilter LDAP_P(( /* deprecated */
1399 /* LDAP_CONST */ char *tagpat,
1400 /* LDAP_CONST */ char *value ));
1402 LDAP_F( LDAPFiltInfo *)
1403 ldap_getnextfilter LDAP_P(( /* deprecated */
1404 LDAPFiltDesc *lfdp ));
1407 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1409 LDAP_CONST char *prefix,
1410 LDAP_CONST char *suffix ));
1413 ldap_build_filter LDAP_P(( /* deprecated */
1416 LDAP_CONST char *pattern,
1417 LDAP_CONST char *prefix,
1418 LDAP_CONST char *suffix,
1419 LDAP_CONST char *attr,
1420 LDAP_CONST char *value,
1429 ldap_memalloc LDAP_P((
1433 ldap_memrealloc LDAP_P((
1438 ldap_memcalloc LDAP_P((
1443 ldap_memfree LDAP_P((
1447 ldap_memvfree LDAP_P((
1451 ldap_strdup LDAP_P((
1452 LDAP_CONST char * ));
1455 ldap_getfilter_free LDAP_P((
1456 LDAPFiltDesc *lfdp ));
1459 ldap_mods_free LDAP_P((
1469 ldap_friendly_name LDAP_P(( /* deprecated */
1470 LDAP_CONST char *filename,
1471 /* LDAP_CONST */ char *uname,
1472 LDAPFriendlyMap **map ));
1475 ldap_free_friendlymap LDAP_P(( /* deprecated */
1476 LDAPFriendlyMap **map ));
1484 cldap_open LDAP_P(( /* deprecated */
1485 LDAP_CONST char *host,
1489 cldap_close LDAP_P(( /* deprecated */
1493 cldap_search_s LDAP_P(( /* deprecated */
1495 LDAP_CONST char *base,
1497 LDAP_CONST char *filter,
1504 cldap_setretryinfo LDAP_P(( /* deprecated */
1513 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1514 LDAP_CONST char *left,
1515 LDAP_CONST char *right ));
1517 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1518 LDAP_CONST void *left,
1519 LDAP_CONST void *right ));
1522 ldap_sort_entries LDAP_P(( LDAP *ld,
1523 LDAPMessage **chain,
1524 LDAP_CONST char *attr,
1525 LDAP_SORT_AD_CMP_PROC *cmp ));
1527 LDAP_F( int ) /* deprecated */
1528 ldap_sort_values LDAP_P((
1531 LDAP_SORT_AV_CMP_PROC *cmp ));
1533 LDAP_F( int ) /* deprecated */
1534 ldap_sort_strcasecmp LDAP_P((
1536 LDAP_CONST void *b ));
1542 * need _ext varients
1545 ldap_is_ldap_url LDAP_P((
1546 LDAP_CONST char *url ));
1549 ldap_is_ldaps_url LDAP_P((
1550 LDAP_CONST char *url ));
1553 ldap_is_ldapi_url LDAP_P((
1554 LDAP_CONST char *url ));
1557 ldap_url_parse LDAP_P((
1558 LDAP_CONST char *url,
1559 LDAPURLDesc **ludpp ));
1562 ldap_free_urldesc LDAP_P((
1563 LDAPURLDesc *ludp ));
1566 ldap_url_search LDAP_P((
1568 LDAP_CONST char *url,
1572 ldap_url_search_s LDAP_P((
1574 LDAP_CONST char *url,
1576 LDAPMessage **res ));
1579 ldap_url_search_st LDAP_P((
1581 LDAP_CONST char *url,
1583 struct timeval *timeout,
1584 LDAPMessage **res ));
1590 * structure for a sort-key
1592 typedef struct ldapsortkey {
1593 char * attributeType;
1594 char * orderingRule;
1599 ldap_create_sort_keylist LDAP_P((
1600 LDAPSortKey ***sortKeyList,
1604 ldap_free_sort_keylist LDAP_P((
1605 LDAPSortKey **sortkeylist ));
1608 ldap_create_sort_control LDAP_P((
1610 LDAPSortKey **keyList,
1612 LDAPControl **ctrlp ));
1615 ldap_parse_sort_control LDAP_P((
1617 LDAPControl **ctrlp,
1618 unsigned long *result,
1619 char **attribute ));
1627 * structure for virtul list.
1629 typedef struct ldapvlvinfo {
1631 unsigned long ldvlv_before_count;
1632 unsigned long ldvlv_after_count;
1633 unsigned long ldvlv_offset;
1634 unsigned long ldvlv_count;
1635 struct berval *ldvlv_attrvalue;
1636 struct berval *ldvlv_context;
1637 void *ldvlv_extradata;
1641 ldap_create_vlv_control LDAP_P((
1643 LDAPVLVInfo *ldvlistp,
1644 LDAPControl **ctrlp ));
1647 ldap_parse_vlv_control LDAP_P((
1649 LDAPControl **ctrls,
1650 unsigned long *target_posp,
1651 unsigned long *list_countp,
1652 struct berval **contextp,
1657 #endif /* _LDAP_H */