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     struct list entry;
 101     LONG ref;
 102     WCHAR *hostname;
 103     INTERNET_PORT port;
 104     BOOL secure;
 105     struct list connections;
 106 } hostdata_t;
 107
 108 typedef struct
 109 {
 110     object_header_t hdr;
 111     LPWSTR agent;
 112     DWORD access;
 113     int resolve_timeout;
 114     int connect_timeout;
 115     int send_timeout;
 116     int recv_timeout;
 117     LPWSTR proxy_server;
 118     LPWSTR proxy_bypass;
 119     LPWSTR proxy_username;
 120     LPWSTR proxy_password;
 121     struct list cookie_cache;
 122     HANDLE unload_event;
 123 } session_t;
 124
 125 typedef struct
 126 {
 127     object_header_t hdr;
 128     session_t *session;
 129     LPWSTR hostname;    /* final destination of the request */
 130     LPWSTR servername;  /* name of the server we directly connect to */
 131     LPWSTR username;
 132     LPWSTR password;
 133     INTERNET_PORT hostport;
 134     INTERNET_PORT serverport;
 135     struct sockaddr_storage sockaddr;
 136     BOOL resolved;
 137 } connect_t;
 138
 139 typedef struct
 140 {
 141     struct list entry;
 142     int socket;
 143     struct sockaddr_storage sockaddr;
 144     BOOL secure; /* SSL active on connection? */
 145     hostdata_t *host;
 146     ULONGLONG keep_until;
 147     CtxtHandle ssl_ctx;
 148     SecPkgContext_StreamSizes ssl_sizes;
 149     char *ssl_buf;
 150     char *extra_buf;
 151     size_t extra_len;
 152     char *peek_msg;
 153     char *peek_msg_mem;
 154     size_t peek_len;
 155 } netconn_t;
 156
 157 typedef struct
 158 {
 159     LPWSTR field;
 160     LPWSTR value;
 161     BOOL is_request; /* part of request headers? */
 162 } header_t;
 163
 164 enum auth_target
 165 {
 166     TARGET_INVALID = -1,
 167     TARGET_SERVER,
 168     TARGET_PROXY,
 169     TARGET_MAX
 170 };
 171
 172 enum auth_scheme
 173 {
 174     SCHEME_INVALID = -1,
 175     SCHEME_BASIC,
 176     SCHEME_NTLM,
 177     SCHEME_PASSPORT,
 178     SCHEME_DIGEST,
 179     SCHEME_NEGOTIATE,
 180     SCHEME_MAX
 181 };
 182
 183 struct authinfo
 184 {
 185     enum auth_scheme scheme;
 186     CredHandle cred;
 187     CtxtHandle ctx;
 188     TimeStamp exp;
 189     ULONG attr;
 190     ULONG max_token;
 191     char *data;
 192     unsigned int data_len;
 193     BOOL finished; /* finished authenticating */
 194 };
 195
 196 typedef struct
 197 {
 198     object_header_t hdr;
 199     connect_t *connect;
 200     LPWSTR verb;
 201     LPWSTR path;
 202     LPWSTR version;
 203     LPWSTR raw_headers;
 204     void *optional;
 205     DWORD optional_len;
 206     netconn_t *netconn;
 207     DWORD security_flags;
 208     int resolve_timeout;
 209     int connect_timeout;
 210     int send_timeout;
 211     int recv_timeout;
 212     LPWSTR status_text;
 213     DWORD content_length; /* total number of bytes to be read */
 214     DWORD content_read;   /* bytes read so far */
 215     BOOL  read_chunked;   /* are we reading in chunked mode? */
 216     BOOL  read_chunked_eof;  /* end of stream in chunked mode */
 217     BOOL  read_chunked_size; /* chunk size remaining */
 218     DWORD read_pos;       /* current read position in read_buf */
 219     DWORD read_size;      /* valid data size in read_buf */
 220     char  read_buf[8192]; /* buffer for already read but not returned data */
 221     header_t *headers;
 222     DWORD num_headers;
 223     WCHAR **accept_types;
 224     DWORD num_accept_types;
 225     struct authinfo *authinfo;
 226     struct authinfo *proxy_authinfo;
 227     HANDLE task_wait;
 228     HANDLE task_cancel;
 229     HANDLE task_thread;
 230     struct list task_queue;
 231     CRITICAL_SECTION task_cs;
 232     struct
 233     {
 234         WCHAR *username;
 235         WCHAR *password;
 236     } creds[TARGET_MAX][SCHEME_MAX];
 237 } request_t;
 238
 239 typedef struct _task_header_t task_header_t;
 240
 241 struct _task_header_t
 242 {
 243     struct list entry;
 244     request_t *request;
 245     void (*proc)( task_header_t * );
 246 };
 247
 248 typedef struct
 249 {
 250     task_header_t hdr;
 251     LPWSTR headers;
 252     DWORD headers_len;
 253     LPVOID optional;
 254     DWORD optional_len;
 255     DWORD total_len;
 256     DWORD_PTR context;
 257 } send_request_t;
 258
 259 typedef struct
 260 {
 261     task_header_t hdr;
 262 } receive_response_t;
 263
 264 typedef struct
 265 {
 266     task_header_t hdr;
 267     LPDWORD available;
 268 } query_data_t;
 269
 270 typedef struct
 271 {
 272     task_header_t hdr;
 273     LPVOID buffer;
 274     DWORD to_read;
 275     LPDWORD read;
 276 } read_data_t;
 277
 278 typedef struct
 279 {
 280     task_header_t hdr;
 281     LPCVOID buffer;
 282     DWORD to_write;
 283     LPDWORD written;
 284 } write_data_t;
 285
 286 object_header_t *addref_object( object_header_t * ) DECLSPEC_HIDDEN;
 287 object_header_t *grab_object( HINTERNET ) DECLSPEC_HIDDEN;
 288 void release_object( object_header_t * ) DECLSPEC_HIDDEN;
 289 HINTERNET alloc_handle( object_header_t * ) DECLSPEC_HIDDEN;
 290 BOOL free_handle( HINTERNET ) DECLSPEC_HIDDEN;
 291
 292 void set_last_error( DWORD ) DECLSPEC_HIDDEN;
 293 DWORD get_last_error( void ) DECLSPEC_HIDDEN;
 294 void send_callback( object_header_t *, DWORD, LPVOID, DWORD ) DECLSPEC_HIDDEN;
 295 void close_connection( request_t * ) DECLSPEC_HIDDEN;
 296
 297 BOOL netconn_close( netconn_t * ) DECLSPEC_HIDDEN;
 298 netconn_t *netconn_create( hostdata_t *, const struct sockaddr_storage *, int ) DECLSPEC_HIDDEN;
 299 void netconn_unload( void ) DECLSPEC_HIDDEN;
 300 ULONG netconn_query_data_available( netconn_t * ) DECLSPEC_HIDDEN;
 301 BOOL netconn_recv( netconn_t *, void *, size_t, int, int * ) DECLSPEC_HIDDEN;
 302 BOOL netconn_resolve( WCHAR *, INTERNET_PORT, struct sockaddr_storage *, int ) DECLSPEC_HIDDEN;
 303 BOOL netconn_secure_connect( netconn_t *, WCHAR *, DWORD ) DECLSPEC_HIDDEN;
 304 BOOL netconn_send( netconn_t *, const void *, size_t, int * ) DECLSPEC_HIDDEN;
 305 DWORD netconn_set_timeout( netconn_t *, BOOL, int ) DECLSPEC_HIDDEN;
 306 BOOL netconn_is_alive( netconn_t * ) DECLSPEC_HIDDEN;
 307 const void *netconn_get_certificate( netconn_t * ) DECLSPEC_HIDDEN;
 308 int netconn_get_cipher_strength( netconn_t * ) DECLSPEC_HIDDEN;
 309
 310 BOOL set_cookies( request_t *, const WCHAR * ) DECLSPEC_HIDDEN;
 311 BOOL add_cookie_headers( request_t * ) DECLSPEC_HIDDEN;
 312 BOOL add_request_headers( request_t *, LPCWSTR, DWORD, DWORD ) DECLSPEC_HIDDEN;
 313 void delete_domain( domain_t * ) DECLSPEC_HIDDEN;
 314 BOOL set_server_for_hostname( connect_t *, LPCWSTR, INTERNET_PORT ) DECLSPEC_HIDDEN;
 315 void destroy_authinfo( struct authinfo * ) DECLSPEC_HIDDEN;
 316
 317 void release_host( hostdata_t *host ) DECLSPEC_HIDDEN;
 318
 319 extern HRESULT WinHttpRequest_create( void ** ) DECLSPEC_HIDDEN;
 320 void release_typelib( void ) DECLSPEC_HIDDEN;
 321
 322 static inline void* __WINE_ALLOC_SIZE(1) heap_alloc( SIZE_T size )
 323 {
 324     return HeapAlloc( GetProcessHeap(), 0, size );
 325 }
 326
 327 static inline void* __WINE_ALLOC_SIZE(1) heap_alloc_zero( SIZE_T size )
 328 {
 329     return HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, size );
 330 }
 331
 332 static inline void* __WINE_ALLOC_SIZE(2) heap_realloc( LPVOID mem, SIZE_T size )
 333 {
 334     return HeapReAlloc( GetProcessHeap(), 0, mem, size );
 335 }
 336
 337 static inline void* __WINE_ALLOC_SIZE(2) heap_realloc_zero( LPVOID mem, SIZE_T size )
 338 {
 339     return HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, mem, size );
 340 }
 341
 342 static inline BOOL heap_free( LPVOID mem )
 343 {
 344     return HeapFree( GetProcessHeap(), 0, mem );
 345 }
 346
 347 static inline WCHAR *strdupW( const WCHAR *src )
 348 {
 349     WCHAR *dst;
 350
 351     if (!src) return NULL;
 352     dst = heap_alloc( (strlenW( src ) + 1) * sizeof(WCHAR) );
 353     if (dst) strcpyW( dst, src );
 354     return dst;
 355 }
 356
 357 static inline WCHAR *strdupAW( const char *src )
 358 {
 359     WCHAR *dst = NULL;
 360     if (src)
 361     {
 362         DWORD len = MultiByteToWideChar( CP_ACP, 0, src, -1, NULL, 0 );
 363         if ((dst = heap_alloc( len * sizeof(WCHAR) )))
 364             MultiByteToWideChar( CP_ACP, 0, src, -1, dst, len );
 365     }
 366     return dst;
 367 }
 368
 369 static inline char *strdupWA( const WCHAR *src )
 370 {
 371     char *dst = NULL;
 372     if (src)
 373     {
 374         int len = WideCharToMultiByte( CP_ACP, 0, src, -1, NULL, 0, NULL, NULL );
 375         if ((dst = heap_alloc( len )))
 376             WideCharToMultiByte( CP_ACP, 0, src, -1, dst, len, NULL, NULL );
 377     }
 378     return dst;
 379 }
 380
 381 static inline char *strdupWA_sized( const WCHAR *src, DWORD size )
 382 {
 383     char *dst = NULL;
 384     if (src)
 385     {
 386         int len = WideCharToMultiByte( CP_ACP, 0, src, size, NULL, 0, NULL, NULL ) + 1;
 387         if ((dst = heap_alloc( len )))
 388         {
 389             WideCharToMultiByte( CP_ACP, 0, src, len, dst, size, NULL, NULL );
 390             dst[len - 1] = 0;
 391         }
 392     }
 393     return dst;
 394 }
 395
 396 extern HINSTANCE winhttp_instance DECLSPEC_HIDDEN;
 397
 398 #endif /* _WINE_WINHTTP_PRIVATE_H_ */