1 /* $OpenLDAP: pkg/ldap/include/ldap.h,v 1.312.2.10 2008/07/09 00:29:57 quanah Exp $ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2008 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 4511: 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_DIAGNOSTIC_MESSAGE 0x0032
108 #define LDAP_OPT_ERROR_STRING LDAP_OPT_DIAGNOSTIC_MESSAGE
109 #define LDAP_OPT_MATCHED_DN 0x0033
110 /* 0x0034 - 0x3fff not defined */
113 #define LDAP_OPT_API_EXTENSION_BASE 0x4000 /* API extensions */
115 /* private and experimental options */
116 /* OpenLDAP specific options */
117 #define LDAP_OPT_DEBUG_LEVEL 0x5001 /* debug level */
118 #define LDAP_OPT_TIMEOUT 0x5002 /* default timeout */
119 #define LDAP_OPT_REFHOPLIMIT 0x5003 /* ref hop limit */
120 #define LDAP_OPT_NETWORK_TIMEOUT 0x5005 /* socket level timeout */
121 #define LDAP_OPT_URI 0x5006
122 #define LDAP_OPT_REFERRAL_URLS 0x5007 /* Referral URLs */
123 #define LDAP_OPT_SOCKBUF 0x5008 /* sockbuf */
124 #define LDAP_OPT_DEFBASE 0x5009 /* searchbase */
125 #define LDAP_OPT_CONNECT_ASYNC 0x5010 /* create connections asynchronously */
127 /* OpenLDAP TLS options */
128 #define LDAP_OPT_X_TLS 0x6000
129 #define LDAP_OPT_X_TLS_CTX 0x6001 /* OpenSSL CTX */
130 #define LDAP_OPT_X_TLS_CACERTFILE 0x6002
131 #define LDAP_OPT_X_TLS_CACERTDIR 0x6003
132 #define LDAP_OPT_X_TLS_CERTFILE 0x6004
133 #define LDAP_OPT_X_TLS_KEYFILE 0x6005
134 #define LDAP_OPT_X_TLS_REQUIRE_CERT 0x6006
135 /* #define LDAP_OPT_X_TLS_PROTOCOL 0x6007 */
136 #define LDAP_OPT_X_TLS_CIPHER_SUITE 0x6008
137 #define LDAP_OPT_X_TLS_RANDOM_FILE 0x6009
138 #define LDAP_OPT_X_TLS_SSL_CTX 0x600a
139 #define LDAP_OPT_X_TLS_CRLCHECK 0x600b
140 #define LDAP_OPT_X_TLS_CONNECT_CB 0x600c
141 #define LDAP_OPT_X_TLS_CONNECT_ARG 0x600d
142 #define LDAP_OPT_X_TLS_DHFILE 0x600e
143 #define LDAP_OPT_X_TLS_NEWCTX 0x600f
144 #define LDAP_OPT_X_TLS_CRLFILE 0x6010 /* GNUtls only */
146 #define LDAP_OPT_X_TLS_NEVER 0
147 #define LDAP_OPT_X_TLS_HARD 1
148 #define LDAP_OPT_X_TLS_DEMAND 2
149 #define LDAP_OPT_X_TLS_ALLOW 3
150 #define LDAP_OPT_X_TLS_TRY 4
152 #define LDAP_OPT_X_TLS_CRL_NONE 0
153 #define LDAP_OPT_X_TLS_CRL_PEER 1
154 #define LDAP_OPT_X_TLS_CRL_ALL 2
156 /* OpenLDAP SASL options */
157 #define LDAP_OPT_X_SASL_MECH 0x6100
158 #define LDAP_OPT_X_SASL_REALM 0x6101
159 #define LDAP_OPT_X_SASL_AUTHCID 0x6102
160 #define LDAP_OPT_X_SASL_AUTHZID 0x6103
161 #define LDAP_OPT_X_SASL_SSF 0x6104 /* read-only */
162 #define LDAP_OPT_X_SASL_SSF_EXTERNAL 0x6105 /* write-only */
163 #define LDAP_OPT_X_SASL_SECPROPS 0x6106 /* write-only */
164 #define LDAP_OPT_X_SASL_SSF_MIN 0x6107
165 #define LDAP_OPT_X_SASL_SSF_MAX 0x6108
166 #define LDAP_OPT_X_SASL_MAXBUFSIZE 0x6109
168 /* Private API Extensions -- reserved for application use */
169 #define LDAP_OPT_PRIVATE_EXTENSION_BASE 0x7000 /* Private API inclusive */
172 * ldap_get_option() and ldap_set_option() return values.
173 * As later versions may return other values indicating
174 * failure, current applications should only compare returned
175 * value against LDAP_OPT_SUCCESS.
177 #define LDAP_OPT_SUCCESS 0
178 #define LDAP_OPT_ERROR (-1)
180 /* option on/off values */
181 #define LDAP_OPT_ON ((void *) &ber_pvt_opt_on)
182 #define LDAP_OPT_OFF ((void *) 0)
184 typedef struct ldapapiinfo
{
185 int ldapai_info_version
; /* version of LDAPAPIInfo */
186 #define LDAP_API_INFO_VERSION (1)
187 int ldapai_api_version
; /* revision of API supported */
188 int ldapai_protocol_version
; /* highest LDAP version supported */
189 char **ldapai_extensions
; /* names of API extensions */
190 char *ldapai_vendor_name
; /* name of supplier */
191 int ldapai_vendor_version
; /* supplier-specific version * 100 */
194 typedef struct ldap_apifeature_info
{
195 int ldapaif_info_version
; /* version of LDAPAPIFeatureInfo */
196 #define LDAP_FEATURE_INFO_VERSION (1) /* apifeature_info struct version */
197 char* ldapaif_name
; /* LDAP_API_FEATURE_* (less prefix) */
198 int ldapaif_version
; /* value of LDAP_API_FEATURE_... */
199 } LDAPAPIFeatureInfo
;
202 * LDAP Control structure
204 typedef struct ldapcontrol
{
205 char * ldctl_oid
; /* numericoid of control */
206 struct berval ldctl_value
; /* encoded value of control */
207 char ldctl_iscritical
; /* criticality */
211 /* standard track controls */
212 #define LDAP_CONTROL_MANAGEDSAIT "2.16.840.1.113730.3.4.2" /* RFC 3296 */
213 #define LDAP_CONTROL_PROXY_AUTHZ "2.16.840.1.113730.3.4.18" /* RFC 4370 */
214 #define LDAP_CONTROL_SUBENTRIES "1.3.6.1.4.1.4203.1.10.1" /* RFC 3672 */
216 #define LDAP_CONTROL_VALUESRETURNFILTER "1.2.826.0.1.3344810.2.3"/* RFC 3876 */
218 #define LDAP_CONTROL_ASSERT "1.3.6.1.1.12" /* RFC 4528 */
219 #define LDAP_CONTROL_PRE_READ "1.3.6.1.1.13.1" /* RFC 4527 */
220 #define LDAP_CONTROL_POST_READ "1.3.6.1.1.13.2" /* RFC 4527 */
222 /* standard track - not implemented in slapd(8) */
223 #define LDAP_CONTROL_SORTREQUEST "1.2.840.113556.1.4.473" /* RFC 2891 */
224 #define LDAP_CONTROL_SORTRESPONSE "1.2.840.113556.1.4.474" /* RFC 2891 */
226 /* non-standard track controls */
227 #define LDAP_CONTROL_PAGEDRESULTS "1.2.840.113556.1.4.319" /* RFC 2696 */
229 /* LDAP Content Synchronization Operation -- RFC 4533 */
230 #define LDAP_SYNC_OID "1.3.6.1.4.1.4203.1.9.1"
231 #define LDAP_CONTROL_SYNC LDAP_SYNC_OID ".1"
232 #define LDAP_CONTROL_SYNC_STATE LDAP_SYNC_OID ".2"
233 #define LDAP_CONTROL_SYNC_DONE LDAP_SYNC_OID ".3"
234 #define LDAP_SYNC_INFO LDAP_SYNC_OID ".4"
236 #define LDAP_SYNC_NONE 0x00
237 #define LDAP_SYNC_REFRESH_ONLY 0x01
238 #define LDAP_SYNC_RESERVED 0x02
239 #define LDAP_SYNC_REFRESH_AND_PERSIST 0x03
241 #define LDAP_SYNC_REFRESH_PRESENTS 0
242 #define LDAP_SYNC_REFRESH_DELETES 1
244 #define LDAP_TAG_SYNC_NEW_COOKIE ((ber_tag_t) 0x80U)
245 #define LDAP_TAG_SYNC_REFRESH_DELETE ((ber_tag_t) 0xa1U)
246 #define LDAP_TAG_SYNC_REFRESH_PRESENT ((ber_tag_t) 0xa2U)
247 #define LDAP_TAG_SYNC_ID_SET ((ber_tag_t) 0xa3U)
249 #define LDAP_TAG_SYNC_COOKIE ((ber_tag_t) 0x04U)
250 #define LDAP_TAG_REFRESHDELETES ((ber_tag_t) 0x01U)
251 #define LDAP_TAG_REFRESHDONE ((ber_tag_t) 0x01U)
252 #define LDAP_TAG_RELOAD_HINT ((ber_tag_t) 0x01U)
254 #define LDAP_SYNC_PRESENT 0
255 #define LDAP_SYNC_ADD 1
256 #define LDAP_SYNC_MODIFY 2
257 #define LDAP_SYNC_DELETE 3
260 /* Password policy Controls *//* work in progress */
261 /* ITS#3458: released; disabled by default */
262 #define LDAP_CONTROL_PASSWORDPOLICYREQUEST "1.3.6.1.4.1.42.2.27.8.5.1"
263 #define LDAP_CONTROL_PASSWORDPOLICYRESPONSE "1.3.6.1.4.1.42.2.27.8.5.1"
265 /* various works in progress */
266 #define LDAP_CONTROL_NOOP "1.3.6.1.4.1.4203.666.5.2"
267 #define LDAP_CONTROL_NO_SUBORDINATES "1.3.6.1.4.1.4203.666.5.11"
268 #define LDAP_CONTROL_RELAX "1.3.6.1.4.1.4203.666.5.12"
269 #define LDAP_CONTROL_MANAGEDIT LDAP_CONTROL_RELAX
270 #define LDAP_CONTROL_SLURP "1.3.6.1.4.1.4203.666.5.13"
271 #define LDAP_CONTROL_VALSORT "1.3.6.1.4.1.4203.666.5.14"
272 #define LDAP_CONTROL_DONTUSECOPY "1.3.6.1.4.1.4203.666.5.15"
275 /* LDAP Chaining Behavior Control *//* work in progress */
276 /* <draft-sermersheim-ldap-chaining>;
277 * see also LDAP_NO_REFERRALS_FOUND, LDAP_CANNOT_CHAIN */
278 #define LDAP_CONTROL_X_CHAINING_BEHAVIOR "1.3.6.1.4.1.4203.666.11.3"
280 #define LDAP_CHAINING_PREFERRED 0
281 #define LDAP_CHAINING_REQUIRED 1
282 #define LDAP_REFERRALS_PREFERRED 2
283 #define LDAP_REFERRALS_REQUIRED 3
285 /* MS Active Directory controls (for compatibility) */
286 #define LDAP_CONTROL_X_INCREMENTAL_VALUES "1.2.840.113556.1.4.802"
287 #define LDAP_CONTROL_X_DOMAIN_SCOPE "1.2.840.113556.1.4.1339"
288 #define LDAP_CONTROL_X_PERMISSIVE_MODIFY "1.2.840.113556.1.4.1413"
289 #define LDAP_CONTROL_X_SEARCH_OPTIONS "1.2.840.113556.1.4.1340"
290 #define LDAP_SEARCH_FLAG_DOMAIN_SCOPE 1 /* do not generate referrals */
291 #define LDAP_SEARCH_FLAG_PHANTOM_ROOT 2 /* search all subordinate NCs */
292 #define LDAP_CONTROL_X_TREE_DELETE "1.2.840.113556.1.4.805"
294 /* MS Active Directory controls - not implemented in slapd(8) */
295 #define LDAP_CONTROL_X_EXTENDED_DN "1.2.840.113556.1.4.529"
298 /* <draft-wahl-ldap-session> */
299 #define LDAP_CONTROL_X_SESSION_TRACKING "1.3.6.1.4.1.21008.108.63.1"
300 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_SESSION_ID \
301 LDAP_CONTROL_X_SESSION_TRACKING ".1"
302 #define LDAP_CONTROL_X_SESSION_TRACKING_RADIUS_ACCT_MULTI_SESSION_ID \
303 LDAP_CONTROL_X_SESSION_TRACKING ".2"
304 #define LDAP_CONTROL_X_SESSION_TRACKING_USERNAME \
305 LDAP_CONTROL_X_SESSION_TRACKING ".3"
306 #endif /* LDAP_DEVEL */
308 /* various expired works */
309 /* LDAP Duplicated Entry Control Extension *//* not implemented in slapd(8) */
310 #define LDAP_CONTROL_DUPENT_REQUEST "2.16.840.1.113719.1.27.101.1"
311 #define LDAP_CONTROL_DUPENT_RESPONSE "2.16.840.1.113719.1.27.101.2"
312 #define LDAP_CONTROL_DUPENT_ENTRY "2.16.840.1.113719.1.27.101.3"
313 #define LDAP_CONTROL_DUPENT LDAP_CONTROL_DUPENT_REQUEST
315 /* LDAP Persistent Search Control *//* not implemented in slapd(8) */
316 #define LDAP_CONTROL_PERSIST_REQUEST "2.16.840.1.113730.3.4.3"
317 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_NOTICE "2.16.840.1.113730.3.4.7"
318 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_ADD 0x1
319 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_DELETE 0x2
320 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_MODIFY 0x4
321 #define LDAP_CONTROL_PERSIST_ENTRY_CHANGE_RENAME 0x8
323 /* LDAP VLV *//* not implemented in slapd(8) */
324 #define LDAP_CONTROL_VLVREQUEST "2.16.840.1.113730.3.4.9"
325 #define LDAP_CONTROL_VLVRESPONSE "2.16.840.1.113730.3.4.10"
328 /* LDAP Unsolicited Notifications */
329 #define LDAP_NOTICE_OF_DISCONNECTION "1.3.6.1.4.1.1466.20036" /* RFC 4511 */
330 #define LDAP_NOTICE_DISCONNECT LDAP_NOTICE_OF_DISCONNECTION
332 /* LDAP Extended Operations */
333 #define LDAP_EXOP_START_TLS "1.3.6.1.4.1.1466.20037" /* RFC 4511 */
335 #define LDAP_EXOP_MODIFY_PASSWD "1.3.6.1.4.1.4203.1.11.1" /* RFC 3062 */
336 #define LDAP_TAG_EXOP_MODIFY_PASSWD_ID ((ber_tag_t) 0x80U)
337 #define LDAP_TAG_EXOP_MODIFY_PASSWD_OLD ((ber_tag_t) 0x81U)
338 #define LDAP_TAG_EXOP_MODIFY_PASSWD_NEW ((ber_tag_t) 0x82U)
339 #define LDAP_TAG_EXOP_MODIFY_PASSWD_GEN ((ber_tag_t) 0x80U)
341 #define LDAP_EXOP_CANCEL "1.3.6.1.1.8" /* RFC 3909 */
342 #define LDAP_EXOP_X_CANCEL LDAP_EXOP_CANCEL
344 #define LDAP_EXOP_REFRESH "1.3.6.1.4.1.1466.101.119.1" /* RFC 2589 */
345 #define LDAP_TAG_EXOP_REFRESH_REQ_DN ((ber_tag_t) 0x80U)
346 #define LDAP_TAG_EXOP_REFRESH_REQ_TTL ((ber_tag_t) 0x81U)
347 #define LDAP_TAG_EXOP_REFRESH_RES_TTL ((ber_tag_t) 0x80U)
349 #define LDAP_EXOP_WHO_AM_I "1.3.6.1.4.1.4203.1.11.3" /* RFC 4532 */
350 #define LDAP_EXOP_X_WHO_AM_I LDAP_EXOP_WHO_AM_I
352 /* various works in progress */
353 #define LDAP_EXOP_TURN "1.3.6.1.1.19" /* RFC 4531 */
354 #define LDAP_EXOP_X_TURN LDAP_EXOP_TURN
356 /* LDAP Distributed Procedures <draft-sermersheim-ldap-distproc> */
357 /* a work in progress */
358 #define LDAP_X_DISTPROC_BASE "1.3.6.1.4.1.4203.666.11.6"
359 #define LDAP_EXOP_X_CHAINEDREQUEST LDAP_X_DISTPROC_BASE ".1"
360 #define LDAP_FEATURE_X_CANCHAINOPS LDAP_X_DISTPROC_BASE ".2"
361 #define LDAP_CONTROL_X_RETURNCONTREF LDAP_X_DISTPROC_BASE ".3"
362 #define LDAP_URLEXT_X_LOCALREFOID LDAP_X_DISTPROC_BASE ".4"
363 #define LDAP_URLEXT_X_REFTYPEOID LDAP_X_DISTPROC_BASE ".5"
364 #define LDAP_URLEXT_X_SEARCHEDSUBTREEOID \
365 LDAP_X_DISTPROC_BASE ".6"
366 #define LDAP_URLEXT_X_FAILEDNAMEOID LDAP_X_DISTPROC_BASE ".7"
367 #define LDAP_URLEXT_X_LOCALREF "x-localReference"
368 #define LDAP_URLEXT_X_REFTYPE "x-referenceType"
369 #define LDAP_URLEXT_X_SEARCHEDSUBTREE "x-searchedSubtree"
370 #define LDAP_URLEXT_X_FAILEDNAME "x-failedName"
373 #define LDAP_X_TXN "1.3.6.1.4.1.4203.666.11.7" /* tmp */
374 #define LDAP_EXOP_X_TXN_START LDAP_X_TXN ".1"
375 #define LDAP_CONTROL_X_TXN_SPEC LDAP_X_TXN ".2"
376 #define LDAP_EXOP_X_TXN_END LDAP_X_TXN ".3"
377 #define LDAP_EXOP_X_TXN_ABORTED_NOTICE LDAP_X_TXN ".4"
381 #define LDAP_FEATURE_ALL_OP_ATTRS "1.3.6.1.4.1.4203.1.5.1" /* RFC 3673 */
382 #define LDAP_FEATURE_OBJECTCLASS_ATTRS \
383 "1.3.6.1.4.1.4203.1.5.2" /* @objectClass - new number to be assigned */
384 #define LDAP_FEATURE_ABSOLUTE_FILTERS "1.3.6.1.4.1.4203.1.5.3" /* (&) (|) */
385 #define LDAP_FEATURE_LANGUAGE_TAG_OPTIONS "1.3.6.1.4.1.4203.1.5.4"
386 #define LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS "1.3.6.1.4.1.4203.1.5.5"
387 #define LDAP_FEATURE_MODIFY_INCREMENT "1.3.6.1.1.14"
389 /* LDAP Experimental (works in progress) Features */
390 #define LDAP_FEATURE_SUBORDINATE_SCOPE \
391 "1.3.6.1.4.1.4203.666.8.1" /* "children" */
392 #define LDAP_FEATURE_CHILDREN_SCOPE LDAP_FEATURE_SUBORDINATE_SCOPE
395 * specific LDAP instantiations of BER types we know about
398 /* Overview of LBER tag construction
405 * 1 0 = CONTEXT-SPECIFIC
412 * | 5 ... 1 | TAG-NUMBER
416 #define LDAP_TAG_MESSAGE ((ber_tag_t) 0x30U) /* constructed + 16 */
417 #define LDAP_TAG_MSGID ((ber_tag_t) 0x02U) /* integer */
419 #define LDAP_TAG_LDAPDN ((ber_tag_t) 0x04U) /* octet string */
420 #define LDAP_TAG_LDAPCRED ((ber_tag_t) 0x04U) /* octet string */
422 #define LDAP_TAG_CONTROLS ((ber_tag_t) 0xa0U) /* context specific + constructed + 0 */
423 #define LDAP_TAG_REFERRAL ((ber_tag_t) 0xa3U) /* context specific + constructed + 3 */
425 #define LDAP_TAG_NEWSUPERIOR ((ber_tag_t) 0x80U) /* context-specific + primitive + 0 */
427 #define LDAP_TAG_EXOP_REQ_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
428 #define LDAP_TAG_EXOP_REQ_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
429 #define LDAP_TAG_EXOP_RES_OID ((ber_tag_t) 0x8aU) /* context specific + primitive */
430 #define LDAP_TAG_EXOP_RES_VALUE ((ber_tag_t) 0x8bU) /* context specific + primitive */
432 #define LDAP_TAG_IM_RES_OID ((ber_tag_t) 0x80U) /* context specific + primitive */
433 #define LDAP_TAG_IM_RES_VALUE ((ber_tag_t) 0x81U) /* context specific + primitive */
435 #define LDAP_TAG_SASL_RES_CREDS ((ber_tag_t) 0x87U) /* context specific + primitive */
437 /* LDAP Request Messages */
438 #define LDAP_REQ_BIND ((ber_tag_t) 0x60U) /* application + constructed */
439 #define LDAP_REQ_UNBIND ((ber_tag_t) 0x42U) /* application + primitive */
440 #define LDAP_REQ_SEARCH ((ber_tag_t) 0x63U) /* application + constructed */
441 #define LDAP_REQ_MODIFY ((ber_tag_t) 0x66U) /* application + constructed */
442 #define LDAP_REQ_ADD ((ber_tag_t) 0x68U) /* application + constructed */
443 #define LDAP_REQ_DELETE ((ber_tag_t) 0x4aU) /* application + primitive */
444 #define LDAP_REQ_MODDN ((ber_tag_t) 0x6cU) /* application + constructed */
445 #define LDAP_REQ_MODRDN LDAP_REQ_MODDN
446 #define LDAP_REQ_RENAME LDAP_REQ_MODDN
447 #define LDAP_REQ_COMPARE ((ber_tag_t) 0x6eU) /* application + constructed */
448 #define LDAP_REQ_ABANDON ((ber_tag_t) 0x50U) /* application + primitive */
449 #define LDAP_REQ_EXTENDED ((ber_tag_t) 0x77U) /* application + constructed */
451 /* LDAP Response Messages */
452 #define LDAP_RES_BIND ((ber_tag_t) 0x61U) /* application + constructed */
453 #define LDAP_RES_SEARCH_ENTRY ((ber_tag_t) 0x64U) /* application + constructed */
454 #define LDAP_RES_SEARCH_REFERENCE ((ber_tag_t) 0x73U) /* V3: application + constructed */
455 #define LDAP_RES_SEARCH_RESULT ((ber_tag_t) 0x65U) /* application + constructed */
456 #define LDAP_RES_MODIFY ((ber_tag_t) 0x67U) /* application + constructed */
457 #define LDAP_RES_ADD ((ber_tag_t) 0x69U) /* application + constructed */
458 #define LDAP_RES_DELETE ((ber_tag_t) 0x6bU) /* application + constructed */
459 #define LDAP_RES_MODDN ((ber_tag_t) 0x6dU) /* application + constructed */
460 #define LDAP_RES_MODRDN LDAP_RES_MODDN /* application + constructed */
461 #define LDAP_RES_RENAME LDAP_RES_MODDN /* application + constructed */
462 #define LDAP_RES_COMPARE ((ber_tag_t) 0x6fU) /* application + constructed */
463 #define LDAP_RES_EXTENDED ((ber_tag_t) 0x78U) /* V3: application + constructed */
464 #define LDAP_RES_INTERMEDIATE ((ber_tag_t) 0x79U) /* V3+: application + constructed */
466 #define LDAP_RES_ANY (-1)
467 #define LDAP_RES_UNSOLICITED (0)
471 #define LDAP_SASL_SIMPLE ((char*)0)
472 #define LDAP_SASL_NULL ("")
475 /* authentication methods available */
476 #define LDAP_AUTH_NONE ((ber_tag_t) 0x00U) /* no authentication */
477 #define LDAP_AUTH_SIMPLE ((ber_tag_t) 0x80U) /* context specific + primitive */
478 #define LDAP_AUTH_SASL ((ber_tag_t) 0xa3U) /* context specific + constructed */
479 #define LDAP_AUTH_KRBV4 ((ber_tag_t) 0xffU) /* means do both of the following */
480 #define LDAP_AUTH_KRBV41 ((ber_tag_t) 0x81U) /* context specific + primitive */
481 #define LDAP_AUTH_KRBV42 ((ber_tag_t) 0x82U) /* context specific + primitive */
485 #define LDAP_FILTER_AND ((ber_tag_t) 0xa0U) /* context specific + constructed */
486 #define LDAP_FILTER_OR ((ber_tag_t) 0xa1U) /* context specific + constructed */
487 #define LDAP_FILTER_NOT ((ber_tag_t) 0xa2U) /* context specific + constructed */
488 #define LDAP_FILTER_EQUALITY ((ber_tag_t) 0xa3U) /* context specific + constructed */
489 #define LDAP_FILTER_SUBSTRINGS ((ber_tag_t) 0xa4U) /* context specific + constructed */
490 #define LDAP_FILTER_GE ((ber_tag_t) 0xa5U) /* context specific + constructed */
491 #define LDAP_FILTER_LE ((ber_tag_t) 0xa6U) /* context specific + constructed */
492 #define LDAP_FILTER_PRESENT ((ber_tag_t) 0x87U) /* context specific + primitive */
493 #define LDAP_FILTER_APPROX ((ber_tag_t) 0xa8U) /* context specific + constructed */
494 #define LDAP_FILTER_EXT ((ber_tag_t) 0xa9U) /* context specific + constructed */
496 /* extended filter component types */
497 #define LDAP_FILTER_EXT_OID ((ber_tag_t) 0x81U) /* context specific */
498 #define LDAP_FILTER_EXT_TYPE ((ber_tag_t) 0x82U) /* context specific */
499 #define LDAP_FILTER_EXT_VALUE ((ber_tag_t) 0x83U) /* context specific */
500 #define LDAP_FILTER_EXT_DNATTRS ((ber_tag_t) 0x84U) /* context specific */
502 /* substring filter component types */
503 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
504 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
505 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
508 #define LDAP_SCOPE_BASE ((ber_int_t) 0x0000)
509 #define LDAP_SCOPE_BASEOBJECT LDAP_SCOPE_BASE
510 #define LDAP_SCOPE_ONELEVEL ((ber_int_t) 0x0001)
511 #define LDAP_SCOPE_ONE LDAP_SCOPE_ONELEVEL
512 #define LDAP_SCOPE_SUBTREE ((ber_int_t) 0x0002)
513 #define LDAP_SCOPE_SUB LDAP_SCOPE_SUBTREE
514 #define LDAP_SCOPE_SUBORDINATE ((ber_int_t) 0x0003) /* OpenLDAP extension */
515 #define LDAP_SCOPE_CHILDREN LDAP_SCOPE_SUBORDINATE
516 #define LDAP_SCOPE_DEFAULT ((ber_int_t) -1) /* OpenLDAP extension */
518 /* substring filter component types */
519 #define LDAP_SUBSTRING_INITIAL ((ber_tag_t) 0x80U) /* context specific */
520 #define LDAP_SUBSTRING_ANY ((ber_tag_t) 0x81U) /* context specific */
521 #define LDAP_SUBSTRING_FINAL ((ber_tag_t) 0x82U) /* context specific */
526 #define LDAP_SUCCESS 0x00
528 #define LDAP_RANGE(n,x,y) (((x) <= (n)) && ((n) <= (y)))
530 #define LDAP_OPERATIONS_ERROR 0x01
531 #define LDAP_PROTOCOL_ERROR 0x02
532 #define LDAP_TIMELIMIT_EXCEEDED 0x03
533 #define LDAP_SIZELIMIT_EXCEEDED 0x04
534 #define LDAP_COMPARE_FALSE 0x05
535 #define LDAP_COMPARE_TRUE 0x06
536 #define LDAP_AUTH_METHOD_NOT_SUPPORTED 0x07
537 #define LDAP_STRONG_AUTH_NOT_SUPPORTED LDAP_AUTH_METHOD_NOT_SUPPORTED
538 #define LDAP_STRONG_AUTH_REQUIRED 0x08
539 #define LDAP_STRONGER_AUTH_REQUIRED LDAP_STRONG_AUTH_REQUIRED
540 #define LDAP_PARTIAL_RESULTS 0x09 /* LDAPv2+ (not LDAPv3) */
542 #define LDAP_REFERRAL 0x0a /* LDAPv3 */
543 #define LDAP_ADMINLIMIT_EXCEEDED 0x0b /* LDAPv3 */
544 #define LDAP_UNAVAILABLE_CRITICAL_EXTENSION 0x0c /* LDAPv3 */
545 #define LDAP_CONFIDENTIALITY_REQUIRED 0x0d /* LDAPv3 */
546 #define LDAP_SASL_BIND_IN_PROGRESS 0x0e /* LDAPv3 */
548 #define LDAP_ATTR_ERROR(n) LDAP_RANGE((n),0x10,0x15) /* 16-21 */
550 #define LDAP_NO_SUCH_ATTRIBUTE 0x10
551 #define LDAP_UNDEFINED_TYPE 0x11
552 #define LDAP_INAPPROPRIATE_MATCHING 0x12
553 #define LDAP_CONSTRAINT_VIOLATION 0x13
554 #define LDAP_TYPE_OR_VALUE_EXISTS 0x14
555 #define LDAP_INVALID_SYNTAX 0x15
557 #define LDAP_NAME_ERROR(n) LDAP_RANGE((n),0x20,0x24) /* 32-34,36 */
559 #define LDAP_NO_SUCH_OBJECT 0x20
560 #define LDAP_ALIAS_PROBLEM 0x21
561 #define LDAP_INVALID_DN_SYNTAX 0x22
562 #define LDAP_IS_LEAF 0x23 /* not LDAPv3 */
563 #define LDAP_ALIAS_DEREF_PROBLEM 0x24
565 #define LDAP_SECURITY_ERROR(n) LDAP_RANGE((n),0x2F,0x32) /* 47-50 */
567 #define LDAP_X_PROXY_AUTHZ_FAILURE 0x2F /* LDAPv3 proxy authorization */
568 #define LDAP_INAPPROPRIATE_AUTH 0x30
569 #define LDAP_INVALID_CREDENTIALS 0x31
570 #define LDAP_INSUFFICIENT_ACCESS 0x32
572 #define LDAP_SERVICE_ERROR(n) LDAP_RANGE((n),0x33,0x36) /* 51-54 */
574 #define LDAP_BUSY 0x33
575 #define LDAP_UNAVAILABLE 0x34
576 #define LDAP_UNWILLING_TO_PERFORM 0x35
577 #define LDAP_LOOP_DETECT 0x36
579 #define LDAP_UPDATE_ERROR(n) LDAP_RANGE((n),0x40,0x47) /* 64-69,71 */
581 #define LDAP_NAMING_VIOLATION 0x40
582 #define LDAP_OBJECT_CLASS_VIOLATION 0x41
583 #define LDAP_NOT_ALLOWED_ON_NONLEAF 0x42
584 #define LDAP_NOT_ALLOWED_ON_RDN 0x43
585 #define LDAP_ALREADY_EXISTS 0x44
586 #define LDAP_NO_OBJECT_CLASS_MODS 0x45
587 #define LDAP_RESULTS_TOO_LARGE 0x46 /* CLDAP */
588 #define LDAP_AFFECTS_MULTIPLE_DSAS 0x47
590 #define LDAP_OTHER 0x50
592 /* LCUP operation codes (113-117) - not implemented */
593 #define LDAP_CUP_RESOURCES_EXHAUSTED 0x71
594 #define LDAP_CUP_SECURITY_VIOLATION 0x72
595 #define LDAP_CUP_INVALID_DATA 0x73
596 #define LDAP_CUP_UNSUPPORTED_SCHEME 0x74
597 #define LDAP_CUP_RELOAD_REQUIRED 0x75
599 /* Cancel operation codes (118-121) */
600 #define LDAP_CANCELLED 0x76
601 #define LDAP_NO_SUCH_OPERATION 0x77
602 #define LDAP_TOO_LATE 0x78
603 #define LDAP_CANNOT_CANCEL 0x79
605 /* Assertion control (122) */
606 #define LDAP_ASSERTION_FAILED 0x7A
608 /* Proxied Authorization Denied (123) */
609 #define LDAP_PROXIED_AUTHORIZATION_DENIED 0x7B
611 /* Experimental result codes */
612 #define LDAP_E_ERROR(n) LDAP_RANGE((n),0x1000,0x3FFF)
614 /* LDAP Sync (4096) */
615 #define LDAP_SYNC_REFRESH_REQUIRED 0x1000
618 /* Private Use result codes */
619 #define LDAP_X_ERROR(n) LDAP_RANGE((n),0x4000,0xFFFF)
621 #define LDAP_X_SYNC_REFRESH_REQUIRED 0x4100 /* defunct */
622 #define LDAP_X_ASSERTION_FAILED 0x410f /* defunct */
624 /* for the LDAP No-Op control */
625 #define LDAP_X_NO_OPERATION 0x410e
627 /* for the Chaining Behavior control (consecutive result codes requested;
628 * see <draft-sermersheim-ldap-chaining> ) */
629 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
630 #define LDAP_X_NO_REFERRALS_FOUND 0x4110
631 #define LDAP_X_CANNOT_CHAIN 0x4111
634 /* for Distributed Procedures (see <draft-sermersheim-ldap-distproc>) */
635 #ifdef LDAP_X_DISTPROC_BASE
636 #define LDAP_X_INVALIDREFERENCE 0x4112
640 #define LDAP_X_TXN_SPECIFY_OKAY 0x4120
641 #define LDAP_X_TXN_ID_INVALID 0x4121
646 * Based on draft-ietf-ldap-c-api-xx
647 * but with new negative code values
649 #define LDAP_API_ERROR(n) ((n)<0)
650 #define LDAP_API_RESULT(n) ((n)<=0)
652 #define LDAP_SERVER_DOWN (-1)
653 #define LDAP_LOCAL_ERROR (-2)
654 #define LDAP_ENCODING_ERROR (-3)
655 #define LDAP_DECODING_ERROR (-4)
656 #define LDAP_TIMEOUT (-5)
657 #define LDAP_AUTH_UNKNOWN (-6)
658 #define LDAP_FILTER_ERROR (-7)
659 #define LDAP_USER_CANCELLED (-8)
660 #define LDAP_PARAM_ERROR (-9)
661 #define LDAP_NO_MEMORY (-10)
662 #define LDAP_CONNECT_ERROR (-11)
663 #define LDAP_NOT_SUPPORTED (-12)
664 #define LDAP_CONTROL_NOT_FOUND (-13)
665 #define LDAP_NO_RESULTS_RETURNED (-14)
666 #define LDAP_MORE_RESULTS_TO_RETURN (-15) /* Obsolete */
667 #define LDAP_CLIENT_LOOP (-16)
668 #define LDAP_REFERRAL_LIMIT_EXCEEDED (-17)
669 #define LDAP_X_CONNECTING (-18)
673 * This structure represents both ldap messages and ldap responses.
674 * These are really the same, except in the case of search responses,
675 * where a response has multiple messages.
678 typedef struct ldapmsg LDAPMessage
;
680 /* for modifications */
681 typedef struct ldapmod
{
684 #define LDAP_MOD_OP (0x0007)
685 #define LDAP_MOD_ADD (0x0000)
686 #define LDAP_MOD_DELETE (0x0001)
687 #define LDAP_MOD_REPLACE (0x0002)
688 #define LDAP_MOD_INCREMENT (0x0003) /* OpenLDAP extension */
689 #define LDAP_MOD_BVALUES (0x0080)
690 /* IMPORTANT: do not use code 0x1000 (or above),
691 * it is used internally by the backends!
692 * (see ldap/servers/slapd/slap.h)
698 struct berval
**modv_bvals
;
700 #define mod_values mod_vals.modv_strvals
701 #define mod_bvalues mod_vals.modv_bvals
705 * structure representing an ldap session which can
706 * encompass connections to multiple servers (in the
707 * face of referrals).
709 typedef struct ldap LDAP
;
711 #define LDAP_DEREF_NEVER 0x00
712 #define LDAP_DEREF_SEARCHING 0x01
713 #define LDAP_DEREF_FINDING 0x02
714 #define LDAP_DEREF_ALWAYS 0x03
716 #define LDAP_NO_LIMIT 0
718 /* how many messages to retrieve results for */
719 #define LDAP_MSG_ONE 0x00
720 #define LDAP_MSG_ALL 0x01
721 #define LDAP_MSG_RECEIVED 0x02
724 * types for ldap URL handling
726 typedef struct ldap_url_desc
{
727 struct ldap_url_desc
*lud_next
;
739 #define LDAP_URL_SUCCESS 0x00 /* Success */
740 #define LDAP_URL_ERR_MEM 0x01 /* can't allocate memory space */
741 #define LDAP_URL_ERR_PARAM 0x02 /* parameter is bad */
743 #define LDAP_URL_ERR_BADSCHEME 0x03 /* URL doesn't begin with "ldap[si]://" */
744 #define LDAP_URL_ERR_BADENCLOSURE 0x04 /* URL is missing trailing ">" */
745 #define LDAP_URL_ERR_BADURL 0x05 /* URL is bad */
746 #define LDAP_URL_ERR_BADHOST 0x06 /* host port is bad */
747 #define LDAP_URL_ERR_BADATTRS 0x07 /* bad (or missing) attributes */
748 #define LDAP_URL_ERR_BADSCOPE 0x08 /* scope string is invalid (or missing) */
749 #define LDAP_URL_ERR_BADFILTER 0x09 /* bad or missing filter */
750 #define LDAP_URL_ERR_BADEXTS 0x0a /* bad or missing extensions */
753 * LDAP sync (RFC4533) API
756 typedef struct ldap_sync_t ldap_sync_t
;
759 /* these are private - the client should never see them */
760 LDAP_SYNC_CAPI_NONE
= -1,
762 LDAP_SYNC_CAPI_PHASE_FLAG
= 0x10U
,
763 LDAP_SYNC_CAPI_IDSET_FLAG
= 0x20U
,
764 LDAP_SYNC_CAPI_DONE_FLAG
= 0x40U
,
766 /* these are passed to ls_search_entry() */
767 LDAP_SYNC_CAPI_PRESENT
= LDAP_SYNC_PRESENT
,
768 LDAP_SYNC_CAPI_ADD
= LDAP_SYNC_ADD
,
769 LDAP_SYNC_CAPI_MODIFY
= LDAP_SYNC_MODIFY
,
770 LDAP_SYNC_CAPI_DELETE
= LDAP_SYNC_DELETE
,
772 /* these are passed to ls_intermediate() */
773 LDAP_SYNC_CAPI_PRESENTS
= ( LDAP_SYNC_CAPI_PHASE_FLAG
| LDAP_SYNC_CAPI_PRESENT
),
774 LDAP_SYNC_CAPI_DELETES
= ( LDAP_SYNC_CAPI_PHASE_FLAG
| LDAP_SYNC_CAPI_DELETE
),
776 LDAP_SYNC_CAPI_PRESENTS_IDSET
= ( LDAP_SYNC_CAPI_PRESENTS
| LDAP_SYNC_CAPI_IDSET_FLAG
),
777 LDAP_SYNC_CAPI_DELETES_IDSET
= ( LDAP_SYNC_CAPI_DELETES
| LDAP_SYNC_CAPI_IDSET_FLAG
),
779 LDAP_SYNC_CAPI_DONE
= ( LDAP_SYNC_CAPI_DONE_FLAG
| LDAP_SYNC_CAPI_PRESENTS
)
780 } ldap_sync_refresh_t
;
783 * Called when an entry is returned by ldap_result().
784 * If phase is LDAP_SYNC_CAPI_ADD or LDAP_SYNC_CAPI_MODIFY,
785 * the entry has been either added or modified, and thus
786 * the complete view of the entry should be in the LDAPMessage.
787 * If phase is LDAP_SYNC_CAPI_PRESENT or LDAP_SYNC_CAPI_DELETE,
788 * only the DN should be in the LDAPMessage.
790 typedef int (*ldap_sync_search_entry_f
) LDAP_P((
793 struct berval
*entryUUID
,
794 ldap_sync_refresh_t phase
));
797 * Called when a reference is returned; the client should know
798 * what to do with it.
800 typedef int (*ldap_sync_search_reference_f
) LDAP_P((
805 * Called when specific intermediate/final messages are returned.
806 * If phase is LDAP_SYNC_CAPI_PRESENTS or LDAP_SYNC_CAPI_DELETES,
807 * a "presents" or "deletes" phase begins.
808 * If phase is LDAP_SYNC_CAPI_DONE, a special "presents" phase
809 * with refreshDone set to "TRUE" has been returned, to indicate
810 * that the refresh phase of a refreshAndPersist is complete.
811 * In the above cases, syncUUIDs is NULL.
813 * If phase is LDAP_SYNC_CAPI_PRESENTS_IDSET or
814 * LDAP_SYNC_CAPI_DELETES_IDSET, syncUUIDs is an array of UUIDs
815 * that are either present or have been deleted.
817 typedef int (*ldap_sync_intermediate_f
) LDAP_P((
821 ldap_sync_refresh_t phase
));
824 * Called when a searchResultDone is returned. In refreshAndPersist,
825 * this can only occur if the search for any reason is being terminated
828 typedef int (*ldap_sync_search_result_f
) LDAP_P((
831 int refreshDeletes
));
834 * This structure contains all information about the persistent search;
835 * the caller is responsible for connecting, setting version, binding, tls...
838 /* conf search params */
849 /* helpers - add as appropriate */
850 ldap_sync_search_entry_f ls_search_entry
;
851 ldap_sync_search_reference_f ls_search_reference
;
852 ldap_sync_intermediate_f ls_intermediate
;
853 ldap_sync_search_result_f ls_search_result
;
855 /* set by the caller as appropriate */
861 /* --- the parameters below are private - do not modify --- */
863 /* FIXME: make the structure opaque, and provide an interface
864 * to modify the public values? */
870 /* needed by refreshOnly */
873 /* opaque - need to pass between sessions, updated by the API */
874 struct berval ls_cookie
;
876 /* state variable - do not modify */
877 ldap_sync_refresh_t ls_refreshPhase
;
881 * End of LDAP sync (RFC4533) API
885 * The API draft spec says we should declare (or cause to be declared)
886 * 'struct timeval'. We don't. See IETF LDAPext discussions.
894 ldap_get_option
LDAP_P((
900 ldap_set_option
LDAP_P((
903 LDAP_CONST
void *invalue
));
905 /* V3 REBIND Function Callback Prototype */
906 typedef int (LDAP_REBIND_PROC
) LDAP_P((
907 LDAP
*ld
, LDAP_CONST
char *url
,
908 ber_tag_t request
, ber_int_t msgid
,
912 ldap_set_rebind_proc
LDAP_P((
914 LDAP_REBIND_PROC
*rebind_proc
,
917 /* V3 referral selection Function Callback Prototype */
918 typedef int (LDAP_NEXTREF_PROC
) LDAP_P((
919 LDAP
*ld
, char ***refsp
, int *cntp
,
923 ldap_set_nextref_proc
LDAP_P((
925 LDAP_NEXTREF_PROC
*nextref_proc
,
928 /* V3 URLLIST Function Callback Prototype */
929 typedef int (LDAP_URLLIST_PROC
) LDAP_P((
931 LDAPURLDesc
**urllist
,
936 ldap_set_urllist_proc
LDAP_P((
938 LDAP_URLLIST_PROC
*urllist_proc
,
946 ldap_create_control
LDAP_P(( /* deprecated, use ldap_control_create */
947 LDAP_CONST
char *requestOID
,
950 LDAPControl
**ctrlp
));
952 LDAP_F( LDAPControl
* )
953 ldap_find_control
LDAP_P(( /* deprecated, use ldap_control_find */
954 LDAP_CONST
char *oid
,
955 LDAPControl
**ctrls
));
959 ldap_control_create
LDAP_P((
960 LDAP_CONST
char *requestOID
,
962 struct berval
*value
,
964 LDAPControl
**ctrlp
));
966 LDAP_F( LDAPControl
* )
967 ldap_control_find
LDAP_P((
968 LDAP_CONST
char *oid
,
970 LDAPControl
***nextctrlp
));
973 ldap_control_free
LDAP_P((
974 LDAPControl
*ctrl
));
977 ldap_controls_free
LDAP_P((
978 LDAPControl
**ctrls
));
980 LDAP_F( LDAPControl
** )
981 ldap_controls_dup
LDAP_P((
982 LDAPControl
*LDAP_CONST
*controls
));
984 LDAP_F( LDAPControl
* )
985 ldap_control_dup
LDAP_P((
986 LDAP_CONST LDAPControl
*c
));
992 ldap_domain2dn
LDAP_P((
993 LDAP_CONST
char* domain
,
997 ldap_dn2domain
LDAP_P((
1002 ldap_domain2hostlist
LDAP_P((
1003 LDAP_CONST
char *domain
,
1010 ldap_extended_operation
LDAP_P((
1012 LDAP_CONST
char *reqoid
,
1013 struct berval
*reqdata
,
1014 LDAPControl
**serverctrls
,
1015 LDAPControl
**clientctrls
,
1019 ldap_extended_operation_s
LDAP_P((
1021 LDAP_CONST
char *reqoid
,
1022 struct berval
*reqdata
,
1023 LDAPControl
**serverctrls
,
1024 LDAPControl
**clientctrls
,
1026 struct berval
**retdatap
));
1029 ldap_parse_extended_result
LDAP_P((
1033 struct berval
**retdatap
,
1037 ldap_parse_intermediate
LDAP_P((
1041 struct berval
**retdatap
,
1042 LDAPControl
***serverctrls
,
1050 ldap_abandon_ext
LDAP_P((
1053 LDAPControl
**serverctrls
,
1054 LDAPControl
**clientctrls
));
1058 ldap_abandon
LDAP_P(( /* deprecated, use ldap_abandon_ext */
1067 ldap_add_ext
LDAP_P((
1069 LDAP_CONST
char *dn
,
1071 LDAPControl
**serverctrls
,
1072 LDAPControl
**clientctrls
,
1076 ldap_add_ext_s
LDAP_P((
1078 LDAP_CONST
char *dn
,
1080 LDAPControl
**serverctrls
,
1081 LDAPControl
**clientctrls
));
1085 ldap_add
LDAP_P(( /* deprecated, use ldap_add_ext */
1087 LDAP_CONST
char *dn
,
1091 ldap_add_s
LDAP_P(( /* deprecated, use ldap_add_ext_s */
1093 LDAP_CONST
char *dn
,
1102 ldap_sasl_bind
LDAP_P((
1104 LDAP_CONST
char *dn
,
1105 LDAP_CONST
char *mechanism
,
1106 struct berval
*cred
,
1107 LDAPControl
**serverctrls
,
1108 LDAPControl
**clientctrls
,
1111 /* Interaction flags (should be passed about in a control)
1112 * Automatic (default): use defaults, prompt otherwise
1113 * Interactive: prompt always
1114 * Quiet: never prompt
1116 #define LDAP_SASL_AUTOMATIC 0U
1117 #define LDAP_SASL_INTERACTIVE 1U
1118 #define LDAP_SASL_QUIET 2U
1121 * V3 SASL Interaction Function Callback Prototype
1122 * when using Cyrus SASL, interact is pointer to sasl_interact_t
1123 * should likely passed in a control (and provided controls)
1125 typedef int (LDAP_SASL_INTERACT_PROC
) LDAP_P((
1126 LDAP
*ld
, unsigned flags
, void* defaults
, void *interact
));
1129 ldap_sasl_interactive_bind_s
LDAP_P((
1131 LDAP_CONST
char *dn
, /* usually NULL */
1132 LDAP_CONST
char *saslMechanism
,
1133 LDAPControl
**serverControls
,
1134 LDAPControl
**clientControls
,
1136 /* should be client controls */
1138 LDAP_SASL_INTERACT_PROC
*proc
,
1142 ldap_sasl_bind_s
LDAP_P((
1144 LDAP_CONST
char *dn
,
1145 LDAP_CONST
char *mechanism
,
1146 struct berval
*cred
,
1147 LDAPControl
**serverctrls
,
1148 LDAPControl
**clientctrls
,
1149 struct berval
**servercredp
));
1152 ldap_parse_sasl_bind_result
LDAP_P((
1155 struct berval
**servercredp
,
1164 ldap_bind
LDAP_P(( /* deprecated, use ldap_sasl_bind */
1166 LDAP_CONST
char *who
,
1167 LDAP_CONST
char *passwd
,
1171 ldap_bind_s
LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1173 LDAP_CONST
char *who
,
1174 LDAP_CONST
char *cred
,
1181 ldap_simple_bind
LDAP_P(( /* deprecated, use ldap_sasl_bind */
1183 LDAP_CONST
char *who
,
1184 LDAP_CONST
char *passwd
));
1187 ldap_simple_bind_s
LDAP_P(( /* deprecated, use ldap_sasl_bind_s */
1189 LDAP_CONST
char *who
,
1190 LDAP_CONST
char *passwd
));
1199 ldap_compare_ext
LDAP_P((
1201 LDAP_CONST
char *dn
,
1202 LDAP_CONST
char *attr
,
1203 struct berval
*bvalue
,
1204 LDAPControl
**serverctrls
,
1205 LDAPControl
**clientctrls
,
1209 ldap_compare_ext_s
LDAP_P((
1211 LDAP_CONST
char *dn
,
1212 LDAP_CONST
char *attr
,
1213 struct berval
*bvalue
,
1214 LDAPControl
**serverctrls
,
1215 LDAPControl
**clientctrls
));
1219 ldap_compare
LDAP_P(( /* deprecated, use ldap_compare_ext */
1221 LDAP_CONST
char *dn
,
1222 LDAP_CONST
char *attr
,
1223 LDAP_CONST
char *value
));
1226 ldap_compare_s
LDAP_P(( /* deprecated, use ldap_compare_ext_s */
1228 LDAP_CONST
char *dn
,
1229 LDAP_CONST
char *attr
,
1230 LDAP_CONST
char *value
));
1238 ldap_delete_ext
LDAP_P((
1240 LDAP_CONST
char *dn
,
1241 LDAPControl
**serverctrls
,
1242 LDAPControl
**clientctrls
,
1246 ldap_delete_ext_s
LDAP_P((
1248 LDAP_CONST
char *dn
,
1249 LDAPControl
**serverctrls
,
1250 LDAPControl
**clientctrls
));
1254 ldap_delete
LDAP_P(( /* deprecated, use ldap_delete_ext */
1256 LDAP_CONST
char *dn
));
1259 ldap_delete_s
LDAP_P(( /* deprecated, use ldap_delete_ext_s */
1261 LDAP_CONST
char *dn
));
1269 ldap_parse_result
LDAP_P((
1276 LDAPControl
***serverctrls
,
1280 ldap_err2string
LDAP_P((
1285 ldap_result2error
LDAP_P(( /* deprecated, use ldap_parse_result */
1291 ldap_perror
LDAP_P(( /* deprecated, use ldap_err2string */
1293 LDAP_CONST
char *s
));
1301 ldap_modify_ext
LDAP_P((
1303 LDAP_CONST
char *dn
,
1305 LDAPControl
**serverctrls
,
1306 LDAPControl
**clientctrls
,
1310 ldap_modify_ext_s
LDAP_P((
1312 LDAP_CONST
char *dn
,
1314 LDAPControl
**serverctrls
,
1315 LDAPControl
**clientctrls
));
1319 ldap_modify
LDAP_P(( /* deprecated, use ldap_modify_ext */
1321 LDAP_CONST
char *dn
,
1325 ldap_modify_s
LDAP_P(( /* deprecated, use ldap_modify_ext_s */
1327 LDAP_CONST
char *dn
,
1336 ldap_rename
LDAP_P((
1338 LDAP_CONST
char *dn
,
1339 LDAP_CONST
char *newrdn
,
1340 LDAP_CONST
char *newSuperior
,
1342 LDAPControl
**sctrls
,
1343 LDAPControl
**cctrls
,
1347 ldap_rename_s
LDAP_P((
1349 LDAP_CONST
char *dn
,
1350 LDAP_CONST
char *newrdn
,
1351 LDAP_CONST
char *newSuperior
,
1353 LDAPControl
**sctrls
,
1354 LDAPControl
**cctrls
));
1358 ldap_rename2
LDAP_P(( /* deprecated, use ldap_rename */
1360 LDAP_CONST
char *dn
,
1361 LDAP_CONST
char *newrdn
,
1362 LDAP_CONST
char *newSuperior
,
1363 int deleteoldrdn
));
1366 ldap_rename2_s
LDAP_P(( /* deprecated, use ldap_rename_s */
1368 LDAP_CONST
char *dn
,
1369 LDAP_CONST
char *newrdn
,
1370 LDAP_CONST
char *newSuperior
,
1371 int deleteoldrdn
));
1374 ldap_modrdn
LDAP_P(( /* deprecated, use ldap_rename */
1376 LDAP_CONST
char *dn
,
1377 LDAP_CONST
char *newrdn
));
1380 ldap_modrdn_s
LDAP_P(( /* deprecated, use ldap_rename_s */
1382 LDAP_CONST
char *dn
,
1383 LDAP_CONST
char *newrdn
));
1386 ldap_modrdn2
LDAP_P(( /* deprecated, use ldap_rename */
1388 LDAP_CONST
char *dn
,
1389 LDAP_CONST
char *newrdn
,
1390 int deleteoldrdn
));
1393 ldap_modrdn2_s
LDAP_P(( /* deprecated, use ldap_rename_s */
1395 LDAP_CONST
char *dn
,
1396 LDAP_CONST
char *newrdn
,
1406 ldap_init
LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1407 LDAP_CONST
char *host
,
1411 ldap_open
LDAP_P(( /* deprecated, use ldap_create or ldap_initialize */
1412 LDAP_CONST
char *host
,
1417 ldap_create
LDAP_P((
1421 ldap_initialize
LDAP_P((
1423 LDAP_CONST
char *url
));
1430 ldap_tls_inplace
LDAP_P((
1434 ldap_start_tls
LDAP_P((
1436 LDAPControl
**serverctrls
,
1437 LDAPControl
**clientctrls
,
1441 ldap_install_tls
LDAP_P((
1445 ldap_start_tls_s
LDAP_P((
1447 LDAPControl
**serverctrls
,
1448 LDAPControl
**clientctrls
));
1453 LDAP_F( LDAPMessage
* )
1454 ldap_first_message
LDAP_P((
1456 LDAPMessage
*chain
));
1458 LDAP_F( LDAPMessage
* )
1459 ldap_next_message
LDAP_P((
1461 LDAPMessage
*msg
));
1464 ldap_count_messages
LDAP_P((
1466 LDAPMessage
*chain
));
1471 LDAP_F( LDAPMessage
* )
1472 ldap_first_reference
LDAP_P((
1474 LDAPMessage
*chain
));
1476 LDAP_F( LDAPMessage
* )
1477 ldap_next_reference
LDAP_P((
1479 LDAPMessage
*ref
));
1482 ldap_count_references
LDAP_P((
1484 LDAPMessage
*chain
));
1487 ldap_parse_reference
LDAP_P((
1491 LDAPControl
***serverctrls
,
1498 LDAP_F( LDAPMessage
* )
1499 ldap_first_entry
LDAP_P((
1501 LDAPMessage
*chain
));
1503 LDAP_F( LDAPMessage
* )
1504 ldap_next_entry
LDAP_P((
1506 LDAPMessage
*entry
));
1509 ldap_count_entries
LDAP_P((
1511 LDAPMessage
*chain
));
1514 ldap_get_entry_controls
LDAP_P((
1517 LDAPControl
***serverctrls
));
1523 LDAP_F( LDAPMessage
* )
1524 ldap_delete_result_entry
LDAP_P((
1529 ldap_add_result_entry
LDAP_P((
1538 ldap_get_dn
LDAP_P((
1540 LDAPMessage
*entry
));
1542 typedef struct ldap_ava
{
1543 struct berval la_attr
;
1544 struct berval la_value
;
1546 #define LDAP_AVA_NULL 0x0000U
1547 #define LDAP_AVA_STRING 0x0001U
1548 #define LDAP_AVA_BINARY 0x0002U
1549 #define LDAP_AVA_NONPRINTABLE 0x0004U
1550 #define LDAP_AVA_FREE_ATTR 0x0010U
1551 #define LDAP_AVA_FREE_VALUE 0x0020U
1556 typedef LDAPAVA
** LDAPRDN
;
1557 typedef LDAPRDN
* LDAPDN
;
1560 #define LDAP_DN_FORMAT_LDAP 0x0000U
1561 #define LDAP_DN_FORMAT_LDAPV3 0x0010U
1562 #define LDAP_DN_FORMAT_LDAPV2 0x0020U
1563 #define LDAP_DN_FORMAT_DCE 0x0030U
1564 #define LDAP_DN_FORMAT_UFN 0x0040U /* dn2str only */
1565 #define LDAP_DN_FORMAT_AD_CANONICAL 0x0050U /* dn2str only */
1566 #define LDAP_DN_FORMAT_LBER 0x00F0U /* for testing only */
1567 #define LDAP_DN_FORMAT_MASK 0x00F0U
1570 #define LDAP_DN_PRETTY 0x0100U
1571 #define LDAP_DN_SKIP 0x0200U
1572 #define LDAP_DN_P_NOLEADTRAILSPACES 0x1000U
1573 #define LDAP_DN_P_NOSPACEAFTERRDN 0x2000U
1574 #define LDAP_DN_PEDANTIC 0xF000U
1576 LDAP_F( void ) ldap_rdnfree
LDAP_P(( LDAPRDN rdn
));
1577 LDAP_F( void ) ldap_dnfree
LDAP_P(( LDAPDN dn
));
1586 ldap_str2dn
LDAP_P((
1587 LDAP_CONST
char *str
,
1598 ldap_dn2str
LDAP_P((
1604 ldap_bv2rdn
LDAP_P((
1611 ldap_str2rdn
LDAP_P((
1612 LDAP_CONST
char *str
,
1618 ldap_rdn2bv
LDAP_P((
1624 ldap_rdn2str
LDAP_P((
1630 ldap_dn_normalize
LDAP_P((
1631 LDAP_CONST
char *in
, unsigned iflags
,
1632 char **out
, unsigned oflags
));
1635 ldap_dn2ufn
LDAP_P(( /* deprecated, use ldap_str2dn/dn2str */
1636 LDAP_CONST
char *dn
));
1639 ldap_explode_dn
LDAP_P(( /* deprecated, ldap_str2dn */
1640 LDAP_CONST
char *dn
,
1644 ldap_explode_rdn
LDAP_P(( /* deprecated, ldap_str2rdn */
1645 LDAP_CONST
char *rdn
,
1648 typedef int LDAPDN_rewrite_func
1649 LDAP_P(( LDAPDN dn
, unsigned flags
, void *ctx
));
1652 ldap_X509dn2bv
LDAP_P(( void *x509_name
, struct berval
*dn
,
1653 LDAPDN_rewrite_func
*func
, unsigned flags
));
1656 ldap_dn2dcedn
LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1657 LDAP_CONST
char *dn
));
1660 ldap_dcedn2dn
LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1661 LDAP_CONST
char *dce
));
1664 ldap_dn2ad_canonical
LDAP_P(( /* deprecated, ldap_str2dn/dn2str */
1665 LDAP_CONST
char *dn
));
1668 ldap_get_dn_ber
LDAP_P((
1669 LDAP
*ld
, LDAPMessage
*e
, BerElement
**berout
, struct berval
*dn
));
1672 ldap_get_attribute_ber
LDAP_P((
1673 LDAP
*ld
, LDAPMessage
*e
, BerElement
*ber
, struct berval
*attr
,
1674 struct berval
**vals
));
1680 ldap_first_attribute
LDAP_P((
1683 BerElement
**ber
));
1686 ldap_next_attribute
LDAP_P((
1695 LDAP_F( struct berval
** )
1696 ldap_get_values_len
LDAP_P((
1699 LDAP_CONST
char *target
));
1702 ldap_count_values_len
LDAP_P((
1703 struct berval
**vals
));
1706 ldap_value_free_len
LDAP_P((
1707 struct berval
**vals
));
1711 ldap_get_values
LDAP_P(( /* deprecated, use ldap_get_values_len */
1714 LDAP_CONST
char *target
));
1717 ldap_count_values
LDAP_P(( /* deprecated, use ldap_count_values_len */
1721 ldap_value_free
LDAP_P(( /* deprecated, use ldap_value_free_len */
1729 ldap_result
LDAP_P((
1733 struct timeval
*timeout
,
1734 LDAPMessage
**result
));
1737 ldap_msgtype
LDAP_P((
1745 ldap_msgfree
LDAP_P((
1749 ldap_msgdelete
LDAP_P((
1758 ldap_bv2escaped_filter_value
LDAP_P((
1760 struct berval
*out
));
1763 ldap_search_ext
LDAP_P((
1765 LDAP_CONST
char *base
,
1767 LDAP_CONST
char *filter
,
1770 LDAPControl
**serverctrls
,
1771 LDAPControl
**clientctrls
,
1772 struct timeval
*timeout
,
1777 ldap_search_ext_s
LDAP_P((
1779 LDAP_CONST
char *base
,
1781 LDAP_CONST
char *filter
,
1784 LDAPControl
**serverctrls
,
1785 LDAPControl
**clientctrls
,
1786 struct timeval
*timeout
,
1788 LDAPMessage
**res
));
1792 ldap_search
LDAP_P(( /* deprecated, use ldap_search_ext */
1794 LDAP_CONST
char *base
,
1796 LDAP_CONST
char *filter
,
1801 ldap_search_s
LDAP_P(( /* deprecated, use ldap_search_ext_s */
1803 LDAP_CONST
char *base
,
1805 LDAP_CONST
char *filter
,
1808 LDAPMessage
**res
));
1811 ldap_search_st
LDAP_P(( /* deprecated, use ldap_search_ext_s */
1813 LDAP_CONST
char *base
,
1815 LDAP_CONST
char *filter
,
1818 struct timeval
*timeout
,
1819 LDAPMessage
**res
));
1826 ldap_unbind_ext
LDAP_P((
1828 LDAPControl
**serverctrls
,
1829 LDAPControl
**clientctrls
));
1832 ldap_unbind_ext_s
LDAP_P((
1834 LDAPControl
**serverctrls
,
1835 LDAPControl
**clientctrls
));
1839 ldap_unbind
LDAP_P(( /* deprecated, use ldap_unbind_ext */
1843 ldap_unbind_s
LDAP_P(( /* deprecated, use ldap_unbind_ext_s */
1851 ldap_put_vrFilter
LDAP_P((
1860 ldap_memalloc
LDAP_P((
1864 ldap_memrealloc
LDAP_P((
1869 ldap_memcalloc
LDAP_P((
1874 ldap_memfree
LDAP_P((
1878 ldap_memvfree
LDAP_P((
1882 ldap_strdup
LDAP_P((
1883 LDAP_CONST
char * ));
1886 ldap_mods_free
LDAP_P((
1893 * in sort.c (deprecated, use custom code instead)
1895 typedef int (LDAP_SORT_AD_CMP_PROC
) LDAP_P(( /* deprecated */
1896 LDAP_CONST
char *left
,
1897 LDAP_CONST
char *right
));
1899 typedef int (LDAP_SORT_AV_CMP_PROC
) LDAP_P(( /* deprecated */
1900 LDAP_CONST
void *left
,
1901 LDAP_CONST
void *right
));
1903 LDAP_F( int ) /* deprecated */
1904 ldap_sort_entries
LDAP_P(( LDAP
*ld
,
1905 LDAPMessage
**chain
,
1906 LDAP_CONST
char *attr
,
1907 LDAP_SORT_AD_CMP_PROC
*cmp
));
1909 LDAP_F( int ) /* deprecated */
1910 ldap_sort_values
LDAP_P((
1913 LDAP_SORT_AV_CMP_PROC
*cmp
));
1915 LDAP_F( int ) /* deprecated */
1916 ldap_sort_strcasecmp
LDAP_P((
1918 LDAP_CONST
void *b
));
1925 ldap_is_ldap_url
LDAP_P((
1926 LDAP_CONST
char *url
));
1929 ldap_is_ldaps_url
LDAP_P((
1930 LDAP_CONST
char *url
));
1933 ldap_is_ldapi_url
LDAP_P((
1934 LDAP_CONST
char *url
));
1937 ldap_url_parse
LDAP_P((
1938 LDAP_CONST
char *url
,
1939 LDAPURLDesc
**ludpp
));
1942 ldap_url_desc2str
LDAP_P((
1943 LDAPURLDesc
*ludp
));
1946 ldap_free_urldesc
LDAP_P((
1947 LDAPURLDesc
*ludp
));
1951 * LDAP Cancel Extended Operation <draft-zeilenga-ldap-cancel-xx.txt>
1954 #define LDAP_API_FEATURE_CANCEL 1000
1957 ldap_cancel
LDAP_P(( LDAP
*ld
,
1959 LDAPControl
**sctrls
,
1960 LDAPControl
**cctrls
,
1964 ldap_cancel_s
LDAP_P(( LDAP
*ld
,
1966 LDAPControl
**sctrl
,
1967 LDAPControl
**cctrl
));
1970 * LDAP Turn Extended Operation <draft-zeilenga-ldap-turn-xx.txt>
1973 #define LDAP_API_FEATURE_TURN 1000
1976 ldap_turn
LDAP_P(( LDAP
*ld
,
1978 LDAP_CONST
char* identifier
,
1979 LDAPControl
**sctrls
,
1980 LDAPControl
**cctrls
,
1984 ldap_turn_s
LDAP_P(( LDAP
*ld
,
1986 LDAP_CONST
char* identifier
,
1987 LDAPControl
**sctrl
,
1988 LDAPControl
**cctrl
));
1991 * LDAP Paged Results
1994 #define LDAP_API_FEATURE_PAGED_RESULTS 2000
1997 ldap_create_page_control_value
LDAP_P((
2000 struct berval
*cookie
,
2001 struct berval
*value
));
2004 ldap_create_page_control
LDAP_P((
2007 struct berval
*cookie
,
2009 LDAPControl
**ctrlp
));
2013 ldap_parse_page_control
LDAP_P((
2014 /* deprecated, use ldap_parse_pageresponse_control */
2016 LDAPControl
**ctrls
,
2018 struct berval
**cookie
));
2022 ldap_parse_pageresponse_control
LDAP_P((
2026 struct berval
*cookie
));
2029 * LDAP Server Side Sort
2032 #define LDAP_API_FEATURE_SERVER_SIDE_SORT 2000
2034 /* structure for a sort-key */
2035 typedef struct ldapsortkey
{
2036 char *attributeType
;
2042 ldap_create_sort_keylist
LDAP_P((
2043 LDAPSortKey
***sortKeyList
,
2047 ldap_free_sort_keylist
LDAP_P((
2048 LDAPSortKey
**sortkeylist
));
2051 ldap_create_sort_control_value
LDAP_P((
2053 LDAPSortKey
**keyList
,
2054 struct berval
*value
));
2057 ldap_create_sort_control
LDAP_P((
2059 LDAPSortKey
**keyList
,
2061 LDAPControl
**ctrlp
));
2064 ldap_parse_sortresponse_control
LDAP_P((
2068 char **attribute
));
2071 * LDAP Virtual List View
2074 #define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 2000
2076 /* structure for virtual list */
2077 typedef struct ldapvlvinfo
{
2078 ber_int_t ldvlv_version
;
2079 ber_int_t ldvlv_before_count
;
2080 ber_int_t ldvlv_after_count
;
2081 ber_int_t ldvlv_offset
;
2082 ber_int_t ldvlv_count
;
2083 struct berval
* ldvlv_attrvalue
;
2084 struct berval
* ldvlv_context
;
2085 void * ldvlv_extradata
;
2089 ldap_create_vlv_control_value
LDAP_P((
2091 LDAPVLVInfo
*ldvlistp
,
2092 struct berval
*value
));
2095 ldap_create_vlv_control
LDAP_P((
2097 LDAPVLVInfo
*ldvlistp
,
2098 LDAPControl
**ctrlp
));
2101 ldap_parse_vlvresponse_control
LDAP_P((
2104 ber_int_t
*target_posp
,
2105 ber_int_t
*list_countp
,
2106 struct berval
**contextp
,
2113 #define LDAP_API_FEATURE_WHOAMI 1000
2116 ldap_parse_whoami
LDAP_P((
2119 struct berval
**authzid
));
2122 ldap_whoami
LDAP_P(( LDAP
*ld
,
2123 LDAPControl
**sctrls
,
2124 LDAPControl
**cctrls
,
2128 ldap_whoami_s
LDAP_P((
2130 struct berval
**authzid
,
2131 LDAPControl
**sctrls
,
2132 LDAPControl
**cctrls
));
2135 * LDAP Password Modify
2138 #define LDAP_API_FEATURE_PASSWD_MODIFY 1000
2141 ldap_parse_passwd
LDAP_P((
2144 struct berval
*newpasswd
));
2147 ldap_passwd
LDAP_P(( LDAP
*ld
,
2148 struct berval
*user
,
2149 struct berval
*oldpw
,
2150 struct berval
*newpw
,
2151 LDAPControl
**sctrls
,
2152 LDAPControl
**cctrls
,
2156 ldap_passwd_s
LDAP_P((
2158 struct berval
*user
,
2159 struct berval
*oldpw
,
2160 struct berval
*newpw
,
2161 struct berval
*newpasswd
,
2162 LDAPControl
**sctrls
,
2163 LDAPControl
**cctrls
));
2165 #ifdef LDAP_CONTROL_PASSWORDPOLICYREQUEST
2167 * LDAP Password Policy controls
2170 #define LDAP_API_FEATURE_PASSWORD_POLICY 1000
2172 typedef enum passpolicyerror_enum
{
2173 PP_passwordExpired
= 0,
2174 PP_accountLocked
= 1,
2175 PP_changeAfterReset
= 2,
2176 PP_passwordModNotAllowed
= 3,
2177 PP_mustSupplyOldPassword
= 4,
2178 PP_insufficientPasswordQuality
= 5,
2179 PP_passwordTooShort
= 6,
2180 PP_passwordTooYoung
= 7,
2181 PP_passwordInHistory
= 8,
2183 } LDAPPasswordPolicyError
;
2186 ldap_create_passwordpolicy_control
LDAP_P((
2188 LDAPControl
**ctrlp
));
2191 ldap_parse_passwordpolicy_control
LDAP_P((
2196 LDAPPasswordPolicyError
*errorp
));
2198 LDAP_F( const char * )
2199 ldap_passwordpolicy_err2txt
LDAP_P(( LDAPPasswordPolicyError
));
2200 #endif /* LDAP_CONTROL_PASSWORDPOLICYREQUEST */
2203 * LDAP Dynamic Directory Services Refresh -- RFC 2589
2206 #define LDAP_API_FEATURE_REFRESH 1000
2209 ldap_parse_refresh
LDAP_P((
2212 ber_int_t
*newttl
));
2215 ldap_refresh
LDAP_P(( LDAP
*ld
,
2218 LDAPControl
**sctrls
,
2219 LDAPControl
**cctrls
,
2223 ldap_refresh_s
LDAP_P((
2228 LDAPControl
**sctrls
,
2229 LDAPControl
**cctrls
));
2236 ldap_txn_start
LDAP_P(( LDAP
*ld
,
2237 LDAPControl
**sctrls
,
2238 LDAPControl
**cctrls
,
2242 ldap_txn_start_s
LDAP_P(( LDAP
*ld
,
2243 LDAPControl
**sctrl
,
2244 LDAPControl
**cctrl
,
2245 struct berval
**rettxnid
));
2248 ldap_txn_end
LDAP_P(( LDAP
*ld
,
2250 struct berval
*txnid
,
2251 LDAPControl
**sctrls
,
2252 LDAPControl
**cctrls
,
2256 ldap_txn_end_s
LDAP_P(( LDAP
*ld
,
2258 struct berval
*txnid
,
2259 LDAPControl
**sctrl
,
2260 LDAPControl
**cctrl
,
2269 * initialize the persistent search structure
2271 LDAP_F( ldap_sync_t
* )
2272 ldap_sync_initialize
LDAP_P((
2276 * destroy the persistent search structure
2279 ldap_sync_destroy
LDAP_P((
2284 * initialize a refreshOnly sync
2287 ldap_sync_init
LDAP_P((
2292 * initialize a refreshOnly sync
2295 ldap_sync_init_refresh_only
LDAP_P((
2299 * initialize a refreshAndPersist sync
2302 ldap_sync_init_refresh_and_persist
LDAP_P((
2306 * poll for new responses
2309 ldap_sync_poll
LDAP_P((
2312 #ifdef LDAP_CONTROL_X_SESSION_TRACKING
2318 ldap_create_session_tracking_value
LDAP_P((
2320 char *sessionSourceIp
,
2321 char *sessionSourceName
,
2323 struct berval
*sessionTrackingIdentifier
,
2324 struct berval
*value
));
2327 ldap_create_session_tracking
LDAP_P((
2329 char *sessionSourceIp
,
2330 char *sessionSourceName
,
2332 struct berval
*sessionTrackingIdentifier
,
2333 LDAPControl
**ctrlp
));
2336 ldap_parse_session_tracking_control
LDAP_P((
2340 struct berval
*name
,
2342 struct berval
*id
));
2344 #endif /* LDAP_CONTROL_X_SESSION_TRACKING */
2350 ldap_create_assertion_control_value
LDAP_P((
2353 struct berval
*value
));
2356 ldap_create_assertion_control
LDAP_P((
2360 LDAPControl
**ctrlp
));
2363 #endif /* _LDAP_H */