src/chrome/browser/net/connection_tester.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/net/connection_tester.h"
   6
   7 #include "base/bind.h"
   8 #include "base/command_line.h"
   9 #include "base/compiler_specific.h"
  10 #include "base/logging.h"
  11 #include "base/memory/weak_ptr.h"
  12 #include "base/message_loop/message_loop.h"
  13 #include "base/strings/utf_string_conversions.h"
  14 #include "base/thread_task_runner_handle.h"
  15 #include "base/threading/thread_restrictions.h"
  16 #include "chrome/common/chrome_switches.h"
  17 #include "content/public/browser/browser_thread.h"
  18 #include "content/public/browser/cookie_store_factory.h"
  19 #include "net/base/io_buffer.h"
  20 #include "net/base/net_errors.h"
  21 #include "net/base/net_util.h"
  22 #include "net/base/request_priority.h"
  23 #include "net/cert/cert_verifier.h"
  24 #include "net/dns/host_resolver.h"
  25 #include "net/http/http_auth_handler_factory.h"
  26 #include "net/http/http_cache.h"
  27 #include "net/http/http_network_session.h"
  28 #include "net/http/http_server_properties_impl.h"
  29 #include "net/http/transport_security_state.h"
  30 #include "net/proxy/dhcp_proxy_script_fetcher_factory.h"
  31 #include "net/proxy/proxy_config_service_fixed.h"
  32 #include "net/proxy/proxy_script_fetcher_impl.h"
  33 #include "net/proxy/proxy_service.h"
  34 #include "net/proxy/proxy_service_v8.h"
  35 #include "net/ssl/ssl_config_service_defaults.h"
  36 #include "net/url_request/url_request.h"
  37 #include "net/url_request/url_request_context.h"
  38 #include "net/url_request/url_request_context_storage.h"
  39
  40 #if !defined(OS_ANDROID) && !defined(OS_IOS)
  41 #include "chrome/browser/net/firefox_proxy_settings.h"
  42 #endif
  43
  44 namespace {
  45
  46 // ExperimentURLRequestContext ------------------------------------------------
  47
  48 // An instance of ExperimentURLRequestContext is created for each experiment
  49 // run by ConnectionTester. The class initializes network dependencies according
  50 // to the specified "experiment".
  51 class ExperimentURLRequestContext : public net::URLRequestContext {
  52  public:
  53   explicit ExperimentURLRequestContext(
  54       net::URLRequestContext* proxy_request_context) :
  55 #if !defined(OS_IOS)
  56         proxy_request_context_(proxy_request_context),
  57 #endif
  58         storage_(this),
  59         weak_factory_(this) {}
  60
  61   virtual ~ExperimentURLRequestContext() {}
  62
  63   // Creates a proxy config service for |experiment|. On success returns net::OK
  64   // and fills |config_service| with a new pointer. Otherwise returns a network
  65   // error code.
  66   int CreateProxyConfigService(
  67       ConnectionTester::ProxySettingsExperiment experiment,
  68       scoped_ptr<net::ProxyConfigService>* config_service,
  69       base::Callback<void(int)> callback) {
  70     switch (experiment) {
  71       case ConnectionTester::PROXY_EXPERIMENT_USE_SYSTEM_SETTINGS:
  72         return CreateSystemProxyConfigService(config_service);
  73       case ConnectionTester::PROXY_EXPERIMENT_USE_FIREFOX_SETTINGS:
  74         return CreateFirefoxProxyConfigService(config_service, callback);
  75       case ConnectionTester::PROXY_EXPERIMENT_USE_AUTO_DETECT:
  76         config_service->reset(new net::ProxyConfigServiceFixed(
  77             net::ProxyConfig::CreateAutoDetect()));
  78         return net::OK;
  79       case ConnectionTester::PROXY_EXPERIMENT_USE_DIRECT:
  80         config_service->reset(new net::ProxyConfigServiceFixed(
  81             net::ProxyConfig::CreateDirect()));
  82         return net::OK;
  83       default:
  84         NOTREACHED();
  85         return net::ERR_UNEXPECTED;
  86     }
  87   }
  88
  89   int Init(const ConnectionTester::Experiment& experiment,
  90            scoped_ptr<net::ProxyConfigService>* proxy_config_service,
  91            net::NetLog* net_log) {
  92     int rv;
  93
  94     // Create a custom HostResolver for this experiment.
  95     scoped_ptr<net::HostResolver> host_resolver_tmp;
  96     rv = CreateHostResolver(experiment.host_resolver_experiment,
  97                             &host_resolver_tmp);
  98     if (rv != net::OK)
  99       return rv;  // Failure.
 100     storage_.set_host_resolver(host_resolver_tmp.Pass());
 101
 102     // Create a custom ProxyService for this this experiment.
 103     scoped_ptr<net::ProxyService> experiment_proxy_service;
 104     rv = CreateProxyService(experiment.proxy_settings_experiment,
 105                             proxy_config_service, &experiment_proxy_service);
 106     if (rv != net::OK)
 107       return rv;  // Failure.
 108     storage_.set_proxy_service(experiment_proxy_service.release());
 109
 110     // The rest of the dependencies are standard, and don't depend on the
 111     // experiment being run.
 112     storage_.set_cert_verifier(net::CertVerifier::CreateDefault());
 113     storage_.set_transport_security_state(new net::TransportSecurityState);
 114     storage_.set_ssl_config_service(new net::SSLConfigServiceDefaults);
 115     storage_.set_http_auth_handler_factory(
 116         net::HttpAuthHandlerFactory::CreateDefault(host_resolver()));
 117     storage_.set_http_server_properties(
 118         scoped_ptr<net::HttpServerProperties>(
 119             new net::HttpServerPropertiesImpl()));
 120
 121     net::HttpNetworkSession::Params session_params;
 122     session_params.host_resolver = host_resolver();
 123     session_params.cert_verifier = cert_verifier();
 124     session_params.transport_security_state = transport_security_state();
 125     session_params.proxy_service = proxy_service();
 126     session_params.ssl_config_service = ssl_config_service();
 127     session_params.http_auth_handler_factory = http_auth_handler_factory();
 128     session_params.http_server_properties = http_server_properties();
 129     session_params.net_log = net_log;
 130     scoped_refptr<net::HttpNetworkSession> network_session(
 131         new net::HttpNetworkSession(session_params));
 132     storage_.set_http_transaction_factory(new net::HttpCache(
 133         network_session.get(), net::HttpCache::DefaultBackend::InMemory(0)));
 134     // In-memory cookie store.
 135     storage_.set_cookie_store(
 136         content::CreateCookieStore(content::CookieStoreConfig()));
 137
 138     return net::OK;
 139   }
 140
 141  private:
 142   // Creates a host resolver for |experiment|. On success returns net::OK and
 143   // fills |host_resolver| with a new pointer. Otherwise returns a network
 144   // error code.
 145   int CreateHostResolver(
 146       ConnectionTester::HostResolverExperiment experiment,
 147       scoped_ptr<net::HostResolver>* host_resolver) {
 148     // Create a vanilla HostResolver that disables caching.
 149     const size_t kMaxJobs = 50u;
 150     const size_t kMaxRetryAttempts = 4u;
 151     net::HostResolver::Options options;
 152     options.max_concurrent_resolves = kMaxJobs;
 153     options.max_retry_attempts = kMaxRetryAttempts;
 154     options.enable_caching = false;
 155     scoped_ptr<net::HostResolver> resolver(
 156         net::HostResolver::CreateSystemResolver(options, NULL /* NetLog */));
 157
 158     // Modify it slightly based on the experiment being run.
 159     switch (experiment) {
 160       case ConnectionTester::HOST_RESOLVER_EXPERIMENT_PLAIN:
 161         break;
 162       case ConnectionTester::HOST_RESOLVER_EXPERIMENT_DISABLE_IPV6:
 163         resolver->SetDefaultAddressFamily(net::ADDRESS_FAMILY_IPV4);
 164         break;
 165       case ConnectionTester::HOST_RESOLVER_EXPERIMENT_IPV6_PROBE: {
 166         // The system HostResolver will probe by default.
 167         break;
 168       }
 169       default:
 170         NOTREACHED();
 171         return net::ERR_UNEXPECTED;
 172     }
 173     host_resolver->swap(resolver);
 174     return net::OK;
 175   }
 176
 177   // Creates a proxy service for |experiment|. On success returns net::OK
 178   // and fills |experiment_proxy_service| with a new pointer. Otherwise returns
 179   // a network error code.
 180   int CreateProxyService(
 181       ConnectionTester::ProxySettingsExperiment experiment,
 182       scoped_ptr<net::ProxyConfigService>* proxy_config_service,
 183       scoped_ptr<net::ProxyService>* experiment_proxy_service) {
 184     if (CommandLine::ForCurrentProcess()->HasSwitch(
 185         switches::kSingleProcess)) {
 186       // We can't create a standard proxy resolver in single-process mode.
 187       // Rather than falling-back to some other implementation, fail.
 188       return net::ERR_NOT_IMPLEMENTED;
 189     }
 190
 191     net::DhcpProxyScriptFetcherFactory dhcp_factory;
 192     if (CommandLine::ForCurrentProcess()->HasSwitch(
 193         switches::kDisableDhcpWpad)) {
 194       dhcp_factory.set_enabled(false);
 195     }
 196
 197 #if defined(OS_IOS)
 198     experiment_proxy_service->reset(
 199         net::ProxyService::CreateUsingSystemProxyResolver(
 200             proxy_config_service->release(), 0u, NULL));
 201 #else
 202     experiment_proxy_service->reset(
 203         net::CreateProxyServiceUsingV8ProxyResolver(
 204             proxy_config_service->release(),
 205             new net::ProxyScriptFetcherImpl(proxy_request_context_),
 206             dhcp_factory.Create(proxy_request_context_),
 207             host_resolver(),
 208             NULL,
 209             NULL));
 210 #endif
 211
 212     return net::OK;
 213   }
 214
 215   // Creates a proxy config service that pulls from the system proxy settings.
 216   // On success returns net::OK and fills |config_service| with a new pointer.
 217   // Otherwise returns a network error code.
 218   int CreateSystemProxyConfigService(
 219       scoped_ptr<net::ProxyConfigService>* config_service) {
 220 #if defined(OS_LINUX) || defined(OS_OPENBSD)
 221     // TODO(eroman): This is not supported on Linux yet, because of how
 222     // construction needs ot happen on the UI thread.
 223     return net::ERR_NOT_IMPLEMENTED;
 224 #else
 225     config_service->reset(net::ProxyService::CreateSystemProxyConfigService(
 226         base::ThreadTaskRunnerHandle::Get().get(), NULL));
 227     return net::OK;
 228 #endif
 229   }
 230
 231 #if !defined(OS_ANDROID) && !defined(OS_IOS)
 232   static int FirefoxProxySettingsTask(
 233       FirefoxProxySettings* firefox_settings) {
 234     if (!FirefoxProxySettings::GetSettings(firefox_settings))
 235       return net::ERR_FILE_NOT_FOUND;
 236     return net::OK;
 237   }
 238
 239   void FirefoxProxySettingsReply(
 240       scoped_ptr<net::ProxyConfigService>* config_service,
 241       FirefoxProxySettings* firefox_settings,
 242       base::Callback<void(int)> callback,
 243       int rv) {
 244     if (rv == net::OK) {
 245       if (FirefoxProxySettings::SYSTEM == firefox_settings->config_type()) {
 246         rv = CreateSystemProxyConfigService(config_service);
 247       } else {
 248         net::ProxyConfig config;
 249         if (firefox_settings->ToProxyConfig(&config))
 250           config_service->reset(new net::ProxyConfigServiceFixed(config));
 251         else
 252           rv = net::ERR_FAILED;
 253       }
 254     }
 255     callback.Run(rv);
 256   }
 257 #endif
 258
 259   // Creates a fixed proxy config service that is initialized using Firefox's
 260   // current proxy settings. On success returns net::OK and fills
 261   // |config_service| with a new pointer. Otherwise returns a network error
 262   // code.
 263   int CreateFirefoxProxyConfigService(
 264       scoped_ptr<net::ProxyConfigService>* config_service,
 265       base::Callback<void(int)> callback) {
 266 #if defined(OS_ANDROID) || defined(OS_IOS)
 267     // Chrome on Android and iOS do not support Firefox settings.
 268     return net::ERR_NOT_IMPLEMENTED;
 269 #else
 270     // Fetch Firefox's proxy settings (can fail if Firefox is not installed).
 271     FirefoxProxySettings* ff_settings = new FirefoxProxySettings();
 272     base::Callback<int(void)> task = base::Bind(
 273         &FirefoxProxySettingsTask, ff_settings);
 274     base::Callback<void(int)> reply = base::Bind(
 275         &ExperimentURLRequestContext::FirefoxProxySettingsReply,
 276         weak_factory_.GetWeakPtr(), config_service,
 277         base::Owned(ff_settings), callback);
 278     if (!content::BrowserThread::PostTaskAndReplyWithResult<int>(
 279             content::BrowserThread::FILE, FROM_HERE, task, reply))
 280       return net::ERR_FAILED;
 281     return net::ERR_IO_PENDING;
 282 #endif
 283   }
 284
 285 #if !defined(OS_IOS)
 286   net::URLRequestContext* const proxy_request_context_;
 287 #endif
 288   net::URLRequestContextStorage storage_;
 289   base::WeakPtrFactory<ExperimentURLRequestContext> weak_factory_;
 290 };
 291
 292 }  // namespace
 293
 294 // ConnectionTester::TestRunner ----------------------------------------------
 295
 296 // TestRunner is a helper class for running an individual experiment. It can
 297 // be deleted any time after it is started, and this will abort the request.
 298 class ConnectionTester::TestRunner : public net::URLRequest::Delegate {
 299  public:
 300   // |tester| must remain alive throughout the TestRunner's lifetime.
 301   // |tester| will be notified of completion.
 302   TestRunner(ConnectionTester* tester, net::NetLog* net_log)
 303       : tester_(tester),
 304         net_log_(net_log),
 305         weak_factory_(this) {}
 306
 307   // Finish running |experiment| once a ProxyConfigService has been created.
 308   // In the case of a FirefoxProxyConfigService, this will be called back
 309   // after disk access has completed.
 310   void ProxyConfigServiceCreated(
 311     const Experiment& experiment,
 312     scoped_ptr<net::ProxyConfigService>* proxy_config_service, int status);
 313
 314   // Starts running |experiment|. Notifies tester->OnExperimentCompleted() when
 315   // it is done.
 316   void Run(const Experiment& experiment);
 317
 318   // Overridden from net::URLRequest::Delegate:
 319   virtual void OnResponseStarted(net::URLRequest* request) OVERRIDE;
 320   virtual void OnReadCompleted(net::URLRequest* request,
 321                                int bytes_read) OVERRIDE;
 322   // TODO(eroman): handle cases requiring authentication.
 323
 324  private:
 325   // The number of bytes to read each response body chunk.
 326   static const int kReadBufferSize = 1024;
 327
 328   // Starts reading the response's body (and keeps reading until an error or
 329   // end of stream).
 330   void ReadBody(net::URLRequest* request);
 331
 332   // Called when the request has completed (for both success and failure).
 333   void OnResponseCompleted(net::URLRequest* request);
 334   void OnExperimentCompletedWithResult(int result);
 335
 336   ConnectionTester* tester_;
 337   scoped_ptr<ExperimentURLRequestContext> request_context_;
 338   scoped_ptr<net::URLRequest> request_;
 339   net::NetLog* net_log_;
 340
 341   base::WeakPtrFactory<TestRunner> weak_factory_;
 342
 343   DISALLOW_COPY_AND_ASSIGN(TestRunner);
 344 };
 345
 346 void ConnectionTester::TestRunner::OnResponseStarted(net::URLRequest* request) {
 347   if (!request->status().is_success()) {
 348     OnResponseCompleted(request);
 349     return;
 350   }
 351
 352   // Start reading the body.
 353   ReadBody(request);
 354 }
 355
 356 void ConnectionTester::TestRunner::OnReadCompleted(net::URLRequest* request,
 357                                                    int bytes_read) {
 358   if (bytes_read <= 0) {
 359     OnResponseCompleted(request);
 360     return;
 361   }
 362
 363   // Keep reading until the stream is closed. Throw the data read away.
 364   ReadBody(request);
 365 }
 366
 367 void ConnectionTester::TestRunner::ReadBody(net::URLRequest* request) {
 368   // Read the response body |kReadBufferSize| bytes at a time.
 369   scoped_refptr<net::IOBuffer> unused_buffer(
 370       new net::IOBuffer(kReadBufferSize));
 371   int num_bytes;
 372   if (request->Read(unused_buffer.get(), kReadBufferSize, &num_bytes)) {
 373     OnReadCompleted(request, num_bytes);
 374   } else if (!request->status().is_io_pending()) {
 375     // Read failed synchronously.
 376     OnResponseCompleted(request);
 377   }
 378 }
 379
 380 void ConnectionTester::TestRunner::OnResponseCompleted(
 381     net::URLRequest* request) {
 382   int result = net::OK;
 383   if (!request->status().is_success()) {
 384     DCHECK_NE(net::ERR_IO_PENDING, request->status().error());
 385     result = request->status().error();
 386   }
 387
 388   // Post a task to notify the parent rather than handling it right away,
 389   // to avoid re-entrancy problems with URLRequest. (Don't want the caller
 390   // to end up deleting the URLRequest while in the middle of processing).
 391   base::MessageLoop::current()->PostTask(
 392       FROM_HERE,
 393       base::Bind(&TestRunner::OnExperimentCompletedWithResult,
 394                  weak_factory_.GetWeakPtr(), result));
 395 }
 396
 397 void ConnectionTester::TestRunner::OnExperimentCompletedWithResult(int result) {
 398   tester_->OnExperimentCompleted(result);
 399 }
 400
 401 void ConnectionTester::TestRunner::ProxyConfigServiceCreated(
 402     const Experiment& experiment,
 403     scoped_ptr<net::ProxyConfigService>* proxy_config_service,
 404     int status) {
 405   if (status == net::OK)
 406     status = request_context_->Init(experiment,
 407                                     proxy_config_service,
 408                                     net_log_);
 409   if (status != net::OK) {
 410     tester_->OnExperimentCompleted(status);
 411     return;
 412   }
 413   // Fetch a request using the experimental context.
 414   request_ = request_context_->CreateRequest(
 415       experiment.url, net::DEFAULT_PRIORITY, this);
 416   request_->Start();
 417 }
 418
 419 void ConnectionTester::TestRunner::Run(const Experiment& experiment) {
 420   // Try to create a net::URLRequestContext for this experiment.
 421   request_context_.reset(
 422       new ExperimentURLRequestContext(tester_->proxy_request_context_));
 423   scoped_ptr<net::ProxyConfigService>* proxy_config_service =
 424       new scoped_ptr<net::ProxyConfigService>();
 425   base::Callback<void(int)> config_service_callback =
 426       base::Bind(
 427           &TestRunner::ProxyConfigServiceCreated, weak_factory_.GetWeakPtr(),
 428           experiment, base::Owned(proxy_config_service));
 429   int rv = request_context_->CreateProxyConfigService(
 430       experiment.proxy_settings_experiment,
 431       proxy_config_service, config_service_callback);
 432   if (rv != net::ERR_IO_PENDING)
 433     ProxyConfigServiceCreated(experiment, proxy_config_service, rv);
 434 }
 435
 436 // ConnectionTester ----------------------------------------------------------
 437
 438 ConnectionTester::ConnectionTester(
 439     Delegate* delegate,
 440     net::URLRequestContext* proxy_request_context,
 441     net::NetLog* net_log)
 442     : delegate_(delegate),
 443       proxy_request_context_(proxy_request_context),
 444       net_log_(net_log) {
 445   DCHECK(delegate);
 446   DCHECK(proxy_request_context);
 447 }
 448
 449 ConnectionTester::~ConnectionTester() {
 450   // Cancellation happens automatically by deleting test_runner_.
 451 }
 452
 453 void ConnectionTester::RunAllTests(const GURL& url) {
 454   // Select all possible experiments to run. (In no particular order).
 455   // It is possible that some of these experiments are actually duplicates.
 456   GetAllPossibleExperimentCombinations(url, &remaining_experiments_);
 457
 458   delegate_->OnStartConnectionTestSuite();
 459   StartNextExperiment();
 460 }
 461
 462 // static
 463 base::string16 ConnectionTester::ProxySettingsExperimentDescription(
 464     ProxySettingsExperiment experiment) {
 465   // TODO(eroman): Use proper string resources.
 466   switch (experiment) {
 467     case PROXY_EXPERIMENT_USE_DIRECT:
 468       return base::ASCIIToUTF16("Don't use any proxy");
 469     case PROXY_EXPERIMENT_USE_SYSTEM_SETTINGS:
 470       return base::ASCIIToUTF16("Use system proxy settings");
 471     case PROXY_EXPERIMENT_USE_FIREFOX_SETTINGS:
 472       return base::ASCIIToUTF16("Use Firefox's proxy settings");
 473     case PROXY_EXPERIMENT_USE_AUTO_DETECT:
 474       return base::ASCIIToUTF16("Auto-detect proxy settings");
 475     default:
 476       NOTREACHED();
 477       return base::string16();
 478   }
 479 }
 480
 481 // static
 482 base::string16 ConnectionTester::HostResolverExperimentDescription(
 483     HostResolverExperiment experiment) {
 484   // TODO(eroman): Use proper string resources.
 485   switch (experiment) {
 486     case HOST_RESOLVER_EXPERIMENT_PLAIN:
 487       return base::string16();
 488     case HOST_RESOLVER_EXPERIMENT_DISABLE_IPV6:
 489       return base::ASCIIToUTF16("Disable IPv6 host resolving");
 490     case HOST_RESOLVER_EXPERIMENT_IPV6_PROBE:
 491       return base::ASCIIToUTF16("Probe for IPv6 host resolving");
 492     default:
 493       NOTREACHED();
 494       return base::string16();
 495   }
 496 }
 497
 498 // static
 499 void ConnectionTester::GetAllPossibleExperimentCombinations(
 500     const GURL& url,
 501     ConnectionTester::ExperimentList* list) {
 502   list->clear();
 503   for (size_t resolver_experiment = 0;
 504        resolver_experiment < HOST_RESOLVER_EXPERIMENT_COUNT;
 505        ++resolver_experiment) {
 506     for (size_t proxy_experiment = 0;
 507          proxy_experiment < PROXY_EXPERIMENT_COUNT;
 508          ++proxy_experiment) {
 509       Experiment experiment(
 510           url,
 511           static_cast<ProxySettingsExperiment>(proxy_experiment),
 512           static_cast<HostResolverExperiment>(resolver_experiment));
 513       list->push_back(experiment);
 514     }
 515   }
 516 }
 517
 518 void ConnectionTester::StartNextExperiment() {
 519   DCHECK(!remaining_experiments_.empty());
 520   DCHECK(!current_test_runner_.get());
 521
 522   delegate_->OnStartConnectionTestExperiment(current_experiment());
 523
 524   current_test_runner_.reset(new TestRunner(this, net_log_));
 525   current_test_runner_->Run(current_experiment());
 526 }
 527
 528 void ConnectionTester::OnExperimentCompleted(int result) {
 529   Experiment current = current_experiment();
 530
 531   // Advance to the next experiment.
 532   remaining_experiments_.erase(remaining_experiments_.begin());
 533   current_test_runner_.reset();
 534
 535   // Notify the delegate of completion.
 536   delegate_->OnCompletedConnectionTestExperiment(current, result);
 537
 538   if (remaining_experiments_.empty()) {
 539     delegate_->OnCompletedConnectionTestSuite();
 540   } else {
 541     StartNextExperiment();
 542   }
 543 }