Debian Codegraph @

tests/selenium/content_filtering_test.py

raw
1 #!/usr/bin/env python
2
3 import time
4 import unittest
5
6 import pbtest
7
8
9 class ContentFilteringTest(pbtest.PBSeleniumTest):
10 """Content filtering tests."""
11
12 # for blocking tests
13 FIXTURE_DOMAIN = "efforg.github.io"
14 FIXTURE_PARENT_DOMAIN = "github.io"
15 FIXTURE_URL = (
16 f"https://{FIXTURE_DOMAIN}/privacybadger-test-fixtures/html/"
17 "3p_script_with_load_status.html"
18 )
19 THIRD_PARTY_DOMAIN = "privacybadger-tests.eff.org"
20 THIRD_PARTY_SUBDOMAIN = "child1." + THIRD_PARTY_DOMAIN
21 SELECTOR = "#third-party-load-result"
22
23 # for cookie tests
24 COOKIE_FIXTURE_URL = (
25 "https://efforg.github.io/privacybadger-test-fixtures/html/"
26 "recording_nontracking_domains.html"
27 )
28 COOKIE_DOMAIN = "dnt-request-cookies-test.trackersimulator.org"
29
30 def setUp(self):
31 self.clear_tracker_data()
32
33 def assert_block(self):
34 self.wait_for_any_text(self.SELECTOR)
35 assert self.find_el_by_css(self.SELECTOR).text == "error", (
36 "3rd-party should've gotten blocked")
37
38 def assert_load(self):
39 self.wait_for_any_text(self.SELECTOR)
40 assert self.find_el_by_css(self.SELECTOR).text == "success", (
41 "3rd-party should've loaded successfully")
42
43 def test_blocking_fixture_loads_when_unblocked(self):
44 self.load_url(self.FIXTURE_URL)
45 self.assert_load()
46
47 def test_blocking(self):
48 self.block_domain(self.THIRD_PARTY_DOMAIN)
49
50 self.load_url(self.FIXTURE_URL)
51 self.assert_block()
52
53 def test_cookieblocking_stops_saving(self):
54 self.load_url(f"https://{self.COOKIE_DOMAIN}/")
55 assert not self.driver.get_cookies(), (
56 "Visiting the domain directly does not set a cookie")
57
58 self.load_url(self.COOKIE_FIXTURE_URL)
59 self.load_url(f"https://{self.COOKIE_DOMAIN}/")
60 assert len(self.driver.get_cookies()) == 1, (
61 "Cookie fixture should have set a cookie")
62
63 self.driver.delete_all_cookies()
64 self.cookieblock_domain(self.COOKIE_DOMAIN)
65
66 self.load_url(self.COOKIE_FIXTURE_URL)
67 self.load_url(f"https://{self.COOKIE_DOMAIN}/")
68 assert not self.driver.get_cookies(), (
69 "Cookie fixture should have been blocked from setting a cookie")
70
71 def test_cookieblocking_stops_sending(self):
72 self.load_url(self.COOKIE_FIXTURE_URL)
73 self.wait_for_and_switch_to_frame("iframe[src]", timeout=1)
74 self.wait_for_any_text('body')
75 assert self.find_el_by_css('body').text == "cookies=0", (
76 "No cookies should've been sent to start with")
77
78 self.load_url(self.COOKIE_FIXTURE_URL)
79 self.wait_for_and_switch_to_frame("iframe[src]", timeout=1)
80 self.wait_for_any_text('body')
81 assert self.find_el_by_css('body').text == "cookies=1", (
82 "We should have sent a cookie at this point")
83
84 self.cookieblock_domain(self.COOKIE_DOMAIN)
85
86 self.load_url(self.COOKIE_FIXTURE_URL)
87 self.wait_for_and_switch_to_frame("iframe[src]", timeout=1)
88 self.wait_for_any_text('body')
89 assert self.find_el_by_css('body').text == "cookies=0", (
90 "No cookies should have been sent by the cookieblocked domain")
91
92 def test_cookieblocking_subdomain_of_blocked_domain(self):
93 self.block_domain(self.THIRD_PARTY_DOMAIN)
94 self.cookieblock_domain(self.THIRD_PARTY_SUBDOMAIN)
95 self.load_url(self.FIXTURE_URL + '?alt3p')
96 self.assert_load()
97
98 def test_cookieblocking_base_overwrites_subdomain_block(self):
99 self.block_domain(self.THIRD_PARTY_SUBDOMAIN)
100 self.load_url(self.FIXTURE_URL + '?alt3p')
101 self.assert_block()
102
103 self.cookieblock_domain(self.THIRD_PARTY_DOMAIN)
104 self.load_url(self.FIXTURE_URL + '?alt3p')
105 self.assert_load()
106
107 def test_blocking_fp_script_from_cookieblocked_cdn(self):
108 fp2_fixture = "https://efforg.github.io/privacybadger-test-fixtures/html/fingerprinting.html"
109
110 self.cookieblock_domain("cdn.jsdelivr.net")
111
112 # no canvas script data to start with
113 assert self.get_badger_storage('fp_scripts') == {}
114
115 # enable local learning
116 self.wait_for_script("return window.OPTIONS_INITIALIZED")
117 self.find_el_by_css('a[href="#tab-general-settings"]').click()
118 self.find_el_by_css('#local-learning-checkbox').click()
119
120 self.load_url(fp2_fixture)
121 assert self.js("return typeof window.Fingerprint2") == "function"
122
123 # keep the window open for recording to complete
124 self.open_window()
125
126 # wait for canvas script path to be recorded
127 if self.get_badger_storage('fp_scripts') == {}:
128 time.sleep(1)
129
130 self.load_url(fp2_fixture)
131 self.driver.refresh()
132
133 if self.js("return typeof window.Fingerprint2") != "undefined":
134 # clear webRequest caches
135 self.load_url(self.options_url)
136 self.wait_for_script(
137 "(async function (done) {"
138 " await chrome.webRequest.handlerBehaviorChanged();"
139 " done(true);"
140 "}(arguments[arguments.length - 1]));", execute_async=True)
141 self.load_url(fp2_fixture)
142 self.driver.refresh()
143
144 assert self.js("return typeof window.Fingerprint2") == "undefined"
145
146 def test_surrogating_fp_script_from_cookieblocked_cdn(self):
147 """Since we have a surrogate script for FingerprintJS (v3) served
148 from cdn.jsdelivr.net, we test surrogation rather than blocking."""
149
150 def get_visitor_id():
151 return self.driver.execute_async_script(
152 "let done = arguments[arguments.length - 1];"
153 "FingerprintJS.load().then(fp => {"
154 " fp.get().then(res => {"
155 " done(res.visitorId);"
156 " });"
157 "});")
158
159 self.cookieblock_domain("cdn.jsdelivr.net")
160
161 # first get a visitor ID from FingerprintJS, before enabling learning
162 self.load_url(self.FIXTURE_URL + '?fingerprintjs')
163 self.assert_load()
164 visitor_id = get_visitor_id()
165
166 # enable local learning
167 self.load_url(self.options_url)
168 self.wait_for_script("return window.OPTIONS_INITIALIZED")
169 self.find_el_by_css('a[href="#tab-general-settings"]').click()
170 self.find_el_by_css('#local-learning-checkbox').click()
171
172 # assert the original script still loads
173 self.load_url(self.FIXTURE_URL + '?fingerprintjs')
174 self.assert_load()
175 assert get_visitor_id() == visitor_id, (
176 "Visitor ID should be consistent between page loads")
177
178 # keep the window open for recording to complete
179 self.open_window()
180
181 # now assert the surrogate script loads
182 self.load_url(self.FIXTURE_URL + '?fingerprintjs')
183 self.assert_load()
184
185 if get_visitor_id() == visitor_id:
186 # clear webRequest caches
187 self.load_url(self.options_url)
188 self.wait_for_script(
189 "(async function (done) {"
190 " await chrome.webRequest.handlerBehaviorChanged();"
191 " done(true);"
192 "}(arguments[arguments.length - 1]));", execute_async=True)
193 self.load_url(self.FIXTURE_URL + '?fingerprintjs')
194 self.driver.refresh()
195 self.assert_load()
196
197 assert get_visitor_id() != visitor_id, (
198 "Visitor ID should change between page loads")
199 self.driver.refresh()
200 self.assert_load()
201 assert get_visitor_id() != visitor_id, (
202 "Visitor ID should change between page loads")
203
204 def test_userblock(self):
205 self.set_user_action(self.THIRD_PARTY_DOMAIN, "block")
206
207 self.load_url(self.FIXTURE_URL)
208 self.assert_block()
209
210 def test_userblock_overwrites_cookieblock(self):
211 self.cookieblock_domain(self.THIRD_PARTY_DOMAIN)
212 self.set_user_action(self.THIRD_PARTY_DOMAIN, "block")
213 self.load_url(self.FIXTURE_URL)
214 self.assert_block()
215
216 def test_userblock_overwrites_dnt(self):
217 self.set_dnt(self.THIRD_PARTY_DOMAIN)
218 self.set_user_action(self.THIRD_PARTY_DOMAIN, "block")
219 self.load_url(self.FIXTURE_URL)
220 self.assert_block()
221
222 def test_usercookieblock_stops_saving(self):
223 self.set_user_action(self.COOKIE_DOMAIN, "cookieblock")
224
225 self.load_url(self.COOKIE_FIXTURE_URL)
226 self.load_url(f"https://{self.COOKIE_DOMAIN}/")
227 assert not self.driver.get_cookies(), (
228 "Cookie fixture should have been blocked from setting a cookie")
229
230 def test_usercookieblock_overwrites_block(self):
231 self.block_domain(self.THIRD_PARTY_DOMAIN)
232 self.load_url(self.FIXTURE_URL)
233 self.assert_block()
234
235 self.set_user_action(self.THIRD_PARTY_DOMAIN, "cookieblock")
236 self.load_url(self.FIXTURE_URL)
237 self.assert_load()
238
239 def test_userallow(self):
240 self.block_domain(self.THIRD_PARTY_DOMAIN)
241 self.set_user_action(self.THIRD_PARTY_DOMAIN, "allow")
242
243 self.load_url(self.FIXTURE_URL)
244 self.assert_load()
245
246 def test_userallow_overwrites_block(self):
247 self.block_domain(self.THIRD_PARTY_DOMAIN)
248 self.load_url(self.FIXTURE_URL)
249 self.assert_block()
250
251 self.set_user_action(self.THIRD_PARTY_DOMAIN, "allow")
252 self.load_url(self.FIXTURE_URL)
253 self.assert_load()
254
255 def test_reverting_control(self):
256 self.block_domain(self.THIRD_PARTY_DOMAIN)
257 self.set_user_action(self.THIRD_PARTY_DOMAIN, "allow")
258 self.load_url(self.FIXTURE_URL)
259 self.assert_load()
260
261 # click the undo arrow
262 self.open_popup(self.FIXTURE_URL)
263 self.find_el_by_css(
264 f'div[data-origin="{self.THIRD_PARTY_DOMAIN}"] a.honeybadgerPowered').click()
265 self.driver.switch_to.window(self.driver.window_handles[0])
266 self.open_window()
267
268 self.load_url(self.FIXTURE_URL)
269 # navigate elsewhere and back to work around the third-party getting served from cache
270 self.load_url(self.options_url)
271 self.load_url(self.FIXTURE_URL)
272 self.assert_block()
273
274 def test_cookieblock_site_override(self):
275 # verify blocking gets overriden
276 self.block_domain(self.THIRD_PARTY_DOMAIN)
277 self.add_site_override(self.THIRD_PARTY_DOMAIN, self.FIXTURE_DOMAIN)
278
279 self.load_url(self.FIXTURE_URL)
280 self.assert_load()
281
282 # verify cookieblocking
283 self.block_domain(self.COOKIE_DOMAIN)
284 self.add_site_override(self.COOKIE_DOMAIN, self.FIXTURE_DOMAIN)
285
286 self.load_url(self.COOKIE_FIXTURE_URL)
287 self.wait_for_and_switch_to_frame("iframe[src]", timeout=1)
288 self.wait_for_any_text('body')
289 assert self.find_el_by_css('body').text == "cookies=0", (
290 "No cookies should have been sent by the cookieblocked domain")
291 # reload to verify that there are still no cookies
292 self.load_url(self.COOKIE_FIXTURE_URL)
293 self.wait_for_and_switch_to_frame("iframe[src]", timeout=1)
294 self.wait_for_any_text('body')
295 assert self.find_el_by_css('body').text == "cookies=0", (
296 "No cookies should have been sent by the cookieblocked domain")
297
298 def test_userblock_overrides_site_override(self):
299 self.add_site_override(self.THIRD_PARTY_DOMAIN, self.FIXTURE_DOMAIN)
300 self.set_user_action(self.THIRD_PARTY_DOMAIN, "block")
301 self.load_url(self.FIXTURE_URL)
302 self.assert_block()
303
304 def test_disabling_on_site(self):
305 self.block_domain(self.THIRD_PARTY_DOMAIN)
306 self.disable_badger_on_site(self.FIXTURE_URL)
307
308 self.load_url(self.FIXTURE_URL)
309 self.assert_load()
310
311 def test_disabling_on_site_parent_domain(self):
312 self.block_domain(self.THIRD_PARTY_DOMAIN)
313 self.disable_badger_on_site(self.FIXTURE_PARENT_DOMAIN)
314
315 self.load_url(self.FIXTURE_URL)
316 self.assert_load()
317
318 def test_disabling_on_site_wildcard(self):
319 self.block_domain(self.THIRD_PARTY_DOMAIN)
320 self.disable_badger_on_site("*." + self.FIXTURE_PARENT_DOMAIN)
321
322 self.load_url(self.FIXTURE_URL)
323 self.assert_load()
324
325 def test_reenabling_on_site(self):
326 self.block_domain(self.THIRD_PARTY_DOMAIN)
327 self.disable_badger_on_site(self.FIXTURE_URL)
328 self.reenable_badger_on_site(self.FIXTURE_DOMAIN)
329
330 self.load_url(self.FIXTURE_URL)
331 self.assert_block()
332
333 def test_ignoring_dnt_compliance(self):
334 """We should ignore DNT compliance when DNT policy checking is off."""
335
336 self.block_domain(self.THIRD_PARTY_DOMAIN)
337 self.set_dnt(self.THIRD_PARTY_DOMAIN)
338
339 self.load_url(self.FIXTURE_URL)
340 self.assert_load()
341 self.open_popup(self.FIXTURE_URL)
342 assert self.get_domain_slider_state(self.THIRD_PARTY_DOMAIN) == "allow", (
343 "DNT-compliant resource should be allowed")
344 self.close_window_with_url(self.FIXTURE_URL)
345
346 self.load_url(self.options_url)
347 self.wait_for_script("return window.OPTIONS_INITIALIZED")
348 self.find_el_by_css('a[href="#tab-general-settings"]').click()
349 self.find_el_by_css('#check_dnt_policy_checkbox').click()
350
351 self.load_url(self.FIXTURE_URL)
352 self.assert_block()
353 self.open_popup(self.FIXTURE_URL)
354 assert self.get_domain_slider_state(self.THIRD_PARTY_DOMAIN) == "block", (
355 "DNT-compliant resource should now be blocked")
356
357 def test_reenabling_dnt_policy_checking(self):
358 self.block_domain(self.THIRD_PARTY_DOMAIN)
359 self.set_dnt(self.THIRD_PARTY_DOMAIN)
360
361 # toggle EFF's DNT policy checking
362 self.wait_for_script("return window.OPTIONS_INITIALIZED")
363 self.find_el_by_css('a[href="#tab-general-settings"]').click()
364 self.find_el_by_css('#check_dnt_policy_checkbox').click()
365 self.driver.refresh()
366 self.wait_for_script("return window.OPTIONS_INITIALIZED")
367 self.find_el_by_css('a[href="#tab-general-settings"]').click()
368 self.find_el_by_css('#check_dnt_policy_checkbox').click()
369
370 self.load_url(self.FIXTURE_URL)
371 self.assert_load()
372
373 def test_removing_dnt(self):
374 self.block_domain(self.THIRD_PARTY_DOMAIN)
375 self.set_dnt(self.THIRD_PARTY_DOMAIN)
376
377 self.load_url(self.FIXTURE_URL)
378 self.assert_load()
379
380 assert not self.check_dnt(self.THIRD_PARTY_DOMAIN), (
381 "domain should not be DNT-compliant")
382
383 self.load_url(self.FIXTURE_URL)
384 if self.is_firefox_nightly():
385 self.driver.refresh()
386 self.assert_block()
387
388 def test_removing_domain(self):
389 # first block the domain
390 self.block_domain(self.THIRD_PARTY_DOMAIN)
391
392 # now remove it
393 self.js(
394 "chrome.runtime.sendMessage({"
395 " type: 'removeDomain',"
396 " domain: arguments[0]"
397 "});", self.THIRD_PARTY_DOMAIN)
398
399 # the domain should now load
400 self.load_url(self.FIXTURE_URL)
401 self.assert_load()
402
403
404 if __name__ == "__main__":
405 unittest.main()