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