selenium_tor 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b43f3c595a9b52864114bd23e728e824349b3cd514dbc30cbf3bdaca3e1f09
-  data.tar.gz: 45a4d53c8881fa99b6530c11d28131195c57d355f1caba27e4ed51181d52b368
+  metadata.gz: d91caf67c6dbe8d0ee5a4e9e1fde84901ec736d0280dc5913b91e9d38e78bc55
+  data.tar.gz: e3e789ac86f09532c03472f52dd80c750695d71f1b7bd4b9b4521880d5f83751
 SHA512:
-  metadata.gz: a8cf7f476a0aaa8d25d79e904c4d485e147f0527bdde799f46e62f0d2b140a83ace68cf5601e5b21c2f47cb5106004cbdde1ed99ce8625444d5e906a0014a3e3
-  data.tar.gz: 81c8bef22783b315ec3e4c570f601d8dd442478b30c813c069b491b66665443f6fff05827721e7610b266f28877db38c6c85420dfa13e69e4e7e8e84b187d864
+  metadata.gz: bc39fe85b2f2cceddc76d77c4e5cbbfcc35f658a0af9376affd99d397617523705e4b5a2cf11a74785ff7bfb41bf83cfbd15b87e5472649191b4d346b75f6b64
+  data.tar.gz: 2b0aa0060db12d4f6854b47b47979e9f50b7a013a8ad550a8fdb5268c1d9c8eda76df88090a81e620845cb1e114db6e8e1430cbdd983a0d0c5a0ef7f88758360

data/.rubocop.yml

@@ -34,3 +34,6 @@ Minitest/TestMethodName:
 
 Minitest/AssertTruthy:
   Enabled: false
+
+Minitest/RefuteFalse:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## master (unreleased)
 
+## [2.0.0] - 2025-05-31
+
+### New features
+
+* SocksPort is now auto selected, 'SocksPort'/:socks_port keys are ignored in Tor::Options :tor_opts hash
+* selenium-manager is disabled (avoids chance of FF being downloaded & used)
+* errors in Tor namespace now subclass Selenium::WebDriver::Error::WebDriverError
+* drop Xvfb/headless gem dependency
+* drop deprecated :system_tor options
+
+### Bug fixes
+
+* ControlPort no longer set by default in torrc (security)
+
 ## [1.7.0] - 2025-05-21
 
 ### New features

data/README.md

@@ -8,7 +8,8 @@ A Selenium extension for Tor Browser.
 # before_all
 require 'selenium_tor'
 
-options = Selenium::WebDriver::Tor::Options.new
+options = Selenium::WebDriver::Options.tor
+options.args << '-headless'
 @driver = Selenium::WebDriver.for :tor, options: options
 ```
 When you are done don't forget to quit the driver. Failure to do so may leave orphaned tor processes.
@@ -18,6 +19,9 @@ When you are done don't forget to quit the driver. Failure to do so may leave or
 ```
 Once you have a driver instance:
 ```ruby
+@driver
+# => instance_of Selenium::WebDriver::Tor::Driver
+
 @driver.get 'https://check.torproject.org'
 @driver.title
 # => "Congratulations. This browser is configured to use Tor."
@@ -43,11 +47,11 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 [Tor Browser](https://www.torproject.org/download). Tests are conducted with the latest stable ('release') and alpha versions of Tor Browser. Support for older versions is periodically dropped - see the CHANGELOG.
 
-As with Firefox browser, `geckodriver` needs to be installed and in your PATH.
+As with Firefox browser, `geckodriver` needs to be installed and in your PATH. [Selenium Manager](https://www.selenium.dev/documentation/selenium_manager) is disabled for security reasons, so you are responsible for ensuring the correct (latest) version of geckodriver is installed.
 
 The gem needs to know the location of the Tor Browser Bundle (TBB). The Tor Browser download package archive must be extracted and the root TBB directory (named "tor-browser") placed somewhere on your system. By default it is assumed to be in the current user's HOME directory. An alternative location can be set via the env var `TOR_BROWSER_ROOT_DIR` - e.g. `export TOR_BROWSER_ROOT_DIR=/home/<user>/Downloads`. The Tor Browser binary location is *automatically set* by reference to this directory, so there is no need to do this:
 ```ruby
