Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(648)

Side by Side Diff: chrome/common/extensions/extension.h

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

Powered by Google App Engine
This is Rietveld 408576698