src/third_party/WebKit/Source/web/AssociatedURLLoader.cpp

   1 /*
   2  * Copyright (C) 2010, 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 "AssociatedURLLoader.h"
  33
  34 #include "WebApplicationCacheHost.h"
  35 #include "WebDataSource.h"
  36 #include "WebFrameImpl.h"
  37 #include "core/fetch/CrossOriginAccessControl.h"
  38 #include "core/loader/DocumentThreadableLoader.h"
  39 #include "core/loader/DocumentThreadableLoaderClient.h"
  40 #include "core/xml/XMLHttpRequest.h"
  41 #include "platform/Timer.h"
  42 #include "platform/exported/WrappedResourceRequest.h"
  43 #include "platform/exported/WrappedResourceResponse.h"
  44 #include "platform/network/HTTPParsers.h"
  45 #include "platform/network/ResourceError.h"
  46 #include "public/platform/WebHTTPHeaderVisitor.h"
  47 #include "public/platform/WebString.h"
  48 #include "public/platform/WebURLError.h"
  49 #include "public/platform/WebURLLoaderClient.h"
  50 #include "public/platform/WebURLRequest.h"
  51 #include "wtf/HashSet.h"
  52 #include "wtf/text/WTFString.h"
  53
  54 using namespace WebCore;
  55 using namespace WTF;
  56
  57 namespace blink {
  58
  59 namespace {
  60
  61 class HTTPRequestHeaderValidator : public WebHTTPHeaderVisitor {
  62     WTF_MAKE_NONCOPYABLE(HTTPRequestHeaderValidator);
  63 public:
  64     HTTPRequestHeaderValidator() : m_isSafe(true) { }
  65
  66     void visitHeader(const WebString& name, const WebString& value);
  67     bool isSafe() const { return m_isSafe; }
  68
  69 private:
  70     bool m_isSafe;
  71 };
  72
  73 typedef HashSet<String, CaseFoldingHash> HTTPHeaderSet;
  74
  75 void HTTPRequestHeaderValidator::visitHeader(const WebString& name, const WebString& value)
  76 {
  77     m_isSafe = m_isSafe && isValidHTTPToken(name) && XMLHttpRequest::isAllowedHTTPHeader(name) && isValidHTTPHeaderValue(value);
  78 }
  79
  80 // FIXME: Remove this and use WebCore code that does the same thing.
  81 class HTTPResponseHeaderValidator : public WebHTTPHeaderVisitor {
  82     WTF_MAKE_NONCOPYABLE(HTTPResponseHeaderValidator);
  83 public:
  84     HTTPResponseHeaderValidator(bool usingAccessControl) : m_usingAccessControl(usingAccessControl) { }
  85
  86     void visitHeader(const WebString& name, const WebString& value);
  87     const HTTPHeaderSet& blockedHeaders();
  88
  89 private:
  90     HTTPHeaderSet m_exposedHeaders;
  91     HTTPHeaderSet m_blockedHeaders;
  92     bool m_usingAccessControl;
  93 };
  94
  95 void HTTPResponseHeaderValidator::visitHeader(const WebString& name, const WebString& value)
  96 {
  97     String headerName(name);
  98     if (m_usingAccessControl) {
  99         if (equalIgnoringCase(headerName, "access-control-expose-headers"))
 100             parseAccessControlExposeHeadersAllowList(value, m_exposedHeaders);
 101         else if (!isOnAccessControlResponseHeaderWhitelist(headerName))
 102             m_blockedHeaders.add(name);
 103     }
 104 }
 105
 106 const HTTPHeaderSet& HTTPResponseHeaderValidator::blockedHeaders()
 107 {
 108     // Remove exposed headers from the blocked set.
 109     if (!m_exposedHeaders.isEmpty()) {
 110         // Don't allow Set-Cookie headers to be exposed.
 111         m_exposedHeaders.remove("set-cookie");
 112         m_exposedHeaders.remove("set-cookie2");
 113         // Block Access-Control-Expose-Header itself. It could be exposed later.
 114         m_blockedHeaders.add("access-control-expose-headers");
 115         HTTPHeaderSet::const_iterator end = m_exposedHeaders.end();
 116         for (HTTPHeaderSet::const_iterator it = m_exposedHeaders.begin(); it != end; ++it)
 117             m_blockedHeaders.remove(*it);
 118     }
 119
 120     return m_blockedHeaders;
 121 }
 122
 123 }
 124
 125 // This class bridges the interface differences between WebCore and WebKit loader clients.
 126 // It forwards its ThreadableLoaderClient notifications to a WebURLLoaderClient.
 127 class AssociatedURLLoader::ClientAdapter FINAL : public DocumentThreadableLoaderClient {
 128     WTF_MAKE_NONCOPYABLE(ClientAdapter);
 129 public:
 130     static PassOwnPtr<ClientAdapter> create(AssociatedURLLoader*, WebURLLoaderClient*, const WebURLLoaderOptions&);
 131
 132     virtual void didSendData(unsigned long long /*bytesSent*/, unsigned long long /*totalBytesToBeSent*/) OVERRIDE;
 133     virtual void willSendRequest(ResourceRequest& /*newRequest*/, const ResourceResponse& /*redirectResponse*/) OVERRIDE;
 134
 135     virtual void didReceiveResponse(unsigned long, const ResourceResponse&) OVERRIDE;
 136     virtual void didDownloadData(int /*dataLength*/) OVERRIDE;
 137     virtual void didReceiveData(const char*, int /*dataLength*/) OVERRIDE;
 138     virtual void didReceiveCachedMetadata(const char*, int /*dataLength*/) OVERRIDE;
 139     virtual void didFinishLoading(unsigned long /*identifier*/, double /*finishTime*/) OVERRIDE;
 140     virtual void didFail(const ResourceError&) OVERRIDE;
 141     virtual void didFailRedirectCheck() OVERRIDE;
 142
 143     // Sets an error to be reported back to the client, asychronously.
 144     void setDelayedError(const ResourceError&);
 145
 146     // Enables forwarding of error notifications to the WebURLLoaderClient. These must be
 147     // deferred until after the call to AssociatedURLLoader::loadAsynchronously() completes.
 148     void enableErrorNotifications();
 149
 150     // Stops loading and releases the DocumentThreadableLoader as early as possible.
 151     void clearClient() { m_client = 0; }
 152
 153 private:
 154     ClientAdapter(AssociatedURLLoader*, WebURLLoaderClient*, const WebURLLoaderOptions&);
 155
 156     void notifyError(Timer<ClientAdapter>*);
 157
 158     AssociatedURLLoader* m_loader;
 159     WebURLLoaderClient* m_client;
 160     WebURLLoaderOptions m_options;
 161     WebURLError m_error;
 162
 163     Timer<ClientAdapter> m_errorTimer;
 164     bool m_enableErrorNotifications;
 165     bool m_didFail;
 166 };
 167
 168 PassOwnPtr<AssociatedURLLoader::ClientAdapter> AssociatedURLLoader::ClientAdapter::create(AssociatedURLLoader* loader, WebURLLoaderClient* client, const WebURLLoaderOptions& options)
 169 {
 170     return adoptPtr(new ClientAdapter(loader, client, options));
 171 }
 172
 173 AssociatedURLLoader::ClientAdapter::ClientAdapter(AssociatedURLLoader* loader, WebURLLoaderClient* client, const WebURLLoaderOptions& options)
 174     : m_loader(loader)
 175     , m_client(client)
 176     , m_options(options)
 177     , m_errorTimer(this, &ClientAdapter::notifyError)
 178     , m_enableErrorNotifications(false)
 179     , m_didFail(false)
 180 {
 181     ASSERT(m_loader);
 182     ASSERT(m_client);
 183 }
 184
 185 void AssociatedURLLoader::ClientAdapter::willSendRequest(ResourceRequest& newRequest, const ResourceResponse& redirectResponse)
 186 {
 187     if (!m_client)
 188         return;
 189
 190     WrappedResourceRequest wrappedNewRequest(newRequest);
 191     WrappedResourceResponse wrappedRedirectResponse(redirectResponse);
 192     m_client->willSendRequest(m_loader, wrappedNewRequest, wrappedRedirectResponse);
 193 }
 194
 195 void AssociatedURLLoader::ClientAdapter::didSendData(unsigned long long bytesSent, unsigned long long totalBytesToBeSent)
 196 {
 197     if (!m_client)
 198         return;
 199
 200     m_client->didSendData(m_loader, bytesSent, totalBytesToBeSent);
 201 }
 202
 203 void AssociatedURLLoader::ClientAdapter::didReceiveResponse(unsigned long, const ResourceResponse& response)
 204 {
 205     // Try to use the original ResourceResponse if possible.
 206     WebURLResponse validatedResponse = WrappedResourceResponse(response);
 207     HTTPResponseHeaderValidator validator(m_options.crossOriginRequestPolicy == WebURLLoaderOptions::CrossOriginRequestPolicyUseAccessControl);
 208     if (!m_options.exposeAllResponseHeaders)
 209         validatedResponse.visitHTTPHeaderFields(&validator);
 210
 211     // If there are blocked headers, copy the response so we can remove them.
 212     const HTTPHeaderSet& blockedHeaders = validator.blockedHeaders();
 213     if (!blockedHeaders.isEmpty()) {
 214         validatedResponse = WebURLResponse(validatedResponse);
 215         HTTPHeaderSet::const_iterator end = blockedHeaders.end();
 216         for (HTTPHeaderSet::const_iterator it = blockedHeaders.begin(); it != end; ++it)
 217             validatedResponse.clearHTTPHeaderField(*it);
 218     }
 219     m_client->didReceiveResponse(m_loader, validatedResponse);
 220 }
 221
 222 void AssociatedURLLoader::ClientAdapter::didDownloadData(int dataLength)
 223 {
 224     if (!m_client)
 225         return;
 226
 227     m_client->didDownloadData(m_loader, dataLength, -1);
 228 }
 229
 230 void AssociatedURLLoader::ClientAdapter::didReceiveData(const char* data, int dataLength)
 231 {
 232     if (!m_client)
 233         return;
 234
 235     m_client->didReceiveData(m_loader, data, dataLength, -1);
 236 }
 237
 238 void AssociatedURLLoader::ClientAdapter::didReceiveCachedMetadata(const char* data, int dataLength)
 239 {
 240     if (!m_client)
 241         return;
 242
 243     m_client->didReceiveCachedMetadata(m_loader, data, dataLength);
 244 }
 245
 246 void AssociatedURLLoader::ClientAdapter::didFinishLoading(unsigned long identifier, double finishTime)
 247 {
 248     if (!m_client)
 249         return;
 250
 251     m_client->didFinishLoading(m_loader, finishTime, WebURLLoaderClient::kUnknownEncodedDataLength);
 252 }
 253
 254 void AssociatedURLLoader::ClientAdapter::didFail(const ResourceError& error)
 255 {
 256     if (!m_client)
 257         return;
 258
 259     m_didFail = true;
 260     m_error = WebURLError(error);
 261     if (m_enableErrorNotifications)
 262         notifyError(&m_errorTimer);
 263 }
 264
 265 void AssociatedURLLoader::ClientAdapter::didFailRedirectCheck()
 266 {
 267     m_loader->cancel();
 268 }
 269
 270 void AssociatedURLLoader::ClientAdapter::setDelayedError(const ResourceError& error)
 271 {
 272     didFail(error);
 273 }
 274
 275 void AssociatedURLLoader::ClientAdapter::enableErrorNotifications()
 276 {
 277     m_enableErrorNotifications = true;
 278     // If an error has already been received, start a timer to report it to the client
 279     // after AssociatedURLLoader::loadAsynchronously has returned to the caller.
 280     if (m_didFail)
 281         m_errorTimer.startOneShot(0);
 282 }
 283
 284 void AssociatedURLLoader::ClientAdapter::notifyError(Timer<ClientAdapter>* timer)
 285 {
 286     ASSERT_UNUSED(timer, timer == &m_errorTimer);
 287
 288     m_client->didFail(m_loader, m_error);
 289 }
 290
 291 AssociatedURLLoader::AssociatedURLLoader(PassRefPtr<WebFrameImpl> frameImpl, const WebURLLoaderOptions& options)
 292     : m_frameImpl(frameImpl)
 293     , m_options(options)
 294     , m_client(0)
 295 {
 296     ASSERT(m_frameImpl);
 297 }
 298
 299 AssociatedURLLoader::~AssociatedURLLoader()
 300 {
 301     cancel();
 302 }
 303
 304 #define COMPILE_ASSERT_MATCHING_ENUM(webkit_name, webcore_name) \
 305     COMPILE_ASSERT(static_cast<int>(blink::webkit_name) == static_cast<int>(WebCore::webcore_name), mismatching_enums)
 306
 307 COMPILE_ASSERT_MATCHING_ENUM(WebURLLoaderOptions::CrossOriginRequestPolicyDeny, DenyCrossOriginRequests);
 308 COMPILE_ASSERT_MATCHING_ENUM(WebURLLoaderOptions::CrossOriginRequestPolicyUseAccessControl, UseAccessControl);
 309 COMPILE_ASSERT_MATCHING_ENUM(WebURLLoaderOptions::CrossOriginRequestPolicyAllow, AllowCrossOriginRequests);
 310
 311 COMPILE_ASSERT_MATCHING_ENUM(WebURLLoaderOptions::ConsiderPreflight, ConsiderPreflight);
 312 COMPILE_ASSERT_MATCHING_ENUM(WebURLLoaderOptions::ForcePreflight, ForcePreflight);
 313 COMPILE_ASSERT_MATCHING_ENUM(WebURLLoaderOptions::PreventPreflight, PreventPreflight);
 314
 315 void AssociatedURLLoader::loadSynchronously(const WebURLRequest& request, WebURLResponse& response, WebURLError& error, WebData& data)
 316 {
 317     ASSERT(0); // Synchronous loading is not supported.
 318 }
 319
 320 void AssociatedURLLoader::loadAsynchronously(const WebURLRequest& request, WebURLLoaderClient* client)
 321 {
 322     ASSERT(!m_client);
 323
 324     m_client = client;
 325     ASSERT(m_client);
 326
 327     bool allowLoad = true;
 328     WebURLRequest newRequest(request);
 329     if (m_options.untrustedHTTP) {
 330         WebString method = newRequest.httpMethod();
 331         allowLoad = isValidHTTPToken(method) && XMLHttpRequest::isAllowedHTTPMethod(method);
 332         if (allowLoad) {
 333             newRequest.setHTTPMethod(XMLHttpRequest::uppercaseKnownHTTPMethod(method));
 334             HTTPRequestHeaderValidator validator;
 335             newRequest.visitHTTPHeaderFields(&validator);
 336             allowLoad = validator.isSafe();
 337         }
 338     }
 339
 340     m_clientAdapter = ClientAdapter::create(this, m_client, m_options);
 341
 342     if (allowLoad) {
 343         ThreadableLoaderOptions options;
 344         options.sniffContent = m_options.sniffContent ? SniffContent : DoNotSniffContent;
 345         options.allowCredentials = m_options.allowCredentials ? AllowStoredCredentials : DoNotAllowStoredCredentials;
 346         options.preflightPolicy = static_cast<WebCore::PreflightPolicy>(m_options.preflightPolicy);
 347         options.crossOriginRequestPolicy = static_cast<WebCore::CrossOriginRequestPolicy>(m_options.crossOriginRequestPolicy);
 348         options.dataBufferingPolicy = DoNotBufferData;
 349
 350         const ResourceRequest& webcoreRequest = newRequest.toResourceRequest();
 351         Document* webcoreDocument = m_frameImpl->frame()->document();
 352         m_loader = DocumentThreadableLoader::create(webcoreDocument, m_clientAdapter.get(), webcoreRequest, options);
 353     } else {
 354         // FIXME: return meaningful error codes.
 355         m_clientAdapter->setDelayedError(ResourceError());
 356     }
 357     m_clientAdapter->enableErrorNotifications();
 358 }
 359
 360 void AssociatedURLLoader::cancel()
 361 {
 362     if (m_clientAdapter)
 363         m_clientAdapter->clearClient();
 364     if (m_loader)
 365         m_loader->cancel();
 366 }
 367
 368 void AssociatedURLLoader::setDefersLoading(bool defersLoading)
 369 {
 370     if (m_loader)
 371         m_loader->setDefersLoading(defersLoading);
 372 }
 373
 374 } // namespace blink