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
|
const store = {
ALLOWLIST_URL: '/ext-libs/disconnect-entitylist.json',
db: null,
async init() {
if (!this.db) {
this.makeNewDatabase();
}
browser.runtime.onMessage.addListener((m) => {
return store.messageHandler(m);
});
await this.getAllowList();
},
async isFirstRun() {
let isFirstRun = await browser.storage.local.get('isFirstRun');
if (! ('isFirstRun' in isFirstRun)) {
isFirstRun = true;
} else if (isFirstRun) {
isFirstRun = false;
}
await browser.storage.local.set({ isFirstRun });
return isFirstRun;
},
indexes: [
'hostname', // Primary key
'firstRequestTime',
'lastRequestTime',
'isVisible',
'firstParty'
],
makeNewDatabase() {
this.db = new Dexie('websites_database');
const websites = this.indexes.join(', ');
this.db.version(1).stores({websites});
this.db.open();
},
// get Disconnect Entity List from shavar-prod-lists submodule
async getAllowList() {
let allowList;
try {
allowList = await fetch(this.ALLOWLIST_URL);
allowList = await allowList.json();
} catch (error) {
allowList = {};
const explanation = 'See README.md for how to import submodule file';
// eslint-disable-next-line no-console
console.error(`${error.message} ${explanation} ${this.ALLOWLIST_URL}`);
}
const { firstPartyAllowList, thirdPartyAllowList }
= this.reformatList(allowList);
this.firstPartyAllowList = firstPartyAllowList;
this.thirdPartyAllowList = thirdPartyAllowList;
},
/*
disconnect-entitylist.json is expected to match this format, where:
- 'properties' keys are first parties
- 'resources' keys are third parties
{
"Facebook" : {
"properties": [
"facebook.com",
"facebook.de",
...
"messenger.com"
],
"resources": [
"facebook.com",
"facebook.de",
...
"akamaihd.net"
]
}
"Google" : {
...
}
}
this.firstPartyAllowList is expected to match this format:
{
"google.com": 1,
"abc.xyz": 1
....
"facebook.com": 2,
...
}
this.thirdPartyAllowList is expected to match this format:
{
1: [
"google.com",
"googleanalytics.com",
"weloveevilstuff.com"
]
}
*/
reformatList(allowList) {
const firstPartyAllowList = {};
const thirdPartyAllowList = {};
let counter = 0;
for (const siteOwner in allowList) {
const firstParties = allowList[siteOwner].properties;
for (let i = 0; i < firstParties.length; i++) {
firstPartyAllowList[firstParties[i]] = counter;
}
const thirdParties = allowList[siteOwner].resources;
thirdPartyAllowList[counter] = [];
for (let i = 0; i < thirdParties.length; i++) {
thirdPartyAllowList[counter].push(thirdParties[i]);
}
counter++;
}
return {
firstPartyAllowList,
thirdPartyAllowList
};
},
// send message to storeChild when data in store is changed
updateChild(...args) {
return browser.runtime.sendMessage({
type: 'storeChildCall',
args
});
},
messageHandler(m) {
if (m.type !== 'storeCall') {
return;
}
const publicMethods = [
'getAll',
'reset',
'getFirstRequestTime',
'getNumFirstParties',
'getNumThirdParties',
'isFirstRun'
];
if (publicMethods.includes(m['method'])) {
const args = m.args;
return this[m['method']](...args);
} else {
return new Error(`Unsupported method ${m.method}`);
}
},
async _write(website) {
for (const key in website) {
website[key] = this.mungeDataInbound(key, website[key]);
}
return await this.db.websites.put(website);
},
outputWebsite(hostname, website) {
const output = {
hostname: hostname,
favicon: website.faviconUrl || '',
firstPartyHostnames: website.firstPartyHostnames || false,
firstParty: !!website.firstParty,
thirdParties: []
};
if ('thirdPartyHostnames' in website) {
output.thirdParties = website.thirdPartyHostnames;
}
return output;
},
async getAll() {
const websites = await this.db.websites.filter((website) => {
return website.isVisible || website.firstParty;
}).toArray();
const output = {};
for (const website of websites) {
output[website.hostname]
= this.outputWebsite(website.hostname, website);
}
return output;
},
/*
if not {}, getWebsite returns an object:
- in this format for first parties:
{
thirdPartyHostnames: [
"www.thirdpartydomain.com",
...
]
}
and in this format for third parties:
{
firstPartyHostnames: [
"www.firstpartydomain.com",
...
],
isVisible: false,
}
*/
async getWebsite(hostname) {
if (!hostname) {
throw new Error('getWebsite requires a valid hostname argument');
}
const website = await this.db.websites.get(hostname);
if (website) {
const websiteOutput = {};
Object.keys(website).forEach((key) => {
websiteOutput[key] = this.mungeDataOutbound(key, website[key]);
});
return websiteOutput;
} else {
return {};
}
},
mungeDataInbound(key, value) {
if (this.indexes.includes(key)) {
// IndexedDB does not accept boolean values for indexes; using 0/1 instead
if (value === true) {
value = 1;
}
if (value === false) {
value = 0;
}
}
return value;
},
mungeDataOutbound(key, value) {
if (this.indexes.includes(key)) {
// IndexedDB does not accept boolean values for indexes; using 0/1 instead
if (value === 1) {
value = true;
}
if (value === 0) {
value = false;
}
}
return value;
},
async setWebsite(hostname, data) {
const website = await this.getWebsite(hostname);
if (!('hostname' in website)) {
website['hostname'] = hostname;
}
for (const key in data) {
const value = data[key];
switch (key) {
case 'requestTime':
// store first and last request times for clearing data every X days
if (!('firstRequestTime' in website)) {
website.firstRequestTime = value;
} else {
website.lastRequestTime = value;
}
break;
case 'isVisible':
if ('isVisible' in website
&& website.isVisible === true) {
// once a website is visible, it will always be visible
break;
}
website.isVisible = value;
break;
case 'firstParty':
if ('firstParty' in website
&& website.firstParty === true) {
// once a website is a first party, it will always be drawn as one
break;
}
website.firstParty = value;
if (value) {
website.isVisible = value;
}
break;
default:
website[key] = value;
break;
}
}
await this._write(website);
return website;
},
async isNewWebsite(hostname) {
if (!(await this.db.websites.get(hostname))) {
return true;
}
return false;
},
getHostnameVariants(hostname) {
const hostnameVariants = [hostname];
const hostnameArr = hostname.split('.');
const numDots = hostnameArr.length - 1;
for (let i = 0; i < numDots - 1; i++) {
hostnameArr.shift();
hostname = hostnameArr.join('.');
hostnameVariants.push(hostname);
}
return hostnameVariants;
},
// check if third party is on the allowlist (owned by the first party)
// returns true if it is and false otherwise
onAllowList(firstPartyFromRequest, thirdPartyFromRequest) {
if (thirdPartyFromRequest && this.firstPartyAllowList) {
const hostnameVariantsFirstParty
= this.getHostnameVariants(firstPartyFromRequest);
for (let i = 0; i < hostnameVariantsFirstParty.length; i++) {
if (this.firstPartyAllowList
.hasOwnProperty(hostnameVariantsFirstParty[i])) {
// first party is in the allowlist
const index = this.firstPartyAllowList[hostnameVariantsFirstParty[i]];
const hostnameVariantsThirdParty
= this.getHostnameVariants(thirdPartyFromRequest);
for (let j = 0; j < hostnameVariantsThirdParty.length; j++) {
if (this.thirdPartyAllowList[index]
.includes(hostnameVariantsThirdParty[j])) {
return true;
}
}
return false;
}
}
}
return false;
},
async setFirstParty(hostname, data) {
if (!hostname) {
throw new Error('setFirstParty requires a valid hostname argument');
}
const isNewWebsite = await this.isNewWebsite(hostname);
const responseData = await this.setWebsite(hostname, data);
if (isNewWebsite) {
this.updateChild(this.outputWebsite(hostname, responseData));
}
},
async setThirdParty(origin, target, data) {
if (!origin) {
throw new Error('setThirdParty requires a valid origin argument');
}
let isNewThirdParty = false;
let shouldUpdate = false;
const firstParty = await this.getWebsite(origin);
const thirdParty = await this.getWebsite(target);
// add link in third party if it doesn't exist yet
if (!('firstPartyHostnames' in thirdParty)) {
thirdParty['firstPartyHostnames'] = [];
}
if (!thirdParty['firstPartyHostnames'].includes(origin)) {
thirdParty['firstPartyHostnames'].push(origin);
}
// add link in first party if it doesn't exist yet
// and the third party is visible (i.e. not allowlisted)
if (!this.isFirstPartyLinkedToThirdParty(firstParty, target)) {
if (!this.isVisibleThirdParty(thirdParty)) {
if (this.onAllowList(origin, target)) {
// hide third party
thirdParty['isVisible'] = false;
} else {
// show third party; it either became visible or is brand new
thirdParty['isVisible'] = true;
isNewThirdParty = true;
for (let i = 0; i < thirdParty['firstPartyHostnames'].length; i++) {
const firstPartyHostname = thirdParty['firstPartyHostnames'][i];
await this.addFirstPartyLink(firstPartyHostname, target);
}
shouldUpdate = true;
}
}
if (this.isVisibleThirdParty(thirdParty) && !isNewThirdParty) {
// an existing visible third party links to a new first party
await this.addFirstPartyLink(origin, target);
shouldUpdate = true;
}
}
// merge data with thirdParty
for (const key in data) {
thirdParty[key] = data[key];
}
const responseData = await this.setWebsite(target, thirdParty);
if (shouldUpdate) {
this.updateChild(this.outputWebsite(target, responseData));
}
},
isFirstPartyLinkedToThirdParty(firstParty, thirdPartyHostname) {
if (!('thirdPartyHostnames' in firstParty)
|| !firstParty['thirdPartyHostnames'].includes(thirdPartyHostname)) {
return false;
}
return true;
},
isVisibleThirdParty(thirdParty) {
if (!('isVisible' in thirdParty) || !thirdParty['isVisible']) {
return false;
}
return true;
},
async addFirstPartyLink(firstPartyHostname, thirdPartyHostname) {
const firstParty = await this.getWebsite(firstPartyHostname);
// We are likely storing the tp first, lets account for that
if (!('firstParty' in firstParty)) {
firstParty.firstParty = true;
}
if (!('thirdPartyHostnames' in firstParty)) {
firstParty['thirdPartyHostnames'] = [];
}
if (!this.isFirstPartyLinkedToThirdParty(firstParty, thirdPartyHostname)) {
firstParty['thirdPartyHostnames'].push(thirdPartyHostname);
await this.setFirstParty(firstPartyHostname, firstParty);
}
},
async reset() {
// empty out request processing queue
capture.queue = [];
return await this.db.websites.clear();
},
async getFirstRequestTime() {
const oldestSite
= await this.db.websites.orderBy('firstRequestTime').first();
if (!oldestSite) {
return false;
}
return oldestSite.firstRequestTime;
},
async getNumFirstParties() {
return await this.db.websites.where('firstParty').equals(1).count();
},
async getNumThirdParties() {
return await this.db.websites
.where('firstParty').equals(0).and((website) => {
return website.isVisible;
}).count();
}
};
store.init();
|