2011-06-16 Sheriff Bot <webkit.review.bot@gmail.com>
[WebKit-https.git] / Source / WebCore / loader / DocumentThreadableLoader.cpp
1 /*
2  * Copyright (C) 2011 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 "AuthenticationChallenge.h"
35 #include "CrossOriginAccessControl.h"
36 #include "CrossOriginPreflightResultCache.h"
37 #include "Document.h"
38 #include "DocumentThreadableLoaderClient.h"
39 #include "Frame.h"
40 #include "FrameLoader.h"
41 #include "ResourceHandle.h"
42 #include "ResourceLoadScheduler.h"
43 #include "ResourceRequest.h"
44 #include "SecurityOrigin.h"
45 #include "SubresourceLoader.h"
46 #include "ThreadableLoaderClient.h"
47 #include <wtf/UnusedParam.h>
48
49 namespace WebCore {
50
51 void DocumentThreadableLoader::loadResourceSynchronously(Document* document, const ResourceRequest& request, ThreadableLoaderClient& client, const ThreadableLoaderOptions& options)
52 {
53     // The loader will be deleted as soon as this function exits.
54     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, &client, LoadSynchronously, request, options, String()));
55     ASSERT(loader->hasOneRef());
56 }
57
58 PassRefPtr<DocumentThreadableLoader> DocumentThreadableLoader::create(Document* document, ThreadableLoaderClient* client, const ResourceRequest& request, const ThreadableLoaderOptions& options, const String& optionalOutgoingReferrer)
59 {
60     RefPtr<DocumentThreadableLoader> loader = adoptRef(new DocumentThreadableLoader(document, client, LoadAsynchronously, request, options, optionalOutgoingReferrer));
61     if (!loader->m_loader)
62         loader = 0;
63     return loader.release();
64 }
65
66 DocumentThreadableLoader::DocumentThreadableLoader(Document* document, ThreadableLoaderClient* client, BlockingBehavior blockingBehavior, const ResourceRequest& request, const ThreadableLoaderOptions& options, const String& optionalOutgoingReferrer)
67     : m_client(client)
68     , m_document(document)
69     , m_options(options)
70     , m_optionalOutgoingReferrer(optionalOutgoingReferrer)
71     , m_sameOriginRequest(securityOrigin()->canRequest(request.url()))
72     , m_async(blockingBehavior == LoadAsynchronously)
73 {
74     ASSERT(document);
75     ASSERT(client);
76     // Setting an outgoing referer is only supported in the async code path.
77     ASSERT(m_async || m_optionalOutgoingReferrer.isEmpty());
78
79     if (m_sameOriginRequest || m_options.crossOriginRequestPolicy == AllowCrossOriginRequests) {
80         loadRequest(request, DoSecurityCheck);
81         return;
82     }
83
84     if (m_options.crossOriginRequestPolicy == DenyCrossOriginRequests) {
85         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are not supported."));
86         return;
87     }
88     
89     ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
90
91     OwnPtr<ResourceRequest> crossOriginRequest = adoptPtr(new ResourceRequest(request));
92     updateRequestForAccessControl(*crossOriginRequest, securityOrigin(), m_options.allowCredentials);
93
94     if (!m_options.forcePreflight && isSimpleCrossOriginAccessRequest(crossOriginRequest->httpMethod(), crossOriginRequest->httpHeaderFields()))
95         makeSimpleCrossOriginAccessRequest(*crossOriginRequest);
96     else {
97         m_actualRequest = crossOriginRequest.release();
98
99         if (CrossOriginPreflightResultCache::shared().canSkipPreflight(securityOrigin()->toString(), m_actualRequest->url(), m_options.allowCredentials, m_actualRequest->httpMethod(), m_actualRequest->httpHeaderFields()))
100             preflightSuccess();
101         else
102             makeCrossOriginAccessRequestWithPreflight(*m_actualRequest);
103     }
104 }
105
106 void DocumentThreadableLoader::makeSimpleCrossOriginAccessRequest(const ResourceRequest& request)
107 {
108     ASSERT(isSimpleCrossOriginAccessRequest(request.httpMethod(), request.httpHeaderFields()));
109
110     // Cross-origin requests are only defined for HTTP. We would catch this when checking response headers later, but there is no reason to send a request that's guaranteed to be denied.
111     // FIXME: Consider allowing simple CORS requests to non-HTTP URLs.
112     if (!request.url().protocolInHTTPFamily()) {
113         m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, request.url().string(), "Cross origin requests are only supported for HTTP."));
114         return;
115     }
116
117     loadRequest(request, DoSecurityCheck);
118 }
119
120 void DocumentThreadableLoader::makeCrossOriginAccessRequestWithPreflight(const ResourceRequest& request)
121 {
122     ResourceRequest preflightRequest = createAccessControlPreflightRequest(request, securityOrigin(), m_options.allowCredentials);
123     loadRequest(preflightRequest, DoSecurityCheck);
124 }
125
126 DocumentThreadableLoader::~DocumentThreadableLoader()
127 {
128     if (m_loader)
129         m_loader->clearClient();
130 }
131
132 void DocumentThreadableLoader::cancel()
133 {
134     if (!m_loader)
135         return;
136
137     m_loader->cancel();
138     m_loader->clearClient();
139     m_loader = 0;
140     m_client = 0;
141 }
142
143 void DocumentThreadableLoader::setDefersLoading(bool value)
144 {
145     if (m_loader)
146         m_loader->setDefersLoading(value);
147 }
148
149 void DocumentThreadableLoader::willSendRequest(SubresourceLoader* loader, ResourceRequest& request, const ResourceResponse& redirectResponse)
150 {
151     ASSERT(m_client);
152     ASSERT_UNUSED(loader, loader == m_loader);
153
154     if (!isAllowedRedirect(request.url())) {
155         RefPtr<DocumentThreadableLoader> protect(this);
156         m_client->didFailRedirectCheck();
157         request = ResourceRequest();
158     } else {
159         if (m_client->isDocumentThreadableLoaderClient())
160             static_cast<DocumentThreadableLoaderClient*>(m_client)->willSendRequest(request, redirectResponse);
161     }
162 }
163
164 void DocumentThreadableLoader::didSendData(SubresourceLoader* loader, unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
165 {
166     ASSERT(m_client);
167     ASSERT_UNUSED(loader, loader == m_loader);
168
169     m_client->didSendData(bytesSent, totalBytesToBeSent);
170 }
171
172 void DocumentThreadableLoader::didReceiveResponse(SubresourceLoader* loader, const ResourceResponse& response)
173 {
174     ASSERT(m_client);
175     ASSERT_UNUSED(loader, loader == m_loader);
176
177     String accessControlErrorDescription;
178     if (m_actualRequest) {
179         if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
180             preflightFailure(response.url(), accessControlErrorDescription);
181             return;
182         }
183
184         OwnPtr<CrossOriginPreflightResultCacheItem> preflightResult = adoptPtr(new CrossOriginPreflightResultCacheItem(m_options.allowCredentials));
185         if (!preflightResult->parse(response, accessControlErrorDescription)
186             || !preflightResult->allowsCrossOriginMethod(m_actualRequest->httpMethod(), accessControlErrorDescription)
187             || !preflightResult->allowsCrossOriginHeaders(m_actualRequest->httpHeaderFields(), accessControlErrorDescription)) {
188             preflightFailure(response.url(), accessControlErrorDescription);
189             return;
190         }
191
192         CrossOriginPreflightResultCache::shared().appendEntry(securityOrigin()->toString(), m_actualRequest->url(), preflightResult.release());
193     } else {
194         if (!m_sameOriginRequest && m_options.crossOriginRequestPolicy == UseAccessControl) {
195             if (!passesAccessControlCheck(response, m_options.allowCredentials, securityOrigin(), accessControlErrorDescription)) {
196                 m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, response.url().string(), accessControlErrorDescription));
197                 return;
198             }
199         }
200
201         m_client->didReceiveResponse(response);
202     }
203 }
204
205 void DocumentThreadableLoader::didReceiveData(SubresourceLoader* loader, const char* data, int dataLength)
206 {
207     ASSERT(m_client);
208     ASSERT_UNUSED(loader, loader == m_loader);
209
210     // Preflight data should be invisible to clients.
211     if (m_actualRequest)
212         return;
213
214     m_client->didReceiveData(data, dataLength);
215 }
216
217 void DocumentThreadableLoader::didReceiveCachedMetadata(SubresourceLoader* loader, const char* data, int dataLength)
218 {
219     ASSERT(m_client);
220     ASSERT_UNUSED(loader, loader == m_loader);
221
222     // Preflight data should be invisible to clients.
223     if (m_actualRequest)
224         return;
225
226     m_client->didReceiveCachedMetadata(data, dataLength);
227 }
228
229 void DocumentThreadableLoader::didFinishLoading(SubresourceLoader* loader, double finishTime)
230 {
231     ASSERT(loader == m_loader);
232     ASSERT(m_client);
233     didFinishLoading(loader->identifier(), finishTime);
234 }
235
236 void DocumentThreadableLoader::didFinishLoading(unsigned long identifier, double finishTime)
237 {
238     if (m_actualRequest) {
239         ASSERT(!m_sameOriginRequest);
240         ASSERT(m_options.crossOriginRequestPolicy == UseAccessControl);
241         preflightSuccess();
242     } else
243         m_client->didFinishLoading(identifier, finishTime);
244 }
245
246 void DocumentThreadableLoader::didFail(SubresourceLoader* loader, const ResourceError& error)
247 {
248     ASSERT(m_client);
249     // m_loader may be null if we arrive here via SubresourceLoader::create in the ctor
250     ASSERT_UNUSED(loader, loader == m_loader || !m_loader);
251
252     m_client->didFail(error);
253 }
254
255 bool DocumentThreadableLoader::getShouldUseCredentialStorage(SubresourceLoader* loader, bool& shouldUseCredentialStorage)
256 {
257     ASSERT_UNUSED(loader, loader == m_loader || !m_loader);
258
259     if (!m_options.allowCredentials) {
260         shouldUseCredentialStorage = false;
261         return true;
262     }
263
264     return false; // Only FrameLoaderClient can ultimately permit credential use.
265 }
266
267 void DocumentThreadableLoader::didReceiveAuthenticationChallenge(SubresourceLoader* loader, const AuthenticationChallenge& challenge)
268 {
269     ASSERT(loader == m_loader);
270     // Users are not prompted for credentials for cross-origin requests.
271     if (!m_sameOriginRequest) {
272 #if PLATFORM(MAC) || USE(CFNETWORK) || USE(CURL)
273         loader->handle()->receivedRequestToContinueWithoutCredential(challenge);
274 #else
275         // These platforms don't provide a way to continue without credentials, cancel the load altogether.
276         UNUSED_PARAM(challenge);
277         RefPtr<DocumentThreadableLoader> protect(this);
278         m_client->didFail(loader->blockedError());
279         cancel();
280 #endif
281     }
282 }
283
284 void DocumentThreadableLoader::receivedCancellation(SubresourceLoader* loader, const AuthenticationChallenge& challenge)
285 {
286     ASSERT(m_client);
287     ASSERT_UNUSED(loader, loader == m_loader);
288     m_client->didReceiveAuthenticationCancellation(challenge.failureResponse());
289 }
290
291 void DocumentThreadableLoader::preflightSuccess()
292 {
293     OwnPtr<ResourceRequest> actualRequest;
294     actualRequest.swap(m_actualRequest);
295
296     actualRequest->setHTTPOrigin(securityOrigin()->toString());
297
298     // It should be ok to skip the security check since we already asked about the preflight request.
299     loadRequest(*actualRequest, SkipSecurityCheck);
300 }
301
302 void DocumentThreadableLoader::preflightFailure(const String& url, const String& errorDescription)
303 {
304     m_actualRequest = nullptr; // Prevent didFinishLoading() from bypassing access check.
305     m_client->didFail(ResourceError(errorDomainWebKitInternal, 0, url, errorDescription));
306 }
307
308 void DocumentThreadableLoader::loadRequest(const ResourceRequest& request, SecurityCheckPolicy securityCheck)
309 {
310     // Any credential should have been removed from the cross-site requests.
311     const KURL& requestURL = request.url();
312     ASSERT(m_sameOriginRequest || requestURL.user().isEmpty());
313     ASSERT(m_sameOriginRequest || requestURL.pass().isEmpty());
314
315     if (m_async) {
316         // Don't sniff content or send load callbacks for the preflight request.
317         bool sendLoadCallbacks = m_options.sendLoadCallbacks && !m_actualRequest;
318         bool sniffContent = m_options.sniffContent && !m_actualRequest;
319         // Keep buffering the data for the preflight request.
320         bool shouldBufferData = m_options.shouldBufferData || m_actualRequest;
321
322         // Clear the loader so that any callbacks from SubresourceLoader::create will not have the old loader.
323         m_loader = 0;
324         m_loader = resourceLoadScheduler()->scheduleSubresourceLoad(m_document->frame(), this, request, ResourceLoadPriorityMedium, securityCheck, sendLoadCallbacks,
325                                                                     sniffContent, m_optionalOutgoingReferrer, shouldBufferData);
326         return;
327     }
328     
329     // FIXME: ThreadableLoaderOptions.sniffContent is not supported for synchronous requests.
330     StoredCredentials storedCredentials = m_options.allowCredentials ? AllowStoredCredentials : DoNotAllowStoredCredentials;
331
332     Vector<char> data;
333     ResourceError error;
334     ResourceResponse response;
335     unsigned long identifier = std::numeric_limits<unsigned long>::max();
336     if (m_document->frame())
337         identifier = m_document->frame()->loader()->loadResourceSynchronously(request, storedCredentials, error, response, data);
338
339     // No exception for file:/// resources, see <rdar://problem/4962298>.
340     // Also, if we have an HTTP response, then it wasn't a network error in fact.
341     if (!error.isNull() && !requestURL.isLocalFile() && response.httpStatusCode() <= 0) {
342         m_client->didFail(error);
343         return;
344     }
345
346     // FIXME: FrameLoader::loadSynchronously() does not tell us whether a redirect happened or not, so we guess by comparing the
347     // request and response URLs. This isn't a perfect test though, since a server can serve a redirect to the same URL that was
348     // requested. Also comparing the request and response URLs as strings will fail if the requestURL still has its credentials.
349     if (requestURL != response.url() && !isAllowedRedirect(response.url())) {
350         m_client->didFailRedirectCheck();
351         return;
352     }
353
354     didReceiveResponse(0, response);
355
356     const char* bytes = static_cast<const char*>(data.data());
357     int len = static_cast<int>(data.size());
358     didReceiveData(0, bytes, len);
359
360     didFinishLoading(identifier, 0.0);
361 }
362
363 bool DocumentThreadableLoader::isAllowedRedirect(const KURL& url)
364 {
365     if (m_options.crossOriginRequestPolicy == AllowCrossOriginRequests)
366         return true;
367
368     // FIXME: We need to implement access control for each redirect. This will require some refactoring though, because the code
369     // that processes redirects doesn't know about access control and expects a synchronous answer from its client about whether
370     // a redirect should proceed.
371     return m_sameOriginRequest && securityOrigin()->canRequest(url);
372 }
373
374 SecurityOrigin* DocumentThreadableLoader::securityOrigin() const
375 {
376     return m_options.securityOrigin ? m_options.securityOrigin.get() : m_document->securityOrigin();
377 }
378
379 } // namespace WebCore