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
|
// Copyright 2011 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/renderer/phishing_classifier/phishing_classifier_delegate.h"
#include <memory>
#include <set>
#include <utility>
#include "base/debug/stack_trace.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/lazy_instance.h"
#include "base/memory/weak_ptr.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/no_destructor.h"
#include "base/notreached.h"
#include "base/task/single_thread_task_runner.h"
#include "components/safe_browsing/content/common/safe_browsing.mojom-forward.h"
#include "components/safe_browsing/content/common/safe_browsing.mojom-shared.h"
#include "components/safe_browsing/content/renderer/phishing_classifier/features.h"
#include "components/safe_browsing/content/renderer/phishing_classifier/phishing_classifier.h"
#include "components/safe_browsing/content/renderer/phishing_classifier/scorer.h"
#include "components/safe_browsing/core/common/proto/csd.pb.h"
#include "content/public/renderer/render_frame.h"
#include "content/public/renderer/render_thread.h"
#include "mojo/public/cpp/base/proto_wrapper.h"
#include "mojo/public/cpp/bindings/self_owned_receiver.h"
#include "services/service_manager/public/cpp/interface_provider.h"
#include "third_party/blink/public/common/associated_interfaces/associated_interface_registry.h"
#include "third_party/blink/public/platform/web_url.h"
#include "third_party/blink/public/web/web_document.h"
#include "third_party/blink/public/web/web_local_frame.h"
#include "third_party/blink/public/web/web_view.h"
using content::RenderThread;
namespace safe_browsing {
namespace {
GURL StripRef(const GURL& url) {
GURL::Replacements replacements;
replacements.ClearRef();
return url.ReplaceComponents(replacements);
}
void LogClassificationRetryWithinTimeout(bool success) {
base::UmaHistogramBoolean(
"SBClientPhishing.Classifier.ReadyAfterRetryTimeout", success);
}
} // namespace
PhishingClassifierDelegate::PhishingClassifierDelegate(
content::RenderFrame* render_frame,
PhishingClassifier* classifier)
: content::RenderFrameObserver(render_frame),
last_main_frame_transition_(ui::PAGE_TRANSITION_LINK),
is_classifying_(false),
awaiting_retry_(false) {
if (!classifier) {
classifier = new PhishingClassifier(render_frame);
}
classifier_.reset(classifier);
render_frame->GetAssociatedInterfaceRegistry()
->AddInterface<mojom::PhishingDetector>(base::BindRepeating(
&PhishingClassifierDelegate::PhishingDetectorReceiver,
base::Unretained(this)));
model_change_observation_.Observe(ScorerStorage::GetInstance());
}
PhishingClassifierDelegate::~PhishingClassifierDelegate() {
CancelPendingClassification();
}
// static
PhishingClassifierDelegate* PhishingClassifierDelegate::Create(
content::RenderFrame* render_frame,
PhishingClassifier* classifier) {
// Private constructor and public static Create() method to facilitate
// stubbing out this class for binary-size reduction purposes.
return new PhishingClassifierDelegate(render_frame, classifier);
}
void PhishingClassifierDelegate::PhishingDetectorReceiver(
mojo::PendingAssociatedReceiver<mojom::PhishingDetector> receiver) {
phishing_detector_receiver_.reset();
phishing_detector_receiver_.Bind(std::move(receiver));
}
void PhishingClassifierDelegate::StartPhishingDetection(
const GURL& url,
StartPhishingDetectionCallback callback) {
RecordEvent(SBPhishingClassifierEvent::kPhishingDetectionRequested);
if (!callback_.is_null())
std::move(callback_).Run(mojom::PhishingDetectorResult::CANCELLED,
std::nullopt);
is_phishing_detection_running_ = true;
awaiting_retry_ = false;
last_url_received_from_browser_ = StripRef(url);
callback_ = std::move(callback);
// Start classifying the current page if all conditions are met.
// See MaybeStartClassification() for details.
MaybeStartClassification();
}
void PhishingClassifierDelegate::DidCommitProvisionalLoad(
ui::PageTransition transition) {
blink::WebLocalFrame* frame = render_frame()->GetWebFrame();
// A new page is starting to load, so cancel classificaiton.
CancelPendingClassification();
if (!frame->Parent())
last_main_frame_transition_ = transition;
}
void PhishingClassifierDelegate::DidFinishSameDocumentNavigation() {
// TODO(bryner): We shouldn't need to cancel classification if the navigation
// is within the same document. However, if we let classification continue in
// this case, we need to properly deal with the fact that PageCaptured will
// be called again for the same-document navigation. We need to be sure not
// to swap out the page text while the term feature extractor is still
// running.
CancelPendingClassification();
}
bool PhishingClassifierDelegate::is_ready() {
return classifier_->is_ready();
}
void PhishingClassifierDelegate::PageCaptured(
scoped_refptr<const base::RefCountedString16> page_text,
bool preliminary_capture) {
RecordEvent(SBPhishingClassifierEvent::kPageTextCaptured);
if (preliminary_capture) {
return;
}
// Make sure there's no classification in progress. We don't want to swap
// out the page text string from underneath the term feature extractor.
//
// Note: Currently, if the url hasn't changed, we won't restart
// classification in this case. We may want to adjust this.
CancelPendingClassification();
last_finished_load_url_ = render_frame()->GetWebFrame()->GetDocument().Url();
classifier_page_text_ = std::move(page_text);
GURL stripped_last_load_url(StripRef(last_finished_load_url_));
// Check if toplevel URL has changed.
if (stripped_last_load_url == StripRef(last_url_sent_to_classifier_)) {
return;
}
MaybeStartClassification();
}
void PhishingClassifierDelegate::CancelPendingClassification() {
if (is_classifying_) {
is_classifying_ = false;
}
if (classifier_->is_ready()) {
classifier_->CancelPendingClassification();
}
classifier_page_text_ = nullptr;
awaiting_retry_ = false;
}
void PhishingClassifierDelegate::ClassificationDone(
const ClientPhishingRequest& verdict,
PhishingClassifier::Result phishing_classifier_result) {
is_phishing_detection_running_ = false;
if (callback_.is_null())
return;
mojom::PhishingDetectorResult result = mojom::PhishingDetectorResult::SUCCESS;
if (verdict.client_score() == PhishingClassifier::kClassifierFailed) {
switch (phishing_classifier_result) {
case PhishingClassifier::Result::kInvalidScore:
result = mojom::PhishingDetectorResult::INVALID_SCORE;
break;
case PhishingClassifier::Result::kInvalidURLFormatRequest:
result = mojom::PhishingDetectorResult::INVALID_URL_FORMAT_REQUEST;
break;
case PhishingClassifier::Result::kInvalidDocumentLoader:
result = mojom::PhishingDetectorResult::INVALID_DOCUMENT_LOADER;
break;
case PhishingClassifier::Result::kURLFeatureExtractionFailed:
result = mojom::PhishingDetectorResult::URL_FEATURE_EXTRACTION_FAILED;
break;
case PhishingClassifier::Result::kDOMExtractionFailed:
result = mojom::PhishingDetectorResult::DOM_EXTRACTION_FAILED;
break;
case PhishingClassifier::Result::kTermExtractionFailed:
result = mojom::PhishingDetectorResult::TERM_EXTRACTION_FAILED;
break;
case PhishingClassifier::Result::kVisualExtractionFailed:
result = mojom::PhishingDetectorResult::VISUAL_EXTRACTION_FAILED;
break;
default:
NOTREACHED();
}
}
if (result == mojom::PhishingDetectorResult::SUCCESS) {
DCHECK_EQ(last_url_sent_to_classifier_.spec(), verdict.url());
}
std::move(callback_).Run(result, mojo_base::ProtoWrapper(verdict));
}
void PhishingClassifierDelegate::MaybeStartClassification() {
// We can begin phishing classification when the following conditions are
// met:
// 1. A Scorer has been created
// 2. The browser has sent a StartPhishingDetection message for the
// current toplevel URL.
// 3. The page has finished loading and the page text has been extracted.
// 4. The load is a new navigation (not a session history navigation).
// 5. The toplevel URL has not already been classified.
//
// Note that if we determine that this particular navigation should not be
// classified at all (as opposed to deferring it until we get an IPC or
// the load completes), we discard the page text since it won't be needed.
if (!classifier_->is_ready()) {
// We should only retry if a phishing detection has been requested, which
// is tracked by |is_phishing_detection_running_|.
if (base::FeatureList::IsEnabled(kClientSideDetectionRetryLimit) &&
is_phishing_detection_running_ && !awaiting_retry_) {
awaiting_retry_ = true;
base::SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
FROM_HERE,
base::BindOnce(&PhishingClassifierDelegate::OnRetryTimeout,
weak_factory_.GetWeakPtr()),
base::Seconds(kClientSideDetectionRetryLimitTime.Get()));
} else {
is_phishing_detection_running_ = false;
// Keep classifier_page_text_, in case a Scorer is set later.
if (!callback_.is_null()) {
std::move(callback_).Run(
mojom::PhishingDetectorResult::CLASSIFIER_NOT_READY, std::nullopt);
}
}
return;
}
if (last_main_frame_transition_ & ui::PAGE_TRANSITION_FORWARD_BACK) {
// Skip loads from session history navigation. However, update the
// last URL sent to the classifier, so that we'll properly detect
// same-document navigations.
last_url_sent_to_classifier_ = last_finished_load_url_;
classifier_page_text_ = nullptr; // we won't need this.
is_phishing_detection_running_ = false;
if (!callback_.is_null())
std::move(callback_).Run(
mojom::PhishingDetectorResult::FORWARD_BACK_TRANSITION, std::nullopt);
return;
}
if (!classifier_page_text_) {
RecordEvent(SBPhishingClassifierEvent::kPageTextNotLoaded);
return;
}
GURL stripped_last_load_url(StripRef(last_finished_load_url_));
if (last_url_received_from_browser_ != stripped_last_load_url) {
RecordEvent(SBPhishingClassifierEvent::kUrlShouldNotBeClassified);
// The browser has not yet confirmed that this URL should be classified,
// so defer classification for now. Note: the ref does not affect
// any of the browser's preclassification checks, so we don't require it
// to match.
// Keep classifier_page_text_, in case the browser notifies us later that
// we should classify the URL.
return;
}
last_url_sent_to_classifier_ = last_finished_load_url_;
if (awaiting_retry_) {
LogClassificationRetryWithinTimeout(true);
awaiting_retry_ = false;
}
is_classifying_ = true;
classifier_->BeginClassification(
classifier_page_text_,
base::BindOnce(&PhishingClassifierDelegate::ClassificationDone,
base::Unretained(this)));
}
void PhishingClassifierDelegate::OnRetryTimeout() {
// If |awaiting_retry_| is false, the classification is happening, completed,
// cancelled, or there is a new phishing detection request.
if (!awaiting_retry_) {
return;
}
is_phishing_detection_running_ = false;
awaiting_retry_ = false;
if (!callback_.is_null()) {
std::move(callback_).Run(
mojom::PhishingDetectorResult::CLASSIFIER_NOT_READY, std::nullopt);
}
LogClassificationRetryWithinTimeout(false);
}
void PhishingClassifierDelegate::RecordEvent(SBPhishingClassifierEvent event) {
UMA_HISTOGRAM_ENUMERATION("SBClientPhishing.Classifier.Event", event);
}
void PhishingClassifierDelegate::OnDestruct() {
if (is_phishing_detection_running_) {
RecordEvent(SBPhishingClassifierEvent::kDestructedBeforeClassificationDone);
}
delete this;
}
void PhishingClassifierDelegate::OnScorerChanged() {
Scorer* scorer = ScorerStorage::GetInstance()->GetScorer();
if (!scorer) {
// If the scorer is reset, we should clear pending classification if there
// is one going on, which is checked by the function below.
CancelPendingClassification();
return;
}
// We check |is_classifying_| here because |CancelPendingClassification|
// clears the page text, and we do not want that if we are awaiting retry.
if (is_classifying_) {
CancelPendingClassification();
} else if (awaiting_retry_) {
// If a classificiation is not going on right now, a retry has been
// attempted, and we're still within the timeout, call the classification
// process again, because we should be able to classify now with the scorer
// available.
RecordEvent(SBPhishingClassifierEvent::kScorerUpdatedWithinRetryTimeout);
MaybeStartClassification();
}
}
} // namespace safe_browsing
|