net/test/spawned_test_server/base_test_server.cc

   1 // Copyright 2013 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 "net/test/spawned_test_server/base_test_server.h"
   6
   7 #include <string>
   8 #include <vector>
   9
  10 #include "base/base64.h"
  11 #include "base/files/file_util.h"
  12 #include "base/json/json_reader.h"
  13 #include "base/logging.h"
  14 #include "base/path_service.h"
  15 #include "base/values.h"
  16 #include "net/base/address_list.h"
  17 #include "net/base/host_port_pair.h"
  18 #include "net/base/net_errors.h"
  19 #include "net/base/port_util.h"
  20 #include "net/base/test_completion_callback.h"
  21 #include "net/cert/test_root_certs.h"
  22 #include "net/dns/host_resolver.h"
  23 #include "net/log/net_log.h"
  24 #include "url/gurl.h"
  25
  26 namespace net {
  27
  28 namespace {
  29
  30 std::string GetHostname(BaseTestServer::Type type,
  31                         const BaseTestServer::SSLOptions& options) {
  32   if (BaseTestServer::UsingSSL(type)) {
  33     if (options.server_certificate ==
  34             BaseTestServer::SSLOptions::CERT_MISMATCHED_NAME ||
  35         options.server_certificate ==
  36             BaseTestServer::SSLOptions::CERT_COMMON_NAME_IS_DOMAIN) {
  37       // For |CERT_MISMATCHED_NAME|, return a different hostname string
  38       // that resolves to the same hostname. For
  39       // |CERT_COMMON_NAME_IS_DOMAIN|, the certificate is issued for
  40       // "localhost" instead of "127.0.0.1".
  41       return "localhost";
  42     }
  43   }
  44
  45   // Use the 127.0.0.1 as default.
  46   return BaseTestServer::kLocalhost;
  47 }
  48
  49 std::string GetClientCertType(SSLClientCertType type) {
  50   switch (type) {
  51     case CLIENT_CERT_RSA_SIGN:
  52       return "rsa_sign";
  53     case CLIENT_CERT_ECDSA_SIGN:
  54       return "ecdsa_sign";
  55     default:
  56       NOTREACHED();
  57       return "";
  58   }
  59 }
  60
  61 void GetKeyExchangesList(int key_exchange, base::ListValue* values) {
  62   if (key_exchange & BaseTestServer::SSLOptions::KEY_EXCHANGE_RSA)
  63     values->Append(new base::StringValue("rsa"));
  64   if (key_exchange & BaseTestServer::SSLOptions::KEY_EXCHANGE_DHE_RSA)
  65     values->Append(new base::StringValue("dhe_rsa"));
  66   if (key_exchange & BaseTestServer::SSLOptions::KEY_EXCHANGE_ECDHE_RSA)
  67     values->Append(new base::StringValue("ecdhe_rsa"));
  68 }
  69
  70 void GetCiphersList(int cipher, base::ListValue* values) {
  71   if (cipher & BaseTestServer::SSLOptions::BULK_CIPHER_RC4)
  72     values->Append(new base::StringValue("rc4"));
  73   if (cipher & BaseTestServer::SSLOptions::BULK_CIPHER_AES128)
  74     values->Append(new base::StringValue("aes128"));
  75   if (cipher & BaseTestServer::SSLOptions::BULK_CIPHER_AES256)
  76     values->Append(new base::StringValue("aes256"));
  77   if (cipher & BaseTestServer::SSLOptions::BULK_CIPHER_3DES)
  78     values->Append(new base::StringValue("3des"));
  79   if (cipher & BaseTestServer::SSLOptions::BULK_CIPHER_AES128GCM)
  80     values->Append(new base::StringValue("aes128gcm"));
  81 }
  82
  83 base::StringValue* GetTLSIntoleranceType(
  84     BaseTestServer::SSLOptions::TLSIntoleranceType type) {
  85   switch (type) {
  86     case BaseTestServer::SSLOptions::TLS_INTOLERANCE_ALERT:
  87       return new base::StringValue("alert");
  88     case BaseTestServer::SSLOptions::TLS_INTOLERANCE_CLOSE:
  89       return new base::StringValue("close");
  90     case BaseTestServer::SSLOptions::TLS_INTOLERANCE_RESET:
  91       return new base::StringValue("reset");
  92     default:
  93       NOTREACHED();
  94       return new base::StringValue("");
  95   }
  96 }
  97
  98 }  // namespace
  99
 100 BaseTestServer::SSLOptions::SSLOptions()
 101     : server_certificate(CERT_OK),
 102       ocsp_status(OCSP_OK),
 103       cert_serial(0),
 104       request_client_certificate(false),
 105       key_exchanges(SSLOptions::KEY_EXCHANGE_ANY),
 106       bulk_ciphers(SSLOptions::BULK_CIPHER_ANY),
 107       record_resume(false),
 108       tls_intolerant(TLS_INTOLERANT_NONE),
 109       tls_intolerance_type(TLS_INTOLERANCE_ALERT),
 110       fallback_scsv_enabled(false),
 111       staple_ocsp_response(false),
 112       ocsp_server_unavailable(false),
 113       enable_npn(false),
 114       alert_after_handshake(false) {
 115 }
 116
 117 BaseTestServer::SSLOptions::SSLOptions(
 118     BaseTestServer::SSLOptions::ServerCertificate cert)
 119     : server_certificate(cert),
 120       ocsp_status(OCSP_OK),
 121       cert_serial(0),
 122       request_client_certificate(false),
 123       key_exchanges(SSLOptions::KEY_EXCHANGE_ANY),
 124       bulk_ciphers(SSLOptions::BULK_CIPHER_ANY),
 125       record_resume(false),
 126       tls_intolerant(TLS_INTOLERANT_NONE),
 127       tls_intolerance_type(TLS_INTOLERANCE_ALERT),
 128       fallback_scsv_enabled(false),
 129       staple_ocsp_response(false),
 130       ocsp_server_unavailable(false),
 131       enable_npn(false),
 132       alert_after_handshake(false) {
 133 }
 134
 135 BaseTestServer::SSLOptions::~SSLOptions() {}
 136
 137 base::FilePath BaseTestServer::SSLOptions::GetCertificateFile() const {
 138   switch (server_certificate) {
 139     case CERT_OK:
 140     case CERT_MISMATCHED_NAME:
 141       return base::FilePath(FILE_PATH_LITERAL("ok_cert.pem"));
 142     case CERT_COMMON_NAME_IS_DOMAIN:
 143       return base::FilePath(FILE_PATH_LITERAL("localhost_cert.pem"));
 144     case CERT_EXPIRED:
 145       return base::FilePath(FILE_PATH_LITERAL("expired_cert.pem"));
 146     case CERT_CHAIN_WRONG_ROOT:
 147       // This chain uses its own dedicated test root certificate to avoid
 148       // side-effects that may affect testing.
 149       return base::FilePath(FILE_PATH_LITERAL("redundant-server-chain.pem"));
 150     case CERT_AUTO:
 151       return base::FilePath();
 152     default:
 153       NOTREACHED();
 154   }
 155   return base::FilePath();
 156 }
 157
 158 std::string BaseTestServer::SSLOptions::GetOCSPArgument() const {
 159   if (server_certificate != CERT_AUTO)
 160     return std::string();
 161
 162   switch (ocsp_status) {
 163     case OCSP_OK:
 164       return "ok";
 165     case OCSP_REVOKED:
 166       return "revoked";
 167     case OCSP_INVALID:
 168       return "invalid";
 169     case OCSP_UNAUTHORIZED:
 170       return "unauthorized";
 171     case OCSP_UNKNOWN:
 172       return "unknown";
 173     default:
 174       NOTREACHED();
 175       return std::string();
 176   }
 177 }
 178
 179 const char BaseTestServer::kLocalhost[] = "127.0.0.1";
 180
 181 BaseTestServer::BaseTestServer(Type type, const std::string& host)
 182     : type_(type),
 183       started_(false),
 184       log_to_console_(false),
 185       ws_basic_auth_(false),
 186       no_anonymous_ftp_user_(false) {
 187   Init(host);
 188 }
 189
 190 BaseTestServer::BaseTestServer(Type type, const SSLOptions& ssl_options)
 191     : ssl_options_(ssl_options),
 192       type_(type),
 193       started_(false),
 194       log_to_console_(false),
 195       ws_basic_auth_(false),
 196       no_anonymous_ftp_user_(false) {
 197   DCHECK(UsingSSL(type));
 198   Init(GetHostname(type, ssl_options));
 199 }
 200
 201 BaseTestServer::~BaseTestServer() {}
 202
 203 const HostPortPair& BaseTestServer::host_port_pair() const {
 204   DCHECK(started_);
 205   return host_port_pair_;
 206 }
 207
 208 const base::DictionaryValue& BaseTestServer::server_data() const {
 209   DCHECK(started_);
 210   DCHECK(server_data_.get());
 211   return *server_data_;
 212 }
 213
 214 std::string BaseTestServer::GetScheme() const {
 215   switch (type_) {
 216     case TYPE_FTP:
 217       return "ftp";
 218     case TYPE_HTTP:
 219       return "http";
 220     case TYPE_HTTPS:
 221       return "https";
 222     case TYPE_WS:
 223       return "ws";
 224     case TYPE_WSS:
 225       return "wss";
 226     case TYPE_TCP_ECHO:
 227     case TYPE_UDP_ECHO:
 228     default:
 229       NOTREACHED();
 230   }
 231   return std::string();
 232 }
 233
 234 bool BaseTestServer::GetAddressList(AddressList* address_list) const {
 235   DCHECK(address_list);
 236
 237   scoped_ptr<HostResolver> resolver(HostResolver::CreateDefaultResolver(NULL));
 238   HostResolver::RequestInfo info(host_port_pair_);
 239   // Limit the lookup to IPv4. When started with the default
 240   // address of kLocalhost, testserver.py only supports IPv4.
 241   // If a custom hostname is used, it's possible that the test
 242   // server will listen on both IPv4 and IPv6, so this will
 243   // still work. The testserver does not support explicit
 244   // IPv6 literal hostnames.
 245   info.set_address_family(ADDRESS_FAMILY_IPV4);
 246   TestCompletionCallback callback;
 247   int rv = resolver->Resolve(info,
 248                              DEFAULT_PRIORITY,
 249                              address_list,
 250                              callback.callback(),
 251                              NULL,
 252                              BoundNetLog());
 253   if (rv == ERR_IO_PENDING)
 254     rv = callback.WaitForResult();
 255   if (rv != OK) {
 256     LOG(ERROR) << "Failed to resolve hostname: " << host_port_pair_.host();
 257     return false;
 258   }
 259   return true;
 260 }
 261
 262 uint16 BaseTestServer::GetPort() {
 263   return host_port_pair_.port();
 264 }
 265
 266 void BaseTestServer::SetPort(uint16 port) {
 267   host_port_pair_.set_port(port);
 268 }
 269
 270 GURL BaseTestServer::GetURL(const std::string& path) const {
 271   return GURL(GetScheme() + "://" + host_port_pair_.ToString() + "/" + path);
 272 }
 273
 274 GURL BaseTestServer::GetURLWithUser(const std::string& path,
 275                                 const std::string& user) const {
 276   return GURL(GetScheme() + "://" + user + "@" + host_port_pair_.ToString() +
 277               "/" + path);
 278 }
 279
 280 GURL BaseTestServer::GetURLWithUserAndPassword(const std::string& path,
 281                                            const std::string& user,
 282                                            const std::string& password) const {
 283   return GURL(GetScheme() + "://" + user + ":" + password + "@" +
 284               host_port_pair_.ToString() + "/" + path);
 285 }
 286
 287 // static
 288 bool BaseTestServer::GetFilePathWithReplacements(
 289     const std::string& original_file_path,
 290     const std::vector<StringPair>& text_to_replace,
 291     std::string* replacement_path) {
 292   std::string new_file_path = original_file_path;
 293   bool first_query_parameter = true;
 294   const std::vector<StringPair>::const_iterator end = text_to_replace.end();
 295   for (std::vector<StringPair>::const_iterator it = text_to_replace.begin();
 296        it != end;
 297        ++it) {
 298     const std::string& old_text = it->first;
 299     const std::string& new_text = it->second;
 300     std::string base64_old;
 301     std::string base64_new;
 302     base::Base64Encode(old_text, &base64_old);
 303     base::Base64Encode(new_text, &base64_new);
 304     if (first_query_parameter) {
 305       new_file_path += "?";
 306       first_query_parameter = false;
 307     } else {
 308       new_file_path += "&";
 309     }
 310     new_file_path += "replace_text=";
 311     new_file_path += base64_old;
 312     new_file_path += ":";
 313     new_file_path += base64_new;
 314   }
 315
 316   *replacement_path = new_file_path;
 317   return true;
 318 }
 319
 320 bool BaseTestServer::LoadTestRootCert() const {
 321   TestRootCerts* root_certs = TestRootCerts::GetInstance();
 322   if (!root_certs)
 323     return false;
 324
 325   // Should always use absolute path to load the root certificate.
 326   base::FilePath root_certificate_path = certificates_dir_;
 327   if (!certificates_dir_.IsAbsolute()) {
 328     base::FilePath src_dir;
 329     if (!PathService::Get(base::DIR_SOURCE_ROOT, &src_dir))
 330       return false;
 331     root_certificate_path = src_dir.Append(certificates_dir_);
 332   }
 333
 334   return root_certs->AddFromFile(
 335       root_certificate_path.AppendASCII("root_ca_cert.pem"));
 336 }
 337
 338 void BaseTestServer::Init(const std::string& host) {
 339   host_port_pair_ = HostPortPair(host, 0);
 340
 341   // TODO(battre) Remove this after figuring out why the TestServer is flaky.
 342   // http://crbug.com/96594
 343   log_to_console_ = true;
 344 }
 345
 346 void BaseTestServer::SetResourcePath(const base::FilePath& document_root,
 347                                      const base::FilePath& certificates_dir) {
 348   // This method shouldn't get called twice.
 349   DCHECK(certificates_dir_.empty());
 350   document_root_ = document_root;
 351   certificates_dir_ = certificates_dir;
 352   DCHECK(!certificates_dir_.empty());
 353 }
 354
 355 bool BaseTestServer::ParseServerData(const std::string& server_data) {
 356   VLOG(1) << "Server data: " << server_data;
 357   base::JSONReader json_reader;
 358   scoped_ptr<base::Value> value(json_reader.ReadToValue(server_data));
 359   if (!value.get() || !value->IsType(base::Value::TYPE_DICTIONARY)) {
 360     LOG(ERROR) << "Could not parse server data: "
 361                << json_reader.GetErrorMessage();
 362     return false;
 363   }
 364
 365   server_data_.reset(static_cast<base::DictionaryValue*>(value.release()));
 366   int port = 0;
 367   if (!server_data_->GetInteger("port", &port)) {
 368     LOG(ERROR) << "Could not find port value";
 369     return false;
 370   }
 371   if ((port <= 0) || (port > kuint16max)) {
 372     LOG(ERROR) << "Invalid port value: " << port;
 373     return false;
 374   }
 375   host_port_pair_.set_port(port);
 376
 377   return true;
 378 }
 379
 380 bool BaseTestServer::SetupWhenServerStarted() {
 381   DCHECK(host_port_pair_.port());
 382
 383   if (UsingSSL(type_) && !LoadTestRootCert())
 384       return false;
 385
 386   started_ = true;
 387   allowed_port_.reset(new ScopedPortException(host_port_pair_.port()));
 388   return true;
 389 }
 390
 391 void BaseTestServer::CleanUpWhenStoppingServer() {
 392   TestRootCerts* root_certs = TestRootCerts::GetInstance();
 393   root_certs->Clear();
 394
 395   host_port_pair_.set_port(0);
 396   allowed_port_.reset();
 397   started_ = false;
 398 }
 399
 400 // Generates a dictionary of arguments to pass to the Python test server via
 401 // the test server spawner, in the form of
 402 // { argument-name: argument-value, ... }
 403 // Returns false if an invalid configuration is specified.
 404 bool BaseTestServer::GenerateArguments(base::DictionaryValue* arguments) const {
 405   DCHECK(arguments);
 406
 407   arguments->SetString("host", host_port_pair_.host());
 408   arguments->SetInteger("port", host_port_pair_.port());
 409   arguments->SetString("data-dir", document_root_.value());
 410
 411   if (VLOG_IS_ON(1) || log_to_console_)
 412     arguments->Set("log-to-console", base::Value::CreateNullValue());
 413
 414   if (ws_basic_auth_) {
 415     DCHECK(type_ == TYPE_WS || type_ == TYPE_WSS);
 416     arguments->Set("ws-basic-auth", base::Value::CreateNullValue());
 417   }
 418
 419   if (no_anonymous_ftp_user_) {
 420     DCHECK_EQ(TYPE_FTP, type_);
 421     arguments->Set("no-anonymous-ftp-user", base::Value::CreateNullValue());
 422   }
 423
 424   if (UsingSSL(type_)) {
 425     // Check the certificate arguments of the HTTPS server.
 426     base::FilePath certificate_path(certificates_dir_);
 427     base::FilePath certificate_file(ssl_options_.GetCertificateFile());
 428     if (!certificate_file.value().empty()) {
 429       certificate_path = certificate_path.Append(certificate_file);
 430       if (certificate_path.IsAbsolute() &&
 431           !base::PathExists(certificate_path)) {
 432         LOG(ERROR) << "Certificate path " << certificate_path.value()
 433                    << " doesn't exist. Can't launch https server.";
 434         return false;
 435       }
 436       arguments->SetString("cert-and-key-file", certificate_path.value());
 437     }
 438
 439     // Check the client certificate related arguments.
 440     if (ssl_options_.request_client_certificate)
 441       arguments->Set("ssl-client-auth", base::Value::CreateNullValue());
 442     scoped_ptr<base::ListValue> ssl_client_certs(new base::ListValue());
 443
 444     std::vector<base::FilePath>::const_iterator it;
 445     for (it = ssl_options_.client_authorities.begin();
 446          it != ssl_options_.client_authorities.end(); ++it) {
 447       if (it->IsAbsolute() && !base::PathExists(*it)) {
 448         LOG(ERROR) << "Client authority path " << it->value()
 449                    << " doesn't exist. Can't launch https server.";
 450         return false;
 451       }
 452       ssl_client_certs->Append(new base::StringValue(it->value()));
 453     }
 454
 455     if (ssl_client_certs->GetSize())
 456       arguments->Set("ssl-client-ca", ssl_client_certs.release());
 457
 458     scoped_ptr<base::ListValue> client_cert_types(new base::ListValue());
 459     for (size_t i = 0; i < ssl_options_.client_cert_types.size(); i++) {
 460       client_cert_types->Append(new base::StringValue(
 461           GetClientCertType(ssl_options_.client_cert_types[i])));
 462     }
 463     if (client_cert_types->GetSize())
 464       arguments->Set("ssl-client-cert-type", client_cert_types.release());
 465   }
 466
 467   if (type_ == TYPE_HTTPS) {
 468     arguments->Set("https", base::Value::CreateNullValue());
 469
 470     std::string ocsp_arg = ssl_options_.GetOCSPArgument();
 471     if (!ocsp_arg.empty())
 472       arguments->SetString("ocsp", ocsp_arg);
 473
 474     if (ssl_options_.cert_serial != 0) {
 475       arguments->SetInteger("cert-serial", ssl_options_.cert_serial);
 476     }
 477
 478     // Check key exchange argument.
 479     scoped_ptr<base::ListValue> key_exchange_values(new base::ListValue());
 480     GetKeyExchangesList(ssl_options_.key_exchanges, key_exchange_values.get());
 481     if (key_exchange_values->GetSize())
 482       arguments->Set("ssl-key-exchange", key_exchange_values.release());
 483     // Check bulk cipher argument.
 484     scoped_ptr<base::ListValue> bulk_cipher_values(new base::ListValue());
 485     GetCiphersList(ssl_options_.bulk_ciphers, bulk_cipher_values.get());
 486     if (bulk_cipher_values->GetSize())
 487       arguments->Set("ssl-bulk-cipher", bulk_cipher_values.release());
 488     if (ssl_options_.record_resume)
 489       arguments->Set("https-record-resume", base::Value::CreateNullValue());
 490     if (ssl_options_.tls_intolerant != SSLOptions::TLS_INTOLERANT_NONE) {
 491       arguments->SetInteger("tls-intolerant", ssl_options_.tls_intolerant);
 492       arguments->Set("tls-intolerance-type", GetTLSIntoleranceType(
 493           ssl_options_.tls_intolerance_type));
 494     }
 495     if (ssl_options_.fallback_scsv_enabled)
 496       arguments->Set("fallback-scsv", base::Value::CreateNullValue());
 497     if (!ssl_options_.signed_cert_timestamps_tls_ext.empty()) {
 498       std::string b64_scts_tls_ext;
 499       base::Base64Encode(ssl_options_.signed_cert_timestamps_tls_ext,
 500                          &b64_scts_tls_ext);
 501       arguments->SetString("signed-cert-timestamps-tls-ext", b64_scts_tls_ext);
 502     }
 503     if (ssl_options_.staple_ocsp_response)
 504       arguments->Set("staple-ocsp-response", base::Value::CreateNullValue());
 505     if (ssl_options_.ocsp_server_unavailable) {
 506       arguments->Set("ocsp-server-unavailable",
 507                      base::Value::CreateNullValue());
 508     }
 509     if (ssl_options_.enable_npn)
 510       arguments->Set("enable-npn", base::Value::CreateNullValue());
 511     if (ssl_options_.alert_after_handshake)
 512       arguments->Set("alert-after-handshake", base::Value::CreateNullValue());
 513   }
 514
 515   return GenerateAdditionalArguments(arguments);
 516 }
 517
 518 bool BaseTestServer::GenerateAdditionalArguments(
 519     base::DictionaryValue* arguments) const {
 520   return true;
 521 }
 522
 523 }  // namespace net