Merge pull request #316 from brave/tor-extension

Implement Tor client updater as component extension

browser/brave_browser_process_impl.cc

@@ -9,6 +9,7 @@
 #include "base/threading/sequenced_task_runner_handle.h"
 #include "brave/browser/component_updater/brave_component_updater_configurator.h"
 #include "brave/browser/brave_stats_updater.h"
+#include "brave/browser/extensions/brave_tor_client_updater.h"
 #include "brave/components/brave_shields/browser/ad_block_service.h"
 #include "brave/components/brave_shields/browser/ad_block_regional_service.h"
 #include "brave/components/brave_shields/browser/https_everywhere_service.h"
@@ -119,3 +120,12 @@ BraveBrowserProcessImpl::https_everywhere_service() {
     brave_shields::HTTPSEverywhereServiceFactory();
   return https_everywhere_service_.get();
 }
+
+extensions::BraveTorClientUpdater*
+BraveBrowserProcessImpl::tor_client_updater() {
+  if (tor_client_updater_)
+    return tor_client_updater_.get();
+
+  tor_client_updater_ = extensions::BraveTorClientUpdaterFactory();
+  return tor_client_updater_.get();
+}

browser/brave_browser_process_impl.h

@@ -18,6 +18,10 @@ class HTTPSEverywhereService;
 class TrackingProtectionService;
 }
 
