3 * Copyright 1998-2001 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"
50 /* We'll eventually release as 20000 */
52 /* OpenLDAP API Features */
53 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
55 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
56 ( defined( LDAP_THREAD_SAFE ) && \
57 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
58 /* -lldap may or may not be thread safe */
59 /* -lldap_r, if available, is always thread safe */
60 # define LDAP_API_FEATURE_THREAD_SAFE 1
62 #if defined( LDAP_THREAD_SAFE ) && \
63 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
64 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
65 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
68 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
69 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
71 #define LDAP_ROOT_DSE ""
72 #define LDAP_NO_ATTRS "1.1"
73 #define LDAP_ALL_USER_ATTRIBUTES "*"
74 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* OpenLDAP extension */
77 * LDAP_OPTions defined by draft-ldapext-ldap-c-api-02
78 * 0x0000 - 0x0fff reserved for api options
79 * 0x1000 - 0x3fff reserved for api extended options
80 * 0x4000 - 0x7fff reserved for private and experimental options
82 #define LDAP_OPT_API_INFO 0x0000
83 #define LDAP_OPT_DESC 0x0001 /* deprecated */
84 #define LDAP_OPT_DEREF 0x0002
85 #define LDAP_OPT_SIZELIMIT 0x0003
86 #define LDAP_OPT_TIMELIMIT 0x0004
87 /* 0x05 - 0x07 not defined by current draft */
88 #define LDAP_OPT_REFERRALS 0x0008
89 #define LDAP_OPT_RESTART 0x0009
90 /* 0x0a - 0x10 not defined by current draft */
91 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
92 #define LDAP_OPT_SERVER_CONTROLS 0x0012
93 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
94 /* 0x14 not defined by current draft */
95 #define LDAP_OPT_API_FEATURE_INFO 0x0015
97 /* 0x16 - 0x2f not defined by current draft */
98 #define LDAP_OPT_HOST_NAME 0x0030
99 #define LDAP_OPT_ERROR_NUMBER 0x0031
100 #define LDAP_OPT_ERROR_STRING 0x0032
101 #define LDAP_OPT_MATCHED_DN 0x0033
103 /* 0x34 - 0x0fff not defined by current draft */
105 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x4000 /* to 0x7FFF inclusive */
107 /* private and experimental options */
108 /* OpenLDAP specific options */
109 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
110 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
111 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
112 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
113 #define LDAP_OPT_URI 0x5006
115 /* OpenLDAP TLS options */
116 #define LDAP_OPT_X_TLS 0x6000
117 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
118 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
119 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
120 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
121 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
122 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
123 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
124 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
125 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
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"
193 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
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"
198 /* Experimental Controls */
200 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473"
201 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474"
202 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
203 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
205 /* LDAP Unsolicited Notifications */
206 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036"
207 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
209 /* LDAP Extended Operations */
210 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037"
212 #define LDAP_EXOP_X_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1"
213 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
214 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
215 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
216 #define LDAP_TAG_EXOP_X_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
219 * specific LDAP instantiations of BER types we know about
222 /* Overview of LBER tag construction
229 * 1 0 = CONTEXT-SPECIFIC
236 * | 5 ... 1 | TAG-NUMBER
240 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
241 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
242 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
243 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
244 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
245 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
247 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
249 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
250 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
251 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
252 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
254 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
257 /* possible operations a client can invoke */
258 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
259 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
260 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
261 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
262 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
263 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
264 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
265 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
266 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
267 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
268 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
269 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
271 /* possible result types a server can return */
272 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
273 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
274 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
275 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
276 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
277 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
278 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
279 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
280 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
281 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
282 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
283 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
284 #define LDAP_RES_EXTENDED_PARTIAL ((ber_tag_t) 0x79U) /* V3+: application + constructed */
286 #define LDAP_RES_ANY (-1)
287 #define LDAP_RES_UNSOLICITED (0)
291 #define LDAP_SASL_SIMPLE ((char*)0)
292 #define LDAP_SASL_NULL ("")
295 /* authentication methods available */
296 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
297 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
298 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
299 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
300 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
301 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
305 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
306 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
307 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
308 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
309 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
310 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
311 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
312 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
313 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
314 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
316 /* extended filter component types */
317 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
318 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
319 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
320 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
322 /* substring filter component types */
323 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
324 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
325 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
328 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1)
329 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
330 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
331 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
333 /* substring filter component types */
334 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
335 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
336 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
339 * possible error codes we can return
342 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
344 #define LDAP_SUCCESS 0x00
345 #define LDAP_OPERATIONS_ERROR 0x01
346 #define LDAP_PROTOCOL_ERROR 0x02
347 #define LDAP_TIMELIMIT_EXCEEDED 0x03
348 #define LDAP_SIZELIMIT_EXCEEDED 0x04
349 #define LDAP_COMPARE_FALSE 0x05
350 #define LDAP_COMPARE_TRUE 0x06
351 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
352 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
353 #define LDAP_STRONG_AUTH_REQUIRED 0x08
354 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
356 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
357 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
358 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
359 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
360 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
362 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
364 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
365 #define LDAP_UNDEFINED_TYPE 0x11
366 #define LDAP_INAPPROPRIATE_MATCHING 0x12
367 #define LDAP_CONSTRAINT_VIOLATION 0x13
368 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
369 #define LDAP_INVALID_SYNTAX 0x15
371 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
373 #define LDAP_NO_SUCH_OBJECT 0x20
374 #define LDAP_ALIAS_PROBLEM 0x21
375 #define LDAP_INVALID_DN_SYNTAX 0x22
376 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
377 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
379 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x30,0x32) /* 48-50 */
381 #define LDAP_INAPPROPRIATE_AUTH 0x30
382 #define LDAP_INVALID_CREDENTIALS 0x31
383 #define LDAP_INSUFFICIENT_ACCESS 0x32
385 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
387 #define LDAP_BUSY 0x33
388 #define LDAP_UNAVAILABLE 0x34
389 #define LDAP_UNWILLING_TO_PERFORM 0x35
390 #define LDAP_LOOP_DETECT 0x36
392 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
394 #define LDAP_NAMING_VIOLATION 0x40
395 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
396 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
397 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
398 #define LDAP_ALREADY_EXISTS 0x44
399 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
400 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
401 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
403 #define LDAP_OTHER 0x50
405 #define LDAP_API_ERROR(n) LDAP_RANGE((n),0x51,0x61) /* 81-97 */
406 #define LDAP_API_RESULT(n) (((n) == LDAP_SUCCESS) || \
407 LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
409 /* reserved for APIs */
410 #define LDAP_SERVER_DOWN 0x51
411 #define LDAP_LOCAL_ERROR 0x52
412 #define LDAP_ENCODING_ERROR 0x53
413 #define LDAP_DECODING_ERROR 0x54
414 #define LDAP_TIMEOUT 0x55
415 #define LDAP_AUTH_UNKNOWN 0x56
416 #define LDAP_FILTER_ERROR 0x57
417 #define LDAP_USER_CANCELLED 0x58
418 #define LDAP_PARAM_ERROR 0x59
419 #define LDAP_NO_MEMORY 0x5a
421 /* used but not reserved for APIs */
422 #define LDAP_CONNECT_ERROR 0x5b /* draft-ietf-ldap-c-api-xx */
423 #define LDAP_NOT_SUPPORTED 0x5c /* draft-ietf-ldap-c-api-xx */
424 #define LDAP_CONTROL_NOT_FOUND 0x5d /* draft-ietf-ldap-c-api-xx */
425 #define LDAP_NO_RESULTS_RETURNED 0x5e /* draft-ietf-ldap-c-api-xx */
426 #define LDAP_MORE_RESULTS_TO_RETURN 0x5f /* draft-ietf-ldap-c-api-xx */
427 #define LDAP_CLIENT_LOOP 0x60 /* draft-ietf-ldap-c-api-xx */
428 #define LDAP_REFERRAL_LIMIT_EXCEEDED 0x61 /* draft-ietf-ldap-c-api-xx */
431 * This structure represents both ldap messages and ldap responses.
432 * These are really the same, except in the case of search responses,
433 * where a response has multiple messages.
436 typedef struct ldapmsg LDAPMessage;
438 /* for modifications */
439 typedef struct ldapmod {
442 #define LDAP_MOD_ADD ((ber_int_t) 0x0000)
443 #define LDAP_MOD_DELETE ((ber_int_t) 0x0001)
444 #define LDAP_MOD_REPLACE ((ber_int_t) 0x0002)
445 #define LDAP_MOD_BVALUES ((ber_int_t) 0x0080)
446 /* IMPORTANT: do not use code 0x1000 (or above),
447 * it is used internally by the backends!
448 * (see ldap/servers/slapd/slap.h)
454 struct berval **modv_bvals;
456 #define mod_values mod_vals.modv_strvals
457 #define mod_bvalues mod_vals.modv_bvals
461 * structures for ldap getfilter routines
464 typedef struct ldap_filt_info {
469 struct ldap_filt_info *lfi_next;
472 typedef struct ldap_filt_list {
476 LDAPFiltInfo *lfl_ilist;
477 struct ldap_filt_list *lfl_next;
481 #define LDAP_FILT_MAXSIZ 1024
483 typedef struct ldap_filt_desc {
484 LDAPFiltList *lfd_filtlist;
485 LDAPFiltInfo *lfd_curfip;
486 LDAPFiltInfo lfd_retfi;
487 char lfd_filter[ LDAP_FILT_MAXSIZ ];
489 char *lfd_curvalcopy;
490 char **lfd_curvalwords;
491 char *lfd_filtprefix;
492 char *lfd_filtsuffix;
497 * structure representing an ldap session which can
498 * encompass connections to multiple servers (in the
499 * face of referrals).
501 typedef struct ldap LDAP;
503 #define LDAP_DEREF_NEVER 0x00
504 #define LDAP_DEREF_SEARCHING 0x01
505 #define LDAP_DEREF_FINDING 0x02
506 #define LDAP_DEREF_ALWAYS 0x03
508 #define LDAP_NO_LIMIT 0
510 /* how many messages to retrieve results for */
511 #define LDAP_MSG_ONE 0x00
512 #define LDAP_MSG_ALL 0x01
513 #define LDAP_MSG_RECEIVED 0x02
516 * types for ldap URL handling
518 typedef struct ldap_url_desc {
519 struct ldap_url_desc *lud_next;
531 #define LDAP_URL_SUCCESS 0x00 /* Success */
532 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
533 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
535 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
536 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
537 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
538 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
539 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
540 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
541 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
542 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
545 * The API draft spec says we should declare (or cause to be declared)
546 * 'struct timeval'. We don't. See IETF LDAPext discussions.
554 ldap_get_option LDAP_P((
560 ldap_set_option LDAP_P((
563 LDAP_CONST void *invalue));
565 /* V3 REBIND Function Callback Prototype */
566 typedef int (LDAP_REBIND_PROC) LDAP_P((
567 LDAP *ld, LDAP_CONST char *url,
568 ber_tag_t request, ber_int_t msgid,
572 ldap_set_rebind_proc LDAP_P((
574 LDAP_REBIND_PROC *rebind_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 ));
1167 typedef struct ldap_ava {
1168 struct berval *la_attr;
1169 struct berval *la_value;
1171 #define LDAP_AVA_STRING 0x0000U
1172 #define LDAP_AVA_BINARY 0x0001U
1173 #define LDAP_AVA_NONPRINTABLE 0x0002U
1178 typedef LDAPAVA** LDAPRDN;
1179 typedef LDAPRDN** LDAPDN;
1182 #define LDAP_DN_FORMAT_LDAP 0x0000U
1183 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1184 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1185 #define LDAP_DN_FORMAT_DCE 0x0030U
1186 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1187 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1188 #define LDAP_DN_FORMAT_MASK 0x00F0U
1191 #define LDAP_DN_PRETTY 0x0100U
1192 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1193 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1194 #define LDAP_DN_PEDANTIC 0xF000U
1197 ldap_str2dn LDAP_P((
1198 LDAP_CONST char *str,
1203 ldap_dn2str LDAP_P((
1209 ldapava_free_dn LDAP_P(( LDAPDN *dn ));
1212 ldap_str2rdn LDAP_P((
1219 ldap_rdn2str LDAP_P((
1225 ldapava_free_rdn LDAP_P(( LDAPRDN *rdn ));
1228 ldap_dn_normalize LDAP_P((
1229 LDAP_CONST char *in, unsigned iflags,
1230 char **out, unsigned oflags ));
1233 ldap_dn2ufn LDAP_P(( /* deprecated */
1234 LDAP_CONST char *dn ));
1237 ldap_explode_dn LDAP_P(( /* deprecated */
1238 LDAP_CONST char *dn,
1242 ldap_explode_rdn LDAP_P(( /* deprecated */
1243 LDAP_CONST char *rdn,
1247 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1250 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1253 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1259 ldap_first_attribute LDAP_P((
1262 BerElement **ber ));
1265 ldap_next_attribute LDAP_P((
1275 ldap_get_values LDAP_P((
1278 LDAP_CONST char *target ));
1280 LDAP_F( struct berval ** )
1281 ldap_get_values_len LDAP_P((
1284 LDAP_CONST char *target ));
1287 ldap_count_values LDAP_P((
1291 ldap_count_values_len LDAP_P((
1292 struct berval **vals ));
1295 ldap_value_free LDAP_P((
1299 ldap_value_free_len LDAP_P((
1300 struct berval **vals ));
1306 ldap_result LDAP_P((
1310 struct timeval *timeout,
1311 LDAPMessage **result ));
1314 ldap_msgtype LDAP_P((
1322 ldap_msgfree LDAP_P((
1326 ldap_msgdelete LDAP_P((
1335 ldap_search_ext LDAP_P((
1337 LDAP_CONST char *base,
1339 LDAP_CONST char *filter,
1342 LDAPControl **serverctrls,
1343 LDAPControl **clientctrls,
1344 struct timeval *timeout,
1349 ldap_search_ext_s LDAP_P((
1351 LDAP_CONST char *base,
1353 LDAP_CONST char *filter,
1356 LDAPControl **serverctrls,
1357 LDAPControl **clientctrls,
1358 struct timeval *timeout,
1360 LDAPMessage **res ));
1363 ldap_search LDAP_P(( /* deprecated */
1365 LDAP_CONST char *base,
1367 LDAP_CONST char *filter,
1372 ldap_search_s LDAP_P(( /* deprecated */
1374 LDAP_CONST char *base,
1376 LDAP_CONST char *filter,
1379 LDAPMessage **res ));
1382 ldap_search_st LDAP_P(( /* deprecated */
1384 LDAP_CONST char *base,
1386 LDAP_CONST char *filter,
1389 struct timeval *timeout,
1390 LDAPMessage **res ));
1396 ldap_unbind LDAP_P(( /* deprecated */
1400 ldap_unbind_s LDAP_P(( /* deprecated */
1404 ldap_unbind_ext LDAP_P((
1406 LDAPControl **serverctrls,
1407 LDAPControl **clientctrls));
1410 ldap_unbind_ext_s LDAP_P((
1412 LDAPControl **serverctrls,
1413 LDAPControl **clientctrls));
1419 LDAP_F( LDAPFiltDesc * )
1420 ldap_init_getfilter LDAP_P(( /* deprecated */
1421 LDAP_CONST char *fname ));
1423 LDAP_F( LDAPFiltDesc * )
1424 ldap_init_getfilter_buf LDAP_P(( /* deprecated */
1425 /* LDAP_CONST */ char *buf,
1426 ber_len_t buflen ));
1428 LDAP_F( LDAPFiltInfo * )
1429 ldap_getfirstfilter LDAP_P(( /* deprecated */
1431 /* LDAP_CONST */ char *tagpat,
1432 /* LDAP_CONST */ char *value ));
1434 LDAP_F( LDAPFiltInfo * )
1435 ldap_getnextfilter LDAP_P(( /* deprecated */
1436 LDAPFiltDesc *lfdp ));
1439 ldap_setfilteraffixes LDAP_P(( /* deprecated */
1441 LDAP_CONST char *prefix,
1442 LDAP_CONST char *suffix ));
1445 ldap_build_filter LDAP_P(( /* deprecated */
1448 LDAP_CONST char *pattern,
1449 LDAP_CONST char *prefix,
1450 LDAP_CONST char *suffix,
1451 LDAP_CONST char *attr,
1452 LDAP_CONST char *value,
1461 ldap_memalloc LDAP_P((
1465 ldap_memrealloc LDAP_P((
1470 ldap_memcalloc LDAP_P((
1475 ldap_memfree LDAP_P((
1479 ldap_memvfree LDAP_P((
1483 ldap_strdup LDAP_P((
1484 LDAP_CONST char * ));
1487 ldap_getfilter_free LDAP_P((
1488 LDAPFiltDesc *lfdp ));
1491 ldap_mods_free LDAP_P((
1499 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P((
1500 LDAP_CONST char *left,
1501 LDAP_CONST char *right ));
1503 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P((
1504 LDAP_CONST void *left,
1505 LDAP_CONST void *right ));
1508 ldap_sort_entries LDAP_P(( LDAP *ld,
1509 LDAPMessage **chain,
1510 LDAP_CONST char *attr,
1511 LDAP_SORT_AD_CMP_PROC *cmp ));
1513 LDAP_F( int ) /* deprecated */
1514 ldap_sort_values LDAP_P((
1517 LDAP_SORT_AV_CMP_PROC *cmp ));
1519 LDAP_F( int ) /* deprecated */
1520 ldap_sort_strcasecmp LDAP_P((
1522 LDAP_CONST void *b ));
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_url_desc2str LDAP_P((
1547 LDAPURLDesc *ludp ));
1550 ldap_free_urldesc LDAP_P((
1551 LDAPURLDesc *ludp ));
1554 ldap_url_search LDAP_P((
1556 LDAP_CONST char *url,
1560 ldap_url_search_s LDAP_P((
1562 LDAP_CONST char *url,
1564 LDAPMessage **res ));
1567 ldap_url_search_st LDAP_P((
1569 LDAP_CONST char *url,
1571 struct timeval *timeout,
1572 LDAPMessage **res ));
1578 * structure for a sort-key
1580 typedef struct ldapsortkey {
1581 char * attributeType;
1582 char * orderingRule;
1587 ldap_create_sort_keylist LDAP_P((
1588 LDAPSortKey ***sortKeyList,
1592 ldap_free_sort_keylist LDAP_P((
1593 LDAPSortKey **sortkeylist ));
1596 ldap_create_sort_control LDAP_P((
1598 LDAPSortKey **keyList,
1600 LDAPControl **ctrlp ));
1603 ldap_parse_sort_control LDAP_P((
1605 LDAPControl **ctrlp,
1606 unsigned long *result,
1607 char **attribute ));
1615 * structure for virtul list.
1617 typedef struct ldapvlvinfo {
1619 unsigned long ldvlv_before_count;
1620 unsigned long ldvlv_after_count;
1621 unsigned long ldvlv_offset;
1622 unsigned long ldvlv_count;
1623 struct berval *ldvlv_attrvalue;
1624 struct berval *ldvlv_context;
1625 void *ldvlv_extradata;
1629 ldap_create_vlv_control LDAP_P((
1631 LDAPVLVInfo *ldvlistp,
1632 LDAPControl **ctrlp ));
1635 ldap_parse_vlv_control LDAP_P((
1637 LDAPControl **ctrls,
1638 unsigned long *target_posp,
1639 unsigned long *list_countp,
1640 struct berval **contextp,
1645 #endif /* _LDAP_H */