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
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;
184 /* chase referrals client control (not yet implemented) */
185 #define LDAP_CONTROL_REFERRALS "1.2.840.113666.1.4.616"
186 #define LDAP_CHASE_SUBORDINATE_REFERRALS 0x0020U
187 #define LDAP_CHASE_EXTERNAL_REFERRALS 0x0040U
190 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2"
191 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1"
192 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
194 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
195 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
196 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
197 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
199 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
200 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
201 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
202 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
204 /* LDAP Unsolicited Notifications */
205 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
206 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
208 /* LDAP Extended Operations */
209 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
211 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
212 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
213 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
214 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
215 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
217 #define LDAP_EXOP_X_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
220 * specific LDAP instantiations of BER types we know about
223 /* Overview of LBER tag construction
230 * 1 0 = CONTEXT-SPECIFIC
237 * | 5 ... 1 | TAG-NUMBER
241 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
242 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
243 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
244 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
245 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
246 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
248 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
250 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
251 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
252 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
253 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
255 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
258 /* possible operations a client can invoke */
259 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
260 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
261 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
262 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
263 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
264 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
265 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
266 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
267 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
268 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
269 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
270 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
272 /* possible result types a server can return */
273 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
274 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
275 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
276 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
277 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
278 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
279 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
280 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
281 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
282 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
283 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
284 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
285 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
287 #define LDAP_RES_ANY (-1)
288 #define LDAP_RES_UNSOLICITED (0)
292 #define LDAP_SASL_SIMPLE ((char*)0)
293 #define LDAP_SASL_NULL ("")
296 /* authentication methods available */
297 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
298 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
299 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
300 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
301 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
302 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
306 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
307 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
308 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
309 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
310 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
311 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
312 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
313 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
314 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
315 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
317 /* extended filter component types */
318 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
319 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
320 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
321 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
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 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1)
330 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
331 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
332 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
334 /* substring filter component types */
335 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
336 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
337 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
340 * possible error codes we can return
343 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
345 #define LDAP_SUCCESS 0x00
346 #define LDAP_OPERATIONS_ERROR 0x01
347 #define LDAP_PROTOCOL_ERROR 0x02
348 #define LDAP_TIMELIMIT_EXCEEDED 0x03
349 #define LDAP_SIZELIMIT_EXCEEDED 0x04
350 #define LDAP_COMPARE_FALSE 0x05
351 #define LDAP_COMPARE_TRUE 0x06
352 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
353 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
354 #define LDAP_STRONG_AUTH_REQUIRED 0x08
355 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
357 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
358 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
359 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
360 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
361 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
363 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
365 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
366 #define LDAP_UNDEFINED_TYPE 0x11
367 #define LDAP_INAPPROPRIATE_MATCHING 0x12
368 #define LDAP_CONSTRAINT_VIOLATION 0x13
369 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
370 #define LDAP_INVALID_SYNTAX 0x15
372 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
374 #define LDAP_NO_SUCH_OBJECT 0x20
375 #define LDAP_ALIAS_PROBLEM 0x21
376 #define LDAP_INVALID_DN_SYNTAX 0x22
377 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
378 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
380 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
382 #define LDAP_INAPPROPRIATE_AUTH 0x30
383 #define LDAP_INVALID_CREDENTIALS 0x31
384 #define LDAP_INSUFFICIENT_ACCESS 0x32
386 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
388 #define LDAP_BUSY 0x33
389 #define LDAP_UNAVAILABLE 0x34
390 #define LDAP_UNWILLING_TO_PERFORM 0x35
391 #define LDAP_LOOP_DETECT 0x36
393 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
395 #define LDAP_NAMING_VIOLATION 0x40
396 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
397 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
398 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
399 #define LDAP_ALREADY_EXISTS 0x44
400 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
401 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
402 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
404 #define LDAP_OTHER 0x50
406 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
407 #define LDAP_API_RESULT(n) (((n) == LDAP_SUCCESS) || \
408 LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
410 /* reserved for APIs */
411 #define LDAP_SERVER_DOWN 0x51
412 #define LDAP_LOCAL_ERROR 0x52
413 #define LDAP_ENCODING_ERROR 0x53
414 #define LDAP_DECODING_ERROR 0x54
415 #define LDAP_TIMEOUT 0x55
416 #define LDAP_AUTH_UNKNOWN 0x56
417 #define LDAP_FILTER_ERROR 0x57
418 #define LDAP_USER_CANCELLED 0x58
419 #define LDAP_PARAM_ERROR 0x59
420 #define LDAP_NO_MEMORY 0x5a
422 /* used but not reserved for APIs */
423 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
424 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
425 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
426 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
427 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
428 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
429 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
432 * This structure represents both ldap messages and ldap responses.
433 * These are really the same, except in the case of search responses,
434 * where a response has multiple messages.
437 typedef struct ldapmsg LDAPMessage;
439 /* for modifications */
440 typedef struct ldapmod {
443 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
444 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
445 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
446 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
447 /* IMPORTANT: do not use code 0x1000 (or above),
448 * it is used internally by the backends!
449 * (see ldap/servers/slapd/slap.h)
455 struct berval **modv_bvals;
457 #define mod_values mod_vals.modv_strvals
458 #define mod_bvalues mod_vals.modv_bvals
462 * structures for ldap getfilter routines
465 typedef struct ldap_filt_info {
470 struct ldap_filt_info *lfi_next;
473 typedef struct ldap_filt_list {
477 LDAPFiltInfo *lfl_ilist;
478 struct ldap_filt_list *lfl_next;
482 #define LDAP_FILT_MAXSIZ 1024
484 typedef struct ldap_filt_desc {
485 LDAPFiltList *lfd_filtlist;
486 LDAPFiltInfo *lfd_curfip;
487 LDAPFiltInfo lfd_retfi;
488 char lfd_filter[ LDAP_FILT_MAXSIZ ];
490 char *lfd_curvalcopy;
491 char **lfd_curvalwords;
492 char *lfd_filtprefix;
493 char *lfd_filtsuffix;
498 * structure representing an ldap session which can
499 * encompass connections to multiple servers (in the
500 * face of referrals).
502 typedef struct ldap LDAP;
504 #define LDAP_DEREF_NEVER 0x00
505 #define LDAP_DEREF_SEARCHING 0x01
506 #define LDAP_DEREF_FINDING 0x02
507 #define LDAP_DEREF_ALWAYS 0x03
509 #define LDAP_NO_LIMIT 0
511 /* how many messages to retrieve results for */
512 #define LDAP_MSG_ONE 0x00
513 #define LDAP_MSG_ALL 0x01
514 #define LDAP_MSG_RECEIVED 0x02
517 * types for ldap URL handling
519 typedef struct ldap_url_desc {
520 struct ldap_url_desc *lud_next;
532 #define LDAP_URL_SUCCESS 0x00 /* Success */
533 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
534 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
536 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
537 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
538 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
539 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
540 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
541 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
542 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
543 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
546 * The API draft spec says we should declare (or cause to be declared)
547 * 'struct timeval'. We don't. See IETF LDAPext discussions.
555 ldap_get_option LDAP_P((
561 ldap_set_option LDAP_P((
564 LDAP_CONST void *invalue));
566 /* V3 REBIND Function Callback Prototype */
567 typedef int (LDAP_REBIND_PROC) LDAP_P((
568 LDAP *ld, LDAP_CONST char *url,
569 ber_tag_t request, ber_int_t msgid,
573 ldap_set_rebind_proc LDAP_P((
575 LDAP_REBIND_PROC *rebind_proc,
582 ldap_create_control LDAP_P((
583 LDAP_CONST char *requestOID,
586 LDAPControl **ctrlp ));
589 ldap_control_free LDAP_P((
590 LDAPControl *ctrl ));
593 ldap_controls_free LDAP_P((
594 LDAPControl **ctrls ));
600 ldap_domain2dn LDAP_P((
601 LDAP_CONST char* domain,
605 ldap_dn2domain LDAP_P((
610 ldap_domain2hostlist LDAP_P((
611 LDAP_CONST char *domain,
618 ldap_extended_operation LDAP_P((
620 LDAP_CONST char *reqoid,
621 struct berval *reqdata,
622 LDAPControl **serverctrls,
623 LDAPControl **clientctrls,
627 ldap_extended_operation_s LDAP_P((
629 LDAP_CONST char *reqoid,
630 struct berval *reqdata,
631 LDAPControl **serverctrls,
632 LDAPControl **clientctrls,
634 struct berval **retdatap ));
637 ldap_parse_extended_result LDAP_P((
641 struct berval **retdatap,
645 ldap_parse_extended_partial LDAP_P((
649 struct berval **retdatap,
650 LDAPControl ***serverctrls,
657 ldap_abandon_ext LDAP_P((
660 LDAPControl **serverctrls,
661 LDAPControl **clientctrls ));
664 ldap_abandon LDAP_P(( /* deprecated */
673 ldap_add_ext LDAP_P((
677 LDAPControl **serverctrls,
678 LDAPControl **clientctrls,
682 ldap_add_ext_s LDAP_P((
686 LDAPControl **serverctrls,
687 LDAPControl **clientctrls ));
690 ldap_add LDAP_P(( /* deprecated */
696 ldap_add_s LDAP_P(( /* deprecated */
706 ldap_sasl_bind LDAP_P((
709 LDAP_CONST char *mechanism,
711 LDAPControl **serverctrls,
712 LDAPControl **clientctrls,
715 /* Interaction flags (should be passed about in a control)
716 * Automatic (default): use defaults, prompt otherwise
717 * Interactive: prompt always
718 * Quiet: never prompt
720 #define LDAP_SASL_AUTOMATIC 0U
721 #define LDAP_SASL_INTERACTIVE 1U
722 #define LDAP_SASL_QUIET 2U
725 * V3 SASL Interaction Function Callback Prototype
726 * when using Cyrus SASL, interact is pointer to sasl_interact_t
727 * should likely passed in a control (and provided controls)
729 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
730 LDAP *ld, unsigned flags, void* defaults, void *interact ));
733 ldap_sasl_interactive_bind_s LDAP_P((
735 LDAP_CONST char *dn, /* usually NULL */
736 LDAP_CONST char *saslMechanism,
737 LDAPControl **serverControls,
738 LDAPControl **clientControls,
740 /* should be client controls */
742 LDAP_SASL_INTERACT_PROC *proc,
746 ldap_sasl_bind_s LDAP_P((
749 LDAP_CONST char *mechanism,
751 LDAPControl **serverctrls,
752 LDAPControl **clientctrls,
753 struct berval **servercredp ));
756 ldap_parse_sasl_bind_result LDAP_P((
759 struct berval **servercredp,
767 ldap_bind LDAP_P(( /* deprecated */
769 LDAP_CONST char *who,
770 LDAP_CONST char *passwd,
774 ldap_bind_s LDAP_P(( /* deprecated */
776 LDAP_CONST char *who,
777 LDAP_CONST char *cred,
784 ldap_simple_bind LDAP_P((
786 LDAP_CONST char *who,
787 LDAP_CONST char *passwd ));
790 ldap_simple_bind_s LDAP_P((
792 LDAP_CONST char *who,
793 LDAP_CONST char *passwd ));
801 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
803 LDAP_CONST char *who ));
806 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
808 LDAP_CONST char *who ));
811 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
813 LDAP_CONST char *who ));
816 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
818 LDAP_CONST char *who ));
821 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
823 LDAP_CONST char *who ));
830 ldap_enable_cache LDAP_P(( LDAP *ld, long timeout, ber_len_t maxmem ));
833 ldap_disable_cache LDAP_P(( LDAP *ld ));
836 ldap_set_cache_options LDAP_P(( LDAP *ld, unsigned long opts ));
839 ldap_destroy_cache LDAP_P(( LDAP *ld ));
842 ldap_flush_cache LDAP_P(( LDAP *ld ));
845 ldap_uncache_entry LDAP_P(( LDAP *ld, LDAP_CONST char *dn ));
848 ldap_uncache_request LDAP_P(( LDAP *ld, int msgid ));
855 ldap_compare_ext LDAP_P((
858 LDAP_CONST char *attr,
859 struct berval *bvalue,
860 LDAPControl **serverctrls,
861 LDAPControl **clientctrls,
865 ldap_compare_ext_s LDAP_P((
868 LDAP_CONST char *attr,
869 struct berval *bvalue,
870 LDAPControl **serverctrls,
871 LDAPControl **clientctrls ));
874 ldap_compare LDAP_P(( /* deprecated */
877 LDAP_CONST char *attr,
878 LDAP_CONST char *value ));
881 ldap_compare_s LDAP_P(( /* deprecated */
884 LDAP_CONST char *attr,
885 LDAP_CONST char *value ));
892 ldap_delete_ext LDAP_P((
895 LDAPControl **serverctrls,
896 LDAPControl **clientctrls,
900 ldap_delete_ext_s LDAP_P((
903 LDAPControl **serverctrls,
904 LDAPControl **clientctrls ));
907 ldap_delete LDAP_P(( /* deprecated */
909 LDAP_CONST char *dn ));
912 ldap_delete_s LDAP_P(( /* deprecated */
914 LDAP_CONST char *dn ));
921 ldap_parse_result LDAP_P((
928 LDAPControl ***serverctrls,
932 ldap_err2string LDAP_P((
936 ldap_result2error LDAP_P(( /* deprecated */
942 ldap_perror LDAP_P(( /* deprecated */
944 LDAP_CONST char *s ));
951 ldap_modify_ext LDAP_P((
955 LDAPControl **serverctrls,
956 LDAPControl **clientctrls,
960 ldap_modify_ext_s LDAP_P((
964 LDAPControl **serverctrls,
965 LDAPControl **clientctrls ));
968 ldap_modify LDAP_P(( /* deprecated */
974 ldap_modify_s LDAP_P(( /* deprecated */
987 LDAP_CONST char *newrdn,
988 LDAP_CONST char *newSuperior,
990 LDAPControl **sctrls,
991 LDAPControl **cctrls,
995 ldap_rename_s LDAP_P((
998 LDAP_CONST char *newrdn,
999 LDAP_CONST char *newSuperior,
1001 LDAPControl **sctrls,
1002 LDAPControl **cctrls ));
1005 ldap_rename2 LDAP_P(( /* deprecated */
1007 LDAP_CONST char *dn,
1008 LDAP_CONST char *newrdn,
1009 LDAP_CONST char *newSuperior,
1010 int deleteoldrdn ));
1013 ldap_rename2_s LDAP_P(( /* deprecated */
1015 LDAP_CONST char *dn,
1016 LDAP_CONST char *newrdn,
1017 LDAP_CONST char *newSuperior,
1018 int deleteoldrdn ));
1021 ldap_modrdn LDAP_P(( /* deprecated */
1023 LDAP_CONST char *dn,
1024 LDAP_CONST char *newrdn ));
1027 ldap_modrdn_s LDAP_P(( /* deprecated */
1029 LDAP_CONST char *dn,
1030 LDAP_CONST char *newrdn ));
1033 ldap_modrdn2 LDAP_P(( /* deprecated */
1035 LDAP_CONST char *dn,
1036 LDAP_CONST char *newrdn,
1037 int deleteoldrdn ));
1040 ldap_modrdn2_s LDAP_P(( /* deprecated */
1042 LDAP_CONST char *dn,
1043 LDAP_CONST char *newrdn,
1052 LDAP_CONST char *host,
1056 ldap_open LDAP_P(( /* deprecated */
1057 LDAP_CONST char *host,
1061 ldap_create LDAP_P((
1065 ldap_initialize LDAP_P((
1067 LDAP_CONST char *url ));
1070 ldap_start_tls_s LDAP_P((
1072 LDAPControl **serverctrls,
1073 LDAPControl **clientctrls ));
1078 LDAP_F( LDAPMessage * )
1079 ldap_first_message LDAP_P((
1081 LDAPMessage *chain ));
1083 LDAP_F( LDAPMessage * )
1084 ldap_next_message LDAP_P((
1086 LDAPMessage *msg ));
1089 ldap_count_messages LDAP_P((
1091 LDAPMessage *chain ));
1097 LDAP_F( LDAPMessage * )
1098 ldap_first_reference LDAP_P((
1100 LDAPMessage *chain ));
1102 LDAP_F( LDAPMessage * )
1103 ldap_next_reference LDAP_P((
1105 LDAPMessage *ref ));
1108 ldap_count_references LDAP_P((
1110 LDAPMessage *chain ));
1113 ldap_parse_reference LDAP_P((
1117 LDAPControl ***serverctrls,
1124 LDAP_F( LDAPMessage * )
1125 ldap_first_entry LDAP_P((
1127 LDAPMessage *chain ));
1129 LDAP_F( LDAPMessage * )
1130 ldap_next_entry LDAP_P((
1132 LDAPMessage *entry ));
1135 ldap_count_entries LDAP_P((
1137 LDAPMessage *chain ));
1140 ldap_get_entry_controls LDAP_P((
1143 LDAPControl ***serverctrls));
1149 LDAP_F( LDAPMessage * )
1150 ldap_delete_result_entry LDAP_P((
1155 ldap_add_result_entry LDAP_P((
1164 ldap_get_dn LDAP_P((
1166 LDAPMessage *entry ));
1168 typedef struct ldap_ava {
1169 struct berval la_attr;
1170 struct berval la_value;
1172 #define LDAP_AVA_STRING 0x0000U
1173 #define LDAP_AVA_BINARY 0x0001U
1174 #define LDAP_AVA_NONPRINTABLE 0x0002U
1179 typedef LDAPAVA** LDAPRDN;
1180 typedef LDAPRDN** LDAPDN;
1183 #define LDAP_DN_FORMAT_LDAP 0x0000U
1184 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1185 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1186 #define LDAP_DN_FORMAT_DCE 0x0030U
1187 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1188 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1189 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1190 #define LDAP_DN_FORMAT_MASK 0x00F0U
1193 #define LDAP_DN_PRETTY 0x0100U
1194 #define LDAP_DN_SKIP 0x0200U
1195 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1196 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1197 #define LDAP_DN_PEDANTIC 0xF000U
1200 ldap_avafree LDAP_P(( LDAPAVA *ava ));
1202 ldap_rdnfree LDAP_P(( LDAPRDN *rdn ));
1204 ldap_dnfree LDAP_P(( LDAPDN *dn ));
1213 ldap_str2dn LDAP_P((
1214 LDAP_CONST char *str,
1225 ldap_dn2str LDAP_P((
1231 ldap_bv2rdn LDAP_P((
1238 ldap_str2rdn LDAP_P((
1239 LDAP_CONST char *str,
1245 ldap_rdn2bv LDAP_P((
1251 ldap_rdn2str LDAP_P((
1257 ldap_dn_normalize LDAP_P((
1258 LDAP_CONST char *in, unsigned iflags,
1259 char **out, unsigned oflags ));
1262 ldap_dn2ufn LDAP_P(( /* deprecated */
1263 LDAP_CONST char *dn ));
1266 ldap_explode_dn LDAP_P(( /* deprecated */
1267 LDAP_CONST char *dn,
1271 ldap_explode_rdn LDAP_P(( /* deprecated */
1272 LDAP_CONST char *rdn,
1276 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1279 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1282 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1288 ldap_first_attribute LDAP_P((
1291 BerElement **ber ));
1294 ldap_next_attribute LDAP_P((
1303 LDAP_F( struct berval ** )
1304 ldap_get_values_len LDAP_P((
1307 LDAP_CONST char *target ));
1310 ldap_count_values_len LDAP_P((
1311 struct berval **vals ));
1314 ldap_value_free_len LDAP_P((
1315 struct berval **vals ));
1318 ldap_get_values LDAP_P(( /* deprecated */
1321 LDAP_CONST char *target ));
1324 ldap_count_values LDAP_P(( /* deprecated */
1328 ldap_value_free LDAP_P(( /* deprecated */
1335 ldap_result LDAP_P((
1339 struct timeval *timeout,
1340 LDAPMessage **result ));
1343 ldap_msgtype LDAP_P((
1351 ldap_msgfree LDAP_P((
1355 ldap_msgdelete LDAP_P((
1364 ldap_search_ext LDAP_P((
1366 LDAP_CONST char *base,
1368 LDAP_CONST char *filter,
1371 LDAPControl **serverctrls,
1372 LDAPControl **clientctrls,
1373 struct timeval *timeout,
1378 ldap_search_ext_s LDAP_P((
1380 LDAP_CONST char *base,
1382 LDAP_CONST char *filter,
1385 LDAPControl **serverctrls,
1386 LDAPControl **clientctrls,
1387 struct timeval *timeout,
1389 LDAPMessage **res ));
1392 ldap_search LDAP_P(( /* deprecated */
1394 LDAP_CONST char *base,
1396 LDAP_CONST char *filter,
1401 ldap_search_s LDAP_P(( /* deprecated */
1403 LDAP_CONST char *base,
1405 LDAP_CONST char *filter,
1408 LDAPMessage **res ));
1411 ldap_search_st LDAP_P(( /* deprecated */
1413 LDAP_CONST char *base,
1415 LDAP_CONST char *filter,
1418 struct timeval *timeout,
1419 LDAPMessage **res ));
1425 ldap_unbind LDAP_P(( /* deprecated */
1429 ldap_unbind_s LDAP_P(( /* deprecated */
1433 ldap_unbind_ext LDAP_P((
1435 LDAPControl **serverctrls,
1436 LDAPControl **clientctrls));
1439 ldap_unbind_ext_s LDAP_P((
1441 LDAPControl **serverctrls,
1442 LDAPControl **clientctrls));
1448 LDAP_F( LDAPFiltDesc * )
1449 ldap_init_getfilter LDAP_P(( /* deprecated */
1450 LDAP_CONST char *fname ));
1452 LDAP_F( LDAPFiltInfo * )
1453 ldap_getfirstfilter LDAP_P(( /* deprecated */
1455 /* LDAP_CONST */ char *tagpat,
1456 /* LDAP_CONST */ char *value ));
1458 LDAP_F( LDAPFiltInfo * )
1459 ldap_getnextfilter LDAP_P(( /* deprecated */
1460 LDAPFiltDesc *lfdp ));
1468 ldap_memalloc LDAP_P((
1472 ldap_memrealloc LDAP_P((
1477 ldap_memcalloc LDAP_P((
1482 ldap_memfree LDAP_P((
1486 ldap_memvfree LDAP_P((
1490 ldap_strdup LDAP_P((
1491 LDAP_CONST char * ));
1494 ldap_getfilter_free LDAP_P((
1495 LDAPFiltDesc *lfdp ));
1498 ldap_mods_free LDAP_P((
1507 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1508 LDAP_CONST char *left,
1509 LDAP_CONST char *right ));
1511 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1512 LDAP_CONST void *left,
1513 LDAP_CONST void *right ));
1515 LDAP_F( int ) /* deprecated */
1516 ldap_sort_entries LDAP_P(( LDAP *ld,
1517 LDAPMessage **chain,
1518 LDAP_CONST char *attr,
1519 LDAP_SORT_AD_CMP_PROC *cmp ));
1521 LDAP_F( int ) /* deprecated */
1522 ldap_sort_values LDAP_P((
1525 LDAP_SORT_AV_CMP_PROC *cmp ));
1527 LDAP_F( int ) /* deprecated */
1528 ldap_sort_strcasecmp LDAP_P((
1530 LDAP_CONST void *b ));
1537 ldap_is_ldap_url LDAP_P((
1538 LDAP_CONST char *url ));
1541 ldap_is_ldaps_url LDAP_P((
1542 LDAP_CONST char *url ));
1545 ldap_is_ldapi_url LDAP_P((
1546 LDAP_CONST char *url ));
1549 ldap_url_parse LDAP_P((
1550 LDAP_CONST char *url,
1551 LDAPURLDesc **ludpp ));
1554 ldap_url_desc2str LDAP_P((
1555 LDAPURLDesc *ludp ));
1558 ldap_free_urldesc LDAP_P((
1559 LDAPURLDesc *ludp ));
1565 * structure for a sort-key
1567 typedef struct ldapsortkey {
1568 char * attributeType;
1569 char * orderingRule;
1574 ldap_create_sort_keylist LDAP_P((
1575 LDAPSortKey ***sortKeyList,
1579 ldap_free_sort_keylist LDAP_P((
1580 LDAPSortKey **sortkeylist ));
1583 ldap_create_sort_control LDAP_P((
1585 LDAPSortKey **keyList,
1587 LDAPControl **ctrlp ));
1590 ldap_parse_sort_control LDAP_P((
1592 LDAPControl **ctrlp,
1593 unsigned long *result,
1594 char **attribute ));
1602 * structure for virtul list.
1604 typedef struct ldapvlvinfo {
1606 unsigned long ldvlv_before_count;
1607 unsigned long ldvlv_after_count;
1608 unsigned long ldvlv_offset;
1609 unsigned long ldvlv_count;
1610 struct berval *ldvlv_attrvalue;
1611 struct berval *ldvlv_context;
1612 void *ldvlv_extradata;
1616 ldap_create_vlv_control LDAP_P((
1618 LDAPVLVInfo *ldvlistp,
1619 LDAPControl **ctrlp ));
1622 ldap_parse_vlv_control LDAP_P((
1624 LDAPControl **ctrls,
1625 unsigned long *target_posp,
1626 unsigned long *list_countp,
1627 struct berval **contextp,
1632 #endif /* _LDAP_H */