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
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_EXTENSIONS_COMPONENT_LOADER_H_
#define CHROME_BROWSER_EXTENSIONS_COMPONENT_LOADER_H_
#include <stddef.h>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
#include "base/files/file_path.h"
#include "base/functional/callback_forward.h"
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/values.h"
#include "build/branding_buildflags.h"
#include "build/build_config.h"
#include "build/chromeos_buildflags.h"
#include "chrome/common/buildflags.h"
#include "components/content_settings/core/common/content_settings_types.h"
#include "components/keyed_service/core/keyed_service.h"
#include "extensions/buildflags/buildflags.h"
#include "extensions/common/extension_id.h"
static_assert(BUILDFLAG(ENABLE_EXTENSIONS_CORE));
class Profile;
namespace content {
class BrowserContext;
}
namespace extensions {
class Extension;
class ExtensionSystem;
// For registering, loading, and unloading component extensions.
class ComponentLoader : public KeyedService {
public:
static ComponentLoader* Get(content::BrowserContext* context);
ComponentLoader(const ComponentLoader&) = delete;
ComponentLoader& operator=(const ComponentLoader&) = delete;
~ComponentLoader() override;
// KeyedService:
void Shutdown() override;
size_t registered_extensions_count() const {
return component_extensions_.size();
}
// Creates and loads all registered component extensions.
void LoadAll();
// Registers and possibly loads a component extension. If ExtensionService
// has been initialized, the extension is loaded; otherwise, the load is
// deferred until LoadAll is called. The ID of the added extension is
// returned.
//
// Component extension manifests must contain a "key" property with a unique
// public key, serialized in base64. You can create a suitable value with the
// following commands on a unixy system:
//
// ssh-keygen -t rsa -b 1024 -N '' -f /tmp/key.pem
// openssl rsa -pubout -outform DER < /tmp/key.pem 2>/dev/null | base64 -w 0
ExtensionId Add(std::string_view manifest_contents,
const base::FilePath& root_directory);
// Convenience method for registering a component extension by resource id.
ExtensionId Add(int manifest_resource_id,
const base::FilePath& root_directory);
// Convenience method for registering a component extension by parsed
// manifest.
ExtensionId Add(base::Value::Dict manifest,
const base::FilePath& root_directory);
// Loads a component extension from file system. Replaces previously added
// extension with the same ID.
ExtensionId AddOrReplace(const base::FilePath& path);
// Returns true if an extension with the specified id has been added.
bool Exists(const ExtensionId& id) const;
// Unloads a component extension and removes it from the list of component
// extensions to be loaded.
void Remove(const base::FilePath& root_directory);
void Remove(const ExtensionId& id);
// Call this during test setup to load component extensions that have
// background pages for testing, which could otherwise interfere with tests.
static void EnableBackgroundExtensionsForTesting();
#if BUILDFLAG(IS_CHROMEOS) && BUILDFLAG(GOOGLE_CHROME_BRANDING)
// Call this during test setup to disabling loading the HelpApp.
static void DisableHelpAppForTesting();
#endif
// Adds the default component extensions. If `skip_session_components`
// the loader will skip loading component extensions that weren't supposed to
// be loaded unless we are in signed user session (ChromeOS). For all other
// platforms this `skip_session_components` is expected to be unset.
void AddDefaultComponentExtensions(bool skip_session_components);
// Similar to above but adds the default component extensions for kiosk mode.
void AddDefaultComponentExtensionsForKioskMode(bool skip_session_components);
// Reloads a registered component extension.
void Reload(const ExtensionId& extension_id);
// Return ids of all registered extensions.
std::vector<ExtensionId> GetRegisteredComponentExtensionsIds() const;
#if BUILDFLAG(IS_CHROMEOS)
// Identical to AddComponentFromDir() except allows for the caller to supply
// the name of the manifest file.
void AddComponentFromDirWithManifestFilename(
const base::FilePath& root_directory,
const ExtensionId& extension_id,
const base::FilePath::CharType* manifest_file_name,
const base::FilePath::CharType* guest_manifest_file_name,
base::OnceClosure done_cb);
// Add a component extension from a specific directory. Assumes that the
// extension uses a different manifest file when this is a guest session
// and that the manifest file lives in `root_directory`. Calls `done_cb`
// on success, unless the component loader is shut down during loading.
void AddComponentFromDir(const base::FilePath& root_directory,
const ExtensionId& extension_id,
base::OnceClosure done_cb);
// Add a component extension from a specific directory. Assumes that the
// extension's manifest file lives in `root_directory` and its name is
// 'manifest.json'. `name_string` and `description_string` are used to
// localize component extension's name and description text exclusively.
void AddWithNameAndDescriptionFromDir(const base::FilePath& root_directory,
const ExtensionId& extension_id,
const std::string& name_string,
const std::string& description_string);
void AddChromeOsSpeechSynthesisExtensions();
#endif // BUILDFLAG(IS_CHROMEOS)
void set_ignore_allowlist_for_testing(bool value) {
ignore_allowlist_for_testing_ = value;
}
// Allows setting the profile used by the loader for testing purposes.
void set_profile_for_testing(Profile* profile) { profile_ = profile; }
private:
friend class ComponentLoaderFactory;
FRIEND_TEST_ALL_PREFIXES(ComponentLoaderTest, ParseManifest);
// Information about a registered component extension.
struct ComponentExtensionInfo {
ComponentExtensionInfo(base::Value::Dict manifest_param,
const base::FilePath& root_directory);
ComponentExtensionInfo(const ComponentExtensionInfo&) = delete;
ComponentExtensionInfo& operator=(const ComponentExtensionInfo&) = delete;
~ComponentExtensionInfo();
ComponentExtensionInfo(ComponentExtensionInfo&& other);
ComponentExtensionInfo& operator=(ComponentExtensionInfo&& other);
// The parsed contents of the extensions's manifest file.
base::Value::Dict manifest;
// Directory where the extension is stored.
base::FilePath root_directory;
// The component extension's ID.
ExtensionId extension_id;
};
explicit ComponentLoader(Profile* profile);
// Parses the given JSON manifest. Returns `std::nullopt` if it cannot be
// parsed or if the result is not a base::Value::Dict.
std::optional<base::Value::Dict> ParseManifest(
std::string_view manifest_contents) const;
ExtensionId Add(std::string_view manifest_contents,
const base::FilePath& root_directory,
bool skip_allowlist);
ExtensionId Add(base::Value::Dict parsed_manifest,
const base::FilePath& root_directory,
bool skip_allowlist);
// Loads a registered component extension.
void Load(const ComponentExtensionInfo& info);
void AddDefaultComponentExtensionsWithBackgroundPages(
bool skip_session_components);
void AddDefaultComponentExtensionsWithBackgroundPagesForKioskMode();
#if BUILDFLAG(ENABLE_HANGOUT_SERVICES_EXTENSION)
void AddHangoutServicesExtension();
#endif // BUILDFLAG(ENABLE_HANGOUT_SERVICES_EXTENSION)
void AddNetworkSpeechSynthesisExtension();
void AddWithNameAndDescription(int manifest_resource_id,
const base::FilePath& root_directory,
const std::string& name_string,
const std::string& description_string);
void AddWebStoreApp();
#if BUILDFLAG(IS_CHROMEOS)
void AddChromeApp();
void AddFileManagerExtension();
void AddGalleryExtension();
void AddImageLoaderExtension();
void AddGuestModeTestExtension(const base::FilePath& path);
void AddKeyboardApp();
// Used as a reply callback by `AddComponentFromDir`.
// Called with a `root_directory` and parsed `manifest` and invokes
// `done_cb` after adding the extension.
void FinishAddComponentFromDir(
const base::FilePath& root_directory,
const ExtensionId& extension_id,
const std::optional<std::string>& name_string,
const std::optional<std::string>& description_string,
base::OnceClosure done_cb,
std::optional<base::Value::Dict> manifest);
// Finishes loading an extension tts engine.
void FinishLoadSpeechSynthesisExtension(const ExtensionId& extension_id);
// Grant ContentSettingsType permissions to Extension.
void GrantPermissions(const ExtensionId& extension_id,
std::initializer_list<ContentSettingsType> permissions);
#endif // BUILDFLAG(IS_CHROMEOS)
scoped_refptr<const Extension> CreateExtension(
const ComponentExtensionInfo& info, std::string* utf8_error);
// Unloads `component` from the memory.
void UnloadComponent(ComponentExtensionInfo* component);
raw_ptr<Profile> profile_;
raw_ptr<ExtensionSystem, AcrossTasksDanglingUntriaged> extension_system_;
// List of registered component extensions (see mojom::ManifestLocation).
typedef std::vector<ComponentExtensionInfo> RegisteredComponentExtensions;
RegisteredComponentExtensions component_extensions_;
bool ignore_allowlist_for_testing_;
base::WeakPtrFactory<ComponentLoader> weak_factory_{this};
friend class TtsApiTest;
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_COMPONENT_LOADER_H_
|