selenium_tor 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53381bfb6eec61ccbffdd84ce01dd3e83413822c139ef6877f1873505fdf9560
-  data.tar.gz: b0aaf6755f2139ab92f66941f6874a38a1ee0d5da6c4a4891968c2c22afb114f
+  metadata.gz: cd34aa798531de8ada12d53163c343733610aa6115141d58aeaa3b4875c40cd6
+  data.tar.gz: f989c3ca02651ba825beefde17a4f2ac007ae25bb7c09e29ca080eee24cd3d03
 SHA512:
-  metadata.gz: f5ce3f9a6def6cf03b4ddcb9eaa24548f70d87f7624d2c6b8deae473210f6a02e7239a80a4ba5ba9a925b8a33f9bb9e4adde8182d93fe90c17a8dd581de25351
-  data.tar.gz: c153ff3ea434a2a141f3f15670e923b0800159e1ee2126414b7fd498fbe937e155de652735255d9f4576735789ab9215f259c2983922627e0d68fbcad33825a7
+  metadata.gz: 1a71cffb60fc1e7f58d4a8cb4ffc9b0b42abfca1f5c541332b0febf50b78440fb5adfacb76f18e7289184bd7fb185582c4b338f6c2cde8177847b0db4e9a8ba7
+  data.tar.gz: 3c9291018aede2ef805bf96110ff3742b4e2791634801be4ac607ad27e4d318ddafe931950946499a8547883c48ca750d6af9a409674b91e40cf9cce41e418b5

data/.rubocop.yml

@@ -24,3 +24,6 @@ Lint/RescueException:
 Style/RegexpLiteral:
   Exclude:
     - 'Guardfile'
+
+Minitest/TestMethodName:
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## master (unreleased)
 
