selenium_tor 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6364e433d9dc6dae22726d13c881c445eecfe34d7ce3deaf6b7a6f018e2e12a5
-  data.tar.gz: 6cf4824e8b4b0bb836cfa4ee44be05da6efba6dbe880b91de71e93971234415a
+  metadata.gz: 16076de37e6507820ad98d174e84997b480006e73e2d397b12d1106c65041fa4
+  data.tar.gz: dd48992b164cd81d1bacac5dec6050705781af03ae756ff33d9d9b0481f58e21
 SHA512:
-  metadata.gz: f49bbbcc7edbc15b544d06f1d6d1aadc3dc0a37f2e7210fe6b55a567b8dbc177db450fb6047d62a57560e024750b81907ac4581a35264688a81e60d195b82ae8
-  data.tar.gz: e0e76fc9a1b113221cc735f2b0b785e9d6a062d42bc7938d1303d0161c5950a5efe253cf27f3c94004a71301d152e2cfd80c21117322d162cada0e6fbdedd3a9
+  metadata.gz: 69c0d3811af3092236b2c9cfc4090258143ac0688f79a175684809ebc96f5d89759612625bd3d4e9361ec8ebec56daa3d924ab2525316d934544d45af8c94b94
+  data.tar.gz: a717b10e0f9595af81ec4233e86a7cbe47e5205eb681c244b56c0aed55c2642ae7cf33da2a825e1a74d1337b95c9136562aad06dfc0a396a712de3b0618611b9

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## master (unreleased)
 