-options = Selenium::WebDriver::Tor::Options.new
+options = Selenium::WebDriver::Options.tor
 options.binary = '/some/path/to/tor_firefox_binary' # UNNECESSARY
 # => '/some/path/to/tor_firefox_binary'
 ```
@@ -56,21 +60,6 @@ The location of the TBB is not expected to change during code execution.
 
 Tor Selenium is tested on **Linux only** right now.
 
-### Patching libxul.so
-
-A configuration option to patch the `libxul.so` packaged with Tor Browser is provided. This has the effect of preventing websites from fingerprinting Selenium-driven Tor Browser via a JS call to `navigator.webdriver`:
-```ruby
-@driver_class = Selenium::WebDriver::Tor::Driver
-@driver_class.libxul_patched? # is Tor Browser's libxul.so patched?
-# => false
-@driver_class.patch_libxul # patch libxul.so
-@driver_class.libxul_patched?
-# => true
-@driver_class.unpatch_libxul # revert the patch and restore the libxul.so packaged with Tor Browser
-# => 0
-```
-The patcher uses the [Bsdiff](https://gitlab.com/matzfan/bsdiff) gem.
-
 ## Usage
 ```ruby
 require 'selenium_tor'
@@ -84,21 +73,17 @@ A separate tor process is used for each driver. Failure to call `Driver#quit` af
 
 ### Tor options
 
-In addition to the regular Firefox options, a :tor_opts key may be passed to an instance of `Tor::Options` with a hash of tor options. All valid tor options are recognized - see `man tor`. For convenience, "SocksPort" and "ControlPort" options may be set using snake_case symbols - i.e. :socks_port and :control_port. Additionally, a :tor_opts timeout value may be set with the :timeout key. This overrides the default time allowed for the tor process to bootstrap (10 seconds).
+In addition to the regular Firefox options, a `:tor_opts` key may be passed to an instance of `Tor::Options` with a hash of tor options. All valid tor client options are recognized - see `man tor`. Snake case key symbols may be used if these can be coerced to valid camel case key strings - e.g. `:control_port` becomes 'ControlPort'. Additionally, a `:tor_opts` timeout value may be set with the `:timeout` key. This overrides the default time allowed for the tor process to bootstrap (10 seconds).
 
 ### Multiple driver instances
 
