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
139 #define LDAP_OPT_X_TLS_DHPARAMDIR 0x600e
141 #define LDAP_OPT_X_TLS_NEVER 0
142 #define LDAP_OPT_X_TLS_HARD 1
143 #define LDAP_OPT_X_TLS_DEMAND 2
144 #define LDAP_OPT_X_TLS_ALLOW 3
145 #define LDAP_OPT_X_TLS_TRY 4
147 #define LDAP_OPT_X_TLS_CRL_NONE 0
148 #define LDAP_OPT_X_TLS_CRL_PEER 1
149 #define LDAP_OPT_X_TLS_CRL_ALL 2
151 /* OpenLDAP SASL options */
152 #define LDAP_OPT_X_SASL_MECH 0x6100
153 #define LDAP_OPT_X_SASL_REALM 0x6101
154 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
155 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
156 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
157 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
158 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
159 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
160 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
161 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
163 /* Private API Extensions -- reserved for application use */
164 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
167 * ldap_get_option() and ldap_set_option() return values.
168 * As later versions may return other values indicating
169 * failure, current applications should only compare returned
170 * value against LDAP_OPT_SUCCESS.
172 #define LDAP_OPT_SUCCESS 0
173 #define LDAP_OPT_ERROR (-1)
175 /* option on/off values */
176 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
177 #define LDAP_OPT_OFF ((void *) 0)
179 typedef struct ldapapiinfo {
180 int ldapai_info_version; /* version of LDAPAPIInfo */
181 #define LDAP_API_INFO_VERSION (1)
182 int ldapai_api_version; /* revision of API supported */
183 int ldapai_protocol_version; /* highest LDAP version supported */
184 char **ldapai_extensions; /* names of API extensions */
185 char *ldapai_vendor_name; /* name of supplier */
186 int ldapai_vendor_version; /* supplier-specific version * 100 */
189 typedef struct ldap_apifeature_info {
190 int ldapaif_info_version; /* version of LDAPAPIFeatureInfo */
191 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
192 char* ldapaif_name; /* LDAP_API_FEATURE_* (less prefix) */
193 int ldapaif_version; /* value of LDAP_API_FEATURE_... */
194 } LDAPAPIFeatureInfo;
197 * LDAP Control structure
199 typedef struct ldapcontrol {
200 char * ldctl_oid; /* numericoid of control */
201 struct berval ldctl_value; /* encoded value of control */
202 char ldctl_iscritical; /* criticality */
206 /* standard track controls */
207 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
208 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
209 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
210 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.334810.2.3" /* RFC 3876 */
211 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12"
212 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1"
213 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2"
215 /* standard track - not implemented in slapd(8) */
216 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
217 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
219 /* but not yet formalized controls */
220 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18"
222 /* various works in progress */
223 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
224 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
225 #define LDAP_CONTROL_MANAGEDIT "1.3.6.1.4.1.4203.666.5.12"
226 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
227 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
229 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
230 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
231 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
232 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
233 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
235 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
236 /* draft-ietf-ldapext-psearch-03.txt (expired) */
237 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
238 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
239 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_ADD 0x1
240 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_DELETE 0x2
241 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_MODIFY 0x4
242 #define LDAP_CONTROL_PERSSIT_ENTRY_CHANGE_RENAME 0x8
244 /* LDAP VLV *//* not implemented in slapd(8) */
245 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
246 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
248 /* Password policy Controls *//* work in progress */
249 /* ITS#3458: released; disabled by default */
250 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
251 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
253 /* LDAP Sync -- draft-zeilenga-ldup-sync *//* submitted for publication */
254 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
255 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
256 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
257 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
258 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
260 #define LDAP_SYNC_NONE 0x00
261 #define LDAP_SYNC_REFRESH_ONLY 0x01
262 #define LDAP_SYNC_RESERVED 0x02
263 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
265 #define LDAP_SYNC_REFRESH_PRESENTS 0
266 #define LDAP_SYNC_REFRESH_DELETES 1
268 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
269 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
270 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
271 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
273 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
274 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
275 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
276 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
278 #define LDAP_SYNC_PRESENT 0
279 #define LDAP_SYNC_ADD 1
280 #define LDAP_SYNC_MODIFY 2
281 #define LDAP_SYNC_DELETE 3
283 /* LDAP Chaining Behavior Control *//* work in progress */
284 /* <draft-sermersheim-ldap-chaining>;
285 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
287 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
289 #define LDAP_CHAINING_PREFERRED 0
290 #define LDAP_CHAINING_REQUIRED 1
291 #define LDAP_REFERRALS_PREFERRED 2
292 #define LDAP_REFERRALS_REQUIRED 3
295 /* MS ActiveDirectory controls (for compatibility) */
296 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
297 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
298 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
299 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
300 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
301 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
302 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all NCs subordinate to base */
303 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
305 /* LDAP Unsolicited Notifications */
306 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 2251 */
307 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
309 /* LDAP Extended Operations */
310 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 2830 */
312 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
313 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
314 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
315 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
316 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
318 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
319 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
321 /* various works in progress */
323 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3"
324 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
326 #define LDAP_EXOP_X_TURN "1.3.6.1.4.1.4203.666.6.4"
328 /* LDAP Grouping of Related Operations *//* a work in progress */
330 #define LDAP_X_GROUPING_BASE "1.3.6.1.4.1.4203.666.10.3"
331 #define LDAP_EXOP_GROUPING_CREATE LDAP_X_GROUPING_BASE ".1"
332 #define LDAP_EXOP_GROUPING_END LDAP_X_GROUPING_BASE ".2"
333 #define LDAP_NOTICE_GROUPING_END LDAP_X_GROUPING_BASE ".3"
334 #define LDAP_EXOP_GROUPING_ACTION LDAP_X_GROUPING_BASE ".4"
335 #define LDAP_NOTICE_GROUPING_INFO LDAP_X_GROUPING_BASE ".5"
336 #define LDAP_CONTROL_GROUPING LDAP_X_GROUPING_BASE ".6"
339 /* LDAP Grouping Types *//* a work in progress */
341 #define LDAP_GROUP_TRANSACTION "1.3.6.1.4.1.4203.666.10.4"
345 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
346 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
347 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
348 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
349 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
350 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
351 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
354 /* LDAP Experimental (works in progress) Features */
355 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
356 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
357 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
361 * specific LDAP instantiations of BER types we know about
364 /* Overview of LBER tag construction
371 * 1 0 = CONTEXT-SPECIFIC
378 * | 5 ... 1 | TAG-NUMBER
382 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
383 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
385 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
386 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
388 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
389 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
391 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
393 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
394 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
395 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
396 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
398 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
399 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
401 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
403 /* LDAP Request Messages */
404 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
405 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
406 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
407 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
408 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
409 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
410 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
411 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
412 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
413 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
414 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
415 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
417 /* LDAP Response Messages */
418 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
419 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
420 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
421 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
422 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
423 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
424 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
425 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
426 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
427 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
428 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
429 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
430 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
432 #define LDAP_RES_ANY (-1)
433 #define LDAP_RES_UNSOLICITED (0)
437 #define LDAP_SASL_SIMPLE ((char*)0)
438 #define LDAP_SASL_NULL ("")
441 /* authentication methods available */
442 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
443 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
444 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
445 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
446 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
447 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
451 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
452 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
453 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
454 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
455 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
456 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
457 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
458 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
459 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
460 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
462 /* extended filter component types */
463 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
464 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
465 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
466 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
468 /* substring filter component types */
469 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
470 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
471 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
474 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
475 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
476 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
477 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
478 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
479 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
480 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
481 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
482 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
484 /* substring filter component types */
485 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
486 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
487 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
492 #define LDAP_SUCCESS 0x00
494 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
496 #define LDAP_OPERATIONS_ERROR 0x01
497 #define LDAP_PROTOCOL_ERROR 0x02
498 #define LDAP_TIMELIMIT_EXCEEDED 0x03
499 #define LDAP_SIZELIMIT_EXCEEDED 0x04
500 #define LDAP_COMPARE_FALSE 0x05
501 #define LDAP_COMPARE_TRUE 0x06
502 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
503 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
504 #define LDAP_STRONG_AUTH_REQUIRED 0x08
505 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
506 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
508 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
509 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
510 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
511 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
512 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
514 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
516 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
517 #define LDAP_UNDEFINED_TYPE 0x11
518 #define LDAP_INAPPROPRIATE_MATCHING 0x12
519 #define LDAP_CONSTRAINT_VIOLATION 0x13
520 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
521 #define LDAP_INVALID_SYNTAX 0x15
523 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
525 #define LDAP_NO_SUCH_OBJECT 0x20
526 #define LDAP_ALIAS_PROBLEM 0x21
527 #define LDAP_INVALID_DN_SYNTAX 0x22
528 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
529 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
531 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
533 #define LDAP_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
534 #define LDAP_INAPPROPRIATE_AUTH 0x30
535 #define LDAP_INVALID_CREDENTIALS 0x31
536 #define LDAP_INSUFFICIENT_ACCESS 0x32
538 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
540 #define LDAP_BUSY 0x33
541 #define LDAP_UNAVAILABLE 0x34
542 #define LDAP_UNWILLING_TO_PERFORM 0x35
543 #define LDAP_LOOP_DETECT 0x36
545 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
547 #define LDAP_NAMING_VIOLATION 0x40
548 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
549 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
550 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
551 #define LDAP_ALREADY_EXISTS 0x44
552 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
553 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
554 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47 /* LDAPv3 */
556 #define LDAP_OTHER 0x50
558 /* LCUP operation codes (113-117) - not implemented */
559 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
560 #define LDAP_CUP_SECURITY_VIOLATION 0x72
561 #define LDAP_CUP_INVALID_DATA 0x73
562 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
563 #define LDAP_CUP_RELOAD_REQUIRED 0x75
565 /* Cancel operation codes (118-121) */
566 #define LDAP_CANCELLED 0x76
567 #define LDAP_NO_SUCH_OPERATION 0x77
568 #define LDAP_TOO_LATE 0x78
569 #define LDAP_CANNOT_CANCEL 0x79
572 /* Experimental result codes */
573 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF) /* experimental */
574 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF) /* private use */
576 /* for the LDAP Sync operation */
577 #define LDAP_SYNC_REFRESH_REQUIRED 0x4100
579 /* for the LDAP No-Op control */
580 #define LDAP_NO_OPERATION 0x410e
582 /* for the Assertion control */
583 #define LDAP_ASSERTION_FAILED 0x410f
585 /* for the Chaining Behavior control (consecutive result codes requested;
586 * see <draft-sermersheim-ldap-chaining> ) */
587 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
588 #define LDAP_NO_REFERRALS_FOUND 0x4110
589 #define LDAP_CANNOT_CHAIN 0x4111
594 * Based on draft-ietf-ldap-c-api-xx
595 * but with new negative code values
597 #define LDAP_API_ERROR(n) ((n)<0)
598 #define LDAP_API_RESULT(n) ((n)<=0)
600 #define LDAP_SERVER_DOWN (-1)
601 #define LDAP_LOCAL_ERROR (-2)
602 #define LDAP_ENCODING_ERROR (-3)
603 #define LDAP_DECODING_ERROR (-4)
604 #define LDAP_TIMEOUT (-5)
605 #define LDAP_AUTH_UNKNOWN (-6)
606 #define LDAP_FILTER_ERROR (-7)
607 #define LDAP_USER_CANCELLED (-8)
608 #define LDAP_PARAM_ERROR (-9)
609 #define LDAP_NO_MEMORY (-10)
610 #define LDAP_CONNECT_ERROR (-11)
611 #define LDAP_NOT_SUPPORTED (-12)
612 #define LDAP_CONTROL_NOT_FOUND (-13)
613 #define LDAP_NO_RESULTS_RETURNED (-14)
614 #define LDAP_MORE_RESULTS_TO_RETURN (-15)
615 #define LDAP_CLIENT_LOOP (-16)
616 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
620 * This structure represents both ldap messages and ldap responses.
621 * These are really the same, except in the case of search responses,
622 * where a response has multiple messages.
625 typedef struct ldapmsg LDAPMessage;
627 /* for modifications */
628 typedef struct ldapmod {
631 #define LDAP_MOD_OP (0x0007)
632 #define LDAP_MOD_ADD (0x0000)
633 #define LDAP_MOD_DELETE (0x0001)
634 #define LDAP_MOD_REPLACE (0x0002)
635 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
636 #define LDAP_MOD_BVALUES (0x0080)
637 /* IMPORTANT: do not use code 0x1000 (or above),
638 * it is used internally by the backends!
639 * (see ldap/servers/slapd/slap.h)
645 struct berval **modv_bvals;
647 #define mod_values mod_vals.modv_strvals
648 #define mod_bvalues mod_vals.modv_bvals
652 * structure representing an ldap session which can
653 * encompass connections to multiple servers (in the
654 * face of referrals).
656 typedef struct ldap LDAP;
658 #define LDAP_DEREF_NEVER 0x00
659 #define LDAP_DEREF_SEARCHING 0x01
660 #define LDAP_DEREF_FINDING 0x02
661 #define LDAP_DEREF_ALWAYS 0x03
663 #define LDAP_NO_LIMIT 0
665 /* how many messages to retrieve results for */
666 #define LDAP_MSG_ONE 0x00
667 #define LDAP_MSG_ALL 0x01
668 #define LDAP_MSG_RECEIVED 0x02
671 * types for ldap URL handling
673 typedef struct ldap_url_desc {
674 struct ldap_url_desc *lud_next;
686 #define LDAP_URL_SUCCESS 0x00 /* Success */
687 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
688 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
690 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
691 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
692 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
693 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
694 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
695 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
696 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
697 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
700 * The API draft spec says we should declare (or cause to be declared)
701 * 'struct timeval'. We don't. See IETF LDAPext discussions.
709 ldap_get_option LDAP_P((
715 ldap_set_option LDAP_P((
718 LDAP_CONST void *invalue));
720 /* V3 REBIND Function Callback Prototype */
721 typedef int (LDAP_REBIND_PROC) LDAP_P((
722 LDAP *ld, LDAP_CONST char *url,
723 ber_tag_t request, ber_int_t msgid,
727 ldap_set_rebind_proc LDAP_P((
729 LDAP_REBIND_PROC *rebind_proc,
732 /* V3 referral selection Function Callback Prototype */
733 typedef int (LDAP_NEXTREF_PROC) LDAP_P((
734 LDAP *ld, char ***refsp, int *cntp,
738 ldap_set_nextref_proc LDAP_P((
740 LDAP_NEXTREF_PROC *nextref_proc,
747 ldap_create_control LDAP_P((
748 LDAP_CONST char *requestOID,
751 LDAPControl **ctrlp ));
753 LDAP_F( LDAPControl * )
754 ldap_find_control LDAP_P((
755 LDAP_CONST char *oid,
756 LDAPControl **ctrls ));
759 ldap_control_free LDAP_P((
760 LDAPControl *ctrl ));
763 ldap_controls_free LDAP_P((
764 LDAPControl **ctrls ));
770 ldap_domain2dn LDAP_P((
771 LDAP_CONST char* domain,
775 ldap_dn2domain LDAP_P((
780 ldap_domain2hostlist LDAP_P((
781 LDAP_CONST char *domain,
788 ldap_extended_operation LDAP_P((
790 LDAP_CONST char *reqoid,
791 struct berval *reqdata,
792 LDAPControl **serverctrls,
793 LDAPControl **clientctrls,
797 ldap_extended_operation_s LDAP_P((
799 LDAP_CONST char *reqoid,
800 struct berval *reqdata,
801 LDAPControl **serverctrls,
802 LDAPControl **clientctrls,
804 struct berval **retdatap ));
807 ldap_parse_extended_result LDAP_P((
811 struct berval **retdatap,
815 ldap_parse_intermediate LDAP_P((
819 struct berval **retdatap,
820 LDAPControl ***serverctrls,
826 #ifdef LDAP_EXOP_GROUPING_CREATE
829 ldap_grouping_create LDAP_P((
831 LDAP_CONST char *grpoid,
832 struct berval *grpdata,
833 LDAPControl **serverctrls,
834 LDAPControl **clientctrls,
838 ldap_grouping_create_s LDAP_P((
840 LDAP_CONST char *grpoid,
841 struct berval *grpdata,
842 LDAPControl **serverctrls,
843 LDAPControl **clientctrls,
844 struct berval **retgrpcookiep,
845 struct berval **retgrpdatap ));
848 ldap_parse_grouping_create_result LDAP_P((
851 struct berval **retgrpcookiep,
852 struct berval **retgrpdatap,
853 LDAPControl ***serverctrls,
857 ldap_grouping_end LDAP_P((
859 LDAP_CONST char *grpoid,
860 struct berval *grpdata,
861 LDAPControl **serverctrls,
862 LDAPControl **clientctrls,
866 ldap_grouping_end_s LDAP_P((
868 LDAP_CONST char *grpoid,
869 struct berval *grpdata,
870 LDAPControl **serverctrls,
871 LDAPControl **clientctrls,
872 struct berval **retgrpdatap ));
875 ldap_parse_grouping_end_result LDAP_P((
878 struct berval **retgrpdatap,
879 LDAPControl ***serverctrls,
883 ldap_grouping_action_operation LDAP_P((
885 LDAP_CONST char *grpoid,
886 struct berval *grpdata,
887 LDAPControl **serverctrls,
888 LDAPControl **clientctrls,
892 ldap_grouping_action_operation_s LDAP_P((
894 LDAP_CONST char *grpoid,
895 struct berval *grpdata,
896 LDAPControl **serverctrls,
897 LDAPControl **clientctrls,
898 struct berval **retgrpcookiep,
899 struct berval **retgrpdatap ));
902 ldap_parse_grouping_action_result LDAP_P((
905 struct berval **retgrpcookiep,
906 struct berval **retgrpdatap,
907 LDAPControl ***serverctrls,
911 ldap_parse_grouping_end_notice LDAP_P((
914 struct berval **retdatap,
915 struct berval **retgrpcookiep,
916 struct berval **retgrpdatap,
920 ldap_parse_grouping_info_notice LDAP_P((
923 struct berval **retdatap,
924 struct berval **retgrpcookiep,
925 struct berval **retgrpdatap,
933 ldap_abandon_ext LDAP_P((
936 LDAPControl **serverctrls,
937 LDAPControl **clientctrls ));
941 ldap_abandon LDAP_P(( /* deprecated */
951 ldap_add_ext LDAP_P((
955 LDAPControl **serverctrls,
956 LDAPControl **clientctrls,
960 ldap_add_ext_s LDAP_P((
964 LDAPControl **serverctrls,
965 LDAPControl **clientctrls ));
969 ldap_add LDAP_P(( /* deprecated */
975 ldap_add_s LDAP_P(( /* deprecated */
986 ldap_sasl_bind LDAP_P((
989 LDAP_CONST char *mechanism,
991 LDAPControl **serverctrls,
992 LDAPControl **clientctrls,
995 /* Interaction flags (should be passed about in a control)
996 * Automatic (default): use defaults, prompt otherwise
997 * Interactive: prompt always
998 * Quiet: never prompt
1000 #define LDAP_SASL_AUTOMATIC 0U
1001 #define LDAP_SASL_INTERACTIVE 1U
1002 #define LDAP_SASL_QUIET 2U
1005 * V3 SASL Interaction Function Callback Prototype
1006 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1007 * should likely passed in a control (and provided controls)
1009 typedef int (LDAP_SASL_INTERACT_PROC) LDAP_P((
1010 LDAP *ld, unsigned flags, void* defaults, void *interact ));
1013 ldap_sasl_interactive_bind_s LDAP_P((
1015 LDAP_CONST char *dn, /* usually NULL */
1016 LDAP_CONST char *saslMechanism,
1017 LDAPControl **serverControls,
1018 LDAPControl **clientControls,
1020 /* should be client controls */
1022 LDAP_SASL_INTERACT_PROC *proc,
1026 ldap_sasl_bind_s LDAP_P((
1028 LDAP_CONST char *dn,
1029 LDAP_CONST char *mechanism,
1030 struct berval *cred,
1031 LDAPControl **serverctrls,
1032 LDAPControl **clientctrls,
1033 struct berval **servercredp ));
1036 ldap_parse_sasl_bind_result LDAP_P((
1039 struct berval **servercredp,
1048 ldap_bind LDAP_P(( /* deprecated */
1050 LDAP_CONST char *who,
1051 LDAP_CONST char *passwd,
1055 ldap_bind_s LDAP_P(( /* deprecated */
1057 LDAP_CONST char *who,
1058 LDAP_CONST char *cred,
1065 ldap_simple_bind LDAP_P(( /* deprecated */
1067 LDAP_CONST char *who,
1068 LDAP_CONST char *passwd ));
1071 ldap_simple_bind_s LDAP_P(( /* deprecated */
1073 LDAP_CONST char *who,
1074 LDAP_CONST char *passwd ));
1082 ldap_kerberos_bind_s LDAP_P(( /* deprecated */
1084 LDAP_CONST char *who ));
1087 ldap_kerberos_bind1 LDAP_P(( /* deprecated */
1089 LDAP_CONST char *who ));
1092 ldap_kerberos_bind1_s LDAP_P(( /* deprecated */
1094 LDAP_CONST char *who ));
1097 ldap_kerberos_bind2 LDAP_P(( /* deprecated */
1099 LDAP_CONST char *who ));
1102 ldap_kerberos_bind2_s LDAP_P(( /* deprecated */
1104 LDAP_CONST char *who ));
1112 ldap_compare_ext LDAP_P((
1114 LDAP_CONST char *dn,
1115 LDAP_CONST char *attr,
1116 struct berval *bvalue,
1117 LDAPControl **serverctrls,
1118 LDAPControl **clientctrls,
1122 ldap_compare_ext_s LDAP_P((
1124 LDAP_CONST char *dn,
1125 LDAP_CONST char *attr,
1126 struct berval *bvalue,
1127 LDAPControl **serverctrls,
1128 LDAPControl **clientctrls ));
1132 ldap_compare LDAP_P(( /* deprecated */
1134 LDAP_CONST char *dn,
1135 LDAP_CONST char *attr,
1136 LDAP_CONST char *value ));
1139 ldap_compare_s LDAP_P(( /* deprecated */
1141 LDAP_CONST char *dn,
1142 LDAP_CONST char *attr,
1143 LDAP_CONST char *value ));
1151 ldap_delete_ext LDAP_P((
1153 LDAP_CONST char *dn,
1154 LDAPControl **serverctrls,
1155 LDAPControl **clientctrls,
1159 ldap_delete_ext_s LDAP_P((
1161 LDAP_CONST char *dn,
1162 LDAPControl **serverctrls,
1163 LDAPControl **clientctrls ));
1167 ldap_delete LDAP_P(( /* deprecated */
1169 LDAP_CONST char *dn ));
1172 ldap_delete_s LDAP_P(( /* deprecated */
1174 LDAP_CONST char *dn ));
1182 ldap_parse_result LDAP_P((
1189 LDAPControl ***serverctrls,
1193 ldap_err2string LDAP_P((
1198 ldap_result2error LDAP_P(( /* deprecated */
1204 ldap_perror LDAP_P(( /* deprecated */
1206 LDAP_CONST char *s ));
1214 ldap_modify_ext LDAP_P((
1216 LDAP_CONST char *dn,
1218 LDAPControl **serverctrls,
1219 LDAPControl **clientctrls,
1223 ldap_modify_ext_s LDAP_P((
1225 LDAP_CONST char *dn,
1227 LDAPControl **serverctrls,
1228 LDAPControl **clientctrls ));
1232 ldap_modify LDAP_P(( /* deprecated */
1234 LDAP_CONST char *dn,
1238 ldap_modify_s LDAP_P(( /* deprecated */
1240 LDAP_CONST char *dn,
1249 ldap_rename LDAP_P((
1251 LDAP_CONST char *dn,
1252 LDAP_CONST char *newrdn,
1253 LDAP_CONST char *newSuperior,
1255 LDAPControl **sctrls,
1256 LDAPControl **cctrls,
1260 ldap_rename_s LDAP_P((
1262 LDAP_CONST char *dn,
1263 LDAP_CONST char *newrdn,
1264 LDAP_CONST char *newSuperior,
1266 LDAPControl **sctrls,
1267 LDAPControl **cctrls ));
1271 ldap_rename2 LDAP_P(( /* deprecated */
1273 LDAP_CONST char *dn,
1274 LDAP_CONST char *newrdn,
1275 LDAP_CONST char *newSuperior,
1276 int deleteoldrdn ));
1279 ldap_rename2_s LDAP_P(( /* deprecated */
1281 LDAP_CONST char *dn,
1282 LDAP_CONST char *newrdn,
1283 LDAP_CONST char *newSuperior,
1284 int deleteoldrdn ));
1287 ldap_modrdn LDAP_P(( /* deprecated */
1289 LDAP_CONST char *dn,
1290 LDAP_CONST char *newrdn ));
1293 ldap_modrdn_s LDAP_P(( /* deprecated */
1295 LDAP_CONST char *dn,
1296 LDAP_CONST char *newrdn ));
1299 ldap_modrdn2 LDAP_P(( /* deprecated */
1301 LDAP_CONST char *dn,
1302 LDAP_CONST char *newrdn,
1303 int deleteoldrdn ));
1306 ldap_modrdn2_s LDAP_P(( /* deprecated */
1308 LDAP_CONST char *dn,
1309 LDAP_CONST char *newrdn,
1319 ldap_init LDAP_P(( /* deprecated */
1320 LDAP_CONST char *host,
1324 ldap_open LDAP_P(( /* deprecated */
1325 LDAP_CONST char *host,
1330 ldap_create LDAP_P((
1334 ldap_initialize LDAP_P((
1336 LDAP_CONST char *url ));
1343 ldap_tls_inplace LDAP_P((
1347 ldap_start_tls LDAP_P((
1349 LDAPControl **serverctrls,
1350 LDAPControl **clientctrls,
1354 ldap_install_tls LDAP_P((
1358 ldap_start_tls_s LDAP_P((
1360 LDAPControl **serverctrls,
1361 LDAPControl **clientctrls ));
1366 LDAP_F( LDAPMessage * )
1367 ldap_first_message LDAP_P((
1369 LDAPMessage *chain ));
1371 LDAP_F( LDAPMessage * )
1372 ldap_next_message LDAP_P((
1374 LDAPMessage *msg ));
1377 ldap_count_messages LDAP_P((
1379 LDAPMessage *chain ));
1384 LDAP_F( LDAPMessage * )
1385 ldap_first_reference LDAP_P((
1387 LDAPMessage *chain ));
1389 LDAP_F( LDAPMessage * )
1390 ldap_next_reference LDAP_P((
1392 LDAPMessage *ref ));
1395 ldap_count_references LDAP_P((
1397 LDAPMessage *chain ));
1400 ldap_parse_reference LDAP_P((
1404 LDAPControl ***serverctrls,
1411 LDAP_F( LDAPMessage * )
1412 ldap_first_entry LDAP_P((
1414 LDAPMessage *chain ));
1416 LDAP_F( LDAPMessage * )
1417 ldap_next_entry LDAP_P((
1419 LDAPMessage *entry ));
1422 ldap_count_entries LDAP_P((
1424 LDAPMessage *chain ));
1427 ldap_get_entry_controls LDAP_P((
1430 LDAPControl ***serverctrls));
1436 LDAP_F( LDAPMessage * )
1437 ldap_delete_result_entry LDAP_P((
1442 ldap_add_result_entry LDAP_P((
1451 ldap_get_dn LDAP_P((
1453 LDAPMessage *entry ));
1455 typedef struct ldap_ava {
1456 struct berval la_attr;
1457 struct berval la_value;
1459 #define LDAP_AVA_NULL 0x0000U
1460 #define LDAP_AVA_STRING 0x0001U
1461 #define LDAP_AVA_BINARY 0x0002U
1462 #define LDAP_AVA_NONPRINTABLE 0x0004U
1463 #define LDAP_AVA_FREE_ATTR 0x0010U
1464 #define LDAP_AVA_FREE_VALUE 0x0020U
1469 typedef LDAPAVA** LDAPRDN;
1470 typedef LDAPRDN* LDAPDN;
1473 #define LDAP_DN_FORMAT_LDAP 0x0000U
1474 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1475 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1476 #define LDAP_DN_FORMAT_DCE 0x0030U
1477 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1478 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1479 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1480 #define LDAP_DN_FORMAT_MASK 0x00F0U
1483 #define LDAP_DN_PRETTY 0x0100U
1484 #define LDAP_DN_SKIP 0x0200U
1485 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1486 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1487 #define LDAP_DN_PEDANTIC 0xF000U
1489 LDAP_F( void ) ldap_rdnfree LDAP_P(( LDAPRDN rdn ));
1490 LDAP_F( void ) ldap_dnfree LDAP_P(( LDAPDN dn ));
1499 ldap_str2dn LDAP_P((
1500 LDAP_CONST char *str,
1511 ldap_dn2str LDAP_P((
1517 ldap_bv2rdn LDAP_P((
1524 ldap_str2rdn LDAP_P((
1525 LDAP_CONST char *str,
1531 ldap_rdn2bv LDAP_P((
1537 ldap_rdn2str LDAP_P((
1543 ldap_dn_normalize LDAP_P((
1544 LDAP_CONST char *in, unsigned iflags,
1545 char **out, unsigned oflags ));
1548 ldap_dn2ufn LDAP_P(( /* deprecated */
1549 LDAP_CONST char *dn ));
1552 ldap_explode_dn LDAP_P(( /* deprecated */
1553 LDAP_CONST char *dn,
1557 ldap_explode_rdn LDAP_P(( /* deprecated */
1558 LDAP_CONST char *rdn,
1561 typedef int LDAPDN_rewrite_func
1562 LDAP_P(( LDAPDN dn, unsigned flags, void *ctx ));
1565 ldap_X509dn2bv LDAP_P(( void *x509_name, struct berval *dn,
1566 LDAPDN_rewrite_func *func, unsigned flags ));
1569 ldap_dn2dcedn LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1572 ldap_dcedn2dn LDAP_P(( LDAP_CONST char *dce )); /* deprecated */
1575 ldap_dn2ad_canonical LDAP_P(( LDAP_CONST char *dn )); /* deprecated */
1578 ldap_get_dn_ber LDAP_P((
1579 LDAP *ld, LDAPMessage *e, BerElement **berout, struct berval *dn ));
1582 ldap_get_attribute_ber LDAP_P((
1583 LDAP *ld, LDAPMessage *e, BerElement *ber, struct berval *attr,
1584 struct berval **vals ));
1590 ldap_first_attribute LDAP_P((
1593 BerElement **ber ));
1596 ldap_next_attribute LDAP_P((
1605 LDAP_F( struct berval ** )
1606 ldap_get_values_len LDAP_P((
1609 LDAP_CONST char *target ));
1612 ldap_count_values_len LDAP_P((
1613 struct berval **vals ));
1616 ldap_value_free_len LDAP_P((
1617 struct berval **vals ));
1621 ldap_get_values LDAP_P(( /* deprecated */
1624 LDAP_CONST char *target ));
1627 ldap_count_values LDAP_P(( /* deprecated */
1631 ldap_value_free LDAP_P(( /* deprecated */
1639 ldap_result LDAP_P((
1643 struct timeval *timeout,
1644 LDAPMessage **result ));
1647 ldap_msgtype LDAP_P((
1655 ldap_msgfree LDAP_P((
1659 ldap_msgdelete LDAP_P((
1668 ldap_search_ext LDAP_P((
1670 LDAP_CONST char *base,
1672 LDAP_CONST char *filter,
1675 LDAPControl **serverctrls,
1676 LDAPControl **clientctrls,
1677 struct timeval *timeout,
1682 ldap_search_ext_s LDAP_P((
1684 LDAP_CONST char *base,
1686 LDAP_CONST char *filter,
1689 LDAPControl **serverctrls,
1690 LDAPControl **clientctrls,
1691 struct timeval *timeout,
1693 LDAPMessage **res ));
1697 ldap_search LDAP_P(( /* deprecated */
1699 LDAP_CONST char *base,
1701 LDAP_CONST char *filter,
1706 ldap_search_s LDAP_P(( /* deprecated */
1708 LDAP_CONST char *base,
1710 LDAP_CONST char *filter,
1713 LDAPMessage **res ));
1716 ldap_search_st LDAP_P(( /* deprecated */
1718 LDAP_CONST char *base,
1720 LDAP_CONST char *filter,
1723 struct timeval *timeout,
1724 LDAPMessage **res ));
1731 ldap_unbind_ext LDAP_P((
1733 LDAPControl **serverctrls,
1734 LDAPControl **clientctrls));
1737 ldap_unbind_ext_s LDAP_P((
1739 LDAPControl **serverctrls,
1740 LDAPControl **clientctrls));
1744 ldap_unbind LDAP_P(( /* deprecated */
1748 ldap_unbind_s LDAP_P(( /* deprecated */
1756 ldap_put_vrFilter LDAP_P((
1765 ldap_memalloc LDAP_P((
1769 ldap_memrealloc LDAP_P((
1774 ldap_memcalloc LDAP_P((
1779 ldap_memfree LDAP_P((
1783 ldap_memvfree LDAP_P((
1787 ldap_strdup LDAP_P((
1788 LDAP_CONST char * ));
1791 ldap_mods_free LDAP_P((
1798 * in sort.c (deprecated)
1800 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
1801 LDAP_CONST char *left,
1802 LDAP_CONST char *right ));
1804 typedef int (LDAP_SORT_AV_CMP_PROC) LDAP_P(( /* deprecated */
1805 LDAP_CONST void *left,
1806 LDAP_CONST void *right ));
1808 LDAP_F( int ) /* deprecated */
1809 ldap_sort_entries LDAP_P(( LDAP *ld,
1810 LDAPMessage **chain,
1811 LDAP_CONST char *attr,
1812 LDAP_SORT_AD_CMP_PROC *cmp ));
1814 LDAP_F( int ) /* deprecated */
1815 ldap_sort_values LDAP_P((
1818 LDAP_SORT_AV_CMP_PROC *cmp ));
1820 LDAP_F( int ) /* deprecated */
1821 ldap_sort_strcasecmp LDAP_P((
1823 LDAP_CONST void *b ));
1830 ldap_is_ldap_url LDAP_P((
1831 LDAP_CONST char *url ));
1834 ldap_is_ldaps_url LDAP_P((
1835 LDAP_CONST char *url ));
1838 ldap_is_ldapi_url LDAP_P((
1839 LDAP_CONST char *url ));
1842 ldap_url_parse LDAP_P((
1843 LDAP_CONST char *url,
1844 LDAPURLDesc **ludpp ));
1847 ldap_url_desc2str LDAP_P((
1848 LDAPURLDesc *ludp ));
1851 ldap_free_urldesc LDAP_P((
1852 LDAPURLDesc *ludp ));
1856 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1859 #define LDAP_API_FEATURE_CANCEL 1000
1862 ldap_cancel LDAP_P(( LDAP *ld,
1864 LDAPControl **sctrls,
1865 LDAPControl **cctrls,
1869 ldap_cancel_s LDAP_P(( LDAP *ld,
1871 LDAPControl **sctrl,
1872 LDAPControl **cctrl ));
1875 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1878 #define LDAP_API_FEATURE_TURN 1000
1881 ldap_turn LDAP_P(( LDAP *ld,
1883 LDAP_CONST char* identifier,
1884 LDAPControl **sctrls,
1885 LDAPControl **cctrls,
1889 ldap_turn_s LDAP_P(( LDAP *ld,
1891 LDAP_CONST char* identifier,
1892 LDAPControl **sctrl,
1893 LDAPControl **cctrl ));
1896 * LDAP Server Side Sort
1899 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
1901 /* structure for a sort-key */
1902 typedef struct ldapsortkey {
1903 char * attributeType;
1904 char * orderingRule;
1909 ldap_create_sort_keylist LDAP_P((
1910 LDAPSortKey ***sortKeyList,
1914 ldap_free_sort_keylist LDAP_P((
1915 LDAPSortKey **sortkeylist ));
1918 ldap_create_sort_control LDAP_P((
1920 LDAPSortKey **keyList,
1922 LDAPControl **ctrlp ));
1925 ldap_parse_sort_control LDAP_P((
1927 LDAPControl **ctrlp,
1928 unsigned long *result,
1929 char **attribute ));
1933 * LDAP Virtual List View
1936 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
1938 /* structure for virtual list */
1939 typedef struct ldapvlvinfo {
1941 unsigned long ldvlv_before_count;
1942 unsigned long ldvlv_after_count;
1943 unsigned long ldvlv_offset;
1944 unsigned long ldvlv_count;
1945 struct berval * ldvlv_attrvalue;
1946 struct berval * ldvlv_context;
1947 void * ldvlv_extradata;
1951 ldap_create_vlv_control LDAP_P((
1953 LDAPVLVInfo *ldvlistp,
1954 LDAPControl **ctrlp ));
1957 ldap_parse_vlv_control LDAP_P((
1959 LDAPControl **ctrls,
1960 unsigned long *target_posp,
1961 unsigned long *list_countp,
1962 struct berval **contextp,
1969 #ifdef LDAP_GROUP_TRANSACTION
1971 ldap_parse_txn_create LDAP_P((
1974 struct berval **cookie ));
1977 ldap_txn_create LDAP_P((
1979 LDAPControl **sctrls,
1980 LDAPControl **cctrls,
1984 ldap_txn_create_s LDAP_P((
1986 struct berval **cookie,
1987 LDAPControl **sctrls,
1988 LDAPControl **cctrls ));
1991 ldap_txn_end LDAP_P((
1993 struct berval *cookie,
1995 LDAPControl **sctrls,
1996 LDAPControl **cctrls,
2000 ldap_txn_end_s LDAP_P((
2002 struct berval *cookie,
2004 LDAPControl **sctrls,
2005 LDAPControl **cctrls ));
2012 #define LDAP_API_FEATURE_WHOAMI 1000
2015 ldap_parse_whoami LDAP_P((
2018 struct berval **authzid ));
2021 ldap_whoami LDAP_P(( LDAP *ld,
2022 LDAPControl **sctrls,
2023 LDAPControl **cctrls,
2027 ldap_whoami_s LDAP_P((
2029 struct berval **authzid,
2030 LDAPControl **sctrls,
2031 LDAPControl **cctrls ));
2034 * LDAP Password Modify
2037 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2040 ldap_parse_passwd LDAP_P((
2043 struct berval *newpasswd ));
2046 ldap_passwd LDAP_P(( LDAP *ld,
2047 struct berval *user,
2048 struct berval *oldpw,
2049 struct berval *newpw,
2050 LDAPControl **sctrls,
2051 LDAPControl **cctrls,
2055 ldap_passwd_s LDAP_P((
2057 struct berval *user,
2058 struct berval *oldpw,
2059 struct berval *newpw,
2060 struct berval *newpasswd,
2061 LDAPControl **sctrls,
2062 LDAPControl **cctrls ));
2064 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2066 * LDAP Password Policy controls
2069 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2071 typedef enum passpolicyerror_enum {
2072 PP_passwordExpired = 0,
2073 PP_accountLocked = 1,
2074 PP_changeAfterReset = 2,
2075 PP_passwordModNotAllowed = 3,
2076 PP_mustSupplyOldPassword = 4,
2077 PP_insufficientPasswordQuality = 5,
2078 PP_passwordTooShort = 6,
2079 PP_passwordTooYoung = 7,
2080 PP_passwordInHistory = 8,
2082 } LDAPPasswordPolicyError;
2085 ldap_create_passwordpolicy_control LDAP_P((
2087 LDAPControl **ctrlp ));
2090 ldap_parse_passwordpolicy_control LDAP_P((
2095 LDAPPasswordPolicyError *errorp ));
2097 LDAP_F( const char * )
2098 ldap_passwordpolicy_err2txt LDAP_P(( LDAPPasswordPolicyError ));
2099 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2102 #endif /* _LDAP_H */