aboutsummaryrefslogtreecommitdiff
path: root/test/haketilo_test/unit/test_policy_enforcing.py
blob: 4bc6470e3da2d73ee388197744e6d7e6dc202acc (about) (plain)
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
# SPDX-License-Identifier: CC0-1.0

"""
Haketilo unit tests - enforcing script blocking policy from content script
"""

# This file is part of Haketilo
#
# Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the CC0 1.0 Universal License as published by
# the Creative Commons Corporation.
#
# 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
# CC0 1.0 Universal License for more details.

import pytest
import json
import urllib.parse
from selenium.webdriver.support.ui import WebDriverWait

from ..script_loader import load_script
from .utils import are_scripts_allowed

# For simplicity, we'll use one nonce in all test cases.
nonce = 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'

allow_policy = {'allow': True}
block_policy = {
    'allow': False,
    'csp': f"prefetch-src 'none'; script-src-attr 'none'; script-src 'none' 'unsafe-eval'; script-src-elem 'none'; frame-src http://* https://*;"
}
payload_policy = {
    'mapping': 'somemapping',
    'payload': {'identifier': 'someresource'},
    'csp': f"prefetch-src 'none'; script-src-attr 'none'; script-src 'nonce-{nonce}' 'unsafe-eval'; script-src-elem 'nonce-{nonce}';"
}

def content_script():
    return load_script('content/policy_enforcing.js') + \
        content_script_appended_code

content_script_appended_code = ''';{
const smuggled_what_to_do = /^[^#]*#?(.*)$/.exec(document.URL)[1];
const what_to_do = smuggled_what_to_do === "" ? {policy: {allow: true}} :
                   JSON.parse(decodeURIComponent(smuggled_what_to_do));

if (what_to_do.csp_off) {
    const orig_DOMParser = window.DOMParser;
    window.DOMParser = function() {
        const parser = new orig_DOMParser();
        this.parseFromString = () => parser.parseFromString('', 'text/html');
    }
}

enforce_blocking(what_to_do.policy);
}'''

def get(driver, page, what_to_do):
    driver.get(page + '#' + urllib.parse.quote(json.dumps(what_to_do)))
    driver.execute_script('window.before_reload = true; location.reload();')
    done = lambda _: not driver.execute_script('return window.before_reload;')
    WebDriverWait(driver, 10).until(done)

@pytest.mark.ext_data({'content_script': content_script})
@pytest.mark.usefixtures('webextension')
# Under Mozilla we use several mechanisms of script blocking. Some serve as
# fallbacks in case others break. CSP one of those mechanisms. Here we run the
# test once with CSP blocking on and once without it. This allows us to verify
# that the CSP-less blocking approaches by themselves also work. We don't do the
# reverse (CSP on and other mechanisms off) because CSP rules added through
# <meta> injection are not reliable enough - they do not always take effect
# immediately and there's nothing we can do to fix it.
@pytest.mark.parametrize('csp_off_setting', [{}, {'csp_off': True}])
def test_policy_enforcing_html(driver, execute_in_page, csp_off_setting):
    """
    A test case of sanitizing <script>s and intrinsic JavaScript in HTML pages.
    """
    def click_all():
        for i in range(1, 3):
            driver.find_element_by_id(f'clickme{i}').click()

    def assert_properly_blocked():
        click_all()

        assert set(driver.execute_script('return window.__run || [];')) == set()
        assert bool(csp_off_setting) == are_scripts_allowed(driver)

        for attr in ('onclick', 'href', 'src', 'data'):
            elem = driver.find_element_by_css_selector(f'[blocked-{attr}]')

            assert 'blocked' in elem.get_attribute(attr)
            assert '__run = [...(' in elem.get_attribute(f'blocked-{attr}')

        but1 = driver.find_element_by_id('clickme1')
        assert but1.get_attribute('blocked-blocked-onclick') == \
            "some useful data"

    # First, see if scripts run when not blocked.
    get(driver, 'https://gotmyowndoma.in/scripts_to_block_1.html', {
        'policy': allow_policy,
        **csp_off_setting
    })

    click_all()

    assert set(driver.execute_script('return window.__run || [];')) == \
        {'inline', 'on', 'href', 'src', 'data'}
    assert are_scripts_allowed(driver)

    # Now, verify scripts don't run when blocked.
    get(driver, 'https://gotmyowndoma.in/scripts_to_block_1.html', {
        'policy': block_policy,
        **csp_off_setting
    })

    assert_properly_blocked()

    # Now, verify only scripts with nonce can run when payload is injected.
    get(driver, 'https://gotmyowndoma.in/scripts_to_block_1.html', {
        'policy': payload_policy,
        **csp_off_setting
    })

    assert_properly_blocked()
    assert are_scripts_allowed(driver, nonce)

# Test function analogous to that for HTML page.
@pytest.mark.ext_data({'content_script': content_script})
@pytest.mark.usefixtures('webextension')
@pytest.mark.parametrize('csp_off_setting', [{}, {'csp_off': True}])
def test_policy_enforcing_xml(driver, execute_in_page, csp_off_setting):
    """
    A test case of sanitizing <script>s and intrinsic JavaScript in XML
    documents.
    """
    def click_all():
        for name in ('idaret', 'nowamak', 'mango', 'annoying'):
            elem = driver.find_element_by_id(f'{name}_circle')
            try:
                elem.click()
            except:
                pass

    def assert_properly_blocked():
        click_all()

        assert set(driver.execute_script('return window.__run || [];')) == set()
        assert bool(csp_off_setting) == are_scripts_allowed(driver)

    # First, see if scripts run when not blocked.
    get(driver, 'https://gotmyowndoma.in/scripts_to_block_2.xml', {
        'policy': allow_policy,
        **csp_off_setting
    })

    click_all()

    assert set(driver.execute_script('return window.__run || [];')) == \
        {'grape', 'raspberry', 'idaret', 'melon'}
    assert are_scripts_allowed(driver)

    # Now, verify scripts don't run when blocked.
    get(driver, 'https://gotmyowndoma.in/scripts_to_block_2.xml', {
        'policy': block_policy,
        **csp_off_setting
    })

    assert_properly_blocked()

    # Now, verify only scripts with nonce can run when payload is injected.
    get(driver, 'https://gotmyowndoma.in/scripts_to_block_2.xml', {
        'policy': payload_policy,
        **csp_off_setting
    })

    assert_properly_blocked()
    assert are_scripts_allowed(driver, nonce)