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