+namespace extensions {
+class BraveTorClientUpdater;
+}
+
 class BraveBrowserProcessImpl : public BrowserProcessImpl {
  public:
   BraveBrowserProcessImpl(base::SequencedTaskRunner* local_state_task_runner);
@@ -31,6 +35,7 @@ class BraveBrowserProcessImpl : public BrowserProcessImpl {
   brave_shields::AdBlockRegionalService* ad_block_regional_service();
   brave_shields::TrackingProtectionService* tracking_protection_service();
   brave_shields::HTTPSEverywhereService* https_everywhere_service();
+  extensions::BraveTorClientUpdater* tor_client_updater();
 
  private:
   std::unique_ptr<brave_shields::AdBlockService> ad_block_service_;
@@ -41,9 +46,10 @@ class BraveBrowserProcessImpl : public BrowserProcessImpl {
   std::unique_ptr<brave_shields::HTTPSEverywhereService>
       https_everywhere_service_;
   std::unique_ptr<brave::BraveStatsUpdater> brave_stats_updater_;
+  std::unique_ptr<extensions::BraveTorClientUpdater> tor_client_updater_;
 
   component_updater::ComponentUpdateService* component_updater(
-      std::unique_ptr<component_updater::ComponentUpdateService> &,
+      std::unique_ptr<component_updater::ComponentUpdateService>&,
       bool use_brave_server);
   std::unique_ptr<component_updater::ComponentUpdateService>
       google_component_updater_;

browser/extensions/BUILD.gn

@@ -6,6 +6,8 @@ source_set("extensions") {
     "api/brave_shields_api.h",
     "api/content_settings/brave_content_settings_store.cc",
     "api/content_settings/brave_content_settings_store.h",
+    "brave_component_extension.cc",
+    "brave_component_extension.h",
     "brave_component_extension_resource_manager.cc",
     "brave_component_extension_resource_manager.h",
     "brave_component_loader.cc",
@@ -14,6 +16,8 @@ source_set("extensions") {
     "brave_extension_management.h",
     "brave_extension_provider.cc",
     "brave_extension_provider.h",
+    "brave_tor_client_updater.cc",
+    "brave_tor_client_updater.h",
   ]
 
   deps = [

browser/extensions/brave_component_extension.cc

@@ -0,0 +1,61 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "brave/browser/extensions/brave_component_extension.h"
+
+#include <string>
+
+#include "base/bind.h"
+#include "base/bind_helpers.h"
+#include "base/callback.h"
+#include "brave/browser/component_updater/brave_component_installer.h"
+#include "chrome/browser/browser_process.h"
+
+void ComponentsUI::OnDemandUpdate(
+    component_updater::ComponentUpdateService* cus,
+    const std::string& component_id) {
+  cus->GetOnDemandUpdater().OnDemandUpdate(
+      component_id, component_updater::OnDemandUpdater::Priority::FOREGROUND,
+      component_updater::Callback());
+}
+
+BraveComponentExtension::BraveComponentExtension() {
+}
+
+BraveComponentExtension::~BraveComponentExtension() {
+}
+
+void BraveComponentExtension::Register(
+    const std::string& component_name,
+    const std::string& component_id,
+    const std::string& component_base64_public_key) {
+  component_name_ = component_name;
+  component_id_ = component_id;
+  component_base64_public_key_ = component_base64_public_key;
+
+  base::Closure registered_callback =
+      base::Bind(&BraveComponentExtension::OnComponentRegistered,
+                 base::Unretained(this), component_id_);
+  ReadyCallback ready_callback =
+      base::Bind(&BraveComponentExtension::OnComponentReady,
+                 base::Unretained(this), component_id_);
+  brave::RegisterComponent(g_browser_process->component_updater(),
+                           component_name_, component_base64_public_key_,
+                           registered_callback, ready_callback);
+}
+
+// static
+bool BraveComponentExtension::Unregister(const std::string& component_id) {
+  return g_browser_process->component_updater()->UnregisterComponent(
+      component_id);
+}
+
+void BraveComponentExtension::OnComponentRegistered(const std::string& component_id) {
+  OnDemandUpdate(g_browser_process->component_updater(), component_id);
+}
+
+void BraveComponentExtension::OnComponentReady(
+    const std::string& component_id,
+    const base::FilePath& install_dir) {
+}

browser/extensions/brave_component_extension.h

@@ -0,0 +1,40 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef BRAVE_BROWSER_EXTENSIONS_BRAVE_COMPONENT_EXTENSION_H_
+#define BRAVE_BROWSER_EXTENSIONS_BRAVE_COMPONENT_EXTENSION_H_
+
+#include "base/files/file_path.h"
+#include "components/component_updater/component_updater_service.h"
+
+// Just used to give access to OnDemandUpdater since it's private.
+// Chromium has ComponentsUI which is a friend class, so we just
+// do this hack here to gain access.
+class ComponentsUI {
+ public:
+  void OnDemandUpdate(component_updater::ComponentUpdateService* cus,
+                      const std::string& component_id);
+};
+
+class BraveComponentExtension : public ComponentsUI {
+ public:
+  BraveComponentExtension();
+  virtual ~BraveComponentExtension();
+  void Register(const std::string& component_name,
+                const std::string& component_id,
+                const std::string& component_base64_public_key);
+  static bool Unregister(const std::string& component_id);
+
+ protected:
+  virtual void OnComponentRegistered(const std::string& component_id);
+  virtual void OnComponentReady(const std::string& component_id,
+                                const base::FilePath& install_dir);
+
+ private:
+  std::string component_name_;
+  std::string component_id_;
+  std::string component_base64_public_key_;
+};
+
+#endif  // BRAVE_BROWSER_EXTENSIONS_BRAVE_COMPONENT_EXTENSION_H_

browser/extensions/brave_extension_management.cc

@@ -5,9 +5,11 @@
 #include "brave/browser/extensions/brave_extension_management.h"
 
 #include "base/command_line.h"
+#include "brave/browser/brave_browser_process_impl.h"
 #include "brave/common/brave_switches.h"
 #include "brave/common/extensions/extension_constants.h"
 #include "brave/browser/extensions/brave_extension_provider.h"
+#include "brave/browser/extensions/brave_tor_client_updater.h"
 #include "chrome/browser/extensions/external_policy_loader.h"
 #include "extensions/common/extension_urls.h"
 
@@ -24,6 +26,7 @@ BraveExtensionManagement::BraveExtensionManagement(
   if (!command_line.HasSwitch(switches::kDisablePDFJSExtension)) {
     RegisterForceInstalledExtensions();
   }
+  RegisterBraveExtensions();
 }
 
 BraveExtensionManagement::~BraveExtensionManagement() {
@@ -37,4 +40,11 @@ void BraveExtensionManagement::RegisterForceInstalledExtensions() {
   UpdateForcedExtensions(&forced_list_pref);
 }
 
+void BraveExtensionManagement::RegisterBraveExtensions() {
+  const base::CommandLine& command_line =
+      *base::CommandLine::ForCurrentProcess();
+  if (!command_line.HasSwitch(switches::kDisableTorClientUpdaterExtension))
+    g_brave_browser_process->tor_client_updater()->Register();
+}
+
 }  // namespace extensions

browser/extensions/brave_extension_management.h

@@ -16,6 +16,7 @@ class BraveExtensionManagement : public ExtensionManagement {
 
  private:
   void RegisterForceInstalledExtensions();
+  void RegisterBraveExtensions();
   DISALLOW_COPY_AND_ASSIGN(BraveExtensionManagement);
 };
 

browser/extensions/brave_extension_provider.cc

@@ -39,6 +39,12 @@ bool IsWhitelisted(const extensions::Extension* extension) {
     "afalakplffnnnlkncjhbmahjfjhmlkal",
     // Brave HTTPS Everywhere Updater
     "oofiananboodjbbmdelgdommihjbkfag",
+    // Brave Tor Client Updater (Windows)
+    "cpoalefficncklhjfpglfiplenlpccdb",
+    // Brave Tor Client Updater (Mac)
+    "cldoidikboihgcjfkhdeidbpclkineef",
+    // Brave Tor Client Updater (Linux)
+    "biahpgbdmdkfgndcmfiipgcebobojjkp",
     // Dashlane
     "fdjamakpfbbddfjaooikfcpapjohcfmg",
     // Enpass
@@ -72,7 +78,9 @@ bool IsWhitelisted(const extensions::Extension* extension) {
     // Test ID: PDFJS
     "kpbdcmcgkedhpbcpfndimofjnefgjidd",
     // Test ID: Brave HTTPS Everywhere Updater
-    "bhlmpjhncoojbkemjkeppfahkglffilp"
+    "bhlmpjhncoojbkemjkeppfahkglffilp",
+    // Test ID: Brave Tor Client Updater
+    "ngicbhhaldfdgmjhilmnleppfpmkgbbk"
   });
   return std::find(whitelist.begin(), whitelist.end(),
       extension->id()) != whitelist.end();

browser/extensions/brave_tor_client_updater.cc

@@ -0,0 +1,84 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "brave/browser/extensions/brave_tor_client_updater.h"
+
+#include "base/files/file_enumerator.h"
+#include "base/files/file_path.h"
+#include "base/task_scheduler/post_task.h"
+#include "third_party/re2/src/re2/re2.h"
+
+namespace extensions {
+
+std::string BraveTorClientUpdater::g_tor_client_component_id_(
+    kTorClientComponentId);
+std::string BraveTorClientUpdater::g_tor_client_component_base64_public_key_(
+    kTorClientComponentBase64PublicKey);
+
+BraveTorClientUpdater::BraveTorClientUpdater()
+    : task_runner_(
+          base::CreateSequencedTaskRunnerWithTraits({base::MayBlock()})),
+      registered_(false) {
+}
+
+BraveTorClientUpdater::~BraveTorClientUpdater() {
+}
+
+void BraveTorClientUpdater::Register() {
+  if (registered_)
+    return;
+
+  BraveComponentExtension::Register(kTorClientComponentName,
+                                    g_tor_client_component_id_,
+                                    g_tor_client_component_base64_public_key_);
+  registered_ = true;
+}
+
+base::FilePath BraveTorClientUpdater::GetExecutablePath() const {
+  return executable_path_;
+}
+
+void BraveTorClientUpdater::InitExecutablePath(
+    const base::FilePath& install_dir) {
+  base::FileEnumerator traversal(install_dir, false,
+                                 base::FileEnumerator::FILES,
+                                 FILE_PATH_LITERAL("tor-*"));
+  for (base::FilePath current = traversal.Next(); !current.empty();
+       current = traversal.Next()) {
+    base::FileEnumerator::FileInfo file_info = traversal.GetInfo();
+    if (RE2::FullMatch(file_info.GetName().MaybeAsASCII(),
+                       "tor-\\d+\\.\\d+\\.\\d+\\.\\d+-\\w+-brave-\\d+")) {
+      executable_path_ = current;
+      return;
+    }
+  }
+
+  LOG(ERROR) << "Failed to locate Tor client executable in "
+             << install_dir.value().c_str();
+}
+
+void BraveTorClientUpdater::OnComponentReady(
+    const std::string& component_id,
+    const base::FilePath& install_dir) {
+  GetTaskRunner()->PostTask(
+      FROM_HERE, base::Bind(&BraveTorClientUpdater::InitExecutablePath,
+                            base::Unretained(this), install_dir));
+}
+
+// static
+void BraveTorClientUpdater::SetComponentIdAndBase64PublicKeyForTest(
+    const std::string& component_id,
+    const std::string& component_base64_public_key) {
+  g_tor_client_component_id_ = component_id;
+  g_tor_client_component_base64_public_key_ = component_base64_public_key;
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+// The Brave Tor client extension factory.
+std::unique_ptr<BraveTorClientUpdater> BraveTorClientUpdaterFactory() {
+  return std::make_unique<BraveTorClientUpdater>();
+}
+
+}  // namespace extensions