forked from EFForg/badger-sett
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcrawler.py
executable file
·1187 lines (969 loc) · 44.3 KB
/
crawler.py
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
import argparse
import contextlib
import copy
import json
import logging
import os
import pathlib
import random
import re
import subprocess
import sys
import tempfile
import time
from datetime import datetime, timedelta
from fnmatch import fnmatch
from pprint import pformat
from shutil import copytree
from urllib3.exceptions import MaxRetryError, ProtocolError
from urllib.parse import urljoin, urlparse
from selenium import webdriver
from selenium.common.exceptions import (
ElementClickInterceptedException,
ElementNotInteractableException,
ElementNotVisibleException,
InvalidSessionIdException,
NoAlertPresentException,
NoSuchElementException,
NoSuchWindowException,
SessionNotCreatedException,
StaleElementReferenceException,
TimeoutException,
UnexpectedAlertPresentException,
WebDriverException,
)
from selenium.webdriver.common.by import By
from selenium.webdriver.chrome.options import Options as ChromeOptions
from selenium.webdriver.chrome.service import Service as ChromeService
from selenium.webdriver.edge.options import Options as EdgeOptions
from selenium.webdriver.firefox.options import Options as FirefoxOptions
from selenium.webdriver.firefox.service import Service as FirefoxService
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.support.ui import WebDriverWait
from tranco import Tranco
from xvfbwrapper import Xvfb
from lib.basedomain import extract
CHROME_EXT_ID = 'mcgekeccgjgcmhnhbabplanchdogjcnh'
CHROME_URL_PREFIX = 'chrome-extension://'
FF_EXT_ID = 'jid1-MnnxcxisBPnSXQ@jetpack'
FF_UUID = 'd56a5b99-51b6-4e83-ab23-796216679614'
FF_URL_PREFIX = 'moz-extension://'
CHROME = 'chrome'
FIREFOX = 'firefox'
EDGE = 'edge'
RESTART_RETRIES = 5
MAX_ALERTS = 10
# day before yesterday, as yesterday's list is sometimes not yet available
TRANCO_VERSION = (datetime.utcnow() - timedelta(days=2)).strftime('%Y-%m-%d')
# Privacy Badger storage keys not for export/import
STORAGE_KEYS_TO_IGNORE = ['cookieblock_list', 'dnt_hashes', 'settings_map', 'private_storage']
def create_argument_parser():
ap = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
ap.add_argument('browser', choices=[CHROME, EDGE, FIREFOX],
help='browser to use')
ap.add_argument('num_sites', type=int,
help='number of websites to visit')
ap.add_argument('--timeout', type=float, default=30.0,
help="time in seconds to allow each site to finish loading")
ap.add_argument('--wait-time', type=float, default=5.0,
help="time in seconds to wait on each site after it loads")
ap.add_argument('--log-stdout', action='store_true', default=False,
help="log to stdout as well as to log.txt")
feat = ap.add_argument_group("scan modes and features")
feat.add_argument('--no-blocking', action='store_true', default=False,
help="disables blocking and snitch_map limits in Privacy Badger")
feat.add_argument('--no-link-clicking', action='store_true', default=False,
help="disables finding and clicking internal links on sites")
feat.add_argument('--take-screenshots', action='store_true', default=False,
help=f"saves screenshots to {os.path.join('OUT_DIR', 'screenshots')}")
feat.add_argument('--load-extension', default=None,
help="extension (.crx or .xpi) to install in addition to Privacy Badger")
feat.add_argument('--get-sitelist-only', action='store_true', default=False,
help="output the site list and exit")
sites = ap.add_argument_group("site list arguments")
sites.add_argument('--site-list', '--domain-list', default=None,
help="load site domains from this file instead of Tranco")
sites.add_argument('--exclude', default=None,
help="exclude domains that end with one of the specified "
"comma-separated suffixes; for example: .gov,.gov.?? will "
"exclude domains that end with .gov and also exclude "
"domains that end with .gov. followed by any two letters")
sites.add_argument('--exclude-failures-since', metavar='DATE', default='1 week',
help="how far back to look in git history for log.txt "
"for failed sites to auto-exclude from the site list; "
"set to 'off' to disable this feature")
pb_data = ap.add_argument_group("Badger data arguments")
pb_data.add_argument('--load-data', metavar='BADGER_DATA_JSON', action='append', default=[],
help="load tracker data from specified Badger data file")
pb_data.add_argument('--load-data-ignore-sites', default=None,
help="comma-separated list of site eTLD+1 domains to ignore "
"when merging data sets")
# Arguments below should never have to be used within the docker container.
ap.add_argument('--out-dir', '--out-path', dest='out_dir', default='./',
help="path at which to save output")
ap.add_argument('--pb-dir', '--pb-path', dest='pb_dir', default='./privacybadger',
help="path to the Privacy Badger source checkout")
ap.add_argument('--browser-binary', default=None,
help="path to the browser binary, "
"for example /usr/bin/google-chrome-beta")
ap.add_argument('--chromedriver-path', default=None,
help="path to the ChromeDriver binary")
ap.add_argument('--firefox-tracking-protection',
choices=("off", "standard", "strict"), default="off",
help="Firefox Enhanced Tracking Protection setting")
ap.add_argument('--no-xvfb', action='store_true', default=False,
help="set to disable the virtual display")
return ap
def run(cmd, cwd=pathlib.Path(__file__).parent.resolve()):
"""Convenience wrapper for getting the output of CLI commands"""
return subprocess.run(cmd, capture_output=True, check=True,
cwd=cwd, text=True).stdout.strip()
def get_git_info(path):
git_info = {
'branch': None,
'commit_hash': None
}
commit_hash = run("git rev-parse HEAD".split(" "), cwd=path)
git_info['commit_hash'] = commit_hash
branch = run("git rev-parse --abbrev-ref HEAD".split(" "), cwd=path)
if branch != "HEAD":
git_info['branch'] = branch
return git_info
def get_recently_failed_domains(since_date):
"""Returns a set of domains that errored or consistently timed out
in recent scans."""
domains = set()
if not since_date or since_date == "off":
return domains
revisions = run(["git", "rev-list", f"--since='{since_date}'", "HEAD", "--", "log.txt"])
if not revisions:
return domains
revisions = revisions.split('\n')
error_pattern = re.compile("(?:Error loading|Exception on) ([^: ]+):")
num_scans = len(revisions)
timeout_pattern = re.compile("Timed out loading ([^ ]+)$")
timeout_counts = {}
logs = []
for rev in revisions:
log_txt = run(f"git show {rev}:log.txt".split(" "))
for line in log_txt.split('\n'):
if matches := error_pattern.search(line):
domains.add(matches.group(1))
elif matches := timeout_pattern.search(line):
domain = matches.group(1)
timeout_counts[domain] = timeout_counts.get(domain, 0) + 1
if num_scans > 1:
logs.append(log_txt)
if num_scans == 1: # not enough data to look at timeouts
return domains
for domain, count in timeout_counts.items():
if count >= num_scans:
# site timed out in all recent scans
domains.add(domain)
elif count > 1:
num_visits = sum(1 for log_txt in logs if re.search(
r"Visiting \d+: " + domain, log_txt))
if count == num_visits:
# site timed out in all recent scans **that it appeared in**
domains.add(domain)
return domains
# Force a 'Failed to decode response from marionette' crash.
# Example from https://bugzilla.mozilla.org/show_bug.cgi?id=1401131
def test_crash(driver):
driver.set_context("chrome")
driver.execute_script("""
// Copied from crash me simple
Components.utils.import("resource://gre/modules/ctypes.jsm");
// ctypes checks for NULL pointer derefs, so just go near-NULL.
var zero = new ctypes.intptr_t(8);
var badptr = ctypes.cast(zero, ctypes.PointerType(ctypes.int32_t));
var crash = badptr.contents;""")
# determine whether we need to restart the webdriver after an error
def should_restart(e):
ERROR_STRINGS = (
"chrome not reachable",
"disconnected: not connected to DevTools",
"response from marionette",
"tab crashed",
"TypeError: this.curBrowser.contentBrowser is null",
"unknown error: failed to close window in 20 seconds",
"unknown error: session deleted because of page crash",
)
EXCEPTION_TYPES = (
InvalidSessionIdException,
NoSuchWindowException,
SessionNotCreatedException,
)
if isinstance(e, EXCEPTION_TYPES):
return True
if any(txt in e.msg for txt in ERROR_STRINGS):
return True
return False
def wait_for_script(driver, script, *script_args, execute_async=False, timeout=30,
message="Timed out waiting for execute_script to eval to True"):
def execute_script(dr):
if execute_async: return dr.execute_async_script(script, *script_args)
return dr.execute_script(script, *script_args)
return WebDriverWait(driver, timeout).until(execute_script, message)
def dismiss_alert(driver, accept=False):
try:
alert = driver.switch_to.alert
if accept:
alert.accept()
else:
alert.dismiss()
except NoAlertPresentException:
pass
def internal_link(page_url, link_href):
# path components we care about when looking for links to click
wanted_paths = ["news", "article", "articles", "story", "blog", "world",
"video", "videos", "media", "artikel", "news-story",
"noticias", "actualite", "actualites", "nachrichten",
"nyheter", "noticia", "haber", "notizie"]
today = datetime.today()
start_year = today.year - 2
wanted_paths = [
str(year) for year in range(start_year, start_year + 3)
] + wanted_paths
wanted_paths.append('{d.year}{d.month:02}{d.day:02}'.format(d=today))
wanted_paths.append('{d.year}-{d.month:02}-{d.day:02}'.format(d=today))
try:
link_parts = urlparse(link_href)
except ValueError:
return False
if link_parts.path == "/":
return False
# only keep links that point somewhere else within the site we are on
if link_href.startswith(page_url):
if link_href.startswith(page_url + '#'):
return False
# limit to news/blog/media articles for now
if all('/' + x + '/' not in link_parts.path or link_parts.path.endswith('/' + x + '/') for x in wanted_paths):
return False
# also keep links that point to different news/blog/media
# subdomains of the same base domain
else:
netloc_parts = link_parts.netloc.split('.')
if netloc_parts[0] not in wanted_paths or not page_url.endswith('.'.join(netloc_parts[1:]) + '/'):
return False
# if there is a file extension, limit to allowed extensions
ext = os.path.splitext(link_parts.path)[1]
if ext and ext not in ('.html', '.php', '.htm', '.aspx', '.shtml', '.jsp', '.asp'):
return False
return True
class Crawler:
def __init__(self, opts):
self.browser_binary = opts.browser_binary
self.browser = opts.browser
self.chromedriver_path = opts.chromedriver_path
self.site_list = opts.site_list
self.exclude_domains = get_recently_failed_domains(opts.exclude_failures_since)
self.exclude_suffixes = opts.exclude
self.firefox_tracking_protection = opts.firefox_tracking_protection
self.last_data = None
self.load_data_ignore_sites = opts.load_data_ignore_sites
self.load_extension = opts.load_extension
self.logger = logging.getLogger()
self.no_blocking = opts.no_blocking
self.num_sites = opts.num_sites
self.out_dir = opts.out_dir
self.pb_dir = opts.pb_dir
self.no_link_clicking = opts.no_link_clicking
self.take_screenshots = opts.take_screenshots
self.timeout = opts.timeout
self.version = time.strftime('%Y.%-m.%-d', time.localtime())
self.wait_time = opts.wait_time
pathlib.Path(self.out_dir).mkdir(exist_ok=True)
def init_logging(self, log_stdout):
self.logger.setLevel(logging.INFO)
log_fmt = logging.Formatter('%(asctime)s %(message)s')
# by default, just log to file
fh = logging.FileHandler(os.path.join(self.out_dir, 'log.txt'))
fh.setFormatter(log_fmt)
self.logger.addHandler(fh)
# log to stdout as well if configured
if log_stdout:
sh = logging.StreamHandler(sys.stdout)
sh.setFormatter(log_fmt)
self.logger.addHandler(sh)
def log_scan_summary(self):
git_data = get_git_info(self.pb_dir)
self.logger.info(
(
"Starting new crawl:\n\n"
" browser: %s\n"
" Badger branch: %s\n"
" Badger hash: %s\n"
" blocking: %s\n"
" timeout: %ss\n"
" wait time: %ss\n"
" site list: %s\n"
" domains to crawl: %d\n"
" suffixes to exclude: %s\n"
" domains to exclude: %s\n"
" parallel extension: %s\n"
" driver capabilities:\n\n%s\n"
),
f"Firefox (ETP {self.firefox_tracking_protection})" if self.browser == FIREFOX else self.browser.capitalize(),
git_data['branch'],
git_data['commit_hash'],
"off" if self.no_blocking else "standard",
self.timeout,
self.wait_time,
self.site_list if self.site_list else "Tranco " + TRANCO_VERSION,
self.num_sites,
self.exclude_suffixes,
self.get_exclude_domains_summary(),
self.load_extension,
pformat(self.driver.capabilities)
)
def get_exclude_domains_summary(self):
if not self.exclude_domains:
return None
sample_size = 5
if len(self.exclude_domains) <= sample_size:
return ", ".join(self.exclude_domains)
sample = [];
for domain in self.exclude_domains:
sample.append(domain)
if len(sample) == sample_size:
break
return ", ".join(sample) + f" and {len(self.exclude_domains) - sample_size} more"
def handle_alerts_and(self, fun):
num_tries = 0
while True:
num_tries += 1
try:
res = fun()
break
except UnexpectedAlertPresentException as uape:
if num_tries > MAX_ALERTS:
raise WebDriverException("Too many alerts") from uape
# first dismiss, next time accept, then dismiss, ...
dismiss_alert(self.driver, not bool(num_tries % 2))
return res
def get_firefox_options(self):
opts = FirefoxOptions()
if self.browser_binary:
opts.binary_location = self.browser_binary
#opts.log.level = "trace"
opts.set_capability("acceptInsecureCerts", False);
opts.set_capability("unhandledPromptBehavior", "ignore");
opts.set_preference(
'extensions.webextensions.uuids', f'{{"{FF_EXT_ID}": "{FF_UUID}"}}')
opts.set_preference("dom.webdriver.enabled", False)
# disable prefetching
opts.set_preference("network.dns.disablePrefetch", True)
opts.set_preference("network.prefetch-next", False)
# disable OpenH264 codec downloading
opts.set_preference("media.gmp-gmpopenh264.enabled", False)
opts.set_preference("media.gmp-manager.url", "")
# disable health reports
opts.set_preference("datareporting.healthreport.service.enabled", False)
opts.set_preference("datareporting.healthreport.uploadEnabled", False)
opts.set_preference("datareporting.policy.dataSubmissionEnabled", False)
# disable experiments
opts.set_preference("experiments.enabled", False)
opts.set_preference("experiments.supported", False)
opts.set_preference("experiments.manifest.uri", "")
# disable telemetry
opts.set_preference("toolkit.telemetry.enabled", False)
opts.set_preference("toolkit.telemetry.unified", False)
opts.set_preference("toolkit.telemetry.archive.enabled", False)
if self.firefox_tracking_protection == "off":
# disable all content blocking/Tracking Protection features
# https://wiki.mozilla.org/Security/Tracking_protection
opts.set_preference("privacy.trackingprotection.enabled", False)
opts.set_preference("privacy.trackingprotection.pbmode.enabled", False)
opts.set_preference("privacy.trackingprotection.cryptomining.enabled", False)
opts.set_preference("privacy.trackingprotection.fingerprinting.enabled", False)
opts.set_preference("privacy.trackingprotection.socialtracking.enabled", False)
# always allow third-party cookies
opts.set_preference("network.cookie.cookieBehavior", 0)
elif self.firefox_tracking_protection == "strict":
opts.set_preference("browser.contentblocking.category", "strict")
return opts
def start_driver(self):
"""Start a new Selenium web driver and install the bundled
extension."""
if self.browser in (CHROME, EDGE):
# make extension ID constant across runs
# create temp directory
# TODO does tmp_dir actually get cleaned up?
self.tmp_dir = tempfile.TemporaryDirectory() # pylint:disable=consider-using-with
new_extension_path = os.path.join(self.tmp_dir.name, "src")
# copy extension sources there
copytree(os.path.join(self.pb_dir, 'src'), new_extension_path)
# update manifest.json
manifest_path = os.path.join(new_extension_path, "manifest.json")
with open(manifest_path, "r", encoding="utf-8") as f:
manifest = json.load(f)
# this key and the extension ID
# must both be derived from the same private key
manifest['key'] = "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArMdgFkGsm7nOBr/9qkx8XEcmYSu1VkIXXK94oXLz1VKGB0o2MN+mXL/Dsllgkh61LZgK/gVuFFk89e/d6Vlsp9IpKLANuHgyS98FKx1+3sUoMujue+hyxulEGxXXJKXhk0kGxWdE0IDOamFYpF7Yk0K8Myd/JW1U2XOoOqJRZ7HR6is1W6iO/4IIL2/j3MUioVqu5ClT78+fE/Fn9b/DfzdX7RxMNza9UTiY+JCtkRTmm4ci4wtU1lxHuVmWiaS45xLbHphQr3fpemDlyTmaVoE59qG5SZZzvl6rwDah06dH01YGSzUF1ezM2IvY9ee1nMSHEadQRQ2sNduNZWC9gwIDAQAB" # noqa:E501 pylint:disable=line-too-long
# remove the 5MB limit on Chrome extension local storage
if 'unlimitedStorage' not in manifest['permissions']:
manifest['permissions'].append('unlimitedStorage')
with open(manifest_path, "w", encoding="utf-8") as f:
json.dump(manifest, f)
opts = ChromeOptions() if self.browser == CHROME else EdgeOptions()
if self.browser_binary:
opts.binary_location = self.browser_binary
opts.add_argument("--load-extension=" + new_extension_path)
# loads parallel extension to run alongside pb
if self.load_extension:
opts.add_extension(self.load_extension)
opts.add_argument("--disable-blink-features=AutomationControlled")
opts.add_argument("--disable-crash-reporter")
opts.set_capability("acceptInsecureCerts", False);
opts.set_capability("unhandledPromptBehavior", "ignore");
# TODO Edge-specific settings? disable Tracking Prevention by default?
for _ in range(5):
try:
if self.browser == CHROME:
if self.chromedriver_path:
service = ChromeService(executable_path=self.chromedriver_path)
self.driver = webdriver.Chrome(options=opts, service=service)
else:
self.driver = webdriver.Chrome(options=opts)
else:
self.driver = webdriver.Edge(options=opts)
except ConnectionResetError as e:
self.logger.warning((
"%s WebDriver initialization failed:\n"
"%s\n"
"Retrying ..."), self.browser.capitalize(), str(e))
time.sleep(2)
else:
break
elif self.browser == FIREFOX:
opts = self.get_firefox_options()
service = FirefoxService(log_output=os.path.devnull)
self.driver = webdriver.Firefox(options=opts, service=service)
# load Privacy Badger
# Firefox requires absolute paths
unpacked_addon_path = os.path.abspath(
os.path.join(self.pb_dir, 'src'))
self.driver.install_addon(unpacked_addon_path, temporary=True)
# loads parallel extension to run alongside pb
if self.load_extension:
parallel_extension_url = os.path.abspath(self.load_extension)
self.driver.install_addon(parallel_extension_url)
# apply timeout settings
self.driver.set_page_load_timeout(self.timeout)
self.driver.set_script_timeout(self.timeout)
self.driver.maximize_window()
# wait for Badger to finish initializing
self.load_extension_page()
wait_for_script(self.driver, (
"let done = arguments[arguments.length - 1];"
"chrome.runtime.sendMessage({"
" type: 'isBadgerInitialized'"
"}, r => done(r));"), execute_async=True)
# also disable the welcome page
self.driver.execute_async_script(
"let done = arguments[arguments.length - 1];"
"chrome.runtime.sendMessage({"
" type: 'updateSettings',"
" data: { showIntroPage: false }"
"}, () => {"
" chrome.tabs.query({}, (res) => {"
" let welcome_tab = res && res.find("
" tab => tab.url == chrome.runtime.getURL('skin/firstRun.html'));"
" if (!welcome_tab) {"
" return done();"
" }"
" chrome.tabs.remove(welcome_tab.id, done);"
" });"
"});")
def load_extension_page(self):
"""Loads Privacy Badger's options page."""
if self.browser in (CHROME, EDGE):
url = f'{CHROME_URL_PREFIX}{CHROME_EXT_ID}/skin/options.html'
elif self.browser == FIREFOX:
url = f'{FF_URL_PREFIX}{FF_UUID}/skin/options.html'
def _load_ext_page():
self.driver.get(url)
# wait for extension page to be ready
wait_for_script(self.driver, "return chrome.extension")
max_tries = 7
max_timeouts = 3
num_timeouts = 0
for _ in range(max_tries):
try:
self.handle_alerts_and(_load_ext_page)
break
except (MaxRetryError, ProtocolError) as e:
self.logger.warning("Error loading extension page:\n%s", str(e))
self.restart_browser()
except TimeoutException:
num_timeouts += 1
self.logger.warning("Timed out loading extension page")
if num_timeouts >= max_timeouts:
num_timeouts = 0
self.restart_browser()
except WebDriverException as err:
self.logger.warning(
"Error loading extension page (%s): %s",
type(err).__name__, err.msg)
if should_restart(err):
self.restart_browser()
else:
raise WebDriverException("Failed to load extension page")
def load_user_data(self, data):
"""Load saved user data into Privacy Badger after a restart"""
self.load_extension_page()
self.driver.execute_async_script((
"let done = arguments[arguments.length - 1];"
"chrome.runtime.sendMessage({"
" type: 'mergeData',"
" data: arguments[0]"
"}, done);"), data)
# force Badger data to get written to disk
for store_name in data.keys():
if store_name in STORAGE_KEYS_TO_IGNORE:
continue
self.driver.execute_async_script((
"let done = arguments[arguments.length - 1];"
"chrome.runtime.sendMessage({"
" type: 'syncStorage',"
" storeName: arguments[0]"
"}, done);"), store_name)
def dump_data(self):
"""Extract the objects Privacy Badger learned during its training
run."""
data = {}
self.load_extension_page()
store_keys = self.driver.execute_async_script(
"let done = arguments[arguments.length - 1];"
"chrome.storage.local.get(null, r=>done(Object.keys(r)));")
if 'action_map' not in store_keys:
store_keys.append('action_map')
if 'snitch_map' not in store_keys:
store_keys.append('snitch_map')
for store_name in store_keys:
if store_name in STORAGE_KEYS_TO_IGNORE:
continue
data[store_name] = self.driver.execute_async_script((
"let done = arguments[arguments.length - 1],"
" store_name = arguments[0];"
"chrome.runtime.sendMessage({"
" type: 'syncStorage',"
" storeName: store_name"
"}, function () {"
" chrome.storage.local.get([store_name], function (res) {"
" done(res[store_name]);"
" });"
"});"
), store_name)
return data
def clear_data(self):
"""Clear the training data Privacy Badger starts with."""
self.load_extension_page()
self.driver.execute_async_script((
"let done = arguments[arguments.length - 1];"
"chrome.runtime.sendMessage({"
" type: 'removeAllData'"
"}, done);"
))
def raise_on_datadome_pages(self):
try:
self.driver.find_element(By.CSS_SELECTOR,
"iframe[src^='https://geo.captcha-delivery.com/captcha/']")
raise WebDriverException("Reached DataDome security page")
except NoSuchElementException:
pass
def raise_on_security_pages(self):
"""
Detects and errors out on anti-bot CAPTCHA or challenge pages.
"""
if self.driver.title in ("Attention Required! | Cloudflare", "Just a moment..."):
if 'https://challenges.cloudflare.com' in self.driver.page_source:
raise WebDriverException("Reached Cloudflare security page")
self.raise_on_datadome_pages()
def raise_on_chrome_error_pages(self):
# TODO update for changes in Chrome 85? now Chrome raises in many cases
"""
Chrome doesn't automatically raise WebDriverExceptions on error pages.
This makes Chrome behave more like Firefox.
"""
if self.browser != CHROME:
return
# self.driver.current_url has the URL we tried, not the error page URL
actual_page_url = self.handle_alerts_and(
lambda: self.driver.execute_script("return document.location.href"))
if not actual_page_url or not actual_page_url.startswith("chrome-error://"):
return
error_text = self.driver.find_element(By.TAG_NAME, "body").text
error_code = error_text
# for example: ERR_NAME_NOT_RESOLVED
matches = re.search('(ERR_.+)', error_text)
if not matches:
# for example: HTTP ERROR 404
# TODO these don't seem to be caught by Firefox
matches = re.search('(HTTP ERROR \\d+)', error_text)
if matches:
error_code = matches.group(1)
if error_code:
msg = "Reached error page: " + error_code
else:
msg = "Reached unknown error page (basic auth prompt?)"
raise WebDriverException(msg)
def take_screenshot(self, domain):
pathlib.Path(self.out_dir + '/screenshots').mkdir(exist_ok=True)
filename = os.path.join(self.out_dir, "screenshots", "".join((
str(int(time.time())),
"-",
re.sub(r'[^a-z0-9]', '-', domain.lower()[:100]),
".png")))
if not self.driver.save_screenshot(filename):
self.logger.warning("Failed to save screenshot for %s", domain)
def scroll_page(self):
# split self.wait_time into INTERVAL_SEC intervals
INTERVAL_SEC = 0.1
def _scroll_down():
self.driver.execute_script(
"window.scrollBy(0, arguments[0]);",
abs(random.normalvariate(50, 25)))
for _ in range(int(self.wait_time / INTERVAL_SEC)):
time.sleep(INTERVAL_SEC)
# scroll a bit during every interval
self.handle_alerts_and(_scroll_down)
def gather_internal_links(self):
links = []
curl = self.driver.current_url
for i, el in enumerate(self.driver.find_elements(By.TAG_NAME, 'a')):
# limit to checking 200 links
if i > 199:
break
try:
href = el.get_property('href')
except AttributeError:
# AttributeError: 'NoneType' object has no attribute 'get_property'
continue
except StaleElementReferenceException:
continue
if not href:
continue
if not isinstance(href, str):
# normalize SVG links (href is an SVGAnimatedString object)
if "baseVal" in href:
href = href['baseVal']
if href:
href = urljoin(curl, href)
else:
self.logger.warning("Skipping unexpected href: %s", href)
continue
if not href.startswith("http") or not internal_link(curl, href):
continue
# remove duplicates
if href in [link[0] for link in links]:
continue
links.append((href, el))
# limit to 30 valid links
if len(links) > 29:
break
return links
def click_internal_link(self):
links = self.gather_internal_links()
if not links or len(links) < 10:
return
# sort by link length (try to prioritize article links)
links.sort(key=lambda item: (-len(item[0]), item[0]))
# take top ten
links = links[:10]
link_href, link_el = random.choice(links)
self.logger.info("Clicking on %s", link_href)
try:
curl = self.driver.current_url
cwindows = self.driver.window_handles
try:
link_el.click()
except (ElementClickInterceptedException, ElementNotInteractableException, ElementNotVisibleException):
self.driver.execute_script("arguments[0].click()", link_el)
try:
WebDriverWait(self.driver, 15).until(EC.any_of(
EC.url_changes(curl),
EC.new_window_is_opened(cwindows)))
except TimeoutException:
pass
except WebDriverException as e:
self.logger.error(
"Failed to visit link (%s): %s", type(e).__name__, e.msg)
else:
# TODO wait for the page to actually load first
self.scroll_page()
def get_domain(self, domain):
"""
Visit a domain, then spend `self.wait_time` seconds on the site
waiting for dynamic loading to complete.
"""
url = f"http://{domain}/"
self.handle_alerts_and(lambda: self.driver.get(url))
self.raise_on_chrome_error_pages()
self.raise_on_security_pages()
self.scroll_page()
self.raise_on_datadome_pages()
if not self.no_link_clicking:
self.click_internal_link()
# if any new tabs/windows got opened, close them now
handles = self.driver.window_handles
if len(list(handles)) > 1:
for handle in handles[1:]:
self.driver.switch_to.window(handle)
if self.take_screenshots:
self.take_screenshot(domain + "-" + self.driver.current_url)
self.driver.close()
self.driver.switch_to.window(handles[0])
if self.take_screenshots:
self.take_screenshot(domain + "-" + self.driver.current_url)
return url
def get_sitelist(self):
"""Get the top n sites from the Tranco list"""
domains = []
if self.site_list:
# read in domains from file
with open(self.site_list, encoding="utf-8") as f:
for line in f:
domain = line.strip()
if domain and domain[0] != '#':
domains.append(domain)
else:
self.logger.info("Fetching Tranco list ...")
domains = Tranco(cache_dir=tempfile.gettempdir()).list(TRANCO_VERSION).top()
# filter domains
filtered_domains = []
suffixes = self.exclude_suffixes.split(",") if self.exclude_suffixes else []
wildsuffixes = ['*' + suffix for suffix in suffixes if "?" in suffix]
suffixes = [suffix for suffix in suffixes if "?" not in suffix]
for domain in domains:
if domain in self.exclude_domains:
continue
if domain.startswith("google.") and domain != "google.com":
continue
if suffixes:
if any(domain.endswith(suffix) for suffix in suffixes):
continue
if wildsuffixes:
if any(fnmatch(domain, suffix) for suffix in wildsuffixes):
continue
filtered_domains.append(domain)
# return the list if we gathered enough
if len(filtered_domains) == self.num_sites:
return filtered_domains
return filtered_domains
def start_browser(self):
self.start_driver()
self.clear_data()
self.load_extension_page()
if self.no_blocking:
# set blocking threshold to infinity,
# to never learn to block (and create unlimited snitch_map entries)
self.driver.execute_script(
"chrome.runtime.sendMessage({"
" type: 'setBlockThreshold',"
" value: Number.MAX_VALUE"
"})")
if self.load_data_ignore_sites:
self.driver.execute_async_script(
"let done = arguments[arguments.length - 1];"
"chrome.runtime.sendMessage({"
" type: 'setIgnoredSiteBases',"
" value: arguments[0].split(',')"
"}, r => done());", self.load_data_ignore_sites)
# enable local learning
wait_for_script(self.driver, "return window.OPTIONS_INITIALIZED")
try:
self.driver.find_element(By.ID, 'local-learning-checkbox').click()
except NoSuchElementException:
self.logger.warning("Learning checkbox not found, learning NOT enabled!")
def restart_browser(self):
self.logger.info("Restarting browser ...")
# It's ugly, but this section needs to be ABSOLUTELY crash-proof.
for _ in range(RESTART_RETRIES):
try:
self.driver.quit()
except: # noqa:E722 pylint:disable=bare-except
pass
try:
del self.driver
except: # noqa:E722 pylint:disable=bare-except
pass
try:
self.start_browser()
if self.last_data:
self.load_user_data(self.last_data)
else:
self.logger.warning("No data to load on restart!")
self.logger.info("Successfully restarted")
break
except Exception as e:
self.logger.error("Error restarting browser. Retrying ...")
if isinstance(e, WebDriverException):
self.logger.error('%s: %s', type(e).__name__, e.msg)
else:
self.logger.error('%s: %s', type(e).__name__, e)
else:
# If we couldn't restart the browser after all that, just quit.
self.logger.error("Could not restart browser")
sys.exit(1)
def log_snitch_map_changes(self, old_snitches, new_snitches):
diff = set(new_snitches) - set(old_snitches)
if diff:
self.logger.info("New domains in snitch_map: %s", ', '.join(sorted(diff)))
def crawl(self):