Protect this DocumentThreadableLoader in cancel() to handle reentrancy properly.
[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 "CrossOriginAccessControl.h"
37 #include "CrossOriginPreflightResultCache.h"
38 #include "Document.h"
39 #include "DocumentThreadableLoaderClient.h"
40 #include "Frame.h"
41 #include "FrameLoader.h"
42 #include "ResourceError.h"
43 #include "ResourceRequest.h"
44 #include "SchemeRegistry.h"
45 #include "SecurityOrigin.h"
46 #include "ThreadableLoaderClient.h"
47 #include <wtf/Assertions.h>
48 #include <wtf/UnusedParam.h>
49
50 #if ENABLE(INSPECTOR)
51 #include "InspectorInstrumentation.h"
52 #include "ProgressTracker.h"
53 #endif
54
55 namespace WebCore {
56
57 void DocumentThreadableLoader::loadResourceSynchronously(Document* document, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
58 {
59     // The loader will be deleted as soon as this function exits.
60     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, &client, LoadSynchronously, request, options));
61     ASSERT(loader->hasOneRef());
62 }
63
64 PassRefPtr<DocumentThreadableLoader> DocumentThreadableLoader::create(Document* document, ThreadableLoaderClient* client, const ResourceRequest& request, const ThreadableLoaderOptions& options)
65 {
66     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, client, LoadAsynchronously, request, options));
67     if (!loader->m_resource)
68         loader = 0;
69     return loader.release();
70 }
71
72 DocumentThreadableLoader::DocumentThreadableLoader(Document* document, ThreadableLoaderClient* client, BlockingBehavior blockingBehavior, const ResourceRequest& request, const ThreadableLoaderOptions& options)
73     : m_client(client)
74     , m_document(document)
75     , m_options(options)
76     , m_sameOriginRequest(securityOrigin()->canRequest(request.url()))
77     , m_simpleRequest(true)
78     , m_async(blockingBehavior == LoadAsynchronously)
79 #if ENABLE(INSPECTOR)
80     , m_preflightRequestIdentifier(0)
81 #endif
82 {
83     ASSERT(document);
84     ASSERT(client);
85     // Setting an outgoing referer is only supported in the async code path.
86     ASSERT(m_async || request.httpReferrer().isEmpty());
87
88     if (m_sameOriginRequest || m_options.crossOriginRequestPolicy == AllowCrossOriginRequests) {
89         loadRequest(request, DoSecurityCheck);
90         return;
91     }
92
93     if (m_options.crossOriginRequestPolicy == DenyCrossOriginRequests) {
94         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are not supported."));
95         return;
96     }
97
98     makeCrossOriginAccessRequest(request);
99 }
100
101 void DocumentThreadableLoader::makeCrossOriginAccessRequest(const ResourceRequest& request)
102 {
103     ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
104
105     OwnPtr<ResourceRequest> crossOriginRequest = adoptPtr(new ResourceRequest(request));
106     updateRequestForAccessControl(*crossOriginRequest, securityOrigin(), m_options.allowCredentials);
107
108     if ((m_options.preflightPolicy == ConsiderPreflight && isSimpleCrossOriginAccessRequest(crossOriginRequest->httpMethod(), crossOriginRequest->httpHeaderFields())) || m_options.preflightPolicy == PreventPreflight)
109         makeSimpleCrossOriginAccessRequest(*crossOriginRequest);
110     else {
111         m_simpleRequest = false;
112         m_actualRequest = crossOriginRequest.release();
113
114         if (CrossOriginPreflightResultCache::shared().canSkipPreflight(securityOrigin()->toString(), m_actualRequest->url(), m_options.allowCredentials, m_actualRequest->httpMethod(), m_actualRequest->httpHeaderFields()))
115             preflightSuccess();
116         else
117             makeCrossOriginAccessRequestWithPreflight(*m_actualRequest);
118     }
119 }
120
121 void DocumentThreadableLoader::makeSimpleCrossOriginAccessRequest(const ResourceRequest& request)
122 {
123     ASSERT(m_options.preflightPolicy != ForcePreflight);
124     ASSERT(m_options.preflightPolicy == PreventPreflight || isSimpleCrossOriginAccessRequest(request.httpMethod(), request.httpHeaderFields()));
125
126     // 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.
127     if (!SchemeRegistry::shouldTreatURLSchemeAsCORSEnabled(request.url().protocol())) {
128         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are only supported for HTTP."));
129         return;
130     }
131
132     loadRequest(request, DoSecurityCheck);
133 }
134
135 void DocumentThreadableLoader::makeCrossOriginAccessRequestWithPreflight(const ResourceRequest& request)
136 {
137     ResourceRequest preflightRequest = createAccessControlPreflightRequest(request, securityOrigin());
138     loadRequest(preflightRequest, DoSecurityCheck);
139 }
140
141 DocumentThreadableLoader::~DocumentThreadableLoader()
142 {
143     if (m_resource)
144         m_resource->removeClient(this);
145 }
146
147 void DocumentThreadableLoader::cancel()
148 {
149     RefPtr<DocumentThreadableLoader> protect(this);
150
151     // Cancel can re-enter and m_resource might be null here as a result.
152     if (m_client && m_resource) {
153         ResourceError error(errorDomainWebKitInternal, 0, m_resource->url(), "Load cancelled");
154         error.setIsCancellation(true);
155         didFail(error);
156     }
157     clearResource();
158     m_client = 0;
159 }
160
161 void DocumentThreadableLoader::setDefersLoading(bool value)
162 {
163     if (m_resource)
164         m_resource->setDefersLoading(value);
165 }
166
167 void DocumentThreadableLoader::clearResource()
168 {
169     // Script can cancel and restart a request reentrantly within removeClient(),
170     // which could lead to calling CachedResource::removeClient() multiple times for
171     // this DocumentThreadableLoader. Save off a copy of m_resource and clear it to
172     // prevent the reentrancy.
173     if (CachedResourceHandle<CachedRawResource> resource = m_resource) {
174         m_resource = 0;
175         resource->removeClient(this);
176     }
177 }
178
179 void DocumentThreadableLoader::redirectReceived(CachedResource* resource, ResourceRequest& request, const ResourceResponse& redirectResponse)
180 {
181     ASSERT(m_client);
182     ASSERT_UNUSED(resource, resource == m_resource);
183
184     RefPtr<DocumentThreadableLoader> protect(this);
185     // Allow same origin requests to continue after allowing clients to audit the redirect.
186     if (isAllowedRedirect(request.url())) {
187         if (m_client->isDocumentThreadableLoaderClient())
188             static_cast<DocumentThreadableLoaderClient*>(m_client)->willSendRequest(request, redirectResponse);
189         return;
190     }
191
192     // When using access control, only simple cross origin requests are allowed to redirect. The new request URL must have a supported
193     // scheme and not contain the userinfo production. In addition, the redirect response must pass the access control check.
194     if (m_options.crossOriginRequestPolicy == UseAccessControl) {
195         bool allowRedirect = false;
196         if (m_simpleRequest) {
197             String accessControlErrorDescription;
198             allowRedirect = SchemeRegistry::shouldTreatURLSchemeAsCORSEnabled(request.url().protocol())
199                             && request.url().user().isEmpty()
200                             && request.url().pass().isEmpty()
201                             && passesAccessControlCheck(redirectResponse, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription);
202         }
203
204         if (allowRedirect) {
205             if (m_resource)
206                 clearResource();
207
208             RefPtr<SecurityOrigin> originalOrigin = SecurityOrigin::createFromString(redirectResponse.url());
209             RefPtr<SecurityOrigin> requestOrigin = SecurityOrigin::createFromString(request.url());
210             // If the request URL origin is not same origin with the original URL origin, set source origin to a globally unique identifier.
211             if (!originalOrigin->isSameSchemeHostPort(requestOrigin.get()))
212                 m_options.securityOrigin = SecurityOrigin::createUnique();
213             // Force any subsequent requests to use these checks.
214             m_sameOriginRequest = false;
215
216             // Remove any headers that may have been added by the network layer that cause access control to fail.
217             request.clearHTTPContentType();
218             request.clearHTTPReferrer();
219             request.clearHTTPOrigin();
220             request.clearHTTPUserAgent();
221             request.clearHTTPAccept();
222             makeCrossOriginAccessRequest(request);
223             return;
224         }
225     }
226
227     m_client->didFailRedirectCheck();
228     request = ResourceRequest();
229 }
230
231 void DocumentThreadableLoader::dataSent(CachedResource* resource, unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
232 {
233     ASSERT(m_client);
234     ASSERT_UNUSED(resource, resource == m_resource);
235     m_client->didSendData(bytesSent, totalBytesToBeSent);
236 }
237
238 void DocumentThreadableLoader::responseReceived(CachedResource* resource, const ResourceResponse& response)
239 {
240     ASSERT_UNUSED(resource, resource == m_resource);
241     didReceiveResponse(m_resource->identifier(), response);
242 }
243
244 void DocumentThreadableLoader::didReceiveResponse(unsigned long identifier, const ResourceResponse& response)
245 {
246     ASSERT(m_client);
247
248 #if ENABLE(INSPECTOR)
249     if (m_preflightRequestIdentifier) {
250         DocumentLoader* loader = m_document->frame()->loader()->documentLoader();
251         InspectorInstrumentationCookie cookie = InspectorInstrumentation::willReceiveResourceResponse(m_document->frame(), m_preflightRequestIdentifier, response);
252         InspectorInstrumentation::didReceiveResourceResponse(cookie, m_preflightRequestIdentifier, loader, response);
253     }
254 #endif
255
256     String accessControlErrorDescription;
257     if (m_actualRequest) {
258         if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
259             preflightFailure(response.url(), accessControlErrorDescription);
260             return;
261         }
262
263         OwnPtr<CrossOriginPreflightResultCacheItem> preflightResult = adoptPtr(new CrossOriginPreflightResultCacheItem(m_options.allowCredentials));
264         if (!preflightResult->parse(response, accessControlErrorDescription)
265             || !preflightResult->allowsCrossOriginMethod(m_actualRequest->httpMethod(), accessControlErrorDescription)
266             || !preflightResult->allowsCrossOriginHeaders(m_actualRequest->httpHeaderFields(), accessControlErrorDescription)) {
267             preflightFailure(response.url(), accessControlErrorDescription);
268             return;
269         }
270
271         CrossOriginPreflightResultCache::shared().appendEntry(securityOrigin()->toString(), m_actualRequest->url(), preflightResult.release());
272     } else {
273         if (!m_sameOriginRequest && m_options.crossOriginRequestPolicy == UseAccessControl) {
274             if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
275                 m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, response.url().string(), accessControlErrorDescription));
276                 return;
277             }
278         }
279
280         m_client->didReceiveResponse(identifier, response);
281     }
282 }
283
284 void DocumentThreadableLoader::dataReceived(CachedResource* resource, const char* data, int dataLength)
285 {
286     ASSERT(m_client);
287     ASSERT_UNUSED(resource, resource == m_resource);
288
289 #if ENABLE(INSPECTOR)
290     if (m_preflightRequestIdentifier)
291         InspectorInstrumentation::didReceiveData(m_document->frame(), m_preflightRequestIdentifier, 0, 0, dataLength);
292 #endif
293
294     // Preflight data should be invisible to clients.
295     if (m_actualRequest)
296         return;
297
298     m_client->didReceiveData(data, dataLength);
299 }
300
301 void DocumentThreadableLoader::notifyFinished(CachedResource* resource)
302 {
303     ASSERT(m_client);
304     ASSERT_UNUSED(resource, resource == m_resource);
305         
306     if (m_resource && (m_resource->errorOccurred() || m_resource->wasCanceled())) {
307         ResourceError error("Network Request Failed", 0, m_resource->url(), "Resource failed to load");
308         if (m_resource->wasCanceled())
309             error.setIsCancellation(true);
310         didFail(error);
311     } else
312         didFinishLoading(m_resource->identifier(), m_resource->loadFinishTime());
313 }
314
315 void DocumentThreadableLoader::didFinishLoading(unsigned long identifier, double finishTime)
316 {
317 #if ENABLE(INSPECTOR)
318     if (m_preflightRequestIdentifier)
319         InspectorInstrumentation::didFinishLoading(m_document->frame(), m_document->frame()->loader()->documentLoader(), m_preflightRequestIdentifier, finishTime);
320 #endif
321
322     if (m_actualRequest) {
323         ASSERT(!m_sameOriginRequest);
324         ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
325         preflightSuccess();
326     } else
327         m_client->didFinishLoading(identifier, finishTime);
328 }
329
330 void DocumentThreadableLoader::didFail(const ResourceError& error)
331 {
332 #if ENABLE(INSPECTOR)
333     if (m_preflightRequestIdentifier)
334         InspectorInstrumentation::didFailLoading(m_document->frame(), m_document->frame()->loader()->documentLoader(), m_preflightRequestIdentifier, error);
335 #endif
336
337     m_client->didFail(error);
338 }
339
340 void DocumentThreadableLoader::preflightSuccess()
341 {
342     OwnPtr<ResourceRequest> actualRequest;
343     actualRequest.swap(m_actualRequest);
344
345     actualRequest->setHTTPOrigin(securityOrigin()->toString());
346
347     clearResource();
348
349     // It should be ok to skip the security check since we already asked about the preflight request.
350     loadRequest(*actualRequest, SkipSecurityCheck);
351 }
352
353 void DocumentThreadableLoader::preflightFailure(const String& url, const String& errorDescription)
354 {
355     m_actualRequest = nullptr; // Prevent didFinishLoading() from bypassing access check.
356     m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, url, errorDescription));
357 }
358
359 void DocumentThreadableLoader::loadRequest(const ResourceRequest& request, SecurityCheckPolicy securityCheck)
360 {
361     // Any credential should have been removed from the cross-site requests.
362     const KURL& requestURL = request.url();
363     m_options.securityCheck = securityCheck;
364     ASSERT(m_sameOriginRequest || requestURL.user().isEmpty());
365     ASSERT(m_sameOriginRequest || requestURL.pass().isEmpty());
366
367     if (m_async) {
368         ThreadableLoaderOptions options = m_options;
369         options.crossOriginCredentialPolicy = DoNotAskClientForCrossOriginCredentials;
370         if (m_actualRequest) {
371             // Don't sniff content or send load callbacks for the preflight request.
372             options.sendLoadCallbacks = DoNotSendCallbacks;
373             options.sniffContent = DoNotSniffContent;
374             // Keep buffering the data for the preflight request.
375             options.shouldBufferData = BufferData;
376         }
377
378         ResourceRequest newRequest(request);
379 #if ENABLE(INSPECTOR)
380         if (m_actualRequest) {
381             // Because willSendRequest only gets called during redirects, we initialize the identifier and the first willSendRequest here.
382             m_preflightRequestIdentifier = m_document->frame()->page()->progress()->createUniqueIdentifier();
383             ResourceResponse redirectResponse = ResourceResponse();
384             InspectorInstrumentation::willSendRequest(m_document->frame(), m_preflightRequestIdentifier, m_document->frame()->loader()->documentLoader(), newRequest, redirectResponse);
385         }
386 #endif
387         ASSERT(!m_resource);
388         m_resource = m_document->cachedResourceLoader()->requestRawResource(newRequest, options);
389         if (m_resource)
390             m_resource->addClient(this);
391         return;
392     }
393     
394     // FIXME: ThreadableLoaderOptions.sniffContent is not supported for synchronous requests.
395     Vector<char> data;
396     ResourceError error;
397     ResourceResponse response;
398     unsigned long identifier = std::numeric_limits<unsigned long>::max();
399     if (m_document->frame())
400         identifier = m_document->frame()->loader()->loadResourceSynchronously(request, m_options.allowCredentials, error, response, data);
401
402     // No exception for file:/// resources, see <rdar://problem/4962298>.
403     // Also, if we have an HTTP response, then it wasn't a network error in fact.
404     if (!error.isNull() && !requestURL.isLocalFile() && response.httpStatusCode() <= 0) {
405         m_client->didFail(error);
406         return;
407     }
408
409     // FIXME: FrameLoader::loadSynchronously() does not tell us whether a redirect happened or not, so we guess by comparing the
410     // request and response URLs. This isn't a perfect test though, since a server can serve a redirect to the same URL that was
411     // requested. Also comparing the request and response URLs as strings will fail if the requestURL still has its credentials.
412     if (requestURL != response.url() && !isAllowedRedirect(response.url())) {
413         m_client->didFailRedirectCheck();
414         return;
415     }
416
417     didReceiveResponse(identifier, response);
418
419     const char* bytes = static_cast<const char*>(data.data());
420     int len = static_cast<int>(data.size());
421     dataReceived(0, bytes, len);
422
423     didFinishLoading(identifier, 0.0);
424 }
425
426 bool DocumentThreadableLoader::isAllowedRedirect(const KURL& url)
427 {
428     if (m_options.crossOriginRequestPolicy == AllowCrossOriginRequests)
429         return true;
430
431     return m_sameOriginRequest && securityOrigin()->canRequest(url);
432 }
433
434 SecurityOrigin* DocumentThreadableLoader::securityOrigin() const
435 {
436     return m_options.securityOrigin ? m_options.securityOrigin.get() : m_document->securityOrigin();
437 }
438
439 } // namespace WebCore