-Running multiple tor processes requires that each uses different ports for SocksPort (and ControlPort, if used). These must be passed using the `:tor_opts` key. An example using the [Parallel gem](https://rubygems.org/gems/parallel):
+Running multiple tor processes requires that each uses different ports for SocksPort (and ControlPort, if used). From version 2.0 the SocksPort is auto selected, so no configuation is required. An example using the [Parallel gem](https://rubygems.org/gems/parallel):
 ```ruby
 require 'parallel'
 
-@socks_port = 9150
-@control_port = 9151
-
 def driver
-  @socks_port += 2
-  @control_port += 2
-  options = Selenium::WebDriver::Tor::Options.new tor_opts: { socks_port: @socks_port, control_port: @control_port }
+  options = Selenium::WebDriver::Options.tor # no needs to pass SocksPort in :tor_opts from version 2.0
+  options.args << '-headless'
   Selenium::WebDriver.for :tor, options: options
 end
 
@@ -155,24 +140,34 @@ Tor::TBB_EXTENSIONS_DIR # path to the 'extensions' directory in the above
 Tor::TBB_VERSION # the version installed, e.g. "13.0.1", note: driver.capabilities.browser_version returns the Firefox version Tor Browser is based on
 # => instance_of String
 ```
+### Patching libxul.so
 
-## Known issues
+A configuration option to patch the `libxul.so` packaged with Tor Browser is provided. This has the effect of preventing websites from fingerprinting Selenium-driven Tor Browser via a JS call to `navigator.webdriver`:
+```ruby
+@driver_class = Selenium::WebDriver::Tor::Driver
+@driver_class.libxul_patched? # is Tor Browser's libxul.so patched?
+# => false
+@driver_class.patch_libxul # patch libxul.so
+@driver_class.libxul_patched?
+# => true
+@driver_class.unpatch_libxul # revert the patch and restore the libxul.so packaged with Tor Browser
+# => 0
+```
+The patcher uses the [Bsdiff](https://gitlab.com/matzfan/bsdiff) gem.
 
-Known issues are recorded [here](https://gitlab.com/matzfan/selenium-tor/-/issues).
+### Exceptions
 
-### Fingerprinting
+Tor-specific webdriver funcionality raises `Tor::Error` or a subclass. `Tor::Error` itself subclasses `WebDriver::Error::WebDriverError`
 
-The gem uses Xvfb to allow Tor Browser to be manipulated headlessly. Xvfb in turn uses `llvmpipe` software acceleration which may lead to issues with WebGL fingerprinting - see [issue #7](https://gitlab.com/matzfan/selenium-tor/-/issues/7). If this is a problem we recommend using [VirtualGL](https://www.virtualgl.org) to force Xvfb to use your hardware driver instead. This is done by prepending your executable code with the command `vglrun`. For an example take a look at the `test_fingerprintjs_with_virtualgl.rb` test. VirtualGL can be installed from a [package repo](https://virtualgl.org/Downloads/YUM).
+## Known issues
+
+Known issues are recorded [here](https://gitlab.com/matzfan/selenium-tor/-/issues).
 
 ## Testing
 
 ~~After checking out the repo, run `bin/setup` to install dependencies.~~
 
-Tests dependencies are `Xvfb` if you want to run headless tests and `VirtualGL` (see Fingerprinting above). The latter can be skipped by setting ENV var `CI` to `true`.
-
-Tests are run in the display set by the `DISPLAY` env var, usually :0 by default. To run headless tests, set it to another value:
-
-    $ DISPLAY=:99 bundle exec rake
+    $ bundle exec rake
 
 If you find driver instantiation failing with port bind failure error messages ( these include "Address already in use. Is Tor already running?") check you have no other tor processes running with conflicting ports. With timeout errors, you may also want to check the Tor network is actually up, it isn't always..
 

data/lib/selenium_tor.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
-require 'selenium-webdriver'
+ENV['SE_OFFLINE']     = 'true' # we don't want selenium-manager getting & using firefox in error
+ENV['SE_AVOID_STATS'] = 'true' # no telemetry thanks!
+
+load 'selenium-webdriver.rb' # force load to ensure env vars are applied
+
 require_relative 'driver'

data/lib/tor/driver.rb

@@ -18,12 +18,20 @@ module Selenium
       class Driver < DelegateClass(DriverDelegate)
         extend LibxulPatchable
 
-        TORRC_PATH_PREF = 'extensions.torlauncher.torrc_path'
-        TORRC = 'torrc'
-        BROWSER_SECURITY_LEVEL_PREF = 'browser.security_level.security_slider'
-        DOMAIN_ISOLATOR = 'TorDomainIsolator' # ES6 module
-        NEW_CIRCUIT = 'newCircuitForDomain' # js function
-        TB_SEC_LEVELS = { 'standard' => 4, 'safer' => 2, 'safest' => 1 }.freeze
+        TORRC                       = 'torrc'
+
+        PREF_BROWSER_SECURITY_LEVEL = 'browser.security_level.security_slider'
+        PREF_TORRC_PATH             = 'extensions.torlauncher.torrc_path'
+        PREF_SOCKS_PORT             = 'network.proxy.socks_port'
+
+        DOMAIN_ISOLATOR             = 'TorDomainIsolator' # ES6 module
+        NEW_CIRCUIT                 = 'newCircuitForDomain' # js function
+
+        TB_SEC_LEVELS               = { 'standard' => 4, 'safer' => 2, 'safest' => 1 }.freeze
+
+        LOCALHOST_PORT_REGEXP       = /127\.0\.0\.1:(\d+)/
+
+        attr_reader :tor_process
 
         def initialize(options: nil, **)
           @data_dir = Dir.mktmpdir
@@ -31,7 +39,8 @@ module Selenium
           add_torrc_path_to_options
           @instance = DriverDelegate.new(options: @options, **)
           install_extensions @instance
-          create_tor_process_and_start_tor @options.tor_opts
+          pid = create_tor_process_and_start_tor(@options.tor_opts)
+          @instance.pref[PREF_SOCKS_PORT] = socks_port(pid)
           super(@instance)
         end
 
@@ -46,13 +55,13 @@ module Selenium
         end
 
         def security_level
-          pref[BROWSER_SECURITY_LEVEL_PREF]
+          pref[PREF_BROWSER_SECURITY_LEVEL]
         end
 
         def security_level=(int)
           raise(ArgumentError, "Valid security levels are: #{TB_SEC_LEVELS.values}") unless TB_SEC_LEVELS.value?(int)
 
-          pref[BROWSER_SECURITY_LEVEL_PREF] = int
+          pref[PREF_BROWSER_SECURITY_LEVEL] = int
         end
 
         def new_circuit_for_site
@@ -64,7 +73,7 @@ module Selenium
         private
 
         def add_torrc_path_to_options
-          @options.prefs[TORRC_PATH_PREF] = File.join(@data_dir, TORRC)
+          @options.prefs[PREF_TORRC_PATH] = File.join(@data_dir, TORRC)
         end
 
         def install_extensions(instance)
@@ -73,20 +82,25 @@ module Selenium
 
         def create_tor_process_and_start_tor(opts)
           timeout = opts.delete :timeout
-          @tor_process = tor_process(opts)
+          @tor_process = create_tor_process(opts)
           @tor_process.start_tor(timeout: timeout)
         rescue Tor::TorProcess::TorProcessError => e
           instance_variable_get(:@instance)&.quit # avoids hanging firefox.real process
           raise Error::WebDriverError, e
         end
 
-        def tor_process(opts)
+        def create_tor_process(opts)
           TorProcess.new(@data_dir, opts || {})
         end
 
         def domain
           URI(current_url).host&.match(/[^\.]+\.\w+$/)
         end
+
+        def socks_port(pid)
+          str = `netstat -tnlp 2>/dev/null|grep #{pid}/tor` # net-tools dep
+          str.match(LOCALHOST_PORT_REGEXP)[1].to_i
+        end
       end
     end
   end

data/lib/tor/error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal:true
+
+require 'selenium-webdriver'
+
+# errors
+module Selenium
+  module WebDriver
+    module Tor
+      class Error < WebDriver::Error::WebDriverError; end
+
+      class TorrcError < Error; end
+
+      class TorProcessError < Error; end
+
+      class LibxulPatchableError < Error; end
+    end
+  end
+end

data/lib/tor/libxul_checksums.yml

@@ -1,4 +1,8 @@
 ---
+14.5.3:
+  unpatched_libxul: 88c9aef61ca0df4c617a8c7c589194bd8ff31d1d7a6360512e1ab1cfc81390a8
+  patched_libxul: 18e6f350a2a8983395ffac984aac1a7a431d2acb0c97faa69d6f965199b67e2c
+  patch_checksum: b216ba4ad661e79e9cbf648837e1f18282490ee504f5970a2cb1ae7f847dd271
 14.5.2:
   unpatched_libxul: 0e4d960cb427df67a25ab50aa934272e7ac7ee3487c709e48d97e2611e2ae930
   patched_libxul: 20579db140991d77db1a3ffa3e248752dd689bf4156056402cbe1fd6287430c1

data/lib/tor/libxul_patchable.rb

@@ -5,6 +5,8 @@ require 'digest'
 require 'json'
 require 'open-uri'
 require 'yaml'
+
+require_relative 'error'
 require_relative 'options' # module needs access to consts therein defined
 
 module Selenium
@@ -12,19 +14,17 @@ module Selenium
     module Tor
       # methods to patch/unpatch libxul.so
       module LibxulPatchable
-        class LibxulPatchableError < StandardError; end
-
-        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/
+        PATCH_REPO_URL   = '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
           return true if patched_libxul_checksum_for_version == libxul_checksum
           return false if unpatched_libxul_checksum_for_version == libxul_checksum
 
-          raise LibxulPatchableError, 'Unrecognized libxul.so'
+          raise Tor::LibxulPatchableError, 'Unrecognized libxul.so'
         end
 
         def patch_libxul
@@ -36,7 +36,7 @@ module Selenium
           execute_patch patchfile
           FileUtils.cp libxul_patched, Tor::TBB_LIBXUL
         rescue OpenURI::HTTPError
-          raise LibxulPatchableError, NO_PATCH_MSG
+          raise Tor::LibxulPatchableError, NO_PATCH_MSG
         end
 
         def unpatch_libxul
@@ -57,7 +57,7 @@ module Selenium
 
         def valid?(patchfile)
           msg = "Invalid patch for #{Tor::TBB_VERSION}, please raise an issue at #{ISSUES_URL}"
-          raise LibxulPatchableError, msg unless patch_checksum_for_version == checksum_for(patchfile)
+          raise Tor::LibxulPatchableError, msg unless patch_checksum_for_version == checksum_for(patchfile)
         end
 
         def execute_patch(patchfile)
@@ -71,7 +71,7 @@ module Selenium
         def unpatched_libxul_checksum_for_version
           libxul_checksums['unpatched_libxul']
         rescue NoMethodError => e
-          raise LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
+          raise Tor::LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
 
           raise e
         end
@@ -79,7 +79,7 @@ module Selenium
         def patched_libxul_checksum_for_version
           libxul_checksums['patched_libxul']
         rescue NoMethodError => e
-          raise LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
+          raise Tor::LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
 
           raise e
         end
@@ -87,7 +87,7 @@ module Selenium
         def patch_checksum_for_version
           libxul_checksums['patch_checksum']
         rescue NoMethodError => e
-          raise LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
+          raise Tor::LibxulPatchableError, NO_PATCH_MSG if e.message.match UNDEF_REGEXP
 
           raise e
         end
@@ -106,7 +106,7 @@ module Selenium
         end
 
         def patch_url
-          File.join PATCH_REPO, "#{Tor::TBB_VERSION}.patch"
+          File.join PATCH_REPO_URL, "#{Tor::TBB_VERSION}.patch"
         end
       end
     end

data/lib/tor/options.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'tor_prefs'
-require_relative 'system_tor'
 require 'selenium-webdriver'
 
 module Selenium
@@ -9,25 +8,23 @@ module Selenium
     module Tor
       # tor options
       class Options < Firefox::Options
-        CAPABILITIES = CAPABILITIES.merge(tor_opts: 'tor_opts')
-        CAPABILITIES[:system_tor] = 'system_tor' # DEPRECATED 2.0
+        CAPABILITIES    = CAPABILITIES.merge(tor_opts: 'tor_opts')
         DEFAULT_TBB_DIR = File.join Dir.home, 'tor-browser'
 
-        Tor::TBB_DIR = ENV.fetch('TOR_BROWSER_ROOT_DIR', nil) || DEFAULT_TBB_DIR
-        Tor::TBB_BROWSER_DIR = File.join Tor::TBB_DIR, 'Browser'
-        Tor::TBB_LIBXUL = File.join Tor::TBB_BROWSER_DIR, 'libxul.so'
-        Tor::TBB_BINARY_PATH = File.join Tor::TBB_BROWSER_DIR, 'firefox'
+        Tor::TBB_DIR             = ENV.fetch('TOR_BROWSER_ROOT_DIR', nil) || DEFAULT_TBB_DIR
+        Tor::TBB_BROWSER_DIR     = File.join Tor::TBB_DIR, 'Browser'
+        Tor::TBB_LIBXUL          = File.join Tor::TBB_BROWSER_DIR, 'libxul.so'
+        Tor::TBB_BINARY_PATH     = File.join Tor::TBB_BROWSER_DIR, 'firefox'
         Tor::TBB_TOR_BINARY_PATH = File.join Tor::TBB_BROWSER_DIR, *%w[TorBrowser Tor tor]
-        Tor::TBB_TOR_DATA_DIR = File.join Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data Tor]
-        Tor::TBB_PROFILE_DIR = File.join Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data Browser profile.default]
-        Tor::TBB_EXTENSIONS_DIR = File.join Tor::TBB_PROFILE_DIR, 'extensions'
-        Tor::TBB_VERSION = JSON.parse(File.read(File.join(Tor::TBB_BROWSER_DIR, 'tbb_version.json')))['version']
+        Tor::TBB_TOR_DATA_DIR    = File.join Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data Tor]
+        Tor::TBB_PROFILE_DIR     = File.join Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data Browser profile.default]
+        Tor::TBB_EXTENSIONS_DIR  = File.join Tor::TBB_PROFILE_DIR, 'extensions'
+        Tor::TBB_VERSION         = JSON.parse(File.read(File.join(Tor::TBB_BROWSER_DIR, 'tbb_version.json')))['version']
 
         attr_reader :tor_opts
 
         def initialize(log_level: nil, **opts)
-          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
+          @tor_opts = opts[:tor_opts] ? opts.delete(:tor_opts) : {}
           do_start_tor_browser_script_stuff # stuff the start-tor-browser script in TBB does
           super(log_level: log_level, **tor_options(opts.delete(:prefs)).merge(opts))
         end
@@ -39,10 +36,10 @@ module Selenium
         end
 
         def do_start_tor_browser_script_stuff
-          ENV['SESSION_MANAGER'] = nil
-          ENV['XAUTHORITY'] = File.join(Dir.home, '.Xauthority') unless ENV.fetch('XAUTHORITY', nil)
-          FileUtils.rm_rf File.join(Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data fontconfig])
+          ENV['SESSION_MANAGER']   = nil
           ENV['GSETTINGS_BACKEND'] = 'memory'
+          ENV['XAUTHORITY']        = File.join(Dir.home, '.Xauthority') unless ENV.fetch('XAUTHORITY', nil)
+          FileUtils.rm_rf File.join(Tor::TBB_BROWSER_DIR, *%w[TorBrowser Data fontconfig])
         end
       end
     end

data/lib/tor/tor_prefs.rb

@@ -18,7 +18,7 @@ module Selenium
       OTHER_PREFS = {
         'intl.language_notification.shown' => true, # affects font fingerprint (viewport size)
         'remote.active-protocols' => 1, # BiDi only >= 4.32 https://github.com/SeleniumHQ/selenium/pull/15224/files
-        'extensions.torlauncher.start_tor' => false
+        'extensions.torlauncher.start_tor' => false # no settings Connection pane
       }.freeze
 
       TOR_PREFS = FIRST_CONNECTION_PREFS.merge OTHER_PREFS

data/lib/tor/tor_process.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'timeout'
+require_relative 'error'
 require_relative 'torrc'
 
 module Selenium
@@ -8,12 +9,10 @@ module Selenium
     module Tor
       # Respresentation of a tor process
       class TorProcess
-        class TorProcessError < StandardError; end
-
         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\] .*/
