forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
clear_site_data_throttle.cc
559 lines (471 loc) · 19.8 KB
/
clear_site_data_throttle.cc
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
// Copyright 2016 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 "content/browser/browsing_data/clear_site_data_throttle.h"
#include "base/command_line.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/histogram_macros.h"
#include "base/scoped_observer.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/task/post_task.h"
#include "base/values.h"
#include "content/browser/service_worker/service_worker_response_info.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/browsing_data_filter_builder.h"
#include "content/public/browser/browsing_data_remover.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/web_contents.h"
#include "content/public/common/content_switches.h"
#include "content/public/common/origin_util.h"
#include "content/public/common/resource_type.h"
#include "net/base/load_flags.h"
#include "net/base/registry_controlled_domains/registry_controlled_domain.h"
#include "net/http/http_response_headers.h"
#include "net/url_request/redirect_info.h"
#include "services/network/public/cpp/resource_response_info.h"
#include "url/gurl.h"
#include "url/origin.h"
namespace content {
namespace {
// Appending '2' to avoid naming conflicts with 'clear_site_data_handler.h' in
// jumbo builds. This file will be removed later as mentioned in the header.
const char kNameForLogging2[] = "ClearSiteDataThrottle";
const char kClearSiteDataHeader2[] = "Clear-Site-Data";
// Datatypes.
const char kDatatypeWildcard2[] = "\"*\"";
const char kDatatypeCookies2[] = "\"cookies\"";
const char kDatatypeStorage2[] = "\"storage\"";
const char kDatatypeCache2[] = "\"cache\"";
// Pretty-printed log output.
const char kConsoleMessageTemplate2[] = "Clear-Site-Data header on '%s': %s";
const char kConsoleMessageCleared2[] = "Cleared data types: %s.";
const char kConsoleMessageDatatypeSeparator2[] = ", ";
bool AreExperimentalFeaturesEnabled2() {
return base::CommandLine::ForCurrentProcess()->HasSwitch(
switches::kEnableExperimentalWebPlatformFeatures);
}
bool IsNavigationRequest(net::URLRequest* request) {
const ResourceRequestInfo* info = ResourceRequestInfo::ForRequest(request);
return info && IsResourceTypeFrame(info->GetResourceType());
}
// Represents the parameters as a single number to be recorded in a histogram.
int ParametersMask2(bool clear_cookies, bool clear_storage, bool clear_cache) {
return static_cast<int>(clear_cookies) * (1 << 0) +
static_cast<int>(clear_storage) * (1 << 1) +
static_cast<int>(clear_cache) * (1 << 2);
}
// A helper function to pass an IO thread callback to a method called on
// the UI thread.
void JumpFromUIToIOThread(base::OnceClosure callback) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
base::PostTaskWithTraits(FROM_HERE, {BrowserThread::IO}, std::move(callback));
}
// Finds the BrowserContext associated with the request and requests
// the actual clearing of data for |origin|. The data types to be deleted
// are determined by |clear_cookies|, |clear_storage|, and |clear_cache|.
// |web_contents_getter| identifies the WebContents from which the request
// originated. Must be run on the UI thread. The |callback| will be executed
// on the IO thread.
class UIThreadSiteDataClearer : public BrowsingDataRemover::Observer {
public:
static void Run(
const ResourceRequestInfo::WebContentsGetter& web_contents_getter,
const url::Origin& origin,
bool clear_cookies,
bool clear_storage,
bool clear_cache,
base::OnceClosure callback) {
WebContents* web_contents = web_contents_getter.Run();
if (!web_contents)
return;
(new UIThreadSiteDataClearer(web_contents, origin, clear_cookies,
clear_storage, clear_cache,
std::move(callback)))
->RunAndDestroySelfWhenDone();
}
private:
UIThreadSiteDataClearer(const WebContents* web_contents,
const url::Origin& origin,
bool clear_cookies,
bool clear_storage,
bool clear_cache,
base::OnceClosure callback)
: origin_(origin),
clear_cookies_(clear_cookies),
clear_storage_(clear_storage),
clear_cache_(clear_cache),
callback_(std::move(callback)),
pending_task_count_(0),
remover_(nullptr),
scoped_observer_(this) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
remover_ = BrowserContext::GetBrowsingDataRemover(
web_contents->GetBrowserContext());
DCHECK(remover_);
scoped_observer_.Add(remover_);
}
~UIThreadSiteDataClearer() override {}
void RunAndDestroySelfWhenDone() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
// Cookies and channel IDs are scoped to
// a) eTLD+1 of |origin|'s host if |origin|'s host is a registrable domain
// or a subdomain thereof
// b) |origin|'s host exactly if it is an IP address or an internal hostname
// (e.g. "localhost" or "fileserver").
// TODO(msramek): What about plugin data?
if (clear_cookies_) {
std::string domain = GetDomainAndRegistry(
origin_.host(),
net::registry_controlled_domains::INCLUDE_PRIVATE_REGISTRIES);
if (domain.empty())
domain = origin_.host(); // IP address or internal hostname.
std::unique_ptr<BrowsingDataFilterBuilder> domain_filter_builder(
BrowsingDataFilterBuilder::Create(
BrowsingDataFilterBuilder::WHITELIST));
domain_filter_builder->AddRegisterableDomain(domain);
pending_task_count_++;
remover_->RemoveWithFilterAndReply(
base::Time(), base::Time::Max(),
BrowsingDataRemover::DATA_TYPE_COOKIES |
BrowsingDataRemover::DATA_TYPE_CHANNEL_IDS |
BrowsingDataRemover::DATA_TYPE_AVOID_CLOSING_CONNECTIONS,
BrowsingDataRemover::ORIGIN_TYPE_UNPROTECTED_WEB |
BrowsingDataRemover::ORIGIN_TYPE_PROTECTED_WEB,
std::move(domain_filter_builder), this);
}
// Delete origin-scoped data.
int remove_mask = 0;
if (clear_storage_)
remove_mask |= BrowsingDataRemover::DATA_TYPE_DOM_STORAGE;
if (clear_cache_)
remove_mask |= BrowsingDataRemover::DATA_TYPE_CACHE;
if (remove_mask) {
std::unique_ptr<BrowsingDataFilterBuilder> origin_filter_builder(
BrowsingDataFilterBuilder::Create(
BrowsingDataFilterBuilder::WHITELIST));
origin_filter_builder->AddOrigin(origin_);
pending_task_count_++;
remover_->RemoveWithFilterAndReply(
base::Time(), base::Time::Max(), remove_mask,
BrowsingDataRemover::ORIGIN_TYPE_UNPROTECTED_WEB |
BrowsingDataRemover::ORIGIN_TYPE_PROTECTED_WEB,
std::move(origin_filter_builder), this);
}
DCHECK_GT(pending_task_count_, 0);
}
// BrowsingDataRemover::Observer:
void OnBrowsingDataRemoverDone() override {
DCHECK(pending_task_count_);
if (--pending_task_count_)
return;
JumpFromUIToIOThread(std::move(callback_));
delete this;
}
url::Origin origin_;
bool clear_cookies_;
bool clear_storage_;
bool clear_cache_;
base::OnceClosure callback_;
int pending_task_count_;
BrowsingDataRemover* remover_;
ScopedObserver<BrowsingDataRemover, BrowsingDataRemover::Observer>
scoped_observer_;
};
// Outputs a single |formatted_message| on the UI thread.
void OutputFormattedMessage2(WebContents* web_contents,
ConsoleMessageLevel level,
const std::string& formatted_text) {
if (web_contents)
web_contents->GetMainFrame()->AddMessageToConsole(level, formatted_text);
}
// Outputs |messages| to the console of WebContents retrieved from
// |web_contents_getter|. Must be run on the UI thread.
void OutputMessagesOnUIThread(
const ResourceRequestInfo::WebContentsGetter& web_contents_getter,
const std::vector<ClearSiteDataThrottle::ConsoleMessagesDelegate::Message>&
messages,
const ClearSiteDataThrottle::ConsoleMessagesDelegate::
OutputFormattedMessageFunction& output_formatted_message_function) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
WebContents* web_contents = web_contents_getter.Run();
for (const auto& message : messages) {
// Prefix each message with |kConsoleMessageTemplate2|.
output_formatted_message_function.Run(
web_contents, message.level,
base::StringPrintf(kConsoleMessageTemplate2, message.url.spec().c_str(),
message.text.c_str()));
}
}
} // namespace
////////////////////////////////////////////////////////////////////////////////
// ConsoleMessagesDelegate
ClearSiteDataThrottle::ConsoleMessagesDelegate::ConsoleMessagesDelegate()
: output_formatted_message_function_(
base::BindRepeating(&OutputFormattedMessage2)) {}
ClearSiteDataThrottle::ConsoleMessagesDelegate::~ConsoleMessagesDelegate() {}
void ClearSiteDataThrottle::ConsoleMessagesDelegate::AddMessage(
const GURL& url,
const std::string& text,
ConsoleMessageLevel level) {
messages_.push_back({url, text, level});
}
void ClearSiteDataThrottle::ConsoleMessagesDelegate::OutputMessages(
const ResourceRequestInfo::WebContentsGetter& web_contents_getter) {
if (messages_.empty())
return;
DCHECK_CURRENTLY_ON(BrowserThread::IO);
base::PostTaskWithTraits(
FROM_HERE, {BrowserThread::UI},
base::BindOnce(&OutputMessagesOnUIThread, web_contents_getter,
std::move(messages_), output_formatted_message_function_));
messages_.clear();
}
void ClearSiteDataThrottle::ConsoleMessagesDelegate::
SetOutputFormattedMessageFunctionForTesting(
const OutputFormattedMessageFunction& function) {
output_formatted_message_function_ = function;
}
////////////////////////////////////////////////////////////////////////////////
// ClearSiteDataThrottle
// static
std::unique_ptr<ResourceThrottle>
ClearSiteDataThrottle::MaybeCreateThrottleForRequest(net::URLRequest* request) {
// The throttle has no purpose if the request has no ResourceRequestInfo,
// because we won't be able to determine whose data should be deleted.
if (!ResourceRequestInfo::ForRequest(request))
return nullptr;
return base::WrapUnique(new ClearSiteDataThrottle(
request, std::make_unique<ConsoleMessagesDelegate>()));
}
ClearSiteDataThrottle::~ClearSiteDataThrottle() {
// Output the cached console messages. For navigations, we output console
// messages when the request is finished rather than in real time, since in
// the case of navigations swapping RenderFrameHost would cause the outputs
// to disappear.
if (IsNavigationRequest(request_))
OutputConsoleMessages();
}
const char* ClearSiteDataThrottle::GetNameForLogging() const {
return kNameForLogging2;
}
void ClearSiteDataThrottle::WillRedirectRequest(
const net::RedirectInfo& redirect_info,
bool* defer) {
*defer = HandleHeader();
// For subresource requests, console messages are output on every redirect.
// If the redirect is deferred, wait until it is resumed.
if (!IsNavigationRequest(request_) && !*defer)
OutputConsoleMessages();
}
void ClearSiteDataThrottle::WillProcessResponse(bool* defer) {
*defer = HandleHeader();
// For subresource requests, console messages are output on every redirect.
// If the redirect is deferred, wait until it is resumed.
if (!IsNavigationRequest(request_) && !*defer)
OutputConsoleMessages();
}
// static
bool ClearSiteDataThrottle::ParseHeaderForTesting(
const std::string& header,
bool* clear_cookies,
bool* clear_storage,
bool* clear_cache,
ConsoleMessagesDelegate* delegate,
const GURL& current_url) {
return ClearSiteDataThrottle::ParseHeader(
header, clear_cookies, clear_storage, clear_cache, delegate, current_url);
}
ClearSiteDataThrottle::ClearSiteDataThrottle(
net::URLRequest* request,
std::unique_ptr<ConsoleMessagesDelegate> delegate)
: request_(request),
delegate_(std::move(delegate)),
weak_ptr_factory_(this) {
DCHECK(request_);
DCHECK(delegate_);
}
const GURL& ClearSiteDataThrottle::GetCurrentURL() const {
return request_->url();
}
const net::HttpResponseHeaders* ClearSiteDataThrottle::GetResponseHeaders()
const {
return request_->response_headers();
}
bool ClearSiteDataThrottle::HandleHeader() {
const net::HttpResponseHeaders* headers = GetResponseHeaders();
std::string header_value;
if (!headers ||
!headers->GetNormalizedHeader(kClearSiteDataHeader2, &header_value)) {
return false;
}
// Only accept the header on secure non-unique origins.
if (!IsOriginSecure(GetCurrentURL())) {
delegate_->AddMessage(GetCurrentURL(),
"Not supported for insecure origins.",
CONSOLE_MESSAGE_LEVEL_ERROR);
return false;
}
url::Origin origin = url::Origin::Create(GetCurrentURL());
if (origin.opaque()) {
delegate_->AddMessage(GetCurrentURL(), "Not supported for unique origins.",
CONSOLE_MESSAGE_LEVEL_ERROR);
return false;
}
// The LOAD_DO_NOT_SAVE_COOKIES flag prohibits the request from doing any
// modification to cookies. Clear-Site-Data applies this restriction to other
// data types as well.
// TODO(msramek): Consider showing a blocked icon via
// TabSpecificContentSettings and reporting the action in the "Blocked"
// section of the cookies dialog in OIB.
if (request_->load_flags() & net::LOAD_DO_NOT_SAVE_COOKIES) {
delegate_->AddMessage(
GetCurrentURL(),
"The request's credentials mode prohibits modifying cookies "
"and other local data.",
CONSOLE_MESSAGE_LEVEL_ERROR);
return false;
}
// Service workers can handle fetches of third-party resources and inject
// arbitrary headers. Ignore responses that came from a service worker,
// as supporting Clear-Site-Data would give them the power to delete data from
// any website.
// See https://w3c.github.io/webappsec-clear-site-data/#service-workers
// for more information.
const ServiceWorkerResponseInfo* response_info =
ServiceWorkerResponseInfo::ForRequest(request_);
if (response_info) {
network::ResourceResponseInfo extra_response_info;
response_info->GetExtraResponseInfo(&extra_response_info);
if (extra_response_info.was_fetched_via_service_worker) {
delegate_->AddMessage(
GetCurrentURL(),
"Ignoring, as the response came from a service worker.",
CONSOLE_MESSAGE_LEVEL_ERROR);
return false;
}
}
bool clear_cookies;
bool clear_storage;
bool clear_cache;
if (!ClearSiteDataThrottle::ParseHeader(header_value, &clear_cookies,
&clear_storage, &clear_cache,
delegate_.get(), GetCurrentURL())) {
return false;
}
// If the header is valid, clear the data for this browser context and origin.
clearing_started_ = base::TimeTicks::Now();
// Record the call parameters.
UMA_HISTOGRAM_ENUMERATION(
"Navigation.ClearSiteData.Parameters",
ParametersMask2(clear_cookies, clear_storage, clear_cache), (1 << 3));
base::WeakPtr<ClearSiteDataThrottle> weak_ptr =
weak_ptr_factory_.GetWeakPtr();
// Immediately bind the weak pointer to the current thread (IO). This will
// make a potential misuse on the UI thread DCHECK immediately rather than
// later when it's correctly used on the IO thread again.
weak_ptr.get();
ExecuteClearingTask(
origin, clear_cookies, clear_storage, clear_cache,
base::BindOnce(&ClearSiteDataThrottle::TaskFinished, weak_ptr));
return true;
}
// static
bool ClearSiteDataThrottle::ParseHeader(const std::string& header,
bool* clear_cookies,
bool* clear_storage,
bool* clear_cache,
ConsoleMessagesDelegate* delegate,
const GURL& current_url) {
if (!base::IsStringASCII(header)) {
delegate->AddMessage(current_url, "Must only contain ASCII characters.",
CONSOLE_MESSAGE_LEVEL_ERROR);
return false;
}
*clear_cookies = false;
*clear_storage = false;
*clear_cache = false;
std::vector<std::string> input_types = base::SplitString(
header, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_NONEMPTY);
std::string output_types;
for (unsigned i = 0; i < input_types.size(); i++) {
bool* data_type = nullptr;
if (AreExperimentalFeaturesEnabled2() &&
input_types[i] == kDatatypeWildcard2) {
input_types.push_back(kDatatypeCookies2);
input_types.push_back(kDatatypeStorage2);
input_types.push_back(kDatatypeCache2);
continue;
} else if (input_types[i] == kDatatypeCookies2) {
data_type = clear_cookies;
} else if (input_types[i] == kDatatypeStorage2) {
data_type = clear_storage;
} else if (input_types[i] == kDatatypeCache2) {
data_type = clear_cache;
} else {
delegate->AddMessage(
current_url,
base::StringPrintf("Unrecognized type: %s.", input_types[i].c_str()),
CONSOLE_MESSAGE_LEVEL_ERROR);
continue;
}
DCHECK(data_type);
if (*data_type)
continue;
*data_type = true;
if (!output_types.empty())
output_types += kConsoleMessageDatatypeSeparator2;
output_types += input_types[i];
}
if (!*clear_cookies && !*clear_storage && !*clear_cache) {
delegate->AddMessage(current_url, "No recognized types specified.",
CONSOLE_MESSAGE_LEVEL_ERROR);
return false;
}
// Pretty-print which types are to be cleared.
// TODO(crbug.com/798760): Remove the disclaimer about cookies.
std::string console_output =
base::StringPrintf(kConsoleMessageCleared2, output_types.c_str());
if (*clear_cookies) {
console_output +=
" Clearing channel IDs and HTTP authentication cache is currently not"
" supported, as it breaks active network connections.";
}
delegate->AddMessage(current_url, console_output, CONSOLE_MESSAGE_LEVEL_INFO);
return true;
}
void ClearSiteDataThrottle::ExecuteClearingTask(const url::Origin& origin,
bool clear_cookies,
bool clear_storage,
bool clear_cache,
base::OnceClosure callback) {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
base::PostTaskWithTraits(
FROM_HERE, {BrowserThread::UI},
base::BindOnce(&UIThreadSiteDataClearer::Run,
ResourceRequestInfo::ForRequest(request_)
->GetWebContentsGetterForRequest(),
origin, clear_cookies, clear_storage, clear_cache,
std::move(callback)));
}
void ClearSiteDataThrottle::TaskFinished() {
DCHECK_CURRENTLY_ON(BrowserThread::IO);
DCHECK(!clearing_started_.is_null());
UMA_HISTOGRAM_CUSTOM_TIMES("Navigation.ClearSiteData.Duration",
base::TimeTicks::Now() - clearing_started_,
base::TimeDelta::FromMilliseconds(1),
base::TimeDelta::FromSeconds(1), 50);
// For subresource requests, console messages are output immediately.
if (!IsNavigationRequest(request_))
OutputConsoleMessages();
Resume();
}
void ClearSiteDataThrottle::OutputConsoleMessages() {
const ResourceRequestInfo* info = ResourceRequestInfo::ForRequest(request_);
if (info)
delegate_->OutputMessages(info->GetWebContentsGetterForRequest());
}
} // namespace content