summaryrefslogtreecommitdiffstats
path: root/net/http/http_transaction_winhttp.h
blob: bb8ec1f79c9e5cfa7f43ab88ce7f52627391a63f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef NET_HTTP_HTTP_TRANSACTION_WINHTTP_H__
#define NET_HTTP_HTTP_TRANSACTION_WINHTTP_H__

#include <windows.h>
#include <winhttp.h>

#include <string>

#include "base/ref_counted.h"
#include "net/base/completion_callback.h"
#include "net/http/http_proxy_service.h"
#include "net/http/http_response_info.h"
#include "net/http/http_transaction.h"
#include "net/http/http_transaction_factory.h"

namespace net {

class UploadDataStream;

class HttpTransactionWinHttp : public HttpTransaction {
  class Session;  // Represents a WinHttp session handle.
  class SessionCallback;
 public:
  // Instantiate this class, and use it to create HttpTransaction objects.
  class Factory : public HttpTransactionFactory {
   public:
    Factory() : session_(NULL), proxy_info_(NULL), is_suspended_(false) {}
    explicit Factory(const HttpProxyInfo* info)
        : session_(NULL), proxy_info_(NULL), is_suspended_(false) {
      if (info) {
        proxy_info_.reset(new HttpProxyInfo());
        proxy_info_->Use(*info);
      }
    }
    ~Factory();

    virtual HttpTransaction* CreateTransaction();
    virtual HttpCache* GetCache();
    virtual AuthCache* GetAuthCache();
    virtual void Suspend(bool suspend);

   private:
    Session* session_;
    scoped_ptr<HttpProxyInfo> proxy_info_;
    bool is_suspended_;
    DISALLOW_EVIL_CONSTRUCTORS(Factory);
  };

  // HttpTransaction methods:
  virtual void Destroy();
  virtual int Start(const HttpRequestInfo*, CompletionCallback*);
  virtual int RestartIgnoringLastError(CompletionCallback*);
  virtual int RestartWithAuth(const std::wstring&,
                              const std::wstring&,
                              CompletionCallback*);
  virtual int Read(char*, int, CompletionCallback*);
  virtual const HttpResponseInfo* GetResponseInfo() const;
  virtual LoadState GetLoadState() const;
  virtual uint64 GetUploadProgress() const;

  static void CALLBACK StatusCallback(HINTERNET handle,
                                      DWORD_PTR context,
                                      DWORD status,
                                      LPVOID status_info,
                                      DWORD status_info_len);

  // Called via the message loop in response to a WinHttp status callback.
  void HandleStatusCallback(DWORD status,
                            DWORD_PTR result,
                            DWORD error,
                            DWORD secure_failure);

 private:
  friend class Factory;

  // Methods ------------------------------------------------------------------

  HttpTransactionWinHttp(Session* session, const HttpProxyInfo* info);
  ~HttpTransactionWinHttp();

  void DoCallback(int rv);
  int ResolveProxy();
  bool OpenRequest();
  int SendRequest();
  bool ReopenRequest();
  int Restart(CompletionCallback* callback);
  int DidResolveProxy();
  int DidReceiveError(DWORD error, DWORD secure_failure);
  int DidSendRequest();
  int DidWriteData(DWORD num_bytes);
  int DidReadData(DWORD num_bytes);
  int DidReceiveHeaders();

  void PopulateAuthChallenge();
  void ApplyAuth();

  std::string GetRequestHeaders() const;
  X509Certificate* GetServerCertificate() const;
  int GetSecurityBits() const;
  void PopulateSSLInfo(DWORD secure_failure);

  void OnProxyInfoAvailable(int result);

  // Variables ----------------------------------------------------------------

  Session* session_;
  const HttpRequestInfo* request_;

  // A copy of request_->load_flags that we can modify in
  // RestartIgnoringLastError.
  int load_flags_;

  // Optional auth data for proxy and origin server.
  scoped_refptr<AuthData> proxy_auth_;
  scoped_refptr<AuthData> server_auth_;

  // The key for looking up the auth data in the auth cache, consisting
  // of the scheme, host, and port of the request URL and the realm in
  // the auth challenge.
  std::string proxy_auth_cache_key_;
  std::string server_auth_cache_key_;

  // The peer of the connection.  For a direct connection, this is the
  // destination server.  If we use a proxy, this is the proxy.
  std::string connect_peer_;

  // The last error from SendRequest that occurred.  Used by
  // RestartIgnoringLastError to adjust load_flags_ to ignore this error.
  DWORD last_error_;

  // This value is non-negative when we are streaming a response over a
  // non-keepalive connection.  We decrement this value as we receive data to
  // allow us to discover end-of-file.  This is used to workaround a bug in
  // WinHttp (see bug 1063336).
  int64 content_length_remaining_;

  HttpProxyInfo proxy_info_;
  HttpProxyService::PacRequest* pac_request_;
  CompletionCallbackImpl<HttpTransactionWinHttp> proxy_callback_;

  HttpResponseInfo response_;
  CompletionCallback* callback_;
  HINTERNET connect_handle_;
  HINTERNET request_handle_;
  scoped_refptr<SessionCallback> session_callback_;
  scoped_ptr<UploadDataStream> upload_stream_;
  uint64 upload_progress_;

  // True if the URL's scheme is https.
  bool is_https_;

  // True if the SSL server doesn't support TLS but also cannot correctly
  // negotiate with a TLS-enabled client to use SSL 3.0.  The workaround is
  // for the client to downgrade to SSL 3.0 and retry the SSL handshake.
  bool is_tls_intolerant_;

  // True if revocation checking of the SSL server certificate is enabled.
  bool rev_checking_enabled_;

  // A flag to indicate whether or not we already have proxy information.
  // If false, we will attempt to resolve proxy information from the proxy
  // service.  This flag is set to true if proxy information is supplied by
  // a client.
  bool have_proxy_info_;

  // If WinHTTP is still using our caller's data (upload data or read buffer),
  // we need to wait for the HANDLE_CLOSING status notification after we close
  // the request handle.
  //
  // There are only five WinHTTP functions that work asynchronously (listed in
  // the order in which they're called):
  // WinHttpSendRequest, WinHttpWriteData, WinHttpReceiveResponse,
  // WinHttpQueryDataAvailable, WinHttpReadData.
  // WinHTTP is using our caller's data during the two time intervals:
  // - From the first WinHttpWriteData call to the completion of the last
  //   WinHttpWriteData call.  (We may call WinHttpWriteData multiple times.)
  // - From the WinHttpReadData call to its completion.
  // We set need_to_wait_for_handle_closing_ to true at the beginning of these
  // time intervals and set it to false at the end.  We're not sandwiching the
  // intervals as tightly as possible.  (To do that, we'd need to give WinHTTP
  // worker threads access to the need_to_wait_for_handle_closing_ flag and
  // worry about thread synchronization issues.)
  bool need_to_wait_for_handle_closing_;

  // True if we have called WinHttpRequestThrottle::SubmitRequest.
  bool request_submitted_;

  DISALLOW_EVIL_CONSTRUCTORS(HttpTransactionWinHttp);
};

}  // namespace net

#endif  // NET_HTTP_HTTP_TRANSACTION_WINHTTP_H__