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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/first_party_sets/global_first_party_sets.h"
#include <algorithm>
#include <iterator>
#include <map>
#include <optional>
#include <set>
#include <tuple>
#include <utility>
#include "base/containers/contains.h"
#include "base/containers/flat_map.h"
#include "base/containers/flat_set.h"
#include "base/containers/map_util.h"
#include "base/functional/function_ref.h"
#include "base/types/optional_ref.h"
#include "net/base/schemeful_site.h"
#include "net/first_party_sets/addition_overlaps_union_find.h"
#include "net/first_party_sets/first_party_set_entry.h"
#include "net/first_party_sets/first_party_set_entry_override.h"
#include "net/first_party_sets/first_party_set_metadata.h"
#include "net/first_party_sets/first_party_sets_context_config.h"
#include "net/first_party_sets/first_party_sets_validator.h"
#include "net/first_party_sets/local_set_declaration.h"
namespace net {
namespace {
using FlattenedSets = base::flat_map<SchemefulSite, FirstPartySetEntry>;
using SingleSet = base::flat_map<SchemefulSite, FirstPartySetEntry>;
// Converts a list of First-Party Sets from a SingleSet to a FlattenedSet
// representation.
FlattenedSets Flatten(const std::vector<SingleSet>& set_list) {
FlattenedSets sets;
for (const auto& set : set_list) {
for (const auto& site_and_entry : set) {
bool inserted = sets.emplace(site_and_entry).second;
CHECK(inserted);
}
}
return sets;
}
std::pair<SchemefulSite, FirstPartySetEntryOverride>
SiteAndEntryToSiteAndOverride(
const std::pair<SchemefulSite, FirstPartySetEntry>& pair) {
return std::make_pair(pair.first, FirstPartySetEntryOverride(pair.second));
}
} // namespace
GlobalFirstPartySets::GlobalFirstPartySets() = default;
GlobalFirstPartySets::GlobalFirstPartySets(
base::Version public_sets_version,
base::flat_map<SchemefulSite, FirstPartySetEntry> entries,
base::flat_map<SchemefulSite, SchemefulSite> aliases)
: GlobalFirstPartySets(
public_sets_version,
public_sets_version.IsValid()
? std::move(entries)
: base::flat_map<SchemefulSite, FirstPartySetEntry>(),
public_sets_version.IsValid()
? std::move(aliases)
: base::flat_map<SchemefulSite, SchemefulSite>(),
FirstPartySetsContextConfig()) {}
GlobalFirstPartySets::GlobalFirstPartySets(
base::Version public_sets_version,
base::flat_map<SchemefulSite, FirstPartySetEntry> entries,
base::flat_map<SchemefulSite, SchemefulSite> aliases,
FirstPartySetsContextConfig manual_config)
: public_sets_version_(std::move(public_sets_version)),
entries_(std::move(entries)),
aliases_(std::move(aliases)),
manual_config_(std::move(manual_config)) {
if (!public_sets_version_.IsValid()) {
CHECK(entries_.empty());
CHECK(aliases_.empty());
}
CHECK(std::ranges::all_of(aliases_, [&](const auto& pair) {
return entries_.contains(pair.second);
}));
CHECK(IsValid()) << "Sets must be valid";
}
GlobalFirstPartySets::GlobalFirstPartySets(GlobalFirstPartySets&&) = default;
GlobalFirstPartySets& GlobalFirstPartySets::operator=(GlobalFirstPartySets&&) =
default;
GlobalFirstPartySets::~GlobalFirstPartySets() = default;
bool GlobalFirstPartySets::operator==(const GlobalFirstPartySets& other) const =
default;
GlobalFirstPartySets GlobalFirstPartySets::Clone() const {
return GlobalFirstPartySets(public_sets_version_, entries_, aliases_,
manual_config_.Clone());
}
std::optional<FirstPartySetEntry> GlobalFirstPartySets::FindEntry(
const SchemefulSite& site,
const FirstPartySetsContextConfig& config) const {
return FindEntry(site, &config);
}
std::optional<FirstPartySetEntry> GlobalFirstPartySets::FindEntry(
const SchemefulSite& site,
const FirstPartySetsContextConfig* config) const {
// Check if `site` can be found in the customizations first.
if (config) {
if (const auto override = config->FindOverride(site);
override.has_value()) {
return override->IsDeletion() ? std::nullopt
: std::make_optional(override->GetEntry());
}
}
// Now see if it's in the manual config (with or without a manual alias).
if (const auto manual_override = manual_config_.FindOverride(site);
manual_override.has_value()) {
return manual_override->IsDeletion()
? std::nullopt
: std::make_optional(manual_override->GetEntry());
}
// Finally, look up in `entries_`, applying an alias if applicable.
const auto canonical_it = aliases_.find(site);
const SchemefulSite& canonical_site =
canonical_it == aliases_.end() ? site : canonical_it->second;
if (const auto entry_it = entries_.find(canonical_site);
entry_it != entries_.end()) {
return entry_it->second;
}
return std::nullopt;
}
base::flat_map<SchemefulSite, FirstPartySetEntry>
GlobalFirstPartySets::FindEntries(
const base::flat_set<SchemefulSite>& sites,
const FirstPartySetsContextConfig& config) const {
std::vector<std::pair<SchemefulSite, FirstPartySetEntry>> sites_to_entries;
for (const SchemefulSite& site : sites) {
const std::optional<FirstPartySetEntry> entry = FindEntry(site, config);
if (entry.has_value()) {
sites_to_entries.emplace_back(site, entry.value());
}
}
return sites_to_entries;
}
FirstPartySetMetadata GlobalFirstPartySets::ComputeMetadata(
const SchemefulSite& site,
base::optional_ref<const SchemefulSite> top_frame_site,
const FirstPartySetsContextConfig& fps_context_config) const {
return FirstPartySetMetadata(
FindEntry(site, fps_context_config),
top_frame_site ? FindEntry(*top_frame_site, fps_context_config)
: std::nullopt);
}
void GlobalFirstPartySets::ApplyManuallySpecifiedSet(
const LocalSetDeclaration& local_set_declaration) {
CHECK(manual_config_.empty());
if (local_set_declaration.empty()) {
// Nothing to do.
return;
}
manual_config_ = ComputeConfig(local_set_declaration.ComputeMutation());
CHECK(IsValid()) << "Sets must be valid";
}
void GlobalFirstPartySets::UnsafeSetManualConfig(
FirstPartySetsContextConfig manual_config) {
CHECK(manual_config_.empty());
manual_config_ = std::move(manual_config);
}
base::flat_map<SchemefulSite, FirstPartySetEntry>
GlobalFirstPartySets::FindPrimariesAffectedByAdditions(
const FlattenedSets& additions) const {
std::vector<std::pair<SchemefulSite, FirstPartySetEntry>>
addition_intersected_primaries;
for (const auto& [new_member, new_entry] : additions) {
if (const auto entry = FindEntry(new_member, /*config=*/nullptr);
entry.has_value()) {
// Found an overlap with the existing list of sets.
addition_intersected_primaries.emplace_back(entry->primary(), new_entry);
}
}
return addition_intersected_primaries;
}
std::pair<base::flat_map<SchemefulSite, base::flat_set<SchemefulSite>>,
base::flat_set<SchemefulSite>>
GlobalFirstPartySets::FindPrimariesAffectedByReplacements(
const FlattenedSets& replacements,
const FlattenedSets& additions,
const base::flat_map<SchemefulSite, FirstPartySetEntry>&
addition_intersected_primaries) const {
if (replacements.empty()) {
return {{}, {}};
}
const auto canonicalize = [&](const SchemefulSite& site) {
const auto it = aliases_.find(site);
return it != aliases_.end() ? it->second : site;
};
std::map<SchemefulSite, std::set<SchemefulSite>> canonical_to_aliases;
ForEachAlias([&](const SchemefulSite& alias, const SchemefulSite& canonical) {
canonical_to_aliases[canonical].insert(alias);
});
// Runs the given FunctionRef for all (existing) variants of the given site,
// i.e. all the aliases and the "canonical" variant.
const auto for_all_variants =
[canonical_to_aliases = std::move(canonical_to_aliases),
canonicalize = std::move(canonicalize)](
const SchemefulSite& site,
const base::FunctionRef<void(const SchemefulSite&)> f) {
const SchemefulSite canonical = canonicalize(site);
f(canonical);
if (const auto it = canonical_to_aliases.find(canonical);
it != canonical_to_aliases.end()) {
for (const auto& alias : it->second) {
f(alias);
}
}
};
// Maps an existing primary site to the members it lost due to replacement.
base::flat_map<SchemefulSite, base::flat_set<SchemefulSite>>
potential_singletons;
// Stores existing primary sites which have left their sets (via
// replacement), and whose existing members should be removed from the set
// (excluding any custom sets that those members are involved in).
base::flat_set<SchemefulSite> replaced_existing_primaries;
for (const auto& [new_site, unused_entry] : replacements) {
const auto existing_entry = FindEntry(new_site, /*config=*/nullptr);
if (!existing_entry.has_value()) {
continue;
}
if (!addition_intersected_primaries.contains(existing_entry->primary()) &&
!additions.contains(existing_entry->primary()) &&
!replacements.contains(existing_entry->primary())) {
// The existing site's primary isn't involved in any of the customized
// sets, so it might become a singleton (if all of its variants and
// non-primaries [and their variants] are replaced by the
// customizations).
for_all_variants(new_site, [&](const SchemefulSite& variant) {
if (existing_entry->primary() != variant) {
potential_singletons[existing_entry->primary()].insert(variant);
}
});
}
if (existing_entry->primary() == new_site) {
// `new_site` was a primary in the existing sets, but is in the
// replacement sets, so its non-primaries (and aliases) might need to be
// deleted/hidden.
bool inserted =
replaced_existing_primaries.emplace(existing_entry->primary()).second;
CHECK(inserted);
}
}
return std::make_pair(potential_singletons, replaced_existing_primaries);
}
FirstPartySetsContextConfig GlobalFirstPartySets::ComputeConfig(
SetsMutation mutation) const {
if (std::ranges::all_of(mutation.replacements(), &SingleSet::empty) &&
std::ranges::all_of(mutation.additions(), &SingleSet::empty)) {
// Nothing to do.
return FirstPartySetsContextConfig();
}
const FlattenedSets replacements = Flatten(mutation.replacements());
const FlattenedSets additions =
Flatten(NormalizeAdditionSets(mutation.additions()));
// Maps a site to its override.
std::vector<std::pair<SchemefulSite, FirstPartySetEntryOverride>>
site_to_override;
std::ranges::transform(replacements, std::back_inserter(site_to_override),
SiteAndEntryToSiteAndOverride);
std::ranges::transform(additions, std::back_inserter(site_to_override),
SiteAndEntryToSiteAndOverride);
// Maps old primary site to new entry.
const base::flat_map<SchemefulSite, FirstPartySetEntry>
addition_intersected_primaries =
FindPrimariesAffectedByAdditions(additions);
auto [potential_singletons, replaced_existing_primaries] =
FindPrimariesAffectedByReplacements(replacements, additions,
addition_intersected_primaries);
if (!addition_intersected_primaries.empty() ||
!potential_singletons.empty() || !replaced_existing_primaries.empty()) {
// Find out which potential singletons are actually singletons; delete
// members whose primaries left; and reparent the sets that intersected with
// an addition set.
// Note: use a null config here, to avoid taking unrelated policy sets into
// account.
ForEachEffectiveSetEntry(
/*config=*/std::nullopt,
[&](const SchemefulSite& member, const FirstPartySetEntry& set_entry) {
// Reparent all sites in any intersecting addition sets.
if (const auto entry =
addition_intersected_primaries.find(set_entry.primary());
entry != addition_intersected_primaries.end() &&
!replacements.contains(member)) {
site_to_override.emplace_back(
member, FirstPartySetEntry(entry->second.primary(),
member == entry->second.primary()
? SiteType::kPrimary
: SiteType::kAssociated));
}
if (member == set_entry.primary())
return true;
// Remove non-singletons from the potential list.
if (const auto entry = potential_singletons.find(set_entry.primary());
entry != potential_singletons.end() &&
!entry->second.contains(member)) {
// This primary lost members, but it still has at least one
// (`member`), so it's not a singleton.
potential_singletons.erase(entry);
}
// Remove members from sets whose primary left.
if (replaced_existing_primaries.contains(set_entry.primary()) &&
!replacements.contains(member) &&
!addition_intersected_primaries.contains(set_entry.primary())) {
site_to_override.emplace_back(member, FirstPartySetEntryOverride());
}
return true;
});
// Any primary remaining in `potential_singleton` is a real singleton, so
// delete it:
for (const auto& [primary, members] : potential_singletons) {
site_to_override.emplace_back(primary, FirstPartySetEntryOverride());
}
}
// For every pre-existing alias that would now refer to a site in the overlay,
// which is not already contained in the overlay, we explicitly ignore that
// alias.
ForEachAlias([&](const SchemefulSite& alias, const SchemefulSite& canonical) {
if (base::Contains(
site_to_override, canonical,
&std::pair<SchemefulSite, FirstPartySetEntryOverride>::first) &&
!base::Contains(
site_to_override, alias,
&std::pair<SchemefulSite, FirstPartySetEntryOverride>::first)) {
site_to_override.emplace_back(alias, FirstPartySetEntryOverride());
}
});
// Verify that the original set of aliases in the overlay don't refer to
// anything that was removed from the overlay. No alias can refer to a
// deletion.
CHECK(std::ranges::none_of(
mutation.aliases(), [&](const auto& alias_pair) -> bool {
const auto alias_override_it = std::ranges::find_if(
site_to_override, [&](const auto& site_override_pair) -> bool {
return site_override_pair.first == alias_pair.first;
});
return alias_override_it == site_to_override.end() ||
alias_override_it->second.IsDeletion();
}));
std::optional<FirstPartySetsContextConfig> config =
FirstPartySetsContextConfig::Create(std::move(site_to_override),
mutation.aliases());
CHECK(config.has_value()); // This class ensures the invariants that the
// config relies on.
CHECK(IsValid(config)) << "Sets must not contain singleton or orphan";
return std::move(config).value();
}
std::vector<base::flat_map<SchemefulSite, FirstPartySetEntry>>
GlobalFirstPartySets::NormalizeAdditionSets(
const std::vector<base::flat_map<SchemefulSite, FirstPartySetEntry>>&
addition_sets) const {
if (std::ranges::all_of(addition_sets, &SingleSet::empty)) {
// Nothing to do.
return {};
}
// Find all the addition sets that intersect with any given public set.
base::flat_map<SchemefulSite, base::flat_set<size_t>> addition_set_overlaps;
for (size_t set_idx = 0; set_idx < addition_sets.size(); set_idx++) {
for (const auto& site_and_entry : addition_sets[set_idx]) {
if (const auto entry =
FindEntry(site_and_entry.first, /*config=*/nullptr);
entry.has_value()) {
addition_set_overlaps[entry->primary()].insert(set_idx);
}
}
}
// Union together all transitively-overlapping addition sets.
AdditionOverlapsUnionFind union_finder(addition_sets.size());
for (const auto& [public_site, addition_set_indices] :
addition_set_overlaps) {
for (size_t representative : addition_set_indices) {
union_finder.Union(*addition_set_indices.begin(), representative);
}
}
// Now build the new addition sets, with all transitive overlaps eliminated.
std::vector<SingleSet> normalized_additions;
for (const auto& [rep, children] : union_finder.SetsMapping()) {
SingleSet normalized = addition_sets[rep];
const SchemefulSite& rep_primary =
addition_sets[rep].begin()->second.primary();
for (size_t child_set_idx : children) {
for (const auto& child_site_and_entry : addition_sets[child_set_idx]) {
bool inserted =
normalized
.emplace(child_site_and_entry.first,
FirstPartySetEntry(rep_primary, SiteType::kAssociated))
.second;
CHECK(inserted);
}
}
normalized_additions.push_back(normalized);
}
return normalized_additions;
}
bool GlobalFirstPartySets::ForEachPublicSetEntry(
base::FunctionRef<bool(const SchemefulSite&, const FirstPartySetEntry&)> f)
const {
for (const auto& [site, entry] : entries_) {
if (!f(site, entry))
return false;
}
for (const auto& [alias, canonical] : aliases_) {
auto it = entries_.find(canonical);
CHECK(it != entries_.end());
if (!f(alias, it->second))
return false;
}
return true;
}
bool GlobalFirstPartySets::ForEachManualConfigEntry(
base::FunctionRef<bool(const SchemefulSite&,
const FirstPartySetEntryOverride&)> f) const {
return manual_config_.ForEachCustomizationEntry(f);
}
bool GlobalFirstPartySets::ForEachEffectiveSetEntry(
const FirstPartySetsContextConfig& config,
base::FunctionRef<bool(const SchemefulSite&, const FirstPartySetEntry&)> f)
const {
return ForEachEffectiveSetEntry(&config, f);
}
bool GlobalFirstPartySets::ForEachEffectiveSetEntry(
base::optional_ref<const FirstPartySetsContextConfig> config,
base::FunctionRef<bool(const SchemefulSite&, const FirstPartySetEntry&)> f)
const {
// Policy sets have highest precedence:
if (config) {
if (!config->ForEachCustomizationEntry(
[&](const SchemefulSite& site,
const FirstPartySetEntryOverride& override) {
if (!override.IsDeletion())
return f(site, override.GetEntry());
return true;
})) {
return false;
}
}
// Then the manual set:
if (!manual_config_.ForEachCustomizationEntry(
[&](const SchemefulSite& site,
const FirstPartySetEntryOverride& override) {
if (!override.IsDeletion() && (!config || !config->Contains(site)))
return f(site, override.GetEntry());
return true;
})) {
return false;
}
// Finally, the public sets.
return ForEachPublicSetEntry([&](const SchemefulSite& site,
const FirstPartySetEntry& entry) {
if ((!config || !config->Contains(site)) && !manual_config_.Contains(site))
return f(site, entry);
return true;
});
}
void GlobalFirstPartySets::ForEachAlias(
base::FunctionRef<void(const SchemefulSite&, const SchemefulSite&)> f)
const {
manual_config_.ForEachAlias(f);
for (const auto& [alias, site] : aliases_) {
if (manual_config_.Contains(alias)) {
continue;
}
f(alias, site);
}
}
bool GlobalFirstPartySets::IsValid(
base::optional_ref<const FirstPartySetsContextConfig> config) const {
FirstPartySetsValidator validator;
ForEachEffectiveSetEntry(
config,
[&](const SchemefulSite& site, const FirstPartySetEntry& entry) -> bool {
validator.Update(site, entry.primary());
return true;
});
return validator.IsValid();
}
std::ostream& operator<<(std::ostream& os, const GlobalFirstPartySets& sets) {
os << "{entries = {";
for (const auto& [site, entry] : sets.entries_) {
os << "{" << site.Serialize() << ": " << entry << "}, ";
}
os << "}, aliases = {";
for (const auto& [alias, canonical] : sets.aliases_) {
os << "{" << alias.Serialize() << ": " << canonical.Serialize() << "}, ";
}
os << "}, manual_config = {";
sets.ForEachManualConfigEntry(
[&](const net::SchemefulSite& site,
const FirstPartySetEntryOverride& override) {
os << "{" << site.Serialize() << ": " << override << "},";
return true;
});
os << "}}";
return os;
}
} // namespace net
|