+        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'
+        DIR_MSG    = 'data_dir must exist and be a dir'
         DATA_FILES = %w[cached-certs cached-microdesc-consensus cached-microdescs.new].freeze
 
         class << self
@@ -36,6 +35,7 @@ module Selenium
           pid = Process.spawn tor_command, out: io, err: :out
           io.close
           parse_tor_bootstrap_errors_with_timeout(r, timeout: timeout)
+          # tor process now bootstrapped
           read_from_data_files
           @pid = pid
         rescue Timeout::Error
@@ -88,7 +88,7 @@ module Selenium
               break '' if line.match BOOTSTRAP_SUCCESS_REGEX
             end
           end
-          raise(TorProcessError, "Tor failed to start with errors:\n\n#{errors}") unless errors.empty?
+          raise(Tor::TorProcessError, "Tor failed to start with errors:\n\n#{errors}") unless errors.empty?
         end
 
         def read_from_data_files
@@ -101,7 +101,7 @@ module Selenium
 
         def timeout_with(pid, timeout)
           Process.kill 'KILL', pid if pid
-          raise Error::TimeoutError, "Tor not bootstrapped after #{timeout} seconds"
+          raise WebDriver::Error::TimeoutError, "Tor not bootstrapped after #{timeout} seconds" # regular s-w error
         end
       end
     end