+## [2.5.0] - 2026-05-15
+
+* added ControlPort ("auto") & ControlPortWriteToFile to `Tor::Torrc` fixed config
+* added methods `Tor::TorProcess#control_port` and `Tor::TorProcess#socks_port`
+* start tor process before instantiating driver
+
+### Bug fixes
+
+* set `extensions.torlauncher.control_port` pref before driver starts and quit driver *before* ending tor process [#23](https://gitlab.com/matzfan/selenium-tor/-/issues/23)
+
+### Breaking changes
+
+* `FirefoxJsHelper#es6_const_call` and `FirefoxJsHelper#es6_function_call` es6: kwarg is replaced by es6_uri:
+  es6: required just the module name, es6_uri: requires the full module uri - e.g. "moz-src:///toolkit/modules/TorConnect.sys.mjs"
+  Upstream issue & full list of new URI's in 16.0a6 is here: https://gitlab.torproject.org/tpo/applications/tor-browser/-/work_items/43824#note_3389196 
+
 ## [2.4.1] - 2026-03-12
 
 * add Tor::TBB_TOR_GEOIP_DIR const for changed tor geoip files location in 16.0a4 (see tor-browser-build bug 40892)

data/lib/firefox_js_helpers.rb

@@ -12,18 +12,18 @@ module Selenium
           in_chrome_context { execute_script(...) }
         end
 
-        def es6_const_call(es6:, const:)
-          es6_import(es6) << "return m.#{const}"
+        def es6_const_call(es6_uri:, const:)
+          es6_import(es6_uri) << "return m.#{const}"
         end
 
-        def es6_function_call(es6:, func:, args:)
-          es6_import(es6) << "return m.#{es6}.#{func}('#{args}')"
+        def es6_function_call(es6_uri:, func:, args:)
+          es6_import(es6_uri) << "return m.#{es6_uri.split('/').last}.#{func}('#{args}')"
         end
 
         private
 
-        def es6_import(es6)
-          "let m = ChromeUtils.importESModule('resource://gre/modules/#{es6}.sys.mjs');"
+        def es6_import(es6_uri)
+          "let m = ChromeUtils.importESModule('#{es6_uri}.sys.mjs');"
         end
 
         def in_chrome_context

data/lib/tor/driver.rb

@@ -4,6 +4,7 @@ require 'open-uri'
 require_relative '../service'
 require_relative '../options'
 require_relative '../firefox_prefs'
+require_relative 'error'
 require_relative 'libxul_patchable'
 require_relative 'profile'
 require_relative 'tor_process'
@@ -23,13 +24,16 @@ module Selenium
         PREF_BROWSER_SECURITY_LEVEL = 'browser.security_level.security_slider'
         PREF_TORRC_PATH             = 'extensions.torlauncher.torrc_path'
         PREF_SOCKS_PORT             = 'network.proxy.socks_port'
+        PREF_CONTROL_PORT           = 'extensions.torlauncher.control_port'
 
-        DOMAIN_ISOLATOR             = 'TorDomainIsolator' # ES6 module
-        NEW_CIRCUIT                 = 'newCircuitForDomain' # js function
+        DOMAIN_ISOLATOR_URI     = 'moz-src:///toolkit/components/tor-launcher/TorDomainIsolator' # ES6 module URI
+        DOMAIN_ISOLATOR_OLD_URI = 'resource://gre/modules/TorDomainIsolator' # ES6 module URI
 
-        TB_SEC_LEVELS               = { 'standard' => 4, 'safer' => 2, 'safest' => 1 }.freeze
+        NEW_CIRCUIT = 'newCircuitForDomain' # js function
 
-        LOCALHOST_PORT_REGEXP       = /127\.0\.0\.1:(\d+)/
+        TB_SEC_LEVELS = { 'standard' => 4, 'safer' => 2, 'safest' => 1 }.freeze
+
+        LOCALHOST_PORT_REGEXP = /127\.0\.0\.1:(\d+)/
 
         attr_reader :tor_process
 
@@ -38,10 +42,10 @@ module Selenium
           @options = options || Options.new # fix for issue #11, 'tis a puzzlement
           @options.add_argument '-remote-allow-system-access' # FF 138+
           add_torrc_path_to_options
+          create_tor_process_and_start_tor(@options.tor_opts) # sets @tor_process
+          add_ports_to_option_prefs
           @instance = while_in_tbb_browser_directory { DriverDelegate.new(options: @options, **) } # fixes #22
           install_extensions @instance
-          pid = create_tor_process_and_start_tor(@options.tor_opts)
-          @instance.pref[PREF_SOCKS_PORT] = socks_port(pid)
           super(@instance)
         end
 
@@ -50,9 +54,10 @@ module Selenium
         end
 
         def quit
+          super # 16.0a6 on; popup dialog blocks quit unless tor process (& control port) closed *after* browser
+        ensure
           @tor_process&.stop_tor
           FileUtils.rm_rf @data_dir
-          super
         end
 
         def security_level
@@ -67,7 +72,9 @@ module Selenium
         # end
 
         def new_circuit_for_site
-          execute_script_in_chrome_context es6_function_call(es6: DOMAIN_ISOLATOR, func: NEW_CIRCUIT, args: domain)
+          uri = DOMAIN_ISOLATOR_URI
+          uri = DOMAIN_ISOLATOR_OLD_URI if Gem::Version.new(Tor::TBB_VERSION) < '16.0a6' # DEPRECATE when 16 stable
+          execute_script_in_chrome_context es6_function_call(es6_uri: uri, func: NEW_CIRCUIT, args: domain)
         end
 
         alias new_circuit_for_page new_circuit_for_site
@@ -107,9 +114,8 @@ module Selenium
           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
+        def add_ports_to_option_prefs
+          @options.prefs.merge! PREF_CONTROL_PORT => tor_process.control_port, PREF_SOCKS_PORT => tor_process.socks_port
         end
       end
     end

data/lib/tor/libxul_checksums.yml

@@ -1,4 +1,12 @@
 ---
+16.0a6:
+  unpatched_libxul: 953e6739ed12e7040969532a8ffd8ca9ee4ac57bcd26217ee7ef6be07e671577
+  patched_libxul: 0a51fcad914d091d7dffdb8fd3ac83ea3fc0fa4ab9f4ffdbfe3e1a158291025b
+  patch_checksum: 3679851db2713292c2ce91e962e6237b032fcc38243b6b31c41225c003b1e1dd
+16.0a5:
+  unpatched_libxul: 78dc4e14b71be5522aa5530571371d84c070fd620681955d590a2d12c5ac632f
+  patched_libxul: 21c888f7c99cb9b946a1a7a03fbad0b2934e0eb5fee81e540c6dbb357d9810d9
+  patch_checksum: 031cb83ebdda6566699d22a7015ff9f1cf45f4eb2ade87b47c9ac609c3634aa3
 16.0a4:
   unpatched_libxul: 432205c32f39e9d78c2b525d4f8158cb1489bef85f9fdad6961b9c7493cb9a3a
   patched_libxul: 61ee89195b06b6ed01581cf34a23bc324da3817ea703f8ad57f984664888c579
@@ -15,6 +23,30 @@
   unpatched_libxul: 031bb945f33ab3c735c5a83005a73c0969eaff5c354e3d84aed2d7d39d0e05e1
   patched_libxul: 7b87200bb0a406f8d4c0660413aab05b61eb539e7596082b8f4c78d083b072a1
   patch_checksum: 6315196938fa4c3bae59b300426f2dac1141fb075c19fcdbebd656d0c3452dd5
+15.0.13:
+  unpatched_libxul: c48ec76b7011319f0b225fa99587e6f75e49ff9a99a334a3b1b01b9daf184f73
+  patched_libxul: 45d88d2244f24250c11c7115287ef27f69b371659ec2a0eb0a484cf5bb42446d
+  patch_checksum: 272c97a05d968f1eb6a13e9fc660a1ce47e3ec8406749407b3c2238ae3097062
+15.0.12:
+  unpatched_libxul: 33d5f416b406d2b11687920e2248760a8f012e4a2473d6813968b33948ec0c2e
+  patched_libxul: 8bd0aeb1b2f78e5d2e7a721e7d495872c5049c995f8b04accc47aa2c699eaec9
+  patch_checksum: 1b726b56fc6a6e5937d0f69a1cd8e6224f9709e7e46d51afa28d02395cf387c5
+15.0.11:
+  unpatched_libxul: 0936946a38d718e6cd18945de19b189ae0b95a0ec0f9b2214607ab0eb58f1437
+  patched_libxul: ff9cfd8e9a94f2f358d23c33442b017d11990fe28169c508762cd506b8870ab6
+  patch_checksum: 40b472e86423026f341257d50ed1a3fb88586eddd34fa161444e6b4bab7b7b09
+15.0.10:
+  unpatched_libxul: 08f4f5d2a435fd7fdea075a5cf15492099b7ce6c5b7a8b096ee0f135052c2088
+  patched_libxul: ad1eca9ebac396ab22d1e13e5d5804091ab3bb26ec533c4ab8ce414f68d45845
+  patch_checksum: 694dbf57259f194839ba4ea9d487097cc83d1faa9339093fa5368ad4a49b8935
+15.0.9:
+  unpatched_libxul: 7106d33aeb8f4ecb4d87b88ee9e28ec3562e8ffff78f79a35c12622e2342acf9
+  patched_libxul: 5527d040bc73ef330fd52a135cd800c8026df87477467d93d600864ae4a542fe
+  patch_checksum: b748eba77d408a85fc893a99a3fe7eb64ab90785f65718fdb7c48b8716af42b1
+15.0.8:
+  unpatched_libxul: 91988852045f96a6f9d7bd0a58ef21c902fd6798d51b48770d83b7e542b14dbd
+  patched_libxul: 184c98c6ed443d8fd685983715ea82df793032e3773a94b2e92379db0f6c9fb4
+  patch_checksum: 5bd27f79d0d2a346b4d7fe7b933e5333dcaf7dfece14df2c1bb411be173a00b8
 15.0.7:
   unpatched_libxul: 46c9b9c8882645386a3ca9714f6abc09198fbd1ae233509cb658ebc6b689e444
   patched_libxul: b1770187f513bd6bfb8a86fbd4617b1de142c43529f350e9ba79ac52216b4e5a

data/lib/tor/tor_process.rb

@@ -11,6 +11,7 @@ module Selenium
       class TorProcess
         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\] .*/
