selenium_tor 1.5.4 → 1.7.0

data/fonts/fonts.conf

@@ -0,0 +1,183 @@
+<?xml version="1.0"?>
+<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
+<!--
+**DO NOT EDIT THIS FILE!**
+This file sets Tor Browser's bundled fonts as the only available system fonts
+and standardizes rendering settings.
+Any changes might deanonymize you, or expose you to fingerprinting vectors.
+-->
+<!--
+Derived from fonts.conf.in of Fontconfig.
+
+Copyright © 2000,2001,2002,2003,2004,2006,2007 Keith Packard
+Copyright © 2005 Patrick Lam
+Copyright © 2009 Roozbeh Pournader
+Copyright © 2008,2009 Red Hat, Inc.
+Copyright © 2008 Danilo Šegan
+Copyright © 2012 Google, Inc.
+
+
+Permission to use, copy, modify, distribute, and sell this software and its
+documentation for any purpose is hereby granted without fee, provided that
+the above copyright notice appear in all copies and that both that
+copyright notice and this permission notice appear in supporting
+documentation, and that the name of the author(s) not be used in
+advertising or publicity pertaining to distribution of the software without
+specific, written prior permission.  The authors make no
+representations about the suitability of this software for any purpose.  It
+is provided "as is" without express or implied warranty.
+
+THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
+EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+-->
+<fontconfig>
+
+<!-- Font directory list -->
+
+	<dir prefix="cwd">fonts</dir>
+
+<!--
+  Accept deprecated 'mono' alias, replacing it with 'monospace'
+-->
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>mono</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>monospace</string>
+		</edit>
+	</match>
+
+<!--
+  Accept alternate 'sans serif' spelling, replacing it with 'sans-serif'
+-->
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>sans serif</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>sans-serif</string>
+		</edit>
+	</match>
+
+<!--
+  Accept deprecated 'sans' alias, replacing it with 'sans-serif'
+-->
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>sans</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>sans-serif</string>
+		</edit>
+	</match>
+
+<!--
+  Set our default generic families.
+-->
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>sans-serif</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Arimo</string>
+		</edit>
+	</match>
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>serif</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Tinos</string>
+		</edit>
+	</match>
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>monospace</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Cousine</string>
+		</edit>
+	</match>
+
+<!--
+  tor-browser#41799, tor-browser-build#41237: Add some aliases for
+  compatibility.
+-->
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>Arial</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Arimo</string>
+		</edit>
+	</match>
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>Times New Roman</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Tinos</string>
+		</edit>
+	</match>
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>Courier New</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Cousine</string>
+		</edit>
+	</match>
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>Helvetica</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Arimo</string>
+		</edit>
+	</match>
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>Times</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Tinos</string>
+		</edit>
+	</match>
+	<match target="pattern">
+		<test qual="any" name="family">
+			<string>Courier</string>
+		</test>
+		<edit name="family" mode="assign" binding="same">
+			<string>Cousine</string>
+		</edit>
+	</match>
+
+<!-- Font cache directory list -->
+
+	<cachedir prefix="xdg">fontconfig</cachedir>
+
+	<config>
+<!--
+  Rescan configuration every 30 seconds when FcFontSetList is called
+ -->
+		<rescan>
+			<int>30</int>
+		</rescan>
+	</config>
+
+	<!-- Standardize rendering settings. -->
+	<match target="pattern">
+		<edit name="antialias" mode="assign"><bool>true</bool></edit>
+		<edit name="autohint" mode="assign"><bool>false</bool></edit>
+		<edit name="hinting" mode="assign"><bool>true</bool></edit>
+		<edit name="hintstyle" mode="assign"><const>hintfull</const></edit>
+		<edit name="lcdfilter" mode="assign"><const>lcddefault</const></edit>
+		<edit name="rgba" mode="assign"><const>none</const></edit>
+	</match>
+</fontconfig>

data/lib/tor/driver.rb

@@ -29,8 +29,7 @@ module Selenium
           @data_dir = Dir.mktmpdir
           @options = options || Options.new # fix for issue #11, 'tis a puzzlement
           add_torrc_path_to_options
-          # @instance = DriverDelegate.new(options: @options, **)
-          @instance = DriverDelegate.new(options: @options, **, service: service)
+          @instance = DriverDelegate.new(options: @options, **)
           install_extensions @instance
           create_tor_process_and_start_tor @options.tor_opts
           super(@instance)
