[Curl] Cross-protocol, cross-site scripting (XPXSS) using HTML forms
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlContext.h
1 /*
2  * Copyright (C) 2013 Apple Inc.  All rights reserved.
3  * Copyright (C) 2017 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 "CookieJarCurl.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/Threading.h>
37
38 #if OS(WINDOWS)
39 #include <windows.h>
40 #include <winsock2.h>
41 #endif
42
43 #include <curl/curl.h>
44
45 namespace WebCore {
46
47 enum class CurlProxyType {
48     Invalid = -1,
49     HTTP = CURLPROXY_HTTP,
50     Socks4 = CURLPROXY_SOCKS4,
51     Socks4A = CURLPROXY_SOCKS4A,
52     Socks5 = CURLPROXY_SOCKS5,
53     Socks5Hostname = CURLPROXY_SOCKS5_HOSTNAME
54 };
55
56 // CurlGlobal --------------------------------------------
57 // to make the initialization of libcurl happen before other initialization of CurlContext
58
59 class CurlGlobal {
60 protected:
61     CurlGlobal()
62     {
63         curl_global_init(CURL_GLOBAL_ALL);
64     }
65     
66     virtual ~CurlGlobal()
67     {
68         curl_global_cleanup();
69     }
70 };
71
72 // CurlShareHandle --------------------------------------------
73
74 class CurlShareHandle {
75     WTF_MAKE_NONCOPYABLE(CurlShareHandle);
76
77 public:
78     CurlShareHandle();
79     ~CurlShareHandle();
80
81     CURLSH* handle() const { return m_shareHandle; }
82
83 private:
84     static void lockCallback(CURL*, curl_lock_data, curl_lock_access, void*);
85     static void unlockCallback(CURL*, curl_lock_data, void*);
86     static StaticLock* mutexFor(curl_lock_data);
87
88     CURLSH* m_shareHandle { nullptr };
89 };
90
91 // CurlContext --------------------------------------------
92
93 class CurlContext : public CurlGlobal {
94     WTF_MAKE_NONCOPYABLE(CurlContext);
95     friend NeverDestroyed<CurlContext>;
96 public:
97     struct ProxyInfo {
98         String host;
99         unsigned long port;
100         CurlProxyType type { CurlProxyType::Invalid };
101         String username;
102         String password;
103
104         const String url() const;
105     };
106
107     static CurlContext& singleton();
108
109     virtual ~CurlContext();
110
111     const CurlShareHandle& shareHandle() { return m_shareHandle; }
112
113     // Cookie
114     const char* getCookieJarFileName() const { return m_cookieJarFileName.data(); }
115     void setCookieJarFileName(const char* cookieJarFileName) { m_cookieJarFileName = CString(cookieJarFileName); }
116     CookieJarCurl& cookieJar() { return *m_cookieJar; }
117
118     // Proxy
119     const ProxyInfo& proxyInfo() const { return m_proxy; }
120     void setProxyInfo(const ProxyInfo& info) { m_proxy = info;  }
121     void setProxyInfo(const String& host = emptyString(), unsigned long port = 0, CurlProxyType = CurlProxyType::HTTP, const String& username = emptyString(), const String& password = emptyString());
122
123     // SSL
124     CurlSSLHandle& sslHandle() { return m_sslHandle; }
125
126 #ifndef NDEBUG
127     FILE* getLogFile() const { return m_logFile; }
128     bool isVerbose() const { return m_verbose; }
129 #endif
130
131 private:
132     ProxyInfo m_proxy;
133     CString m_cookieJarFileName;
134     CurlShareHandle m_shareHandle;
135     std::unique_ptr<CookieJarCurl> m_cookieJar;
136     CurlSSLHandle m_sslHandle;
137
138     CurlContext();
139     void initCookieSession();
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     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 enableHttpGetRequest();
234     void enableHttpHeadRequest();
235     void enableHttpPostRequest();
236     void setPostFields(const char*, long);
237     void setPostFieldLarge(curl_off_t);
238     void enableHttpPutRequest();
239     void setInFileSizeLarge(curl_off_t);
240     void setHttpCustomRequest(const String&);
241
242     void enableAcceptEncoding();
243     void enableAllowedProtocols();
244
245     void enableHttpAuthentication(long);
246     void setHttpAuthUserPass(const String&, const String&);
247
248     void setCACertPath(const char*);
249     void setSslVerifyPeer(VerifyPeer);
250     void setSslVerifyHost(VerifyHost);
251     void setSslCert(const char*);
252     void setSslCertType(const char*);
253     void setSslKeyPassword(const char*);
254
255     void enableCookieJarIfExists();
256     void setCookieList(const char*);
257     void fetchCookieList(CurlSList &cookies) const;
258
259     void enableProxyIfExists();
260
261     void enableTimeout();
262
263     // Callback function
264     void setHeaderCallbackFunction(curl_write_callback, void*);
265     void setWriteCallbackFunction(curl_write_callback, void*);
266     void setReadCallbackFunction(curl_read_callback, void*);
267     void setSslCtxCallbackFunction(curl_ssl_ctx_callback, void*);
268
269     // Status
270     std::optional<uint16_t> getPrimaryPort();
271     std::optional<long> getResponseCode();
272     std::optional<long> getHttpConnectCode();
273     std::optional<long long> getContentLength();
274     std::optional<long> getHttpAuthAvail();
275     std::optional<long> getHttpVersion();
276     std::optional<NetworkLoadMetrics> getNetworkLoadMetrics();
277
278     static long long maxCurlOffT();
279
280 #ifndef NDEBUG
281     void enableVerboseIfUsed();
282     void enableStdErrIfUsed();
283 #endif
284
285 private:
286     void enableRequestHeaders();
287     static int expectedSizeOfCurlOffT();
288
289     CURL* m_handle { nullptr };
290     char m_errorBuffer[CURL_ERROR_SIZE] { };
291
292     CurlSList m_requestHeaders;
293 };
294
295 } // namespace WebCore