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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/tpcd/metadata/browser/manager.h"
#include <cstdint>
#include <memory>
#include <random>
#include <string>
#include <utility>
#include "base/base64.h"
#include "base/check.h"
#include "base/containers/flat_map.h"
#include "base/hash/sha1.h"
#include "base/metrics/histogram_functions.h"
#include "base/no_destructor.h"
#include "base/rand_util.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "components/content_settings/core/common/content_settings.h"
#include "components/content_settings/core/common/content_settings_enums.mojom-shared.h"
#include "components/content_settings/core/common/content_settings_rules.h"
#include "components/content_settings/core/common/content_settings_utils.h"
#include "components/content_settings/core/common/features.h"
#include "components/content_settings/core/common/host_indexed_content_settings.h"
#include "components/prefs/pref_service.h"
#include "components/prefs/scoped_user_pref_update.h"
#include "components/tpcd/metadata/browser/parser.h"
#include "components/tpcd/metadata/browser/prefs.h"
#include "components/tpcd/metadata/common/proto/metadata.pb.h"
namespace tpcd::metadata {
namespace {
uint32_t ElectedDtrp(const MetadataEntry& metadata_entry) {
return metadata_entry.has_dtrp_override() ? metadata_entry.dtrp_override()
: metadata_entry.dtrp();
}
} // namespace
// static
Manager* Manager::GetInstance(Parser* parser, Delegate& delegate) {
// TODO(dcheng): This is probably the wrong layer for caching the Manager,
// since it's never ideal to pass ctor arguments into a factory method and
// ignore them on subsequent calls.
static base::NoDestructor<Manager> instance(parser, delegate);
return instance.get();
}
Manager::Manager(Parser* parser, Delegate& delegate)
: parser_(parser), delegate_(delegate) {
CHECK(parser_);
rand_generator_ = std::make_unique<RandGenerator>();
parser_->AddObserver(this);
if (!parser_->GetMetadata().empty()) {
OnMetadataReady();
}
}
Manager::~Manager() {
parser_->RemoveObserver(this);
}
uint32_t Manager::RandGenerator::Generate() const {
base::RandomBitGenerator generator;
std::uniform_int_distribution<uint32_t> distribution(Parser::kMinDtrp + 1,
Parser::kMaxDtrp);
uint32_t rand = distribution(generator);
return rand;
}
bool Manager::IsAllowed(const GURL& url,
const GURL& first_party_url,
content_settings::SettingInfo* out_info) const {
base::AutoLock lock(grants_lock_);
return CONTENT_SETTING_ALLOW ==
GetContentSetting(grants_, url, first_party_url, out_info);
}
void Manager::SetGrants(const ContentSettingsForOneType& grants) {
auto indices = content_settings::HostIndexedContentSettings::Create(grants);
if (indices.empty()) {
base::AutoLock lock(grants_lock_);
grants_ = content_settings::HostIndexedContentSettings();
} else {
CHECK_EQ(indices.size(), 1u);
base::AutoLock lock(grants_lock_);
grants_ = std::move(indices.front());
}
delegate_->SetTpcdMetadataGrants(grants);
}
ContentSettingsForOneType Manager::BuildGrantsWithPredicate(
base::FunctionRef<bool(const MetadataEntry&)> predicate) {
base::flat_set<std::string> remove_keys;
if (base::FeatureList::IsEnabled(net::features::kTpcdMetadataStageControl)) {
const base::Value::Dict& dict =
delegate_->GetLocalState().GetDict(prefs::kCohorts);
for (const auto itr : dict) {
remove_keys.insert(itr.first);
}
}
ContentSettingsForOneType grants;
for (const auto& metadata_entry : parser_->GetMetadata()) {
const auto primary_pattern = ContentSettingsPattern::FromString(
metadata_entry.primary_pattern_spec());
const auto secondary_pattern = ContentSettingsPattern::FromString(
metadata_entry.secondary_pattern_spec());
// This is unlikely to occurred as it is validated before the component is
// installed by the component installer.
if (!primary_pattern.IsValid() || !secondary_pattern.IsValid()) {
continue;
}
base::Value value(ContentSetting::CONTENT_SETTING_ALLOW);
content_settings::RuleMetaData rule_metadata =
content_settings::RuleMetaData();
rule_metadata.set_tpcd_metadata_rule_source(
Parser::ToRuleSource(metadata_entry.source()));
uint32_t elected_dtrp = ElectedDtrp(metadata_entry);
rule_metadata.set_tpcd_metadata_elected_dtrp(elected_dtrp);
std::optional<content_settings::mojom::TpcdMetadataCohort> cohort;
if (!metadata_entry.has_dtrp() ||
!base::FeatureList::IsEnabled(
net::features::kTpcdMetadataStageControl)) {
cohort = content_settings::mojom::TpcdMetadataCohort::DEFAULT;
}
std::string key_hash = helpers::GenerateKeyHash(metadata_entry);
// Get the cohort from the prefs if available.
if (!cohort.has_value() && !predicate(metadata_entry)) {
const base::Value::Dict& dict =
delegate_->GetLocalState().GetDict(prefs::kCohorts);
const std::optional<int> stored_int = dict.FindInt(key_hash);
if (stored_int.has_value()) {
auto stored_cohort =
static_cast<content_settings::mojom::TpcdMetadataCohort>(
stored_int.value());
if (content_settings::mojom::IsKnownEnumValue(stored_cohort)) {
cohort = stored_cohort;
remove_keys.erase(key_hash);
}
}
}
if (!cohort.has_value()) {
cohort = rand_generator_->Generate() <= elected_dtrp
? content_settings::mojom::TpcdMetadataCohort::
GRACE_PERIOD_FORCED_OFF
: content_settings::mojom::TpcdMetadataCohort::
GRACE_PERIOD_FORCED_ON;
if (parser_->get_metadata_source() == MetadataSource::kServer &&
Parser::IsTestEntry(metadata_entry)) {
helpers::WriteCohortDistributionMetrics(cohort.value());
}
ScopedDictPrefUpdate update(&delegate_->GetLocalState(), prefs::kCohorts);
update->Set(key_hash, static_cast<int32_t>(cohort.value()));
if (predicate(metadata_entry)) {
remove_keys.erase(key_hash);
}
}
CHECK(cohort.has_value());
rule_metadata.set_tpcd_metadata_cohort(cohort.value());
grants.emplace_back(primary_pattern, secondary_pattern, std::move(value),
content_settings::ProviderType::kNone,
/*incognito=*/false, std::move(rule_metadata));
}
if (base::FeatureList::IsEnabled(net::features::kTpcdMetadataStageControl)) {
ScopedDictPrefUpdate update(&delegate_->GetLocalState(), prefs::kCohorts);
for (const auto& key : remove_keys) {
update->Remove(key);
}
}
return grants;
}
void Manager::OnMetadataReady() {
if (!base::FeatureList::IsEnabled(net::features::kTpcdMetadataGrants)) {
return;
}
SetGrants(
BuildGrantsWithPredicate([](const MetadataEntry&) { return false; }));
}
ContentSettingsForOneType Manager::GetGrants() const {
if (!base::FeatureList::IsEnabled(net::features::kTpcdMetadataGrants)) {
return ContentSettingsForOneType();
}
base::AutoLock lock(grants_lock_);
return GetContentSettingForOneType(grants_);
}
void Manager::ResetCohorts() {
if (!base::FeatureList::IsEnabled(net::features::kTpcdMetadataStageControl)) {
return;
}
auto reset_cohort = [&](const MetadataEntry& metadata_entry) -> bool {
return metadata_entry.has_dtrp();
};
SetGrants(BuildGrantsWithPredicate(reset_cohort));
}
namespace helpers {
std::string GenerateKeyHash(const MetadataEntry& metadata_entry) {
std::string key = base::StrCat(
{metadata_entry.primary_pattern_spec(),
/*Non-url delimiter:*/ "\\", metadata_entry.secondary_pattern_spec(),
base::NumberToString(ElectedDtrp(metadata_entry))});
// The hash from SHA1 is faster to obtain than SHA256 and will be forever
// unchanged if key is unchanged and provides lesser collision risk than MD5.
return base::Base64Encode(base::SHA1HashString(key));
}
void WriteCohortDistributionMetrics(
const content_settings::mojom::TpcdMetadataCohort& cohort) {
base::UmaHistogramEnumeration(kMetadataCohortDistributionHistogram, cohort);
}
} // namespace helpers
} // namespace tpcd::metadata
|