dll/win32/winhttp/winhttp_private.h

   1 /*
   2  * Copyright 2008 Hans Leidekker for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef _WINE_WINHTTP_PRIVATE_H_
  20 #define _WINE_WINHTTP_PRIVATE_H_
  21
  22 #include <wine/config.h>
  23
  24 #include <stdarg.h>
  25
  26 #define WIN32_NO_STATUS
  27 #define _INC_WINDOWS
  28 #define COM_NO_WINDOWS_H
  29
  30 #define COBJMACROS
  31 #define NONAMELESSUNION
  32
  33 #include <windef.h>
  34 #include <winbase.h>
  35 #include <objbase.h>
  36 #include <oleauto.h>
  37 #include <winsock2.h>
  38 #include <winhttp.h>
  39
  40 #include <wine/list.h>
  41 #include <wine/unicode.h>
  42
  43 #ifdef HAVE_SYS_SOCKET_H
  44 # include <sys/socket.h>
  45 #endif
  46 #ifdef HAVE_NETINET_IN_H
  47 # include <netinet/in.h>
  48 #endif
  49 #ifdef HAVE_NETDB_H
  50 # include <netdb.h>
  51 #endif
  52 #if defined(__MINGW32__) || defined (_MSC_VER)
  53 # include <ws2tcpip.h>
  54 #else
  55 # define closesocket close
  56 # define ioctlsocket ioctl
  57 #endif
  58
  59 #include <sspi.h>
  60
  61 #include <wine/debug.h>
  62 WINE_DEFAULT_DEBUG_CHANNEL(winhttp);
  63
  64 static const WCHAR getW[]    = {'G','E','T',0};
  65 static const WCHAR postW[]   = {'P','O','S','T',0};
  66 static const WCHAR headW[]   = {'H','E','A','D',0};
  67 static const WCHAR slashW[]  = {'/',0};
  68 static const WCHAR http1_0[] = {'H','T','T','P','/','1','.','0',0};
  69 static const WCHAR http1_1[] = {'H','T','T','P','/','1','.','1',0};
  70 static const WCHAR chunkedW[] = {'c','h','u','n','k','e','d',0};
  71
  72 typedef struct _object_header_t object_header_t;
  73
  74 typedef struct
  75 {
  76     void (*destroy)( object_header_t * );
  77     BOOL (*query_option)( object_header_t *, DWORD, void *, DWORD * );
  78     BOOL (*set_option)( object_header_t *, DWORD, void *, DWORD );
  79 } object_vtbl_t;
  80
  81 struct _object_header_t
  82 {
  83     DWORD type;
  84     HINTERNET handle;
  85     const object_vtbl_t *vtbl;
  86     DWORD flags;
  87     DWORD disable_flags;
  88     DWORD logon_policy;
  89     DWORD redirect_policy;
  90     DWORD error;
  91     DWORD_PTR context;
  92     LONG refs;
  93     WINHTTP_STATUS_CALLBACK callback;
  94     DWORD notify_mask;
  95     struct list entry;
  96     struct list children;
  97 };
  98
  99 typedef struct
 100 {
 101     struct list entry;
 102     WCHAR *name;
 103     struct list cookies;
 104 } domain_t;
 105
 106 typedef struct
 107 {
 108     struct list entry;
 109     WCHAR *name;
 110     WCHAR *value;
 111     WCHAR *path;
 112 } cookie_t;
 113
 114 typedef struct
 115 {
 116     object_header_t hdr;
 117     LPWSTR agent;
 118     DWORD access;
 119     int resolve_timeout;
 120     int connect_timeout;
 121     int send_timeout;
 122     int recv_timeout;
 123     LPWSTR proxy_server;
 124     LPWSTR proxy_bypass;
 125     LPWSTR proxy_username;
 126     LPWSTR proxy_password;
 127     struct list cookie_cache;
 128 } session_t;
 129
 130 typedef struct
 131 {
 132     object_header_t hdr;
 133     session_t *session;
 134     LPWSTR hostname;    /* final destination of the request */
 135     LPWSTR servername;  /* name of the server we directly connect to */
 136     LPWSTR username;
 137     LPWSTR password;
 138     INTERNET_PORT hostport;
 139     INTERNET_PORT serverport;
 140     struct sockaddr_storage sockaddr;
 141     BOOL resolved;
 142 } connect_t;
 143
 144 typedef struct
 145 {
 146     int socket;
 147     BOOL secure; /* SSL active on connection? */
 148     CtxtHandle ssl_ctx;
 149     SecPkgContext_StreamSizes ssl_sizes;
 150     char *ssl_buf;
 151     char *extra_buf;
 152     size_t extra_len;
 153     char *peek_msg;
 154     char *peek_msg_mem;
 155     size_t peek_len;
 156     DWORD security_flags;
 157 } netconn_t;
 158
 159 typedef struct
 160 {
 161     LPWSTR field;
 162     LPWSTR value;
 163     BOOL is_request; /* part of request headers? */
 164 } header_t;
 165
 166 enum auth_scheme
 167 {
 168     SCHEME_INVALID = -1,
 169     SCHEME_BASIC,
 170     SCHEME_NTLM,
 171     SCHEME_PASSPORT,
 172     SCHEME_DIGEST,
 173     SCHEME_NEGOTIATE
 174 };
 175
 176 struct authinfo
 177 {
 178     enum auth_scheme scheme;
 179     CredHandle cred;
 180     CtxtHandle ctx;
 181     TimeStamp exp;
 182     ULONG attr;
 183     ULONG max_token;
 184     char *data;
 185     unsigned int data_len;
 186     BOOL finished; /* finished authenticating */
 187 };
 188
 189 typedef struct
 190 {
 191     object_header_t hdr;
 192     connect_t *connect;
 193     LPWSTR verb;
 194     LPWSTR path;
 195     LPWSTR version;
 196     LPWSTR raw_headers;
 197     void *optional;
 198     DWORD optional_len;
 199     netconn_t netconn;
 200     int resolve_timeout;
 201     int connect_timeout;
 202     int send_timeout;
 203     int recv_timeout;
 204     LPWSTR status_text;
 205     DWORD content_length; /* total number of bytes to be read (per chunk) */
 206     DWORD content_read;   /* bytes read so far */
 207     BOOL  read_chunked;   /* are we reading in chunked mode? */
 208     DWORD read_pos;       /* current read position in read_buf */
 209     DWORD read_size;      /* valid data size in read_buf */
 210     char  read_buf[4096]; /* buffer for already read but not returned data */
 211     header_t *headers;
 212     DWORD num_headers;
 213     WCHAR **accept_types;
 214     DWORD num_accept_types;
 215     struct authinfo *authinfo;
 216     struct authinfo *proxy_authinfo;
 217 } request_t;
 218
 219 typedef struct _task_header_t task_header_t;
 220
 221 struct _task_header_t
 222 {
 223     request_t *request;
 224     void (*proc)( task_header_t * );
 225 };
 226
 227 typedef struct
 228 {
 229     task_header_t hdr;
 230     LPWSTR headers;
 231     DWORD headers_len;
 232     LPVOID optional;
 233     DWORD optional_len;
 234     DWORD total_len;
 235     DWORD_PTR context;
 236 } send_request_t;
 237
 238 typedef struct
 239 {
 240     task_header_t hdr;
 241 } receive_response_t;
 242
 243 typedef struct
 244 {
 245     task_header_t hdr;
 246     LPDWORD available;
 247 } query_data_t;
 248
 249 typedef struct
 250 {
 251     task_header_t hdr;
 252     LPVOID buffer;
 253     DWORD to_read;
 254     LPDWORD read;
 255 } read_data_t;
 256
 257 typedef struct
 258 {
 259     task_header_t hdr;
 260     LPCVOID buffer;
 261     DWORD to_write;
 262     LPDWORD written;
 263 } write_data_t;
 264
 265 object_header_t *addref_object( object_header_t * ) DECLSPEC_HIDDEN;
 266 object_header_t *grab_object( HINTERNET ) DECLSPEC_HIDDEN;
 267 void release_object( object_header_t * ) DECLSPEC_HIDDEN;
 268 HINTERNET alloc_handle( object_header_t * ) DECLSPEC_HIDDEN;
 269 BOOL free_handle( HINTERNET ) DECLSPEC_HIDDEN;
 270
 271 void set_last_error( DWORD ) DECLSPEC_HIDDEN;
 272 DWORD get_last_error( void ) DECLSPEC_HIDDEN;
 273 void send_callback( object_header_t *, DWORD, LPVOID, DWORD ) DECLSPEC_HIDDEN;
 274 void close_connection( request_t * ) DECLSPEC_HIDDEN;
 275
 276 BOOL netconn_close( netconn_t * ) DECLSPEC_HIDDEN;
 277 BOOL netconn_connect( netconn_t *, const struct sockaddr *, unsigned int, int ) DECLSPEC_HIDDEN;
 278 BOOL netconn_connected( netconn_t * ) DECLSPEC_HIDDEN;
 279 BOOL netconn_create( netconn_t *, int, int, int ) DECLSPEC_HIDDEN;
 280 BOOL netconn_init( netconn_t * ) DECLSPEC_HIDDEN;
 281 void netconn_unload( void ) DECLSPEC_HIDDEN;
 282 BOOL netconn_query_data_available( netconn_t *, DWORD * ) DECLSPEC_HIDDEN;
 283 BOOL netconn_recv( netconn_t *, void *, size_t, int, int * ) DECLSPEC_HIDDEN;
 284 BOOL netconn_resolve( WCHAR *, INTERNET_PORT, struct sockaddr *, socklen_t *, int ) DECLSPEC_HIDDEN;
 285 BOOL netconn_secure_connect( netconn_t *, WCHAR * ) DECLSPEC_HIDDEN;
 286 BOOL netconn_send( netconn_t *, const void *, size_t, int * ) DECLSPEC_HIDDEN;
 287 DWORD netconn_set_timeout( netconn_t *, BOOL, int ) DECLSPEC_HIDDEN;
 288 const void *netconn_get_certificate( netconn_t * ) DECLSPEC_HIDDEN;
 289 int netconn_get_cipher_strength( netconn_t * ) DECLSPEC_HIDDEN;
 290
 291 BOOL set_cookies( request_t *, const WCHAR * ) DECLSPEC_HIDDEN;
 292 BOOL add_cookie_headers( request_t * ) DECLSPEC_HIDDEN;
 293 BOOL add_request_headers( request_t *, LPCWSTR, DWORD, DWORD ) DECLSPEC_HIDDEN;
 294 void delete_domain( domain_t * ) DECLSPEC_HIDDEN;
 295 BOOL set_server_for_hostname( connect_t *, LPCWSTR, INTERNET_PORT ) DECLSPEC_HIDDEN;
 296 void destroy_authinfo( struct authinfo * ) DECLSPEC_HIDDEN;
 297
 298 extern HRESULT WinHttpRequest_create( IUnknown *, void ** ) DECLSPEC_HIDDEN;
 299
 300 static inline const char *debugstr_variant( const VARIANT *v )
 301 {
 302     if (!v) return "(null)";
 303     switch (V_VT(v))
 304     {
 305     case VT_EMPTY:
 306         return "{VT_EMPTY}";
 307     case VT_NULL:
 308         return "{VT_NULL}";
 309     case VT_I4:
 310         return wine_dbg_sprintf( "{VT_I4: %d}", V_I4(v) );
 311     case VT_R8:
 312         return wine_dbg_sprintf( "{VT_R8: %lf}", V_R8(v) );
 313     case VT_BSTR:
 314         return wine_dbg_sprintf( "{VT_BSTR: %s}", debugstr_w(V_BSTR(v)) );
 315     case VT_DISPATCH:
 316         return wine_dbg_sprintf( "{VT_DISPATCH: %p}", V_DISPATCH(v) );
 317     case VT_BOOL:
 318         return wine_dbg_sprintf( "{VT_BOOL: %x}", V_BOOL(v) );
 319     case VT_UNKNOWN:
 320         return wine_dbg_sprintf( "{VT_UNKNOWN: %p}", V_UNKNOWN(v) );
 321     case VT_UINT:
 322         return wine_dbg_sprintf( "{VT_UINT: %u}", V_UINT(v) );
 323     case VT_BSTR|VT_BYREF:
 324         return wine_dbg_sprintf( "{VT_BSTR|VT_BYREF: ptr %p, data %s}",
 325             V_BSTRREF(v), V_BSTRREF(v) ? debugstr_w( *V_BSTRREF(v) ) : NULL );
 326     default:
 327         return wine_dbg_sprintf( "{vt %d}", V_VT(v) );
 328     }
 329 }
 330
 331 static inline void *heap_alloc( SIZE_T size )
 332 {
 333     return HeapAlloc( GetProcessHeap(), 0, size );
 334 }
 335
 336 static inline void *heap_alloc_zero( SIZE_T size )
 337 {
 338     return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, size );
 339 }
 340
 341 static inline void *heap_realloc( LPVOID mem, SIZE_T size )
 342 {
 343     return HeapReAlloc( GetProcessHeap(), 0, mem, size );
 344 }
 345
 346 static inline void *heap_realloc_zero( LPVOID mem, SIZE_T size )
 347 {
 348     return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, size );
 349 }
 350
 351 static inline BOOL heap_free( LPVOID mem )
 352 {
 353     return HeapFree( GetProcessHeap(), 0, mem );
 354 }
 355
 356 static inline WCHAR *strdupW( const WCHAR *src )
 357 {
 358     WCHAR *dst;
 359
 360     if (!src) return NULL;
 361     dst = heap_alloc( (strlenW( src ) + 1) * sizeof(WCHAR) );
 362     if (dst) strcpyW( dst, src );
 363     return dst;
 364 }
 365
 366 static inline WCHAR *strdupAW( const char *src )
 367 {
 368     WCHAR *dst = NULL;
 369     if (src)
 370     {
 371         DWORD len = MultiByteToWideChar( CP_ACP, 0, src, -1, NULL, 0 );
 372         if ((dst = heap_alloc( len * sizeof(WCHAR) )))
 373             MultiByteToWideChar( CP_ACP, 0, src, -1, dst, len );
 374     }
 375     return dst;
 376 }
 377
 378 static inline char *strdupWA( const WCHAR *src )
 379 {
 380     char *dst = NULL;
 381     if (src)
 382     {
 383         int len = WideCharToMultiByte( CP_ACP, 0, src, -1, NULL, 0, NULL, NULL );
 384         if ((dst = heap_alloc( len )))
 385             WideCharToMultiByte( CP_ACP, 0, src, -1, dst, len, NULL, NULL );
 386     }
 387     return dst;
 388 }
 389
 390 #endif /* _WINE_WINHTTP_PRIVATE_H_ */