Implement ldap_result.
[wine] / dlls / wldap32 / winldap_private.h
1 /*
2  * WLDAP32 - LDAP support for Wine
3  *
4  * Copyright 2005 Hans Leidekker
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * This is an internal version of winldap.h where constants, types and
21  * functions are prefixed with WLDAP32_ whenever they conflict with
22  * native headers.
23  */
24
25 typedef enum {
26     WLDAP32_LDAP_SERVER_DOWN             =   0x51,
27     WLDAP32_LDAP_LOCAL_ERROR             =   0x52,
28     WLDAP32_LDAP_ENCODING_ERROR          =   0x53,
29     WLDAP32_LDAP_DECODING_ERROR          =   0x54,
30     WLDAP32_LDAP_TIMEOUT                 =   0x55,
31     WLDAP32_LDAP_AUTH_UNKNOWN            =   0x56,
32     WLDAP32_LDAP_FILTER_ERROR            =   0x57,
33     WLDAP32_LDAP_USER_CANCELLED          =   0x58,
34     WLDAP32_LDAP_PARAM_ERROR             =   0x59,
35     WLDAP32_LDAP_NO_MEMORY               =   0x5a,
36     WLDAP32_LDAP_CONNECT_ERROR           =   0x5b,
37     WLDAP32_LDAP_NOT_SUPPORTED           =   0x5c,
38     WLDAP32_LDAP_NO_RESULTS_RETURNED     =   0x5e,
39     WLDAP32_LDAP_CONTROL_NOT_FOUND       =   0x5d,
40     WLDAP32_LDAP_MORE_RESULTS_TO_RETURN  =   0x5f,
41
42     WLDAP32_LDAP_CLIENT_LOOP             =   0x60,
43     WLDAP32_LDAP_REFERRAL_LIMIT_EXCEEDED =   0x61
44 } LDAP_RETCODE;
45
46 #define LDAP_OPT_THREAD_FN_PTRS         0x05
47 #define LDAP_OPT_REBIND_FN              0x06
48 #define LDAP_OPT_REBIND_ARG             0x07
49 #define LDAP_OPT_SSL                    0x0a
50 #define LDAP_OPT_IO_FN_PTRS             0x0b
51 #define LDAP_OPT_CACHE_FN_PTRS          0x0d
52 #define LDAP_OPT_CACHE_STRATEGY         0x0e
53 #define LDAP_OPT_CACHE_ENABLE           0x0f
54 #define LDAP_OPT_REFERRAL_HOP_LIMIT     0x10
55 #define LDAP_OPT_VERSION                0x11
56 #define LDAP_OPT_SERVER_ERROR           0x33
57 #define LDAP_OPT_SERVER_EXT_ERROR       0x34
58 #define LDAP_OPT_PING_KEEP_ALIVE        0x36
59 #define LDAP_OPT_PING_WAIT_TIME         0x37
60 #define LDAP_OPT_PING_LIMIT             0x38
61 #define LDAP_OPT_DNSDOMAIN_NAME         0x3b
62 #define LDAP_OPT_GETDSNAME_FLAGS        0x3d
63 #define LDAP_OPT_HOST_REACHABLE         0x3e
64 #define LDAP_OPT_PROMPT_CREDENTIALS     0x3f
65 #define LDAP_OPT_TCP_KEEPALIVE          0x40
66 #define LDAP_OPT_FAST_CONCURRENT_BIND   0x41
67 #define LDAP_OPT_SEND_TIMEOUT           0x42
68 #define LDAP_OPT_REFERRAL_CALLBACK      0x70
69 #define LDAP_OPT_CLIENT_CERTIFICATE     0x80
70 #define LDAP_OPT_SERVER_CERTIFICATE     0x81
71 #define LDAP_OPT_AUTO_RECONNECT         0x91
72 #define LDAP_OPT_SSPI_FLAGS             0x92
73 #define LDAP_OPT_SSL_INFO               0x93
74 #define LDAP_OPT_REF_DEREF_CONN_PER_MSG 0x94
75 #define LDAP_OPT_TLS                    LDAP_OPT_SSL
76 #define LDAP_OPT_TLS_INFO               LDAP_OPT_SSL_INFO
77 #define LDAP_OPT_SIGN                   0x95
78 #define LDAP_OPT_ENCRYPT                0x96
79 #define LDAP_OPT_SASL_METHOD            0x97
80 #define LDAP_OPT_AREC_EXCLUSIVE         0x98
81 #define LDAP_OPT_SECURITY_CONTEXT       0x99
82 #define LDAP_OPT_ROOTDSE_CACHE          0x9a
83
84 typedef struct ldap
85 {
86     struct
87     {
88         UINT_PTR sb_sd;
89         UCHAR Reserved1[41];
90         ULONG_PTR sb_naddr;
91         UCHAR Reserved2[24];
92     } ld_sb;
93
94     PCHAR ld_host;
95     ULONG ld_version;
96     UCHAR ld_lberoptions;
97     ULONG ld_deref;
98     ULONG ld_timelimit;
99     ULONG ld_sizelimit;
100     ULONG ld_errno;
101     PCHAR ld_matched;
102     PCHAR ld_error;
103     ULONG ld_msgid;
104     UCHAR Reserved3[25];
105     ULONG ld_cldaptries;
106     ULONG ld_cldaptimeout;
107     ULONG ld_refhoplimit;
108     ULONG ld_options;
109 } WLDAP32_LDAP, *WLDAP32_PLDAP;
110
111 typedef struct ldapmodA {
112     ULONG mod_op;
113     PCHAR mod_type;
114     union {
115         PCHAR *modv_strvals;
116         struct berval **modv_bvals;
117     } mod_vals;
118 } LDAPModA, *PLDAPModA;
119
120 typedef struct ldapmodW {
121     ULONG mod_op;
122     PWCHAR mod_type;
123     union {
124         PWCHAR *modv_strvals;
125         struct berval **modv_bvals;
126     } mod_vals;
127 } LDAPModW, *PLDAPModW;
128
129 typedef struct l_timeval
130 {
131     LONG tv_sec;
132     LONG tv_usec;
133 } LDAP_TIMEVAL, *PLDAP_TIMEVAL;
134
135 typedef struct ldapmsg
136 {
137     ULONG lm_msgid;
138     ULONG lm_msgtype;
139
140     PVOID lm_ber;
141
142     struct ldapmsg *lm_chain;
143     struct ldapmsg *lm_next;
144     ULONG lm_time;
145
146     WLDAP32_PLDAP Connection;
147     PVOID Request;
148     ULONG lm_returncode;
149     USHORT lm_referral;
150     BOOLEAN lm_chased;
151     BOOLEAN lm_eom;
152     BOOLEAN ConnectionReferenced;
153 } WLDAP32_LDAPMessage, *WLDAP32_PLDAPMessage;
154
155 #define LAPI_MAJOR_VER1     1
156 #define LAPI_MINOR_VER1     1
157
158 typedef struct ldap_version_info
159 {
160     ULONG lv_size;
161     ULONG lv_major;
162     ULONG lv_minor;
163 } LDAP_VERSION_INFO, *PLDAP_VERSION_INFO;
164
165 typedef struct WLDAP32_berval
166 {
167     ULONG bv_len;
168     PCHAR bv_val;
169 } LDAP_BERVAL, *PLDAP_BERVAL, BERVAL, *PBERVAL, WLDAP32_BerValue;
170
171 typedef struct ldapcontrolA
172 {
173     PCHAR ldctl_oid;
174     struct WLDAP32_berval ldctl_value;
175     BOOLEAN ldctl_iscritical;
176 } LDAPControlA, *PLDAPControlA;
177
178 typedef struct ldapcontrolW
179 {
180     PWCHAR ldctl_oid;
181     struct WLDAP32_berval ldctl_value;
182     BOOLEAN ldctl_iscritical;
183 } LDAPControlW, *PLDAPControlW;
184
185 typedef struct ldapsearch LDAPSearch, *PLDAPSearch;
186
187 typedef struct ldapsortkeyA
188 {
189     PCHAR sk_attrtype;
190     PCHAR sk_matchruleoid;
191     BOOLEAN sk_reverseorder;
192 } LDAPSortKeyA, *PLDAPSortKeyA;
193
194 typedef struct ldapsortkeyW
195 {
196     PWCHAR sk_attrtype;
197     PWCHAR sk_matchruleoid;
198     BOOLEAN sk_reverseorder;
199 } LDAPSortKeyW, *PLDAPSortKeyW;
200
201 typedef struct ldapapiinfoA
202 {
203     int ldapai_info_version;
204     int ldapai_api_version;
205     int ldapai_protocol_version;
206     char **ldapai_extensions;
207     char *ldapai_vendor_name;
208     int ldapai_vendor_version;
209 } LDAPAPIInfoA;
210
211 typedef struct ldapapiinfoW
212 {
213     int ldapai_info_version;
214     int ldapai_api_version;
215     int ldapai_protocol_version;
216     PWCHAR *ldapai_extensions;
217     PWCHAR ldapai_vendor_name;
218     int ldapai_vendor_version;
219 } LDAPAPIInfoW;
220
221 typedef struct ldap_apifeature_infoA
222 {
223     int ldapaif_info_version;
224     char *ldapaif_name;
225     int ldapaif_version;
226 } LDAPAPIFeatureInfoA;
227
228 typedef struct ldap_apifeature_infoW
229 {
230     int ldapaif_info_version;
231     PWCHAR ldapaif_name;
232     int ldapaif_version;
233 } LDAPAPIFeatureInfoW;
234
235 ULONG ldap_addA(WLDAP32_LDAP*,PCHAR,LDAPModA*[]);
236 ULONG ldap_addW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[]);
237 ULONG ldap_add_extA(WLDAP32_LDAP*,PCHAR,LDAPModA*[],PLDAPControlA*,PLDAPControlA*,ULONG*);
238 ULONG ldap_add_extW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[],PLDAPControlW*,PLDAPControlW*,ULONG*);
239 ULONG ldap_add_ext_sA(WLDAP32_LDAP*,PCHAR,LDAPModA*[],PLDAPControlA*,PLDAPControlA*);
240 ULONG ldap_add_ext_sW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[],PLDAPControlW*,PLDAPControlW*);
241 ULONG ldap_add_sA(WLDAP32_LDAP*,PCHAR,LDAPModA*[]);
242 ULONG ldap_add_sW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[]);
243 ULONG ldap_bindA(WLDAP32_LDAP*,PCHAR,PCHAR,ULONG);
244 ULONG ldap_bindW(WLDAP32_LDAP*,PWCHAR,PWCHAR,ULONG);
245 ULONG ldap_bind_sA(WLDAP32_LDAP*,PCHAR,PCHAR,ULONG);
246 ULONG ldap_bind_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR,ULONG);
247 ULONG ldap_compareA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR);
248 ULONG ldap_compareW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR);
249 ULONG ldap_compare_extA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR,struct WLDAP32_berval*,PLDAPControlA*,PLDAPControlA*,ULONG*);
250 ULONG ldap_compare_extW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR,struct WLDAP32_berval*,PLDAPControlW*,PLDAPControlW*,ULONG*);
251 ULONG ldap_compare_ext_sA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR,struct WLDAP32_berval*,PLDAPControlA*,PLDAPControlA*);
252 ULONG ldap_compare_ext_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR,struct WLDAP32_berval*,PLDAPControlW*,PLDAPControlW*);
253 ULONG ldap_compare_sA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR);
254 ULONG ldap_compare_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR);
255 ULONG ldap_deleteA(WLDAP32_LDAP*,PCHAR);
256 ULONG ldap_deleteW(WLDAP32_LDAP*,PWCHAR);
257 ULONG ldap_delete_extA(WLDAP32_LDAP*,PCHAR,PLDAPControlA*,PLDAPControlA*,ULONG*);
258 ULONG ldap_delete_extW(WLDAP32_LDAP*,PWCHAR,PLDAPControlW*,PLDAPControlW*,ULONG*);
259 ULONG ldap_delete_ext_sA(WLDAP32_LDAP*,PCHAR,PLDAPControlA*,PLDAPControlA*);
260 ULONG ldap_delete_ext_sW(WLDAP32_LDAP*,PWCHAR,PLDAPControlW*,PLDAPControlW*);
261 ULONG ldap_delete_sA(WLDAP32_LDAP*,PCHAR);
262 ULONG ldap_delete_sW(WLDAP32_LDAP*,PWCHAR);
263 PCHAR ldap_dn2ufnA(PCHAR);
264 PWCHAR ldap_dn2ufnW(PWCHAR);
265 PCHAR ldap_err2stringA(ULONG);
266 PWCHAR ldap_err2stringW(ULONG);
267 PCHAR *ldap_explode_dnA(PCHAR,ULONG);
268 PWCHAR *ldap_explode_dnW(PWCHAR,ULONG);
269 PCHAR ldap_get_dnA(WLDAP32_LDAP*,WLDAP32_LDAPMessage*);
270 PWCHAR ldap_get_dnW(WLDAP32_LDAP*,WLDAP32_LDAPMessage*);
271 ULONG ldap_get_optionA(WLDAP32_LDAP*,int,void*);
272 ULONG ldap_get_optionW(WLDAP32_LDAP*,int,void*);
273 WLDAP32_LDAP *ldap_initA(const PCHAR,ULONG);
274 WLDAP32_LDAP *ldap_initW(const PWCHAR,ULONG);
275 void ldap_memfreeA(PCHAR);
276 void ldap_memfreeW(PWCHAR);
277 ULONG ldap_modifyA(WLDAP32_LDAP*,PCHAR,LDAPModA*[]);
278 ULONG ldap_modifyW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[]);
279 ULONG ldap_modify_extA(WLDAP32_LDAP*,PCHAR,LDAPModA*[],PLDAPControlA*,PLDAPControlA*,ULONG*);
280 ULONG ldap_modify_extW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[],PLDAPControlW*,PLDAPControlW*,ULONG*);
281 ULONG ldap_modify_ext_sA(WLDAP32_LDAP*,PCHAR,LDAPModA*[],PLDAPControlA*,PLDAPControlA*);
282 ULONG ldap_modify_ext_sW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[],PLDAPControlW*,PLDAPControlW*);
283 ULONG ldap_modify_sA(WLDAP32_LDAP*,PCHAR,LDAPModA*[]);
284 ULONG ldap_modify_sW(WLDAP32_LDAP*,PWCHAR,LDAPModW*[]);
285 WLDAP32_LDAP *ldap_openA(PCHAR,ULONG);
286 WLDAP32_LDAP *ldap_openW(PWCHAR,ULONG);
287 void WLDAP32_ldap_perror(WLDAP32_LDAP*,const PCHAR);
288 ULONG WLDAP32_ldap_result(WLDAP32_LDAP*,ULONG,ULONG,struct l_timeval*,WLDAP32_LDAPMessage**);
289 ULONG WLDAP32_ldap_result2error(WLDAP32_LDAP*,WLDAP32_LDAPMessage*,ULONG);
290 ULONG ldap_sasl_bindA(WLDAP32_LDAP*,const PCHAR,const PCHAR,const BERVAL*,PLDAPControlA*,PLDAPControlA*,int*);
291 ULONG ldap_sasl_bindW(WLDAP32_LDAP*,const PWCHAR,const PWCHAR,const BERVAL*,PLDAPControlW*,PLDAPControlW*,int*);
292 ULONG ldap_sasl_bind_sA(WLDAP32_LDAP*,const PCHAR,const PCHAR,const BERVAL*,PLDAPControlA*,PLDAPControlA*,PBERVAL*);
293 ULONG ldap_sasl_bind_sW(WLDAP32_LDAP*,const PWCHAR,const PWCHAR,const BERVAL*,PLDAPControlW*,PLDAPControlW*,PBERVAL*);
294 ULONG ldap_searchA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG);
295 ULONG ldap_searchW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG);
296 ULONG ldap_search_extA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG,PLDAPControlA*,
297     PLDAPControlA*,ULONG,ULONG,ULONG*);
298 ULONG ldap_search_extW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG,PLDAPControlW*,
299     PLDAPControlW*,ULONG,ULONG,ULONG*);
300 ULONG ldap_search_ext_sA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG,PLDAPControlA*,
301     PLDAPControlA*,struct l_timeval*,ULONG,WLDAP32_LDAPMessage**);
302 ULONG ldap_search_ext_sW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG,PLDAPControlW*,
303     PLDAPControlW*,struct l_timeval*,ULONG,WLDAP32_LDAPMessage**);
304 ULONG ldap_search_sA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG,WLDAP32_LDAPMessage**);
305 ULONG ldap_search_sW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG,WLDAP32_LDAPMessage**);
306 ULONG ldap_search_stA(WLDAP32_LDAP*,const PCHAR,ULONG,const PCHAR,PCHAR[],ULONG,
307     struct l_timeval*,WLDAP32_LDAPMessage**);
308 ULONG ldap_search_stW(WLDAP32_LDAP*,const PWCHAR,ULONG,const PWCHAR,PWCHAR[],ULONG,
309     struct l_timeval*,WLDAP32_LDAPMessage**);
310 ULONG ldap_set_optionA(WLDAP32_LDAP*,int,void*);
311 ULONG ldap_set_optionW(WLDAP32_LDAP*,int,void*);
312 ULONG ldap_simple_bindA(WLDAP32_LDAP*,PCHAR,PCHAR);
313 ULONG ldap_simple_bindW(WLDAP32_LDAP*,PWCHAR,PWCHAR);
314 ULONG ldap_simple_bind_sA(WLDAP32_LDAP*,PCHAR,PCHAR);
315 ULONG ldap_simple_bind_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR);
316 ULONG ldap_start_tls_sA(WLDAP32_PLDAP,PULONG,WLDAP32_LDAPMessage**,PLDAPControlA*,PLDAPControlA*);
317 ULONG ldap_start_tls_sW(WLDAP32_PLDAP,PULONG,WLDAP32_LDAPMessage**,PLDAPControlW*,PLDAPControlW*);
318 ULONG ldap_ufn2dnA(PCHAR,PCHAR*);
319 ULONG ldap_ufn2dnW(PWCHAR,PWCHAR*);
320 ULONG WLDAP32_ldap_unbind(WLDAP32_LDAP*);
321 ULONG WLDAP32_ldap_unbind_s(WLDAP32_LDAP*);
322 ULONG ldap_value_freeA(PCHAR*);
323 ULONG ldap_value_freeW(PWCHAR*);
324
325 ULONG LdapGetLastError(void);
326 ULONG LdapMapErrorToWin32(ULONG);
327 int LdapUnicodeToUTF8(LPCWSTR,int,LPSTR,int);
328 int LdapUTF8ToUnicode(LPCSTR,int,LPWSTR,int);