summaryrefslogtreecommitdiff
path: root/data/extensions/jsr@javascriptrestrictor/fp_report.js
diff options
context:
space:
mode:
Diffstat (limited to 'data/extensions/jsr@javascriptrestrictor/fp_report.js')
-rw-r--r--data/extensions/jsr@javascriptrestrictor/fp_report.js215
1 files changed, 215 insertions, 0 deletions
diff --git a/data/extensions/jsr@javascriptrestrictor/fp_report.js b/data/extensions/jsr@javascriptrestrictor/fp_report.js
new file mode 100644
index 0000000..77b65ae
--- /dev/null
+++ b/data/extensions/jsr@javascriptrestrictor/fp_report.js
@@ -0,0 +1,215 @@
+/** \file
+ * \brief Functions that summarize fingerprints and generate FPD report
+ * \ingroup FPD
+ *
+ * \author Copyright (C) 2022 Marek Salon
+ *
+ * \license SPDX-License-Identifier: GPL-3.0-or-later
+ */
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+//
+
+/**
+ * Event listener that listens for a load of FPD report page. If the page is loaded, fetch FPD data from background.
+ *
+ * \param callback Function that initializes FPD report creation from fetched data.
+ */
+window.addEventListener('load', () => {
+ browser.runtime.sendMessage({
+ purpose: "fpd-get-report-data",
+ tabId: new URLSearchParams(window.location.search).get("id")
+ }).then((result) => {
+ createReport(result);
+ });
+});
+
+/**
+ * The function that populates FPD report page with data from the latest evaluation and hooks up listeners.
+ *
+ * \param data Information about latest fingerprinting evaluation consisting of all essential FPD objects.
+ */
+function createReport(data) {
+ var {tabObj, groups, latestEvals, fpDb, exceptionWrappers} = data;
+ var report = document.getElementById("fpd-report");
+ if (!tabObj || !groups || !groups.root || !groups.all || !fpDb || !latestEvals) {
+ report.innerHTML = "ERROR: Missing data, cannot create report! Try to reload the page and reopen the report."
+ return;
+ }
+
+ // parse latestEvals to create more useful representation for FPD report generation
+ var processedEvals = {};
+ for (let item of latestEvals.evalStats) {
+ processedEvals[item.title] = processedEvals[item.title] || {};
+ processedEvals[item.title].type = item.type;
+ let total = 0;
+ if (fpDb[item.title]) {
+ for (let stat of Object.values(fpDb[item.title])) {
+ total += stat.total;
+ }
+ }
+ processedEvals[item.title].total = total;
+ }
+
+ // add page URL and FavIcon to header section of the report
+ if (tabObj) {
+ let urlObj = new URL(tabObj.url);
+ var url = urlObj.hostname + (urlObj.pathname.length > 1 ? urlObj.pathname : "");
+ document.getElementById("report-url").innerHTML = url;
+ let img = document.getElementById("pageFavicon");
+ img.src = tabObj.favIconUrl;
+ }
+
+ var html = "";
+
+ // generate html code for evaluated group
+ let generateGroup = (group) => {
+ if (processedEvals[group]) {
+ if (groups.all[group].description) {
+ html += "<div id=\"" + group + "\" class=\"fpd-group access\">";
+ html += "<h2>" + group + "</h2>";
+ html += "<p>" + groups.all[group].description + "</p>";
+ }
+ for (let [item, type] of Object.entries(groups.all[group].items)) {
+ if (type == "group") {
+ generateGroup(item);
+ }
+ else {
+ generateResource(item)
+ }
+ }
+ if (groups.all[group].description) {
+ html += "</div>";
+ }
+ }
+ }
+
+ // generate html code for evaluated resource (get,set,call)
+ let generateResource = (resource) => {
+ if (processedEvals[resource]) {
+ let accessRaw = processedEvals[resource].total;
+ let accessCount = accessRaw >= 1000 ? "1000+" : accessRaw;
+ html += `<h4 class="hidden ${accessRaw > 0 ? "access" : "no-access"}"><span class="dot">-</span> ` +
+ `${resource} (${exceptionWrappers.includes(resource) ? "n/a" : accessCount})</h4>`;
+ }
+ }
+
+ // start generating FPD report from the first group (root group)
+ generateGroup(groups.root);
+ report.innerHTML += html;
+
+ // process generated document
+ let groupElements = document.querySelectorAll(".fpd-group.access");
+ for (let i = groupElements.length; i > 0; i--) {
+ // remove duplicit entries from groups
+ let duplicitArray = [];
+ let elements = groupElements[i-1].querySelectorAll(":scope > h4");
+ elements.forEach((d) => {
+ if (duplicitArray.indexOf(d.innerHTML) > -1) {
+ d.remove();
+ }
+ else {
+ duplicitArray.push(d.innerHTML);
+ }
+ });
+
+ // hide groups with no relevant entries
+ if (!document.querySelectorAll(`#${groupElements[i-1].id} > .access`).length) {
+ groupElements[i-1].classList.replace("access", "no-access");
+ }
+ }
+
+ // function that enables to show accessed resources of the group
+ let toggleResources = (event) => {
+ let parent = event.target.parentElement;
+ for (let i = 0; i < parent.children.length; i++) {
+ let child = parent.children[i];
+ if (child.tagName == "H4") {
+ child.classList.toggle("hidden");
+ }
+ }
+ }
+
+ // make group name clickable only if it makes sense - groups with resources
+ let makeClickableTitles = () => {
+ for (let element of document.querySelectorAll(".fpd-group")) {
+ let button;
+ let haveChild = false;
+
+ for (let i = 0; i < element.children.length; i++) {
+ let child = element.children[i];
+ if (child.tagName == "H2") {
+ button = child;
+ }
+ if (child.tagName == "H4" && !child.classList.contains("no-access")) {
+ haveChild = true;
+ }
+ }
+
+ if (button && haveChild) {
+ button.classList.add("clickable");
+ button.addEventListener("click", toggleResources);
+ }
+ }
+ }
+ makeClickableTitles();
+
+ // show resources for every group in FPD report
+ let showAll = (event) => {
+ for (let element of document.querySelectorAll(".fpd-group > h4")) {
+ if (event.target.innerText == "Show details") {
+ element.classList.remove("hidden");
+ }
+ else {
+ element.classList.add("hidden");
+ }
+ }
+ event.target.innerText = event.target.innerText == "Show details" ? "Hide details" : "Show details";
+ }
+
+ // show description/help for the report
+ let showDescription = () => {
+ for (let element of document.querySelectorAll(".description")) {
+ element.classList.toggle("hidden");
+ }
+ }
+
+ // show all groups/resources even if not accessed
+ let showNotAccessed = () => {
+ for (let element of document.querySelectorAll(".no-access")) {
+ element.classList.remove("no-access");
+ }
+ makeClickableTitles();
+ }
+
+ // create on-site JSON representation of FPD evaluation data and download it
+ function exportReport(filename) {
+ let element = document.createElement("a");
+ let obj = {
+ fpd_evaluation_statistics: latestEvals.evalStats,
+ fpd_access_logs: fpDb
+ }
+ element.setAttribute("href", "data:text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(obj)));
+ element.setAttribute("download", filename);
+ element.style.display = "none";
+ document.body.appendChild(element);
+ element.click();
+ document.body.removeChild(element);
+ }
+
+ document.getElementById("showBtn").addEventListener("click", showAll);
+ document.getElementById("exportBtn").addEventListener("click", exportReport.bind(null, `fpd_report_${url}.json`))
+ document.getElementById("help").addEventListener("click", showDescription);
+ document.getElementById("unhideAll").addEventListener("click", showNotAccessed);
+}
home website