[Curl][WebKit] Implement Proxy configuration API.
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlContext.h
1 /*
2  * Copyright (C) 2013 Apple Inc.  All rights reserved.
3  * Copyright (C) 2018 Sony Interactive Entertainment Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include "CurlProxySettings.h"
30 #include "CurlSSLHandle.h"
31 #include "URL.h"
32
33 #include <wtf/Lock.h>
34 #include <wtf/NeverDestroyed.h>
35 #include <wtf/Noncopyable.h>
36 #include <wtf/Seconds.h>
37 #include <wtf/Threading.h>
38
39 #if OS(WINDOWS)
40 #include <windows.h>
41 #include <winsock2.h>
42 #endif
43
44 #include <curl/curl.h>
45
46 namespace WebCore {
47
48 // Values taken from http://www.browserscope.org/ following
49 // the rule "Do What Every Other Modern Browser Is Doing".
50 const long CurlDefaultMaxConnects { -1 }; // -1 : Does not set CURLMOPT_MAXCONNECTS
51 const long CurlDefaultMaxTotalConnections { 17 };
52 const long CurlDefaultMaxHostConnections { 6 };
53
54 // CurlGlobal --------------------------------------------
55 // to make the initialization of libcurl happen before other initialization of CurlContext
56
57 class CurlGlobal {
58 protected:
59     CurlGlobal()
60     {
61         curl_global_init(CURL_GLOBAL_ALL);
62     }
63     
64     virtual ~CurlGlobal()
65     {
66         curl_global_cleanup();
67     }
68 };
69
70 // CurlShareHandle --------------------------------------------
71
72 class CurlShareHandle {
73     WTF_MAKE_NONCOPYABLE(CurlShareHandle);
74
75 public:
76     CurlShareHandle();
77     ~CurlShareHandle();
78
79     CURLSH* handle() const { return m_shareHandle; }
80
81 private:
82     static void lockCallback(CURL*, curl_lock_data, curl_lock_access, void*);
83     static void unlockCallback(CURL*, curl_lock_data, void*);
84     static Lock* mutexFor(curl_lock_data);
85
86     CURLSH* m_shareHandle { nullptr };
87 };
88
89 // CurlContext --------------------------------------------
90
91 class CurlRequestScheduler;
92
93 class CurlContext : public CurlGlobal {
94     WTF_MAKE_NONCOPYABLE(CurlContext);
95     friend NeverDestroyed<CurlContext>;
96 public:
97     WEBCORE_EXPORT static CurlContext& singleton();
98
99     virtual ~CurlContext();
100
101     const CurlShareHandle& shareHandle() { return m_shareHandle; }
102
103     CurlRequestScheduler& scheduler() { return *m_scheduler; }
104
105     // Proxy
106     const CurlProxySettings& proxySettings() const { return m_proxySettings; }
107     void setProxySettings(CurlProxySettings&& settings) { m_proxySettings = WTFMove(settings); }
108     void setProxyUserPass(const String& user, const String& password) { m_proxySettings.setUserPass(user, password); }
109     void setDefaultProxyAuthMethod() { m_proxySettings.setDefaultAuthMethod(); }
110     void setProxyAuthMethod(long authMethod) { m_proxySettings.setAuthMethod(authMethod); }
111
112     // SSL
113     CurlSSLHandle& sslHandle() { return m_sslHandle; }
114
115     // HTTP/2
116     bool isHttp2Enabled() const;
117
118     // Timeout
119     Seconds dnsCacheTimeout() const { return m_dnsCacheTimeout; }
120     Seconds connectTimeout() const { return m_connectTimeout; }
121     Seconds defaultTimeoutInterval() const { return m_defaultTimeoutInterval; }
122
123 #ifndef NDEBUG
124     FILE* getLogFile() const { return m_logFile; }
125     bool isVerbose() const { return m_verbose; }
126 #endif
127
128 private:
129     CurlContext();
130     void initShareHandle();
131
132     CurlProxySettings m_proxySettings;
133     CurlShareHandle m_shareHandle;
134     CurlSSLHandle m_sslHandle;
135     std::unique_ptr<CurlRequestScheduler> m_scheduler;
136
137     Seconds m_dnsCacheTimeout { Seconds::fromMinutes(5) };
138     Seconds m_connectTimeout { 30.0 };
139     Seconds m_defaultTimeoutInterval { 60.0 };
140
141 #ifndef NDEBUG
142     FILE* m_logFile { nullptr };
143     bool m_verbose { false };
144 #endif
145 };
146
147 // CurlMultiHandle --------------------------------------------
148
149 class CurlMultiHandle {
150     WTF_MAKE_NONCOPYABLE(CurlMultiHandle);
151
152 public:
153     CurlMultiHandle();
154     ~CurlMultiHandle();
155
156     void setMaxConnects(long);
157     void setMaxTotalConnections(long);
158     void setMaxHostConnections(long);
159
160     CURLMcode addHandle(CURL*);
161     CURLMcode removeHandle(CURL*);
162
163     CURLMcode getFdSet(fd_set&, fd_set&, fd_set&, int&);
164     CURLMcode perform(int&);
165     CURLMsg* readInfo(int&);
166
167 private:
168     CURLM* m_multiHandle { nullptr };
169 };
170
171 // CurlSList -------------------------------------------------
172
173 class CurlSList {
174 public:
175     CurlSList() { }
176     ~CurlSList() { clear(); }
177
178     operator struct curl_slist** () { return &m_list; }
179
180     const struct curl_slist* head() const { return m_list; }
181     bool isEmpty() const { return !m_list; }
182     void clear()
183     {
184         if (m_list) {
185             curl_slist_free_all(m_list);
186             m_list = nullptr;
187         }
188     }
189
190     void append(const char* str) { m_list = curl_slist_append(m_list, str); }
191     void append(const String& str) { append(str.latin1().data()); }
192
193 private:
194     struct curl_slist* m_list { nullptr };
195 };
196
197 // CurlHandle -------------------------------------------------
198
199 class CertificateInfo;
200 class CurlSSLVerifier;
201 class HTTPHeaderMap;
202 class NetworkLoadMetrics;
203
204 class CurlHandle {
205     WTF_MAKE_NONCOPYABLE(CurlHandle);
206
207 public:
208     enum class VerifyPeer {
209         Disable = 0L,
210         Enable = 1L
211     };
212
213     enum class VerifyHost {
214         LooseNameCheck = 0,
215         StrictNameCheck = 2
216     };
217
218     CurlHandle();
219     virtual ~CurlHandle();
220
221     CURL* handle() const { return m_handle; }
222     const URL& url() const { return m_url; }
223
224     CURLcode perform();
225     CURLcode pause(int);
226
227     static const String errorDescription(CURLcode);
228
229     void enableShareHandle();
230
231     void setUrl(const URL&);
232     void enableSSLForHost(const String&);
233
234     void appendRequestHeaders(const HTTPHeaderMap&);
235     void appendRequestHeader(const String& name, const String& value);
236     void appendRequestHeader(const String& name);
237     void removeRequestHeader(const String& name);
238
239     void enableHttp();
240     void enableHttpGetRequest();
241     void enableHttpHeadRequest();
242     void enableHttpPostRequest();
243     void setPostFields(const char*, long);
244     void setPostFieldLarge(curl_off_t);
245     void enableHttpPutRequest();
246     void setInFileSizeLarge(curl_off_t);
247     void setHttpCustomRequest(const String&);
248
249     void enableConnectionOnly();
250
251     void enableAcceptEncoding();
252     void enableAllowedProtocols();
253
254     void setHttpAuthUserPass(const String&, const String&, long authType = CURLAUTH_ANY);
255
256     void setCACertPath(const char*);
257     void setSslVerifyPeer(VerifyPeer);
258     void setSslVerifyHost(VerifyHost);
259     void setSslCert(const char*);
260     void setSslCertType(const char*);
261     void setSslKeyPassword(const char*);
262     void setSslCipherList(const char*);
263
264     void enableProxyIfExists();
265
266     void setDnsCacheTimeout(Seconds);
267     void setConnectTimeout(Seconds);
268     void setTimeout(Seconds);
269
270     // Callback function
271     void setHeaderCallbackFunction(curl_write_callback, void*);
272     void setWriteCallbackFunction(curl_write_callback, void*);
273     void setReadCallbackFunction(curl_read_callback, void*);
274     void setSslCtxCallbackFunction(curl_ssl_ctx_callback, void*);
275
276     // Status
277     std::optional<String> getProxyUrl();
278     std::optional<long> getResponseCode();
279     std::optional<long> getHttpConnectCode();
280     std::optional<long long> getContentLength();
281     std::optional<long> getHttpAuthAvail();
282     std::optional<long> getProxyAuthAvail();
283     std::optional<long> getHttpVersion();
284     std::optional<NetworkLoadMetrics> getNetworkLoadMetrics(const WTF::Seconds& domainLookupStart);
285     void addExtraNetworkLoadMetrics(NetworkLoadMetrics&);
286
287     int sslErrors() const;
288     std::optional<CertificateInfo> certificateInfo() const;
289
290     static long long maxCurlOffT();
291
292 #ifndef NDEBUG
293     void enableVerboseIfUsed();
294     void enableStdErrIfUsed();
295 #endif
296
297 private:
298     void enableRequestHeaders();
299     static int expectedSizeOfCurlOffT();
300
301     static CURLcode willSetupSslCtxCallback(CURL*, void* sslCtx, void* userData);
302     CURLcode willSetupSslCtx(void* sslCtx);
303
304     CURL* m_handle { nullptr };
305     char m_errorBuffer[CURL_ERROR_SIZE] { };
306
307     URL m_url;
308     CurlSList m_requestHeaders;
309     std::unique_ptr<CurlSSLVerifier> m_sslVerifier;
310 };
311
312 class CurlSocketHandle : public CurlHandle {
313     WTF_MAKE_NONCOPYABLE(CurlSocketHandle);
314
315 public:
316     struct WaitResult {
317         bool readable { false };
318         bool writable { false };
319     };
320
321     CurlSocketHandle(const URL&, Function<void(CURLcode)>&& errorHandler);
322
323     bool connect();
324     size_t send(const uint8_t*, size_t);
325     std::optional<size_t> receive(uint8_t*, size_t);
326     std::optional<WaitResult> wait(const Seconds& timeout, bool alsoWaitForWrite);
327
328 private:
329     Function<void(CURLcode)> m_errorHandler;
330 };
331
332 } // namespace WebCore