summaryrefslogtreecommitdiff
path: root/docs/permissions.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/permissions.md')
-rw-r--r--docs/permissions.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/permissions.md b/docs/permissions.md
new file mode 100644
index 00000000..8156c746
--- /dev/null
+++ b/docs/permissions.md
@@ -0,0 +1,31 @@
+# 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.
+
+* `webRequest` and `webRequestBlocking` <br>
+ Yomichan uses these permissions 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.
+
+* `nativeMessaging` <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.
+
+* `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.