[Curl] Extract proxy settings into a separate class to hold advanced information.
[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(const CurlProxySettings& settings) { m_proxySettings = settings; }
108     void setProxyUserPass(const String& user, const String& password) { m_proxySettings.setUserPass(user, password); }
109
110     // SSL
111     CurlSSLHandle& sslHandle() { return m_sslHandle; }
112
113     // HTTP/2
114     bool isHttp2Enabled() const;
115
116     // Timeout
117     Seconds dnsCacheTimeout() const { return m_dnsCacheTimeout; }
118     Seconds connectTimeout() const { return m_connectTimeout; }
119
120 #ifndef NDEBUG
121     FILE* getLogFile() const { return m_logFile; }
122     bool isVerbose() const { return m_verbose; }
123 #endif
124
125 private:
126     CurlContext();
127     void initShareHandle();
128
129     CurlProxySettings m_proxySettings;
130     CurlShareHandle m_shareHandle;
131     CurlSSLHandle m_sslHandle;
132     std::unique_ptr<CurlRequestScheduler> m_scheduler;
133
134     Seconds m_dnsCacheTimeout { Seconds::fromMinutes(5) };
135     Seconds m_connectTimeout { 30.0 };
136
137 #ifndef NDEBUG
138     FILE* m_logFile { nullptr };
139     bool m_verbose { false };
140 #endif
141 };
142
143 // CurlMultiHandle --------------------------------------------
144
145 class CurlMultiHandle {
146     WTF_MAKE_NONCOPYABLE(CurlMultiHandle);
147
148 public:
149     CurlMultiHandle();
150     ~CurlMultiHandle();
151
152     void setMaxConnects(long);
153     void setMaxTotalConnections(long);
154     void setMaxHostConnections(long);
155
156     CURLMcode addHandle(CURL*);
157     CURLMcode removeHandle(CURL*);
158
159     CURLMcode getFdSet(fd_set&, fd_set&, fd_set&, int&);
160     CURLMcode perform(int&);
161     CURLMsg* readInfo(int&);
162
163 private:
164     CURLM* m_multiHandle { nullptr };
165 };
166
167 // CurlSList -------------------------------------------------
168
169 class CurlSList {
170 public:
171     CurlSList() { }
172     ~CurlSList() { clear(); }
173
174     operator struct curl_slist** () { return &m_list; }
175
176     const struct curl_slist* head() const { return m_list; }
177     bool isEmpty() const { return !m_list; }
178     void clear()
179     {
180         if (m_list) {
181             curl_slist_free_all(m_list);
182             m_list = nullptr;
183         }
184     }
185
186     void append(const char* str) { m_list = curl_slist_append(m_list, str); }
187     void append(const String& str) { append(str.latin1().data()); }
188
189 private:
190     struct curl_slist* m_list { nullptr };
191 };
192
193 // CurlHandle -------------------------------------------------
194
195 class HTTPHeaderMap;
196 class NetworkLoadMetrics;
197
198 class CurlHandle {
199     WTF_MAKE_NONCOPYABLE(CurlHandle);
200
201 public:
202     enum class VerifyPeer {
203         Disable = 0L,
204         Enable = 1L
205     };
206
207     enum class VerifyHost {
208         LooseNameCheck = 0,
209         StrictNameCheck = 2
210     };
211
212     CurlHandle();
213     virtual ~CurlHandle();
214
215     CURL* handle() const { return m_handle; }
216
217     void initialize();
218
219     CURLcode perform();
220     CURLcode pause(int);
221
222     static const String errorDescription(CURLcode);
223
224     void enableShareHandle();
225
226     void setUrl(const URL&);
227
228     void appendRequestHeaders(const HTTPHeaderMap&);
229     void appendRequestHeader(const String& name, const String& value);
230     void appendRequestHeader(const String& name);
231     void removeRequestHeader(const String& name);
232
233     void enableHttp();
234     void enableHttpGetRequest();
235     void enableHttpHeadRequest();
236     void enableHttpPostRequest();
237     void setPostFields(const char*, long);
238     void setPostFieldLarge(curl_off_t);
239     void enableHttpPutRequest();
240     void setInFileSizeLarge(curl_off_t);
241     void setHttpCustomRequest(const String&);
242
243     void enableAcceptEncoding();
244     void enableAllowedProtocols();
245
246     void enableHttpAuthentication(long);
247     void setHttpAuthUserPass(const String&, const String&);
248
249     void setCACertPath(const char*);
250     void setSslVerifyPeer(VerifyPeer);
251     void setSslVerifyHost(VerifyHost);
252     void setSslCert(const char*);
253     void setSslCertType(const char*);
254     void setSslKeyPassword(const char*);
255
256     void enableProxyIfExists();
257
258     void setDnsCacheTimeout(Seconds);
259     void setConnectTimeout(Seconds);
260     void setTimeout(Seconds);
261
262     // Callback function
263     void setHeaderCallbackFunction(curl_write_callback, void*);
264     void setWriteCallbackFunction(curl_write_callback, void*);
265     void setReadCallbackFunction(curl_read_callback, void*);
266     void setSslCtxCallbackFunction(curl_ssl_ctx_callback, void*);
267
268     // Status
269     std::optional<uint16_t> getPrimaryPort();
270     std::optional<long> getResponseCode();
271     std::optional<long> getHttpConnectCode();
272     std::optional<long long> getContentLength();
273     std::optional<long> getHttpAuthAvail();
274     std::optional<long> getHttpVersion();
275     std::optional<NetworkLoadMetrics> getNetworkLoadMetrics();
276
277     static long long maxCurlOffT();
278
279 #ifndef NDEBUG
280     void enableVerboseIfUsed();
281     void enableStdErrIfUsed();
282 #endif
283
284 private:
285     void enableRequestHeaders();
286     static int expectedSizeOfCurlOffT();
287
288     CURL* m_handle { nullptr };
289     char m_errorBuffer[CURL_ERROR_SIZE] { };
290
291     CurlSList m_requestHeaders;
292 };
293
294 } // namespace WebCore