summaryrefslogtreecommitdiff
path: root/ext/permissions.html
blob: 699aca4fb148efda9893182520e7c9450774b168 (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
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
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Yomichan Permissions</title>
    <link rel="icon" type="image/png" href="/images/icon16.png" sizes="16x16">
    <link rel="icon" type="image/png" href="/images/icon19.png" sizes="19x19">
    <link rel="icon" type="image/png" href="/images/icon32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/images/icon38.png" sizes="38x38">
    <link rel="icon" type="image/png" href="/images/icon48.png" sizes="48x48">
    <link rel="icon" type="image/png" href="/images/icon64.png" sizes="64x64">
    <link rel="icon" type="image/png" href="/images/icon128.png" sizes="128x128">
    <link rel="stylesheet" type="text/css" href="/css/material.css">
    <link rel="stylesheet" type="text/css" href="/css/settings.css">
</head>
<body>

<!-- Main content -->
<div class="content-outer"><div class="content">
<div class="content-center">

    <span tabindex="-1" id="content-scroll-focus"></span>

    <h1>Yomichan Permissions</h1>

    <h2 id="permissions"></h2>
    <div class="settings-group">
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>&lt;all_urls&gt;</code></div>
                <div class="settings-item-description">
                    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.
                </div>
            </div>
        </div></div>
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>storage</code> and <code>unlimitedStorage</code></div>
                <div class="settings-item-description">
                    Yomichan uses storage permissions in order to save extension settings and dictionary data.
                    <code>unlimitedStorage</code> is used to help prevent web browsers from unexpectedly
                    deleting dictionary data.
                </div>
            </div>
        </div></div>
        <div class="settings-item" data-hide-for-manifest-version="3"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>webRequest</code> and <code>webRequestBlocking</code></div>
                <div class="settings-item-description">
                    <p>
                        Yomichan uses these permissions to ensure certain requests have valid and secure headers.
                        This sometimes involves removing or changing the <code>Origin</code> request header,
                        as this can be used to fingerprint browser configuration.
                    </p>
                    <p>
                        Example: <code>Origin: <span class="extension-id-example"></span></code>
                    </p>
                </div>
            </div>
        </div></div>
        <div class="settings-item" data-show-for-manifest-version="3"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>declarativeNetRequest</code></div>
                <div class="settings-item-description">
                    <p>
                        Yomichan uses this permission to ensure certain requests have valid and secure headers.
                        This sometimes involves removing or changing the <code>Origin</code> request header,
                        as this can be used to fingerprint browser configuration.
                    </p>
                    <p>
                        Example: <code>Origin: <span class="extension-id-example"></span></code>
                    </p>
                </div>
            </div>
        </div></div>
        <div class="settings-item" data-show-for-manifest-version="3"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>scripting</code></div>
                <div class="settings-item-description">
                    Yomichan will sometimes need to inject stylesheets into webpages in order to
                    properly display the search popup.
                </div>
            </div>
        </div></div>
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>clipboardWrite</code></div>
                <div class="settings-item-description">
                    Yomichan supports simulating the <code>Ctrl+C</code> (copy to clipboard) keyboard shortcut
                    when a definitions popup is open and focused.
                </div>
            </div>
        </div></div>
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>clipboardRead</code> <span class="light">(optional)</span></div>
                <div class="settings-item-description">
                    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.
                </div>
            </div>
            <div class="settings-item-right">
                <label class="toggle"><input type="checkbox" class="permissions-toggle" data-required-permissions="clipboardRead"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
            </div>
        </div></div>
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label"><code>nativeMessaging</code> <span class="light" data-show-for-browser="chrome edge">(optional)</span></div>
                <div class="settings-item-description">
                    Yomichan has the ability to communicate with an optional native messaging component in order to support
                    parsing large blocks of Japanese text using
                    <a href="https://en.wikipedia.org/wiki/MeCab" target="_blank" rel="noopener noreferrer">MeCab</a>.
                    The installation of this component is optional and is not included by default.
                </div>
            </div>
            <div class="settings-item-right">
                <label class="toggle"><input type="checkbox" class="permissions-toggle" data-required-permissions="nativeMessaging"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
            </div>
        </div></div>
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label">Allow in private windows <span class="light">(optional)</span></div>
                <div class="settings-item-description">
                    <p>
                        When enabled, Yomichan is able to scan text and show definitions in private/incognito web browser windows.
                    </p>
                    <p>
                        This option can be configured from the web browser's extension settings pages.
                    </p>
                </div>
            </div>
            <div class="settings-item-right">
                <label class="toggle"><input type="checkbox" id="permission-checkbox-allow-in-private-windows" disabled><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
            </div>
        </div></div>
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label">Allow access to file URLs <span class="light">(optional)</span></div>
                <div class="settings-item-description">
                    <p>
                        When enabled, Yomichan is able to scan text and show definitions on local HTML files located using the <code>file://*</code> scheme.
                    </p>
                    <p data-show-for-browser="chrome edge">
                        This option can be configured from the web browser's extension settings pages.
                    </p>
                </div>
            </div>
            <div class="settings-item-right">
                <label class="toggle"><input type="checkbox" id="permission-checkbox-allow-file-url-access" disabled><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
            </div>
        </div></div>
        <div class="settings-item"><div class="settings-item-inner">
            <div class="settings-item-left">
                <div class="settings-item-label">Persistent storage</div>
                <div class="settings-item-description">
                    <p>
                        Web browsers will sometimes clear stored data if the device is running low on storage space,
                        which can result in the imported dictionaries being deleted unexpectedly.
                        The persistent storage permission tells the browser that the data should not be deleted in those circumstances.
                    </p>
                    <p data-show-for-browser="firefox-mobile">
                        It may not be possible to enable this permission on Firefox for Android.
                    </p>
                    <p data-show-for-browser="chrome edge">
                        Chromium-based browsers should not need to enable this setting since the Yomichan extension has
                        the <code>unlimitedStorage</code> permission, which should prevent data deletion.<sup><a href="https://bugs.chromium.org/p/chromium/issues/detail?id=680392#c15" target="_blank" rel="noopener">[1]</a></sup>
                    </p>
                </div>
            </div>
            <div class="settings-item-right">
                <label class="toggle"><input type="checkbox" id="storage-persistent-checkbox"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
            </div>
        </div></div>
    </div>

    <div class="footer-padding"></div>

</div>
</div></div>

<!-- Scripts -->
<script src="/js/core.js"></script>

<script src="/js/yomichan.js"></script>

<script src="/js/comm/api.js"></script>
<script src="/js/comm/cross-frame-api.js"></script>
<script src="/js/data/anki-util.js"></script>
<script src="/js/data/permissions-util.js"></script>
<script src="/js/dom/document-focus-controller.js"></script>
<script src="/js/dom/html-template-collection.js"></script>
<script src="/js/pages/settings/permissions-toggle-controller.js"></script>
<script src="/js/pages/settings/persistent-storage-controller.js"></script>
<script src="/js/pages/settings/settings-controller.js"></script>

<script src="/js/pages/permissions-main.js"></script>

</body>
</html>