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
|
// Copyright 2023 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/privacy_sandbox/privacy_sandbox_attestations/privacy_sandbox_attestations.h"
#include <string>
#include <string_view>
#include "base/feature_list.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/with_feature_override.h"
#include "base/version.h"
#include "components/privacy_sandbox/privacy_sandbox_attestations/privacy_sandbox_attestations_histograms.h"
#include "components/privacy_sandbox/privacy_sandbox_attestations/proto/privacy_sandbox_attestations.pb.h"
#include "components/privacy_sandbox/privacy_sandbox_attestations/scoped_privacy_sandbox_attestations.h"
#include "components/privacy_sandbox/privacy_sandbox_features.h"
#include "components/privacy_sandbox/privacy_sandbox_test_util.h"
#include "components/startup_metric_utils/browser/startup_metric_utils.h"
#include "content/public/test/browser_task_environment.h"
#include "net/base/schemeful_site.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "url/gurl.h"
namespace privacy_sandbox {
using Status =
::privacy_sandbox_test_util::PrivacySandboxSettingsTestPeer::Status;
class PrivacySandboxAttestationsTestBase : public testing::Test {
public:
PrivacySandboxAttestationsTestBase()
: scoped_attestations_(PrivacySandboxAttestations::CreateForTesting()) {}
protected:
const base::HistogramTester& histogram_tester() const {
return histogram_tester_;
}
void SetUp() override { ASSERT_TRUE(scoped_temp_dir_.CreateUniqueTempDir()); }
void WriteAttestationsFileAndWaitForLoading(base::Version version,
std::string_view content) {
base::ScopedTempDir component_install_dir;
CHECK(
component_install_dir.CreateUniqueTempDirUnderPath(GetTestDirectory()));
// Note the actual attestations file name required by the Privacy Sandbox
// Attestations component is specified by
// `kPrivacySandboxAttestationsFileName`. Here because this is a unit test
// so it can be any file name.
base::FilePath attestations_file_path =
component_install_dir.GetPath().Append(
FILE_PATH_LITERAL("attestations"));
CHECK(base::WriteFile(attestations_file_path, content));
base::RunLoop run_loop;
PrivacySandboxAttestations::GetInstance()
->SetLoadAttestationsDoneCallbackForTesting(run_loop.QuitClosure());
PrivacySandboxAttestations::GetInstance()->LoadAttestations(
version, attestations_file_path, /*is_pre_installed=*/false);
run_loop.Run();
}
void WriteAttestationsFileAndPauseDuringParsing(base::Version version,
std::string_view content) {
base::ScopedTempDir component_install_dir;
CHECK(
component_install_dir.CreateUniqueTempDirUnderPath(GetTestDirectory()));
// Note the actual attestations file name required by the Privacy Sandbox
// Attestations component is specified by
// `kPrivacySandboxAttestationsFileName`. Here because this is a unit test
// so it can be any file name.
base::FilePath attestations_file_path =
component_install_dir.GetPath().Append(
FILE_PATH_LITERAL("attestations"));
CHECK(base::WriteFile(attestations_file_path, content));
base::RunLoop run_loop;
PrivacySandboxAttestations::GetInstance()
->SetLoadAttestationsParsingStartedCallbackForTesting(
run_loop.QuitClosure());
PrivacySandboxAttestations::GetInstance()->LoadAttestations(
version, attestations_file_path, /*is_pre_installed=*/false);
run_loop.Run();
}
const base::FilePath& GetTestDirectory() const {
return scoped_temp_dir_.GetPath();
}
private:
content::BrowserTaskEnvironment browser_task_environment_;
ScopedPrivacySandboxAttestations scoped_attestations_;
base::ScopedTempDir scoped_temp_dir_;
base::HistogramTester histogram_tester_;
};
TEST_F(PrivacySandboxAttestationsTestBase, AddOverride) {
net::SchemefulSite site(GURL("https://example.com"));
ASSERT_FALSE(PrivacySandboxAttestations::GetInstance()->IsOverridden(site));
PrivacySandboxAttestations::GetInstance()->AddOverride(site);
EXPECT_TRUE(PrivacySandboxAttestations::GetInstance()->IsOverridden(site));
}
class PrivacySandboxAttestationsFeatureEnabledTest
: public base::test::WithFeatureOverride,
public PrivacySandboxAttestationsTestBase {
public:
PrivacySandboxAttestationsFeatureEnabledTest()
: base::test::WithFeatureOverride(
kDefaultAllowPrivacySandboxAttestations) {
scoped_feature_list_.InitAndEnableFeature(
kEnforcePrivacySandboxAttestations);
}
void SetUp() override {
PrivacySandboxAttestationsTestBase::SetUp();
// Reset the singleton recorder to avoid interference across test cases.
startup_metric_utils::GetBrowser().ResetSessionForTesting();
}
bool IsAttestationsDefaultAllowed() const { return IsParamFeatureEnabled(); }
// Return the final expected status of `IsSiteAttested` given the `status`
// which represents the actual status of the attestation.
// Note that this is the expected status when default behavior is not
// specified by the call site.
Status GetExpectedStatus(Status status) {
// If the attestations map is absent and feature
// `kDefaultAllowPrivacySandboxAttestations` is on, the expected status is
// default allow when the given status implies the map is absent.
if (IsAttestationsDefaultAllowed() &&
(status == Status::kAttestationsFileNotPresent ||
status == Status::kAttestationsDownloadedNotYetLoaded ||
status == Status::kAttestationsFileCorrupt ||
status == Status::kAttestationsFileNotYetChecked)) {
return Status::kAllowed;
}
return status;
}
private:
base::test::ScopedFeatureList scoped_feature_list_;
};
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
AttestationsBehaviorWithMapBeingAbsent) {
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
EXPECT_EQ(attestation_status,
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileSource, 0);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
DefaultDenyIfAttestationsComponentNotYetReady) {
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
EXPECT_EQ(attestation_status,
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest, AttestedIfOverridden) {
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
ASSERT_EQ(attestation_status,
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
PrivacySandboxAttestations::GetInstance()->AddOverride(site);
EXPECT_TRUE(PrivacySandboxAttestations::GetInstance()->IsOverridden(site));
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
EnrolledWithoutAttestations) {
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
ASSERT_EQ(attestation_status,
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
PrivacySandboxAttestations::GetInstance()->SetAttestationsForTesting(
PrivacySandboxAttestationsMap{{site, {}}});
Status new_attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
EXPECT_EQ(new_attestation_status,
GetExpectedStatus(Status::kAttestationFailed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA,
Status::kAttestationFailed, 1);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest, EnrolledAndAttested) {
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
ASSERT_EQ(attestation_status,
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
PrivacySandboxAttestations::GetInstance()->SetAttestationsForTesting(
PrivacySandboxAttestationsMap{
{site, PrivacySandboxAttestationsGatedAPISet{
PrivacySandboxAttestationsGatedAPI::kTopics}}});
Status new_attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
EXPECT_EQ(new_attestation_status, GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
1);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
NonExistentAttestationsFile) {
base::RunLoop run_loop;
PrivacySandboxAttestations::GetInstance()
->SetLoadAttestationsDoneCallbackForTesting(run_loop.QuitClosure());
// Call the parsing function with a non-existent file.
PrivacySandboxAttestations::GetInstance()->LoadAttestations(
base::Version("0.0.1"), base::FilePath(), /*is_pre_installed=*/false);
run_loop.Run();
// The parsing should fail.
EXPECT_FALSE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kFileNotExist, 1);
}
// The parsing progress may end up being
// `PrivacySandboxAttestations::Progress::kFinished` but there is no in-memory
// attestations map. Verify that the second attempt to parse should not crash.
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
TryParseNonExistentAttestationsFileTwice) {
base::RunLoop first_attempt;
PrivacySandboxAttestations::GetInstance()
->SetLoadAttestationsDoneCallbackForTesting(first_attempt.QuitClosure());
// Call the parsing function with a non-existent file.
PrivacySandboxAttestations::GetInstance()->LoadAttestations(
base::Version("0.0.1"), base::FilePath(), /*is_pre_installed=*/false);
first_attempt.Run();
// The parsing should fail.
EXPECT_FALSE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kFileNotExist, 1);
base::RunLoop second_attempt;
PrivacySandboxAttestations::GetInstance()
->SetLoadAttestationsDoneCallbackForTesting(second_attempt.QuitClosure());
PrivacySandboxAttestations::GetInstance()->LoadAttestations(
base::Version("0.0.1"), base::FilePath(), /*is_pre_installed=*/false);
second_attempt.Run();
// The parsing should fail again, without crashes.
EXPECT_FALSE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kFileNotExist, 2);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
InvalidAttestationsFileIsNotLoaded) {
// Write an invalid proto file, and try to parse it.
WriteAttestationsFileAndWaitForLoading(base::Version("0.0.1"),
"invalid proto");
// The parsing should fail.
EXPECT_FALSE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kCannotParseFile, 1);
// Attempts to check attestation status should return that the file is
// corrupt.
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kTopics);
EXPECT_EQ(attestation_status,
GetExpectedStatus(Status::kAttestationsFileCorrupt));
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest, LoadAttestationsFile) {
PrivacySandboxAttestationsProto proto;
ASSERT_TRUE(proto.site_attestations_size() == 0);
std::string site = "https://example.com";
ASSERT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
// Add attestation for the site.
PrivacySandboxAttestationsProto::PrivacySandboxAttestedAPIsProto
site_attestation;
site_attestation.add_attested_apis(TOPICS);
(*proto.mutable_site_attestations())[site] = site_attestation;
std::string serialized_proto;
proto.SerializeToString(&serialized_proto);
WriteAttestationsFileAndWaitForLoading(base::Version("0.0.1"),
serialized_proto);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kSuccess, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingTimeUMA, 1);
histogram_tester().ExpectTotalCount(kAttestationsMapMemoryUsageUMA, 1);
// The site should be attested for the API.
ASSERT_TRUE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->GetVersionForTesting(),
base::Version("0.0.1"));
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
1);
histogram_tester().ExpectTotalCount(kAttestationsFileSource, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileSource,
FileSource::kDownloaded, 1);
// For API not in the attestations list, the result should be
// `kAttestationFailed`.
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kProtectedAudience),
GetExpectedStatus(Status::kAttestationFailed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 3);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA,
Status::kAttestationFailed, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileSource, 2);
histogram_tester().ExpectBucketCount(kAttestationsFileSource,
FileSource::kDownloaded, 2);
// Add attestation for Protected Audience.
site_attestation.add_attested_apis(PROTECTED_AUDIENCE);
(*proto.mutable_site_attestations())[site] = site_attestation;
// Parse the new version.
proto.SerializeToString(&serialized_proto);
WriteAttestationsFileAndWaitForLoading(base::Version("0.0.2"),
serialized_proto);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kSuccess, 2);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingTimeUMA, 2);
histogram_tester().ExpectTotalCount(kAttestationsMapMemoryUsageUMA, 2);
// Now the site should be attested for both APIs.
ASSERT_TRUE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->GetVersionForTesting(),
base::Version("0.0.2"));
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 4);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
2);
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kProtectedAudience),
GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 5);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
3);
histogram_tester().ExpectTotalCount(kAttestationsFileSource, 4);
histogram_tester().ExpectBucketCount(kAttestationsFileSource,
FileSource::kDownloaded, 4);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
AttestationFirstCheckTimeHistogram) {
histogram_tester().ExpectTotalCount(kAttestationFirstCheckTimeUMA, 0);
std::string site = "https://example.com";
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kProtectedAudience),
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectTotalCount(kAttestationFirstCheckTimeUMA, 1);
// The first attestation check histogram should be only recorded once for each
// Chrome session.
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectTotalCount(kAttestationFirstCheckTimeUMA, 1);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
LoadAttestationsFilePauseDuringParsing) {
PrivacySandboxAttestationsProto proto;
ASSERT_TRUE(proto.site_attestations_size() == 0);
std::string site = "https://example.com";
ASSERT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
// Add attestation for the site.
PrivacySandboxAttestationsProto::PrivacySandboxAttestedAPIsProto
site_attestation;
site_attestation.add_attested_apis(TOPICS);
(*proto.mutable_site_attestations())[site] = site_attestation;
std::string serialized_proto;
proto.SerializeToString(&serialized_proto);
WriteAttestationsFileAndPauseDuringParsing(base::Version("0.0.1"),
serialized_proto);
// The attestation check should return an error indicating that parsing is in
// progress.
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationsDownloadedNotYetLoaded));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsDownloadedNotYetLoaded, 1);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
OlderVersionAttestationsFileIsNotLoaded) {
PrivacySandboxAttestationsProto proto;
ASSERT_TRUE(proto.site_attestations_size() == 0);
std::string site = "https://example.com";
ASSERT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
// Add attestation for the site.
PrivacySandboxAttestationsProto::PrivacySandboxAttestedAPIsProto
site_attestation;
site_attestation.add_attested_apis(TOPICS);
(*proto.mutable_site_attestations())[site] = site_attestation;
std::string serialized_proto;
proto.SerializeToString(&serialized_proto);
WriteAttestationsFileAndWaitForLoading(base::Version("1.2.3"),
serialized_proto);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kSuccess, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingTimeUMA, 1);
histogram_tester().ExpectTotalCount(kAttestationsMapMemoryUsageUMA, 1);
// The site should be attested for the API.
ASSERT_TRUE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->GetVersionForTesting(),
base::Version("1.2.3"));
ASSERT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
1);
// Clear the proto attestations.
proto.clear_site_attestations();
// Load the attestations file, which has an older version.
proto.SerializeToString(&serialized_proto);
WriteAttestationsFileAndWaitForLoading(base::Version("0.0.1"),
serialized_proto);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kNotNewerVersion, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingTimeUMA, 1);
histogram_tester().ExpectTotalCount(kAttestationsMapMemoryUsageUMA, 1);
// The attestations map should still be the old one.
ASSERT_TRUE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->GetVersionForTesting(),
base::Version("1.2.3"));
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 3);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
2);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
NewerVersionAttestationsFileIsLoaded) {
PrivacySandboxAttestationsProto proto;
ASSERT_TRUE(proto.site_attestations_size() == 0);
std::string site = "https://example.com";
ASSERT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
// Add attestation for the site.
PrivacySandboxAttestationsProto::PrivacySandboxAttestedAPIsProto
site_attestation;
site_attestation.add_attested_apis(TOPICS);
(*proto.mutable_site_attestations())[site] = site_attestation;
std::string serialized_proto;
proto.SerializeToString(&serialized_proto);
WriteAttestationsFileAndWaitForLoading(base::Version("0.0.1"),
serialized_proto);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kSuccess, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingTimeUMA, 1);
histogram_tester().ExpectTotalCount(kAttestationsMapMemoryUsageUMA, 1);
// The site should be attested for the API.
ASSERT_TRUE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->GetVersionForTesting(),
base::Version("0.0.1"));
ASSERT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
1);
// Clear the attestations.
proto.clear_site_attestations();
// Load the attestations file, which has a newer version.
proto.SerializeToString(&serialized_proto);
WriteAttestationsFileAndWaitForLoading(base::Version("0.0.2"),
serialized_proto);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kSuccess, 2);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingTimeUMA, 2);
histogram_tester().ExpectTotalCount(kAttestationsMapMemoryUsageUMA, 2);
// The newer version should override the existing attestations map.
ASSERT_TRUE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->GetVersionForTesting(),
base::Version("0.0.2"));
// The site should not be attested for the API according to the new
// attestations map.
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationFailed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 3);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA,
Status::kAttestationFailed, 1);
}
// Test that the parsing works as expected when there are combining characters
// in the file path to the attestation list. There are exhaustive tests on this
// in `base/files/file_path_unittest.cc`.
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
CombiningCharacterFilePath) {
PrivacySandboxAttestationsProto proto;
ASSERT_TRUE(proto.site_attestations_size() == 0);
std::string site = "https://example.com";
ASSERT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAttestationsFileNotYetChecked));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
// Add attestation for the site.
PrivacySandboxAttestationsProto::PrivacySandboxAttestedAPIsProto
site_attestation;
site_attestation.add_attested_apis(TOPICS);
(*proto.mutable_site_attestations())[site] = site_attestation;
std::string serialized_proto;
proto.SerializeToString(&serialized_proto);
base::ScopedTempDir scoped_temp_dir;
CHECK(scoped_temp_dir.CreateUniqueTempDirUnderPath(GetTestDirectory()));
// Create an install directory that contains combining characters.
base::FilePath component_install_dir = scoped_temp_dir.GetPath().Append(
FILE_PATH_LITERAL("k\u0301u\u032Do\u0304\u0301n"));
CHECK(base::CreateDirectory(component_install_dir));
base::FilePath attestations_file_path =
component_install_dir.Append(FILE_PATH_LITERAL("attestations"));
CHECK(base::WriteFile(attestations_file_path, serialized_proto));
base::RunLoop run_loop;
PrivacySandboxAttestations::GetInstance()
->SetLoadAttestationsDoneCallbackForTesting(run_loop.QuitClosure());
PrivacySandboxAttestations::GetInstance()->LoadAttestations(
base::Version("2023.1.23.0"), attestations_file_path,
/*is_pre_installed=*/false);
run_loop.Run();
histogram_tester().ExpectTotalCount(kAttestationsFileParsingStatusUMA, 1);
histogram_tester().ExpectBucketCount(kAttestationsFileParsingStatusUMA,
ParsingStatus::kSuccess, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileParsingTimeUMA, 1);
histogram_tester().ExpectTotalCount(kAttestationsMapMemoryUsageUMA, 1);
// The site should be attested for the API.
ASSERT_TRUE(PrivacySandboxAttestations::GetInstance()
->GetVersionForTesting()
.IsValid());
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->GetVersionForTesting(),
base::Version("2023.1.23.0"));
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kTopics),
GetExpectedStatus(Status::kAllowed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 2);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA, Status::kAllowed,
1);
// For API not in the attestations list, the result should be
// `kAttestationFailed`.
EXPECT_EQ(PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
net::SchemefulSite(GURL(site)),
PrivacySandboxAttestationsGatedAPI::kProtectedAudience),
GetExpectedStatus(Status::kAttestationFailed));
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 3);
histogram_tester().ExpectBucketCount(kAttestationStatusUMA,
Status::kAttestationFailed, 1);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
AttestationsDefaultBehaviorAllowWithMapBeingAbsent) {
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kAttributionReporting,
AttestationsDefaultBehavior::kAllow);
EXPECT_EQ(attestation_status, Status::kAllowed);
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileSource, 0);
}
TEST_P(PrivacySandboxAttestationsFeatureEnabledTest,
AttestationsDefaultBehaviorDenyWithMapBeingAbsent) {
net::SchemefulSite site(GURL("https://example.com"));
Status attestation_status =
PrivacySandboxAttestations::GetInstance()->IsSiteAttested(
site, PrivacySandboxAttestationsGatedAPI::kAttributionReporting,
AttestationsDefaultBehavior::kDeny);
EXPECT_EQ(attestation_status, Status::kAttestationsFileNotYetChecked);
histogram_tester().ExpectTotalCount(kAttestationStatusUMA, 1);
histogram_tester().ExpectBucketCount(
kAttestationStatusUMA, Status::kAttestationsFileNotYetChecked, 1);
histogram_tester().ExpectTotalCount(kAttestationsFileSource, 0);
}
INSTANTIATE_FEATURE_OVERRIDE_TEST_SUITE(
PrivacySandboxAttestationsFeatureEnabledTest);
} // namespace privacy_sandbox
|