@@ -88,12 +87,6 @@ module Selenium
         def domain
           URI(current_url).host&.match(/[^\.]+\.\w+$/)
         end
-
-        def service
-          service = Service.tor
-          service.args << '--enable-crash-reporter' # BUG: 18, https://github.com/mozilla/geckodriver/issues/2202
-          service
-        end
       end
     end
   end

data/lib/tor/libxul_checksums.yml

@@ -1,4 +1,83 @@
 ---
+14.5.2:
+  unpatched_libxul: 0e4d960cb427df67a25ab50aa934272e7ac7ee3487c709e48d97e2611e2ae930
+  patched_libxul: 20579db140991d77db1a3ffa3e248752dd689bf4156056402cbe1fd6287430c1
+  patch_checksum: d6db59104c809ee3c9232e093e85b34abc02069ccf63beb2102f371492fcd42d
+14.5.1:
+  unpatched_libxul: d3fb74cad36cb0b944b6db87d9377e81b54b0ba1dc9ffecef3ffbf95ab5f6c56
+  patched_libxul: 0092fe0b27e0bc4be47b1f925509064494effea370023bc91e39f254dc52d341
+  patch_checksum: 3746698dfe5ed5d0f56d28fa9655aff2c908252bed51f584e4822d8581e6a24f
+!!str 14.5:
+  unpatched_libxul: 8518f1b2b6b76b2d17fd32189b16e25898a4ae3bf6981613feecdec290363232
+  patched_libxul: f58a11c36cc91fefab1cf92de822d70b0f3d17e38b32c4fa37ba8287529b40c3
+  patch_checksum: 852b152872338a3d0c097607f7f2aa0b41729136bfe661bcc8427dc61789c630
+14.5a6:
+  unpatched_libxul: 7cdfdf7fa84ea5a31607595114d33d77d27eb1fea814835735c0bc0f6484a5b7
+  patched_libxul: 622f8635cf4cc82cc8c4c2db03bae44123d79c50ee910795b1f1dbe4351c9ca3
+  patch_checksum: 44682be0e6b8d885f769fc30daa4f2fdbe64367935f5f88ef6ded29a397101c5
+14.5a5:
+  unpatched_libxul: d96ab04398a1d2636be475ecc3cca747a496213c78d778304d2953b48342af3e
+  patched_libxul: 5c3e72fc6d477735013d7079828aa99cc47c662c58a7ab48fec600f159987c38
+  patch_checksum: 31aeb887eadaff88c19bcd989f6e2530f2ac931a4169e314853116ff568e0250
+14.5a4:
+  unpatched_libxul: 86b62b1794005a400fd204d130ae0dbd7e69db67e66d0db9cc374aee5a0eafdb
+  patched_libxul: 38a7ffff8cb094b7987b413ed5406699b2b137cee5d260f0da7d9b9289a36818
+  patch_checksum: e018a62d07829f4bdfc8ebf6ff2555b6705ea938c5cfdb3667b05fd118e25efe
+14.5a3:
+  unpatched_libxul: 2c865e239e20aeb785c830a922aa197cbd87337669b05ea0c0d43dc4b101efe7
+  patched_libxul: c9a0a33e747268269e269e2a01618e3f8db0c11d080a3867014e11b08b5d2be5
+  patch_checksum: 7977048cde11319a9e5a337ace40abc30e63e7be7808b438105cd90b2397beaf
+14.5a2:
+  unpatched_libxul: 764f91909cac9c90208aaa70001a52cba43ec02d8b0dab69809e542f39a3c0a2
+  patched_libxul: 3fc4c32bde0bd9f1e1ac2d22a936d9912db0cf5f5510227906dca8abb3d4648b
+  patch_checksum: 24cdd9a7755093222faff66fa79bc9c7580503c760d2fae6e0835e3c33b0dade
+14.5a1:
+  unpatched_libxul: 4586056dfd6584effa61f974e802b5b2103965326716423c2f76043e68571149
+  patched_libxul: b4463dffe43a112e509764c5e32b100bc2749112dc852244ed8817b72e631642
+  patch_checksum: a0397d3e9a86339c497bcedf3b8c4bed767284e9299e791e54266d42c2872b7d
+14.0.9:
+  unpatched_libxul: b52659cb3a202ef69acd8ba37360467daf17d7b90afdf1419f7dbefb872979cc
+  patched_libxul: af9c6c3822664f2084b404d9fd34d2e6a2d3f7d2d71f25cf9dde9e97018302fa
+  patch_checksum: 88188dfbd38bd84fa5bd5f82634fc009543ea3e16ba756ea02ffb11dd7875de6
+14.0.7:
+  unpatched_libxul: 649f05fd66e6e84fbde94907571d5bc34b59f06974cb2ebb60d1847c3c0eb1cc
+  patched_libxul: 15d8aaf658bc08b0990525ca4b45539a43e8249541f102bb19cb9050420b6047
+  patch_checksum: b30c3a09eb0a77c23f3c691c8c1a369ca8b1fefd209391e93a077779e60298a1
+14.0.6:
+  unpatched_libxul: a421a0cd73815c323ab6c2c5c676e5177425ae65830290a147ec6efbd5e25388
+  patched_libxul: e7a21cef56b25bc4b1364f953505cf8f74147fc5b48c73d204c17ab10696dae0
+  patch_checksum: 2a9d08a8d21f7ab07df7d2d4ba24c0cbde9b05cebb3f38bfa5953e22c06482c9
+14.0.5:
+  unpatched_libxul: 77d68b6ab27058addd192ba1cb23afb16eccc6bee3d96e1f2f72e1f80c6a09e6
+  patched_libxul: a5786dc865dc673f3290d55d3da324e0209f427678544f5c37e667755b2437ec
+  patch_checksum: be36849ddf1fe51922a3c192d2e97232d93ad62e1bfb2f00e98e2dcbc26a06e3
+14.0.4:
+  unpatched_libxul: 994b21b5417e704be58107cc6308de6e1c922f0cf60b9df2aac0e4f0090f373f
+  patched_libxul: ae03c3e7217b85c0f28b4d971b695f0d042723447c84a8676a372f32e7b76252
+  patch_checksum: d9f32d00ff1050774f1a90d3055f69ebac113261c082fab621244547c6ef41f5
+14.0.3:
+  unpatched_libxul: 2ddc3df2e8feb52c3bcd638249aac7d584d9c65888d67e18ad5fecceb4d5010a
+  patched_libxul: 9864cdfd750e504f06bd9eeca427f0a20d83d0bb5cd8e8232ae4a3ee4b2812b1
+  patch_checksum: 5deece766f5922c77ca4e60f194c0bdfa0374f6c80e190cdf60dd10f49d3b5e8
+14.0.2:
+  unpatched_libxul: 590a02a751951452b0f3eded2234b6c1ffc49ce794301192450a236db5ad11af
+  patched_libxul: 6a49949e01ea35f61ba0e08c05d66ec6b9591d7b148314b99a9d2e7b8334c3f4
+  patch_checksum: 8f3ab90326a7b995eebfd83018dc83b257f5699a72d3cd9754706df973a66852
+14.0.1:
+  unpatched_libxul: 02751a5f1c3390c8d8b1b062147713d9a5412797139d3a86217df3380b44a390
+  patched_libxul: 6df072f5e9f86bcd244b5dab416074754214b85f9735bc05f8d322bf136652ef
+  patch_checksum: 844e29b6131fa6d7282a0052aa81000c5decdd410da509f56e0cf9b8c24d6ca9
+!!str 14.0:
+  unpatched_libxul: 0a9c57aa19a953af56b49e944bfb950b7ba47d12fa927bb76c5ff04b8cdcf063
+  patched_libxul: 3b163b5c035376883fd49eac7fa5d90bfa536d26038ee4e36508226111936cce
+  patch_checksum: 2821841ff51fb511731810622fecb9c132e0774f5883dc500f67869c59a81509
+#######################
+# NO LONGER SUPPORTED #
+#######################
+14.0a9:
+  unpatched_libxul: af9228a9b026fb4dad1d611070421346d8f4f714f00d909bbc2bda04e4175ff4
+  patched_libxul: 7e1e5e733c8c258a92170b45d0bbcafc14beea628290cacbc013affda3082193
+  patch_checksum: cb3fef972d41f81a212b95b1b47b8b0fcb03e58271cde4bbaf6d4fe3f7ffc318
 14.0a8:
   unpatched_libxul: 3ce2cef75c68f52df50cc435c9307bae8596ecbbf53d067e0731506096fb36cd
   patched_libxul: 789bb47f02d7f5c87cae05409ea31a2cf1d222f6716c2dd81fc333f221bf8c16