+## [1.0.0] - 2024-07-15
+
+### New features
+
+* add ability to use system tor
+* add ability to run multiple driver instances simultaneously (fixes [#6](https://gitlab.com/matzfan/selenium-tor/-/issues/6))
+
 ## [0.2.0] - 2024-07-10
 
 ### Breaking changes

data/README.md

@@ -30,8 +30,10 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install selenium_tor
 
 ## Usage
-
-Tor Browser is based on Firefox, so for usage please read the Selenium [docs](https://www.selenium.dev/documentation/webdriver/browsers/firefox/) for Firefox browser.
+```ruby
+require 'selenium_tor'
+```
+Tor Browser is based on Firefox, so for usage please read the Selenium [docs](https://www.selenium.dev/documentation/webdriver/browsers/firefox) for Firefox browser.
 
 A driver is instantiated like this:
 ```ruby
@@ -42,11 +44,43 @@ options = Selenium::WebDriver::Tor::Options.new
 @driver.title # => Congratulations. This browser is configured to use Tor.
 @driver.quit
 ```
-The driver will not be instantiated until a connection to the Tor network is made. If the network is inaccessible for any reason a `TorNetworkError` will result.
+By default Tor Broswer will use the bundled `tor` process, in which case the driver will not be instantiated until a connection to the Tor network is made. If the network is inaccessible for any reason a `TorNetworkError` will result.
 
-The `Selenium::WebDriver::Tor` namespace is used for `Driver`, `Options` and `Profile`. Otherwise Selenium's `Selenium::WebDriver::Firefox` namespace is used.
+### Multiple instances using the system tor
 
-Remote functionality is not tested, but will be if Selenium provide a Tor Browser Docker container for Selenium Grid.
+The following options require `tor` to be installed. Tor is available via various package managers e.g. `sudo apt install tor`.
+
+If a `SystemTor` object is passed to options, the system `tor` will be used instead of the `tor` included in the Tor Browser Bundle (TBB).
+```ruby
+system_tor = Selenium::WebDriver::Tor::SystemTor.new # writes a driver-specific torrc file
+options = Selenium::WebDriver::Tor::Options.new system_tor: system_tor
+@driver = Selenium::WebDriver.for :tor, options: options # new tor process started when :system_tor option passed to driver
+@driver.get 'https://example.com'
+@driver.quit # stops the new system tor process and deletes torrc file
+```
+Multiple instances may be instantiated, in which case `SystemTor` options for :socks_port (default 9150) and :control_port (default 9151) must be set for each so they do not conflict. For example:
+```ruby
+def new_driver(socks_p, control_p)
+  system_tor = Selenium::WebDriver::Tor::SystemTor.new(socks_port: socks_p, control_port: control_p)
+  options = Selenium::WebDriver::Tor::Options.new system_tor: system_tor
+  Selenium::WebDriver.for :tor, options: options
+end
+
+socks_port = 9150
+control_port = 9151
+
+driver1 = new_driver(socks_port, control_port)
+socks_port += 2
+control_port += 2
+driver2 = new_driver(socks_port, control_port)
+
+driver1.quit
+driver2.quit
+```
+
+The `Selenium::WebDriver::Tor` namespace is used for `Driver`, `Options`, `Profile` and all tor-specific classes. Otherwise Selenium's `Selenium::WebDriver::Firefox` namespace is used.
+
+Remote functionality is not tested, but may be if a suitable Tor Browser Docker container becomes available.
 
 A number of constants are set during driver initialization based upon values found in the Tor Browser Bundle (TBB) root directory - see below. These include:
 ```ruby
@@ -76,17 +110,17 @@ Tor Selenium is tested on **Linux only** right now.
 
 ## Testing
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests.
+After checking out the repo, run `bin/setup` to install dependencies.
 
-Tests are run in the display set by the `DISPLAY` env var, :0 by default. To run headless tests, set it to another value:
+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
 
 If you find tests are failing with `TorNetworkError` and a timeout message, check you have no other Tor Browser processes running. The processes to look for are either "firefox.real" or "firefox-esr". The latter may be legitimate if you are also running Firefox browser. You may also want to check the Tor network is actually up, it isn't always..
 
-If you wish run the `vglrun` WebGL fingerprint test (excluded from Rake) install VirtualGL (see above, assumes you have the relevent drivers installed) and run the following command:
+If you wish run the `vglrun` WebGL fingerprint test install VirtualGL (see above, assumes you have the relevent drivers installed) and run the following command:
 
-    $ DISPLAY=:99 vglrun bundle exec ruby test/features/fingerprinting/test_fingerprintjs_with_vglrun.rb
+    $ DISPLAY=:99 vglrun bundle exec ruby test/features/fingerprinting/vglrun_test_fingerprintjs.rb
 
 ## Development
 
@@ -98,12 +132,6 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 Bug reports and pull requests are welcome on GitLab at https://gitlab.com/matzfan/selenium-tor. For a pull request please checkout a suitably named feature branch before making and submitting changes.
 
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/matzfan/selenium-tor/CODE_OF_CONDUCT.md).
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Selenium Tor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/matzfan/selenium-tor/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/test_*.rb'] - ['test/features/fingerprinting/test_fingerprintjs_with_vglrun.rb']
+  t.test_files = FileList['test/**/test_*.rb']
   # t.warning = false
 end
 

data/lib/string_extensions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# patch String
+module StringExtensions
+  def snake_case?
+    match(/\A[a-z]+(_[a-z]+)?\z/)
+  end
+end
+
+class String
+  prepend StringExtensions
+end

data/lib/tor/driver.rb

@@ -13,13 +13,19 @@ module Selenium
         CONNECT_BUTTON_ID = 'network-status-tor-connect-button' # visible only until connected
         TOR_PREFS_CONNECTION_URL = 'about:preferences#connection'
 
-        attr_reader :support_data
+        attr_reader :system_tor
 
-        def initialize(...)
-          instantiate_driver_from_tbb_dir(...)
+        def initialize(options: nil, **)
+          instantiate_driver_from_tbb_dir(options: options, **)
+          setup_system_tor options.system_tor if options&.system_tor
           super(@instance)
-          wait_for_tor_connection
           install_extensions
+          wait_for_tor_connection unless system_tor # no need if system tor used
+        end
+
+        def quit
+          system_tor&.stop_tor
+          super
         end
 
         private
@@ -43,6 +49,11 @@ module Selenium
         def install_extensions
           Pathname.new(TBB_EXTENSIONS_DIR).children.each { |xpi_path| @instance.install_addon xpi_path }
         end
+
+        def setup_system_tor(system_tor)
+          @system_tor = system_tor
+          system_tor.start_tor
+        end
       end
     end
   end

data/lib/tor/options.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'tor_prefs'
+require_relative 'system_tor'
 require 'selenium-webdriver'
 
 module Selenium
@@ -8,7 +9,9 @@ module Selenium
     module Tor
       # tor options
       class Options < Firefox::Options
+        CAPABILITIES = CAPABILITIES.merge(system_tor: 'system_tor')
         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_BINARY_PATH = File.join Tor::TBB_BROWSER_DIR, 'firefox'
@@ -16,15 +19,24 @@ module Selenium
         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 :system_tor # read by Driver
+
         def initialize(log_level: nil, **opts)
+          @system_tor_prefs = {}
+          system_tor_prefs(opts.delete(:system_tor)) if opts[:system_tor] # must be deleted before call to super
           super(log_level: log_level, **tor_options(opts.delete(:prefs)).merge(opts))
           do_start_tor_browser_script_stuff # stuff the start-tor-browser script in TBB does
         end
 
         private
 
+        def system_tor_prefs(system_tor)
+          @system_tor = system_tor
+          @system_tor_prefs = system_tor.prefs
+        end
+
         def tor_options(prefs)
-          { binary: TBB_BINARY_PATH, prefs: (prefs || {}).merge(TOR_PREFS) }
+          { binary: TBB_BINARY_PATH, prefs: (prefs || {}).merge(TOR_PREFS).merge(@system_tor_prefs) }
         end
 
         def do_start_tor_browser_script_stuff

data/lib/tor/system_tor.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'timeout'
+require_relative 'torrc'
+require_relative '../string_extensions'
+
+module Selenium
+  module WebDriver
+    module Tor
+      # Respresentation of a system tor process
+      class SystemTor
+        include StringExtensions
+
+        class SystemTorError < StandardError; end
+
+        BOOTSTRAP_SUCCESS_REGEX = /Bootstrapped 100% \(done\): Done$/
+        BOOTSTRAP_FAIL_REGEX = /^[A-Z][a-z]{2} \d{1,2} \d{2}:\d{2}:\d{2}\.\d{3} \[err\] .*/
+        # BOOTSTRAP_TIMEOUT_REGEX = /^[A-Z][a-z]{2} \d{1,2} \d{2}:\d{2}:\d{2}\.\d{3} \[err\] .*/
+
+        TORRC_PREFS = { 'extensions.torlauncher.start_tor' => false }.freeze
+        TORRC_PATH_KEY = 'extensions.torlauncher.torrc_path'
+
+        attr_reader :pid, :config
+
+        def initialize(opts = {})
+          raise SystemTorError, 'tor executable not found in PATH' unless tor_executable?
+          raise ArgumentError, 'SystemTor.new takes an options hash' unless opts.is_a? Hash
+
+          @opts = map_opts_to_torrc_keys opts
+          @data_dir = Dir.mktmpdir # each tor process needs a separate data directory
+          @torrc = Torrc.new(@data_dir)
+          @config ||= setup_config # Hash to store torrc config
+        end
+
+        def prefs
+          TORRC_PREFS.merge({ TORRC_PATH_KEY => @torrc.path })
+        end
+
+        def start_tor
+          r, io = IO.pipe
+          pid = Process.spawn "tor -f #{@torrc.path}", out: io, err: :out
+          io.close
+          errors = parse_tor_bootstrap_errors r
+          errors.empty? ? @pid = pid : raise(SystemTorError, "Tor failed to start with errors:\n\n#{errors}")
+        ensure
+          r.close
+        end
+
+        def stop_tor
+          Process.kill 'KILL', pid if pid
+          FileUtils.rm_rf @data_dir if @data_dir
+          @pid = nil
+        end
+
+        private
+
+        def map_opts_to_torrc_keys(opts)
+          raise SystemTorError, 'Options hash keys must be snake case' unless opts.keys.map!(&:to_s).all?(&:snake_case?)
+
+          opts.transform_keys { |k| k.to_s.split('_').map(&:capitalize).join }
+        end
+
+        def setup_config
+          @torrc.write_to_config @opts
+          @torrc.config
+        end
+
+        def tor_executable?
+          `which tor`
+        end
+
+        def parse_tor_bootstrap_errors(io)
+          lines = []
+          io.each_line do |line|
+            lines << line
+            break lines if line.match BOOTSTRAP_FAIL_REGEX
+            break [] if line.match BOOTSTRAP_SUCCESS_REGEX
+            # break false if line.match BOOTSTRAP_TIMEOUT_REGEX
+          end
+        end
+      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 # new some time after selenium-webdriver 4.16
+        'remote.active-protocols' => 3 # CDP & BiDi future support
       }.freeze
 
       TOR_PREFS = FIRST_CONNECTION_PREFS.merge OTHER_PREFS

data/lib/tor/torrc.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Selenium
+  module WebDriver
+    module Tor
+      # Respresentation of a torrc file
+      class Torrc
+        class TorrcError < StandardError; end
+
+        DEFAULT_PORTS = { 'SocksPort' => 9150, 'ControlPort' => 9151 }.freeze
+        INVALID_OPTION_REGEX = %r{\[warn\] Failed to parse/validate config: (.*).$}
+
+        attr_reader :path
+
+        def initialize(data_dir)
+          @data_dir = data_dir
+          @torrc_file = File.new File.join(@data_dir, 'torrc'), 'w'
+          @path = @torrc_file.path
+          write_default_config
+        end
+
+        def config
+          parse_config
+        end
+
+        def write_to_config(hash)
+          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.rewind
+        end
+
+        private
+
+        def write_default_config
+          write_to_config DEFAULT_PORTS.merge('DataDirectory' => @data_dir)
+        end
+
+        def validate_torrc_options(hash)
+          tmp = Tempfile.new
+          tmp.write hash_to_config_string(hash)
+          tmp.rewind
+          invalid_opts = parse_invalid_opts `tor -f #{tmp.path} --verify-config`
+          raise TorrcError, "Invalid torrc opts: #{invalid_opts}" unless invalid_opts.empty?
+        ensure
+          tmp.unlink
+        end
+
+        def parse_invalid_opts(tor_output_string)
+          tor_output_string.split("\n").filter_map { |line| line[INVALID_OPTION_REGEX, 1] }
+        end
+
+        def hash_to_config_string(hash)
+          hash.map { |k, v| "#{k} #{v}" }.join("\n")
+        end
+
+        def parse_config
+          File.readlines(@torrc_file).inject({}) do |memo, line|
+            arr = line.chomp.split
+            arr << '' if arr.size == 1 # deal with keys with no value
+            memo.merge coerce_hash_int_values_to_int(Hash[*arr])
+          end
+        end
+
+        def coerce_hash_int_values_to_int(hash)
+          hash.transform_values { |v| v.to_i.to_s == v ? v.to_i : v }
+        end
+      end
+    end
+  end
+end

data/lib/tor/version.rb

@@ -3,7 +3,7 @@
 module Selenium
   module WebDriver
     module Tor
-      VERSION = '0.2.0'
+      VERSION = '1.0.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selenium_tor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - MatzFan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -35,7 +35,6 @@ files:
 - ".ruby-version"
 - ".yamllint"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -44,11 +43,14 @@ files:
 - lib/options.rb
 - lib/selenium_tor.rb
 - lib/service.rb
+- lib/string_extensions.rb
 - lib/tor/driver.rb
 - lib/tor/driver_not_yet_connected_to_tor_network.rb
 - lib/tor/options.rb
 - lib/tor/profile.rb
+- lib/tor/system_tor.rb
 - lib/tor/tor_prefs.rb
+- lib/tor/torrc.rb
 - lib/tor/version.rb
 - selenium_tor.gemspec
 - sig/tor.rbs
@@ -75,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Selenium extension for Tor Browser

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at matzfan@mailinator.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.