+        SOCKS_PORT_REGEX        = /Opened Socks listener connection \(ready\) on 127\.0\.0\.1:(\d+)$/
 
         DIR_MSG    = 'data_dir must exist and be a dir'
         DATA_FILES = %w[cached-certs cached-microdesc-consensus cached-microdescs.new].freeze
@@ -19,7 +20,7 @@ module Selenium
           attr_accessor :cached_certs, :cached_microdesc_consensus, :cached_microdescs # set when tor first started
         end
 
-        attr_reader :pid, :config
+        attr_reader :pid, :config, :socks_port
 
         def initialize(data_dir, opts = {})
           setup_data_dir data_dir
@@ -28,13 +29,14 @@ module Selenium
           @opts = map_opts_to_torrc_keys opts
           @torrc = Torrc.new(@data_dir)
           @config ||= setup_config # Hash to store torrc config
+          @socks_port = 0
         end
 
-        def start_tor(timeout: 10)
+        def start_tor(timeout: 120)
           r, io = IO.pipe
           pid = Process.spawn tor_command, out: io, err: :out
           io.close
-          parse_tor_bootstrap_errors_with_timeout(r, timeout: timeout)
+          parse_tor_bootstrap_with_timeout(r, timeout: timeout)
           # tor process now bootstrapped
           read_from_data_files
           @pid = pid
@@ -50,6 +52,10 @@ module Selenium
           @pid = nil
         end
 
