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 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/safe_browsing/incident_reporting/incident_reporting_service.h"
#include <math.h>
#include <stddef.h>
#include <algorithm>
#include <array>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/functional/bind.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/histogram_macros.h"
#include "base/process/process.h"
#include "base/strings/string_util.h"
#include "base/task/single_thread_task_runner.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "build/branding_buildflags.h"
#include "build/build_config.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/metrics/chrome_metrics_service_accessor.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/profiles/profile_manager.h"
#include "chrome/browser/safe_browsing/incident_reporting/environment_data_collection.h"
#include "chrome/browser/safe_browsing/incident_reporting/extension_data_collection.h"
#include "chrome/browser/safe_browsing/incident_reporting/incident.h"
#include "chrome/browser/safe_browsing/incident_reporting/incident_receiver.h"
#include "chrome/browser/safe_browsing/incident_reporting/incident_report_uploader_impl.h"
#include "chrome/browser/safe_browsing/incident_reporting/preference_validation_delegate.h"
#include "chrome/browser/safe_browsing/incident_reporting/state_store.h"
#include "chrome/browser/safe_browsing/safe_browsing_service.h"
#include "chrome/common/pref_names.h"
#include "components/prefs/pref_service.h"
#include "components/safe_browsing/core/common/features.h"
#include "components/safe_browsing/core/common/proto/csd.pb.h"
#include "components/safe_browsing/core/common/safe_browsing_prefs.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/download_item_utils.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/preferences/public/mojom/tracked_preference_validation_delegate.mojom.h"
namespace safe_browsing {
BASE_FEATURE(kIncidentReportingEnableUpload,
"IncidentReportingEnableUpload",
#if BUILDFLAG(GOOGLE_CHROME_BRANDING)
base::FEATURE_ENABLED_BY_DEFAULT
#else
base::FEATURE_DISABLED_BY_DEFAULT
#endif
);
namespace {
// The action taken for an incident; used for user metrics (see
// LogIncidentDataType).
enum IncidentDisposition {
RECEIVED,
DROPPED,
ACCEPTED,
PRUNED,
DISCARDED,
NO_DOWNLOAD,
NUM_DISPOSITIONS
};
// The state persisted for a specific instance of an incident to enable pruning
// of previously-reported incidents.
struct PersistentIncidentState {
// The type of the incident.
IncidentType type;
// The key for a specific instance of an incident.
std::string key;
// A hash digest representing a specific instance of an incident.
uint32_t digest;
};
// The amount of time the service will wait to collate incidents.
const int64_t kDefaultUploadDelayMs = 1000 * 60; // one minute
// The amount of time between running delayed analysis callbacks.
const int64_t kDefaultCallbackIntervalMs = 1000 * 20;
// Logs the type of incident in |incident_data| to a user metrics histogram.
void LogIncidentDataType(IncidentDisposition disposition,
const Incident& incident) {
static auto const kHistogramNames = std::to_array({
"SBIRS.ReceivedIncident",
"SBIRS.DroppedIncident",
"SBIRS.Incident",
"SBIRS.PrunedIncident",
"SBIRS.DiscardedIncident",
"SBIRS.NoDownloadIncident",
});
static_assert(std::size(kHistogramNames) == NUM_DISPOSITIONS,
"Keep kHistogramNames in sync with enum IncidentDisposition.");
DCHECK_GE(disposition, 0);
DCHECK_LT(disposition, NUM_DISPOSITIONS);
base::LinearHistogram::FactoryGet(
kHistogramNames[disposition],
1, // minimum
static_cast<int32_t>(IncidentType::NUM_TYPES), // maximum
static_cast<size_t>(IncidentType::NUM_TYPES) + 1, // bucket_count
base::HistogramBase::kUmaTargetedHistogramFlag)->Add(
static_cast<int32_t>(incident.GetType()));
}
// Computes the persistent state for an incident.
PersistentIncidentState ComputeIncidentState(const Incident& incident) {
PersistentIncidentState state = {
incident.GetType(),
incident.GetKey(),
incident.ComputeDigest(),
};
return state;
}
// Returns a task runner for blocking tasks in the background.
scoped_refptr<base::TaskRunner> GetBackgroundTaskRunner() {
return base::ThreadPool::CreateTaskRunner(
{base::TaskPriority::BEST_EFFORT,
base::TaskShutdownBehavior::CONTINUE_ON_SHUTDOWN, base::MayBlock()});
}
} // namespace
struct IncidentReportingService::ProfileContext {
ProfileContext();
ProfileContext(const ProfileContext&) = delete;
ProfileContext& operator=(const ProfileContext&) = delete;
~ProfileContext();
// Returns true if the profile has incidents to be uploaded or cleared.
bool HasIncidents() const;
// The incidents collected for this profile pending creation and/or upload.
// Will contain null values for pruned incidents.
std::vector<std::unique_ptr<Incident>> incidents;
// The incidents data of which should be cleared.
std::vector<std::unique_ptr<Incident>> incidents_to_clear;
// State storage for this profile; null until OnProfileAdded is called.
std::unique_ptr<StateStore> state_store;
// False until OnProfileAdded is called.
bool added;
};
class IncidentReportingService::UploadContext {
public:
typedef std::map<ProfileContext*, std::vector<PersistentIncidentState>>
PersistentIncidentStateCollection;
explicit UploadContext(std::unique_ptr<ClientIncidentReport> report);
UploadContext(const UploadContext&) = delete;
UploadContext& operator=(const UploadContext&) = delete;
~UploadContext();
// The report being uploaded.
std::unique_ptr<ClientIncidentReport> report;
// The uploader in use.
std::unique_ptr<IncidentReportUploader> uploader;
// A mapping of profile contexts to the data to be persisted upon successful
// upload.
PersistentIncidentStateCollection profiles_to_state;
};
// An IncidentReceiver that is weakly-bound to the service and transparently
// bounces process-wide incidents back to the main thread for handling.
class IncidentReportingService::Receiver : public IncidentReceiver {
public:
explicit Receiver(const base::WeakPtr<IncidentReportingService>& service);
Receiver(const Receiver&) = delete;
Receiver& operator=(const Receiver&) = delete;
~Receiver() override;
// IncidentReceiver methods:
void AddIncidentForProfile(Profile* profile,
std::unique_ptr<Incident> incident) override;
void AddIncidentForProcess(std::unique_ptr<Incident> incident) override;
void ClearIncidentForProcess(std::unique_ptr<Incident> incident) override;
private:
static void AddIncidentOnMainThread(
const base::WeakPtr<IncidentReportingService>& service,
Profile* profile,
std::unique_ptr<Incident> incident);
static void ClearIncidentOnMainThread(
const base::WeakPtr<IncidentReportingService>& service,
Profile* profile,
std::unique_ptr<Incident> incident);
base::WeakPtr<IncidentReportingService> service_;
scoped_refptr<base::SingleThreadTaskRunner> thread_runner_;
};
IncidentReportingService::Receiver::Receiver(
const base::WeakPtr<IncidentReportingService>& service)
: service_(service),
thread_runner_(base::SingleThreadTaskRunner::GetCurrentDefault()) {}
IncidentReportingService::Receiver::~Receiver() = default;
void IncidentReportingService::Receiver::AddIncidentForProfile(
Profile* profile,
std::unique_ptr<Incident> incident) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
DCHECK(profile);
AddIncidentOnMainThread(service_, profile, std::move(incident));
}
void IncidentReportingService::Receiver::AddIncidentForProcess(
std::unique_ptr<Incident> incident) {
if (thread_runner_->BelongsToCurrentThread()) {
AddIncidentOnMainThread(service_, nullptr, std::move(incident));
} else {
thread_runner_->PostTask(
FROM_HERE,
base::BindOnce(
&IncidentReportingService::Receiver::AddIncidentOnMainThread,
service_, nullptr, std::move(incident)));
}
}
void IncidentReportingService::Receiver::ClearIncidentForProcess(
std::unique_ptr<Incident> incident) {
if (thread_runner_->BelongsToCurrentThread()) {
ClearIncidentOnMainThread(service_, nullptr, std::move(incident));
} else {
thread_runner_->PostTask(
FROM_HERE,
base::BindOnce(
&IncidentReportingService::Receiver::ClearIncidentOnMainThread,
service_, nullptr, std::move(incident)));
}
}
bool IncidentReportingService::HasIncidentsToUpload() const {
for (const auto& profile_and_context : profiles_) {
if (!profile_and_context.second->incidents.empty())
return true;
}
return false;
}
// static
void IncidentReportingService::Receiver::AddIncidentOnMainThread(
const base::WeakPtr<IncidentReportingService>& service,
Profile* profile,
std::unique_ptr<Incident> incident) {
if (service)
service->AddIncident(profile, std::move(incident));
else
LogIncidentDataType(DISCARDED, *incident);
}
// static
void IncidentReportingService::Receiver::ClearIncidentOnMainThread(
const base::WeakPtr<IncidentReportingService>& service,
Profile* profile,
std::unique_ptr<Incident> incident) {
if (service)
service->ClearIncident(profile, std::move(incident));
}
IncidentReportingService::ProfileContext::ProfileContext() : added(false) {
}
IncidentReportingService::ProfileContext::~ProfileContext() {
for (const auto& incident : incidents) {
if (incident)
LogIncidentDataType(DISCARDED, *incident);
}
}
bool IncidentReportingService::ProfileContext::HasIncidents() const {
return !incidents.empty() || !incidents_to_clear.empty();
}
IncidentReportingService::UploadContext::UploadContext(
std::unique_ptr<ClientIncidentReport> report)
: report(std::move(report)) {}
IncidentReportingService::UploadContext::~UploadContext() = default;
// static
bool IncidentReportingService::IsEnabledForProfile(Profile* profile) {
if (profile->IsOffTheRecord())
return false;
if (!IsSafeBrowsingEnabled(*profile->GetPrefs()))
return false;
return IsExtendedReportingEnabled(*profile->GetPrefs());
}
IncidentReportingService::IncidentReportingService(
SafeBrowsingServiceImpl* safe_browsing_service)
: IncidentReportingService(safe_browsing_service,
base::Milliseconds(kDefaultCallbackIntervalMs),
GetBackgroundTaskRunner()) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
DownloadProtectionService* download_protection_service =
(safe_browsing_service
? safe_browsing_service->download_protection_service()
: nullptr);
if (download_protection_service) {
client_download_request_subscription_ =
download_protection_service->RegisterClientDownloadRequestCallback(
base::BindRepeating(
&IncidentReportingService::OnClientDownloadRequest,
base::Unretained(this)));
}
}
IncidentReportingService::~IncidentReportingService() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
CancelIncidentCollection();
// Cancel all internal asynchronous tasks.
weak_ptr_factory_.InvalidateWeakPtrs();
CancelEnvironmentCollection();
CancelDownloadCollection();
CancelAllReportUploads();
if (g_browser_process->profile_manager())
g_browser_process->profile_manager()->RemoveObserver(this);
for (const auto& profile_and_context : profiles_) {
Profile* profile = profile_and_context.first;
if (profile)
profile->RemoveObserver(this);
}
}
std::unique_ptr<IncidentReceiver>
IncidentReportingService::GetIncidentReceiver() {
return std::make_unique<Receiver>(receiver_weak_ptr_factory_.GetWeakPtr());
}
std::unique_ptr<prefs::mojom::TrackedPreferenceValidationDelegate>
IncidentReportingService::CreatePreferenceValidationDelegate(Profile* profile) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
if (profile->IsOffTheRecord())
return nullptr;
return std::make_unique<PreferenceValidationDelegate>(profile,
GetIncidentReceiver());
}
void IncidentReportingService::RegisterDelayedAnalysisCallback(
DelayedAnalysisCallback callback) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
// |callback| will be run on the blocking pool. The receiver will bounce back
// to the origin thread if needed.
delayed_analysis_callbacks_.RegisterCallback(
base::BindOnce(std::move(callback), GetIncidentReceiver()));
// Start running the callbacks if any profiles are participating in safe
// browsing extended reporting. If none are now, running will commence if/when
// such a profile is added.
if (FindEligibleProfile())
delayed_analysis_callbacks_.Start();
}
void IncidentReportingService::AddDownloadManager(
content::DownloadManager* download_manager) {
download_metadata_manager_.AddDownloadManager(download_manager);
}
IncidentReportingService::IncidentReportingService(
SafeBrowsingServiceImpl* safe_browsing_service,
base::TimeDelta delayed_task_interval,
const scoped_refptr<base::TaskRunner>& delayed_task_runner)
: url_loader_factory_(nullptr),
collect_environment_data_fn_(&CollectEnvironmentData),
environment_collection_task_runner_(GetBackgroundTaskRunner()),
collation_timer_(FROM_HERE,
base::Milliseconds(kDefaultUploadDelayMs),
this,
&IncidentReportingService::OnCollationTimeout),
delayed_analysis_callbacks_(delayed_task_interval, delayed_task_runner) {
url_loader_factory_ = g_browser_process->shared_url_loader_factory();
if (g_browser_process->profile_manager())
g_browser_process->profile_manager()->AddObserver(this);
}
void IncidentReportingService::SetCollectEnvironmentHook(
CollectEnvironmentDataFn collect_environment_data_hook,
const scoped_refptr<base::TaskRunner>& task_runner) {
if (collect_environment_data_hook) {
collect_environment_data_fn_ = collect_environment_data_hook;
environment_collection_task_runner_ = task_runner;
} else {
collect_environment_data_fn_ = &CollectEnvironmentData;
environment_collection_task_runner_ = GetBackgroundTaskRunner();
}
}
void IncidentReportingService::DoExtensionCollection(
ClientIncidentReport_ExtensionData* extension_data) {
CollectExtensionData(extension_data);
}
void IncidentReportingService::OnProfileAdded(Profile* profile) {
// Handle the addition of a new profile to the ProfileManager. Create a new
// context for |profile| if one does not exist, drop any received incidents
// for the profile if the profile is not participating in safe browsing
// extended reporting, and initiate a new search for the most recent download
// if a report is being assembled and the most recent has not been found.
// Note that |profile| is assumed to outlive |this|.
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
// Track the addition of all profiles even when no report is being assembled
// so that the service can determine whether or not it can evaluate a
// profile's preferences at the time of incident addition.
ProfileContext* context = GetOrCreateProfileContext(profile);
DCHECK(!context->added);
context->added = true;
context->state_store = std::make_unique<StateStore>(profile);
bool enabled_for_profile = IsEnabledForProfile(profile);
// Drop all incidents associated with this profile that were received prior to
// its addition if incident reporting is not enabled for it.
if (!context->incidents.empty() && !enabled_for_profile) {
for (const auto& incident : context->incidents)
LogIncidentDataType(DROPPED, *incident);
context->incidents.clear();
}
if (enabled_for_profile) {
// Start processing delayed analysis callbacks if incident reporting is
// enabled for this new profile. Start is idempotent, so this is safe even
// if they're already running.
delayed_analysis_callbacks_.Start();
// Start a new report if there are process-wide incidents, or incidents for
// this profile.
if ((GetProfileContext(nullptr) &&
GetProfileContext(nullptr)->HasIncidents()) ||
context->HasIncidents()) {
BeginReportProcessing();
}
}
// TODO(grt): register for pref change notifications to start delayed analysis
// and/or report processing if sb is currently disabled but subsequently
// enabled.
// Nothing else to do if a report is not being assembled.
if (!report_)
return;
// Environment collection is deferred until at least one profile for which the
// service is enabled is added. Re-initiate collection now in case this is the
// first such profile.
BeginEnvironmentCollection();
// Take another stab at finding the most recent download if a report is being
// assembled and one hasn't been found yet (the LastDownloadFinder operates
// only on profiles that have been added to the ProfileManager).
BeginDownloadCollection();
}
void IncidentReportingService::OnProfileWillBeDestroyed(Profile* profile) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
profile->RemoveObserver(this);
auto it = profiles_.find(profile);
CHECK(it != profiles_.end());
// Take ownership of the context.
std::unique_ptr<ProfileContext> context = std::move(it->second);
// TODO(grt): Persist incidents for upload on future profile load.
// Remove the association with this profile context from all pending uploads.
for (const auto& upload : uploads_)
upload->profiles_to_state.erase(context.get());
// Forget about this profile. Incidents not yet sent for upload are lost.
// No new incidents will be accepted for it.
profiles_.erase(it);
}
std::unique_ptr<LastDownloadFinder>
IncidentReportingService::CreateDownloadFinder(
LastDownloadFinder::LastDownloadCallback callback) {
return LastDownloadFinder::Create(
base::BindRepeating(&DownloadMetadataManager::GetDownloadDetails,
base::Unretained(&download_metadata_manager_)),
std::move(callback));
}
std::unique_ptr<IncidentReportUploader>
IncidentReportingService::StartReportUpload(
IncidentReportUploader::OnResultCallback callback,
const ClientIncidentReport& report) {
return IncidentReportUploaderImpl::UploadReport(std::move(callback),
url_loader_factory_, report);
}
bool IncidentReportingService::IsProcessingReport() const {
return report_ != nullptr;
}
IncidentReportingService::ProfileContext*
IncidentReportingService::GetOrCreateProfileContext(Profile* profile) {
std::unique_ptr<ProfileContext>& context = profiles_[profile];
if (!context) {
context = std::make_unique<ProfileContext>();
if (profile)
profile->AddObserver(this);
}
return context.get();
}
IncidentReportingService::ProfileContext*
IncidentReportingService::GetProfileContext(Profile* profile) {
auto it = profiles_.find(profile);
return it != profiles_.end() ? it->second.get() : nullptr;
}
Profile* IncidentReportingService::FindEligibleProfile() const {
for (const auto& scan : profiles_) {
// Skip over profiles that have yet to be added to the profile manager.
// This will also skip over the NULL-profile context used to hold
// process-wide incidents.
if (!scan.second->added)
continue;
if (IsEnabledForProfile(scan.first))
return scan.first;
}
return nullptr;
}
void IncidentReportingService::AddIncident(Profile* profile,
std::unique_ptr<Incident> incident) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
// Ignore incidents from off-the-record profiles.
if (profile && profile->IsOffTheRecord())
return;
ProfileContext* context = GetOrCreateProfileContext(profile);
// If this is a process-wide incident, the context must not indicate that the
// profile (which is NULL) has been added to the profile manager.
DCHECK(profile || !context->added);
LogIncidentDataType(RECEIVED, *incident);
// Drop the incident immediately if the profile has already been added to the
// manager and does not have incident reporting enabled. Preference evaluation
// is deferred until OnProfileAdded() otherwise.
if (context->added && !IsEnabledForProfile(profile)) {
LogIncidentDataType(DROPPED, *incident);
return;
}
// Take ownership of the incident.
context->incidents.push_back(std::move(incident));
// Remember when the first incident for this report arrived.
if (first_incident_time_.is_null())
first_incident_time_ = base::Time::Now();
// Start assembling a new report if this is the first incident ever or the
// first since the last upload.
BeginReportProcessing();
}
void IncidentReportingService::ClearIncident(
Profile* profile,
std::unique_ptr<Incident> incident) {
ProfileContext* context = GetOrCreateProfileContext(profile);
context->incidents_to_clear.push_back(std::move(incident));
// Begin processing to handle cleared incidents following collation.
BeginReportProcessing();
}
void IncidentReportingService::BeginReportProcessing() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
// Creates a new report if needed.
if (!report_)
report_ = std::make_unique<ClientIncidentReport>();
// Ensure that collection tasks are running (calls are idempotent).
BeginIncidentCollation();
BeginEnvironmentCollection();
BeginDownloadCollection();
}
void IncidentReportingService::BeginIncidentCollation() {
// Restart the delay timer to send the report upon expiration.
collation_timeout_pending_ = true;
collation_timer_.Reset();
}
bool IncidentReportingService::WaitingToCollateIncidents() {
return collation_timeout_pending_;
}
void IncidentReportingService::CancelIncidentCollection() {
collation_timeout_pending_ = false;
report_.reset();
}
void IncidentReportingService::OnCollationTimeout() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
// Exit early if collection was cancelled.
if (!collation_timeout_pending_)
return;
// Wait another round if profile-bound incidents have come in from a profile
// that has yet to complete creation.
for (const auto& scan : profiles_) {
if (scan.first && !scan.second->added && scan.second->HasIncidents()) {
collation_timer_.Reset();
return;
}
}
collation_timeout_pending_ = false;
ProcessIncidentsIfCollectionComplete();
}
void IncidentReportingService::BeginEnvironmentCollection() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
DCHECK(report_);
// Nothing to do if environment collection is pending or has already
// completed, if there are no incidents to process, or if there is no eligible
// profile.
if (environment_collection_pending_ || report_->has_environment() ||
!HasIncidentsToUpload() || !FindEligibleProfile()) {
return;
}
ClientIncidentReport_EnvironmentData* environment_data =
new ClientIncidentReport_EnvironmentData();
environment_collection_pending_ =
environment_collection_task_runner_->PostTaskAndReply(
FROM_HERE,
base::BindOnce(collect_environment_data_fn_, environment_data),
base::BindOnce(&IncidentReportingService::OnEnvironmentDataCollected,
weak_ptr_factory_.GetWeakPtr(),
base::WrapUnique(environment_data)));
// Posting the task will fail if the runner has been shut down. This should
// never happen since the blocking pool is shut down after this service.
DCHECK(environment_collection_pending_);
}
bool IncidentReportingService::WaitingForEnvironmentCollection() {
return environment_collection_pending_;
}
void IncidentReportingService::CancelEnvironmentCollection() {
environment_collection_pending_ = false;
if (report_)
report_->clear_environment();
}
void IncidentReportingService::OnEnvironmentDataCollected(
std::unique_ptr<ClientIncidentReport_EnvironmentData> environment_data) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
DCHECK(environment_collection_pending_);
DCHECK(report_ && !report_->has_environment());
environment_collection_pending_ = false;
// Process::Current().CreationTime() is missing on some platforms.
#if BUILDFLAG(IS_MAC) || BUILDFLAG(IS_WIN) || BUILDFLAG(IS_LINUX) || \
BUILDFLAG(IS_CHROMEOS)
base::TimeDelta uptime =
first_incident_time_ - base::Process::Current().CreationTime();
environment_data->mutable_process()->set_uptime_msec(uptime.InMilliseconds());
#endif
report_->set_allocated_environment(environment_data.release());
ProcessIncidentsIfCollectionComplete();
}
void IncidentReportingService::BeginDownloadCollection() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
DCHECK(report_);
// Nothing to do if a search for the most recent download is already pending,
// if one has already been found, or if there are no incidents to process.
if (last_download_finder_ || report_->has_download() ||
!HasIncidentsToUpload()) {
return;
}
// No instance is returned if there are no eligible loaded profiles. Another
// search will be attempted in OnProfileAdded() if another profile appears on
// the scene.
last_download_finder_ = CreateDownloadFinder(
base::BindOnce(&IncidentReportingService::OnLastDownloadFound,
weak_ptr_factory_.GetWeakPtr()));
}
bool IncidentReportingService::WaitingForMostRecentDownload() {
DCHECK(report_); // Only call this when a report is being assembled.
// The easy case: not waiting if a download has already been found.
if (report_->has_download())
return false;
// The next easy case: waiting if the finder is operating.
if (last_download_finder_)
return true;
// Harder case 1: not waiting if there are no incidents to upload (only
// incidents to clear).
if (!HasIncidentsToUpload())
return false;
// Harder case 2: waiting if a non-NULL profile has not yet been added.
for (const auto& scan : profiles_) {
if (scan.first && !scan.second->added)
return true;
}
// There is no most recent download and there's nothing more to wait for.
return false;
}
void IncidentReportingService::CancelDownloadCollection() {
last_download_finder_.reset();
if (report_)
report_->clear_download();
}
void IncidentReportingService::OnLastDownloadFound(
std::unique_ptr<ClientIncidentReport_DownloadDetails> last_binary_download,
std::unique_ptr<ClientIncidentReport_NonBinaryDownloadDetails>
last_non_binary_download) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
DCHECK(report_);
// Harvest the finder.
last_download_finder_.reset();
if (last_binary_download)
report_->set_allocated_download(last_binary_download.release());
if (last_non_binary_download) {
report_->set_allocated_non_binary_download(
last_non_binary_download.release());
}
ProcessIncidentsIfCollectionComplete();
}
void IncidentReportingService::ProcessIncidentsIfCollectionComplete() {
DCHECK(report_);
// Bail out if there are still outstanding collection tasks. Completion of any
// of these will start another upload attempt.
if (WaitingForEnvironmentCollection() || WaitingToCollateIncidents() ||
WaitingForMostRecentDownload()) {
return;
}
// Take ownership of the report and clear things for future reports.
std::unique_ptr<ClientIncidentReport> report(std::move(report_));
first_incident_time_ = base::Time();
ClientIncidentReport_EnvironmentData_Process* process =
report->mutable_environment()->mutable_process();
process->set_metrics_consent(
ChromeMetricsServiceAccessor::IsMetricsAndCrashReportingEnabled());
// Associate process-wide incidents with any eligible profile. If there is no
// eligible profile, drop the incidents.
ProfileContext* null_context = GetProfileContext(nullptr);
if (null_context && null_context->HasIncidents()) {
Profile* eligible_profile = FindEligibleProfile();
if (eligible_profile) {
ProfileContext* eligible_context = GetProfileContext(eligible_profile);
// Move the incidents to the target context.
for (auto& incident : null_context->incidents) {
eligible_context->incidents.push_back(std::move(incident));
}
null_context->incidents.clear();
for (auto& incident : null_context->incidents_to_clear)
eligible_context->incidents_to_clear.push_back(std::move(incident));
null_context->incidents_to_clear.clear();
} else {
for (const auto& incident : null_context->incidents)
LogIncidentDataType(DROPPED, *incident);
null_context->incidents.clear();
}
}
// Clear incidents data where needed.
for (auto& profile_and_context : profiles_) {
// Bypass process-wide incidents that have not yet been associated with a
// profile and profiles with no incidents to clear.
if (!profile_and_context.first ||
profile_and_context.second->incidents_to_clear.empty()) {
continue;
}
ProfileContext* context = profile_and_context.second.get();
StateStore::Transaction transaction(context->state_store.get());
for (const auto& incident : context->incidents_to_clear)
transaction.Clear(incident->GetType(), incident->GetKey());
context->incidents_to_clear.clear();
}
// Abandon report if there are no incidents to upload.
if (!HasIncidentsToUpload())
return;
bool has_download =
report->has_download() || report->has_non_binary_download();
// Collect incidents across all profiles participating in safe browsing
// extended reporting.
// Associate the profile contexts and their incident data with the upload.
UploadContext::PersistentIncidentStateCollection profiles_to_state;
for (auto& profile_and_context : profiles_) {
// Bypass process-wide incidents that have not yet been associated with a
// profile.
if (!profile_and_context.first)
continue;
ProfileContext* context = profile_and_context.second.get();
if (context->incidents.empty())
continue;
// Drop all incidents collected for the profile if it stopped participating
// before collection completed.
if (!IsEnabledForProfile(profile_and_context.first)) {
for (const auto& incident : context->incidents)
LogIncidentDataType(DROPPED, *incident);
context->incidents.clear();
continue;
}
StateStore::Transaction transaction(context->state_store.get());
std::vector<PersistentIncidentState> states;
// Prep persistent data and prune any incidents already sent.
for (const auto& incident : context->incidents) {
const PersistentIncidentState state = ComputeIncidentState(*incident);
if (context->state_store->HasBeenReported(state.type, state.key,
state.digest)) {
LogIncidentDataType(PRUNED, *incident);
} else if (!has_download) {
LogIncidentDataType(NO_DOWNLOAD, *incident);
// Drop the incident and mark for future pruning since no executable
// download was found.
transaction.MarkAsReported(state.type, state.key, state.digest);
} else {
LogIncidentDataType(ACCEPTED, *incident);
// Ownership of the payload is passed to the report.
ClientIncidentReport_IncidentData* data =
incident->TakePayload().release();
DCHECK(data->has_incident_time_msec());
report->mutable_incident()->AddAllocated(data);
data = nullptr;
states.push_back(state);
}
}
context->incidents.clear();
profiles_to_state[context].swap(states);
}
const int count = report->incident_size();
// Abandon the request if all incidents were pruned or otherwise dropped.
if (!count) {
if (!has_download) {
UMA_HISTOGRAM_ENUMERATION("SBIRS.UploadResult",
IncidentReportUploader::UPLOAD_NO_DOWNLOAD,
IncidentReportUploader::NUM_UPLOAD_RESULTS);
}
return;
}
// Perform final synchronous collection tasks for the report.
DoExtensionCollection(report->mutable_extension_data());
std::unique_ptr<UploadContext> context(new UploadContext(std::move(report)));
context->profiles_to_state.swap(profiles_to_state);
UploadContext* temp_context = context.get();
uploads_.push_back(std::move(context));
IncidentReportingService::UploadReportIfUploadingEnabled(temp_context);
}
void IncidentReportingService::CancelAllReportUploads() {
for (size_t i = 0; i < uploads_.size(); ++i) {
UMA_HISTOGRAM_ENUMERATION("SBIRS.UploadResult",
IncidentReportUploader::UPLOAD_CANCELLED,
IncidentReportUploader::NUM_UPLOAD_RESULTS);
}
uploads_.clear();
}
void IncidentReportingService::UploadReportIfUploadingEnabled(
UploadContext* context) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
if (!base::FeatureList::IsEnabled(kIncidentReportingEnableUpload)) {
OnReportUploadResult(context, IncidentReportUploader::UPLOAD_SUPPRESSED,
std::unique_ptr<ClientIncidentResponse>());
return;
}
// Initiate the upload.
context->uploader = StartReportUpload(
base::BindOnce(&IncidentReportingService::OnReportUploadResult,
weak_ptr_factory_.GetWeakPtr(), context),
*context->report);
if (!context->uploader) {
OnReportUploadResult(context,
IncidentReportUploader::UPLOAD_INVALID_REQUEST,
std::unique_ptr<ClientIncidentResponse>());
}
}
void IncidentReportingService::HandleResponse(const UploadContext& context) {
// Mark each incident as reported in its corresponding profile's state store.
for (const auto& context_and_states : context.profiles_to_state) {
StateStore::Transaction transaction(
context_and_states.first->state_store.get());
for (const auto& state : context_and_states.second)
transaction.MarkAsReported(state.type, state.key, state.digest);
}
}
void IncidentReportingService::OnReportUploadResult(
UploadContext* context,
IncidentReportUploader::Result result,
std::unique_ptr<ClientIncidentResponse> response) {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
UMA_HISTOGRAM_ENUMERATION(
"SBIRS.UploadResult", result, IncidentReportUploader::NUM_UPLOAD_RESULTS);
// The upload is no longer outstanding, so take ownership of the context (from
// the collection of outstanding uploads) in this scope.
auto it = std::ranges::find(uploads_, context,
&std::unique_ptr<UploadContext>::get);
CHECK(it != uploads_.end());
std::unique_ptr<UploadContext> upload(std::move(*it));
uploads_.erase(it);
if (result == IncidentReportUploader::UPLOAD_SUCCESS)
HandleResponse(*upload);
// else retry?
}
void IncidentReportingService::OnClientDownloadRequest(
download::DownloadItem* download,
const ClientDownloadRequest* request) {
if (content::DownloadItemUtils::GetBrowserContext(download) &&
!content::DownloadItemUtils::GetBrowserContext(download)
->IsOffTheRecord()) {
download_metadata_manager_.SetRequest(download, request);
}
}
} // namespace safe_browsing
|