summaryrefslogtreecommitdiff
path: root/docs/permissions.md
blob: b2b1a34ca3dedbcf484a59ca50c960b15bc6207e (plain)
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
# Yomichan Permissions

* `<all_urls>` <br>
  Yomichan requires access to all URLs in order to run scripts to scan text and show the definitions popup,
  request audio for playback and download, and connect with Anki.

* `storage` and `unlimitedStorage` <br>
  Yomichan uses storage permissions in order to save extension settings and dictionary data.
  `unlimitedStorage` is used to help prevent web browsers from unexpectedly
  deleting dictionary data.

* `declarativeNetRequest` <br>
  Yomichan uses this permission to ensure certain requests have valid and secure headers.
  This sometimes involves removing or changing the `Origin` request header,
  as this can be used to fingerprint browser configuration.

* `scripting` <br>
  Yomichan needs to inject content scripts and stylesheets into webpages in order to
  properly display the search popup.

* `offscreen` _(Chrome only)_ <br>
  Yomitan uses this permission to create a secondary backend document that has DOM access, given that Manifest v3
  service workers do not. Service workers can then reach out to out to this document in order to complete
  actions that require access to DOM APIs, such as any that require clipboard access.

* `clipboardWrite` <br>
  Yomichan supports simulating the `Ctrl+C` (copy to clipboard) keyboard shortcut
  when a definitions popup is open and focused.

* `clipboardRead` _(optional)_ <br>
  Yomichan supports automatically opening a search window when Japanese text is copied to the clipboard
  while the browser is running, depending on how certain settings are configured.
  This allows Yomichan to support scanning text from external applications, provided there is a way
  to copy text from those applications to the clipboard.

* `nativeMessaging` _(optional, unavailable on Firefox for Android)_ <br>
  Yomichan has the ability to communicate with an optional native messaging component in order to support
  parsing large blocks of Japanese text using
  [MeCab](https://en.wikipedia.org/wiki/MeCab).
  The installation of this component is optional and is not included by default.