From 749f1c85670798999be5958580877277ce16aff0 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Tue, 15 Mar 2022 11:20:59 +0100 Subject: prepare for exposing APIs to injected scripts --- content/content.js | 10 ++++++- content/haketilo_apis.js | 49 +++++++++++++++++++++++++++++++++ test/haketilo_test/unit/test_content.py | 17 ++++++++---- 3 files changed, 70 insertions(+), 6 deletions(-) create mode 100644 content/haketilo_apis.js diff --git a/content/content.js b/content/content.js index ef2ee39..c492d53 100644 --- a/content/content.js +++ b/content/content.js @@ -42,6 +42,7 @@ */ #IMPORT content/repo_query_cacher.js +#IMPORT content/haketilo_apis.js #FROM common/browser.js IMPORT browser #FROM common/misc.js IMPORT is_privileged_url @@ -132,7 +133,14 @@ async function main() { resolve_page_info(Object.assign(page_info, script_response)); return; } else { - for (const script_contents of script_response.files) { + haketilo_apis.start(); + + const version = browser.runtime.getManifest().version; + const scripts = [ + `window.haketilo_version = ${JSON.stringify(version)};`, + ...script_response.files + ]; + for (const script_contents of scripts) { const html_ns = "http://www.w3.org/1999/xhtml"; const script = document.createElementNS(html_ns, "script"); diff --git a/content/haketilo_apis.js b/content/haketilo_apis.js new file mode 100644 index 0000000..36e987d --- /dev/null +++ b/content/haketilo_apis.js @@ -0,0 +1,49 @@ +/** + * This file is part of Haketilo. + * + * Function: Expose some special functionalities to injected scripts using + * CustomEvent's to communicate with them. + * + * Copyright (C) 2022 Wojtek Kosior + * + * 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. + * + * As additional permission under GNU GPL version 3 section 7, you + * may distribute forms of that code without the copy of the GNU + * GPL normally required by section 4, provided you include this + * license notice and, in case of non-source distribution, a URL + * through which recipients can access the Corresponding Source. + * If you modify file(s) with this exception, you may extend this + * exception to your version of the file(s), but you are not + * obligated to do so. If you do not wish to do so, delete this + * exception statement from your version. + * + * As a special exception to the GPL, any HTML file which merely + * makes function calls to this code, and for that purpose + * includes it by reference shall be deemed a separate work for + * copyright law purposes. If you modify this code, you may extend + * this exception to your version of the code, but you are not + * obligated to do so. If you do not wish to do so, delete this + * exception statement from your version. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + * I, Wojtek Kosior, thereby promise not to sue for violation of this file's + * license. Although I request that you do not make use of this code in a + * proprietary program, I am not going to enforce this in court. + */ + +#FROM common/browser.js IMPORT browser + +function start() { +} +#EXPORT start diff --git a/test/haketilo_test/unit/test_content.py b/test/haketilo_test/unit/test_content.py index 8220160..98ea930 100644 --- a/test/haketilo_test/unit/test_content.py +++ b/test/haketilo_test/unit/test_content.py @@ -88,6 +88,7 @@ content_script = \ } repo_query_cacher.start = () => data_set("cacher_started", true); + haketilo_apis.start = () => data_set("apis_started", true); enforce_blocking = policy => data_set("enforcing", policy); @@ -118,7 +119,7 @@ content_script = \ @pytest.mark.ext_data({'content_script': content_script}) @pytest.mark.usefixtures('webextension') -@pytest.mark.parametrize('target1', ['dynamic_before'])#, 'dynamic_after']) +@pytest.mark.parametrize('target1', ['dynamic_before', 'dynamic_after']) @pytest.mark.parametrize('target2', [ 'scripts_blocked', 'payload_error', @@ -144,6 +145,7 @@ def test_content_unprivileged_page(driver, execute_in_page, target1, target2): assert data['bad_request_returned'] == False assert data['cacher_started'] == True + assert data.get('apis_started', False) == (target2 == 'payload_ok') for obj in (data['good_request_result'], data['enforcing']): assert obj['allow'] == False @@ -162,9 +164,13 @@ def test_content_unprivileged_page(driver, execute_in_page, target1, target2): def vars_made_by_payload(driver): vars_values = driver.execute_script( - 'return [1, 2].map(n => window[`hak_injected_${n}`]);' - ) - if vars_values != [None, None]: + ''' + return [ + ...[1, 2].map(n => window[`hak_injected_${n}`]), + window.haketilo_version + ]; + ''') + if vars_values != [None, None, None]: return vars_values if target2 == 'payload_error': @@ -174,7 +180,8 @@ def test_content_unprivileged_page(driver, execute_in_page, target1, target2): } elif target2 == 'payload_ok': vars_values = WebDriverWait(driver, 10).until(vars_made_by_payload) - assert vars_values == [1, 2] + assert vars_values[:2] == [1, 2] + assert type(vars_values[2]) == str @pytest.mark.ext_data({'content_script': content_script}) @pytest.mark.usefixtures('webextension') -- cgit v1.2.3