data/lib/tor/libxul_patchable.rb

@@ -14,9 +14,10 @@ module Selenium
       module LibxulPatchable
         class LibxulPatchableError < StandardError; end
 
-        LIBXUL_CHECKSUMS = YAML.load_file(File.join(__dir__, 'libxul_checksums.yml'))[Tor::TBB_VERSION]
         PATCH_REPO = 'https://gitlab.com/matzfan/keymaster/-/raw/master/patches/tor-browser'
         ISSUES_URL = 'https://gitlab.com/matzfan/keymaster/-/issues'
+        NO_PATCH_MSG = "No patch for #{Tor::TBB_VERSION}, please raise an issue at #{ISSUES_URL}".freeze
+        UNDEF_REGEXP = /undefined method (`|')\[\]' for nil/
 
         def libxul_patched?
           libxul_checksum = checksum_for Tor::TBB_LIBXUL
@@ -35,7 +36,7 @@ module Selenium
           execute_patch patchfile
           FileUtils.cp libxul_patched, Tor::TBB_LIBXUL
         rescue OpenURI::HTTPError
-          raise LibxulPatchableError, "No patch for #{Tor::TBB_VERSION}, please raise an issue at #{ISSUES_URL}"
+          raise LibxulPatchableError, NO_PATCH_MSG
         end
 
         def unpatch_libxul
@@ -63,16 +64,32 @@ module Selenium
           Bsdiff.patch libxul_original, libxul_patched, patchfile
         end
 
+        def libxul_checksums
+          @libxul_checksums ||= YAML.load_file(File.join(__dir__, 'libxul_checksums.yml'))[Tor::TBB_VERSION]
+        end
+
         def unpatched_libxul_checksum_for_version
-          LIBXUL_CHECKSUMS['unpatched_libxul']
+          libxul_checksums['unpatched_libxul']
+        rescue NoMethodError => e
+          raise LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
+
+          raise e
         end
 
         def patched_libxul_checksum_for_version
-          LIBXUL_CHECKSUMS['patched_libxul']
+          libxul_checksums['patched_libxul']
+        rescue NoMethodError => e
+          raise LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
+
+          raise e
         end
 
         def patch_checksum_for_version
-          LIBXUL_CHECKSUMS['patch_checksum']
+          libxul_checksums['patch_checksum']
+        rescue NoMethodError => e
+          raise LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
+
+          raise e
         end
 
         def checksum_for(file)

data/lib/tor/options.rb

@@ -29,7 +29,6 @@ module Selenium
           opts[:tor_opts] = opts.delete(:system_tor).opts if opts[:system_tor] # DEPRECATED 2.0
           @tor_opts = opts[:tor_opts] ? opts.delete(:tor_opts) : {} # must be deleted before call to super
           do_start_tor_browser_script_stuff # stuff the start-tor-browser script in TBB does
-          copy_fonts # so we don't have to change dir before executing TB binary - issues #2 and #9
           super(log_level: log_level, **tor_options(opts.delete(:prefs)).merge(opts))
         end
 
@@ -42,17 +41,9 @@ module Selenium
         def do_start_tor_browser_script_stuff
           ENV['SESSION_MANAGER'] = nil
           ENV['XAUTHORITY'] = File.join(Dir.home, '.Xauthority') unless ENV.fetch('XAUTHORITY', nil)
-          ENV['FONTCONFIG_PATH'] = File.join TBB_BROWSER_DIR, 'fontconfig'
-          ENV['FONTCONFIG_FILE'] = 'fonts.conf'
           FileUtils.rm_rf File.join(Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data fontconfig])
           ENV['GSETTINGS_BACKEND'] = 'memory'
         end
-
-        def copy_fonts
-          return unless Dir[File.join('fonts', '*')].size == 1 # README checked into git
-
-          FileUtils.cp(Dir[File.join(Tor::TBB_BROWSER_DIR, 'fonts', '*')], File.expand_path('fonts'))
-        end
       end
     end
   end

data/lib/tor/tor_prefs.rb

@@ -17,7 +17,7 @@ module Selenium
 
       OTHER_PREFS = {
         'intl.language_notification.shown' => true, # affects font fingerprint (viewport size)
-        'remote.active-protocols' => 3, # CDP & BiDi future support
+        'remote.active-protocols' => 1, # BiDi only >= 4.32 https://github.com/SeleniumHQ/selenium/pull/15224/files
         'extensions.torlauncher.start_tor' => false
       }.freeze
 

data/lib/tor/tor_process.rb

@@ -13,13 +13,19 @@ module Selenium
         BOOTSTRAP_SUCCESS_REGEX = /Bootstrapped 100% \(done\): Done$/
         BOOTSTRAP_FAIL_REGEX = /^[A-Z][a-z]{2} \d{2} \d{2}:\d{2}:\d{2}\.\d{3} \[err\] .*/
 
+        DIR_MSG = 'data_dir must exist and be a dir'
+        DATA_FILES = %w[cached-certs cached-microdesc-consensus cached-microdescs.new].freeze
+
+        class << self
+          attr_accessor :cached_certs, :cached_microdesc_consensus, :cached_microdescs # set when tor first started
+        end
+
         attr_reader :pid, :config
 
         def initialize(data_dir, opts = {})
-          valid_data_dir?(data_dir)
+          setup_data_dir data_dir
           raise ArgumentError, 'TorProcess.new takes an options hash' unless opts.is_a? Hash
 
-          @data_dir = data_dir # each tor process needs a separate data directory
           @opts = map_opts_to_torrc_keys opts
           @torrc = Torrc.new(@data_dir)
           @config ||= setup_config # Hash to store torrc config
@@ -29,11 +35,11 @@ module Selenium
           r, io = IO.pipe
           pid = Process.spawn tor_command, out: io, err: :out
           io.close
-          errors = parse_tor_bootstrap_errors_with_timeout(r, timeout: timeout)
-          errors.empty? ? @pid = pid : raise(TorProcessError, "Tor failed to start with errors:\n\n#{errors}")
+          parse_tor_bootstrap_errors_with_timeout(r, timeout: timeout)
+          read_from_data_files
+          @pid = pid
         rescue Timeout::Error
-          Process.kill 'KILL', pid if pid
-          raise Error::TimeoutError, "Tor not bootstrapped after #{timeout} seconds"
+          timeout_with pid, timeout
         ensure
           r.close
         end
@@ -46,9 +52,18 @@ module Selenium
 
         private
 
-        def valid_data_dir?(dir)
-          msg = 'data_dir must exist and be a dir'
-          raise ArgumentError, msg unless Pathname.new(dir.to_s).directory? && Pathname.new(dir.to_s).empty?
+        def setup_data_dir(dir)
+          raise ArgumentError, DIR_MSG unless Pathname.new(dir.to_s).directory? && Pathname.new(dir.to_s).empty?
+
+          @data_dir = dir # each tor process needs a separate data directory
+          write_data_files_to dir
+        end
+
+        def write_data_files_to(dir)
+          DATA_FILES.each do |f|
+            var = self.class.instance_variable_get(var_from_file(f))
+            File.write(File.join(dir, f), var) if var
+          end
         end
 
         def map_opts_to_torrc_keys(opts)
@@ -66,13 +81,27 @@ module Selenium
 
         def parse_tor_bootstrap_errors_with_timeout(io, timeout:)
           lines = []
-          Timeout.timeout timeout do
+          errors = Timeout.timeout timeout do
             io.each_line do |line|
               lines << line
               break lines.join if line.match BOOTSTRAP_FAIL_REGEX
               break '' if line.match BOOTSTRAP_SUCCESS_REGEX
             end
           end
+          raise(TorProcessError, "Tor failed to start with errors:\n\n#{errors}") unless errors.empty?
+        end
+
+        def read_from_data_files
+          DATA_FILES.each { |f| self.class.instance_variable_set var_from_file(f), File.read(File.join(@data_dir, f)) }
+        end
+
+        def var_from_file(name)
+          :"@#{name.tr('-', '_').sub('.new', '')}"
+        end
+
+        def timeout_with(pid, timeout)
+          Process.kill 'KILL', pid if pid
+          raise Error::TimeoutError, "Tor not bootstrapped after #{timeout} seconds"
         end
       end
     end

data/lib/tor/version.rb

@@ -3,7 +3,7 @@
 module Selenium
   module WebDriver
     module Tor
-      VERSION = '1.5.4'
+      VERSION = '1.7.0'
     end
   end
 end