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
content / browser / browsing_data / clear_site_data_handler.cc [blame]
// Copyright 2018 The Chromium Authors
// 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_handler.h"
#include <optional>
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/metrics/histogram_macros.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "content/browser/buckets/bucket_utils.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/storage_partition_config.h"
#include "content/public/browser/web_contents.h"
#include "net/base/load_flags.h"
#include "net/url_request/clear_site_data.h"
#include "services/network/public/cpp/is_potentially_trustworthy.h"
#include "third_party/blink/public/common/features_generated.h"
namespace content {
namespace {
// Pretty-printed log output.
const char kConsoleMessageTemplate[] = "Clear-Site-Data header on '%s': %s";
const char kConsoleMessageCleared[] = "Cleared data types: %s.";
const char kConsoleMessageDatatypeSeparator[] = ", ";
enum LoggableEventMask {
CLEAR_SITE_DATA_NO_RECOGNIZABLE_TYPES = 0,
CLEAR_SITE_DATA_COOKIES = 1 << 0,
CLEAR_SITE_DATA_STORAGE = 1 << 1,
CLEAR_SITE_DATA_CACHE = 1 << 2,
CLEAR_SITE_DATA_BUCKETS = 1 << 3,
CLEAR_SITE_DATA_CLIENT_HINTS = 1 << 4,
CLEAR_SITE_DATA_MAX_VALUE = 1 << 5,
};
void LogEvent(int event) {
UMA_HISTOGRAM_ENUMERATION("Storage.ClearSiteDataHeader.Parameters", event,
static_cast<int>(CLEAR_SITE_DATA_MAX_VALUE));
}
// Represents the parameters as a single number to be recorded in a histogram.
int ParametersMask(const ClearSiteDataTypeSet clear_site_data_types,
bool has_buckets) {
int mask = CLEAR_SITE_DATA_NO_RECOGNIZABLE_TYPES;
if (clear_site_data_types.Has(ClearSiteDataType::kCookies)) {
mask = mask | CLEAR_SITE_DATA_COOKIES;
}
if (clear_site_data_types.Has(ClearSiteDataType::kStorage)) {
mask = mask | CLEAR_SITE_DATA_STORAGE;
}
if (clear_site_data_types.Has(ClearSiteDataType::kCache)) {
mask = mask | CLEAR_SITE_DATA_CACHE;
}
if (has_buckets) {
mask = mask | CLEAR_SITE_DATA_BUCKETS;
}
if (clear_site_data_types.Has(ClearSiteDataType::kClientHints)) {
mask = mask | CLEAR_SITE_DATA_CLIENT_HINTS;
}
return mask;
}
// Outputs a single |formatted_message| on the UI thread.
void OutputFormattedMessage(WebContents* web_contents,
blink::mojom::ConsoleMessageLevel level,
const std::string& formatted_text) {
if (web_contents)
web_contents->GetPrimaryMainFrame()->AddMessageToConsole(level,
formatted_text);
}
} // namespace
////////////////////////////////////////////////////////////////////////////////
// ConsoleMessagesDelegate
ClearSiteDataHandler::ConsoleMessagesDelegate::ConsoleMessagesDelegate()
: output_formatted_message_function_(
base::BindRepeating(&OutputFormattedMessage)) {}
ClearSiteDataHandler::ConsoleMessagesDelegate::~ConsoleMessagesDelegate() {}
void ClearSiteDataHandler::ConsoleMessagesDelegate::AddMessage(
const GURL& url,
const std::string& text,
blink::mojom::ConsoleMessageLevel level) {
messages_.push_back({url, text, level});
}
void ClearSiteDataHandler::ConsoleMessagesDelegate::OutputMessages(
base::WeakPtr<WebContents> web_contents) {
if (messages_.empty())
return;
for (const auto& message : messages_) {
// Prefix each message with |kConsoleMessageTemplate|.
output_formatted_message_function_.Run(
web_contents.get(), message.level,
base::StringPrintf(kConsoleMessageTemplate, message.url.spec().c_str(),
message.text.c_str()));
}
messages_.clear();
}
void ClearSiteDataHandler::ConsoleMessagesDelegate::
SetOutputFormattedMessageFunctionForTesting(
const OutputFormattedMessageFunction& function) {
output_formatted_message_function_ = function;
}
////////////////////////////////////////////////////////////////////////////////
// ClearSiteDataHandler
// static
void ClearSiteDataHandler::HandleHeader(
base::WeakPtr<BrowserContext> browser_context,
base::WeakPtr<WebContents> web_contents,
const StoragePartitionConfig& storage_partition_config,
const GURL& url,
const std::string& header_value,
int load_flags,
const std::optional<net::CookiePartitionKey> cookie_partition_key,
const std::optional<blink::StorageKey> storage_key,
bool partitioned_state_allowed_only,
base::OnceClosure callback) {
ClearSiteDataHandler handler(
browser_context, web_contents, storage_partition_config, url,
header_value, load_flags, cookie_partition_key, storage_key,
partitioned_state_allowed_only, std::move(callback),
std::make_unique<ConsoleMessagesDelegate>());
handler.HandleHeaderAndOutputConsoleMessages();
}
// static
bool ClearSiteDataHandler::ParseHeaderForTesting(
const std::string& header,
ClearSiteDataTypeSet* clear_site_data_types,
std::set<std::string>* storage_buckets_to_remove,
ConsoleMessagesDelegate* delegate,
const GURL& current_url) {
return ClearSiteDataHandler::ParseHeader(header, clear_site_data_types,
storage_buckets_to_remove, delegate,
current_url);
}
ClearSiteDataHandler::ClearSiteDataHandler(
base::WeakPtr<BrowserContext> browser_context,
base::WeakPtr<WebContents> web_contents,
const StoragePartitionConfig& storage_partition_config,
const GURL& url,
const std::string& header_value,
int load_flags,
const std::optional<net::CookiePartitionKey> cookie_partition_key,
const std::optional<blink::StorageKey> storage_key,
bool partitioned_state_allowed_only,
base::OnceClosure callback,
std::unique_ptr<ConsoleMessagesDelegate> delegate)
: browser_context_(browser_context),
web_contents_(web_contents),
storage_partition_config_(storage_partition_config),
url_(url),
header_value_(header_value),
load_flags_(load_flags),
cookie_partition_key_(cookie_partition_key),
storage_key_(storage_key),
partitioned_state_allowed_only_(partitioned_state_allowed_only),
callback_(std::move(callback)),
delegate_(std::move(delegate)) {
DCHECK(delegate_);
}
ClearSiteDataHandler::~ClearSiteDataHandler() = default;
bool ClearSiteDataHandler::HandleHeaderAndOutputConsoleMessages() {
bool deferred = Run();
// If the redirect is deferred, wait until it is resumed.
// TODO(crbug.com/41409604): Delay output until next frame for navigations.
if (!deferred) {
OutputConsoleMessages();
RunCallbackNotDeferred();
}
return deferred;
}
bool ClearSiteDataHandler::Run() {
// Only accept the header on secure non-unique origins.
if (!network::IsUrlPotentiallyTrustworthy(url_)) {
delegate_->AddMessage(url_, "Not supported for insecure origins.",
blink::mojom::ConsoleMessageLevel::kError);
return false;
}
url::Origin origin = url::Origin::Create(url_);
if (origin.opaque()) {
delegate_->AddMessage(url_, "Not supported for unique origins.",
blink::mojom::ConsoleMessageLevel::kError);
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
// PageSpecificContentSettings and reporting the action in the "Blocked"
// section of the cookies dialog in OIB.
if (load_flags_ & net::LOAD_DO_NOT_SAVE_COOKIES) {
delegate_->AddMessage(
url_,
"The request's credentials mode prohibits modifying cookies "
"and other local data.",
blink::mojom::ConsoleMessageLevel::kError);
return false;
}
ClearSiteDataTypeSet clear_site_data_types;
std::set<std::string> storage_buckets_to_remove;
if (!ClearSiteDataHandler::ParseHeader(header_value_, &clear_site_data_types,
&storage_buckets_to_remove,
delegate_.get(), url_)) {
return false;
}
ExecuteClearingTask(
origin, clear_site_data_types, storage_buckets_to_remove,
base::BindOnce(&ClearSiteDataHandler::TaskFinished,
base::TimeTicks::Now(), std::move(delegate_),
web_contents_, std::move(callback_)));
return true;
}
// static
bool ClearSiteDataHandler::ParseHeader(
const std::string& header,
ClearSiteDataTypeSet* clear_site_data_types,
std::set<std::string>* storage_buckets_to_remove,
ConsoleMessagesDelegate* delegate,
const GURL& current_url) {
DCHECK(clear_site_data_types);
DCHECK(storage_buckets_to_remove);
DCHECK(delegate);
if (!base::IsStringASCII(header)) {
delegate->AddMessage(current_url, "Must only contain ASCII characters.",
blink::mojom::ConsoleMessageLevel::kError);
LogEvent(CLEAR_SITE_DATA_NO_RECOGNIZABLE_TYPES);
return false;
}
clear_site_data_types->Clear();
std::vector<std::string> input_types =
net::ClearSiteDataHeaderContents(header);
std::string output_types;
if (base::Contains(input_types, net::kDatatypeWildcard)) {
input_types.push_back(net::kDatatypeCookies);
input_types.push_back(net::kDatatypeStorage);
input_types.push_back(net::kDatatypeCache);
input_types.push_back(net::kDatatypeClientHints);
}
for (auto& input_type : input_types) {
// Match here if the beginning is '"storage:' and ends with '"'.
if (base::FeatureList::IsEnabled(blink::features::kStorageBuckets) &&
base::StartsWith(input_type, net::kDatatypeStorageBucketPrefix) &&
base::EndsWith(input_type, net::kDatatypeStorageBucketSuffix)) {
const int prefix_len = strlen(net::kDatatypeStorageBucketPrefix);
const std::string bucket_name = input_type.substr(
prefix_len,
input_type.length() -
(prefix_len + strlen(net::kDatatypeStorageBucketSuffix)));
if (IsValidBucketName(bucket_name))
storage_buckets_to_remove->insert(bucket_name);
// Exit the loop and continue since for buckets, there are no booleans
// and the logic later would cause a crash.
continue;
}
ClearSiteDataType data_type = ClearSiteDataType::kUndefined;
if (input_type == net::kDatatypeCookies) {
data_type = ClearSiteDataType::kCookies;
} else if (input_type == net::kDatatypeStorage) {
data_type = ClearSiteDataType::kStorage;
} else if (input_type == net::kDatatypeCache) {
data_type = ClearSiteDataType::kCache;
} else if (input_type == net::kDatatypeClientHints) {
data_type = ClearSiteDataType::kClientHints;
} else if (input_type == net::kDatatypeWildcard) {
continue;
} else {
delegate->AddMessage(
current_url,
base::StringPrintf("Unrecognized type: %s.", input_type.c_str()),
blink::mojom::ConsoleMessageLevel::kError);
continue;
}
DCHECK_NE(data_type, ClearSiteDataType::kUndefined);
if (clear_site_data_types->Has(data_type)) {
continue;
}
clear_site_data_types->Put(data_type);
if (!output_types.empty())
output_types += kConsoleMessageDatatypeSeparator;
output_types += input_type;
}
if (clear_site_data_types->empty() && storage_buckets_to_remove->empty()) {
delegate->AddMessage(current_url, "No recognized types specified.",
blink::mojom::ConsoleMessageLevel::kError);
LogEvent(CLEAR_SITE_DATA_NO_RECOGNIZABLE_TYPES);
return false;
}
if (clear_site_data_types->Has(ClearSiteDataType::kStorage) &&
!storage_buckets_to_remove->empty()) {
// `clear_storage` and `clear_storage_buckets` cannot both be true. When
// that happens, `clear_storage` stays true and we empty `storage_buckets
// _to_remove`
delegate->AddMessage(current_url,
"All the buckets related to this url will be "
"cleared. When passing type 'storage', any "
"additional buckets specifiers are ignored.",
blink::mojom::ConsoleMessageLevel::kWarning);
storage_buckets_to_remove->clear();
}
// Pretty-print which types are to be cleared.
// TODO(crbug.com/41363015): Remove the disclaimer about cookies.
std::string console_output =
base::StringPrintf(kConsoleMessageCleared, output_types.c_str());
if (clear_site_data_types->Has(ClearSiteDataType::kCookies)) {
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,
blink::mojom::ConsoleMessageLevel::kInfo);
// Note that presence of headers is also logged in WebRequest.ResponseHeader
LogEvent(ParametersMask(*clear_site_data_types,
!storage_buckets_to_remove->empty()));
return true;
}
void ClearSiteDataHandler::ExecuteClearingTask(
const url::Origin& origin,
const ClearSiteDataTypeSet clear_site_data_types,
const std::set<std::string>& storage_buckets_to_remove,
base::OnceClosure callback) {
ClearSiteData(browser_context_, storage_partition_config_, origin,
clear_site_data_types, storage_buckets_to_remove,
/*avoid_closing_connections=*/true, cookie_partition_key_,
storage_key_, partitioned_state_allowed_only_,
std::move(callback));
}
// static
void ClearSiteDataHandler::TaskFinished(
base::TimeTicks clearing_started,
std::unique_ptr<ConsoleMessagesDelegate> delegate,
base::WeakPtr<WebContents> web_contents,
base::OnceClosure callback) {
DCHECK(!clearing_started.is_null());
// TODO(crbug.com/41409604): Delay output until next frame for navigations.
delegate->OutputMessages(web_contents);
std::move(callback).Run();
}
void ClearSiteDataHandler::OutputConsoleMessages() {
delegate_->OutputMessages(web_contents_);
}
void ClearSiteDataHandler::RunCallbackNotDeferred() {
std::move(callback_).Run();
}
} // namespace content