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