3 * Copyright 1998-2002 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted only as authorized by the OpenLDAP
8 * Public License. A copy of this license is available at
9 * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10 * top-level directory of the distribution.
13 * Copyright (c) 1990 Regents of the University of Michigan.
14 * All rights reserved.
16 * Redistribution and use in source and binary forms are permitted
17 * provided that this notice is preserved and that due credit is given
18 * to the University of Michigan at Ann Arbor. The name of the University
19 * may not be used to endorse or promote products derived from this
20 * software without specific prior written permission. This software
21 * is provided ``as is'' without express or implied warranty.
30 /* include version and API feature defines */
31 #include <ldap_features.h>
35 #define LDAP_VERSION1 1
36 #define LDAP_VERSION2 2
37 #define LDAP_VERSION3 3
39 #define LDAP_VERSION_MIN LDAP_VERSION2
40 #define LDAP_VERSION LDAP_VERSION2
41 #define LDAP_VERSION_MAX LDAP_VERSION3
44 * We'll use 2000+draft revision for our API version number
45 * As such, the number will be above the old RFC but below
46 * whatever number does finally get assigned
48 #define LDAP_API_VERSION 2004
49 #define LDAP_VENDOR_NAME "OpenLDAP"
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 0x6000
116 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
117 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
118 #define LDAP_OPT_X_TLS_CACERTDIR 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_PROTOCOL 0x6007 */
123 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
124 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
125 #define LDAP_OPT_X_TLS_SSL_CTX 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;
185 /* chase referrals client control (not yet implemented) */
186 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
187 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
188 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
191 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
192 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1"
193 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.1.10.2"
196 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
197 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
198 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
199 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
201 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319"
204 #ifdef LDAP_CLIENT_UPDATE
205 #define LDAP_CONTROL_CLIENT_UPDATE "1.3.6.1.4.1.4203.666.5.3"
206 #define LDAP_CONTROL_ENTRY_UPDATE "1.3.6.1.4.1.4203.666.5.4"
207 #define LDAP_CONTROL_CLIENT_UPDATE_DONE "1.3.6.1.4.1.4203.666.5.5"
210 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
211 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
212 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
213 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
215 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3"
217 /* LDAP Unsolicited Notifications */
218 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
219 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
221 /* LDAP Extended Operations */
222 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
224 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
225 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
226 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
227 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
228 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
230 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
233 #define LDAP_FEATURE_ALL_OPERATIONAL_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* + */
234 #define LDAP_FEATURE_OBJECTCLASS_ATTRS "1.3.6.1.4.1.4203.1.5.2"
235 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
236 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
237 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
240 * specific LDAP instantiations of BER types we know about
243 /* Overview of LBER tag construction
250 * 1 0 = CONTEXT-SPECIFIC
257 * | 5 ... 1 | TAG-NUMBER
261 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
262 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
264 #ifdef LDAP_CLIENT_UPDATE
265 #define LDAP_TAG_INTERVAL ((ber_tag_t) 0x02U) /* integer */
266 #endif /* LDAP_CLIENT_UPDATE */
268 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
269 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
271 #ifdef LDAP_CLIENT_UPDATE
272 #define LDAP_TAG_COOKIE ((ber_tag_t) 0x30U) /* sequence */
273 #endif /* LDAP_CLIENT_UPDATE */
275 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
276 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
278 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
280 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
281 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
282 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
283 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
285 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
288 /* possible operations a client can invoke */
289 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
290 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
291 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
292 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
293 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
294 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
295 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
296 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
297 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
298 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
299 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
300 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
302 /* possible result types a server can return */
303 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
304 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
305 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
306 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
307 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
308 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
309 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
310 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
311 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
312 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
313 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
314 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
315 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
317 #define LDAP_RES_ANY (-1)
318 #define LDAP_RES_UNSOLICITED (0)
322 #define LDAP_SASL_SIMPLE ((char*)0)
323 #define LDAP_SASL_NULL ("")
326 /* authentication methods available */
327 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
328 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
329 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
330 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
331 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
332 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
336 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
337 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
338 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
339 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
340 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
341 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
342 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
343 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
344 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
345 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
347 /* extended filter component types */
348 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
349 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
350 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
351 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
353 /* substring filter component types */
354 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
355 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
356 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
359 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1)
360 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
361 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
362 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
364 /* substring filter component types */
365 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
366 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
367 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
370 * possible error codes we can return
373 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
375 #define LDAP_SUCCESS 0x00
376 #define LDAP_OPERATIONS_ERROR 0x01
377 #define LDAP_PROTOCOL_ERROR 0x02
378 #define LDAP_TIMELIMIT_EXCEEDED 0x03
379 #define LDAP_SIZELIMIT_EXCEEDED 0x04
380 #define LDAP_COMPARE_FALSE 0x05
381 #define LDAP_COMPARE_TRUE 0x06
382 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
383 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
384 #define LDAP_STRONG_AUTH_REQUIRED 0x08
385 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
387 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
388 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
389 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
390 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
391 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
393 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
395 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
396 #define LDAP_UNDEFINED_TYPE 0x11
397 #define LDAP_INAPPROPRIATE_MATCHING 0x12
398 #define LDAP_CONSTRAINT_VIOLATION 0x13
399 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
400 #define LDAP_INVALID_SYNTAX 0x15
402 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
404 #define LDAP_NO_SUCH_OBJECT 0x20
405 #define LDAP_ALIAS_PROBLEM 0x21
406 #define LDAP_INVALID_DN_SYNTAX 0x22
407 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
408 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
410 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
412 #define LDAP_INAPPROPRIATE_AUTH 0x30
413 #define LDAP_INVALID_CREDENTIALS 0x31
414 #define LDAP_INSUFFICIENT_ACCESS 0x32
416 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
418 #define LDAP_BUSY 0x33
419 #define LDAP_UNAVAILABLE 0x34
420 #define LDAP_UNWILLING_TO_PERFORM 0x35
421 #define LDAP_LOOP_DETECT 0x36
423 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
425 #define LDAP_NAMING_VIOLATION 0x40
426 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
427 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
428 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
429 #define LDAP_ALREADY_EXISTS 0x44
430 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
431 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
432 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
434 #define LDAP_OTHER 0x50
436 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
437 #define LDAP_API_RESULT(n) (((n) == LDAP_SUCCESS) || \
438 LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
440 /* reserved for APIs */
441 #define LDAP_SERVER_DOWN 0x51
442 #define LDAP_LOCAL_ERROR 0x52
443 #define LDAP_ENCODING_ERROR 0x53
444 #define LDAP_DECODING_ERROR 0x54
445 #define LDAP_TIMEOUT 0x55
446 #define LDAP_AUTH_UNKNOWN 0x56
447 #define LDAP_FILTER_ERROR 0x57
448 #define LDAP_USER_CANCELLED 0x58
449 #define LDAP_PARAM_ERROR 0x59
450 #define LDAP_NO_MEMORY 0x5a
452 /* used but not reserved for APIs */
453 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
454 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
455 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
456 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
457 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
458 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
459 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
461 #ifdef LDAP_CLIENT_UPDATE
462 /* resultCode for LCUP */
463 #define LCUP_RESOURCES_EXHAUSTED 0x62
464 #define LCUP_SECURITY_VIOLATION 0x63
465 #define LCUP_INVALID_COOKIE 0x64
466 #define LCUP_UNSUPPORTED_SCHEME 0x65
467 #define LCUP_CLIENT_DISCONNECT 0x66
468 #define LCUP_RELOAD_REQUIRED 0x67
469 #endif /* LDAP_CLIENT_UPDATE */
471 #ifdef LDAP_CLIENT_UPDATE
472 #define SYNCHRONIZE_ONLY 0x00
473 #define SYNCHRONIZE_AND_PERSIST 0x01
474 #define PERSIST_ONLY 0x02
475 #endif /* LDAP_CLIENT_UPDATE */
477 #ifdef LDAP_CLIENT_UPDATE
478 #define LDAP_LCUP_DEFAULT_SEND_COOKIE_INTERVAL 0x01
479 #endif /* LDAP_CLIENT_UPDATE */
482 * This structure represents both ldap messages and ldap responses.
483 * These are really the same, except in the case of search responses,
484 * where a response has multiple messages.
487 typedef struct ldapmsg LDAPMessage;
489 /* for modifications */
490 typedef struct ldapmod {
493 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
494 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
495 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
496 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
497 /* IMPORTANT: do not use code 0x1000 (or above),
498 * it is used internally by the backends!
499 * (see ldap/servers/slapd/slap.h)
505 struct berval **modv_bvals;
507 #define mod_values mod_vals.modv_strvals
508 #define mod_bvalues mod_vals.modv_bvals
512 * structure representing an ldap session which can
513 * encompass connections to multiple servers (in the
514 * face of referrals).
516 typedef struct ldap LDAP;
518 #define LDAP_DEREF_NEVER 0x00
519 #define LDAP_DEREF_SEARCHING 0x01
520 #define LDAP_DEREF_FINDING 0x02
521 #define LDAP_DEREF_ALWAYS 0x03
523 #define LDAP_NO_LIMIT 0
525 /* how many messages to retrieve results for */
526 #define LDAP_MSG_ONE 0x00
527 #define LDAP_MSG_ALL 0x01
528 #define LDAP_MSG_RECEIVED 0x02
531 * types for ldap URL handling
533 typedef struct ldap_url_desc {
534 struct ldap_url_desc *lud_next;
546 #define LDAP_URL_SUCCESS 0x00 /* Success */
547 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
548 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
550 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
551 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
552 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
553 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
554 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
555 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
556 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
557 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
560 * The API draft spec says we should declare (or cause to be declared)
561 * 'struct timeval'. We don't. See IETF LDAPext discussions.
569 ldap_get_option LDAP_P((
575 ldap_set_option LDAP_P((
578 LDAP_CONST void *invalue));
580 /* V3 REBIND Function Callback Prototype */
581 typedef int (LDAP_REBIND_PROC) LDAP_P((
582 LDAP *ld, LDAP_CONST char *url,
583 ber_tag_t request, ber_int_t msgid,
587 ldap_set_rebind_proc LDAP_P((
589 LDAP_REBIND_PROC *rebind_proc,
596 ldap_create_control LDAP_P((
597 LDAP_CONST char *requestOID,
600 LDAPControl **ctrlp ));
603 ldap_control_free LDAP_P((
604 LDAPControl *ctrl ));
607 ldap_controls_free LDAP_P((
608 LDAPControl **ctrls ));
614 ldap_domain2dn LDAP_P((
615 LDAP_CONST char* domain,
619 ldap_dn2domain LDAP_P((
624 ldap_domain2hostlist LDAP_P((
625 LDAP_CONST char *domain,
632 ldap_extended_operation LDAP_P((
634 LDAP_CONST char *reqoid,
635 struct berval *reqdata,
636 LDAPControl **serverctrls,
637 LDAPControl **clientctrls,
641 ldap_extended_operation_s LDAP_P((
643 LDAP_CONST char *reqoid,
644 struct berval *reqdata,
645 LDAPControl **serverctrls,
646 LDAPControl **clientctrls,
648 struct berval **retdatap ));
651 ldap_parse_extended_result LDAP_P((
655 struct berval **retdatap,
659 ldap_parse_extended_partial LDAP_P((
663 struct berval **retdatap,
664 LDAPControl ***serverctrls,
671 ldap_abandon_ext LDAP_P((
674 LDAPControl **serverctrls,
675 LDAPControl **clientctrls ));
678 ldap_abandon LDAP_P(( /* deprecated */
687 ldap_add_ext LDAP_P((
691 LDAPControl **serverctrls,
692 LDAPControl **clientctrls,
696 ldap_add_ext_s LDAP_P((
700 LDAPControl **serverctrls,
701 LDAPControl **clientctrls ));
704 ldap_add LDAP_P(( /* deprecated */
710 ldap_add_s LDAP_P(( /* deprecated */
720 ldap_sasl_bind LDAP_P((
723 LDAP_CONST char *mechanism,
725 LDAPControl **serverctrls,
726 LDAPControl **clientctrls,
729 /* Interaction flags (should be passed about in a control)
730 * Automatic (default): use defaults, prompt otherwise
731 * Interactive: prompt always
732 * Quiet: never prompt
734 #define LDAP_SASL_AUTOMATIC 0U
735 #define LDAP_SASL_INTERACTIVE 1U
736 #define LDAP_SASL_QUIET 2U
739 * V3 SASL Interaction Function Callback Prototype
740 * when using Cyrus SASL, interact is pointer to sasl_interact_t
741 * should likely passed in a control (and provided controls)
743 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
744 LDAP *ld, unsigned flags, void* defaults, void *interact ));
747 ldap_sasl_interactive_bind_s LDAP_P((
749 LDAP_CONST char *dn, /* usually NULL */
750 LDAP_CONST char *saslMechanism,
751 LDAPControl **serverControls,
752 LDAPControl **clientControls,
754 /* should be client controls */
756 LDAP_SASL_INTERACT_PROC *proc,
760 ldap_sasl_bind_s LDAP_P((
763 LDAP_CONST char *mechanism,
765 LDAPControl **serverctrls,
766 LDAPControl **clientctrls,
767 struct berval **servercredp ));
770 ldap_parse_sasl_bind_result LDAP_P((
773 struct berval **servercredp,
781 ldap_bind LDAP_P(( /* deprecated */
783 LDAP_CONST char *who,
784 LDAP_CONST char *passwd,
788 ldap_bind_s LDAP_P(( /* deprecated */
790 LDAP_CONST char *who,
791 LDAP_CONST char *cred,
798 ldap_simple_bind LDAP_P((
800 LDAP_CONST char *who,
801 LDAP_CONST char *passwd ));
804 ldap_simple_bind_s LDAP_P((
806 LDAP_CONST char *who,
807 LDAP_CONST char *passwd ));
815 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
817 LDAP_CONST char *who ));
820 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
822 LDAP_CONST char *who ));
825 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
827 LDAP_CONST char *who ));
830 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
832 LDAP_CONST char *who ));
835 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
837 LDAP_CONST char *who ));
844 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
847 ldap_disable_cache LDAP_P(( LDAP *ld ));
850 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
853 ldap_destroy_cache LDAP_P(( LDAP *ld ));
856 ldap_flush_cache LDAP_P(( LDAP *ld ));
859 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
862 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
869 ldap_compare_ext LDAP_P((
872 LDAP_CONST char *attr,
873 struct berval *bvalue,
874 LDAPControl **serverctrls,
875 LDAPControl **clientctrls,
879 ldap_compare_ext_s LDAP_P((
882 LDAP_CONST char *attr,
883 struct berval *bvalue,
884 LDAPControl **serverctrls,
885 LDAPControl **clientctrls ));
888 ldap_compare LDAP_P(( /* deprecated */
891 LDAP_CONST char *attr,
892 LDAP_CONST char *value ));
895 ldap_compare_s LDAP_P(( /* deprecated */
898 LDAP_CONST char *attr,
899 LDAP_CONST char *value ));
906 ldap_delete_ext LDAP_P((
909 LDAPControl **serverctrls,
910 LDAPControl **clientctrls,
914 ldap_delete_ext_s LDAP_P((
917 LDAPControl **serverctrls,
918 LDAPControl **clientctrls ));
921 ldap_delete LDAP_P(( /* deprecated */
923 LDAP_CONST char *dn ));
926 ldap_delete_s LDAP_P(( /* deprecated */
928 LDAP_CONST char *dn ));
935 ldap_parse_result LDAP_P((
942 LDAPControl ***serverctrls,
946 ldap_err2string LDAP_P((
950 ldap_result2error LDAP_P(( /* deprecated */
956 ldap_perror LDAP_P(( /* deprecated */
958 LDAP_CONST char *s ));
965 ldap_modify_ext LDAP_P((
969 LDAPControl **serverctrls,
970 LDAPControl **clientctrls,
974 ldap_modify_ext_s LDAP_P((
978 LDAPControl **serverctrls,
979 LDAPControl **clientctrls ));
982 ldap_modify LDAP_P(( /* deprecated */
988 ldap_modify_s LDAP_P(( /* deprecated */
1000 LDAP_CONST char *dn,
1001 LDAP_CONST char *newrdn,
1002 LDAP_CONST char *newSuperior,
1004 LDAPControl **sctrls,
1005 LDAPControl **cctrls,
1009 ldap_rename_s LDAP_P((
1011 LDAP_CONST char *dn,
1012 LDAP_CONST char *newrdn,
1013 LDAP_CONST char *newSuperior,
1015 LDAPControl **sctrls,
1016 LDAPControl **cctrls ));
1019 ldap_rename2 LDAP_P(( /* deprecated */
1021 LDAP_CONST char *dn,
1022 LDAP_CONST char *newrdn,
1023 LDAP_CONST char *newSuperior,
1024 int deleteoldrdn ));
1027 ldap_rename2_s LDAP_P(( /* deprecated */
1029 LDAP_CONST char *dn,
1030 LDAP_CONST char *newrdn,
1031 LDAP_CONST char *newSuperior,
1032 int deleteoldrdn ));
1035 ldap_modrdn LDAP_P(( /* deprecated */
1037 LDAP_CONST char *dn,
1038 LDAP_CONST char *newrdn ));
1041 ldap_modrdn_s LDAP_P(( /* deprecated */
1043 LDAP_CONST char *dn,
1044 LDAP_CONST char *newrdn ));
1047 ldap_modrdn2 LDAP_P(( /* deprecated */
1049 LDAP_CONST char *dn,
1050 LDAP_CONST char *newrdn,
1051 int deleteoldrdn ));
1054 ldap_modrdn2_s LDAP_P(( /* deprecated */
1056 LDAP_CONST char *dn,
1057 LDAP_CONST char *newrdn,
1066 LDAP_CONST char *host,
1070 ldap_open LDAP_P(( /* deprecated */
1071 LDAP_CONST char *host,
1075 ldap_create LDAP_P((
1079 ldap_initialize LDAP_P((
1081 LDAP_CONST char *url ));
1084 ldap_start_tls_s LDAP_P((
1086 LDAPControl **serverctrls,
1087 LDAPControl **clientctrls ));
1092 LDAP_F( LDAPMessage * )
1093 ldap_first_message LDAP_P((
1095 LDAPMessage *chain ));
1097 LDAP_F( LDAPMessage * )
1098 ldap_next_message LDAP_P((
1100 LDAPMessage *msg ));
1103 ldap_count_messages LDAP_P((
1105 LDAPMessage *chain ));
1111 LDAP_F( LDAPMessage * )
1112 ldap_first_reference LDAP_P((
1114 LDAPMessage *chain ));
1116 LDAP_F( LDAPMessage * )
1117 ldap_next_reference LDAP_P((
1119 LDAPMessage *ref ));
1122 ldap_count_references LDAP_P((
1124 LDAPMessage *chain ));
1127 ldap_parse_reference LDAP_P((
1131 LDAPControl ***serverctrls,
1138 LDAP_F( LDAPMessage * )
1139 ldap_first_entry LDAP_P((
1141 LDAPMessage *chain ));
1143 LDAP_F( LDAPMessage * )
1144 ldap_next_entry LDAP_P((
1146 LDAPMessage *entry ));
1149 ldap_count_entries LDAP_P((
1151 LDAPMessage *chain ));
1154 ldap_get_entry_controls LDAP_P((
1157 LDAPControl ***serverctrls));
1163 LDAP_F( LDAPMessage * )
1164 ldap_delete_result_entry LDAP_P((
1169 ldap_add_result_entry LDAP_P((
1178 ldap_get_dn LDAP_P((
1180 LDAPMessage *entry ));
1182 typedef struct ldap_ava {
1183 struct berval la_attr;
1184 struct berval la_value;
1186 #define LDAP_AVA_STRING 0x0000U
1187 #define LDAP_AVA_BINARY 0x0001U
1188 #define LDAP_AVA_NONPRINTABLE 0x0002U
1193 typedef LDAPAVA** LDAPRDN;
1194 typedef LDAPRDN** LDAPDN;
1197 #define LDAP_DN_FORMAT_LDAP 0x0000U
1198 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1199 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1200 #define LDAP_DN_FORMAT_DCE 0x0030U
1201 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1202 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1203 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1204 #define LDAP_DN_FORMAT_MASK 0x00F0U
1207 #define LDAP_DN_PRETTY 0x0100U
1208 #define LDAP_DN_SKIP 0x0200U
1209 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1210 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1211 #define LDAP_DN_PEDANTIC 0xF000U
1214 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1216 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1218 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1227 ldap_str2dn LDAP_P((
1228 LDAP_CONST char *str,
1239 ldap_dn2str LDAP_P((
1245 ldap_bv2rdn LDAP_P((
1252 ldap_str2rdn LDAP_P((
1253 LDAP_CONST char *str,
1259 ldap_rdn2bv LDAP_P((
1265 ldap_rdn2str LDAP_P((
1271 ldap_dn_normalize LDAP_P((
1272 LDAP_CONST char *in, unsigned iflags,
1273 char **out, unsigned oflags ));
1276 ldap_dn2ufn LDAP_P(( /* deprecated */
1277 LDAP_CONST char *dn ));
1280 ldap_explode_dn LDAP_P(( /* deprecated */
1281 LDAP_CONST char *dn,
1285 ldap_explode_rdn LDAP_P(( /* deprecated */
1286 LDAP_CONST char *rdn,
1289 typedef int LDAPDN_rewrite_func LDAP_P(( LDAPDN *dn, unsigned flags ));
1292 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1293 LDAPDN_rewrite_func *func, unsigned flags ));
1296 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1299 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1302 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1308 ldap_first_attribute LDAP_P((
1311 BerElement **ber ));
1314 ldap_next_attribute LDAP_P((
1323 LDAP_F( struct berval ** )
1324 ldap_get_values_len LDAP_P((
1327 LDAP_CONST char *target ));
1330 ldap_count_values_len LDAP_P((
1331 struct berval **vals ));
1334 ldap_value_free_len LDAP_P((
1335 struct berval **vals ));
1338 ldap_get_values LDAP_P(( /* deprecated */
1341 LDAP_CONST char *target ));
1344 ldap_count_values LDAP_P(( /* deprecated */
1348 ldap_value_free LDAP_P(( /* deprecated */
1355 ldap_result LDAP_P((
1359 struct timeval *timeout,
1360 LDAPMessage **result ));
1363 ldap_msgtype LDAP_P((
1371 ldap_msgfree LDAP_P((
1375 ldap_msgdelete LDAP_P((
1384 ldap_search_ext LDAP_P((
1386 LDAP_CONST char *base,
1388 LDAP_CONST char *filter,
1391 LDAPControl **serverctrls,
1392 LDAPControl **clientctrls,
1393 struct timeval *timeout,
1398 ldap_search_ext_s LDAP_P((
1400 LDAP_CONST char *base,
1402 LDAP_CONST char *filter,
1405 LDAPControl **serverctrls,
1406 LDAPControl **clientctrls,
1407 struct timeval *timeout,
1409 LDAPMessage **res ));
1412 ldap_search LDAP_P(( /* deprecated */
1414 LDAP_CONST char *base,
1416 LDAP_CONST char *filter,
1421 ldap_search_s LDAP_P(( /* deprecated */
1423 LDAP_CONST char *base,
1425 LDAP_CONST char *filter,
1428 LDAPMessage **res ));
1431 ldap_search_st LDAP_P(( /* deprecated */
1433 LDAP_CONST char *base,
1435 LDAP_CONST char *filter,
1438 struct timeval *timeout,
1439 LDAPMessage **res ));
1445 ldap_unbind LDAP_P(( /* deprecated */
1449 ldap_unbind_s LDAP_P(( /* deprecated */
1453 ldap_unbind_ext LDAP_P((
1455 LDAPControl **serverctrls,
1456 LDAPControl **clientctrls));
1459 ldap_unbind_ext_s LDAP_P((
1461 LDAPControl **serverctrls,
1462 LDAPControl **clientctrls));
1468 ldap_put_vrFilter LDAP_P((
1477 ldap_memalloc LDAP_P((
1481 ldap_memrealloc LDAP_P((
1486 ldap_memcalloc LDAP_P((
1491 ldap_memfree LDAP_P((
1495 ldap_memvfree LDAP_P((
1499 ldap_strdup LDAP_P((
1500 LDAP_CONST char * ));
1503 ldap_mods_free LDAP_P((
1512 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1513 LDAP_CONST char *left,
1514 LDAP_CONST char *right ));
1516 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1517 LDAP_CONST void *left,
1518 LDAP_CONST void *right ));
1520 LDAP_F( int ) /* deprecated */
1521 ldap_sort_entries LDAP_P(( LDAP *ld,
1522 LDAPMessage **chain,
1523 LDAP_CONST char *attr,
1524 LDAP_SORT_AD_CMP_PROC *cmp ));
1526 LDAP_F( int ) /* deprecated */
1527 ldap_sort_values LDAP_P((
1530 LDAP_SORT_AV_CMP_PROC *cmp ));
1532 LDAP_F( int ) /* deprecated */
1533 ldap_sort_strcasecmp LDAP_P((
1535 LDAP_CONST void *b ));
1542 ldap_is_ldap_url LDAP_P((
1543 LDAP_CONST char *url ));
1546 ldap_is_ldaps_url LDAP_P((
1547 LDAP_CONST char *url ));
1550 ldap_is_ldapi_url LDAP_P((
1551 LDAP_CONST char *url ));
1554 ldap_url_parse LDAP_P((
1555 LDAP_CONST char *url,
1556 LDAPURLDesc **ludpp ));
1559 ldap_url_desc2str LDAP_P((
1560 LDAPURLDesc *ludp ));
1563 ldap_free_urldesc LDAP_P((
1564 LDAPURLDesc *ludp ));
1570 * structure for a sort-key
1572 typedef struct ldapsortkey {
1573 char * attributeType;
1574 char * orderingRule;
1579 ldap_create_sort_keylist LDAP_P((
1580 LDAPSortKey ***sortKeyList,
1584 ldap_free_sort_keylist LDAP_P((
1585 LDAPSortKey **sortkeylist ));
1588 ldap_create_sort_control LDAP_P((
1590 LDAPSortKey **keyList,
1592 LDAPControl **ctrlp ));
1595 ldap_parse_sort_control LDAP_P((
1597 LDAPControl **ctrlp,
1598 unsigned long *result,
1599 char **attribute ));
1607 * structure for virtual list.
1609 typedef struct ldapvlvinfo {
1611 unsigned long ldvlv_before_count;
1612 unsigned long ldvlv_after_count;
1613 unsigned long ldvlv_offset;
1614 unsigned long ldvlv_count;
1615 struct berval *ldvlv_attrvalue;
1616 struct berval *ldvlv_context;
1617 void *ldvlv_extradata;
1621 ldap_create_vlv_control LDAP_P((
1623 LDAPVLVInfo *ldvlistp,
1624 LDAPControl **ctrlp ));
1627 ldap_parse_vlv_control LDAP_P((
1629 LDAPControl **ctrls,
1630 unsigned long *target_posp,
1631 unsigned long *list_countp,
1632 struct berval **contextp,
1637 #endif /* _LDAP_H */