data/lib/tor/torrc.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'error'
 require_relative 'options'
 
 module Selenium
@@ -7,9 +8,7 @@ module Selenium
     module Tor
       # Respresentation of a torrc file
       class Torrc
-        class TorrcError < StandardError; end
-
-        DEFAULT_PORTS = { 'SocksPort' => 9150, 'ControlPort' => 9151 }.freeze
+        FIXED_CONFIG_KEYS    = %w[DataDirectory GeoIPFile GeoIPv6File SocksPort].freeze
         INVALID_OPTION_REGEX = %r{\[warn\] Failed to parse/validate config: (.*).$}
 
         attr_reader :path
@@ -29,20 +28,26 @@ module Selenium
           raise ArgumentError, 'Torrc#write_to_config takes a hash as argument' unless hash.is_a? Hash
 
           validate_torrc_options hash
-          @torrc_file.write hash_to_config_string(config.merge(hash))
+          @torrc_file.write hash_to_config_string(config.merge(hash).merge(fixed_config))
           @torrc_file.rewind
         end
 
         private
 
         def write_default_config
-          write_to_config DEFAULT_PORTS.merge(default_config)
+          write_to_config fixed_config
+        end
+
+        def fixed_config
+          @fixed_config ||= FIXED_CONFIG_KEYS.zip([@data_dir, geoip_file, geoip6_file, 'auto']).to_h
+        end
+
+        def geoip_file
+          File.join(TBB_TOR_DATA_DIR, 'geoip')
         end
 
