1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef EXTENSIONS_COMMON_EXTENSION_H_
6 #define EXTENSIONS_COMMON_EXTENSION_H_
16 #include "base/containers/hash_tables.h"
17 #include "base/files/file_path.h"
18 #include "base/memory/linked_ptr.h"
19 #include "base/memory/ref_counted.h"
20 #include "base/memory/scoped_ptr.h"
21 #include "base/synchronization/lock.h"
22 #include "base/threading/thread_checker.h"
23 #include "extensions/common/extension_resource.h"
24 #include "extensions/common/install_warning.h"
25 #include "extensions/common/manifest.h"
26 #include "extensions/common/permissions/api_permission.h"
27 #include "extensions/common/url_pattern.h"
28 #include "extensions/common/url_pattern_set.h"
29 #include "ui/base/accelerators/accelerator.h"
30 #include "ui/gfx/size.h"
33 class ExtensionAction;
37 class DictionaryValue;
45 namespace extensions {
46 class PermissionsData;
47 class APIPermissionSet;
48 class ManifestPermissionSet;
51 // Uniquely identifies an Extension, using 32 characters from the alphabet
52 // 'a'-'p'. An empty string represents "no extension".
54 // Note: If this gets used heavily in files that don't otherwise need to include
55 // extension.h, we should pull it into a dedicated header.
56 typedef std::string ExtensionId;
58 // Represents a Chrome extension.
59 // Once created, an Extension object is immutable, with the exception of its
60 // RuntimeData. This makes it safe to use on any thread, since access to the
61 // RuntimeData is protected by a lock.
62 class Extension : public base::RefCountedThreadSafe<Extension> {
66 typedef std::map<const std::string, linked_ptr<ManifestData> >
72 // An external extension that the user uninstalled. We should not reinstall
73 // such extensions on startup.
74 EXTERNAL_EXTENSION_UNINSTALLED,
75 // Special state for component extensions, since they are always loaded by
76 // the component loader, and should never be auto-installed on startup.
81 // Used to record the reason an extension was disabled.
82 enum DeprecatedDisableReason {
83 DEPRECATED_DISABLE_UNKNOWN,
84 DEPRECATED_DISABLE_USER_ACTION,
85 DEPRECATED_DISABLE_PERMISSIONS_INCREASE,
86 DEPRECATED_DISABLE_RELOAD,
87 DEPRECATED_DISABLE_LAST, // Not used.
92 DISABLE_USER_ACTION = 1 << 0,
93 DISABLE_PERMISSIONS_INCREASE = 1 << 1,
94 DISABLE_RELOAD = 1 << 2,
95 DISABLE_UNSUPPORTED_REQUIREMENT = 1 << 3,
96 DISABLE_SIDELOAD_WIPEOUT = 1 << 4,
97 DISABLE_UNKNOWN_FROM_SYNC = 1 << 5,
98 DISABLE_PERMISSIONS_CONSENT = 1 << 6, // Unused - abandoned experiment.
99 DISABLE_KNOWN_DISABLED = 1 << 7,
100 DISABLE_NOT_VERIFIED = 1 << 8, // Disabled because we could not verify
102 DISABLE_GREYLIST = 1 << 9,
103 DISABLE_CORRUPTED = 1 << 10,
114 // A base class for parsed manifest data that APIs want to store on
115 // the extension. Related to base::SupportsUserData, but with an immutable
116 // thread-safe interface to match Extension.
117 struct ManifestData {
118 virtual ~ManifestData() {}
121 enum InitFromValueFlags {
124 // Usually, the id of an extension is generated by the "key" property of
125 // its manifest, but if |REQUIRE_KEY| is not set, a temporary ID will be
126 // generated based on the path.
127 REQUIRE_KEY = 1 << 0,
129 // Requires the extension to have an up-to-date manifest version.
130 // Typically, we'll support multiple manifest versions during a version
131 // transition. This flag signals that we want to require the most modern
132 // manifest version that Chrome understands.
133 REQUIRE_MODERN_MANIFEST_VERSION = 1 << 1,
135 // |ALLOW_FILE_ACCESS| indicates that the user is allowing this extension
136 // to have file access. If it's not present, then permissions and content
137 // scripts that match file:/// URLs will be filtered out.
138 ALLOW_FILE_ACCESS = 1 << 2,
140 // |FROM_WEBSTORE| indicates that the extension was installed from the
142 FROM_WEBSTORE = 1 << 3,
144 // |FROM_BOOKMARK| indicates the extension is a bookmark app which has been
145 // generated from a web page. Bookmark apps have no permissions or extent
146 // and launch the web page they are created from when run.
147 FROM_BOOKMARK = 1 << 4,
149 // |FOLLOW_SYMLINKS_ANYWHERE| means that resources can be symlinks to
150 // anywhere in the filesystem, rather than being restricted to the
151 // extension directory.
152 FOLLOW_SYMLINKS_ANYWHERE = 1 << 5,
154 // |ERROR_ON_PRIVATE_KEY| means that private keys inside an
155 // extension should be errors rather than warnings.
156 ERROR_ON_PRIVATE_KEY = 1 << 6,
158 // |WAS_INSTALLED_BY_DEFAULT| installed by default when the profile was
160 WAS_INSTALLED_BY_DEFAULT = 1 << 7,
162 // Unused - was part of an abandoned experiment.
163 REQUIRE_PERMISSIONS_CONSENT = 1 << 8,
165 // |IS_EPHEMERAL| identifies ephemeral apps (experimental), which are not
166 // permanently installed.
167 IS_EPHEMERAL = 1 << 9,
169 // |WAS_INSTALLED_BY_OEM| installed by an OEM (e.g on Chrome OS) and should
170 // be placed in a special OEM folder in the App Launcher. Note: OEM apps are
171 // also installed by Default (i.e. WAS_INSTALLED_BY_DEFAULT is also true).
172 WAS_INSTALLED_BY_OEM = 1 << 10,
175 static scoped_refptr<Extension> Create(const base::FilePath& path,
176 Manifest::Location location,
177 const base::DictionaryValue& value,
181 // In a few special circumstances, we want to create an Extension and give it
182 // an explicit id. Most consumers should just use the other Create() method.
183 static scoped_refptr<Extension> Create(const base::FilePath& path,
184 Manifest::Location location,
185 const base::DictionaryValue& value,
187 const ExtensionId& explicit_id,
190 // Valid schemes for web extent URLPatterns.
191 static const int kValidWebExtentSchemes;
193 // Valid schemes for host permission URLPatterns.
194 static const int kValidHostPermissionSchemes;
196 // The mimetype used for extensions.
197 static const char kMimeType[];
199 // Checks to see if the extension has a valid ID.
200 static bool IdIsValid(const std::string& id);
202 // See Type definition in Manifest.
203 Manifest::Type GetType() const;
205 // Returns an absolute url to a resource inside of an extension. The
206 // |extension_url| argument should be the url() from an Extension object. The
207 // |relative_path| can be untrusted user input. The returned URL will either
208 // be invalid() or a child of |extension_url|.
209 // NOTE: Static so that it can be used from multiple threads.
210 static GURL GetResourceURL(const GURL& extension_url,
211 const std::string& relative_path);
212 GURL GetResourceURL(const std::string& relative_path) const {
213 return GetResourceURL(url(), relative_path);
216 // Returns true if the resource matches a pattern in the pattern_set.
217 bool ResourceMatches(const URLPatternSet& pattern_set,
218 const std::string& resource) const;
220 // Returns an extension resource object. |relative_path| should be UTF8
222 ExtensionResource GetResource(const std::string& relative_path) const;
224 // As above, but with |relative_path| following the file system's encoding.
225 ExtensionResource GetResource(const base::FilePath& relative_path) const;
227 // |input| is expected to be the text of an rsa public or private key. It
228 // tolerates the presence or absence of bracking header/footer like this:
229 // -----(BEGIN|END) [RSA PUBLIC/PRIVATE] KEY-----
230 // and may contain newlines.
231 static bool ParsePEMKeyBytes(const std::string& input, std::string* output);
233 // Does a simple base64 encoding of |input| into |output|.
234 static bool ProducePEM(const std::string& input, std::string* output);
236 // Expects base64 encoded |input| and formats into |output| including
237 // the appropriate header & footer.
238 static bool FormatPEMForFileOutput(const std::string& input,
242 // Returns the base extension url for a given |extension_id|.
243 static GURL GetBaseURLFromExtensionId(const ExtensionId& extension_id);
245 // DEPRECATED: These methods have been moved to PermissionsData.
246 // TODO(rdevlin.cronin): remove these once all calls have been updated.
247 bool HasAPIPermission(APIPermission::ID permission) const;
248 bool HasAPIPermission(const std::string& permission_name) const;
249 scoped_refptr<const PermissionSet> GetActivePermissions() const;
251 // Whether context menu should be shown for page and browser actions.
252 bool ShowConfigureContextMenus() const;
254 // Returns true if this extension or app includes areas within |origin|.
255 bool OverlapsWithOrigin(const GURL& origin) const;
257 // Returns true if the extension requires a valid ordinal for sorting, e.g.,
258 // for displaying in a launcher or new tab page.
259 bool RequiresSortOrdinal() const;
261 // Returns true if the extension should be displayed in the app launcher.
262 bool ShouldDisplayInAppLauncher() const;
264 // Returns true if the extension should be displayed in the browser NTP.
265 bool ShouldDisplayInNewTabPage() const;
267 // Returns true if the extension should be displayed in the extension
268 // settings page (i.e. chrome://extensions).
269 bool ShouldDisplayInExtensionSettings() const;
271 // Returns true if the extension should not be shown anywhere. This is
272 // mostly the same as the extension being a component extension, but also
273 // includes non-component apps that are hidden from the app launcher and ntp.
274 bool ShouldNotBeVisible() const;
276 // Get the manifest data associated with the key, or NULL if there is none.
277 // Can only be called after InitValue is finished.
278 ManifestData* GetManifestData(const std::string& key) const;
280 // Sets |data| to be associated with the key. Takes ownership of |data|.
281 // Can only be called before InitValue is finished. Not thread-safe;
282 // all SetManifestData calls should be on only one thread.
283 void SetManifestData(const std::string& key, ManifestData* data);
287 const base::FilePath& path() const { return path_; }
288 const GURL& url() const { return extension_url_; }
289 Manifest::Location location() const;
290 const ExtensionId& id() const;
291 const base::Version* version() const { return version_.get(); }
292 const std::string VersionString() const;
293 const std::string& name() const { return name_; }
294 const std::string& short_name() const { return short_name_; }
295 const std::string& non_localized_name() const { return non_localized_name_; }
296 // Base64-encoded version of the key used to sign this extension.
297 // In pseudocode, returns
298 // base::Base64Encode(RSAPrivateKey(pem_file).ExportPublicKey()).
299 const std::string& public_key() const { return public_key_; }
300 const std::string& description() const { return description_; }
301 int manifest_version() const { return manifest_version_; }
302 bool converted_from_user_script() const {
303 return converted_from_user_script_;
305 PermissionsData* permissions_data() { return permissions_data_.get(); }
306 const PermissionsData* permissions_data() const {
307 return permissions_data_.get();
310 // Appends |new_warning[s]| to install_warnings_.
311 void AddInstallWarning(const InstallWarning& new_warning);
312 void AddInstallWarnings(const std::vector<InstallWarning>& new_warnings);
313 const std::vector<InstallWarning>& install_warnings() const {
314 return install_warnings_;
316 const extensions::Manifest* manifest() const {
317 return manifest_.get();
319 bool wants_file_access() const { return wants_file_access_; }
320 // TODO(rdevlin.cronin): This is needed for ContentScriptsHandler, and should
321 // be moved out as part of crbug.com/159265. This should not be used anywhere
323 void set_wants_file_access(bool wants_file_access) {
324 wants_file_access_ = wants_file_access;
326 int creation_flags() const { return creation_flags_; }
327 bool from_webstore() const { return (creation_flags_ & FROM_WEBSTORE) != 0; }
328 bool from_bookmark() const { return (creation_flags_ & FROM_BOOKMARK) != 0; }
329 bool was_installed_by_default() const {
330 return (creation_flags_ & WAS_INSTALLED_BY_DEFAULT) != 0;
332 bool was_installed_by_oem() const {
333 return (creation_flags_ & WAS_INSTALLED_BY_OEM) != 0;
335 bool is_ephemeral() const { return (creation_flags_ & IS_EPHEMERAL) != 0; }
339 bool is_platform_app() const;
340 bool is_hosted_app() const;
341 bool is_legacy_packaged_app() const;
342 bool is_extension() const;
343 bool can_be_incognito_enabled() const;
345 void AddWebExtentPattern(const URLPattern& pattern);
346 const URLPatternSet& web_extent() const { return extent_; }
349 bool is_theme() const;
352 friend class base::RefCountedThreadSafe<Extension>;
354 // Chooses the extension ID for an extension based on a variety of criteria.
355 // The chosen ID will be set in |manifest|.
356 static bool InitExtensionID(extensions::Manifest* manifest,
357 const base::FilePath& path,
358 const ExtensionId& explicit_id,
360 base::string16* error);
362 Extension(const base::FilePath& path,
363 scoped_ptr<extensions::Manifest> manifest);
364 virtual ~Extension();
366 // Initialize the extension from a parsed manifest.
367 // TODO(aa): Rename to just Init()? There's no Value here anymore.
368 // TODO(aa): It is really weird the way this class essentially contains a copy
369 // of the underlying DictionaryValue in its members. We should decide to
370 // either wrap the DictionaryValue and go with that only, or we should parse
371 // into strong types and discard the value. But doing both is bad.
372 bool InitFromValue(int flags, base::string16* error);
374 // The following are helpers for InitFromValue to load various features of the
375 // extension from the manifest.
377 bool LoadRequiredFeatures(base::string16* error);
378 bool LoadName(base::string16* error);
379 bool LoadVersion(base::string16* error);
381 bool LoadAppFeatures(base::string16* error);
382 bool LoadExtent(const char* key,
383 URLPatternSet* extent,
384 const char* list_error,
385 const char* value_error,
386 base::string16* error);
388 bool LoadSharedFeatures(base::string16* error);
389 bool LoadDescription(base::string16* error);
390 bool LoadManifestVersion(base::string16* error);
391 bool LoadShortName(base::string16* error);
393 bool CheckMinimumChromeVersion(base::string16* error) const;
395 // The extension's human-readable name. Name is used for display purpose. It
396 // might be wrapped with unicode bidi control characters so that it is
397 // displayed correctly in RTL context.
398 // NOTE: Name is UTF-8 and may contain non-ascii characters.
401 // A non-localized version of the extension's name. This is useful for
403 std::string non_localized_name_;
405 // A short version of the extension's name. This can be used as an alternative
406 // to the name where there is insufficient space to display the full name. If
407 // an extension has not explicitly specified a short name, the value of this
408 // member variable will be the full name rather than an empty string.
409 std::string short_name_;
411 // The version of this extension's manifest. We increase the manifest
412 // version when making breaking changes to the extension system.
413 // Version 1 was the first manifest version (implied by a lack of a
414 // manifest_version attribute in the extension's manifest). We initialize
415 // this member variable to 0 to distinguish the "uninitialized" case from
416 // the case when we know the manifest version actually is 1.
417 int manifest_version_;
419 // The absolute path to the directory the extension is stored in.
420 base::FilePath path_;
422 // Defines the set of URLs in the extension's web content.
423 URLPatternSet extent_;
425 scoped_ptr<PermissionsData> permissions_data_;
427 // Any warnings that occurred when trying to create/parse the extension.
428 std::vector<InstallWarning> install_warnings_;
430 // The base extension url for the extension.
433 // The extension's version.
434 scoped_ptr<base::Version> version_;
436 // An optional longer description of the extension.
437 std::string description_;
439 // True if the extension was generated from a user script. (We show slightly
440 // different UI if so).
441 bool converted_from_user_script_;
443 // The public key used to sign the contents of the crx package.
444 std::string public_key_;
446 // The manifest from which this extension was created.
447 scoped_ptr<Manifest> manifest_;
449 // Stored parsed manifest data.
450 ManifestDataMap manifest_data_;
452 // Set to true at the end of InitValue when initialization is finished.
453 bool finished_parsing_manifest_;
455 // Ensures that any call to GetManifestData() prior to finishing
456 // initialization happens from the same thread (this can happen when certain
457 // parts of the initialization process need information from previous parts).
458 base::ThreadChecker thread_checker_;
460 // Should this app be shown in the app launcher.
461 bool display_in_launcher_;
463 // Should this app be shown in the browser New Tab Page.
464 bool display_in_new_tab_page_;
466 // Whether the extension has host permissions or user script patterns that
467 // imply access to file:/// scheme URLs (the user may not have actually
468 // granted it that access).
469 bool wants_file_access_;
471 // The flags that were passed to InitFromValue.
474 DISALLOW_COPY_AND_ASSIGN(Extension);
477 typedef std::vector<scoped_refptr<const Extension> > ExtensionList;
478 typedef std::set<ExtensionId> ExtensionIdSet;
479 typedef std::vector<ExtensionId> ExtensionIdList;
481 // Handy struct to pass core extension info around.
482 struct ExtensionInfo {
483 ExtensionInfo(const base::DictionaryValue* manifest,
484 const ExtensionId& id,
485 const base::FilePath& path,
486 Manifest::Location location);
489 scoped_ptr<base::DictionaryValue> extension_manifest;
490 ExtensionId extension_id;
491 base::FilePath extension_path;
492 Manifest::Location extension_location;
495 DISALLOW_COPY_AND_ASSIGN(ExtensionInfo);
498 struct InstalledExtensionInfo {
499 // The extension being installed - this should always be non-NULL.
500 const Extension* extension;
502 // True if the extension is being updated; false if it is being installed.
505 // The name of the extension prior to this update. Will be empty if
506 // |is_update| is false.
507 std::string old_name;
509 InstalledExtensionInfo(const Extension* extension,
511 const std::string& old_name);
514 struct UnloadedExtensionInfo {
515 // TODO(DHNishi): Move this enum to ExtensionRegistryObserver.
517 REASON_DISABLE, // Extension is being disabled.
518 REASON_UPDATE, // Extension is being updated to a newer version.
519 REASON_UNINSTALL, // Extension is being uninstalled.
520 REASON_TERMINATE, // Extension has terminated.
521 REASON_BLACKLIST, // Extension has been blacklisted.
526 // The extension being unloaded - this should always be non-NULL.
527 const Extension* extension;
529 UnloadedExtensionInfo(const Extension* extension, Reason reason);
532 // The details sent for EXTENSION_PERMISSIONS_UPDATED notifications.
533 struct UpdatedExtensionPermissionsInfo {
535 ADDED, // The permissions were added to the extension.
536 REMOVED, // The permissions were removed from the extension.
541 // The extension who's permissions have changed.
542 const Extension* extension;
544 // The permissions that have changed. For Reason::ADDED, this would contain
545 // only the permissions that have added, and for Reason::REMOVED, this would
546 // only contain the removed permissions.
547 const PermissionSet* permissions;
549 UpdatedExtensionPermissionsInfo(
550 const Extension* extension,
551 const PermissionSet* permissions,
555 } // namespace extensions
557 #endif // EXTENSIONS_COMMON_EXTENSION_H_