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.
29 /* include version and API feature defines */
30 #include <ldap_features.h>
34 #define LDAP_VERSION1 1
35 #define LDAP_VERSION2 2
36 #define LDAP_VERSION3 3
38 #define LDAP_VERSION_MIN LDAP_VERSION2
39 #define LDAP_VERSION LDAP_VERSION2
40 #define LDAP_VERSION_MAX LDAP_VERSION3
43 * We'll use 2000+draft revision for our API version number
44 * As such, the number will be above the old RFC but below
45 * whatever number does finally get assigned
47 #define LDAP_API_VERSION 2004
48 #define LDAP_VENDOR_NAME "OpenLDAP"
49 /* We'll eventually release as 20000 */
51 /* OpenLDAP API Features */
52 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
54 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
55 ( defined( LDAP_THREAD_SAFE ) && \
56 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
57 /* -lldap may or may not be thread safe */
58 /* -lldap_r, if available, is always thread safe */
59 # define LDAP_API_FEATURE_THREAD_SAFE 1
61 #if defined( LDAP_THREAD_SAFE ) && \
62 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
63 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
64 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
67 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
68 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
70 #define LDAP_ROOT_DSE ""
71 #define LDAP_NO_ATTRS "1.1"
72 #define LDAP_ALL_USER_ATTRIBUTES "*"
73 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
76 * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
77 * 0x0000 - 0x0fff reserved for api options
78 * 0x1000 - 0x3fff reserved for api extended options
79 * 0x4000 - 0x7fff reserved for private and experimental options
81 #define LDAP_OPT_API_INFO 0x0000
82 #define LDAP_OPT_DESC 0x0001 /* deprecated */
83 #define LDAP_OPT_DEREF 0x0002
84 #define LDAP_OPT_SIZELIMIT 0x0003
85 #define LDAP_OPT_TIMELIMIT 0x0004
86 /* 0x05 - 0x07 not defined by current draft */
87 #define LDAP_OPT_REFERRALS 0x0008
88 #define LDAP_OPT_RESTART 0x0009
89 /* 0x0a - 0x10 not defined by current draft */
90 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
91 #define LDAP_OPT_SERVER_CONTROLS 0x0012
92 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
93 /* 0x14 not defined by current draft */
94 #define LDAP_OPT_API_FEATURE_INFO 0x0015
96 /* 0x16 - 0x2f not defined by current draft */
97 #define LDAP_OPT_HOST_NAME 0x0030
98 #define LDAP_OPT_ERROR_NUMBER 0x0031
99 #define LDAP_OPT_ERROR_STRING 0x0032
100 #define LDAP_OPT_MATCHED_DN 0x0033
102 /* 0x34 - 0x0fff not defined by current draft */
104 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */
106 /* private and experimental options */
107 /* OpenLDAP specific options */
108 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
109 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
110 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
111 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
112 #define LDAP_OPT_URI 0x5006
114 /* OpenLDAP TLS options */
115 #define LDAP_OPT_X_TLS_CACERTFILE 0x6001
116 #define LDAP_OPT_X_TLS_CACERTDIR 0x6002
117 #define LDAP_OPT_X_TLS_CERT 0x6003
118 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
119 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
120 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
121 #define LDAP_OPT_X_TLS 0x6007
122 #define LDAP_OPT_X_TLS_PROTOCOL 0x6008
123 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6009
124 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x600a
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
132 /* OpenLDAP SASL options */
133 #define LDAP_OPT_X_SASL_MECH 0x6100
134 #define LDAP_OPT_X_SASL_REALM 0x6101
135 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
136 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
137 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
138 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
139 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
140 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
141 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
142 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
146 #define LDAP_OPT_ON ((void *) 1)
147 #define LDAP_OPT_OFF ((void *) 0)
150 * ldap_get_option() and ldap_set_option() return values.
151 * As later versions may return other values indicating
152 * failure, current applications should only compare returned
153 * value against LDAP_OPT_SUCCESS.
155 #define LDAP_OPT_SUCCESS 0
156 #define LDAP_OPT_ERROR (-1)
158 #define LDAP_API_INFO_VERSION (1)
159 typedef struct ldapapiinfo {
160 int ldapai_info_version; /* version of LDAPAPIInfo (1) */
161 int ldapai_api_version; /* revision of API supported */
162 int ldapai_protocol_version; /* highest LDAP version supported */
163 char **ldapai_extensions; /* names of API extensions */
164 char *ldapai_vendor_name; /* name of supplier */
165 int ldapai_vendor_version; /* supplier-specific version * 100 */
168 #define LDAP_FEATURE_INFO_VERSION (1) /* version of api feature structure */
169 typedef struct ldap_apifeature_info {
170 int ldapaif_info_version; /* version of this struct (1) */
171 char* ldapaif_name; /* matches LDAP_API_FEATURE_... less the prefix */
172 int ldapaif_version; /* matches the value LDAP_API_FEATURE_... */
173 } LDAPAPIFeatureInfo;
175 typedef struct ldapcontrol {
177 struct berval ldctl_value;
178 char ldctl_iscritical;
182 /* chase referrals controls */
183 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
184 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
185 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
187 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
189 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
190 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
191 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
192 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
194 /* Experimental Controls */
196 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
197 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
198 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
199 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
201 /* LDAP Unsolicited Notifications */
202 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
203 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
205 /* LDAP Extended Operations */
206 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
208 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
209 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
210 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
211 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
212 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
215 * specific LDAP instantiations of BER types we know about
218 /* Overview of LBER tag construction
225 * 1 0 = CONTEXT-SPECIFIC
232 * | 5 ... 1 | TAG-NUMBER
236 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
237 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
238 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
239 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
240 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
241 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
243 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
245 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
246 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
247 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
248 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
250 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
253 /* possible operations a client can invoke */
254 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
255 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
256 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
257 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
258 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
259 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
260 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
261 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
262 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
263 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
264 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
265 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
267 /* possible result types a server can return */
268 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
269 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
270 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
271 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
272 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
273 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
274 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
275 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
276 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
277 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
278 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
279 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
280 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
282 #define LDAP_RES_ANY (-1)
283 #define LDAP_RES_UNSOLICITED (0)
287 #define LDAP_SASL_SIMPLE ((char*)0)
288 #define LDAP_SASL_NULL ("")
291 /* authentication methods available */
292 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
293 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
294 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + primitive */
295 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
296 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
297 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
301 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
302 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
303 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
304 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
305 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
306 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
307 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
308 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
309 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
310 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
312 /* extended filter component types */
313 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
314 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
315 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
316 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
318 /* substring filter component types */
319 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
320 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
321 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
324 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1)
325 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
326 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
327 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
329 /* substring filter component types */
330 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
331 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
332 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
335 * possible error codes we can return
338 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
340 #define LDAP_SUCCESS 0x00
341 #define LDAP_OPERATIONS_ERROR 0x01
342 #define LDAP_PROTOCOL_ERROR 0x02
343 #define LDAP_TIMELIMIT_EXCEEDED 0x03
344 #define LDAP_SIZELIMIT_EXCEEDED 0x04
345 #define LDAP_COMPARE_FALSE 0x05
346 #define LDAP_COMPARE_TRUE 0x06
347 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
348 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
349 #define LDAP_STRONG_AUTH_REQUIRED 0x08
350 #define LDAP_PARTIAL_RESULTS 0x09 /* not listed in v3 */
352 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
353 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
354 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
355 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
356 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
358 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
360 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
361 #define LDAP_UNDEFINED_TYPE 0x11
362 #define LDAP_INAPPROPRIATE_MATCHING 0x12
363 #define LDAP_CONSTRAINT_VIOLATION 0x13
364 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
365 #define LDAP_INVALID_SYNTAX 0x15
367 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
369 #define LDAP_NO_SUCH_OBJECT 0x20
370 #define LDAP_ALIAS_PROBLEM 0x21
371 #define LDAP_INVALID_DN_SYNTAX 0x22
372 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
373 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
375 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
377 #define LDAP_INAPPROPRIATE_AUTH 0x30
378 #define LDAP_INVALID_CREDENTIALS 0x31
379 #define LDAP_INSUFFICIENT_ACCESS 0x32
381 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
383 #define LDAP_BUSY 0x33
384 #define LDAP_UNAVAILABLE 0x34
385 #define LDAP_UNWILLING_TO_PERFORM 0x35
386 #define LDAP_LOOP_DETECT 0x36
388 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
390 #define LDAP_NAMING_VIOLATION 0x40
391 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
392 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
393 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
394 #define LDAP_ALREADY_EXISTS 0x44
395 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
396 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
397 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
399 #define LDAP_OTHER 0x50
401 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
403 /* reserved for APIs */
404 #define LDAP_SERVER_DOWN 0x51
405 #define LDAP_LOCAL_ERROR 0x52
406 #define LDAP_ENCODING_ERROR 0x53
407 #define LDAP_DECODING_ERROR 0x54
408 #define LDAP_TIMEOUT 0x55
409 #define LDAP_AUTH_UNKNOWN 0x56
410 #define LDAP_FILTER_ERROR 0x57
411 #define LDAP_USER_CANCELLED 0x58
412 #define LDAP_PARAM_ERROR 0x59
413 #define LDAP_NO_MEMORY 0x5a
415 /* used but not reserved for APIs */
416 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
417 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
418 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
419 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
420 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
421 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
422 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
425 * This structure represents both ldap messages and ldap responses.
426 * These are really the same, except in the case of search responses,
427 * where a response has multiple messages.
430 typedef struct ldapmsg LDAPMessage;
432 /* for modifications */
433 typedef struct ldapmod {
436 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
437 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
438 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
439 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
440 /* IMPORTANT: do not use code 0x1000 (or above),
441 * it is used internally by the backends!
442 * (see ldap/servers/slapd/slap.h)
448 struct berval **modv_bvals;
450 #define mod_values mod_vals.modv_strvals
451 #define mod_bvalues mod_vals.modv_bvals
455 * structures for ldap getfilter routines
458 typedef struct ldap_filt_info {
463 struct ldap_filt_info *lfi_next;
466 typedef struct ldap_filt_list {
470 LDAPFiltInfo *lfl_ilist;
471 struct ldap_filt_list *lfl_next;
475 #define LDAP_FILT_MAXSIZ 1024
477 typedef struct ldap_filt_desc {
478 LDAPFiltList *lfd_filtlist;
479 LDAPFiltInfo *lfd_curfip;
480 LDAPFiltInfo lfd_retfi;
481 char lfd_filter[ LDAP_FILT_MAXSIZ ];
483 char *lfd_curvalcopy;
484 char **lfd_curvalwords;
485 char *lfd_filtprefix;
486 char *lfd_filtsuffix;
491 * structure representing an ldap session which can
492 * encompass connections to multiple servers (in the
493 * face of referrals).
495 typedef struct ldap LDAP;
497 #define LDAP_DEREF_NEVER 0x00
498 #define LDAP_DEREF_SEARCHING 0x01
499 #define LDAP_DEREF_FINDING 0x02
500 #define LDAP_DEREF_ALWAYS 0x03
502 #define LDAP_NO_LIMIT 0
504 /* how many messages to retrieve results for */
505 #define LDAP_MSG_ONE 0x00
506 #define LDAP_MSG_ALL 0x01
507 #define LDAP_MSG_RECEIVED 0x02
510 * structure for ldap friendly mapping routines
513 typedef struct ldap_friendly {
519 * types for ldap URL handling
521 typedef struct ldap_url_desc {
522 struct ldap_url_desc *lud_next;
534 #define LDAP_URL_SUCCESS 0x00 /* Success */
535 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
536 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
538 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
539 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
540 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
541 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
542 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
543 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
544 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
545 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
548 * The API draft spec says we should declare (or cause to be declared)
549 * 'struct timeval'. We don't. See IETF LDAPext discussions.
557 ldap_get_option LDAP_P((
563 ldap_set_option LDAP_P((
566 LDAP_CONST void *invalue));
568 /* V3 REBIND Function Callback Prototype */
569 typedef int (LDAP_REBIND_PROC) LDAP_P((
570 LDAP *ld, LDAP_CONST char *url, int request, ber_int_t msgid ));
573 ldap_set_rebind_proc LDAP_P((
575 LDAP_REBIND_PROC *ldap_proc));
581 ldap_create_control LDAP_P((
582 const char *requestOID,
585 LDAPControl **ctrlp ));
588 ldap_control_free LDAP_P((
589 LDAPControl *ctrl ));
592 ldap_controls_free LDAP_P((
593 LDAPControl **ctrls ));
599 ldap_domain2dn LDAP_P((
600 LDAP_CONST char* domain,
604 ldap_dn2domain LDAP_P((
609 ldap_domain2hostlist LDAP_P((
610 LDAP_CONST char *domain,
617 ldap_extended_operation LDAP_P((
619 LDAP_CONST char *reqoid,
620 struct berval *reqdata,
621 LDAPControl **serverctrls,
622 LDAPControl **clientctrls,
626 ldap_extended_operation_s LDAP_P((
628 LDAP_CONST char *reqoid,
629 struct berval *reqdata,
630 LDAPControl **serverctrls,
631 LDAPControl **clientctrls,
633 struct berval **retdatap ));
636 ldap_parse_extended_result LDAP_P((
640 struct berval **retdatap,
644 ldap_parse_extended_partial LDAP_P((
648 struct berval **retdatap,
649 LDAPControl ***serverctrls,
656 ldap_abandon_ext LDAP_P((
659 LDAPControl **serverctrls,
660 LDAPControl **clientctrls ));
663 ldap_abandon LDAP_P(( /* deprecated */
672 ldap_add_ext LDAP_P((
676 LDAPControl **serverctrls,
677 LDAPControl **clientctrls,
681 ldap_add_ext_s LDAP_P((
685 LDAPControl **serverctrls,
686 LDAPControl **clientctrls ));
689 ldap_add LDAP_P(( /* deprecated */
695 ldap_add_s LDAP_P(( /* deprecated */
705 ldap_sasl_bind LDAP_P((
708 LDAP_CONST char *mechanism,
710 LDAPControl **serverctrls,
711 LDAPControl **clientctrls,
714 /* Interaction flags (should be passed about in a control)
715 * Automatic (default): use defaults, prompt otherwise
716 * Interactive: prompt always
717 * Quiet: never prompt
719 #define LDAP_SASL_AUTOMATIC 0U
720 #define LDAP_SASL_INTERACTIVE 1U
721 #define LDAP_SASL_QUIET 2U
724 * V3 SASL Interaction Function Callback Prototype
725 * when using Cyrus SASL, interact is pointer to sasl_interact_t
726 * should likely passed in a control (and provided controls)
728 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
729 LDAP *ld, unsigned flags, void* defaults, void *interact ));
732 ldap_sasl_interactive_bind_s LDAP_P((
734 LDAP_CONST char *dn, /* usually NULL */
735 LDAP_CONST char *saslMechanism,
736 LDAPControl **serverControls,
737 LDAPControl **clientControls,
739 /* should be client controls */
741 LDAP_SASL_INTERACT_PROC *proc,
745 ldap_sasl_bind_s LDAP_P((
748 LDAP_CONST char *mechanism,
750 LDAPControl **serverctrls,
751 LDAPControl **clientctrls,
752 struct berval **servercredp ));
755 ldap_parse_sasl_bind_result LDAP_P((
758 struct berval **servercredp,
766 ldap_bind LDAP_P(( /* deprecated */
768 LDAP_CONST char *who,
769 LDAP_CONST char *passwd,
773 ldap_bind_s LDAP_P(( /* deprecated */
775 LDAP_CONST char *who,
776 LDAP_CONST char *cred,
783 ldap_simple_bind LDAP_P((
785 LDAP_CONST char *who,
786 LDAP_CONST char *passwd ));
789 ldap_simple_bind_s LDAP_P((
791 LDAP_CONST char *who,
792 LDAP_CONST char *passwd ));
800 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
802 LDAP_CONST char *who ));
805 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
807 LDAP_CONST char *who ));
810 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
812 LDAP_CONST char *who ));
815 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
817 LDAP_CONST char *who ));
820 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
822 LDAP_CONST char *who ));
829 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
832 ldap_disable_cache LDAP_P(( LDAP *ld ));
835 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
838 ldap_destroy_cache LDAP_P(( LDAP *ld ));
841 ldap_flush_cache LDAP_P(( LDAP *ld ));
844 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
847 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
854 ldap_compare_ext LDAP_P((
857 LDAP_CONST char *attr,
858 struct berval *bvalue,
859 LDAPControl **serverctrls,
860 LDAPControl **clientctrls,
864 ldap_compare_ext_s LDAP_P((
867 LDAP_CONST char *attr,
868 struct berval *bvalue,
869 LDAPControl **serverctrls,
870 LDAPControl **clientctrls ));
873 ldap_compare LDAP_P(( /* deprecated */
876 LDAP_CONST char *attr,
877 LDAP_CONST char *value ));
880 ldap_compare_s LDAP_P(( /* deprecated */
883 LDAP_CONST char *attr,
884 LDAP_CONST char *value ));
891 ldap_delete_ext LDAP_P((
894 LDAPControl **serverctrls,
895 LDAPControl **clientctrls,
899 ldap_delete_ext_s LDAP_P((
902 LDAPControl **serverctrls,
903 LDAPControl **clientctrls ));
906 ldap_delete LDAP_P(( /* deprecated */
908 LDAP_CONST char *dn ));
911 ldap_delete_s LDAP_P(( /* deprecated */
913 LDAP_CONST char *dn ));
920 ldap_parse_result LDAP_P((
927 LDAPControl ***serverctrls,
931 ldap_err2string LDAP_P((
935 ldap_result2error LDAP_P(( /* deprecated */
941 ldap_perror LDAP_P(( /* deprecated */
943 LDAP_CONST char *s ));
950 ldap_modify_ext LDAP_P((
954 LDAPControl **serverctrls,
955 LDAPControl **clientctrls,
959 ldap_modify_ext_s LDAP_P((
963 LDAPControl **serverctrls,
964 LDAPControl **clientctrls ));
967 ldap_modify LDAP_P(( /* deprecated */
973 ldap_modify_s LDAP_P(( /* deprecated */
986 LDAP_CONST char *newrdn,
987 LDAP_CONST char *newSuperior,
989 LDAPControl **sctrls,
990 LDAPControl **cctrls,
994 ldap_rename_s LDAP_P((
997 LDAP_CONST char *newrdn,
998 LDAP_CONST char *newSuperior,
1000 LDAPControl **sctrls,
1001 LDAPControl **cctrls ));
1004 ldap_rename2 LDAP_P(( /* deprecated */
1006 LDAP_CONST char *dn,
1007 LDAP_CONST char *newrdn,
1008 LDAP_CONST char *newSuperior,
1009 int deleteoldrdn ));
1012 ldap_rename2_s LDAP_P(( /* deprecated */
1014 LDAP_CONST char *dn,
1015 LDAP_CONST char *newrdn,
1016 LDAP_CONST char *newSuperior,
1017 int deleteoldrdn ));
1020 ldap_modrdn LDAP_P(( /* deprecated */
1022 LDAP_CONST char *dn,
1023 LDAP_CONST char *newrdn ));
1026 ldap_modrdn_s LDAP_P(( /* deprecated */
1028 LDAP_CONST char *dn,
1029 LDAP_CONST char *newrdn ));
1032 ldap_modrdn2 LDAP_P(( /* deprecated */
1034 LDAP_CONST char *dn,
1035 LDAP_CONST char *newrdn,
1036 int deleteoldrdn ));
1039 ldap_modrdn2_s LDAP_P(( /* deprecated */
1041 LDAP_CONST char *dn,
1042 LDAP_CONST char *newrdn,
1051 LDAP_CONST char *host,
1055 ldap_open LDAP_P(( /* deprecated */
1056 LDAP_CONST char *host,
1060 ldap_create LDAP_P((
1064 ldap_initialize LDAP_P((
1066 LDAP_CONST char *url ));
1069 ldap_start_tls_s LDAP_P((
1071 LDAPControl **serverctrls,
1072 LDAPControl **clientctrls ));
1077 LDAP_F( LDAPMessage *)
1078 ldap_first_message LDAP_P((
1080 LDAPMessage *chain ));
1082 LDAP_F( LDAPMessage *)
1083 ldap_next_message LDAP_P((
1085 LDAPMessage *msg ));
1088 ldap_count_messages LDAP_P((
1090 LDAPMessage *chain ));
1096 LDAP_F( LDAPMessage *)
1097 ldap_first_reference LDAP_P((
1099 LDAPMessage *chain ));
1101 LDAP_F( LDAPMessage *)
1102 ldap_next_reference LDAP_P((
1104 LDAPMessage *ref ));
1107 ldap_count_references LDAP_P((
1109 LDAPMessage *chain ));
1112 ldap_parse_reference LDAP_P((
1116 LDAPControl ***serverctrls,
1123 LDAP_F( LDAPMessage *)
1124 ldap_first_entry LDAP_P((
1126 LDAPMessage *chain ));
1128 LDAP_F( LDAPMessage *)
1129 ldap_next_entry LDAP_P((
1131 LDAPMessage *entry ));
1134 ldap_count_entries LDAP_P((
1136 LDAPMessage *chain ));
1139 ldap_get_entry_controls LDAP_P((
1142 LDAPControl ***serverctrls));
1148 LDAP_F( LDAPMessage *)
1149 ldap_delete_result_entry LDAP_P((
1154 ldap_add_result_entry LDAP_P((
1163 ldap_get_dn LDAP_P((
1165 LDAPMessage *entry ));
1168 ldap_dn2ufn LDAP_P((
1169 LDAP_CONST char *dn ));
1172 ldap_explode_dn LDAP_P((
1173 LDAP_CONST char *dn,
1177 ldap_explode_rdn LDAP_P((
1178 LDAP_CONST char *rdn,
1182 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1185 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1191 ldap_first_attribute LDAP_P((
1194 BerElement **ber ));
1197 ldap_next_attribute LDAP_P((
1207 ldap_get_values LDAP_P((
1210 LDAP_CONST char *target ));
1212 LDAP_F( struct berval **)
1213 ldap_get_values_len LDAP_P((
1216 LDAP_CONST char *target ));
1219 ldap_count_values LDAP_P((
1223 ldap_count_values_len LDAP_P((
1224 struct berval **vals ));
1227 ldap_value_free LDAP_P((
1231 ldap_value_free_len LDAP_P((
1232 struct berval **vals ));
1238 ldap_result LDAP_P((
1242 struct timeval *timeout,
1243 LDAPMessage **result ));
1246 ldap_msgtype LDAP_P((
1254 ldap_msgfree LDAP_P((
1258 ldap_msgdelete LDAP_P((
1267 ldap_search_ext LDAP_P((
1269 LDAP_CONST char *base,
1271 LDAP_CONST char *filter,
1274 LDAPControl **serverctrls,
1275 LDAPControl **clientctrls,
1276 struct timeval *timeout,
1281 ldap_search_ext_s LDAP_P((
1283 LDAP_CONST char *base,
1285 LDAP_CONST char *filter,
1288 LDAPControl **serverctrls,
1289 LDAPControl **clientctrls,
1290 struct timeval *timeout,
1292 LDAPMessage **res ));
1295 ldap_search LDAP_P(( /* deprecated */
1297 LDAP_CONST char *base,
1299 LDAP_CONST char *filter,
1304 ldap_search_s LDAP_P(( /* deprecated */
1306 LDAP_CONST char *base,
1308 LDAP_CONST char *filter,
1311 LDAPMessage **res ));
1314 ldap_search_st LDAP_P(( /* deprecated */
1316 LDAP_CONST char *base,
1318 LDAP_CONST char *filter,
1321 struct timeval *timeout,
1322 LDAPMessage **res ));
1330 ldap_ufn_search_c LDAP_P(( /* deprecated */
1332 LDAP_CONST char *ufn,
1336 int (*cancelproc)( void *cl ),
1337 void *cancelparm ));
1340 ldap_ufn_search_ct LDAP_P(( /* deprecated */
1342 LDAP_CONST char *ufn,
1346 int (*cancelproc)( void *cl ),
1353 ldap_ufn_search_s LDAP_P(( /* deprecated */
1355 LDAP_CONST char *ufn,
1358 LDAPMessage **res ));
1360 LDAP_F( LDAPFiltDesc *)
1361 ldap_ufn_setfilter LDAP_P(( /* deprecated */
1363 LDAP_CONST char *fname ));
1366 ldap_ufn_setprefix LDAP_P(( /* deprecated */
1368 LDAP_CONST char *prefix ));
1371 ldap_ufn_timeout LDAP_P(( /* deprecated */
1379 ldap_unbind LDAP_P(( /* deprecated */
1383 ldap_unbind_s LDAP_P(( /* deprecated */
1387 ldap_unbind_ext LDAP_P((
1389 LDAPControl **serverctrls,
1390 LDAPControl **clientctrls));
1393 ldap_unbind_ext_s LDAP_P((
1395 LDAPControl **serverctrls,
1396 LDAPControl **clientctrls));
1402 LDAP_F( LDAPFiltDesc *)
1403 ldap_init_getfilter LDAP_P(( /* deprecated */
1404 LDAP_CONST char *fname ));
1406 LDAP_F( LDAPFiltDesc *)
1407 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1408 /* LDAP_CONST */ char *buf,
1409 ber_len_t buflen ));
1411 LDAP_F( LDAPFiltInfo *)
1412 ldap_getfirstfilter LDAP_P(( /* deprecated */
1414 /* LDAP_CONST */ char *tagpat,
1415 /* LDAP_CONST */ char *value ));
1417 LDAP_F( LDAPFiltInfo *)
1418 ldap_getnextfilter LDAP_P(( /* deprecated */
1419 LDAPFiltDesc *lfdp ));
1422 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1424 LDAP_CONST char *prefix,
1425 LDAP_CONST char *suffix ));
1428 ldap_build_filter LDAP_P(( /* deprecated */
1431 LDAP_CONST char *pattern,
1432 LDAP_CONST char *prefix,
1433 LDAP_CONST char *suffix,
1434 LDAP_CONST char *attr,
1435 LDAP_CONST char *value,
1444 ldap_memalloc LDAP_P((
1448 ldap_memrealloc LDAP_P((
1453 ldap_memcalloc LDAP_P((
1458 ldap_memfree LDAP_P((
1462 ldap_memvfree LDAP_P((
1466 ldap_strdup LDAP_P((
1467 LDAP_CONST char * ));
1470 ldap_getfilter_free LDAP_P((
1471 LDAPFiltDesc *lfdp ));
1474 ldap_mods_free LDAP_P((
1484 ldap_friendly_name LDAP_P(( /* deprecated */
1485 LDAP_CONST char *filename,
1486 /* LDAP_CONST */ char *uname,
1487 LDAPFriendlyMap **map ));
1490 ldap_free_friendlymap LDAP_P(( /* deprecated */
1491 LDAPFriendlyMap **map ));
1497 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1498 LDAP_CONST char *left,
1499 LDAP_CONST char *right ));
1501 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1502 LDAP_CONST void *left,
1503 LDAP_CONST void *right ));
1506 ldap_sort_entries LDAP_P(( LDAP *ld,
1507 LDAPMessage **chain,
1508 LDAP_CONST char *attr,
1509 LDAP_SORT_AD_CMP_PROC *cmp ));
1511 LDAP_F( int ) /* deprecated */
1512 ldap_sort_values LDAP_P((
1515 LDAP_SORT_AV_CMP_PROC *cmp ));
1517 LDAP_F( int ) /* deprecated */
1518 ldap_sort_strcasecmp LDAP_P((
1520 LDAP_CONST void *b ));
1526 * need _ext varients
1529 ldap_is_ldap_url LDAP_P((
1530 LDAP_CONST char *url ));
1533 ldap_is_ldaps_url LDAP_P((
1534 LDAP_CONST char *url ));
1537 ldap_is_ldapi_url LDAP_P((
1538 LDAP_CONST char *url ));
1541 ldap_url_parse LDAP_P((
1542 LDAP_CONST char *url,
1543 LDAPURLDesc **ludpp ));
1546 ldap_free_urldesc LDAP_P((
1547 LDAPURLDesc *ludp ));
1550 ldap_url_search LDAP_P((
1552 LDAP_CONST char *url,
1556 ldap_url_search_s LDAP_P((
1558 LDAP_CONST char *url,
1560 LDAPMessage **res ));
1563 ldap_url_search_st LDAP_P((
1565 LDAP_CONST char *url,
1567 struct timeval *timeout,
1568 LDAPMessage **res ));
1574 * structure for a sort-key
1576 typedef struct ldapsortkey {
1577 char * attributeType;
1578 char * orderingRule;
1583 ldap_create_sort_keylist LDAP_P((
1584 LDAPSortKey ***sortKeyList,
1588 ldap_free_sort_keylist LDAP_P((
1589 LDAPSortKey **sortkeylist ));
1592 ldap_create_sort_control LDAP_P((
1594 LDAPSortKey **keyList,
1596 LDAPControl **ctrlp ));
1599 ldap_parse_sort_control LDAP_P((
1601 LDAPControl **ctrlp,
1602 unsigned long *result,
1603 char **attribute ));
1611 * structure for virtul list.
1613 typedef struct ldapvlvinfo {
1615 unsigned long ldvlv_before_count;
1616 unsigned long ldvlv_after_count;
1617 unsigned long ldvlv_offset;
1618 unsigned long ldvlv_count;
1619 struct berval *ldvlv_attrvalue;
1620 struct berval *ldvlv_context;
1621 void *ldvlv_extradata;
1625 ldap_create_vlv_control LDAP_P((
1627 LDAPVLVInfo *ldvlistp,
1628 LDAPControl **ctrlp ));
1631 ldap_parse_vlv_control LDAP_P((
1633 LDAPControl **ctrls,
1634 unsigned long *target_posp,
1635 unsigned long *list_countp,
1636 struct berval **contextp,
1641 #endif /* _LDAP_H */