Add custom interstitial for captive portals.

chrome/browser/ssl/ssl_error_handler.cc

+// Copyright 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "chrome/browser/ssl/ssl_error_handler.h"
+
+#include "base/metrics/field_trial.h"
+#include "base/metrics/histogram.h"
+#include "base/time/time.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/ssl/ssl_blocking_page.h"
+#include "content/public/browser/notification_service.h"
+#include "content/public/browser/notification_source.h"
+#include "content/public/browser/web_contents.h"
+
+#if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
+#include "chrome/browser/captive_portal/captive_portal_service.h"
+#include "chrome/browser/captive_portal/captive_portal_service_factory.h"
+#include "chrome/browser/captive_portal/captive_portal_tab_helper.h"
+#include "chrome/browser/ssl/captive_portal_blocking_page.h"
+#endif
+
+namespace {
+
+// The delay before displaying the SSL interstitial for cert errors.
+// - If a "captive portal detected" result arrives in this many seconds,
+//   a captive portal interstitial is displayed.
+// - Otherwise, an SSL interstitial is displayed.
+const int kDefaultInterstitialDisplayDelayInSeconds = 2;
+
+// Time to wait before displaying the SSL interstitial. If a captive portal
+// arrives before this, the captive portal interstitial is displayed instead.
+// Can be changed for testing.
+static base::TimeDelta interstitial_display_delay =

[Bernhard Bauer, 2014/12/19 10:14:25]

Could you name these with a g_ prefix to make it clear they're global variables?
Otherwise they're easily confused with local variables.

[Bernhard Bauer, 2014/12/19 10:14:25]

Are we sure this won't create a static initializer? Also, I think the "static"
isn't necessary if you're in an anonymous namespace anyway.

[meacer, 2014/12/19 19:04:23]

Done.

[meacer, 2014/12/19 19:04:24]

Since there are only three different values, I made this an enum to be on the
safe side.

+    base::TimeDelta::FromSeconds(kDefaultInterstitialDisplayDelayInSeconds);
+
+// Callback to call when the interstitial timer is fired. Used for testing.
+static SSLErrorHandler::TimerFiredCallback* timer_fired_callback = nullptr;
+
+// Events for UMA.
+enum SSLErrorHandlerEvent {
+  HANDLE_ALL,
+  SHOW_CAPTIVE_PORTAL_INTERSTITIAL,
+  SHOW_CAPTIVE_PORTAL_INTERSTITIAL_OVERRIDABLE,
+  SHOW_SSL_INTERSTITIAL,
+  SHOW_SSL_INTERSTITIAL_OVERRIDABLE,
+  SSL_ERROR_HANDLER_EVENT_COUNT
+};
+
+void RecordUMA(SSLErrorHandlerEvent event) {
+  UMA_HISTOGRAM_ENUMERATION("interstitial.ssl_error_handler",
+                            event,
+                            SSL_ERROR_HANDLER_EVENT_COUNT);
+}
+
+}  // namespace
+
+DEFINE_WEB_CONTENTS_USER_DATA_KEY(SSLErrorHandler);
+
+SSLErrorHandler::~SSLErrorHandler() {
+}
+
+void SSLErrorHandler::HandleSSLError(
+    content::WebContents* web_contents,
+    int cert_error,
+    const net::SSLInfo& ssl_info,
+    const GURL& request_url,
+    int options_mask,
+    const base::Callback<void(bool)>& callback) {
+#if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
+  CaptivePortalTabHelper* captive_portal_tab_helper =
+      CaptivePortalTabHelper::FromWebContents(web_contents);
+  if (captive_portal_tab_helper) {
+    captive_portal_tab_helper->OnSSLCertError(ssl_info);
+  }
+#endif
+  SSLErrorHandler::CreateForWebContents(web_contents, cert_error, ssl_info,
+                                        request_url, options_mask, callback);
+  SSLErrorHandler* error_handler =
+      SSLErrorHandler::FromWebContents(web_contents);
+  error_handler->StartHandlingError();
+}
+
+// static
+void SSLErrorHandler::SetInterstitialDisplayDelayForTest(
+    base::TimeDelta delay) {
+  interstitial_display_delay = delay;
+}
+
+// static
+void SSLErrorHandler::SetInterstitialTimerFiredCallbackForTest(
+    TimerFiredCallback* callback) {
+  if (timer_fired_callback) {

[Bernhard Bauer, 2014/12/19 10:14:25]

Uh, I don't think this does what you think it does... Shouldn't this check
|callback| instead, and also leave out the return?

[meacer, 2014/12/19 19:04:23]

Oh wow, good catch. I don't know what I was thinking. 

+    DCHECK(!timer_fired_callback->is_null());
+    return;
+  }
+  timer_fired_callback = callback;
+}
+
+SSLErrorHandler::SSLErrorHandler(content::WebContents* web_contents,
+                                 int cert_error,
+                                 const net::SSLInfo& ssl_info,
+                                 const GURL& request_url,
+                                 int options_mask,
+                                 const base::Callback<void(bool)>& callback)
+    : web_contents_(web_contents),
+      cert_error_(cert_error),
+      ssl_info_(ssl_info),
+      request_url_(request_url),
+      options_mask_(options_mask),
+      callback_(callback) {
+#if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
+  Profile* profile = Profile::FromBrowserContext(
+      web_contents->GetBrowserContext());
+  registrar_.Add(this,
+                 chrome::NOTIFICATION_CAPTIVE_PORTAL_CHECK_RESULT,
+                 content::Source<Profile>(profile));
+#endif
+}
+
+void SSLErrorHandler::StartHandlingError() {
+  RecordUMA(HANDLE_ALL);
+
+#if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
+  CheckForCaptivePortal();
+  timer_.Start(FROM_HERE, interstitial_display_delay,
+               base::Bind(&SSLErrorHandler::OnTimerExpired,
+                          base::Unretained(this)));
+  if (timer_fired_callback)
+    timer_fired_callback->Run(web_contents_);
+#else
+  // Display an SSL interstitial.
+  ShowSSLInterstitial();
+#endif
+}
+
+// static
+void SSLErrorHandler::CreateForWebContents(
+    content::WebContents* web_contents,
+    int cert_error,
+    const net::SSLInfo& ssl_info,
+    const GURL& request_url,
+    int options_mask,
+    const base::Callback<void(bool)>& callback) {
+  DCHECK(!FromWebContents(web_contents));
+  web_contents->SetUserData(UserDataKey(),
+                            new SSLErrorHandler(web_contents, cert_error,
+                                                ssl_info, request_url,
+                                                options_mask, callback));
+}
+
+void SSLErrorHandler::OnTimerExpired() {
+  ShowSSLInterstitial();
+}
+
+void SSLErrorHandler::CheckForCaptivePortal() {
+#if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
+  Profile* profile = Profile::FromBrowserContext(
+      web_contents_->GetBrowserContext());
+  CaptivePortalService* captive_portal_service =
+      CaptivePortalServiceFactory::GetForProfile(profile);
+  captive_portal_service->DetectCaptivePortal();
+#else
+  NOTREACHED();
+#endif
+}
+
+void SSLErrorHandler::ShowCaptivePortalInterstitial() {
+#if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
+  // Show captive portal blocking page. The interstitial owns the blocking page.
+  RecordUMA(SSLBlockingPage::IsOverridable(options_mask_) ?
+            SHOW_CAPTIVE_PORTAL_INTERSTITIAL_OVERRIDABLE :
+            SHOW_CAPTIVE_PORTAL_INTERSTITIAL);
+  (new CaptivePortalBlockingPage(web_contents_, request_url_))->Show();
+  // Once an interstitial is displayed, no need to keep the handler around.
+  // This is the equivalent of "delete this".
+  web_contents_->RemoveUserData(UserDataKey());
+#else
+  NOTREACHED();
+#endif
+}
+
+void SSLErrorHandler::ShowSSLInterstitial() {
+  // Show SSL blocking page. The interstitial owns the blocking page.
+  RecordUMA(SSLBlockingPage::IsOverridable(options_mask_) ?
+            SHOW_SSL_INTERSTITIAL_OVERRIDABLE :
+            SHOW_SSL_INTERSTITIAL);
+  (new SSLBlockingPage(web_contents_, cert_error_, ssl_info_, request_url_,
+                       options_mask_, callback_))->Show();
+  // Once an interstitial is displayed, no need to keep the handler around.
+  // This is the equivalent of "delete this".
+  web_contents_->RemoveUserData(UserDataKey());
+}
+
+void SSLErrorHandler::Observe(
+    int type,
+    const content::NotificationSource& source,
+    const content::NotificationDetails& details) {
+#if defined(ENABLE_CAPTIVE_PORTAL_DETECTION)
+  if (type == chrome::NOTIFICATION_CAPTIVE_PORTAL_CHECK_RESULT) {
+    timer_.Stop();
+    CaptivePortalService::Results* results =
+        content::Details<CaptivePortalService::Results>(details).ptr();
+    if (results->result == captive_portal::RESULT_BEHIND_CAPTIVE_PORTAL)
+      ShowCaptivePortalInterstitial();
+    else
+      ShowSSLInterstitial();
+  }
+#endif
+}