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
|
// 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/attribution_reporting/aggregatable_debug_reporting_config.h"
#include <stdint.h>
#include <algorithm>
#include <optional>
#include <set>
#include <string>
#include <string_view>
#include <utility>
#include "base/check.h"
#include "base/check_op.h"
#include "base/containers/enum_set.h"
#include "base/functional/function_ref.h"
#include "base/metrics/histogram_functions.h"
#include "base/numerics/safe_conversions.h"
#include "base/types/expected.h"
#include "base/types/expected_macros.h"
#include "base/values.h"
#include "components/attribution_reporting/aggregatable_utils.h"
#include "components/attribution_reporting/constants.h"
#include "components/attribution_reporting/debug_types.h"
#include "components/attribution_reporting/debug_types.mojom.h"
#include "components/attribution_reporting/parsing_utils.h"
#include "third_party/abseil-cpp/absl/numeric/int128.h"
namespace attribution_reporting {
namespace {
using ::attribution_reporting::mojom::DebugDataType;
constexpr char kAggregatableDebugReporting[] = "aggregatable_debug_reporting";
constexpr char kBudget[] = "budget";
constexpr char kDebugData[] = "debug_data";
constexpr char kTypes[] = "types";
using ParseDebugDataTypeFunc =
base::FunctionRef<base::expected<DebugDataType, ParseError>(
std::string_view)>;
bool IsValueInRange(int value, std::optional<int> max_value) {
int effective_max_value = max_value.value_or(kMaxAggregatableValue);
CHECK_LE(effective_max_value, kMaxAggregatableValue);
return value > 0 && value <= effective_max_value;
}
base::expected<int, ParseError> ParseValue(const base::Value::Dict& dict,
std::optional<int> max_value) {
const base::Value* value = dict.Find(kValue);
if (!value) {
return base::unexpected(ParseError());
}
ASSIGN_OR_RETURN(int int_value, ParseInt(*value));
if (!IsValueInRange(int_value, max_value)) {
return base::unexpected(ParseError());
}
return int_value;
}
base::expected<int, ParseError> ParseBudget(const base::Value::Dict& dict) {
const base::Value* value = dict.Find(kBudget);
if (!value) {
return base::unexpected(ParseError());
}
return ParseAggregatableValue(*value);
}
base::expected<absl::uint128, ParseError> ParseKeyPiece(
const base::Value::Dict& dict) {
const base::Value* v = dict.Find(kKeyPiece);
if (!v) {
return base::unexpected(ParseError());
}
return ParseAggregationKeyPiece(*v);
}
base::expected<void, AggregatableDebugReportingConfigError>
ParseDebugDataElement(base::Value& elem,
AggregatableDebugReportingConfig::DebugData& data,
std::optional<AggregatableDebugReportingContribution>&
unspecified_contribution,
std::set<std::string>& unknown_types,
std::optional<int> max_value,
ParseDebugDataTypeFunc parse_debug_data_type) {
base::Value::Dict* dict = elem.GetIfDict();
if (!dict) {
return base::unexpected(
AggregatableDebugReportingConfigError::kDebugDataInvalid);
}
ASSIGN_OR_RETURN(
absl::uint128 key_piece,
ParseKeyPiece(*dict).transform_error([](ParseError) {
return AggregatableDebugReportingConfigError::kDebugDataKeyPieceInvalid;
}));
ASSIGN_OR_RETURN(
int int_value,
ParseValue(*dict, max_value).transform_error([](ParseError) {
return AggregatableDebugReportingConfigError::kDebugDataValueInvalid;
}));
base::Value::List* l = dict->FindList(kTypes);
if (!l || l->empty()) {
return base::unexpected(
AggregatableDebugReportingConfigError::kDebugDataTypesInvalid);
}
std::optional<AggregatableDebugReportingContribution> contribution =
AggregatableDebugReportingContribution::Create(key_piece, int_value);
CHECK(contribution.has_value());
for (base::Value& v : *l) {
std::string* s = v.GetIfString();
if (!s) {
return base::unexpected(
AggregatableDebugReportingConfigError::kDebugDataTypesInvalid);
}
if (*s == "unspecified") {
if (unspecified_contribution.has_value()) {
return base::unexpected(
AggregatableDebugReportingConfigError::kDebugDataTypesInvalid);
}
unspecified_contribution.emplace(*contribution);
continue;
}
if (auto type = parse_debug_data_type(*s); type.has_value()) {
auto [_, inserted] = data.try_emplace(*type, *contribution);
if (!inserted) {
return base::unexpected(
AggregatableDebugReportingConfigError::kDebugDataTypesInvalid);
}
} else {
auto [_, inserted] = unknown_types.emplace(std::move(*s));
if (!inserted) {
return base::unexpected(
AggregatableDebugReportingConfigError::kDebugDataTypesInvalid);
}
}
}
return base::ok();
}
base::expected<AggregatableDebugReportingConfig::DebugData,
AggregatableDebugReportingConfigError>
ParseDebugData(base::Value::Dict& dict,
std::optional<int> max_value,
const DebugDataTypes& debug_data_types,
ParseDebugDataTypeFunc parse_debug_data_type) {
base::Value* value = dict.Find(kDebugData);
if (!value) {
return {};
}
base::Value::List* l = value->GetIfList();
if (!l) {
return base::unexpected(
AggregatableDebugReportingConfigError::kDebugDataInvalid);
}
AggregatableDebugReportingConfig::DebugData data;
std::optional<AggregatableDebugReportingContribution>
unspecified_contribution;
for (std::set<std::string> unknown_types; base::Value& v : *l) {
RETURN_IF_ERROR(ParseDebugDataElement(v, data, unspecified_contribution,
unknown_types, max_value,
parse_debug_data_type));
}
if (unspecified_contribution.has_value()) {
for (DebugDataType type : debug_data_types) {
data.try_emplace(type, *unspecified_contribution);
}
}
return data;
}
void SerializeConfig(base::Value::Dict& dict,
const AggregatableDebugReportingConfig& config) {
dict.Set(kKeyPiece, HexEncodeAggregationKey(config.key_piece));
if (config.aggregation_coordinator_origin.has_value()) {
dict.Set(kAggregationCoordinatorOrigin,
config.aggregation_coordinator_origin->Serialize());
}
if (!config.debug_data.empty()) {
auto list = base::Value::List::with_capacity(config.debug_data.size());
for (const auto& [type, contribution] : config.debug_data) {
CHECK(base::IsValueInRangeForNumericType<int>(contribution.value()));
list.Append(
base::Value::Dict()
.Set(kKeyPiece, HexEncodeAggregationKey(contribution.key_piece()))
.Set(kValue, static_cast<int>(contribution.value()))
.Set(kTypes,
base::Value::List().Append(SerializeDebugDataType(type))));
}
dict.Set(kDebugData, std::move(list));
}
}
bool IsValid(int budget,
const AggregatableDebugReportingConfig::DebugData& data) {
if (!IsAggregatableBudgetInRange(budget)) {
return false;
}
return std::ranges::all_of(data, [&](const auto& p) {
return IsValueInRange(p.second.value(), budget);
});
}
base::expected<AggregatableDebugReportingConfig,
AggregatableDebugReportingConfigError>
ParseConfig(base::Value::Dict& dict,
std::optional<int> max_value,
const DebugDataTypes& debug_data_types,
ParseDebugDataTypeFunc parse_debug_data_type) {
ASSIGN_OR_RETURN(
auto key_piece, ParseKeyPiece(dict).transform_error([](ParseError) {
return AggregatableDebugReportingConfigError::kKeyPieceInvalid;
}));
ASSIGN_OR_RETURN(
auto aggregation_coordinator_origin,
ParseAggregationCoordinator(dict).transform_error([](ParseError) {
return AggregatableDebugReportingConfigError::
kAggregationCoordinatorOriginInvalid;
}));
ASSIGN_OR_RETURN(auto data, ParseDebugData(dict, max_value, debug_data_types,
parse_debug_data_type));
return AggregatableDebugReportingConfig(
key_piece, std::move(data), std::move(aggregation_coordinator_origin));
}
base::expected<SourceAggregatableDebugReportingConfig,
AggregatableDebugReportingConfigError>
ParseSourceConfig(base::Value::Dict& dict) {
base::Value* v = dict.Find(kAggregatableDebugReporting);
if (!v) {
return SourceAggregatableDebugReportingConfig();
}
base::Value::Dict* d = v->GetIfDict();
if (!d) {
return base::unexpected(
AggregatableDebugReportingConfigError::kRootInvalid);
}
ASSIGN_OR_RETURN(int budget, ParseBudget(*d), [](ParseError) {
return AggregatableDebugReportingConfigError::kBudgetInvalid;
});
ASSIGN_OR_RETURN(auto config, ParseConfig(*d, budget, SourceDebugDataTypes(),
&ParseSourceDebugDataType));
auto source_config =
SourceAggregatableDebugReportingConfig::Create(budget, std::move(config));
CHECK(source_config.has_value());
return *std::move(source_config);
}
base::expected<AggregatableDebugReportingConfig,
AggregatableDebugReportingConfigError>
ParseTriggerConfig(base::Value::Dict& dict) {
base::Value* v = dict.Find(kAggregatableDebugReporting);
if (!v) {
return AggregatableDebugReportingConfig();
}
base::Value::Dict* d = v->GetIfDict();
if (!d) {
return base::unexpected(
AggregatableDebugReportingConfigError::kRootInvalid);
}
return ParseConfig(*d, /*max_value=*/std::nullopt, TriggerDebugDataTypes(),
&ParseTriggerDebugDataType);
}
} // namespace
// static
std::optional<AggregatableDebugReportingContribution>
AggregatableDebugReportingContribution::Create(absl::uint128 key_piece,
uint32_t value) {
if (!IsValueInRange(value, /*max_value=*/std::nullopt)) {
return std::nullopt;
}
return AggregatableDebugReportingContribution(key_piece, value);
}
AggregatableDebugReportingContribution::AggregatableDebugReportingContribution(
absl::uint128 key_piece,
uint32_t value)
: key_piece_(key_piece), value_(value) {
CHECK(IsValid());
}
bool AggregatableDebugReportingContribution::IsValid() const {
return IsValueInRange(value_, /*max_value=*/std::nullopt);
}
absl::uint128 AggregatableDebugReportingContribution::key_piece() const {
CHECK(IsValid());
return key_piece_;
}
uint32_t AggregatableDebugReportingContribution::value() const {
CHECK(IsValid());
return value_;
}
// static
base::expected<AggregatableDebugReportingConfig,
AggregatableDebugReportingConfigError>
AggregatableDebugReportingConfig::Parse(base::Value::Dict& dict) {
auto parsed = ParseTriggerConfig(dict);
if (!parsed.has_value()) {
base::UmaHistogramEnumeration(
"Conversions.AggregatableDebugReporting.TriggerRegistrationError",
parsed.error());
}
return parsed;
}
AggregatableDebugReportingConfig::AggregatableDebugReportingConfig() = default;
AggregatableDebugReportingConfig::AggregatableDebugReportingConfig(
absl::uint128 key_piece,
DebugData debug_data,
std::optional<SuitableOrigin> aggregation_coordinator_origin)
: key_piece(key_piece),
debug_data(std::move(debug_data)),
aggregation_coordinator_origin(
std::move(aggregation_coordinator_origin)) {}
AggregatableDebugReportingConfig::~AggregatableDebugReportingConfig() = default;
AggregatableDebugReportingConfig::AggregatableDebugReportingConfig(
const AggregatableDebugReportingConfig&) = default;
AggregatableDebugReportingConfig::AggregatableDebugReportingConfig(
AggregatableDebugReportingConfig&&) = default;
AggregatableDebugReportingConfig& AggregatableDebugReportingConfig::operator=(
const AggregatableDebugReportingConfig&) = default;
AggregatableDebugReportingConfig& AggregatableDebugReportingConfig::operator=(
AggregatableDebugReportingConfig&&) = default;
void AggregatableDebugReportingConfig::Serialize(
base::Value::Dict& dict) const {
base::Value::Dict body;
SerializeConfig(body, *this);
dict.Set(kAggregatableDebugReporting, std::move(body));
}
// static
base::expected<SourceAggregatableDebugReportingConfig,
AggregatableDebugReportingConfigError>
SourceAggregatableDebugReportingConfig::Parse(base::Value::Dict& dict) {
auto parsed = ParseSourceConfig(dict);
if (!parsed.has_value()) {
base::UmaHistogramEnumeration(
"Conversions.AggregatableDebugReporting.SourceRegistrationError",
parsed.error());
}
return parsed;
}
// static
std::optional<SourceAggregatableDebugReportingConfig>
SourceAggregatableDebugReportingConfig::Create(
int budget,
AggregatableDebugReportingConfig config) {
if (!IsValid(budget, config.debug_data)) {
return std::nullopt;
}
return SourceAggregatableDebugReportingConfig(budget, std::move(config));
}
SourceAggregatableDebugReportingConfig::
SourceAggregatableDebugReportingConfig() = default;
SourceAggregatableDebugReportingConfig::SourceAggregatableDebugReportingConfig(
int budget,
AggregatableDebugReportingConfig config)
: budget_(budget), config_(std::move(config)) {
CHECK(IsValid(budget_, config_.debug_data));
}
SourceAggregatableDebugReportingConfig::
~SourceAggregatableDebugReportingConfig() = default;
SourceAggregatableDebugReportingConfig::SourceAggregatableDebugReportingConfig(
const SourceAggregatableDebugReportingConfig&) = default;
SourceAggregatableDebugReportingConfig::SourceAggregatableDebugReportingConfig(
SourceAggregatableDebugReportingConfig&&) = default;
SourceAggregatableDebugReportingConfig&
SourceAggregatableDebugReportingConfig::operator=(
const SourceAggregatableDebugReportingConfig&) = default;
SourceAggregatableDebugReportingConfig&
SourceAggregatableDebugReportingConfig::operator=(
SourceAggregatableDebugReportingConfig&&) = default;
void SourceAggregatableDebugReportingConfig::Serialize(
base::Value::Dict& dict) const {
// `budget_` is 0 when aggregatable debug reporting is not opted in.
if (budget_ == 0) {
return;
}
base::Value::Dict body;
body.Set(kBudget, budget_);
SerializeConfig(body, config_);
dict.Set(kAggregatableDebugReporting, std::move(body));
}
} // namespace attribution_reporting
|