469175ab49eedbe8b07c385d7e64096e139e084c
[WebKit-https.git] / Source / WebCore / loader / DocumentThreadableLoader.cpp
1 /*
2  * Copyright (C) 2011, 2012 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "DocumentThreadableLoader.h"
33
34 #include "CachedRawResource.h"
35 #include "CachedResourceLoader.h"
36 #include "CachedResourceRequest.h"
37 #include "CachedResourceRequestInitiators.h"
38 #include "CrossOriginAccessControl.h"
39 #include "CrossOriginPreflightResultCache.h"
40 #include "Document.h"
41 #include "Frame.h"
42 #include "FrameLoader.h"
43 #include "InspectorInstrumentation.h"
44 #include "ProgressTracker.h"
45 #include "ResourceError.h"
46 #include "ResourceRequest.h"
47 #include "SchemeRegistry.h"
48 #include "SecurityOrigin.h"
49 #include "SubresourceLoader.h"
50 #include "ThreadableLoaderClient.h"
51 #include <wtf/Assertions.h>
52 #include <wtf/Ref.h>
53
54 namespace WebCore {
55
56 void DocumentThreadableLoader::loadResourceSynchronously(Document& document, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
57 {
58     // The loader will be deleted as soon as this function exits.
59     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, client, LoadSynchronously, request, options));
60     ASSERT(loader->hasOneRef());
61 }
62
63 PassRefPtr<DocumentThreadableLoader> DocumentThreadableLoader::create(Document& document, ThreadableLoaderClient& client, const ResourceRequest& request, const ThreadableLoaderOptions& options)
64 {
65     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, client, LoadAsynchronously, request, options));
66     if (!loader->m_resource)
67         loader = nullptr;
68     return loader.release();
69 }
70
71 DocumentThreadableLoader::DocumentThreadableLoader(Document& document, ThreadableLoaderClient& client, BlockingBehavior blockingBehavior, const ResourceRequest& request, const ThreadableLoaderOptions& options)
72     : m_client(&client)
73     , m_document(document)
74     , m_options(options)
75     , m_sameOriginRequest(securityOrigin()->canRequest(request.url()))
76     , m_simpleRequest(true)
77     , m_async(blockingBehavior == LoadAsynchronously)
78 {
79     // Setting an outgoing referer is only supported in the async code path.
80     ASSERT(m_async || request.httpReferrer().isEmpty());
81
82     if (m_sameOriginRequest || m_options.crossOriginRequestPolicy == AllowCrossOriginRequests) {
83         loadRequest(request, DoSecurityCheck);
84         return;
85     }
86
87     if (m_options.crossOriginRequestPolicy == DenyCrossOriginRequests) {
88         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url(), "Cross origin requests are not supported."));
89         return;
90     }
91
92     makeCrossOriginAccessRequest(request);
93 }
94
95 void DocumentThreadableLoader::makeCrossOriginAccessRequest(const ResourceRequest& request)
96 {
97     ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
98
99     auto crossOriginRequest = std::make_unique<ResourceRequest>(request);
100     updateRequestForAccessControl(*crossOriginRequest, securityOrigin(), m_options.allowCredentials());
101
102     if ((m_options.preflightPolicy == ConsiderPreflight && isSimpleCrossOriginAccessRequest(crossOriginRequest->httpMethod(), crossOriginRequest->httpHeaderFields())) || m_options.preflightPolicy == PreventPreflight)
103         makeSimpleCrossOriginAccessRequest(*crossOriginRequest);
104     else {
105         m_simpleRequest = false;
106         m_actualRequest = WTFMove(crossOriginRequest);
107
108         if (CrossOriginPreflightResultCache::singleton().canSkipPreflight(securityOrigin()->toString(), m_actualRequest->url(), m_options.allowCredentials(), m_actualRequest->httpMethod(), m_actualRequest->httpHeaderFields()))
109             preflightSuccess();
110         else
111             makeCrossOriginAccessRequestWithPreflight(*m_actualRequest);
112     }
113 }
114
115 void DocumentThreadableLoader::makeSimpleCrossOriginAccessRequest(const ResourceRequest& request)
116 {
117     ASSERT(m_options.preflightPolicy != ForcePreflight);
118     ASSERT(m_options.preflightPolicy == PreventPreflight || isSimpleCrossOriginAccessRequest(request.httpMethod(), request.httpHeaderFields()));
119
120     // Cross-origin requests are only allowed for HTTP and registered schemes. We would catch this when checking response headers later, but there is no reason to send a request that's guaranteed to be denied.
121     if (!SchemeRegistry::shouldTreatURLSchemeAsCORSEnabled(request.url().protocol())) {
122         m_client->didFailAccessControlCheck(ResourceError(errorDomainWebKitInternal, 0, request.url(), "Cross origin requests are only supported for HTTP."));
123         return;
124     }
125
126     loadRequest(request, DoSecurityCheck);
127 }
128
129 void DocumentThreadableLoader::makeCrossOriginAccessRequestWithPreflight(const ResourceRequest& request)
130 {
131     ResourceRequest preflightRequest = createAccessControlPreflightRequest(request, securityOrigin());
132     loadRequest(preflightRequest, DoSecurityCheck);
133 }
134
135 DocumentThreadableLoader::~DocumentThreadableLoader()
136 {
137     if (m_resource)
138         m_resource->removeClient(this);
139 }
140
141 void DocumentThreadableLoader::cancel()
142 {
143     Ref<DocumentThreadableLoader> protect(*this);
144
145     // Cancel can re-enter and m_resource might be null here as a result.
146     if (m_client && m_resource) {
147         // FIXME: This error is sent to the client in didFail(), so it should not be an internal one. Use FrameLoaderClient::cancelledError() instead.
148         ResourceError error(errorDomainWebKitInternal, 0, m_resource->url(), "Load cancelled");
149         error.setIsCancellation(true);
150         didFail(m_resource->identifier(), error);
151     }
152     clearResource();
153     m_client = nullptr;
154 }
155
156 void DocumentThreadableLoader::setDefersLoading(bool value)
157 {
158     if (m_resource)
159         m_resource->setDefersLoading(value);
160 }
161
162 void DocumentThreadableLoader::clearResource()
163 {
164     // Script can cancel and restart a request reentrantly within removeClient(),
165     // which could lead to calling CachedResource::removeClient() multiple times for
166     // this DocumentThreadableLoader. Save off a copy of m_resource and clear it to
167     // prevent the reentrancy.
168     if (CachedResourceHandle<CachedRawResource> resource = m_resource) {
169         m_resource = nullptr;
170         resource->removeClient(this);
171     }
172 }
173
174 void DocumentThreadableLoader::redirectReceived(CachedResource* resource, ResourceRequest& request, const ResourceResponse& redirectResponse)
175 {
176     ASSERT(m_client);
177     ASSERT_UNUSED(resource, resource == m_resource);
178
179     Ref<DocumentThreadableLoader> protect(*this);
180     // Allow same origin requests to continue after allowing clients to audit the redirect.
181     if (isAllowedRedirect(request.url()))
182         return;
183
184     // When using access control, only simple cross origin requests are allowed to redirect. The new request URL must have a supported
185     // scheme and not contain the userinfo production. In addition, the redirect response must pass the access control check.
186     if (m_options.crossOriginRequestPolicy == UseAccessControl) {
187         bool allowRedirect = false;
188         if (m_simpleRequest) {
189             String accessControlErrorDescription;
190             allowRedirect = SchemeRegistry::shouldTreatURLSchemeAsCORSEnabled(request.url().protocol())
191                             && request.url().user().isEmpty()
192                             && request.url().pass().isEmpty()
193                             && passesAccessControlCheck(redirectResponse, m_options.allowCredentials(), securityOrigin(), accessControlErrorDescription);
194         }
195
196         if (allowRedirect) {
197             if (m_resource)
198                 clearResource();
199
200             RefPtr<SecurityOrigin> originalOrigin = SecurityOrigin::createFromString(redirectResponse.url());
201             RefPtr<SecurityOrigin> requestOrigin = SecurityOrigin::createFromString(request.url());
202             // If the request URL origin is not same origin with the original URL origin, set source origin to a globally unique identifier.
203             if (!originalOrigin->isSameSchemeHostPort(requestOrigin.get()))
204                 m_options.securityOrigin = SecurityOrigin::createUnique();
205             // Force any subsequent requests to use these checks.
206             m_sameOriginRequest = false;
207
208             // Remove any headers that may have been added by the network layer that cause access control to fail.
209             request.clearHTTPContentType();
210             request.clearHTTPReferrer();
211             request.clearHTTPOrigin();
212             request.clearHTTPUserAgent();
213             request.clearHTTPAccept();
214             makeCrossOriginAccessRequest(request);
215             return;
216         }
217     }
218
219     m_client->didFailRedirectCheck();
220     request = ResourceRequest();
221 }
222
223 void DocumentThreadableLoader::dataSent(CachedResource* resource, unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
224 {
225     ASSERT(m_client);
226     ASSERT_UNUSED(resource, resource == m_resource);
227     m_client->didSendData(bytesSent, totalBytesToBeSent);
228 }
229
230 void DocumentThreadableLoader::responseReceived(CachedResource* resource, const ResourceResponse& response)
231 {
232     ASSERT_UNUSED(resource, resource == m_resource);
233     didReceiveResponse(m_resource->identifier(), response);
234 }
235
236 void DocumentThreadableLoader::didReceiveResponse(unsigned long identifier, const ResourceResponse& response)
237 {
238     ASSERT(m_client);
239
240     String accessControlErrorDescription;
241     if (m_actualRequest) {
242         DocumentLoader* loader = m_document.frame()->loader().documentLoader();
243         InspectorInstrumentationCookie cookie = InspectorInstrumentation::willReceiveResourceResponse(m_document.frame());
244         InspectorInstrumentation::didReceiveResourceResponse(cookie, identifier, loader, response, 0);
245
246         if (!passesAccessControlCheck(response, m_options.allowCredentials(), securityOrigin(), accessControlErrorDescription)) {
247             preflightFailure(identifier, response.url(), accessControlErrorDescription);
248             return;
249         }
250
251         StoredCredentials allowCredentials = m_options.allowCredentials();
252         auto preflightResult = std::make_unique<CrossOriginPreflightResultCacheItem>(allowCredentials);
253         if (!preflightResult->parse(response, accessControlErrorDescription)
254             || !preflightResult->allowsCrossOriginMethod(m_actualRequest->httpMethod(), accessControlErrorDescription)
255             || !preflightResult->allowsCrossOriginHeaders(m_actualRequest->httpHeaderFields(), accessControlErrorDescription)) {
256             preflightFailure(identifier, response.url(), accessControlErrorDescription);
257             return;
258         }
259
260         CrossOriginPreflightResultCache::singleton().appendEntry(securityOrigin()->toString(), m_actualRequest->url(), WTFMove(preflightResult));
261     } else {
262         if (!m_sameOriginRequest && m_options.crossOriginRequestPolicy == UseAccessControl) {
263             if (!passesAccessControlCheck(response, m_options.allowCredentials(), securityOrigin(), accessControlErrorDescription)) {
264                 m_client->didFailAccessControlCheck(ResourceError(errorDomainWebKitInternal, 0, response.url(), accessControlErrorDescription));
265                 return;
266             }
267         }
268
269         m_client->didReceiveResponse(identifier, response);
270     }
271 }
272
273 void DocumentThreadableLoader::dataReceived(CachedResource* resource, const char* data, int dataLength)
274 {
275     ASSERT_UNUSED(resource, resource == m_resource);
276     didReceiveData(m_resource->identifier(), data, dataLength);
277 }
278
279 void DocumentThreadableLoader::didReceiveData(unsigned long identifier, const char* data, int dataLength)
280 {
281     ASSERT(m_client);
282
283     // Preflight data should be invisible to clients.
284     if (m_actualRequest) {
285         InspectorInstrumentation::didReceiveData(m_document.frame(), identifier, 0, 0, dataLength);
286         return;
287     }
288
289     m_client->didReceiveData(data, dataLength);
290 }
291
292 void DocumentThreadableLoader::notifyFinished(CachedResource* resource)
293 {
294     ASSERT(m_client);
295     ASSERT_UNUSED(resource, resource == m_resource);
296         
297     if (m_resource->errorOccurred())
298         didFail(m_resource->identifier(), m_resource->resourceError());
299     else
300         didFinishLoading(m_resource->identifier(), m_resource->loadFinishTime());
301 }
302
303 void DocumentThreadableLoader::didFinishLoading(unsigned long identifier, double finishTime)
304 {
305     if (m_actualRequest) {
306         InspectorInstrumentation::didFinishLoading(m_document.frame(), m_document.frame()->loader().documentLoader(), identifier, finishTime);
307
308         ASSERT(!m_sameOriginRequest);
309         ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
310         preflightSuccess();
311     } else
312         m_client->didFinishLoading(identifier, finishTime);
313 }
314
315 void DocumentThreadableLoader::didFail(unsigned long identifier, const ResourceError& error)
316 {
317     if (m_actualRequest)
318         InspectorInstrumentation::didFailLoading(m_document.frame(), m_document.frame()->loader().documentLoader(), identifier, error);
319
320     m_client->didFail(error);
321 }
322
323 void DocumentThreadableLoader::preflightSuccess()
324 {
325     std::unique_ptr<ResourceRequest> actualRequest;
326     actualRequest.swap(m_actualRequest);
327
328     actualRequest->setHTTPOrigin(securityOrigin()->toString());
329
330     clearResource();
331
332     // It should be ok to skip the security check since we already asked about the preflight request.
333     loadRequest(*actualRequest, SkipSecurityCheck);
334 }
335
336 void DocumentThreadableLoader::preflightFailure(unsigned long identifier, const URL& url, const String& errorDescription)
337 {
338     ResourceError error(errorDomainWebKitInternal, 0, url, errorDescription);
339     if (m_actualRequest)
340         InspectorInstrumentation::didFailLoading(m_document.frame(), m_document.frame()->loader().documentLoader(), identifier, error);
341
342     m_actualRequest = nullptr; // Prevent didFinishLoading() from bypassing access check.
343     m_client->didFailAccessControlCheck(error);
344 }
345
346 void DocumentThreadableLoader::loadRequest(const ResourceRequest& request, SecurityCheckPolicy securityCheck)
347 {
348     // Any credential should have been removed from the cross-site requests.
349     const URL& requestURL = request.url();
350     m_options.setSecurityCheck(securityCheck);
351     ASSERT(m_sameOriginRequest || requestURL.user().isEmpty());
352     ASSERT(m_sameOriginRequest || requestURL.pass().isEmpty());
353
354     if (m_async) {
355         ThreadableLoaderOptions options = m_options;
356         options.setClientCredentialPolicy(DoNotAskClientForCrossOriginCredentials);
357         if (m_actualRequest) {
358             // Don't sniff content or send load callbacks for the preflight request.
359             options.setSendLoadCallbacks(DoNotSendCallbacks);
360             options.setSniffContent(DoNotSniffContent);
361             // Keep buffering the data for the preflight request.
362             options.setDataBufferingPolicy(BufferData);
363         }
364
365         CachedResourceRequest newRequest(request, options);
366 #if ENABLE(RESOURCE_TIMING)
367         newRequest.setInitiator(m_options.initiator);
368 #endif
369         ASSERT(!m_resource);
370         m_resource = m_document.cachedResourceLoader().requestRawResource(newRequest);
371         if (m_resource)
372             m_resource->addClient(this);
373
374         return;
375     }
376     
377     // FIXME: ThreadableLoaderOptions.sniffContent is not supported for synchronous requests.
378     RefPtr<SharedBuffer> data;
379     ResourceError error;
380     ResourceResponse response;
381     unsigned long identifier = std::numeric_limits<unsigned long>::max();
382     if (m_document.frame())
383         identifier = m_document.frame()->loader().loadResourceSynchronously(request, m_options.allowCredentials(), m_options.clientCredentialPolicy(), error, response, data);
384
385     if (!error.isNull() && response.httpStatusCode() <= 0) {
386         if (requestURL.isLocalFile()) {
387             // We don't want XMLHttpRequest to raise an exception for file:// resources, see <rdar://problem/4962298>.
388             // FIXME: XMLHttpRequest quirks should be in XMLHttpRequest code, not in DocumentThreadableLoader.cpp.
389             didReceiveResponse(identifier, response);
390             didFinishLoading(identifier, 0.0);
391             return;
392         }
393         m_client->didFail(error);
394         return;
395     }
396
397     // FIXME: FrameLoader::loadSynchronously() does not tell us whether a redirect happened or not, so we guess by comparing the
398     // request and response URLs. This isn't a perfect test though, since a server can serve a redirect to the same URL that was
399     // requested. Also comparing the request and response URLs as strings will fail if the requestURL still has its credentials.
400     if (requestURL != response.url() && !isAllowedRedirect(response.url())) {
401         m_client->didFailRedirectCheck();
402         return;
403     }
404
405     didReceiveResponse(identifier, response);
406
407     if (data)
408         didReceiveData(identifier, data->data(), data->size());
409     didFinishLoading(identifier, 0.0);
410 }
411
412 bool DocumentThreadableLoader::isAllowedRedirect(const URL& url)
413 {
414     if (m_options.crossOriginRequestPolicy == AllowCrossOriginRequests)
415         return true;
416
417     return m_sameOriginRequest && securityOrigin()->canRequest(url);
418 }
419
420 bool DocumentThreadableLoader::isXMLHttpRequest() const
421 {
422     return m_options.initiator == cachedResourceRequestInitiators().xmlhttprequest;
423 }
424
425 SecurityOrigin* DocumentThreadableLoader::securityOrigin() const
426 {
427     return m_options.securityOrigin ? m_options.securityOrigin.get() : m_document.securityOrigin();
428 }
429
430 } // namespace WebCore