extension.h revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9
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. 4 5#ifndef EXTENSIONS_COMMON_EXTENSION_H_ 6#define EXTENSIONS_COMMON_EXTENSION_H_ 7 8#include <algorithm> 9#include <iosfwd> 10#include <map> 11#include <set> 12#include <string> 13#include <utility> 14#include <vector> 15 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" 31#include "url/gurl.h" 32 33class ExtensionAction; 34class SkBitmap; 35 36namespace base { 37class DictionaryValue; 38class Version; 39} 40 41namespace gfx { 42class ImageSkia; 43} 44 45namespace extensions { 46class PermissionsData; 47class APIPermissionSet; 48class ManifestPermissionSet; 49class PermissionSet; 50 51// Uniquely identifies an Extension, using 32 characters from the alphabet 52// 'a'-'p'. An empty string represents "no extension". 53// 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. 56typedef std::string ExtensionId; 57 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. 62class Extension : public base::RefCountedThreadSafe<Extension> { 63 public: 64 struct ManifestData; 65 66 typedef std::map<const std::string, linked_ptr<ManifestData> > 67 ManifestDataMap; 68 69 enum State { 70 DISABLED = 0, 71 ENABLED, 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. 77 ENABLED_COMPONENT, 78 NUM_STATES 79 }; 80 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. 88 }; 89 90 enum DisableReason { 91 DISABLE_NONE = 0, 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 101 // the install. 102 DISABLE_GREYLIST = 1 << 9 103 }; 104 105 enum InstallType { 106 INSTALL_ERROR, 107 DOWNGRADE, 108 REINSTALL, 109 UPGRADE, 110 NEW_INSTALL 111 }; 112 113 // A base class for parsed manifest data that APIs want to store on 114 // the extension. Related to base::SupportsUserData, but with an immutable 115 // thread-safe interface to match Extension. 116 struct ManifestData { 117 virtual ~ManifestData() {} 118 }; 119 120 enum InitFromValueFlags { 121 NO_FLAGS = 0, 122 123 // Usually, the id of an extension is generated by the "key" property of 124 // its manifest, but if |REQUIRE_KEY| is not set, a temporary ID will be 125 // generated based on the path. 126 REQUIRE_KEY = 1 << 0, 127 128 // Requires the extension to have an up-to-date manifest version. 129 // Typically, we'll support multiple manifest versions during a version 130 // transition. This flag signals that we want to require the most modern 131 // manifest version that Chrome understands. 132 REQUIRE_MODERN_MANIFEST_VERSION = 1 << 1, 133 134 // |ALLOW_FILE_ACCESS| indicates that the user is allowing this extension 135 // to have file access. If it's not present, then permissions and content 136 // scripts that match file:/// URLs will be filtered out. 137 ALLOW_FILE_ACCESS = 1 << 2, 138 139 // |FROM_WEBSTORE| indicates that the extension was installed from the 140 // Chrome Web Store. 141 FROM_WEBSTORE = 1 << 3, 142 143 // |FROM_BOOKMARK| indicates the extension is a bookmark app which has been 144 // generated from a web page. Bookmark apps have no permissions or extent 145 // and launch the web page they are created from when run. 146 FROM_BOOKMARK = 1 << 4, 147 148 // |FOLLOW_SYMLINKS_ANYWHERE| means that resources can be symlinks to 149 // anywhere in the filesystem, rather than being restricted to the 150 // extension directory. 151 FOLLOW_SYMLINKS_ANYWHERE = 1 << 5, 152 153 // |ERROR_ON_PRIVATE_KEY| means that private keys inside an 154 // extension should be errors rather than warnings. 155 ERROR_ON_PRIVATE_KEY = 1 << 6, 156 157 // |WAS_INSTALLED_BY_DEFAULT| installed by default when the profile was 158 // created. 159 WAS_INSTALLED_BY_DEFAULT = 1 << 7, 160 161 // Unused - was part of an abandoned experiment. 162 REQUIRE_PERMISSIONS_CONSENT = 1 << 8, 163 164 // |IS_EPHEMERAL| identifies ephemeral apps (experimental), which are not 165 // permanently installed. 166 IS_EPHEMERAL = 1 << 9, 167 }; 168 169 static scoped_refptr<Extension> Create(const base::FilePath& path, 170 Manifest::Location location, 171 const base::DictionaryValue& value, 172 int flags, 173 std::string* error); 174 175 // In a few special circumstances, we want to create an Extension and give it 176 // an explicit id. Most consumers should just use the other Create() method. 177 static scoped_refptr<Extension> Create(const base::FilePath& path, 178 Manifest::Location location, 179 const base::DictionaryValue& value, 180 int flags, 181 const ExtensionId& explicit_id, 182 std::string* error); 183 184 // Valid schemes for web extent URLPatterns. 185 static const int kValidWebExtentSchemes; 186 187 // Valid schemes for host permission URLPatterns. 188 static const int kValidHostPermissionSchemes; 189 190 // The mimetype used for extensions. 191 static const char kMimeType[]; 192 193 // Checks to see if the extension has a valid ID. 194 static bool IdIsValid(const std::string& id); 195 196 // See Type definition in Manifest. 197 Manifest::Type GetType() const; 198 199 // Returns an absolute url to a resource inside of an extension. The 200 // |extension_url| argument should be the url() from an Extension object. The 201 // |relative_path| can be untrusted user input. The returned URL will either 202 // be invalid() or a child of |extension_url|. 203 // NOTE: Static so that it can be used from multiple threads. 204 static GURL GetResourceURL(const GURL& extension_url, 205 const std::string& relative_path); 206 GURL GetResourceURL(const std::string& relative_path) const { 207 return GetResourceURL(url(), relative_path); 208 } 209 210 // Returns true if the resource matches a pattern in the pattern_set. 211 bool ResourceMatches(const URLPatternSet& pattern_set, 212 const std::string& resource) const; 213 214 // Returns an extension resource object. |relative_path| should be UTF8 215 // encoded. 216 ExtensionResource GetResource(const std::string& relative_path) const; 217 218 // As above, but with |relative_path| following the file system's encoding. 219 ExtensionResource GetResource(const base::FilePath& relative_path) const; 220 221 // |input| is expected to be the text of an rsa public or private key. It 222 // tolerates the presence or absence of bracking header/footer like this: 223 // -----(BEGIN|END) [RSA PUBLIC/PRIVATE] KEY----- 224 // and may contain newlines. 225 static bool ParsePEMKeyBytes(const std::string& input, std::string* output); 226 227 // Does a simple base64 encoding of |input| into |output|. 228 static bool ProducePEM(const std::string& input, std::string* output); 229 230 // Expects base64 encoded |input| and formats into |output| including 231 // the appropriate header & footer. 232 static bool FormatPEMForFileOutput(const std::string& input, 233 std::string* output, 234 bool is_public); 235 236 // Returns the base extension url for a given |extension_id|. 237 static GURL GetBaseURLFromExtensionId(const ExtensionId& extension_id); 238 239 // DEPRECATED: These methods have been moved to PermissionsData. 240 // TODO(rdevlin.cronin): remove these once all calls have been updated. 241 bool HasAPIPermission(APIPermission::ID permission) const; 242 bool HasAPIPermission(const std::string& permission_name) const; 243 scoped_refptr<const PermissionSet> GetActivePermissions() const; 244 245 // Whether context menu should be shown for page and browser actions. 246 bool ShowConfigureContextMenus() const; 247 248 // Returns true if this extension or app includes areas within |origin|. 249 bool OverlapsWithOrigin(const GURL& origin) const; 250 251 // Returns true if the extension requires a valid ordinal for sorting, e.g., 252 // for displaying in a launcher or new tab page. 253 bool RequiresSortOrdinal() const; 254 255 // Returns true if the extension should be displayed in the app launcher. 256 bool ShouldDisplayInAppLauncher() const; 257 258 // Returns true if the extension should be displayed in the browser NTP. 259 bool ShouldDisplayInNewTabPage() const; 260 261 // Returns true if the extension should be displayed in the extension 262 // settings page (i.e. chrome://extensions). 263 bool ShouldDisplayInExtensionSettings() const; 264 265 // Returns true if the extension should not be shown anywhere. This is 266 // mostly the same as the extension being a component extension, but also 267 // includes non-component apps that are hidden from the app launcher and ntp. 268 bool ShouldNotBeVisible() const; 269 270 // Get the manifest data associated with the key, or NULL if there is none. 271 // Can only be called after InitValue is finished. 272 ManifestData* GetManifestData(const std::string& key) const; 273 274 // Sets |data| to be associated with the key. Takes ownership of |data|. 275 // Can only be called before InitValue is finished. Not thread-safe; 276 // all SetManifestData calls should be on only one thread. 277 void SetManifestData(const std::string& key, ManifestData* data); 278 279 // Accessors: 280 281 const base::FilePath& path() const { return path_; } 282 const GURL& url() const { return extension_url_; } 283 Manifest::Location location() const; 284 const ExtensionId& id() const; 285 const base::Version* version() const { return version_.get(); } 286 const std::string VersionString() const; 287 const std::string& name() const { return name_; } 288 const std::string& short_name() const { return short_name_; } 289 const std::string& non_localized_name() const { return non_localized_name_; } 290 // Base64-encoded version of the key used to sign this extension. 291 // In pseudocode, returns 292 // base::Base64Encode(RSAPrivateKey(pem_file).ExportPublicKey()). 293 const std::string& public_key() const { return public_key_; } 294 const std::string& description() const { return description_; } 295 int manifest_version() const { return manifest_version_; } 296 bool converted_from_user_script() const { 297 return converted_from_user_script_; 298 } 299 PermissionsData* permissions_data() { return permissions_data_.get(); } 300 const PermissionsData* permissions_data() const { 301 return permissions_data_.get(); 302 } 303 304 // Appends |new_warning[s]| to install_warnings_. 305 void AddInstallWarning(const InstallWarning& new_warning); 306 void AddInstallWarnings(const std::vector<InstallWarning>& new_warnings); 307 const std::vector<InstallWarning>& install_warnings() const { 308 return install_warnings_; 309 } 310 const extensions::Manifest* manifest() const { 311 return manifest_.get(); 312 } 313 bool wants_file_access() const { return wants_file_access_; } 314 // TODO(rdevlin.cronin): This is needed for ContentScriptsHandler, and should 315 // be moved out as part of crbug.com/159265. This should not be used anywhere 316 // else. 317 void set_wants_file_access(bool wants_file_access) { 318 wants_file_access_ = wants_file_access; 319 } 320 int creation_flags() const { return creation_flags_; } 321 bool from_webstore() const { return (creation_flags_ & FROM_WEBSTORE) != 0; } 322 bool from_bookmark() const { return (creation_flags_ & FROM_BOOKMARK) != 0; } 323 bool was_installed_by_default() const { 324 return (creation_flags_ & WAS_INSTALLED_BY_DEFAULT) != 0; 325 } 326 bool is_ephemeral() const { return (creation_flags_ & IS_EPHEMERAL) != 0; } 327 328 // App-related. 329 bool is_app() const; 330 bool is_platform_app() const; 331 bool is_hosted_app() const; 332 bool is_legacy_packaged_app() const; 333 bool is_extension() const; 334 bool can_be_incognito_enabled() const; 335 336 void AddWebExtentPattern(const URLPattern& pattern); 337 const URLPatternSet& web_extent() const { return extent_; } 338 339 // Theme-related. 340 bool is_theme() const; 341 342 private: 343 friend class base::RefCountedThreadSafe<Extension>; 344 345 // Chooses the extension ID for an extension based on a variety of criteria. 346 // The chosen ID will be set in |manifest|. 347 static bool InitExtensionID(extensions::Manifest* manifest, 348 const base::FilePath& path, 349 const ExtensionId& explicit_id, 350 int creation_flags, 351 base::string16* error); 352 353 Extension(const base::FilePath& path, 354 scoped_ptr<extensions::Manifest> manifest); 355 virtual ~Extension(); 356 357 // Initialize the extension from a parsed manifest. 358 // TODO(aa): Rename to just Init()? There's no Value here anymore. 359 // TODO(aa): It is really weird the way this class essentially contains a copy 360 // of the underlying DictionaryValue in its members. We should decide to 361 // either wrap the DictionaryValue and go with that only, or we should parse 362 // into strong types and discard the value. But doing both is bad. 363 bool InitFromValue(int flags, base::string16* error); 364 365 // The following are helpers for InitFromValue to load various features of the 366 // extension from the manifest. 367 368 bool LoadRequiredFeatures(base::string16* error); 369 bool LoadName(base::string16* error); 370 bool LoadVersion(base::string16* error); 371 372 bool LoadAppFeatures(base::string16* error); 373 bool LoadExtent(const char* key, 374 URLPatternSet* extent, 375 const char* list_error, 376 const char* value_error, 377 base::string16* error); 378 379 bool LoadSharedFeatures(base::string16* error); 380 bool LoadDescription(base::string16* error); 381 bool LoadManifestVersion(base::string16* error); 382 bool LoadShortName(base::string16* error); 383 384 bool CheckMinimumChromeVersion(base::string16* error) const; 385 386 // The extension's human-readable name. Name is used for display purpose. It 387 // might be wrapped with unicode bidi control characters so that it is 388 // displayed correctly in RTL context. 389 // NOTE: Name is UTF-8 and may contain non-ascii characters. 390 std::string name_; 391 392 // A non-localized version of the extension's name. This is useful for 393 // debug output. 394 std::string non_localized_name_; 395 396 // A short version of the extension's name. This can be used as an alternative 397 // to the name where there is insufficient space to display the full name. If 398 // an extension has not explicitly specified a short name, the value of this 399 // member variable will be the full name rather than an empty string. 400 std::string short_name_; 401 402 // The version of this extension's manifest. We increase the manifest 403 // version when making breaking changes to the extension system. 404 // Version 1 was the first manifest version (implied by a lack of a 405 // manifest_version attribute in the extension's manifest). We initialize 406 // this member variable to 0 to distinguish the "uninitialized" case from 407 // the case when we know the manifest version actually is 1. 408 int manifest_version_; 409 410 // The absolute path to the directory the extension is stored in. 411 base::FilePath path_; 412 413 // Defines the set of URLs in the extension's web content. 414 URLPatternSet extent_; 415 416 scoped_ptr<PermissionsData> permissions_data_; 417 418 // Any warnings that occurred when trying to create/parse the extension. 419 std::vector<InstallWarning> install_warnings_; 420 421 // The base extension url for the extension. 422 GURL extension_url_; 423 424 // The extension's version. 425 scoped_ptr<base::Version> version_; 426 427 // An optional longer description of the extension. 428 std::string description_; 429 430 // True if the extension was generated from a user script. (We show slightly 431 // different UI if so). 432 bool converted_from_user_script_; 433 434 // The public key used to sign the contents of the crx package. 435 std::string public_key_; 436 437 // The manifest from which this extension was created. 438 scoped_ptr<Manifest> manifest_; 439 440 // Stored parsed manifest data. 441 ManifestDataMap manifest_data_; 442 443 // Set to true at the end of InitValue when initialization is finished. 444 bool finished_parsing_manifest_; 445 446 // Ensures that any call to GetManifestData() prior to finishing 447 // initialization happens from the same thread (this can happen when certain 448 // parts of the initialization process need information from previous parts). 449 base::ThreadChecker thread_checker_; 450 451 // Should this app be shown in the app launcher. 452 bool display_in_launcher_; 453 454 // Should this app be shown in the browser New Tab Page. 455 bool display_in_new_tab_page_; 456 457 // Whether the extension has host permissions or user script patterns that 458 // imply access to file:/// scheme URLs (the user may not have actually 459 // granted it that access). 460 bool wants_file_access_; 461 462 // The flags that were passed to InitFromValue. 463 int creation_flags_; 464 465 DISALLOW_COPY_AND_ASSIGN(Extension); 466}; 467 468typedef std::vector<scoped_refptr<const Extension> > ExtensionList; 469typedef std::set<ExtensionId> ExtensionIdSet; 470typedef std::vector<ExtensionId> ExtensionIdList; 471 472// Handy struct to pass core extension info around. 473struct ExtensionInfo { 474 ExtensionInfo(const base::DictionaryValue* manifest, 475 const ExtensionId& id, 476 const base::FilePath& path, 477 Manifest::Location location); 478 ~ExtensionInfo(); 479 480 scoped_ptr<base::DictionaryValue> extension_manifest; 481 ExtensionId extension_id; 482 base::FilePath extension_path; 483 Manifest::Location extension_location; 484 485 private: 486 DISALLOW_COPY_AND_ASSIGN(ExtensionInfo); 487}; 488 489struct InstalledExtensionInfo { 490 // The extension being installed - this should always be non-NULL. 491 const Extension* extension; 492 493 // True if the extension is being updated; false if it is being installed. 494 bool is_update; 495 496 // The name of the extension prior to this update. Will be empty if 497 // |is_update| is false. 498 std::string old_name; 499 500 InstalledExtensionInfo(const Extension* extension, 501 bool is_update, 502 const std::string& old_name); 503}; 504 505struct UnloadedExtensionInfo { 506 enum Reason { 507 REASON_DISABLE, // Extension is being disabled. 508 REASON_UPDATE, // Extension is being updated to a newer version. 509 REASON_UNINSTALL, // Extension is being uninstalled. 510 REASON_TERMINATE, // Extension has terminated. 511 REASON_BLACKLIST, // Extension has been blacklisted. 512 }; 513 514 Reason reason; 515 516 // The extension being unloaded - this should always be non-NULL. 517 const Extension* extension; 518 519 UnloadedExtensionInfo(const Extension* extension, Reason reason); 520}; 521 522// The details sent for EXTENSION_PERMISSIONS_UPDATED notifications. 523struct UpdatedExtensionPermissionsInfo { 524 enum Reason { 525 ADDED, // The permissions were added to the extension. 526 REMOVED, // The permissions were removed from the extension. 527 }; 528 529 Reason reason; 530 531 // The extension who's permissions have changed. 532 const Extension* extension; 533 534 // The permissions that have changed. For Reason::ADDED, this would contain 535 // only the permissions that have added, and for Reason::REMOVED, this would 536 // only contain the removed permissions. 537 const PermissionSet* permissions; 538 539 UpdatedExtensionPermissionsInfo( 540 const Extension* extension, 541 const PermissionSet* permissions, 542 Reason reason); 543}; 544 545} // namespace extensions 546 547#endif // EXTENSIONS_COMMON_EXTENSION_H_ 548