+        def control_port
+          File.read(@torrc.control_port_file_path).split(':').last.to_i # "PORT=127.0.0.1:<port>"
+        end
+
         private
 
         def setup_data_dir(dir)
@@ -79,11 +85,12 @@ module Selenium
           "#{TBB_TOR_BINARY_PATH} -f #{@torrc.path}"
         end
 
-        def parse_tor_bootstrap_errors_with_timeout(io, timeout:)
+        def parse_tor_bootstrap_with_timeout(io, timeout:)
           lines = []
           errors = Timeout.timeout timeout do
             io.each_line do |line|
               lines << line
+              parse_socks_port line
               break lines.join if line.match BOOTSTRAP_FAIL_REGEX
               break '' if line.match BOOTSTRAP_SUCCESS_REGEX
             end
@@ -103,6 +110,12 @@ module Selenium
           Process.kill 'KILL', pid if pid
           raise WebDriver::Error::TimeoutError, "Tor not bootstrapped after #{timeout} seconds" # regular s-w error
         end
+
+        def parse_socks_port(string)
+          return unless (match = string.match(SOCKS_PORT_REGEX))
+
+          @socks_port = match[1].to_i
+        end
       end
     end
   end

data/lib/tor/torrc.rb

@@ -8,16 +8,24 @@ module Selenium
     module Tor
       # Respresentation of a torrc file
       class Torrc
-        FIXED_CONFIG_KEYS    = %w[DataDirectory GeoIPFile GeoIPv6File SocksPort].freeze
+        AUTO         = 'auto'
+        CONTROL_PORT = 'control_port'
+        GEOIP        = 'geoip'
+        GEOIP6       = 'geoip6'
+        TORRC        = 'torrc'
+
+        FIXED_CONFIG_KEYS = %w[DataDirectory GeoIPFile GeoIPv6File SocksPort ControlPort ControlPortWriteToFile].freeze
+
         INVALID_OPTION_REGEX = %r{\[warn\] Failed to parse/validate config: (.*).$}
 
         GEOIP_LOCATION_CHANGE_VER = Gem::Version.new '16.0a4'
 
-        attr_reader :path
+        attr_reader :control_port_file_path, :path
 
         def initialize(data_dir)
           @data_dir = data_dir
-          @torrc_file = File.new File.join(@data_dir, 'torrc'), 'w'
+          @torrc_file = File.new File.join(@data_dir, TORRC), 'w'
+          @control_port_file_path = File.join @data_dir, CONTROL_PORT
           @path = @torrc_file.path
           write_default_config
         end
@@ -41,21 +49,21 @@ module Selenium
         end
 
         def fixed_config
-          @fixed_config ||= FIXED_CONFIG_KEYS.zip([@data_dir, geoip_file, geoip6_file, 'auto']).to_h
+          FIXED_CONFIG_KEYS.zip([@data_dir, geoip_file, geoip6_file, AUTO, AUTO, control_port_file_path]).to_h
         end
 
         def geoip_file
           # DEPRECATE after 16 stable
-          return File.join(TBB_TOR_DATA_DIR, 'geoip') if Gem::Version.new(Tor::TBB_VERSION) < GEOIP_LOCATION_CHANGE_VER
+          return File.join(TBB_TOR_DATA_DIR, GEOIP) if Gem::Version.new(Tor::TBB_VERSION) < GEOIP_LOCATION_CHANGE_VER
 
-          File.join(TBB_TOR_GEOIP_DIR, 'geoip')
+          File.join(TBB_TOR_GEOIP_DIR, GEOIP)
         end
 
         def geoip6_file
           # DEPRECATE after 16 stable
-          return File.join(TBB_TOR_DATA_DIR, 'geoip6') if Gem::Version.new(Tor::TBB_VERSION) < GEOIP_LOCATION_CHANGE_VER
+          return File.join(TBB_TOR_DATA_DIR, GEOIP6) if Gem::Version.new(Tor::TBB_VERSION) < GEOIP_LOCATION_CHANGE_VER
 
-          File.join(TBB_TOR_GEOIP_DIR, 'geoip6')
+          File.join(TBB_TOR_GEOIP_DIR, GEOIP6)
         end
 
         def validate_torrc_options(hash)

data/lib/tor/version.rb

@@ -3,7 +3,7 @@
 module Selenium
   module WebDriver
     module Tor
-      VERSION = '2.4.1'
+      VERSION = '2.5.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium_tor
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - MatzFan
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Selenium extension for Tor Browser
 test_files: []