-        def default_config
-          { 'DataDirectory' => @data_dir,
-            'GeoIPFile' => File.join(TBB_TOR_DATA_DIR, 'geoip'),
-            'GeoIPv6File' => File.join(TBB_TOR_DATA_DIR, 'geoip6') }
+        def geoip6_file
+          File.join(TBB_TOR_DATA_DIR, 'geoip6')
         end
 
         def validate_torrc_options(hash)

data/lib/tor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium_tor
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - MatzFan
@@ -202,11 +202,11 @@ files:
 - lib/selenium_tor.rb
 - lib/service.rb
 - lib/tor/driver.rb
+- lib/tor/error.rb
 - lib/tor/libxul_checksums.yml
 - lib/tor/libxul_patchable.rb
 - lib/tor/options.rb
 - lib/tor/profile.rb
-- lib/tor/system_tor.rb
 - lib/tor/tor_prefs.rb
 - lib/tor/tor_process.rb
 - lib/tor/torrc.rb

data/lib/tor/system_tor.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Selenium
-  module WebDriver
-    module Tor
-      # DEPRECATED
-      class SystemTor
-        attr_reader :opts
-
-        def initialize(opts = {})
-          warn '[DEPRECATION] `SystemTor` options are deprecated in `selenium_tor` 2.0. Use `tor_opts` instead.'
-          @opts = opts
-        end
-      end
-    end
-  end
-end