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
|
// 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/safe_browsing/content/browser/client_side_phishing_model.h"
#include <stdint.h>
#include <memory>
#include <optional>
#include "base/command_line.h"
#include "base/feature_list.h"
#include "base/files/file.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/memory/read_only_shared_memory_region.h"
#include "base/memory/shared_memory_mapping.h"
#include "base/memory/singleton.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/task/thread_pool.h"
#include "build/build_config.h"
#include "components/optimization_guide/core/delivery/optimization_guide_model_provider.h"
#include "components/optimization_guide/core/optimization_guide_util.h"
#include "components/optimization_guide/proto/client_side_phishing_model_metadata.pb.h"
#include "components/optimization_guide/proto/models.pb.h"
#include "components/safe_browsing/core/common/fbs/client_model_generated.h"
#include "components/safe_browsing/core/common/features.h"
#include "components/safe_browsing/core/common/proto/client_model.pb.h"
#include "components/safe_browsing/core/common/safebrowsing_switches.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
namespace safe_browsing {
namespace {
void ReturnModelOverrideFailure(
base::OnceCallback<void(std::pair<std::string, base::File>)> callback) {
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(std::move(callback),
std::make_pair(std::string(), base::File())));
}
void ReadOverridenModel(
base::FilePath path,
base::OnceCallback<void(std::pair<std::string, base::File>)> callback) {
if (path.empty()) {
VLOG(2) << "Failed to override model. Path is empty. Path is " << path;
ReturnModelOverrideFailure(std::move(callback));
return;
}
std::string contents;
if (!base::ReadFileToString(path.AppendASCII("client_model.pb"), &contents)) {
VLOG(2) << "Failed to override model. Could not read model data.";
ReturnModelOverrideFailure(std::move(callback));
return;
}
base::File tflite_model(path.AppendASCII("visual_model.tflite"),
base::File::FLAG_OPEN | base::File::FLAG_READ);
// `tflite_model` is allowed to be invalid, when testing a DOM-only model.
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE,
base::BindOnce(std::move(callback),
std::make_pair(contents, std::move(tflite_model))));
}
base::File LoadImageEmbeddingModelFile(const base::FilePath& model_file_path) {
if (!base::PathExists(model_file_path)) {
VLOG(0)
<< "Model path does not exist. Returning empty file. Given path is: "
<< model_file_path;
return base::File();
}
base::File image_embedding_model_file(
model_file_path, base::File::FLAG_OPEN | base::File::FLAG_READ);
if (!image_embedding_model_file.IsValid()) {
VLOG(2)
<< "Failed to receive image embedding model file. File is not valid";
return base::File();
}
return image_embedding_model_file;
}
// Load the model file at the provided file path.
std::pair<std::string, base::File> LoadModelAndVisualTfLiteFile(
const base::FilePath& model_file_path,
base::flat_set<base::FilePath> additional_files) {
if (!base::PathExists(model_file_path)) {
VLOG(0) << "Model path does not exist. Returning empty pair. Given path is "
<< model_file_path;
return std::pair<std::string, base::File>();
}
// The only additional file we require and expect is the visual tf lite file
if (additional_files.size() != 1) {
VLOG(2) << "Did not receive just one additional file when expected. "
"Actual size: "
<< additional_files.size();
return std::pair<std::string, base::File>();
}
std::optional<base::FilePath> visual_tflite_path = std::nullopt;
for (const base::FilePath& path : additional_files) {
// There should only be one loop after above check
DCHECK(path.IsAbsolute());
visual_tflite_path = path;
}
base::File model(model_file_path,
base::File::FLAG_OPEN | base::File::FLAG_READ);
base::File tf_lite(*visual_tflite_path,
base::File::FLAG_OPEN | base::File::FLAG_READ);
if (!model.IsValid() || !tf_lite.IsValid()) {
VLOG(2) << "Failed to override the model and/or tf_lite file.";
}
// Convert model to string
std::string model_data;
if (!base::ReadFileToString(model_file_path, &model_data)) {
VLOG(2) << "Failed to override model. Could not read model data.";
return std::pair<std::string, base::File>();
}
return std::make_pair(std::string(model_data.begin(), model_data.end()),
std::move(tf_lite));
}
// Close the provided model file.
void CloseModelFile(base::File model_file) {
if (!model_file.IsValid()) {
return;
}
model_file.Close();
}
void RecordImageEmbeddingModelUpdateSuccess(bool success) {
base::UmaHistogramBoolean(
"SBClientPhishing.ModelDynamicUpdateSuccess.ImageEmbedding", success);
}
} // namespace
// --- ClientSidePhishingModel methods ---
ClientSidePhishingModel::ClientSidePhishingModel(
optimization_guide::OptimizationGuideModelProvider* opt_guide)
: opt_guide_(opt_guide),
background_task_runner_(base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(), base::TaskPriority::BEST_EFFORT})),
beginning_time_(base::TimeTicks::Now()) {
opt_guide_->AddObserverForOptimizationTargetModel(
optimization_guide::proto::OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING,
/*model_metadata=*/std::nullopt, this);
}
void ClientSidePhishingModel::OnModelUpdated(
optimization_guide::proto::OptimizationTarget optimization_target,
base::optional_ref<const optimization_guide::ModelInfo> model_info) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (optimization_target !=
optimization_guide::proto::OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING &&
optimization_target !=
optimization_guide::proto::
OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING_IMAGE_EMBEDDER) {
return;
}
if (optimization_target ==
optimization_guide::proto::OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING) {
// If the model_info has no value, that means the OptimizationGuide server
// has sent an intentionally null model value to indicate that there is a
// bad model on disk and it should be removed. Therefore, we will clear the
// current model in the class.
if (!model_info.has_value()) {
trigger_model_opt_guide_metadata_image_embedding_version_.reset();
mapped_region_ = base::MappedReadOnlyRegion();
if (visual_tflite_model_) {
background_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&CloseModelFile, std::move(*visual_tflite_model_)));
}
// Run callback to remove models from the renderer process. When a
// callback is called and there are no models in this class while the
// model type is set, it's expected that it's asked to remove the models.
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE,
base::BindOnce(&ClientSidePhishingModel::NotifyCallbacksOnUI,
weak_ptr_factory_.GetWeakPtr()));
return;
}
background_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&LoadModelAndVisualTfLiteFile,
model_info->GetModelFilePath(),
model_info->GetAdditionalFiles()),
base::BindOnce(
&ClientSidePhishingModel::OnModelAndVisualTfLiteFileLoaded,
weak_ptr_factory_.GetWeakPtr(), model_info->GetModelMetadata()));
} else if (optimization_target ==
optimization_guide::proto::
OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING_IMAGE_EMBEDDER) {
// If the model_info has no value for this target, we only remove the image
// embedding model, and if the trigger models are still valid, then the
// scorer will be created with the trigger models only.
if (!model_info.has_value()) {
embedding_model_opt_guide_metadata_image_embedding_version_.reset();
if (image_embedding_model_) {
background_task_runner_->PostTask(
FROM_HERE, base::BindOnce(&CloseModelFile,
std::move(*image_embedding_model_)));
}
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE,
base::BindOnce(&ClientSidePhishingModel::NotifyCallbacksOnUI,
weak_ptr_factory_.GetWeakPtr()));
return;
}
background_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&LoadImageEmbeddingModelFile,
model_info->GetModelFilePath()),
base::BindOnce(&ClientSidePhishingModel::OnImageEmbeddingModelLoaded,
weak_ptr_factory_.GetWeakPtr(),
model_info->GetModelMetadata()));
}
}
void ClientSidePhishingModel::SubscribeToImageEmbedderOptimizationGuide() {
if (!subscribed_to_image_embedder_ && opt_guide_) {
subscribed_to_image_embedder_ = true;
opt_guide_->AddObserverForOptimizationTargetModel(
optimization_guide::proto::
OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING_IMAGE_EMBEDDER,
/*model_metadata=*/std::nullopt, this);
}
}
void ClientSidePhishingModel::UnsubscribeToImageEmbedderOptimizationGuide() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (subscribed_to_image_embedder_ && opt_guide_) {
subscribed_to_image_embedder_ = false;
opt_guide_->RemoveObserverForOptimizationTargetModel(
optimization_guide::proto::
OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING_IMAGE_EMBEDDER,
this);
embedding_model_opt_guide_metadata_image_embedding_version_.reset();
if (image_embedding_model_) {
background_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&CloseModelFile, std::move(*image_embedding_model_)));
// We will only notify if there was an image embedding model available, so
// the renderer can remove it.
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE,
base::BindOnce(&ClientSidePhishingModel::NotifyCallbacksOnUI,
weak_ptr_factory_.GetWeakPtr()));
}
}
}
bool ClientSidePhishingModel::IsSubscribedToImageEmbeddingModelUpdates() {
return subscribed_to_image_embedder_;
}
void ClientSidePhishingModel::OnModelAndVisualTfLiteFileLoaded(
std::optional<optimization_guide::proto::Any> model_metadata,
std::pair<std::string, base::File> model_and_tflite) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (visual_tflite_model_) {
// If the visual tf lite file is already loaded, it should be closed on a
// background thread.
background_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&CloseModelFile, std::move(*visual_tflite_model_)));
}
std::string model_str = std::move(model_and_tflite.first);
base::File visual_tflite_model = std::move(model_and_tflite.second);
bool model_valid = false;
bool tflite_valid = visual_tflite_model.IsValid();
if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
switches::kOverrideCsdModelFlag) &&
!model_str.empty()) {
model_type_ = CSDModelType::kNone;
flatbuffers::Verifier verifier(
reinterpret_cast<const uint8_t*>(model_str.data()), model_str.length());
model_valid = flat::VerifyClientSideModelBuffer(verifier);
if (model_valid) {
mapped_region_ =
base::ReadOnlySharedMemoryRegion::Create(model_str.length());
if (mapped_region_.IsValid()) {
model_type_ = CSDModelType::kFlatbuffer;
mapped_region_.mapping.GetMemoryAsSpan<char>().copy_prefix_from(
model_str);
const flat::ClientSideModel* flatbuffer_model =
flat::GetClientSideModel(mapped_region_.mapping.memory());
if (!VerifyCSDFlatBufferIndicesAndFields(flatbuffer_model)) {
VLOG(0) << "Failed to verify CSD Flatbuffer indices and fields";
} else {
trigger_model_version_ = flatbuffer_model->version();
if (tflite_valid) {
thresholds_.clear(); // Clear the previous model's thresholds
// before adding on the new ones
for (const flat::TfLiteModelMetadata_::Threshold* flat_threshold :
*(flatbuffer_model->tflite_metadata()->thresholds())) {
TfLiteModelMetadata::Threshold threshold;
threshold.set_label(flat_threshold->label()->str());
threshold.set_threshold(flat_threshold->threshold());
threshold.set_esb_threshold(flat_threshold->esb_threshold() > 0
? flat_threshold->esb_threshold()
: flat_threshold->threshold());
thresholds_[flat_threshold->label()->str()] = threshold;
}
}
}
} else {
model_valid = false;
}
base::UmaHistogramBoolean("SBClientPhishing.FlatBufferMappedRegionValid",
mapped_region_.IsValid());
} else {
VLOG(2) << "Failed to validate flatbuffer model";
}
}
base::UmaHistogramBoolean("SBClientPhishing.ModelDynamicUpdateSuccess",
model_valid);
if (tflite_valid) {
visual_tflite_model_ = std::move(visual_tflite_model);
}
if (model_valid && tflite_valid) {
base::UmaHistogramMediumTimes(
"SBClientPhishing.OptimizationGuide.ModelFetchTime",
base::TimeTicks::Now() - beginning_time_);
std::optional<optimization_guide::proto::ClientSidePhishingModelMetadata>
client_side_phishing_model_metadata = std::nullopt;
if (model_metadata.has_value()) {
client_side_phishing_model_metadata =
optimization_guide::ParsedAnyMetadata<
optimization_guide::proto::ClientSidePhishingModelMetadata>(
model_metadata.value());
}
if (client_side_phishing_model_metadata.has_value()) {
trigger_model_opt_guide_metadata_image_embedding_version_ =
client_side_phishing_model_metadata->image_embedding_model_version();
} else {
VLOG(1) << "Client side phishing model metadata is missing an image "
"embedding model version value";
}
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(&ClientSidePhishingModel::NotifyCallbacksOnUI,
weak_ptr_factory_.GetWeakPtr()));
}
}
void ClientSidePhishingModel::OnImageEmbeddingModelLoaded(
std::optional<optimization_guide::proto::Any> model_metadata,
base::File image_embedding_model) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
bool image_embedding_model_valid = image_embedding_model.IsValid();
RecordImageEmbeddingModelUpdateSuccess(image_embedding_model_valid);
// Any failure to loading the image embedding model will send an empty file.
if (!image_embedding_model_valid) {
return;
}
if (image_embedding_model_) {
// If the image embedding model file is already loaded, it should be closed
// on a background thread.
background_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&CloseModelFile, std::move(*image_embedding_model_)));
}
image_embedding_model_ = std::move(image_embedding_model);
std::optional<optimization_guide::proto::ClientSidePhishingModelMetadata>
image_embedding_model_metadata = std::nullopt;
if (model_metadata.has_value()) {
image_embedding_model_metadata = optimization_guide::ParsedAnyMetadata<
optimization_guide::proto::ClientSidePhishingModelMetadata>(
model_metadata.value());
}
if (image_embedding_model_metadata.has_value()) {
embedding_model_opt_guide_metadata_image_embedding_version_ =
image_embedding_model_metadata->image_embedding_model_version();
} else {
VLOG(1) << "Image embedding model metadata is missing a version value";
}
// There is no use of the image embedding model if the visual trigger model is
// not present, so we will only send to the renderer when that is the case.
if (visual_tflite_model_ && image_embedding_model_) {
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(&ClientSidePhishingModel::NotifyCallbacksOnUI,
weak_ptr_factory_.GetWeakPtr()));
}
}
bool ClientSidePhishingModel::IsModelMetadataImageEmbeddingVersionMatching() {
return trigger_model_opt_guide_metadata_image_embedding_version_
.has_value() &&
embedding_model_opt_guide_metadata_image_embedding_version_
.has_value() &&
trigger_model_opt_guide_metadata_image_embedding_version_.value() ==
embedding_model_opt_guide_metadata_image_embedding_version_
.value();
}
int ClientSidePhishingModel::GetTriggerModelVersion() {
return trigger_model_version_.has_value() ? trigger_model_version_.value()
: 0;
}
ClientSidePhishingModel::~ClientSidePhishingModel() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
opt_guide_->RemoveObserverForOptimizationTargetModel(
optimization_guide::proto::OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING,
this);
if (subscribed_to_image_embedder_) {
opt_guide_->RemoveObserverForOptimizationTargetModel(
optimization_guide::proto::
OPTIMIZATION_TARGET_CLIENT_SIDE_PHISHING_IMAGE_EMBEDDER,
this);
}
if (visual_tflite_model_) {
background_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&CloseModelFile, std::move(*visual_tflite_model_)));
}
if (image_embedding_model_) {
background_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&CloseModelFile, std::move(*image_embedding_model_)));
}
opt_guide_ = nullptr;
}
base::CallbackListSubscription ClientSidePhishingModel::RegisterCallback(
base::RepeatingCallback<void()> callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return callbacks_.Add(std::move(callback));
}
bool ClientSidePhishingModel::IsEnabled() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return (model_type_ == CSDModelType::kFlatbuffer &&
mapped_region_.IsValid() && visual_tflite_model_ &&
visual_tflite_model_->IsValid());
}
// static
bool ClientSidePhishingModel::VerifyCSDFlatBufferIndicesAndFields(
const flat::ClientSideModel* model) {
const flatbuffers::Vector<flatbuffers::Offset<flat::Hash>>* hashes =
model->hashes();
if (!hashes) {
return false;
}
const flatbuffers::Vector<flatbuffers::Offset<flat::ClientSideModel_::Rule>>*
rules = model->rule();
if (!rules) {
return false;
}
for (const flat::ClientSideModel_::Rule* rule : *model->rule()) {
if (!rule || !rule->feature()) {
return false;
}
for (int32_t feature : *rule->feature()) {
if (feature < 0 || feature >= static_cast<int32_t>(hashes->size())) {
return false;
}
}
}
const flatbuffers::Vector<int32_t>* page_terms = model->page_term();
if (!page_terms) {
return false;
}
for (int32_t page_term_idx : *page_terms) {
if (page_term_idx < 0 ||
page_term_idx >= static_cast<int32_t>(hashes->size())) {
return false;
}
}
const flatbuffers::Vector<uint32_t>* page_words = model->page_word();
if (!page_words) {
return false;
}
const flat::TfLiteModelMetadata* metadata = model->tflite_metadata();
if (!metadata) {
return false;
}
const flatbuffers::Vector<
flatbuffers::Offset<flat::TfLiteModelMetadata_::Threshold>>* thresholds =
metadata->thresholds();
if (!thresholds) {
return false;
}
for (const flat::TfLiteModelMetadata_::Threshold* threshold : *thresholds) {
if (!threshold || !threshold->label()) {
return false;
}
}
return true;
}
const base::flat_map<std::string, TfLiteModelMetadata::Threshold>&
ClientSidePhishingModel::GetVisualTfLiteModelThresholds() const {
return thresholds_;
}
const base::File& ClientSidePhishingModel::GetVisualTfLiteModel() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(visual_tflite_model_ && visual_tflite_model_->IsValid());
return *visual_tflite_model_;
}
const base::File& ClientSidePhishingModel::GetImageEmbeddingModel() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(image_embedding_model_ && image_embedding_model_->IsValid());
return *image_embedding_model_;
}
bool ClientSidePhishingModel::HasImageEmbeddingModel() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return image_embedding_model_ && image_embedding_model_->IsValid();
}
CSDModelType ClientSidePhishingModel::GetModelType() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return model_type_;
}
base::ReadOnlySharedMemoryRegion
ClientSidePhishingModel::GetModelSharedMemoryRegion() const {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return mapped_region_.region.Duplicate();
}
void ClientSidePhishingModel::SetModelStringForTesting(
const std::string& model_str,
base::File visual_tflite_model) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
bool model_valid = false;
bool tflite_valid = visual_tflite_model.IsValid();
// TODO (andysjlim): Move to a helper function once protobuf feature is
// removed
if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
switches::kOverrideCsdModelFlag) &&
!model_str.empty()) {
model_type_ = CSDModelType::kNone;
flatbuffers::Verifier verifier(
reinterpret_cast<const uint8_t*>(model_str.data()), model_str.length());
model_valid = flat::VerifyClientSideModelBuffer(verifier);
if (model_valid) {
mapped_region_ =
base::ReadOnlySharedMemoryRegion::Create(model_str.length());
if (mapped_region_.IsValid()) {
model_type_ = CSDModelType::kFlatbuffer;
mapped_region_.mapping.GetMemoryAsSpan<char>().copy_prefix_from(
model_str);
} else {
model_valid = false;
}
base::UmaHistogramBoolean("SBClientPhishing.FlatBufferMappedRegionValid",
mapped_region_.IsValid());
}
base::UmaHistogramBoolean("SBClientPhishing.ModelDynamicUpdateSuccess",
model_valid);
if (tflite_valid) {
visual_tflite_model_ = std::move(visual_tflite_model);
}
}
if (model_valid || tflite_valid) {
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(&ClientSidePhishingModel::NotifyCallbacksOnUI,
base::Unretained(this)));
}
}
void ClientSidePhishingModel::NotifyCallbacksOnUI() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
callbacks_.Notify();
}
void ClientSidePhishingModel::SetVisualTfLiteModelForTesting(base::File file) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
visual_tflite_model_ = std::move(file);
}
void ClientSidePhishingModel::SetModelTypeForTesting(CSDModelType model_type) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
model_type_ = model_type;
}
void ClientSidePhishingModel::ClearMappedRegionForTesting() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
mapped_region_.mapping = base::WritableSharedMemoryMapping();
mapped_region_.region = base::ReadOnlySharedMemoryRegion();
}
void* ClientSidePhishingModel::GetFlatBufferMemoryAddressForTesting() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
return mapped_region_.mapping.memory();
}
// This function is used for testing in client_side_phishing_model_unittest
void ClientSidePhishingModel::MaybeOverrideModel() {
if (base::CommandLine::ForCurrentProcess()->HasSwitch(
switches::kOverrideCsdModelFlag)) {
base::FilePath overriden_model_directory =
base::CommandLine::ForCurrentProcess()->GetSwitchValuePath(
switches::kOverrideCsdModelFlag);
base::ThreadPool::PostTask(
FROM_HERE, {base::MayBlock()},
base::BindOnce(
&ReadOverridenModel, overriden_model_directory,
base::BindOnce(&ClientSidePhishingModel::OnGetOverridenModelData,
base::Unretained(this), CSDModelType::kFlatbuffer)));
}
}
// This function is used for testing in client_side_phishing_model_unittest
void ClientSidePhishingModel::OnGetOverridenModelData(
CSDModelType model_type,
std::pair<std::string, base::File> model_and_tflite) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
const std::string& model_data = model_and_tflite.first;
base::File tflite_model = std::move(model_and_tflite.second);
if (model_data.empty()) {
VLOG(2) << "Overriden model data is empty";
return;
}
switch (model_type) {
case CSDModelType::kFlatbuffer: {
flatbuffers::Verifier verifier(
reinterpret_cast<const uint8_t*>(model_data.data()),
model_data.length());
if (!flat::VerifyClientSideModelBuffer(verifier)) {
VLOG(2)
<< "Overriden model data is not a valid ClientSideModel flatbuffer";
return;
}
mapped_region_ =
base::ReadOnlySharedMemoryRegion::Create(model_data.length());
if (!mapped_region_.IsValid()) {
VLOG(2) << "Could not create shared memory region for flatbuffer";
return;
}
mapped_region_.mapping.GetMemoryAsSpan<char>().copy_prefix_from(
model_data);
model_type_ = model_type;
break;
}
case CSDModelType::kNone:
NOTREACHED();
}
if (tflite_model.IsValid()) {
visual_tflite_model_ = std::move(tflite_model);
}
VLOG(0) << "Model overridden successfully";
content::GetUIThreadTaskRunner({})->PostTask(
FROM_HERE, base::BindOnce(&ClientSidePhishingModel::NotifyCallbacksOnUI,
weak_ptr_factory_.GetWeakPtr()));
}
// For browser unit testing in client_side_detection_service_browsertest
void ClientSidePhishingModel::SetModelAndVisualTfLiteForTesting(
const base::FilePath& model_file_path,
const base::FilePath& visual_tf_lite_model_path) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::flat_set<base::FilePath> additional_files;
additional_files.insert(visual_tf_lite_model_path);
background_task_runner_->PostTaskAndReplyWithResult(
FROM_HERE,
base::BindOnce(&LoadModelAndVisualTfLiteFile, model_file_path,
additional_files),
base::BindOnce(&ClientSidePhishingModel::OnModelAndVisualTfLiteFileLoaded,
weak_ptr_factory_.GetWeakPtr(), std::nullopt));
}
} // namespace safe_browsing
|