-
Notifications
You must be signed in to change notification settings - Fork 3
/
background.js
453 lines (391 loc) · 12.4 KB
/
background.js
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
'use strict';
const CENO_ICON = "icons/ceno-logo-32.png";
const CACHE_MAX_ENTRIES = 500;
const OUINET_RESPONSE_VERSION_MIN = 1 // protocol versions accepted
const OUINET_RESPONSE_VERSION_MAX = 6
// Requests for URLs matching the following regular expressions
// will always be considered private (thus non-cacheable).
const NO_CACHE_URL_REGEXPS = [
/^https?:\/\/(www\.)?google\.com\/complete\//, // Google Search completion
/^https?:\/\/(www\.)?duckduckgo\.com\/ac\//, // DuckDuckGo Search completion
]
// Establish connection with application
const port = browser.runtime.connectNative("browser");
// <https://stackoverflow.com/a/4835406>
const htmlEscapes = {
'&': '&',
'<': '<',
'>': '>',
'"': '"',
"'": '''
}
function escapeHtml(s) {
return s.replace(/[&<>"']/g, (c) => htmlEscapes[c]);
}
function removeFragmentFromURL(url) {
return url.replace(/#.*$/, "");
}
function removeSchemeFromURL(url) {
return url.replace(/^[a-z][-+.0-9a-z]*:\/\//i, "");
}
function removeTrailingSlashes(s) {
return s.replace(/\/+$/, "");
}
function removeLeadingWWW(s) {
return s.replace(/^www\./i, "");
}
function isUrlCacheable(url) {
for (const rx of NO_CACHE_URL_REGEXPS)
if (rx.test(url))
return false;
return true;
}
function getDhtGroup(e) {
// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webRequest/onBeforeSendHeaders
let url = e.documentUrl ? e.documentUrl : e.url;
if (!url) return url;
url = removeFragmentFromURL(url);
url = removeSchemeFromURL(url);
url = removeTrailingSlashes(url);
url = removeLeadingWWW(url);
return url;
}
// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webRequest/onBeforeSendHeaders
function onBeforeSendHeaders(e) {
if (e.tabId < 0) {
return;
}
// tabs.get returns a Promise
return browser.tabs.get(e.tabId).then(tab => {
// The `tab` structure is described here:
// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/Tab
let is_private = tab.incognito || !isUrlCacheable(e.url);
e.requestHeaders.push({name: "X-Ouinet-Private", value: (is_private ? "True" : "False")});
if (!is_private) {
e.requestHeaders.push({name: "X-Ouinet-Group", value: getDhtGroup(e)});
}
return {requestHeaders: e.requestHeaders};
});
}
function redirect403ToHttps(e) {
if (e.statusCode == 403 && e.url.startsWith('http:')) {
console.log("Redirecting to HTTPS");
var redirect = new URL(e.url);
redirect.protocol = 'https';
redirect.port = '';
return {redirectUrl: redirect.href};
}
}
// Useful links:
// https://github.com/mdn/webextensions-examples/tree/master/http-response
// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webRequest/onHeadersReceived
// Chrome's webRequest doc is a bit better ATM
// https://developer.chrome.com/extensions/webRequest
var versionError = false;
function redirectWhenUpdateRequired(e) {
if (!versionError) {
for (var i in e.responseHeaders) {
var h = e.responseHeaders[i];
if (h.name.toUpperCase() === "X-OUINET-ERROR") {
var ec = h.value.substring(0, 2);
if (ec === "0 " || ec === "1 ") {
versionError = true;
}
}
}
}
if (versionError && !isAppStoreUrl(e.url)) {
return {
redirectUrl: browser.extension.getURL("update-page/index.html"),
};
}
}
function isValidProtocolVersion(p) {
var pn = Number(p);
if (isNaN(pn) || pn % 1 > 0) {
return false;
}
return (OUINET_RESPONSE_VERSION_MIN <= pn) && (pn <= OUINET_RESPONSE_VERSION_MAX);
}
function findHeader(headers, name) {
var name_u = name.toUpperCase();
for (var i in headers) {
var h = headers[i];
if (h.name.toUpperCase() == name_u) {
return h.value;
}
}
return null;
}
const WARN_THROTTLE_MILLIS = 5 * 60 * 1000
var warningLastShownOn = {} // warning string -> time in milliseconds
function warnWhenUpdateDetected(e) {
var isOuinetMessage = false;
for (var i in e.responseHeaders) {
var h = e.responseHeaders[i];
var hn = h.name.toUpperCase();
if (hn === "X-OUINET-VERSION" && isValidProtocolVersion(h.value)) {
isOuinetMessage = true // hope this comes before other `X-Ouinet-*` headers
} else if (isOuinetMessage && hn === "X-OUINET-WARNING") {
var hv = h.value
// Do not show the same warning if already shown
// in the last `WARN_THROTTLE_MILLIS` milliseconds.
var now = Date.now()
var lastShown = warningLastShownOn[hv] || 0
if (now - lastShown < WARN_THROTTLE_MILLIS) {
continue
}
warningLastShownOn[hv] = now
browser.notifications.create("", {
type: "basic",
title: browser.i18n.getMessage("bgCenoWarning"),
message: escapeHtml(hv)})
}
}
}
var gActiveTabId = 0;
var gOuinetStats = {};
const gOuinetSources = ['origin', 'proxy', 'injector', 'dist-cache', 'local-cache'];
browser.webNavigation.onBeforeNavigate.addListener(details => {
if (details.frameId != 0) return;
const tabId = details.tabId;
gOuinetStats[tabId] = {};
gOuinetStats[tabId]['url'] = details.url;
});
function updateCenoStats(e) {
const tabId = e.tabId;
if (tabId < 0) return;
var src = findHeader(e.responseHeaders, "X-Ouinet-Source");
if (!src) src = "unknown";
if (e.fromCache) src = "local-cache";
if (!gOuinetStats[tabId]) gOuinetStats[tabId] = {};
if (!gOuinetStats[tabId][src]) {
gOuinetStats[tabId][src] = 1;
} else {
gOuinetStats[tabId][src] += 1;
}
browser.storage.local.get('stats', function(data) {
if (!data.stats) { data.stats = {}; }
if (!data.stats[tabId]) { data.stats[tabId] = {}; }
var stats = data.stats[tabId];
if (!gOuinetStats[tabId]) return;
for (const i in gOuinetSources) {
const name = gOuinetSources[i];
const v = gOuinetStats[tabId][name];
stats[name] = v ? v : 0;
}
data.stats[e.tabId] = stats;
browser.storage.local.set(data);
});
// capture current tab id, so stats for it can be sent via native message
gActiveTabId = tabId
}
const APP_STORES = ["play.google.com", "paskoocheh.com", "s3.amazonaws.com"];
function isAppStoreUrl(url) {
const hostname = new URL(url).hostname;
return APP_STORES.includes(hostname);
}
function updateOuinetDetailsFromHeaders(e) {
if (e.tabId < 0) {
return;
}
// Use the URL from the request as the key instead of the URL
// from the tab because if there is a redirect the tab URL has not been updated
// yet
insertCacheEntry(e.tabId, e.url, getOuinetDetails(e.responseHeaders));
}
const INJ_TS_RE = /\bts=([0-9]+)\b/;
function getOuinetDetails(headers) {
var details = {
isProxied: false,
injectionTime: null,
requestTime: Date.now() / 1000, // seconds
};
var no_details = Object.assign({}, details);
var valid_proto = false;
for (var i = 0; i < headers.length; i++) {
switch (headers[i].name.toUpperCase()) {
case "X-OUINET-VERSION":
valid_proto = isValidProtocolVersion(headers[i].value);
break;
case "X-OUINET-INJECTION":
details.isProxied = true;
var ts_match = INJ_TS_RE.exec(headers[i].value);
if (ts_match) {
details.injectionTime = ts_match[1] - 0;
}
break;
}
}
return (valid_proto ? details : no_details);
}
function insertCacheEntry(tabId, url, details) {
browser.storage.local.get('cache', function(data) {
if (!data.cache) {
data.cache = {};
}
if (!data.cache[tabId]) {
data.cache[tabId] = {};
}
if (size(data.cache[tabId]) >= CACHE_MAX_ENTRIES) {
removeOldestEntries(data.cache[tabId]);
}
data.cache[tabId][url] = details;
// Store an entry for the origin as well because single-page-apps,
// change the URL without causing requests.
data.cache[tabId][new URL(url).origin] = details;
browser.storage.local.set(data);
});
}
function removeOldestEntries(entries) {
var array = Object.entries(entries);
array.sort(([k1,v1],[k2,v2]) => v1.requestTime - v2.requestTime);
var i = 0;
while (size(entries) > CACHE_MAX_ENTRIES) {
delete entries[array[i++][0]];
}
}
function size(o) {
return Object.keys(o).length;
}
function setPageActionIcon(tabId, isUsingOuinet) {
if (isUsingOuinet) {
browser.pageAction.show(tabId);
} else {
browser.pageAction.hide(tabId);
}
}
/**
* Updates the icon for the page action using the details
* about the page from local storage.
*/
function setPageActionForTab(tabId) {
getCacheEntry(tabId, (ouinetDetails) => {
var isUsingOuinet = ouinetDetails && ouinetDetails.isProxied;
setPageActionIcon(tabId, true /* isUsingOuinet */);
});
}
function getCacheEntry(tabId, callback) {
return browser.storage.local.get('cache', function(data) {
if (!data.cache || !data.cache[tabId]) {
callback(undefined);
return;
}
browser.tabs.get(tabId)
.then((tab) => {
var fromUrl = data.cache[tabId][tab.url];
if (fromUrl) {
callback(fromUrl);
return;
}
var origin = new URL(tab.url).origin;
callback(data.cache[tabId][origin]);
});
});
}
/**
* Remove entries from local storage when tab is removed.
*/
function removeCacheForTab(tabId) {
browser.storage.local.get('cache', function(data) {
if (!data.cache) {
return;
}
// Remove all entries for the tab.
delete data.cache[tabId];
browser.storage.local.set(data);
});
};
function clearLocalStorage() {
browser.storage.local.get('cache', function(data) {
if (!data.cache) {
return;
}
browser.tabs.query({}).then((tabs) => {
var tabIds = tabs.map((tab) => tab.id);
for (let key of Object.keys(data.cache)) {
if (!tabIds.includes(key)) {
delete data.cache[key];
}
}
browser.storage.local.set(data);
});
});
}
/**
* Configure the Ouinet client as a proxy.
*
* As of 2022-02-22, and according
* to @url{https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy/settings},
* this only works on Desktop Firefox >= 60.
*/
function setOuinetClientAsProxy() {
var proxyEndpoint = `${config.ouinet_client.host}:${config.ouinet_client.proxy.port}`;
browser.proxy.settings.set({value: {
proxyType: "manual",
http: proxyEndpoint,
ssl: proxyEndpoint,
}}).then(function() {
console.log("Ouinet client configured as proxy for HTTP and HTTPS.");
}).catch(function(e) {
// This does not work on Android:
// check occurrences of "proxy.settings is not supported on android"
// in `gecko-dev/toolkit/components/extensions/parent/ext-proxy.js`.
console.error("Failed to configure HTTP and HTTPS proxies:", e);
});
}
setOuinetClientAsProxy();
browser.browserAction.onClicked.addListener(function() {
var url = browser.extension.getURL("settings.html");
browser.tabs.create({url: url});
})
browser.webRequest.onBeforeSendHeaders.addListener(
onBeforeSendHeaders,
{urls: ["<all_urls>"]},
["blocking", "requestHeaders"]);
browser.webRequest.onHeadersReceived.addListener(
redirect403ToHttps,
{urls: ["<all_urls>"]},
["blocking", "responseHeaders"]
);
browser.webRequest.onHeadersReceived.addListener(
redirectWhenUpdateRequired,
{urls: ["<all_urls>"]},
["blocking", "responseHeaders"]
);
browser.webRequest.onHeadersReceived.addListener(
warnWhenUpdateDetected,
{urls: ["<all_urls>"]},
["responseHeaders"]
);
browser.webRequest.onHeadersReceived.addListener(
updateCenoStats,
{urls: ["<all_urls>"]},
["responseHeaders"]
);
browser.webRequest.onHeadersReceived.addListener(
updateOuinetDetailsFromHeaders,
{urls: ["<all_urls>"]},
["responseHeaders"]
);
browser.runtime.onMessage.addListener(
(request, sender, sendResponse) => setPageActionForTab(sender.tab.id, sender));
browser.runtime.onStartup.addListener(clearLocalStorage);
/**
* Each time a tab is updated, reset the page action for that tab.
*/
browser.tabs.onUpdated.addListener(
(id, changeInfo, tab) => setPageActionForTab(id));
/**
* Initialize all tabs.
*/
browser.tabs.query({}).then(
(tabs) => tabs.map((tab) => setPageActionForTab(tab.id)));
browser.tabs.onRemoved.addListener(
(id) => removeCacheForTab(id));
browser.pageAction.onClicked.addListener(browser.pageAction.openPopup);
// Set up listener for native messages
port.onMessage.addListener(response => {
// Send back ouinet statistics
port.postMessage(`${JSON.stringify(gOuinetStats[gActiveTabId])}`);
});