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
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
content / browser / first_party_sets / first_party_set_parser.cc [blame]
// Copyright 2020 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/first_party_sets/first_party_set_parser.h"
#include <cstdint>
#include <iterator>
#include <optional>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "base/check_op.h"
#include "base/containers/contains.h"
#include "base/containers/flat_map.h"
#include "base/containers/flat_set.h"
#include "base/json/json_reader.h"
#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/ranges/algorithm.h"
#include "base/strings/string_util.h"
#include "base/types/expected.h"
#include "base/types/expected_macros.h"
#include "base/values.h"
#include "content/browser/first_party_sets/first_party_sets_overrides_policy.h"
#include "content/public/browser/first_party_sets_handler.h"
#include "content/public/common/content_features.h"
#include "net/base/registry_controlled_domains/registry_controlled_domain.h"
#include "net/base/schemeful_site.h"
#include "net/first_party_sets/first_party_set_entry.h"
#include "net/first_party_sets/global_first_party_sets.h"
#include "net/first_party_sets/local_set_declaration.h"
#include "net/first_party_sets/sets_mutation.h"
#include "url/gurl.h"
#include "url/origin.h"
namespace content {
namespace {
using ParseErrorType = FirstPartySetsHandler::ParseErrorType;
using ParseWarningType = FirstPartySetsHandler::ParseWarningType;
using ParseError = FirstPartySetsHandler::ParseError;
using ParseWarning = FirstPartySetsHandler::ParseWarning;
using SetsMap = base::flat_map<net::SchemefulSite, net::FirstPartySetEntry>;
using Aliases = base::flat_map<net::SchemefulSite, net::SchemefulSite>;
using SetsAndAliases = std::pair<SetsMap, Aliases>;
using SingleSet = base::flat_map<net::SchemefulSite, net::FirstPartySetEntry>;
constexpr char kFirstPartySetPrimaryField[] = "primary";
constexpr char kFirstPartySetAssociatedSitesField[] = "associatedSites";
constexpr char kFirstPartySetServiceSitesField[] = "serviceSites";
constexpr char kCCTLDsField[] = "ccTLDs";
constexpr char kFirstPartySetPolicyReplacementsField[] = "replacements";
constexpr char kFirstPartySetPolicyAdditionsField[] = "additions";
constexpr int kFirstPartySetsMaxAssociatedSites = 5;
enum class PolicySetType { kReplacement, kAddition };
const char* SetTypeToString(PolicySetType set_type) {
switch (set_type) {
case PolicySetType::kReplacement:
return kFirstPartySetPolicyReplacementsField;
case PolicySetType::kAddition:
return kFirstPartySetPolicyAdditionsField;
}
}
// Class representing the results of validating a given site.
class ValidateSiteResult {
public:
ValidateSiteResult(net::SchemefulSite site, bool modified_host)
: ValidateSiteResult(std::move(site),
std::nullopt,
/*modified_host=*/modified_host) {}
explicit ValidateSiteResult(ParseErrorType error_type)
: ValidateSiteResult(std::nullopt, error_type, /*modified_host=*/false) {}
ValidateSiteResult(net::SchemefulSite site, ParseErrorType error_type)
: ValidateSiteResult(std::make_optional(std::move(site)),
std::make_optional(error_type),
/*modified_host=*/false) {
// If we have both a site and an error, the error must be because the site
// didn't have a registerable domain (but we were still able to parse it).
CHECK_EQ(error_type_.value(), ParseErrorType::kInvalidDomain);
}
bool has_site() const { return site_.has_value(); }
bool has_error() const { return error_type_.has_value(); }
const net::SchemefulSite& site() const { return site_.value(); }
ParseErrorType error_type() const { return error_type_.value(); }
bool modified_host() const { return modified_host_; }
private:
ValidateSiteResult(std::optional<net::SchemefulSite> site,
std::optional<ParseErrorType> error_type,
bool modified_host)
: site_(std::move(site)),
error_type_(error_type),
modified_host_(modified_host) {}
const std::optional<net::SchemefulSite> site_ = std::nullopt;
const std::optional<ParseErrorType> error_type_ = std::nullopt;
const bool modified_host_ = false;
};
bool IsFatalError(ParseErrorType error_type) {
switch (error_type) {
case FirstPartySetsHandler::ParseErrorType::kInvalidType:
case FirstPartySetsHandler::ParseErrorType::kInvalidOrigin:
case FirstPartySetsHandler::ParseErrorType::kNonHttpsScheme:
case FirstPartySetsHandler::ParseErrorType::kNonDisjointSets:
case FirstPartySetsHandler::ParseErrorType::kRepeatedDomain:
// Fatal errors indicate that something is wrong with the data source,
// since it could never have been valid.
return true;
case FirstPartySetsHandler::ParseErrorType::kInvalidDomain:
case FirstPartySetsHandler::ParseErrorType::kSingletonSet:
// Nonfatal errors may arise over time (as the Public Suffix List changes,
// or due to other nonfatal errors), so they don't indicate a problem with
// the data source.
return false;
}
}
// Struct to hold metadata describing a particular "subset" during parsing.
struct SubsetDescriptor {
std::string field_name;
net::SiteType site_type;
std::optional<int> size_limit;
};
bool IsSingletonSet(const std::vector<SetsMap::value_type>& set_entries,
const Aliases& aliases) {
// There's no point in having a set with only one site and no aliases.
return set_entries.size() + aliases.size() < 2;
}
// Removes the TLD from a SchemefulSite, if possible. (It is not possible if
// the site has no final subcomponent.)
std::optional<std::string> RemoveTldFromSite(const net::SchemefulSite& site) {
const size_t tld_length = net::registry_controlled_domains::GetRegistryLength(
site.GetURL(),
net::registry_controlled_domains::INCLUDE_UNKNOWN_REGISTRIES,
net::registry_controlled_domains::INCLUDE_PRIVATE_REGISTRIES);
if (tld_length == 0) {
return std::nullopt;
}
const std::string serialized = site.Serialize();
return serialized.substr(0, serialized.size() - tld_length);
}
struct ParsedPolicySetLists {
std::vector<SingleSet> replacements;
std::vector<SingleSet> additions;
};
class ParseContext {
public:
ParseContext(bool emit_errors, bool exempt_from_limits)
: emit_errors_(emit_errors), exempt_from_limits_(exempt_from_limits) {}
ParseContext(const ParseContext&) = delete;
ParseContext& operator=(const ParseContext&) = delete;
~ParseContext() = default;
// Ensures that the string represents an origin that is non-opaque and HTTPS.
// Returns the registered domain.
ValidateSiteResult Canonicalize(std::string_view origin_string) const {
const url::Origin origin(url::Origin::Create(GURL(origin_string)));
if (origin.opaque()) {
if (emit_errors_) {
LOG(ERROR) << "First-Party Set origin " << origin_string
<< " is not valid; ignoring.";
}
return ValidateSiteResult(ParseErrorType::kInvalidOrigin);
}
if (origin.scheme() != "https") {
if (emit_errors_) {
LOG(ERROR) << "First-Party Set origin " << origin_string
<< " is not HTTPS; ignoring.";
}
return ValidateSiteResult(ParseErrorType::kNonHttpsScheme);
}
std::optional<net::SchemefulSite> site =
net::SchemefulSite::CreateIfHasRegisterableDomain(origin);
if (!site.has_value()) {
if (emit_errors_) {
LOG(ERROR) << "First-Party Set origin " << origin_string
<< " does not have a valid registered domain; ignoring.";
}
return ValidateSiteResult(net::SchemefulSite(origin),
ParseErrorType::kInvalidDomain);
}
bool modified_host = origin.host() != site->GetURL().host();
return ValidateSiteResult(std::move(site).value(), modified_host);
}
// Validates a single First-Party Set and parses it into a SingleSet.
// Note that this is intended for use *only* on sets that were received via
// the Component Updater or from enterprise policy, so this does not check
// assertions or versions. It rejects sets which are non-disjoint with
// previously-encountered sets (i.e. sets which have non-empty intersections
// with `elements`), and singleton sets (i.e. sets must have a primary and at
// least one valid associated site).
//
// Uses `elements_` to check disjointness of sets. The caller is expected to
// update this context via `AddSet` after this method terminates.
//
// Returns the parsed set if parsing and validation were successful;
// otherwise, returns an appropriate ParseError.
base::expected<SetsAndAliases, ParseError> ParseSet(
const base::Value& value) const {
if (!value.is_dict()) {
return base::unexpected(ParseError(ParseErrorType::kInvalidType, {}));
}
const base::Value::Dict& set_declaration = value.GetDict();
// Confirm that the set has a primary, and the primary is a string.
const base::Value* primary_item =
set_declaration.Find(kFirstPartySetPrimaryField);
if (!primary_item) {
return base::unexpected(ParseError(ParseErrorType::kInvalidType,
{kFirstPartySetPrimaryField}));
}
ValidateSiteResult primary_result =
ParseSiteAndValidate(*primary_item, /*set_entries=*/{});
if (primary_result.has_error()) {
// Primaries that exhibit any error (fatal or nonfatal) invalidate the
// whole set.
return base::unexpected(ParseError(primary_result.error_type(),
{kFirstPartySetPrimaryField}));
}
const net::SchemefulSite& primary = primary_result.site();
std::vector<std::pair<net::SchemefulSite, net::FirstPartySetEntry>>
set_entries(
{{primary, net::FirstPartySetEntry(primary, net::SiteType::kPrimary,
std::nullopt)}});
for (const SubsetDescriptor& descriptor : {
SubsetDescriptor{
.field_name = kFirstPartySetAssociatedSitesField,
.site_type = net::SiteType::kAssociated,
.size_limit = exempt_from_limits_
? std::nullopt
: std::make_optional(
kFirstPartySetsMaxAssociatedSites),
},
{
.field_name = kFirstPartySetServiceSitesField,
.site_type = net::SiteType::kService,
.size_limit = std::nullopt,
},
}) {
RETURN_IF_ERROR(
ParseSubset(set_declaration, primary, descriptor, set_entries));
}
ASSIGN_OR_RETURN(const Aliases& aliases,
ParseCctlds(set_declaration, set_entries));
if (IsSingletonSet(set_entries, aliases)) {
return base::unexpected(ParseError(ParseErrorType::kSingletonSet,
{kFirstPartySetAssociatedSitesField}));
}
return std::make_pair(SingleSet(set_entries), aliases);
}
// Returns the parsed sets if successful; otherwise returns the first error.
base::expected<std::vector<SingleSet>, ParseError> GetPolicySetsFromList(
const base::Value::List* policy_sets,
PolicySetType set_type) {
if (!policy_sets) {
return {};
}
std::vector<SingleSet> parsed_sets;
size_t previous_size = warnings_.size();
for (int i = 0; i < static_cast<int>(policy_sets->size()); i++) {
base::expected<SetsAndAliases, ParseError> parsed =
ParseSet((*policy_sets)[i]);
for (auto it = warnings_.begin() + previous_size; it != warnings_.end();
it++) {
it->PrependPath({SetTypeToString(set_type), i});
}
if (!parsed.has_value()) {
if (!IsFatalError(parsed.error().type())) {
continue;
}
ParseError error = parsed.error();
error.PrependPath({SetTypeToString(set_type), i});
return base::unexpected(error);
}
SetsMap& set = parsed.value().first;
if (!parsed.value().second.empty()) {
std::vector<SetsMap::value_type> alias_entries;
for (const auto& alias : parsed.value().second) {
alias_entries.emplace_back(alias.first,
set.find(alias.second)->second);
}
set.insert(std::make_move_iterator(alias_entries.begin()),
std::make_move_iterator(alias_entries.end()));
}
AddSet(SetsAndAliases(set, {}));
parsed_sets.push_back(std::move(set));
previous_size = warnings_.size();
}
return parsed_sets;
}
// Updates the context to include the given set and aliases.
//
// The given set and aliases must be disjoint from everything previously added
// to the context.
void AddSet(const SetsAndAliases& set_and_aliases) {
for (const auto& [site, unused_entry] : set_and_aliases.first) {
CHECK(elements_.insert(site).second);
}
for (const auto& [alias, unused_canonical] : set_and_aliases.second) {
CHECK(elements_.insert(alias).second);
}
}
// Removes invalid site entries and aliases, and fixes up any lingering
// singletons. Modifies the data in-place.
void PostProcessSets(std::vector<SetsMap::value_type>& sets,
std::vector<Aliases::value_type>& aliases) {
if (invalid_keys_.empty()) {
return;
}
base::flat_set<net::SchemefulSite> possible_singletons;
// Erase invalid members/primaries, and collect primary sites that might
// become singletons.
std::erase_if(
sets,
[&](const std::pair<net::SchemefulSite, net::FirstPartySetEntry>& pair)
-> bool { return IsInvalidEntry(pair, &possible_singletons); });
// Erase invalid aliases, and collect canonical sites that are primaries and
// might become singletons.
std::erase_if(
aliases,
[&](const std::pair<net::SchemefulSite, net::SchemefulSite>& pair)
-> bool {
return IsInvalidAlias(pair, possible_singletons, sets);
});
if (possible_singletons.empty()) {
return;
}
// Since we just removed some keys, we have to double-check that there are
// no singleton sets.
for (const auto& [site, entry] : sets) {
if (site == entry.primary()) {
// Skip primaries, they don't count as their own members.
continue;
}
// Found at least one member for this primary, so it isn't a
// singleton.
possible_singletons.erase(entry.primary());
}
// Any canonical site that has at least one alias is not a singleton.
for (const auto& [unused_alias, canonical] : aliases) {
possible_singletons.erase(canonical);
}
if (possible_singletons.empty()) {
return;
}
std::erase_if(
sets,
[&](const std::pair<net::SchemefulSite, net::FirstPartySetEntry>& pair)
-> bool { return possible_singletons.contains(pair.first); });
}
// Removes invalid site entries and fixes up any lingering singletons.
// Modifies the lists in-place.
void PostProcessSetLists(
base::expected<ParsedPolicySetLists, FirstPartySetsHandler::ParseError>&
lists_or_error) {
if (!lists_or_error.has_value() || invalid_keys_.empty()) {
return;
}
ParsedPolicySetLists& lists = lists_or_error.value();
// Erase invalid members/primaries.
const auto is_invalid_entry =
[&](const std::pair<net::SchemefulSite, net::FirstPartySetEntry>& pair)
-> bool {
return IsInvalidEntry(pair, /*possible_singletons=*/nullptr);
};
for (auto& set : lists.additions) {
base::EraseIf(set, is_invalid_entry);
}
for (auto& set : lists.replacements) {
base::EraseIf(set, is_invalid_entry);
}
// Since we just removed some keys, we have to double-check that there are
// no singleton sets.
const auto is_singleton = [](const SingleSet& set) {
return set.size() <= 1;
};
std::erase_if(lists.additions, is_singleton);
std::erase_if(lists.replacements, is_singleton);
}
std::vector<ParseWarning>& warnings() { return warnings_; }
private:
// Parses a given optional subset, ensuring that it is disjoint from all other
// subsets in this set, and from all other sets that have previously been
// parsed.
base::expected<void, ParseError> ParseSubset(
const base::Value::Dict& set_declaration,
const net::SchemefulSite& primary,
const SubsetDescriptor& descriptor,
std::vector<std::pair<net::SchemefulSite, net::FirstPartySetEntry>>&
set_entries) const {
const base::Value* field_value =
set_declaration.Find(descriptor.field_name);
if (!field_value) {
return base::ok();
}
if (!field_value->is_list()) {
return base::unexpected(
ParseError(ParseErrorType::kInvalidType, {descriptor.field_name}));
}
// Add each site to our mapping (after validating).
uint32_t index = 0;
for (const auto& item : field_value->GetList()) {
ValidateSiteResult site_result = ParseSiteAndValidate(item, set_entries);
if (site_result.has_error()) {
if (!IsFatalError(site_result.error_type())) {
++index;
continue;
}
return base::unexpected(
ParseError(site_result.error_type(),
{descriptor.field_name, static_cast<int>(index)}));
}
if (!descriptor.size_limit.has_value() ||
static_cast<int>(index) < descriptor.size_limit.value()) {
set_entries.emplace_back(
site_result.site(),
net::FirstPartySetEntry(
primary, descriptor.site_type,
descriptor.size_limit.has_value()
? std::make_optional(
net::FirstPartySetEntry::SiteIndex(index))
: std::nullopt));
}
// Continue parsing even after we've reached the size limit (if there is
// one), in order to surface malformed input domains as errors.
++index;
}
return base::ok();
}
// Parses the optional ccTLDs field, if present. If absent, this is a no-op.
// Returns any error encountered while parsing the strings into
// SchemefulSites.
//
// Ignores any aliases that differ from their canonical representative by more
// than just the TLD.
// Ignores any aliases provided for a representative site that is not in the
// First-Party Set we're currently parsing/validating.
base::expected<Aliases, ParseError> ParseCctlds(
const base::Value::Dict& set_declaration,
const std::vector<std::pair<net::SchemefulSite, net::FirstPartySetEntry>>&
set_entries) const {
const base::Value::Dict* cctld_dict =
set_declaration.FindDict(kCCTLDsField);
if (!cctld_dict) {
return {};
}
std::vector<std::pair<net::SchemefulSite, net::SchemefulSite>> aliases;
for (const auto [site, site_alias_list] : *cctld_dict) {
net::SchemefulSite site_as_schemeful_site((GURL(site)));
if (!base::Contains(set_entries, site_as_schemeful_site,
[](const auto& site_and_entry) {
return site_and_entry.first;
})) {
warnings_.push_back(ParseWarning(
ParseWarningType::kCctldKeyNotCanonical, {kCCTLDsField, site}));
continue;
}
const std::optional<std::string> site_without_tld =
RemoveTldFromSite(site_as_schemeful_site);
if (!site_without_tld.has_value()) {
continue;
}
if (!site_alias_list.is_list()) {
continue;
}
const base::Value::List& site_aliases = site_alias_list.GetList();
for (size_t i = 0; i < site_aliases.size(); ++i) {
const ValidateSiteResult alias_result =
ParseSiteAndValidate(site_aliases[i], set_entries);
if (alias_result.has_error()) {
if (!IsFatalError(alias_result.error_type())) {
continue;
}
return base::unexpected(
ParseError(alias_result.error_type(),
{kCCTLDsField, site, static_cast<int>(i)}));
}
net::SchemefulSite alias = alias_result.site();
const std::optional<std::string> alias_site_without_tld =
RemoveTldFromSite(alias);
if (!alias_site_without_tld.has_value()) {
continue;
}
if (alias_site_without_tld != site_without_tld) {
warnings_.push_back(
ParseWarning(ParseWarningType::kAliasNotCctldVariant,
{kCCTLDsField, site, static_cast<int>(i)}));
continue;
}
aliases.emplace_back(std::move(alias), site_as_schemeful_site);
}
}
return aliases;
}
// Parses a single base::Value into a net::SchemefulSite, and verifies that it
// is not already included in this set or any other encountered by this
// context.
ValidateSiteResult ParseSiteAndValidate(
const base::Value& item,
const std::vector<std::pair<net::SchemefulSite, net::FirstPartySetEntry>>&
set_entries) const {
if (!item.is_string()) {
return ValidateSiteResult(ParseErrorType::kInvalidType);
}
const ValidateSiteResult result = Canonicalize(item.GetString());
if (result.has_site()) {
const net::SchemefulSite& site = result.site();
if (base::Contains(
set_entries, site,
&std::pair<net::SchemefulSite, net::FirstPartySetEntry>::first)) {
if (result.modified_host()) {
// If the set repeats this site because the PSL caused us to modify
// this site's host, we drop this site.
invalid_keys_.insert(result.site());
return ValidateSiteResult(result.site(),
ParseErrorType::kInvalidDomain);
}
return ValidateSiteResult(ParseErrorType::kRepeatedDomain);
}
if (elements_.contains(site)) {
if (result.modified_host()) {
// If the sets are nondisjoint because the PSL caused us to modify
// this site's host, we drop this site.
invalid_keys_.insert(result.site());
return ValidateSiteResult(result.site(),
ParseErrorType::kInvalidDomain);
}
return ValidateSiteResult(ParseErrorType::kNonDisjointSets);
}
}
return result;
}
// Returns true iff the key or value of `pair` corresponds to a domain that
// is considered invalid. Inserts into `possible_singletons` if it is
// non-nullptr and `pair` is invalid in a way that might create a singleton
// set.
bool IsInvalidEntry(
const std::pair<net::SchemefulSite, net::FirstPartySetEntry> pair,
base::flat_set<net::SchemefulSite>* possible_singletons) {
const net::SchemefulSite& key = pair.first;
const net::FirstPartySetEntry& entry = pair.second;
return base::ranges::any_of(
invalid_keys_, [&](const net::SchemefulSite& invalid_key) -> bool {
if (invalid_key == entry.primary()) {
// The primary is invalid, so we have to kill the whole set. So this
// non-primary site must also be considered invalid in the future.
invalid_keys_.insert(pair.first);
return true;
}
if (invalid_key == key) {
// This is a member whose primary might end up being a
// singleton, since it's losing at least one member (and it
// itself isn't invalid).
if (possible_singletons) {
possible_singletons->insert(entry.primary());
}
return true;
}
return false;
});
}
// Returns true iff the key or value of `pair` is a domain that is considered
// invalid. Inserts into `possible_singletons` if `pair` is invalid in a way
// that might create a singleton set.
bool IsInvalidAlias(
const std::pair<net::SchemefulSite, net::SchemefulSite> pair,
base::flat_set<net::SchemefulSite>& possible_singletons,
const std::vector<SetsMap::value_type>& sets) const {
const net::SchemefulSite& alias = pair.first;
const net::SchemefulSite& canonical = pair.second;
return base::ranges::any_of(
invalid_keys_, [&](const net::SchemefulSite& invalid_key) -> bool {
const bool alias_matches = invalid_key == alias;
const bool canonical_matches = invalid_key == canonical;
if (alias_matches && !canonical_matches) {
const bool is_primary = base::Contains(
sets, canonical,
[](const std::pair<net::SchemefulSite, net::FirstPartySetEntry>&
set_entry) { return set_entry.second.primary(); });
if (is_primary) {
// If we're erasing the alias but not the canonical site, and the
// canonical site is a primary, it might end up becoming a
// singleton, since it's losing at least one member (and it itself
// isn't invalid).
possible_singletons.insert(canonical);
}
}
return alias_matches || canonical_matches;
});
}
// Whether errors should be logged as they're encountered.
const bool emit_errors_;
// Whether to ignore subset limits while parsing.
const bool exempt_from_limits_;
// The previously encountered set elements. This should be kept up-to-date via
// `AddSet` while using this context.
base::flat_set<SetsMap::key_type> elements_;
// The warnings encountered so far. Mutable so that we can accumulate warnings
// even in const methods.
mutable std::vector<ParseWarning> warnings_;
// The keys (sites) that no set ought to be allowed to include, found while
// parsing.
mutable base::flat_set<SetsMap::key_type> invalid_keys_;
};
SetsAndAliases ParseSetsFromStreamInternal(std::istream& input,
bool emit_errors,
bool emit_metrics) {
std::vector<SetsMap::value_type> sets;
std::vector<Aliases::value_type> aliases;
ParseContext context(emit_errors, /*exempt_from_limits=*/false);
int successfully_parsed_sets = 0;
int nonfatal_errors = 0;
for (std::string line; std::getline(input, line);) {
std::string_view trimmed = base::TrimWhitespaceASCII(line, base::TRIM_ALL);
if (trimmed.empty()) {
continue;
}
std::optional<base::Value> maybe_value = base::JSONReader::Read(
trimmed, base::JSONParserOptions::JSON_ALLOW_TRAILING_COMMAS);
if (!maybe_value.has_value()) {
if (emit_metrics) {
base::UmaHistogramBoolean(
"Cookie.FirstPartySets.ProcessedEntireComponent", false);
}
return {};
}
base::expected<SetsAndAliases, ParseError> parsed =
context.ParseSet(*maybe_value);
if (!parsed.has_value()) {
if (!IsFatalError(parsed.error().type())) {
nonfatal_errors++;
continue;
}
// Abort, something is wrong with the component.
if (emit_metrics) {
base::UmaHistogramBoolean(
"Cookie.FirstPartySets.ProcessedEntireComponent", false);
}
return {};
}
context.AddSet(parsed.value());
base::ranges::move(parsed.value().first, std::back_inserter(sets));
base::ranges::move(parsed.value().second, std::back_inserter(aliases));
successfully_parsed_sets++;
}
context.PostProcessSets(sets, aliases);
if (emit_metrics) {
base::UmaHistogramBoolean("Cookie.FirstPartySets.ProcessedEntireComponent",
true);
base::UmaHistogramCounts1000(
"Cookie.FirstPartySets.ComponentSetsParsedSuccessfully",
successfully_parsed_sets);
base::UmaHistogramCounts1000(
"Cookie.FirstPartySets.ComponentSetsNonfatalErrors", nonfatal_errors);
}
return std::make_pair(std::move(sets), std::move(aliases));
}
} // namespace
std::optional<net::SchemefulSite>
FirstPartySetParser::CanonicalizeRegisteredDomain(
std::string_view origin_string,
bool emit_errors) {
ValidateSiteResult result =
ParseContext(emit_errors, /*exempt_from_limits=*/false)
.Canonicalize(origin_string);
if (result.has_error()) {
return std::nullopt;
}
return result.site();
}
net::GlobalFirstPartySets FirstPartySetParser::ParseSetsFromStream(
std::istream& input,
base::Version version,
bool emit_errors,
bool emit_metrics) {
SetsAndAliases sets_and_aliases =
ParseSetsFromStreamInternal(input, emit_errors, emit_metrics);
return net::GlobalFirstPartySets(std::move(version),
std::move(sets_and_aliases.first),
std::move(sets_and_aliases.second));
}
FirstPartySetParser::PolicyParseResult
FirstPartySetParser::ParseSetsFromEnterprisePolicy(
const base::Value::Dict& policy) {
ParseContext context(/*emit_errors=*/false, /*exempt_from_limits=*/true);
auto set_lists = [&]() -> base::expected<ParsedPolicySetLists,
FirstPartySetsHandler::ParseError> {
ASSIGN_OR_RETURN(std::vector<SingleSet> replacements,
context.GetPolicySetsFromList(
policy.FindList(kFirstPartySetPolicyReplacementsField),
PolicySetType::kReplacement));
ASSIGN_OR_RETURN(std::vector<SingleSet> additions,
context.GetPolicySetsFromList(
policy.FindList(kFirstPartySetPolicyAdditionsField),
PolicySetType::kAddition));
return ParsedPolicySetLists(std::move(replacements), std::move(additions));
}();
context.PostProcessSetLists(set_lists);
return FirstPartySetParser::PolicyParseResult(
std::move(set_lists).transform([](ParsedPolicySetLists lists) {
return FirstPartySetsOverridesPolicy(net::SetsMutation(
std::move(lists.replacements), std::move(lists.additions)));
}),
context.warnings());
}
// static
net::LocalSetDeclaration FirstPartySetParser::ParseFromCommandLine(
const std::string& switch_value) {
std::istringstream stream(switch_value);
SetsAndAliases parsed =
ParseSetsFromStreamInternal(stream, /*emit_errors=*/true,
/*emit_metrics*/ false);
SetsMap entries = std::move(parsed.first);
Aliases aliases = std::move(parsed.second);
if (entries.empty()) {
return net::LocalSetDeclaration();
}
const net::SchemefulSite& primary = entries.begin()->second.primary();
if (base::ranges::any_of(entries,
[&primary](const SetsMap::value_type& pair) {
return pair.second.primary() != primary;
})) {
// More than one set was provided. That is (currently) unsupported.
LOG(ERROR) << "Ignoring use-related-website-set switch due to multiple set "
"declarations.";
return net::LocalSetDeclaration();
}
return net::LocalSetDeclaration(std::move(entries), std::move(aliases));
}
} // namespace content