2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2005 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms are permitted
19 * provided that this notice is preserved and that due credit is given
20 * to the University of Michigan at Ann Arbor. The name of the University
21 * may not be used to endorse or promote products derived from this
22 * software without specific prior written permission. This software
23 * is provided ``as is'' without express or implied warranty.
32 /* include version and API feature defines */
33 #include <ldap_features.h>
37 #define LDAP_VERSION1 1
38 #define LDAP_VERSION2 2
39 #define LDAP_VERSION3 3
41 #define LDAP_VERSION_MIN LDAP_VERSION2
42 #define LDAP_VERSION LDAP_VERSION2
43 #define LDAP_VERSION_MAX LDAP_VERSION3
46 * We use 3000+n here because it is above 1823 (for RFC 1823),
47 * above 2000+rev of IETF LDAPEXT draft (now quite dated),
48 * yet below allocations for new RFCs (just in case there is
49 * someday an RFC produced).
51 #define LDAP_API_VERSION 3001
52 #define LDAP_VENDOR_NAME "OpenLDAP"
54 /* OpenLDAP API Features */
55 #define LDAP_API_FEATURE_X_OPENLDAP LDAP_VENDOR_VERSION
57 #if defined( LDAP_API_FEATURE_X_OPENLDAP_REENTRANT ) || \
58 ( defined( LDAP_THREAD_SAFE ) && \
59 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE ) )
60 /* -lldap may or may not be thread safe */
61 /* -lldap_r, if available, is always thread safe */
62 # define LDAP_API_FEATURE_THREAD_SAFE 1
64 #if defined( LDAP_THREAD_SAFE ) && \
65 defined( LDAP_API_FEATURE_X_OPENLDAP_THREAD_SAFE )
66 /* #define LDAP_API_FEATURE_SESSION_SAFE 1 */
67 /* #define LDAP_API_OPERATION_SESSION_SAFE 1 */
71 #define LDAP_PORT 389 /* ldap:/// default LDAP port */
72 #define LDAPS_PORT 636 /* ldaps:/// default LDAP over TLS port */
74 #define LDAP_ROOT_DSE ""
75 #define LDAP_NO_ATTRS "1.1"
76 #define LDAP_ALL_USER_ATTRIBUTES "*"
77 #define LDAP_ALL_OPERATIONAL_ATTRIBUTES "+" /* RFC 3673 */
79 /* RFC 2251: maxInt INTEGER ::= 2147483647 -- (2^^31 - 1) -- */
80 #define LDAP_MAXINT (2147483647)
84 * 0x0000 - 0x0fff reserved for api options
85 * 0x1000 - 0x3fff reserved for api extended options
86 * 0x4000 - 0x7fff reserved for private and experimental options
89 #define LDAP_OPT_API_INFO 0x0000
90 #define LDAP_OPT_DESC 0x0001 /* historic */
91 #define LDAP_OPT_DEREF 0x0002
92 #define LDAP_OPT_SIZELIMIT 0x0003
93 #define LDAP_OPT_TIMELIMIT 0x0004
94 /* 0x05 - 0x07 not defined */
95 #define LDAP_OPT_REFERRALS 0x0008
96 #define LDAP_OPT_RESTART 0x0009
97 /* 0x0a - 0x10 not defined */
98 #define LDAP_OPT_PROTOCOL_VERSION 0x0011
99 #define LDAP_OPT_SERVER_CONTROLS 0x0012
100 #define LDAP_OPT_CLIENT_CONTROLS 0x0013
101 /* 0x14 not defined */
102 #define LDAP_OPT_API_FEATURE_INFO 0x0015
103 /* 0x16 - 0x2f not defined */
104 #define LDAP_OPT_HOST_NAME 0x0030
105 #define LDAP_OPT_RESULT_CODE 0x0031
106 #define LDAP_OPT_ERROR_NUMBER LDAP_OPT_RESULT_CODE
107 #define LDAP_OPT_ERROR_STRING 0x0032
108 #define LDAP_OPT_MATCHED_DN 0x0033
109 /* 0x0034 - 0x3fff not defined */
112 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
114 /* private and experimental options */
115 /* OpenLDAP specific options */
116 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
117 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
118 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
119 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
120 #define LDAP_OPT_URI 0x5006
121 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
122 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */
124 /* OpenLDAP TLS options */
125 #define LDAP_OPT_X_TLS 0x6000
126 #define LDAP_OPT_X_TLS_CTX 0x6001 /* SSL CTX */
127 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
128 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
129 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
130 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
131 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
132 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
133 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
134 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
135 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
136 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
137 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
138 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
140 #define LDAP_OPT_X_TLS_NEVER 0
141 #define LDAP_OPT_X_TLS_HARD 1
142 #define LDAP_OPT_X_TLS_DEMAND 2
143 #define LDAP_OPT_X_TLS_ALLOW 3
144 #define LDAP_OPT_X_TLS_TRY 4
146 #define LDAP_OPT_X_TLS_CRL_NONE 0
147 #define LDAP_OPT_X_TLS_CRL_PEER 1
148 #define LDAP_OPT_X_TLS_CRL_ALL 2
150 /* OpenLDAP SASL options */
151 #define LDAP_OPT_X_SASL_MECH 0x6100
152 #define LDAP_OPT_X_SASL_REALM 0x6101
153 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
154 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
155 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
156 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
157 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
158 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
159 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
160 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
162 /* Private API Extensions -- reserved for application use */
163 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
166 * ldap_get_option() and ldap_set_option() return values.
167 * As later versions may return other values indicating
168 * failure, current applications should only compare returned
169 * value against LDAP_OPT_SUCCESS.
171 #define LDAP_OPT_SUCCESS 0
172 #define LDAP_OPT_ERROR (-1)
174 /* option on/off values */
175 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
176 #define LDAP_OPT_OFF ((void *) 0)
178 typedef struct ldapapiinfo {
179 int ldapai_info_version; /* version of LDAPAPIInfo */
180 #define LDAP_API_INFO_VERSION (1)
181 int ldapai_api_version; /* revision of API supported */
182 int ldapai_protocol_version; /* highest LDAP version supported */
183 char **ldapai_extensions; /* names of API extensions */
184 char *ldapai_vendor_name; /* name of supplier */
185 int ldapai_vendor_version; /* supplier-specific version * 100 */
188 typedef struct ldap_apifeature_info {
189 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
190 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
191 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
192 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
193 } LDAPAPIFeatureInfo;
196 * LDAP Control structure
198 typedef struct ldapcontrol {
199 char * ldctl_oid; /* numericoid of control */
200 struct berval ldctl_value; /* encoded value of control */
201 char ldctl_iscritical; /* criticality */
205 /* standard track controls */
206 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
207 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
208 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
209 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3" /* RFC 3876 */
211 /* standard track - not implemented in slapd(8) */
212 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
213 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
215 /* but not yet formalized controls */
216 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
218 /* various works in progress */
219 #define LDAP_CONTROL_ASSERT "1.3.6.1.4.1.4203.666.5.9"
220 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
221 #define LDAP_CONTROL_PRE_READ "1.3.6.1.4.1.4203.666.5.10.1"
222 #define LDAP_CONTROL_POST_READ "1.3.6.1.4.1.4203.666.5.10.2"
223 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
224 #define LDAP_CONTROL_MANAGEDIT "1.3.6.1.4.1.4203.666.5.12"
225 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
227 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
228 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
229 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
230 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
231 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
233 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
234 /* draft-ietf-ldapext-psearch-03.txt (expired) */
235 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
236 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
237 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_ADD 0x1
238 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_DELETE 0x2
239 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_MODIFY 0x4
240 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_RENAME 0x8
242 /* LDAP VLV *//* not implemented in slapd(8) */
243 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
244 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
246 /* Password policy Controls *//* work in progress */
247 /* ITS#3458: released, but not to latest draft; disabled by default */
248 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
249 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
251 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
252 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
253 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
254 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
255 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
256 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
258 #define LDAP_SYNC_NONE 0x00
259 #define LDAP_SYNC_REFRESH_ONLY 0x01
260 #define LDAP_SYNC_RESERVED 0x02
261 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
263 #define LDAP_SYNC_REFRESH_PRESENTS 0
264 #define LDAP_SYNC_REFRESH_DELETES 1
266 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
267 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
268 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
269 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
271 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
272 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
273 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
274 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
276 #define LDAP_SYNC_PRESENT 0
277 #define LDAP_SYNC_ADD 1
278 #define LDAP_SYNC_MODIFY 2
279 #define LDAP_SYNC_DELETE 3
281 /* LDAP Chaining Behavior Control *//* work in progress */
282 /* <draft-sermersheim-ldap-chaining>;
283 * see also LDAP_REQUIRES_CHAINING, LDAP_CANNOT_CHAIN */
285 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
287 #define LDAP_CHAINING_PREFERRED 0
288 #define LDAP_CHAINING_REQUIRED 1
289 #define LDAP_REFERRALS_PREFERRED 2
290 #define LDAP_REFERRALS_REQUIRED 3
293 /* MS ActiveDirectory controls (for compatibility) */
294 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
295 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
296 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
297 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
298 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
299 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
300 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */
302 /* LDAP Unsolicited Notifications */
303 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
304 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
306 /* LDAP Extended Operations */
307 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
309 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
310 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
311 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
312 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
313 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
315 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
316 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
318 /* various works in progress */
320 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
321 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
323 #define LDAP_EXOP_X_TURN "1.3.6.1.4.1.4203.666.6.4"
325 /* LDAP Grouping of Related Operations *//* a work in progress */
327 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
328 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
329 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
330 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
331 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
332 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
333 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
336 /* LDAP Grouping Types *//* a work in progress */
338 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
342 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
343 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
344 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
345 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
346 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
347 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
350 /* LDAP Experimental (works in progress) Features */
351 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.4.1.4203.666.8.2"
352 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
353 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
354 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
358 * specific LDAP instantiations of BER types we know about
361 /* Overview of LBER tag construction
368 * 1 0 = CONTEXT-SPECIFIC
375 * | 5 ... 1 | TAG-NUMBER
379 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
380 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
382 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
383 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
385 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
386 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
388 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
390 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
391 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
392 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
393 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
395 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
396 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
398 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
400 /* LDAP Request Messages */
401 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
402 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
403 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
404 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
405 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
406 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
407 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
408 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
409 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
410 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
411 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
412 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
414 /* LDAP Response Messages */
415 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
416 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
417 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
418 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
419 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
420 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
421 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
422 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
423 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
424 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
425 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
426 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
427 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
429 #define LDAP_RES_ANY (-1)
430 #define LDAP_RES_UNSOLICITED (0)
434 #define LDAP_SASL_SIMPLE ((char*)0)
435 #define LDAP_SASL_NULL ("")
438 /* authentication methods available */
439 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
440 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
441 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
442 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
443 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
444 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
448 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
449 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
450 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
451 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
452 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
453 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
454 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
455 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
456 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
457 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
459 /* extended filter component types */
460 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
461 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
462 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
463 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
465 /* substring filter component types */
466 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
467 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
468 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
471 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
472 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
473 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
474 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
475 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
476 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
477 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
478 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
479 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
481 /* substring filter component types */
482 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
483 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
484 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
489 #define LDAP_SUCCESS 0x00
491 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
493 #define LDAP_OPERATIONS_ERROR 0x01
494 #define LDAP_PROTOCOL_ERROR 0x02
495 #define LDAP_TIMELIMIT_EXCEEDED 0x03
496 #define LDAP_SIZELIMIT_EXCEEDED 0x04
497 #define LDAP_COMPARE_FALSE 0x05
498 #define LDAP_COMPARE_TRUE 0x06
499 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
500 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
501 #define LDAP_STRONG_AUTH_REQUIRED 0x08
502 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
503 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
505 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
506 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
507 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
508 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
509 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
511 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
513 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
514 #define LDAP_UNDEFINED_TYPE 0x11
515 #define LDAP_INAPPROPRIATE_MATCHING 0x12
516 #define LDAP_CONSTRAINT_VIOLATION 0x13
517 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
518 #define LDAP_INVALID_SYNTAX 0x15
520 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
522 #define LDAP_NO_SUCH_OBJECT 0x20
523 #define LDAP_ALIAS_PROBLEM 0x21
524 #define LDAP_INVALID_DN_SYNTAX 0x22
525 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
526 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
528 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
530 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
531 #define LDAP_INAPPROPRIATE_AUTH 0x30
532 #define LDAP_INVALID_CREDENTIALS 0x31
533 #define LDAP_INSUFFICIENT_ACCESS 0x32
535 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
537 #define LDAP_BUSY 0x33
538 #define LDAP_UNAVAILABLE 0x34
539 #define LDAP_UNWILLING_TO_PERFORM 0x35
540 #define LDAP_LOOP_DETECT 0x36
542 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
544 #define LDAP_NAMING_VIOLATION 0x40
545 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
546 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
547 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
548 #define LDAP_ALREADY_EXISTS 0x44
549 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
550 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
551 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
553 #define LDAP_OTHER 0x50
555 /* LCUP operation codes (113-117) - not implemented */
556 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
557 #define LDAP_CUP_SECURITY_VIOLATION 0x72
558 #define LDAP_CUP_INVALID_DATA 0x73
559 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
560 #define LDAP_CUP_RELOAD_REQUIRED 0x75
562 /* Cancel operation codes (118-121) */
563 #define LDAP_CANCELLED 0x76
564 #define LDAP_NO_SUCH_OPERATION 0x77
565 #define LDAP_TOO_LATE 0x78
566 #define LDAP_CANNOT_CANCEL 0x79
569 /* Experimental result codes */
570 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
571 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
573 /* for the LDAP Sync operation */
574 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
576 /* for the LDAP No-Op control */
577 #define LDAP_NO_OPERATION 0x410e
579 /* for the Assertion control */
580 #define LDAP_ASSERTION_FAILED 0x410f
582 /* for the Chaining Behavior control (consecutive result codes requested;
583 * see <draft-sermersheim-ldap-chaining> ) */
584 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
585 #define LDAP_REQUIRES_CHAINING 0x4110
586 #define LDAP_CANNOT_CHAIN 0x4111
591 * Based on draft-ietf-ldap-c-api-xx
592 * but with new negative code values
594 #define LDAP_API_ERROR(n) ((n)<0)
595 #define LDAP_API_RESULT(n) ((n)<=0)
597 #define LDAP_SERVER_DOWN (-1)
598 #define LDAP_LOCAL_ERROR (-2)
599 #define LDAP_ENCODING_ERROR (-3)
600 #define LDAP_DECODING_ERROR (-4)
601 #define LDAP_TIMEOUT (-5)
602 #define LDAP_AUTH_UNKNOWN (-6)
603 #define LDAP_FILTER_ERROR (-7)
604 #define LDAP_USER_CANCELLED (-8)
605 #define LDAP_PARAM_ERROR (-9)
606 #define LDAP_NO_MEMORY (-10)
607 #define LDAP_CONNECT_ERROR (-11)
608 #define LDAP_NOT_SUPPORTED (-12)
609 #define LDAP_CONTROL_NOT_FOUND (-13)
610 #define LDAP_NO_RESULTS_RETURNED (-14)
611 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
612 #define LDAP_CLIENT_LOOP (-16)
613 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
617 * This structure represents both ldap messages and ldap responses.
618 * These are really the same, except in the case of search responses,
619 * where a response has multiple messages.
622 typedef struct ldapmsg LDAPMessage;
624 /* for modifications */
625 typedef struct ldapmod {
628 #define LDAP_MOD_OP (0x0007)
629 #define LDAP_MOD_ADD (0x0000)
630 #define LDAP_MOD_DELETE (0x0001)
631 #define LDAP_MOD_REPLACE (0x0002)
632 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
633 #define LDAP_MOD_BVALUES (0x0080)
634 /* IMPORTANT: do not use code 0x1000 (or above),
635 * it is used internally by the backends!
636 * (see ldap/servers/slapd/slap.h)
642 struct berval **modv_bvals;
644 #define mod_values mod_vals.modv_strvals
645 #define mod_bvalues mod_vals.modv_bvals
649 * structure representing an ldap session which can
650 * encompass connections to multiple servers (in the
651 * face of referrals).
653 typedef struct ldap LDAP;
655 #define LDAP_DEREF_NEVER 0x00
656 #define LDAP_DEREF_SEARCHING 0x01
657 #define LDAP_DEREF_FINDING 0x02
658 #define LDAP_DEREF_ALWAYS 0x03
660 #define LDAP_NO_LIMIT 0
662 /* how many messages to retrieve results for */
663 #define LDAP_MSG_ONE 0x00
664 #define LDAP_MSG_ALL 0x01
665 #define LDAP_MSG_RECEIVED 0x02
668 * types for ldap URL handling
670 typedef struct ldap_url_desc {
671 struct ldap_url_desc *lud_next;
683 #define LDAP_URL_SUCCESS 0x00 /* Success */
684 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
685 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
687 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
688 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
689 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
690 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
691 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
692 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
693 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
694 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
697 * The API draft spec says we should declare (or cause to be declared)
698 * 'struct timeval'. We don't. See IETF LDAPext discussions.
706 ldap_get_option LDAP_P((
712 ldap_set_option LDAP_P((
715 LDAP_CONST void *invalue));
717 /* V3 REBIND Function Callback Prototype */
718 typedef int (LDAP_REBIND_PROC) LDAP_P((
719 LDAP *ld, LDAP_CONST char *url,
720 ber_tag_t request, ber_int_t msgid,
724 ldap_set_rebind_proc LDAP_P((
726 LDAP_REBIND_PROC *rebind_proc,
733 ldap_create_control LDAP_P((
734 LDAP_CONST char *requestOID,
737 LDAPControl **ctrlp ));
739 LDAP_F( LDAPControl * )
740 ldap_find_control LDAP_P((
741 LDAP_CONST char *oid,
742 LDAPControl **ctrls ));
745 ldap_control_free LDAP_P((
746 LDAPControl *ctrl ));
749 ldap_controls_free LDAP_P((
750 LDAPControl **ctrls ));
756 ldap_domain2dn LDAP_P((
757 LDAP_CONST char* domain,
761 ldap_dn2domain LDAP_P((
766 ldap_domain2hostlist LDAP_P((
767 LDAP_CONST char *domain,
774 ldap_extended_operation LDAP_P((
776 LDAP_CONST char *reqoid,
777 struct berval *reqdata,
778 LDAPControl **serverctrls,
779 LDAPControl **clientctrls,
783 ldap_extended_operation_s LDAP_P((
785 LDAP_CONST char *reqoid,
786 struct berval *reqdata,
787 LDAPControl **serverctrls,
788 LDAPControl **clientctrls,
790 struct berval **retdatap ));
793 ldap_parse_extended_result LDAP_P((
797 struct berval **retdatap,
801 ldap_parse_intermediate LDAP_P((
805 struct berval **retdatap,
806 LDAPControl ***serverctrls,
812 #ifdef LDAP_EXOP_GROUPING_CREATE
815 ldap_grouping_create LDAP_P((
817 LDAP_CONST char *grpoid,
818 struct berval *grpdata,
819 LDAPControl **serverctrls,
820 LDAPControl **clientctrls,
824 ldap_grouping_create_s LDAP_P((
826 LDAP_CONST char *grpoid,
827 struct berval *grpdata,
828 LDAPControl **serverctrls,
829 LDAPControl **clientctrls,
830 struct berval **retgrpcookiep,
831 struct berval **retgrpdatap ));
834 ldap_parse_grouping_create_result LDAP_P((
837 struct berval **retgrpcookiep,
838 struct berval **retgrpdatap,
839 LDAPControl ***serverctrls,
843 ldap_grouping_end LDAP_P((
845 LDAP_CONST char *grpoid,
846 struct berval *grpdata,
847 LDAPControl **serverctrls,
848 LDAPControl **clientctrls,
852 ldap_grouping_end_s LDAP_P((
854 LDAP_CONST char *grpoid,
855 struct berval *grpdata,
856 LDAPControl **serverctrls,
857 LDAPControl **clientctrls,
858 struct berval **retgrpdatap ));
861 ldap_parse_grouping_end_result LDAP_P((
864 struct berval **retgrpdatap,
865 LDAPControl ***serverctrls,
869 ldap_grouping_action_operation LDAP_P((
871 LDAP_CONST char *grpoid,
872 struct berval *grpdata,
873 LDAPControl **serverctrls,
874 LDAPControl **clientctrls,
878 ldap_grouping_action_operation_s LDAP_P((
880 LDAP_CONST char *grpoid,
881 struct berval *grpdata,
882 LDAPControl **serverctrls,
883 LDAPControl **clientctrls,
884 struct berval **retgrpcookiep,
885 struct berval **retgrpdatap ));
888 ldap_parse_grouping_action_result LDAP_P((
891 struct berval **retgrpcookiep,
892 struct berval **retgrpdatap,
893 LDAPControl ***serverctrls,
897 ldap_parse_grouping_end_notice LDAP_P((
900 struct berval **retdatap,
901 struct berval **retgrpcookiep,
902 struct berval **retgrpdatap,
906 ldap_parse_grouping_info_notice LDAP_P((
909 struct berval **retdatap,
910 struct berval **retgrpcookiep,
911 struct berval **retgrpdatap,
919 ldap_abandon_ext LDAP_P((
922 LDAPControl **serverctrls,
923 LDAPControl **clientctrls ));
927 ldap_abandon LDAP_P(( /* deprecated */
937 ldap_add_ext LDAP_P((
941 LDAPControl **serverctrls,
942 LDAPControl **clientctrls,
946 ldap_add_ext_s LDAP_P((
950 LDAPControl **serverctrls,
951 LDAPControl **clientctrls ));
955 ldap_add LDAP_P(( /* deprecated */
961 ldap_add_s LDAP_P(( /* deprecated */
972 ldap_sasl_bind LDAP_P((
975 LDAP_CONST char *mechanism,
977 LDAPControl **serverctrls,
978 LDAPControl **clientctrls,
981 /* Interaction flags (should be passed about in a control)
982 * Automatic (default): use defaults, prompt otherwise
983 * Interactive: prompt always
984 * Quiet: never prompt
986 #define LDAP_SASL_AUTOMATIC 0U
987 #define LDAP_SASL_INTERACTIVE 1U
988 #define LDAP_SASL_QUIET 2U
991 * V3 SASL Interaction Function Callback Prototype
992 * when using Cyrus SASL, interact is pointer to sasl_interact_t
993 * should likely passed in a control (and provided controls)
995 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
996 LDAP *ld, unsigned flags, void* defaults, void *interact ));
999 ldap_sasl_interactive_bind_s LDAP_P((
1001 LDAP_CONST char *dn, /* usually NULL */
1002 LDAP_CONST char *saslMechanism,
1003 LDAPControl **serverControls,
1004 LDAPControl **clientControls,
1006 /* should be client controls */
1008 LDAP_SASL_INTERACT_PROC *proc,
1012 ldap_sasl_bind_s LDAP_P((
1014 LDAP_CONST char *dn,
1015 LDAP_CONST char *mechanism,
1016 struct berval *cred,
1017 LDAPControl **serverctrls,
1018 LDAPControl **clientctrls,
1019 struct berval **servercredp ));
1022 ldap_parse_sasl_bind_result LDAP_P((
1025 struct berval **servercredp,
1034 ldap_bind LDAP_P(( /* deprecated */
1036 LDAP_CONST char *who,
1037 LDAP_CONST char *passwd,
1041 ldap_bind_s LDAP_P(( /* deprecated */
1043 LDAP_CONST char *who,
1044 LDAP_CONST char *cred,
1051 ldap_simple_bind LDAP_P(( /* deprecated */
1053 LDAP_CONST char *who,
1054 LDAP_CONST char *passwd ));
1057 ldap_simple_bind_s LDAP_P(( /* deprecated */
1059 LDAP_CONST char *who,
1060 LDAP_CONST char *passwd ));
1068 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1070 LDAP_CONST char *who ));
1073 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1075 LDAP_CONST char *who ));
1078 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1080 LDAP_CONST char *who ));
1083 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1085 LDAP_CONST char *who ));
1088 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1090 LDAP_CONST char *who ));
1098 ldap_compare_ext LDAP_P((
1100 LDAP_CONST char *dn,
1101 LDAP_CONST char *attr,
1102 struct berval *bvalue,
1103 LDAPControl **serverctrls,
1104 LDAPControl **clientctrls,
1108 ldap_compare_ext_s LDAP_P((
1110 LDAP_CONST char *dn,
1111 LDAP_CONST char *attr,
1112 struct berval *bvalue,
1113 LDAPControl **serverctrls,
1114 LDAPControl **clientctrls ));
1118 ldap_compare LDAP_P(( /* deprecated */
1120 LDAP_CONST char *dn,
1121 LDAP_CONST char *attr,
1122 LDAP_CONST char *value ));
1125 ldap_compare_s LDAP_P(( /* deprecated */
1127 LDAP_CONST char *dn,
1128 LDAP_CONST char *attr,
1129 LDAP_CONST char *value ));
1137 ldap_delete_ext LDAP_P((
1139 LDAP_CONST char *dn,
1140 LDAPControl **serverctrls,
1141 LDAPControl **clientctrls,
1145 ldap_delete_ext_s LDAP_P((
1147 LDAP_CONST char *dn,
1148 LDAPControl **serverctrls,
1149 LDAPControl **clientctrls ));
1153 ldap_delete LDAP_P(( /* deprecated */
1155 LDAP_CONST char *dn ));
1158 ldap_delete_s LDAP_P(( /* deprecated */
1160 LDAP_CONST char *dn ));
1168 ldap_parse_result LDAP_P((
1175 LDAPControl ***serverctrls,
1179 ldap_err2string LDAP_P((
1184 ldap_result2error LDAP_P(( /* deprecated */
1190 ldap_perror LDAP_P(( /* deprecated */
1192 LDAP_CONST char *s ));
1200 ldap_modify_ext LDAP_P((
1202 LDAP_CONST char *dn,
1204 LDAPControl **serverctrls,
1205 LDAPControl **clientctrls,
1209 ldap_modify_ext_s LDAP_P((
1211 LDAP_CONST char *dn,
1213 LDAPControl **serverctrls,
1214 LDAPControl **clientctrls ));
1218 ldap_modify LDAP_P(( /* deprecated */
1220 LDAP_CONST char *dn,
1224 ldap_modify_s LDAP_P(( /* deprecated */
1226 LDAP_CONST char *dn,
1235 ldap_rename LDAP_P((
1237 LDAP_CONST char *dn,
1238 LDAP_CONST char *newrdn,
1239 LDAP_CONST char *newSuperior,
1241 LDAPControl **sctrls,
1242 LDAPControl **cctrls,
1246 ldap_rename_s LDAP_P((
1248 LDAP_CONST char *dn,
1249 LDAP_CONST char *newrdn,
1250 LDAP_CONST char *newSuperior,
1252 LDAPControl **sctrls,
1253 LDAPControl **cctrls ));
1257 ldap_rename2 LDAP_P(( /* deprecated */
1259 LDAP_CONST char *dn,
1260 LDAP_CONST char *newrdn,
1261 LDAP_CONST char *newSuperior,
1262 int deleteoldrdn ));
1265 ldap_rename2_s LDAP_P(( /* deprecated */
1267 LDAP_CONST char *dn,
1268 LDAP_CONST char *newrdn,
1269 LDAP_CONST char *newSuperior,
1270 int deleteoldrdn ));
1273 ldap_modrdn LDAP_P(( /* deprecated */
1275 LDAP_CONST char *dn,
1276 LDAP_CONST char *newrdn ));
1279 ldap_modrdn_s LDAP_P(( /* deprecated */
1281 LDAP_CONST char *dn,
1282 LDAP_CONST char *newrdn ));
1285 ldap_modrdn2 LDAP_P(( /* deprecated */
1287 LDAP_CONST char *dn,
1288 LDAP_CONST char *newrdn,
1289 int deleteoldrdn ));
1292 ldap_modrdn2_s LDAP_P(( /* deprecated */
1294 LDAP_CONST char *dn,
1295 LDAP_CONST char *newrdn,
1305 ldap_init LDAP_P(( /* deprecated */
1306 LDAP_CONST char *host,
1310 ldap_open LDAP_P(( /* deprecated */
1311 LDAP_CONST char *host,
1316 ldap_create LDAP_P((
1320 ldap_initialize LDAP_P((
1322 LDAP_CONST char *url ));
1329 ldap_start_tls LDAP_P((
1331 LDAPControl **serverctrls,
1332 LDAPControl **clientctrls,
1336 ldap_install_tls LDAP_P((
1340 ldap_start_tls_s LDAP_P((
1342 LDAPControl **serverctrls,
1343 LDAPControl **clientctrls ));
1348 LDAP_F( LDAPMessage * )
1349 ldap_first_message LDAP_P((
1351 LDAPMessage *chain ));
1353 LDAP_F( LDAPMessage * )
1354 ldap_next_message LDAP_P((
1356 LDAPMessage *msg ));
1359 ldap_count_messages LDAP_P((
1361 LDAPMessage *chain ));
1366 LDAP_F( LDAPMessage * )
1367 ldap_first_reference LDAP_P((
1369 LDAPMessage *chain ));
1371 LDAP_F( LDAPMessage * )
1372 ldap_next_reference LDAP_P((
1374 LDAPMessage *ref ));
1377 ldap_count_references LDAP_P((
1379 LDAPMessage *chain ));
1382 ldap_parse_reference LDAP_P((
1386 LDAPControl ***serverctrls,
1393 LDAP_F( LDAPMessage * )
1394 ldap_first_entry LDAP_P((
1396 LDAPMessage *chain ));
1398 LDAP_F( LDAPMessage * )
1399 ldap_next_entry LDAP_P((
1401 LDAPMessage *entry ));
1404 ldap_count_entries LDAP_P((
1406 LDAPMessage *chain ));
1409 ldap_get_entry_controls LDAP_P((
1412 LDAPControl ***serverctrls));
1418 LDAP_F( LDAPMessage * )
1419 ldap_delete_result_entry LDAP_P((
1424 ldap_add_result_entry LDAP_P((
1433 ldap_get_dn LDAP_P((
1435 LDAPMessage *entry ));
1437 typedef struct ldap_ava {
1438 struct berval la_attr;
1439 struct berval la_value;
1441 #define LDAP_AVA_NULL 0x0000U
1442 #define LDAP_AVA_STRING 0x0001U
1443 #define LDAP_AVA_BINARY 0x0002U
1444 #define LDAP_AVA_NONPRINTABLE 0x0004U
1445 #define LDAP_AVA_FREE_ATTR 0x0010U
1446 #define LDAP_AVA_FREE_VALUE 0x0020U
1451 typedef LDAPAVA** LDAPRDN;
1452 typedef LDAPRDN* LDAPDN;
1455 #define LDAP_DN_FORMAT_LDAP 0x0000U
1456 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1457 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1458 #define LDAP_DN_FORMAT_DCE 0x0030U
1459 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1460 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1461 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1462 #define LDAP_DN_FORMAT_MASK 0x00F0U
1465 #define LDAP_DN_PRETTY 0x0100U
1466 #define LDAP_DN_SKIP 0x0200U
1467 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1468 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1469 #define LDAP_DN_PEDANTIC 0xF000U
1471 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1472 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1481 ldap_str2dn LDAP_P((
1482 LDAP_CONST char *str,
1493 ldap_dn2str LDAP_P((
1499 ldap_bv2rdn LDAP_P((
1506 ldap_str2rdn LDAP_P((
1507 LDAP_CONST char *str,
1513 ldap_rdn2bv LDAP_P((
1519 ldap_rdn2str LDAP_P((
1525 ldap_dn_normalize LDAP_P((
1526 LDAP_CONST char *in, unsigned iflags,
1527 char **out, unsigned oflags ));
1530 ldap_dn2ufn LDAP_P(( /* deprecated */
1531 LDAP_CONST char *dn ));
1534 ldap_explode_dn LDAP_P(( /* deprecated */
1535 LDAP_CONST char *dn,
1539 ldap_explode_rdn LDAP_P(( /* deprecated */
1540 LDAP_CONST char *rdn,
1543 typedef int LDAPDN_rewrite_func
1544 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1547 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1548 LDAPDN_rewrite_func *func, unsigned flags ));
1551 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1554 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1557 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1560 ldap_get_dn_ber LDAP_P((
1561 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1564 ldap_get_attribute_ber LDAP_P((
1565 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1566 struct berval **vals ));
1572 ldap_first_attribute LDAP_P((
1575 BerElement **ber ));
1578 ldap_next_attribute LDAP_P((
1587 LDAP_F( struct berval ** )
1588 ldap_get_values_len LDAP_P((
1591 LDAP_CONST char *target ));
1594 ldap_count_values_len LDAP_P((
1595 struct berval **vals ));
1598 ldap_value_free_len LDAP_P((
1599 struct berval **vals ));
1603 ldap_get_values LDAP_P(( /* deprecated */
1606 LDAP_CONST char *target ));
1609 ldap_count_values LDAP_P(( /* deprecated */
1613 ldap_value_free LDAP_P(( /* deprecated */
1621 ldap_result LDAP_P((
1625 struct timeval *timeout,
1626 LDAPMessage **result ));
1629 ldap_msgtype LDAP_P((
1637 ldap_msgfree LDAP_P((
1641 ldap_msgdelete LDAP_P((
1650 ldap_search_ext LDAP_P((
1652 LDAP_CONST char *base,
1654 LDAP_CONST char *filter,
1657 LDAPControl **serverctrls,
1658 LDAPControl **clientctrls,
1659 struct timeval *timeout,
1664 ldap_search_ext_s LDAP_P((
1666 LDAP_CONST char *base,
1668 LDAP_CONST char *filter,
1671 LDAPControl **serverctrls,
1672 LDAPControl **clientctrls,
1673 struct timeval *timeout,
1675 LDAPMessage **res ));
1679 ldap_search LDAP_P(( /* deprecated */
1681 LDAP_CONST char *base,
1683 LDAP_CONST char *filter,
1688 ldap_search_s LDAP_P(( /* deprecated */
1690 LDAP_CONST char *base,
1692 LDAP_CONST char *filter,
1695 LDAPMessage **res ));
1698 ldap_search_st LDAP_P(( /* deprecated */
1700 LDAP_CONST char *base,
1702 LDAP_CONST char *filter,
1705 struct timeval *timeout,
1706 LDAPMessage **res ));
1713 ldap_unbind_ext LDAP_P((
1715 LDAPControl **serverctrls,
1716 LDAPControl **clientctrls));
1719 ldap_unbind_ext_s LDAP_P((
1721 LDAPControl **serverctrls,
1722 LDAPControl **clientctrls));
1726 ldap_unbind LDAP_P(( /* deprecated */
1730 ldap_unbind_s LDAP_P(( /* deprecated */
1738 ldap_put_vrFilter LDAP_P((
1747 ldap_memalloc LDAP_P((
1751 ldap_memrealloc LDAP_P((
1756 ldap_memcalloc LDAP_P((
1761 ldap_memfree LDAP_P((
1765 ldap_memvfree LDAP_P((
1769 ldap_strdup LDAP_P((
1770 LDAP_CONST char * ));
1773 ldap_mods_free LDAP_P((
1780 * in sort.c (deprecated)
1782 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1783 LDAP_CONST char *left,
1784 LDAP_CONST char *right ));
1786 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1787 LDAP_CONST void *left,
1788 LDAP_CONST void *right ));
1790 LDAP_F( int ) /* deprecated */
1791 ldap_sort_entries LDAP_P(( LDAP *ld,
1792 LDAPMessage **chain,
1793 LDAP_CONST char *attr,
1794 LDAP_SORT_AD_CMP_PROC *cmp ));
1796 LDAP_F( int ) /* deprecated */
1797 ldap_sort_values LDAP_P((
1800 LDAP_SORT_AV_CMP_PROC *cmp ));
1802 LDAP_F( int ) /* deprecated */
1803 ldap_sort_strcasecmp LDAP_P((
1805 LDAP_CONST void *b ));
1812 ldap_is_ldap_url LDAP_P((
1813 LDAP_CONST char *url ));
1816 ldap_is_ldaps_url LDAP_P((
1817 LDAP_CONST char *url ));
1820 ldap_is_ldapi_url LDAP_P((
1821 LDAP_CONST char *url ));
1824 ldap_url_parse LDAP_P((
1825 LDAP_CONST char *url,
1826 LDAPURLDesc **ludpp ));
1829 ldap_url_desc2str LDAP_P((
1830 LDAPURLDesc *ludp ));
1833 ldap_free_urldesc LDAP_P((
1834 LDAPURLDesc *ludp ));
1838 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1841 #define LDAP_API_FEATURE_CANCEL 1000
1844 ldap_cancel LDAP_P(( LDAP *ld,
1846 LDAPControl **sctrls,
1847 LDAPControl **cctrls,
1851 ldap_cancel_s LDAP_P(( LDAP *ld,
1853 LDAPControl **sctrl,
1854 LDAPControl **cctrl ));
1857 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1860 #define LDAP_API_FEATURE_TURN 1000
1863 ldap_turn LDAP_P(( LDAP *ld,
1865 LDAP_CONST char* identifier,
1866 LDAPControl **sctrls,
1867 LDAPControl **cctrls,
1871 ldap_turn_s LDAP_P(( LDAP *ld,
1873 LDAP_CONST char* identifier,
1874 LDAPControl **sctrl,
1875 LDAPControl **cctrl ));
1878 * LDAP Server Side Sort
1881 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1883 /* structure for a sort-key */
1884 typedef struct ldapsortkey {
1885 char * attributeType;
1886 char * orderingRule;
1891 ldap_create_sort_keylist LDAP_P((
1892 LDAPSortKey ***sortKeyList,
1896 ldap_free_sort_keylist LDAP_P((
1897 LDAPSortKey **sortkeylist ));
1900 ldap_create_sort_control LDAP_P((
1902 LDAPSortKey **keyList,
1904 LDAPControl **ctrlp ));
1907 ldap_parse_sort_control LDAP_P((
1909 LDAPControl **ctrlp,
1910 unsigned long *result,
1911 char **attribute ));
1915 * LDAP Virtual List View
1918 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1920 /* structure for virtual list */
1921 typedef struct ldapvlvinfo {
1923 unsigned long ldvlv_before_count;
1924 unsigned long ldvlv_after_count;
1925 unsigned long ldvlv_offset;
1926 unsigned long ldvlv_count;
1927 struct berval * ldvlv_attrvalue;
1928 struct berval * ldvlv_context;
1929 void * ldvlv_extradata;
1933 ldap_create_vlv_control LDAP_P((
1935 LDAPVLVInfo *ldvlistp,
1936 LDAPControl **ctrlp ));
1939 ldap_parse_vlv_control LDAP_P((
1941 LDAPControl **ctrls,
1942 unsigned long *target_posp,
1943 unsigned long *list_countp,
1944 struct berval **contextp,
1951 #ifdef LDAP_GROUPING_TRANSACTION
1953 ldap_parse_txn_create LDAP_P((
1956 struct berval **cookie ));
1959 ldap_txn_create LDAP_P((
1961 LDAPControl **sctrls,
1962 LDAPControl **cctrls,
1966 ldap_txn_create_s LDAP_P((
1968 struct berval **cookie,
1969 LDAPControl **sctrls,
1970 LDAPControl **cctrls ));
1973 ldap_txn_end LDAP_P((
1975 struct berval *cookie,
1977 LDAPControl **sctrls,
1978 LDAPControl **cctrls,
1982 ldap_txn_end_s LDAP_P((
1984 struct berval *cookie,
1986 LDAPControl **sctrls,
1987 LDAPControl **cctrls ));
1994 #define LDAP_API_FEATURE_WHOAMI 1000
1997 ldap_parse_whoami LDAP_P((
2000 struct berval **authzid ));
2003 ldap_whoami LDAP_P(( LDAP *ld,
2004 LDAPControl **sctrls,
2005 LDAPControl **cctrls,
2009 ldap_whoami_s LDAP_P((
2011 struct berval **authzid,
2012 LDAPControl **sctrls,
2013 LDAPControl **cctrls ));
2016 * LDAP Password Modify
2019 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2022 ldap_parse_passwd LDAP_P((
2025 struct berval *newpasswd ));
2028 ldap_passwd LDAP_P(( LDAP *ld,
2029 struct berval *user,
2030 struct berval *oldpw,
2031 struct berval *newpw,
2032 LDAPControl **sctrls,
2033 LDAPControl **cctrls,
2037 ldap_passwd_s LDAP_P((
2039 struct berval *user,
2040 struct berval *oldpw,
2041 struct berval *newpw,
2042 struct berval *newpasswd,
2043 LDAPControl **sctrls,
2044 LDAPControl **cctrls ));
2046 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2048 * LDAP Password Policy controls
2051 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2053 typedef enum passpolicyerror_enum {
2054 PP_passwordExpired = 0,
2055 PP_accountLocked = 1,
2056 PP_changeAfterReset = 2,
2057 PP_passwordModNotAllowed = 3,
2058 PP_mustSupplyOldPassword = 4,
2059 PP_insufficientPasswordQuality = 5,
2060 PP_passwordTooShort = 6,
2061 PP_passwordTooYoung = 7,
2062 PP_passwordInHistory = 8,
2064 } LDAPPasswordPolicyError;
2067 ldap_create_passwordpolicy_control LDAP_P((
2069 LDAPControl **ctrlp ));
2072 ldap_parse_passwordpolicy_control LDAP_P((
2077 LDAPPasswordPolicyError *errorp ));
2079 LDAP_F( const char * )
2080 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2081 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2084 #endif /* _LDAP_H */