dlls/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 #ifndef __WINE_CONFIG_H
  23 # error You must include config.h to use this header
  24 #endif
  25
  26 #include "wine/list.h"
  27 #include "wine/unicode.h"
  28
  29 #include <sys/types.h>
  30 #ifdef HAVE_SYS_SOCKET_H
  31 # include <sys/socket.h>
  32 #endif
  33 #ifdef HAVE_NETINET_IN_H
  34 # include <netinet/in.h>
  35 #endif
  36 #ifdef HAVE_NETDB_H
  37 # include <netdb.h>
  38 #endif
  39 #if defined(__MINGW32__) || defined (_MSC_VER)
  40 # include <ws2tcpip.h>
  41 #else
  42 # define closesocket close
  43 # define ioctlsocket ioctl
  44 #endif
  45
  46 #include "ole2.h"
  47 #include "sspi.h"
  48
  49 static const WCHAR getW[]    = {'G','E','T',0};
  50 static const WCHAR postW[]   = {'P','O','S','T',0};
  51 static const WCHAR headW[]   = {'H','E','A','D',0};
  52 static const WCHAR slashW[]  = {'/',0};
  53 static const WCHAR http1_0[] = {'H','T','T','P','/','1','.','0',0};
  54 static const WCHAR http1_1[] = {'H','T','T','P','/','1','.','1',0};
  55 static const WCHAR chunkedW[] = {'c','h','u','n','k','e','d',0};
  56
  57 typedef struct _object_header_t object_header_t;
  58
  59 typedef struct
  60 {
  61     void (*destroy)( object_header_t * );
  62     BOOL (*query_option)( object_header_t *, DWORD, void *, DWORD * );
  63     BOOL (*set_option)( object_header_t *, DWORD, void *, DWORD );
  64 } object_vtbl_t;
  65
  66 struct _object_header_t
  67 {
  68     DWORD type;
  69     HINTERNET handle;
  70     const object_vtbl_t *vtbl;
  71     DWORD flags;
  72     DWORD disable_flags;
  73     DWORD logon_policy;
  74     DWORD redirect_policy;
  75     DWORD error;
  76     DWORD_PTR context;
  77     LONG refs;
  78     WINHTTP_STATUS_CALLBACK callback;
  79     DWORD notify_mask;
  80     struct list entry;
  81     struct list children;
  82 };
  83
  84 typedef struct
  85 {
  86     struct list entry;
  87     WCHAR *name;
  88     struct list cookies;
  89 } domain_t;
  90
  91 typedef struct
  92 {
  93     struct list entry;
  94     WCHAR *name;
  95     WCHAR *value;
  96     WCHAR *path;
  97 } cookie_t;
  98
  99 typedef struct
 100 {
 101     object_header_t hdr;
 102     LPWSTR agent;
 103     DWORD access;
 104     int resolve_timeout;
 105     int connect_timeout;
 106     int send_timeout;
 107     int recv_timeout;
 108     LPWSTR proxy_server;
 109     LPWSTR proxy_bypass;
 110     LPWSTR proxy_username;
 111     LPWSTR proxy_password;
 112     struct list cookie_cache;
 113     HANDLE unload_event;
 114 } session_t;
 115
 116 typedef struct
 117 {
 118     object_header_t hdr;
 119     session_t *session;
 120     LPWSTR hostname;    /* final destination of the request */
 121     LPWSTR servername;  /* name of the server we directly connect to */
 122     LPWSTR username;
 123     LPWSTR password;
 124     INTERNET_PORT hostport;
 125     INTERNET_PORT serverport;
 126     struct sockaddr_storage sockaddr;
 127     BOOL resolved;
 128 } connect_t;
 129
 130 typedef struct
 131 {
 132     int socket;
 133     BOOL secure; /* SSL active on connection? */
 134     CtxtHandle ssl_ctx;
 135     SecPkgContext_StreamSizes ssl_sizes;
 136     char *ssl_buf;
 137     char *extra_buf;
 138     size_t extra_len;
 139     char *peek_msg;
 140     char *peek_msg_mem;
 141     size_t peek_len;
 142     DWORD security_flags;
 143 } netconn_t;
 144
 145 typedef struct
 146 {
 147     LPWSTR field;
 148     LPWSTR value;
 149     BOOL is_request; /* part of request headers? */
 150 } header_t;
 151
 152 enum auth_target
 153 {
 154     TARGET_INVALID = -1,
 155     TARGET_SERVER,
 156     TARGET_PROXY,
 157     TARGET_MAX
 158 };
 159
 160 enum auth_scheme
 161 {
 162     SCHEME_INVALID = -1,
 163     SCHEME_BASIC,
 164     SCHEME_NTLM,
 165     SCHEME_PASSPORT,
 166     SCHEME_DIGEST,
 167     SCHEME_NEGOTIATE,
 168     SCHEME_MAX
 169 };
 170
 171 struct authinfo
 172 {
 173     enum auth_scheme scheme;
 174     CredHandle cred;
 175     CtxtHandle ctx;
 176     TimeStamp exp;
 177     ULONG attr;
 178     ULONG max_token;
 179     char *data;
 180     unsigned int data_len;
 181     BOOL finished; /* finished authenticating */
 182 };
 183
 184 typedef struct
 185 {
 186     object_header_t hdr;
 187     connect_t *connect;
 188     LPWSTR verb;
 189     LPWSTR path;
 190     LPWSTR version;
 191     LPWSTR raw_headers;
 192     void *optional;
 193     DWORD optional_len;
 194     netconn_t netconn;
 195     int resolve_timeout;
 196     int connect_timeout;
 197     int send_timeout;
 198     int recv_timeout;
 199     LPWSTR status_text;
 200     DWORD content_length; /* total number of bytes to be read */
 201     DWORD content_read;   /* bytes read so far */
 202     BOOL  read_chunked;   /* are we reading in chunked mode? */
 203     BOOL  read_chunked_eof;  /* end of stream in chunked mode */
 204     BOOL  read_chunked_size; /* chunk size remaining */
 205     DWORD read_pos;       /* current read position in read_buf */
 206     DWORD read_size;      /* valid data size in read_buf */
 207     char  read_buf[8192]; /* buffer for already read but not returned data */
 208     header_t *headers;
 209     DWORD num_headers;
 210     WCHAR **accept_types;
 211     DWORD num_accept_types;
 212     struct authinfo *authinfo;
 213     struct authinfo *proxy_authinfo;
 214     HANDLE task_wait;
 215     HANDLE task_cancel;
 216     HANDLE task_thread;
 217     struct list task_queue;
 218     CRITICAL_SECTION task_cs;
 219     struct
 220     {
 221         WCHAR *username;
 222         WCHAR *password;
 223     } creds[TARGET_MAX][SCHEME_MAX];
 224 } request_t;
 225
 226 typedef struct _task_header_t task_header_t;
 227
 228 struct _task_header_t
 229 {
 230     struct list entry;
 231     request_t *request;
 232     void (*proc)( task_header_t * );
 233 };
 234
 235 typedef struct
 236 {
 237     task_header_t hdr;
 238     LPWSTR headers;
 239     DWORD headers_len;
 240     LPVOID optional;
 241     DWORD optional_len;
 242     DWORD total_len;
 243     DWORD_PTR context;
 244 } send_request_t;
 245
 246 typedef struct
 247 {
 248     task_header_t hdr;
 249 } receive_response_t;
 250
 251 typedef struct
 252 {
 253     task_header_t hdr;
 254     LPDWORD available;
 255 } query_data_t;
 256
 257 typedef struct
 258 {
 259     task_header_t hdr;
 260     LPVOID buffer;
 261     DWORD to_read;
 262     LPDWORD read;
 263 } read_data_t;
 264
 265 typedef struct
 266 {
 267     task_header_t hdr;
 268     LPCVOID buffer;
 269     DWORD to_write;
 270     LPDWORD written;
 271 } write_data_t;
 272
 273 object_header_t *addref_object( object_header_t * ) DECLSPEC_HIDDEN;
 274 object_header_t *grab_object( HINTERNET ) DECLSPEC_HIDDEN;
 275 void release_object( object_header_t * ) DECLSPEC_HIDDEN;
 276 HINTERNET alloc_handle( object_header_t * ) DECLSPEC_HIDDEN;
 277 BOOL free_handle( HINTERNET ) DECLSPEC_HIDDEN;
 278
 279 void set_last_error( DWORD ) DECLSPEC_HIDDEN;
 280 DWORD get_last_error( void ) DECLSPEC_HIDDEN;
 281 void send_callback( object_header_t *, DWORD, LPVOID, DWORD ) DECLSPEC_HIDDEN;
 282 void close_connection( request_t * ) DECLSPEC_HIDDEN;
 283
 284 BOOL netconn_close( netconn_t * ) DECLSPEC_HIDDEN;
 285 BOOL netconn_connect( netconn_t *, const struct sockaddr *, unsigned int, int ) DECLSPEC_HIDDEN;
 286 BOOL netconn_connected( netconn_t * ) DECLSPEC_HIDDEN;
 287 BOOL netconn_create( netconn_t *, int, int, int ) DECLSPEC_HIDDEN;
 288 BOOL netconn_init( netconn_t * ) DECLSPEC_HIDDEN;
 289 void netconn_unload( void ) DECLSPEC_HIDDEN;
 290 ULONG netconn_query_data_available( netconn_t * ) DECLSPEC_HIDDEN;
 291 BOOL netconn_recv( netconn_t *, void *, size_t, int, int * ) DECLSPEC_HIDDEN;
 292 BOOL netconn_resolve( WCHAR *, INTERNET_PORT, struct sockaddr *, socklen_t *, int ) DECLSPEC_HIDDEN;
 293 BOOL netconn_secure_connect( netconn_t *, WCHAR * ) DECLSPEC_HIDDEN;
 294 BOOL netconn_send( netconn_t *, const void *, size_t, int * ) DECLSPEC_HIDDEN;
 295 DWORD netconn_set_timeout( netconn_t *, BOOL, int ) DECLSPEC_HIDDEN;
 296 const void *netconn_get_certificate( netconn_t * ) DECLSPEC_HIDDEN;
 297 int netconn_get_cipher_strength( netconn_t * ) DECLSPEC_HIDDEN;
 298
 299 BOOL set_cookies( request_t *, const WCHAR * ) DECLSPEC_HIDDEN;
 300 BOOL add_cookie_headers( request_t * ) DECLSPEC_HIDDEN;
 301 BOOL add_request_headers( request_t *, LPCWSTR, DWORD, DWORD ) DECLSPEC_HIDDEN;
 302 void delete_domain( domain_t * ) DECLSPEC_HIDDEN;
 303 BOOL set_server_for_hostname( connect_t *, LPCWSTR, INTERNET_PORT ) DECLSPEC_HIDDEN;
 304 void destroy_authinfo( struct authinfo * ) DECLSPEC_HIDDEN;
 305
 306 extern HRESULT WinHttpRequest_create( void ** ) DECLSPEC_HIDDEN;
 307 void release_typelib( void ) DECLSPEC_HIDDEN;
 308
 309 static inline void* __WINE_ALLOC_SIZE(1) heap_alloc( SIZE_T size )
 310 {
 311     return HeapAlloc( GetProcessHeap(), 0, size );
 312 }
 313
 314 static inline void* __WINE_ALLOC_SIZE(1) heap_alloc_zero( SIZE_T size )
 315 {
 316     return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, size );
 317 }
 318
 319 static inline void* __WINE_ALLOC_SIZE(2) heap_realloc( LPVOID mem, SIZE_T size )
 320 {
 321     return HeapReAlloc( GetProcessHeap(), 0, mem, size );
 322 }
 323
 324 static inline void* __WINE_ALLOC_SIZE(2) heap_realloc_zero( LPVOID mem, SIZE_T size )
 325 {
 326     return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, size );
 327 }
 328
 329 static inline BOOL heap_free( LPVOID mem )
 330 {
 331     return HeapFree( GetProcessHeap(), 0, mem );
 332 }
 333
 334 static inline WCHAR *strdupW( const WCHAR *src )
 335 {
 336     WCHAR *dst;
 337
 338     if (!src) return NULL;
 339     dst = heap_alloc( (strlenW( src ) + 1) * sizeof(WCHAR) );
 340     if (dst) strcpyW( dst, src );
 341     return dst;
 342 }
 343
 344 static inline WCHAR *strdupAW( const char *src )
 345 {
 346     WCHAR *dst = NULL;
 347     if (src)
 348     {
 349         DWORD len = MultiByteToWideChar( CP_ACP, 0, src, -1, NULL, 0 );
 350         if ((dst = heap_alloc( len * sizeof(WCHAR) )))
 351             MultiByteToWideChar( CP_ACP, 0, src, -1, dst, len );
 352     }
 353     return dst;
 354 }
 355
 356 static inline char *strdupWA( const WCHAR *src )
 357 {
 358     char *dst = NULL;
 359     if (src)
 360     {
 361         int len = WideCharToMultiByte( CP_ACP, 0, src, -1, NULL, 0, NULL, NULL );
 362         if ((dst = heap_alloc( len )))
 363             WideCharToMultiByte( CP_ACP, 0, src, -1, dst, len, NULL, NULL );
 364     }
 365     return dst;
 366 }
 367
 368 static inline char *strdupWA_sized( const WCHAR *src, DWORD size )
 369 {
 370     char *dst = NULL;
 371     if (src)
 372     {
 373         int len = WideCharToMultiByte( CP_ACP, 0, src, size, NULL, 0, NULL, NULL ) + 1;
 374         if ((dst = heap_alloc( len )))
 375         {
 376             WideCharToMultiByte( CP_ACP, 0, src, len, dst, size, NULL, NULL );
 377             dst[len - 1] = 0;
 378         }
 379     }
 380     return dst;
 381 }
 382
 383 #endif /* _WINE_WINHTTP_PRIVATE_H_ */