Add helpers for converting (arrays of) LDAPSortKey, LDAPAPIInfo, and
[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 l_timeval
112 {
113     LONG tv_sec;
114     LONG tv_usec;
115 } LDAP_TIMEVAL, *PLDAP_TIMEVAL;
116
117 typedef struct ldapmsg
118 {
119     ULONG lm_msgid;
120     ULONG lm_msgtype;
121
122     PVOID lm_ber;
123
124     struct ldapmsg *lm_chain;
125     struct ldapmsg *lm_next;
126     ULONG lm_time;
127
128     WLDAP32_PLDAP Connection;
129     PVOID Request;
130     ULONG lm_returncode;
131     USHORT lm_referral;
132     BOOLEAN lm_chased;
133     BOOLEAN lm_eom;
134     BOOLEAN ConnectionReferenced;
135 } WLDAP32_LDAPMessage, *WLDAP32_PLDAPMessage;
136
137 typedef struct WLDAP32_berval
138 {
139     ULONG bv_len;
140     PCHAR bv_val;
141 } LDAP_BERVAL, *PLDAP_BERVAL, BERVAL, *PBERVAL, WLDAP32_BerValue;
142
143 typedef struct ldapcontrolA
144 {
145     PCHAR ldctl_oid;
146     struct WLDAP32_berval ldctl_value;
147     BOOLEAN ldctl_iscritical;
148 } LDAPControlA, *PLDAPControlA;
149
150 typedef struct ldapcontrolW
151 {
152     PWCHAR ldctl_oid;
153     struct WLDAP32_berval ldctl_value;
154     BOOLEAN ldctl_iscritical;
155 } LDAPControlW, *PLDAPControlW;
156
157 typedef struct ldapsortkeyA
158 {
159     PCHAR sk_attrtype;
160     PCHAR sk_matchruleoid;
161     BOOLEAN sk_reverseorder;
162 } LDAPSortKeyA, *PLDAPSortKeyA;
163
164 typedef struct ldapsortkeyW
165 {
166     PWCHAR sk_attrtype;
167     PWCHAR sk_matchruleoid;
168     BOOLEAN sk_reverseorder;
169 } LDAPSortKeyW, *PLDAPSortKeyW;
170
171 typedef struct ldapapiinfoA
172 {
173     int ldapai_info_version;
174     int ldapai_api_version;
175     int ldapai_protocol_version;
176     char **ldapai_extensions;
177     char *ldapai_vendor_name;
178     int ldapai_vendor_version;
179 } LDAPAPIInfoA;
180
181 typedef struct ldapapiinfoW
182 {
183     int ldapai_info_version;
184     int ldapai_api_version;
185     int ldapai_protocol_version;
186     PWCHAR *ldapai_extensions;
187     PWCHAR ldapai_vendor_name;
188     int ldapai_vendor_version;
189 } LDAPAPIInfoW;
190
191 typedef struct ldap_apifeature_infoA
192 {
193     int ldapaif_info_version;
194     char *ldapaif_name;
195     int ldapaif_version;
196 } LDAPAPIFeatureInfoA;
197
198 typedef struct ldap_apifeature_infoW
199 {
200     int ldapaif_info_version;
201     PWCHAR ldapaif_name;
202     int ldapaif_version;
203 } LDAPAPIFeatureInfoW;
204
205 ULONG ldap_bindA(WLDAP32_LDAP*,PCHAR,PCHAR,ULONG);
206 ULONG ldap_bindW(WLDAP32_LDAP*,PWCHAR,PWCHAR,ULONG);
207 ULONG ldap_bind_sA(WLDAP32_LDAP*,PCHAR,PCHAR,ULONG);
208 ULONG ldap_bind_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR,ULONG);
209 ULONG ldap_compareA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR);
210 ULONG ldap_compareW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR);
211 ULONG ldap_compare_extA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR,struct WLDAP32_berval*,PLDAPControlA*,PLDAPControlA*,ULONG*);
212 ULONG ldap_compare_extW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR,struct WLDAP32_berval*,PLDAPControlW*,PLDAPControlW*,ULONG*);
213 ULONG ldap_compare_ext_sA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR,struct WLDAP32_berval*,PLDAPControlA*,PLDAPControlA*);
214 ULONG ldap_compare_ext_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR,struct WLDAP32_berval*,PLDAPControlW*,PLDAPControlW*);
215 ULONG ldap_compare_sA(WLDAP32_LDAP*,PCHAR,PCHAR,PCHAR);
216 ULONG ldap_compare_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR,PWCHAR);
217 PCHAR ldap_dn2ufnA(PCHAR);
218 PWCHAR ldap_dn2ufnW(PWCHAR);
219 PCHAR ldap_err2stringA(ULONG);
220 PWCHAR ldap_err2stringW(ULONG);
221 PCHAR *ldap_explode_dnA(PCHAR,ULONG);
222 PWCHAR *ldap_explode_dnW(PWCHAR,ULONG);
223 PCHAR ldap_get_dnA(WLDAP32_LDAP*,WLDAP32_LDAPMessage*);
224 PWCHAR ldap_get_dnW(WLDAP32_LDAP*,WLDAP32_LDAPMessage*);
225 ULONG ldap_get_optionA(WLDAP32_LDAP*,int,void*);
226 ULONG ldap_get_optionW(WLDAP32_LDAP*,int,void*);
227 WLDAP32_LDAP *ldap_initA(const PCHAR,ULONG);
228 WLDAP32_LDAP *ldap_initW(const PWCHAR,ULONG);
229 void ldap_memfreeA(PCHAR);
230 void ldap_memfreeW(PWCHAR);
231 WLDAP32_LDAP *ldap_openA(PCHAR,ULONG);
232 WLDAP32_LDAP *ldap_openW(PWCHAR,ULONG);
233 void WLDAP32_ldap_perror(WLDAP32_LDAP*,const PCHAR);
234 ULONG WLDAP32_ldap_result2error(WLDAP32_LDAP*,WLDAP32_LDAPMessage*,ULONG);
235 ULONG ldap_sasl_bindA(WLDAP32_LDAP*,const PCHAR,const PCHAR,const BERVAL*,PLDAPControlA*,PLDAPControlA*,int*);
236 ULONG ldap_sasl_bindW(WLDAP32_LDAP*,const PWCHAR,const PWCHAR,const BERVAL*,PLDAPControlW*,PLDAPControlW*,int*);
237 ULONG ldap_sasl_bind_sA(WLDAP32_LDAP*,const PCHAR,const PCHAR,const BERVAL*,PLDAPControlA*,PLDAPControlA*,PBERVAL*);
238 ULONG ldap_sasl_bind_sW(WLDAP32_LDAP*,const PWCHAR,const PWCHAR,const BERVAL*,PLDAPControlW*,PLDAPControlW*,PBERVAL*);
239 ULONG ldap_searchA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG);
240 ULONG ldap_searchW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG);
241 ULONG ldap_search_extA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG,PLDAPControlA*,
242     PLDAPControlA*,ULONG,ULONG,ULONG*);
243 ULONG ldap_search_extW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG,PLDAPControlW*,
244     PLDAPControlW*,ULONG,ULONG,ULONG*);
245 ULONG ldap_search_ext_sA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG,PLDAPControlA*,
246     PLDAPControlA*,struct l_timeval*,ULONG,WLDAP32_LDAPMessage**);
247 ULONG ldap_search_ext_sW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG,PLDAPControlW*,
248     PLDAPControlW*,struct l_timeval*,ULONG,WLDAP32_LDAPMessage**);
249 ULONG ldap_search_sA(WLDAP32_LDAP*,PCHAR,ULONG,PCHAR,PCHAR[],ULONG,WLDAP32_LDAPMessage**);
250 ULONG ldap_search_sW(WLDAP32_LDAP*,PWCHAR,ULONG,PWCHAR,PWCHAR[],ULONG,WLDAP32_LDAPMessage**);
251 ULONG ldap_search_stA(WLDAP32_LDAP*,const PCHAR,ULONG,const PCHAR,PCHAR[],ULONG,
252     struct l_timeval*,WLDAP32_LDAPMessage**);
253 ULONG ldap_search_stW(WLDAP32_LDAP*,const PWCHAR,ULONG,const PWCHAR,PWCHAR[],ULONG,
254     struct l_timeval*,WLDAP32_LDAPMessage**);
255 ULONG ldap_set_optionA(WLDAP32_LDAP*,int,void*);
256 ULONG ldap_set_optionW(WLDAP32_LDAP*,int,void*);
257 ULONG ldap_simple_bindA(WLDAP32_LDAP*,PCHAR,PCHAR);
258 ULONG ldap_simple_bindW(WLDAP32_LDAP*,PWCHAR,PWCHAR);
259 ULONG ldap_simple_bind_sA(WLDAP32_LDAP*,PCHAR,PCHAR);
260 ULONG ldap_simple_bind_sW(WLDAP32_LDAP*,PWCHAR,PWCHAR);
261 ULONG ldap_start_tls_sA(WLDAP32_PLDAP,PULONG,WLDAP32_LDAPMessage**,PLDAPControlA*,PLDAPControlA*);
262 ULONG ldap_start_tls_sW(WLDAP32_PLDAP,PULONG,WLDAP32_LDAPMessage**,PLDAPControlW*,PLDAPControlW*);
263 ULONG ldap_ufn2dnA(PCHAR,PCHAR*);
264 ULONG ldap_ufn2dnW(PWCHAR,PWCHAR*);
265 ULONG WLDAP32_ldap_unbind(WLDAP32_LDAP*);
266 ULONG WLDAP32_ldap_unbind_s(WLDAP32_LDAP*);
267 ULONG ldap_value_freeA(PCHAR*);
268 ULONG ldap_value_freeW(PWCHAR*);
269
270 ULONG LdapGetLastError(void);
271 ULONG LdapMapErrorToWin32(ULONG);
272 int LdapUnicodeToUTF8(LPCWSTR,int,LPSTR,int);
273 int LdapUTF8ToUnicode(LPCSTR,int,LPWSTR,int);