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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
1) The <head> information in this page is significant, should be uniform
across api docs and should be edited only with knowledge of the
templating mechanism.
3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
browser, it will be re-generated from the template, json schema and
authored overview content.
4) The <body>.innerHTML is also generated by an offline step so that this
page may easily be indexed by search engines.
--><html xmlns="http://www.w3.org/1999/xhtml"><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
<link href="css/print.css" rel="stylesheet" type="text/css" media="print">
<script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
</script>
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>Permission Warnings - Google Chrome Extensions - Google Code</title></head>
<body> <div id="devModeWarning" class="displayModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
</div>
<div id="branchWarning" class="displayModeWarning">
<span>WARNING: This is the <span id="branchName">BETA</span> documentation.
It may not work with the stable release of Chrome.</span>
<select id="branchChooser">
<option>Choose a different version...
</option><option value="">Stable
</option><option value="beta">Beta
</option><option value="dev">Dev
</option><option value="trunk">Trunk
</option></select>
</div>
<div id="unofficialWarning" class="displayModeWarning">
<span>WARNING: This is unofficial documentation. It may not work with the
current release of Chrome.</span>
<button id="goToOfficialDocs">Go to the official docs</button>
</div>
<div id="gc-container" class="labs">
<!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
<!-- In particular, sub-templates that recurse, must be used by allowing
jstemplate to make a copy of the template in this section which
are not operated on by way of the jsskip="true" -->
<!-- /SUBTEMPLATES -->
<a id="top"></a>
<div id="skipto">
<a href="#gc-pagecontent">Skip to page content</a>
<a href="#gc-toc">Skip to main navigation</a>
</div>
<!-- API HEADER -->
<table id="header" width="100%" cellspacing="0" border="0">
<tbody><tr>
<td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>
<td valign="middle" width="100%" style="padding-left:0.6em;">
<form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
<div id="gsc-search-box">
<input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" value="" size="55">
<input class="gsc-search-button" type="submit" name="sa" value="Search">
<br>
<span class="greytext">e.g. "page action" or "tabs"</span>
</div>
</form>
<script type="text/javascript" src="https://www.google.com/jsapi"></script>
<script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
<script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>
<script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>
</td>
</tr>
</tbody></table>
<div id="codesiteContent" class="">
<a id="gc-topnav-anchor"></a>
<div id="gc-topnav">
<h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>
<ul id="home" class="gc-topnav-tabs">
<li id="home_link">
<a href="index.html" title="Google Chrome Extensions home page">Home</a>
</li>
<li id="docs_link">
<a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>
</li>
<li id="faq_link">
<a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>
</li>
<li id="samples_link">
<a href="samples.html" title="Sample extensions (with source code)">Samples</a>
</li>
<li id="group_link">
<a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>
</li>
<li id="so_link">
<a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
</li>
</ul>
</div> <!-- end gc-topnav -->
<div class="g-section g-tpl-170">
<!-- SIDENAV -->
<div class="g-unit g-first" id="gc-toc">
<ul>
<li><a href="getstarted.html">Getting Started</a></li>
<li><a href="overview.html">Overview</a></li>
<li><a href="whats_new.html">What's New?</a></li>
<li><h2><a href="devguide.html">Developer's Guide</a></h2>
<ul>
<li>Browser UI
<ul>
<li><a href="browserAction.html">Browser Actions</a></li>
<li><a href="contextMenus.html">Context Menus</a></li>
<li><a href="notifications.html">Desktop Notifications</a></li>
<li><a href="omnibox.html">Omnibox</a></li>
<li><a href="options.html">Options Pages</a></li>
<li><a href="override.html">Override Pages</a></li>
<li><a href="pageAction.html">Page Actions</a></li>
</ul>
</li>
<li>Browser Interaction
<ul>
<li><a href="bookmarks.html">Bookmarks</a></li>
<li><a href="cookies.html">Cookies</a></li>
<li><a href="devtools.html">Developer Tools</a></li>
<li><a href="events.html">Events</a></li>
<li><a href="history.html">History</a></li>
<li><a href="management.html">Management</a></li>
<li><a href="tabs.html">Tabs</a></li>
<li><a href="windows.html">Windows</a></li>
</ul>
</li>
<li>Implementation
<ul>
<li><a href="a11y.html">Accessibility</a></li>
<li><a href="background_pages.html">Background Pages</a></li>
<li><a href="content_scripts.html">Content Scripts</a></li>
<li><a href="xhr.html">Cross-Origin XHR</a></li>
<li><a href="i18n.html">Internationalization</a></li>
<li><a href="messaging.html">Message Passing</a></li>
<li><a href="permissions.html">Optional Permissions</a></li>
<li><a href="npapi.html">NPAPI Plugins</a></li>
</ul>
</li>
<li>Finishing
<ul>
<li><a href="hosting.html">Hosting</a></li>
<li><a href="external_extensions.html">Other Deployment Options</a></li>
</ul>
</li>
</ul>
</li>
<li><h2><a href="apps.html">Packaged Apps</a></h2></li>
<li><h2><a href="tutorials.html">Tutorials</a></h2>
<ul>
<li><a href="tut_debugging.html">Debugging</a></li>
<li><a href="tut_analytics.html">Google Analytics</a></li>
<li><a href="tut_oauth.html">OAuth</a></li>
</ul>
</li>
<li><h2>Reference</h2>
<ul>
<li>Formats
<ul>
<li><a href="manifest.html">Manifest Files</a></li>
<li><a href="match_patterns.html">Match Patterns</a></li>
</ul>
</li>
<li class="leftNavSelected">Permission Warnings</li>
<li><a href="api_index.html">chrome.* APIs</a></li>
<li><a href="api_other.html">Other APIs</a></li>
</ul>
</li>
<li><h2><a href="samples.html">Samples</a></h2></li>
<div class="line"> </div>
<li><h2>More</h2>
<ul>
<li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>
<li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>
<li><a href="themes.html">Themes</a></li>
</ul>
</li>
</ul>
</div>
<script>
initToggles();
</script>
<div class="g-unit" id="gc-pagecontent">
<div id="pageTitle">
<h1 class="page_title">Permission Warnings</h1>
</div>
<!-- TABLE OF CONTENTS -->
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
<a href="#examples"> Examples of permission warnings </a>
<ol>
</ol>
</li><li>
<a href="#warnings"> Warnings and their triggers </a>
<ol>
</ol>
</li><li>
<a href="#nowarning"> Permissions that don't cause warnings </a>
<ol>
</ol>
</li><li>
<a href="#test"> Testing permission warnings </a>
<ol>
</ol>
</li><li>
<a href="#api">API</a>
<ol>
</ol>
</li>
</ol>
</div>
<!-- /TABLE OF CONTENTS -->
<!-- Standard content lead-in for experimental API pages -->
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static"><div id="pageData-name" class="pageData">Permission Warnings</div>
<div id="pageData-showTOC" class="pageData">true</div>
<!--
NOTE: When this doc is updated, the online help should also be updated:
http://www.google.com/support/chrome_webstore/bin/answer.py?hl=en&answer=186213
We should periodically look at
http://src.chromium.org/viewvc/chrome/trunk/src/chrome/app/generated_resources.grd?view=markup
to make sure that we're covering all messages. Search for
IDS_EXTENSION_PROMPT_WARNING
(e.g. IDS_EXTENSION_PROMPT_WARNING_BROWSING_HISTORY).
-->
<p>
To use most chrome.* APIs and extension capabilities,
your extension must declare its intent in the
<a href="manifest.html">manifest</a>,
often in the "permissions" field.
Some of these declarations
result in a warning when
a user installs your extension.
</p>
<p>
When you autoupdate your extension,
the user might see another warning
if the extension requests new permissions.
These new permissions might be new APIs that your extension uses,
or they might be new websites
that your extension needs access to.
</p>
<h2 id="examples"> Examples of permission warnings </h2>
<p>
Here's a typical dialog
that a user might see when installing an extension:
</p>
<img src="images/perms-hw1.png" width="410" height="193" alt="Permission warning: 'It can access: Your data on api.flickr.com'">
<p>
The warning about access to data on api.flickr.com
is caused by the following lines
in the extension's manifest:
</p>
<pre>"permissions": [
<b>"http://api.flickr.com/"</b>
],
</pre>
<p class="note">
<b>Note:</b>
You don't see permission warnings when
you load an unpacked extension.
You get permission warnings only when you install an extension
from a <code>.crx</code> file.
</p>
<p>
If you add a permission to the extension when you autoupdate it,
the user might see a new permission warning.
For example,
assume you add a new site and the "tabs" permission
to the previous example:
</p>
<pre>"permissions": [
"http://api.flickr.com/",
<b>"http://*.flickr.com/",
"tabs"</b>
],
</pre>
<p>
When the extension autoupdates,
the increased permissions
cause the extension to be disabled
until the user re-enables it.
Here's the warning the user sees:
</p>
<img src="images/perms-hw2-disabled.png" width="814" height="30" alt="Warning text: 'The newest version of the extension Hello World requires more permissions, so it has been disabled. [Re-enable].'">
<p>
Clicking the Re-enable button
brings up the following warning:
</p>
<img src="images/perms-hw2.png" width="412" height="220" alt="Permission warning: 'It can access: Your data on api.flickr.com and flickr.com; Your browsing history'">
<h2 id="warnings"> Warnings and their triggers </h2>
<p>
It can be surprising when adding a permission such as "tabs"
results in the seemingly unrelated warning
that the extension can access your browsing activity.
The reason for the warning is that
although the <code>chrome.tabs</code> API
might be used only to open new tabs,
it can also be used to see the URL that's associated
with every newly opened tab
(using their <a href="tabs.html#type-Tab">Tab</a> objects).
</p>
<p class="note">
<b>Note:</b>
As of Google Chrome 7,
you no longer need to specify the "tabs" permission
just to call <code>chrome.tabs.create()</code>
or <code>chrome.tabs.update()</code>.
</p>
<p>
The following table lists the warning messages
that users can see,
along with the manifest entries
that trigger them.
</p>
<p>
</p><table>
<tbody><tr>
<th>Warning message</th> <th>Manifest entry that causes it</th> <th>Notes</th>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_FULL_ACCESS -->
All data on your computer and the websites you visit
</td>
<td>
"plugins"
</td>
<td>
The "plugins" permission is required by
<a href="npapi.html">NPAPI plugins</a>.
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_BOOKMARKS -->
Your bookmarks
</td>
<td>
"bookmarks" permission
</td>
<td>
The "bookmarks" permission is required by the
<a href="bookmarks.html"><code>chrome.bookmarks</code></a> module.
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_BROWSING_HISTORY -->
Your browsing history
</td>
<td>
<!-- HasEffectiveBrowsingHistoryPermission -->
"history" permission
</td>
<td>
<p>
The "history" permission is required by
<a href="history.html"><code>chrome.history</code></a>.
</p>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_TABS -->
Your tabs and browsing activity
</td>
<td>
<!-- HasEffectiveBrowsingHistoryPermission -->
Any of the following:
<ul>
<li> "tabs" permission </li>
<li> "webNavigation" permission </li>
</ul>
</td>
<td>
<p>
The "tabs" permission is required by the
<a href="tabs.html"><code>chrome.tabs</code></a> and
<a href="windows.html"><code>chrome.windows</code></a> modules.
</p>
<p>
The "webNavigation" permission is required by the
<a href="webNavigation.html"><code>chrome.webNavigation</code></a> module.
</p>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_CONTENT_SETTINGS -->
Settings that specify whether websites can use features such as cookies, JavaScript, and plug-ins
</td>
<td>
<!-- HasEffectiveBrowsingHistoryPermission -->
"contentSettings" permission
</td>
<td>
<p>
The "contentSettings" permission is required by
<a href="contentSettings.html"><code>chrome.contentSettings</code></a>.
</p>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_ALL_HOSTS -->
Your data on all websites
</td>
<td>
<!-- HasEffectiveAccessToAllHosts() -->
Any of the following:
<ul>
<li> "debugger" permission </li>
<li> "proxy" permission </li>
<li> A match pattern in the "permissions" field
that matches all hosts </li>
<li> A "content_scripts" field with a "matches" entry
that matches all hosts </li>
<li> "devtools_page" </li>
</ul>
</td>
<td>
<p>
The "debugger" permission is required by the experimental
<a href="experimental.debugger.html">debugger</a> module.
</p>
<p>
The "proxy" permission is required by the
<a href="proxy.html"><code>chrome.proxy</code></a> module.
</p>
<p>
Any of the following URLs match all hosts:
</p>
<ul>
<li> <code>http://*/*</code> </li>
<li> <code>https://*/*</code> </li>
<li> <code>*://*/*</code> </li>
<li> <code><all_urls></code> </li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_?_HOST -->
<!-- IDS_EXTENSION_PROMPT_WARNING_4_OR_MORE_HOSTS -->
Your data on <em>{list of websites}</em>
</td>
<td>
A match pattern in the "permissions" field
that specifies one or more hosts,
but not all hosts
</td>
<td>
<p>
Up to 3 sites are listed by name.
Subdomains aren't treated specially.
For example, <code>a.com</code> and <code>b.a.com</code>
are listed as different sites.
</p>
<p>
On autoupdate,
the user sees a permission warning
if the extension adds or changes sites.
For example, going from <code>a.com,b.com</code>
to <code>a.com,b.com,c.com</code>
triggers a warning.
Going from <code>b.a.com</code>
to <code>a.com</code>,
or vice versa,
also triggers a warning.
</p>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_MANAGEMENT -->
Your list of apps, extensions, and themes
<br>
<span style="font-weight:normal; font-style:italic">or</span>
<br>
Manage themes, extensions, and apps
<!-- PENDING: remove "Manage...apps" alternative message
once the fix is out on stable channel -->
<!-- See http://crbug.com/67859 -->
</td>
<td>
"management" permission
</td>
<td>
The "management" permission is required by the
<a href="management.html"><code>chrome.management</code></a> module.
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_GEOLOCATION -->
Your physical location
</td>
<td>
"geolocation" permission
</td>
<td>
Allows the extension to use the proposed HTML5
<a href="http://dev.w3.org/geo/api/spec-source.html">geolocation API</a>
without prompting the user for permission.
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_CLIPBOARD-->
Data you copy and paste
</td>
<td>
"clipboardRead" permission
</td>
<td>
Allows the extension to use the following editing commands with
<code>document.execCommand()</code>:
<ul>
<li> <code>"copy"</code> </li>
<li> <code>"cut"</code> </li>
</ul>
</td>
</tr>
<tr>
<td style="font-weight:bold">
<!-- IDS_EXTENSION_PROMPT_WARNING_PRIVACY-->
Privacy-related settings
</td>
<td>
"privacy" permission
</td>
<td>
The "privacy" permission is required by the
<a href="privacy.html"><code>chrome.privacy</code></a> module.
</td>
</tr>
</tbody></table>
<p></p>
<h2 id="nowarning"> Permissions that don't cause warnings </h2>
<p>
The following permissions don't result in a warning:
</p>
<ul>
<li>"chrome://favicon/"</li>
<li>"clipboardWrite"</li>
<li>"contextMenus"</li>
<li>"cookies"</li>
<li>"experimental"</li>
<li>"idle"</li>
<li>"notifications"</li>
<li>"unlimitedStorage"</li>
<li>"webRequest"</li>
<li>"webRequestBlocking"</li>
</ul>
<h2 id="test"> Testing permission warnings </h2>
<p>
If you'd like to see exactly which warnings your users will get,
<a href="packaging.html">package your extension</a>
into a <code>.crx</code> file,
and install it.
</p>
<p>
To see the warnings users will get when your extension is autoupdated,
you can go to a little more trouble
and set up an autoupdate server.
To do this, first create an update manifest
and point to it from your extension,
using the "update_url" key
(see <a href="autoupdate.html">Autoupdating</a>).
Next, <a href="packaging.html">package the extension</a>
into a new <code>.crx</code> file,
and install the app from this <code>.crx</code> file.
Now, change the extension's manifest to contain the new permissions,
and <a href="packaging.html#update">repackage the extension</a>.
Finally, update the extension
(and all other extensions that have outstanding updates)
by clicking the <b>chrome://extensions</b> page's
<b>Update extensions now</b> button.
</p>
<h2 id="api">API</h2>
<p>
You can get a list of permission warnings for any manifest with
<a href="management.html#method-getPermissionWarnings">chrome.management.getPermissionWarnings()</a>.
</p>
</div>
<!-- API PAGE -->
<!-- /apiPage -->
</div> <!-- /gc-pagecontent -->
</div> <!-- /g-section -->
</div> <!-- /codesiteContent -->
<div id="gc-footer" --="">
<div class="text">
<p>
Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
<p>
©2011 Google
</p>
<!-- begin analytics -->
<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>
<script type="text/javascript">
// chrome doc tracking
try {
var engdocs = _gat._getTracker("YT-10763712-2");
engdocs._trackPageview();
} catch(err) {}
// code.google.com site-wide tracking
try {
_uacct="UA-18071-1";
_uanchor=1;
_uff=0;
urchinTracker();
}
catch(e) {/* urchinTracker not available. */}
</script>
<!-- end analytics -->
</div>
</div> <!-- /gc-footer -->
</div> <!-- /gc-container -->
</body></html>
|
