aboutsummaryrefslogtreecommitdiff
path: root/test/spec/LibreJSSpec.js
blob: 8d4aebef7a98ca7d9d52c0cd302888ab21725872 (plain) (blame)
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
/*
* GNU LibreJS - A browser add-on to block nonfree nontrivial JavaScript.
*
* Copyright (C) 2018 Giorgio Maone <giorgio@maone.net>
*
* This file is part of GNU LibreJS.
*
* GNU LibreJS 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.
*
* GNU LibreJS 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 GNU LibreJS.  If not, see <http://www.gnu.org/licenses/>.
*/
"use strict";

describe("LibreJS' components", () => {
  let LibreJS = browser.extension.getBackgroundPage().LibreJS;
  let license = {
    id: 'GPL-3.0',
    url: 'http://www.gnu.org/licenses/gpl-3.0.html',
    magnet: 'magnet:?xt=urn:btih:1f739d935676111cfff4b4693e3816e664797050&dn=gpl-3.0.txt',
  };
  let unknownLicense = {
    id: 'Acme-proprietary-1.5',
    url: 'http://www.acme.com/license-1.5.html',
    magnet: 'magnet:?xt=urn:btih:2f739d935676111cfff4b4693e3816e664797050&dn=acme-1.5.txt'
  };

  let trivial = "1+1";
  let nontrivial = `function nt() { document.documentElement.innerHTML=""; nt(); }`;
  let licensed = `// @license ${license.magnet} ${license.id}\n${nontrivial}\n// @license-end`;
  let unknownLicensed = `// @license ${unknownLicense.magnet} ${unknownLicense.id}\n${nontrivial}\n// @license-end`;
  let malformedLicensed = `// @license\n${nontrivial}`;
  let tab, documentUrl;

  beforeAll(async () => {
    let url = browser.extension.getURL("/test/resources/index.html");
    tab = (await browser.tabs.query({url}))[0] || (await browser.tabs.create({url}));
    documentUrl = url;

  });

  describe("The whitelist/blacklist manager", () => {
    let {ListManager, ListStore, Storage} = LibreJS;
    let lm = new ListManager(new ListStore("_test.whitelist", Storage.CSV), new ListStore("_test.blacklist", Storage.CSV), new Set());
    let forgot = ["http://formerly.whitelist.ed/", "http://formerly.blacklist.ed/"];

    beforeAll(async () => {
      await lm.whitelist("https://fsf.org/*", "https://*.gnu.org/*", forgot[0]);
      await lm.blacklist("https://*.evil.gnu.org/*", "https://verybad.com/*", forgot[1]);
    });

    it("Should handle basic CRUD operations", async () => {
       expect(lm.getStatus(forgot[0])).toBe("whitelisted");
       expect(lm.getStatus(forgot[1])).toBe("blacklisted");

       await lm.forget(...forgot);

       for (let url of forgot) {
         expect(lm.getStatus(url)).toBe("unknown");
       }
    });

    it("Should support full path wildcards", () => {
      expect(lm.getStatus("https://unknown.org")).toBe("unknown");
      expect(lm.getStatus("https://fsf.org/some/path")).toBe("whitelisted");
      expect(lm.getStatus("https://fsf.org/")).toBe("whitelisted");
      expect(lm.getStatus("https://fsf.org")).toBe("whitelisted");
      expect(lm.getStatus("https://subdomain.fsf.org")).toBe("unknown");
      expect(lm.getStatus("https://verybad.com/some/other/path?with=querystring")).toBe("blacklisted");
    });
    it("Should support subdomain wildcards", () => {
      expect(lm.getStatus("https://gnu.org")).toBe("whitelisted");
      expect(lm.getStatus("https://www.gnu.org")).toBe("whitelisted");
      expect(lm.getStatus("https://evil.gnu.org")).toBe("blacklisted");
      expect(lm.getStatus("https://more.evil.gnu.org")).toBe("blacklisted");
      expect(lm.getStatus("https://more.evil.gnu.org/some/evil/path?too")).toBe("blacklisted");
    });
  })

  describe("The external script source processor", () => {
    let url = "https://www.gnu.org/mock-script.js";

    let processScript = async (source, whitelisted = false) =>
      await LibreJS.handle_script({
        text: source,
        request: {url, tabId: tab.id, documentUrl, frameId: 0},
      }, whitelisted);

    it("should accept whitelisted scripts", async () => {
      expect(await processScript(nontrivial, true) || nontrivial).toContain(nontrivial);
    });

    it("should block trivial scripts too", async () => {
      let processed = await processScript(trivial);
      expect(processed || trivial).not.toContain(trivial);
    });

    it("should block non-trivial scripts", async () => {
      let processed = await processScript(nontrivial);
      expect(processed || nontrivial).not.toContain(nontrivial);
    });

    it("should accept scripts with known free license tags", async () => {
      let processed = await processScript(licensed);
      expect(processed || licensed).toContain(nontrivial);
    });

    it("should block scripts with unknown license tags", async () => {
      let processed = await processScript(unknownLicensed);
      expect(processed).not.toContain(nontrivial);
    });

    it("should block scripts with malformed license tags", async () => {
      let processed = await processScript(malformedLicensed);
      expect(processed).not.toContain(nontrivial);
    });
  });

  describe("The HTML processor", () => {
    let processHtml =
      async (html, whitelisted = false) =>
        LibreJS.editHtml(html, tab.url, tab.id, 0, whitelisted);

    let addScript = (html, script, before = "</head>") =>
      html.replace(before, `<script>${script}</script>${before}`);

    let addToBody = (html, fragment) => html.replace("</body>", `${fragment}</body>`);

    let jsUrl = js => `javascript:${encodeURIComponent(js)}`;

    function extractScripts(html, def = "") {
      let matches = html && html.match(/<script>[^]*?<\/script>/g);
      return matches && matches.join("") || def;
    }

    let html, nontrivialInHtml;
    beforeAll(async () => {
      html = (await browser.tabs.executeScript(tab.id, {
        runAt: "document_start",
        code: "document.documentElement.outerHTML"
      }))[0];
      nontrivialInHtml = addScript(html, nontrivial);
    });

    it("should not modify scriptless documents", async () => {
      expect(await processHtml(html)).toBeNull();
    });

    it("should not modify whitelisted documents", async () => {
      expect(await processHtml(nontrivialInHtml, true)).toBeNull();
    });

    it("should accept trivial scripts", async () => {
      let trivialInHtml = addScript(html, trivial);
      let processed = await processHtml(trivialInHtml);
      expect(extractScripts(processed, trivial)).toContain(trivial);
    });

    it("should block non-trivial scripts", async () => {
      let processed = await processHtml(nontrivialInHtml);
      expect(extractScripts(processed, nontrivial)).not.toContain(nontrivial);
    });

    it("should accept scripts with known free license tags", async () => {
      let licensedInHtml = addScript(html, licensed);
      let processed = await processHtml(licensedInHtml);
      expect(extractScripts(processed, licensed)).toContain(nontrivial);
    });

    it("should block scripts with unknown license tags", async () => {
      let unknownInHtml = addScript(html, unknownLicensed);
      let processed = await processHtml(unknownInHtml);
      expect(extractScripts(processed, nontrivial)).not.toContain(nontrivial);
    });

    it("should block scripts with malformed license tags", async () => {
      let malformedInHtml = addScript(html, malformedLicensed);
      let processed = await processHtml(malformedInHtml);
      expect(extractScripts(processed, nontrivial)).not.toContain(nontrivial);
    });

    it("should accept scripts on globally licensed pages", async () => {
      let globalLicense = `/* @licstart The following is the entire license notice
        for the JavaScript code in this page.
        -- Some free license --
        @licend The above is the entire license notice for the JavaScript code in this page. */`;

      let licensed = addScript(nontrivialInHtml, globalLicense, "<script>");
      let processed = await processHtml(html);
      expect(extractScripts(processed, licensed)).toContain(nontrivial);
    });

    it("should discriminate trivial, non-trivial and licensed mixed on the same page", async () => {
      let mixedPage = addScript(addScript(nontrivialInHtml, trivial), licensed);
      let processed = await processHtml(mixedPage);
      expect(processed).not.toBeNull();
      let scripts = extractScripts(processed, nontrivial);
      expect(scripts).toContain(trivial);
      expect(scripts).toContain(licensed);
      expect(scripts.replace(licensed, "")).not.toContain(nontrivial);
    });

    it("should correctly process (de)duplicated inline scripts", async () => {
      let trivialAsUrl = jsUrl(trivial);
      let nontrivialAsUrl = jsUrl(nontrivial);
      let a = (url, label) => `<a href="${url}">${label}</a>`;
      let mixedPage = `<body></body>`;
      for (let dup = 0; dup < 3; dup++) {
        mixedPage = addToBody(mixedPage, a(trivialAsUrl, `Trivial #${dup}`));
        mixedPage = addToBody(mixedPage, a(nontrivialAsUrl, `Nontrivial #${dup}`));
      }
      let processed = await processHtml(mixedPage);
      expect(processed).not.toBeNull();
      expect(processed).toContain(trivialAsUrl);
      expect(processed).not.toContain(nontrivialAsUrl);
    });

    it("should force displaying NOSCRIPT elements (except those with @data-librejs-nodisplay) where scripts have been blocked", async () => {
      let noscriptContent = "I'm NOSCRIPT content";
      let asNoscript = `<noscript>${noscriptContent}</noscript>`;
      let asNodisplay = `<noscript data-librejs-nodisplay>${noscriptContent}</noscript>`;
      let asSpan = `<span>${noscriptContent}</span>`;
      let page = addToBody(addToBody(nontrivialInHtml, asNoscript), asNodisplay);
      let processed = await processHtml(page);
      expect(processed).not.toContain(asNoscript);
      expect(processed).toContain(asSpan);
      expect(processed).not.toContain(asNodisplay);
    });

    it("should always force displaying @data-librejs-display elements", async () => {
      let content = "I'm FORCED content";
      let asDisplay = `<span data-librejs-display>${content}</span>`;
      let asSpan = `<span>${content}</span>`;
      for (let page of [nontrivialInHtml, "<body></body>"]) {
        page = addToBody(page, asDisplay);
        let processed = await processHtml(page);
        expect(processed).not.toContain(asDisplay);
        expect(processed).not.toContain(asSpan);
      }
    });
  });

  describe("The external (Web Labels) license checker", () => {
    let {ExternalLicenses} = LibreJS;
    let check;

    beforeAll(async () => {
      let args = {tabId: tab.id, frameId: 0, documentUrl};
      let resolve = url => new URL(url, documentUrl).href;
      check = async url => await ExternalLicenses.check(Object.assign({url: resolve(url)}, args));
      await browser.tabs.executeScript(tab.id, {
        file: "/content/externalLicenseChecker.js"
      });
    });

    it("should recognize free licenses", async () => {
      let scriptInfo = await check("jquery.js");
      console.debug(scriptInfo);
      expect(scriptInfo.free).toBeTruthy();
    });
    it("should accept scripts if any of multiple licenses is free", async () => {
      let scriptInfo = await check("app-trilicensed.js");
      console.debug(scriptInfo);
      expect(scriptInfo.free).toBeTruthy();
    });
    it("should block scripts declaring only proprietary license(s)", async () => {
      let scriptInfo = await check("proprietary.js");
      console.debug(scriptInfo);
      expect(scriptInfo.free).toBeFalsy();
    });
    it("should block scripts not declaring any license", async () => {
      let scriptInfo = await check("tracker.js");
      console.debug(scriptInfo);
      expect(scriptInfo).toBeNull();
    });
  });
  afterAll(async () => {
    await browser.tabs.remove(tab.id);
    browser.tabs.update((await browser.tabs.getCurrent()).id, {active: true});
  });
});